4 @settitle T-gnus 6.17 Manual
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}{T-gnus v6.17}
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.
358 @title T-gnus 6.17 Manual
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 T-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 T-gnus provides @acronym{MIME} features based on @acronym{SEMI} API. So
402 T-gnus supports your right to read strange messages including big images
403 or other various kinds of formats. T-gnus also supports
404 internationalization/localization and multiscript features based on MULE
405 API. So T-gnus does not discriminate various language communities. Oh,
406 if you are a Klingon, please wait Unicode Next Generation.
408 This manual corresponds to T-gnus 6.17.
419 Gnus is the advanced, self-documenting, customizable, extensible
420 unreal-time newsreader for GNU Emacs.
422 Oops. That sounds oddly familiar, so let's start over again to avoid
423 being accused of plagiarism:
425 Gnus is a message-reading laboratory. It will let you look at just
426 about anything as if it were a newsgroup. You can read mail with it,
427 you can browse directories with it, you can @code{ftp} with it---you
428 can even read news with it!
430 Gnus tries to empower people who read news the same way Emacs empowers
431 people who edit text. Gnus sets no limits to what the user should be
432 allowed to do. Users are encouraged to extend gnus to make it behave
433 like they want it to behave. A program should not control people;
434 people should be empowered to do what they want by using (or abusing)
440 * Starting Up:: Finding news can be a pain.
441 * Group Buffer:: Selecting, subscribing and killing groups.
442 * Summary Buffer:: Reading, saving and posting articles.
443 * Article Buffer:: Displaying and handling articles.
444 * Composing Messages:: Information on sending mail and news.
445 * Select Methods:: Gnus reads all messages from various select methods.
446 * Scoring:: Assigning values to articles.
447 * Various:: General purpose settings.
448 * The End:: Farewell and goodbye.
449 * Appendices:: Terminology, Emacs intro, @acronym{FAQ}, History, Internals.
450 * Index:: Variable, function and concept index.
451 * Key Index:: Key Index.
453 Other related manuals
455 * Message:(message). Composing messages.
456 * Emacs-MIME:(emacs-mime). Composing messages; @acronym{MIME}-specific parts.
457 * Sieve:(sieve). Managing Sieve scripts in Emacs.
458 * PGG:(pgg). @acronym{PGP/MIME} with Gnus.
459 * SASL:(sasl). @acronym{SASL} authentication in Emacs.
462 --- The Detailed Node Listing ---
466 * Finding the News:: Choosing a method for getting news.
467 * The First Time:: What does Gnus do the first time you start it?
468 * The Server is Down:: How can I read my mail then?
469 * Slave Gnusae:: You can have more than one Gnus active at a time.
470 * Fetching a Group:: Starting Gnus just to read a group.
471 * New Groups:: What is Gnus supposed to do with new groups?
472 * Changing Servers:: You may want to move from one server to another.
473 * Startup Files:: Those pesky startup files---@file{.newsrc}.
474 * Auto Save:: Recovering from a crash.
475 * The Active File:: Reading the active file over a slow line Takes Time.
476 * Startup Variables:: Other variables you might change.
480 * Checking New Groups:: Determining what groups are new.
481 * Subscription Methods:: What Gnus should do with new groups.
482 * Filtering New Groups:: Making Gnus ignore certain new groups.
486 * Group Buffer Format:: Information listed and how you can change it.
487 * Group Maneuvering:: Commands for moving in the group buffer.
488 * Selecting a Group:: Actually reading news.
489 * Subscription Commands:: Unsubscribing, killing, subscribing.
490 * Group Data:: Changing the info for a group.
491 * Group Levels:: Levels? What are those, then?
492 * Group Score:: A mechanism for finding out what groups you like.
493 * Marking Groups:: You can mark groups for later processing.
494 * Foreign Groups:: Creating and editing groups.
495 * Group Parameters:: Each group may have different parameters set.
496 * Listing Groups:: Gnus can list various subsets of the groups.
497 * Sorting Groups:: Re-arrange the group order.
498 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
499 * Browse Foreign Server:: You can browse a server. See what it has to offer.
500 * Exiting Gnus:: Stop reading news and get some work done.
501 * Group Topics:: A folding group mode divided into topics.
502 * Misc Group Stuff:: Other stuff that you can to do.
506 * Group Line Specification:: Deciding how the group buffer is to look.
507 * Group Mode Line Specification:: The group buffer mode line.
508 * Group Highlighting:: Having nice colors in the group buffer.
512 * Topic Commands:: Interactive E-Z commands.
513 * Topic Variables:: How to customize the topics the Lisp Way.
514 * Topic Sorting:: Sorting each topic individually.
515 * Topic Topology:: A map of the world.
516 * Topic Parameters:: Parameters that apply to all groups in a topic.
520 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
521 * Group Information:: Information and help on groups and Gnus.
522 * Group Timestamp:: Making Gnus keep track of when you last read a group.
523 * File Commands:: Reading and writing the Gnus files.
524 * Sieve Commands:: Managing Sieve scripts.
528 * Summary Buffer Format:: Deciding how the summary buffer is to look.
529 * Summary Maneuvering:: Moving around the summary buffer.
530 * Choosing Articles:: Reading articles.
531 * Paging the Article:: Scrolling the current article.
532 * Reply Followup and Post:: Posting articles.
533 * Delayed Articles:: Send articles at a later time.
534 * Marking Articles:: Marking articles as read, expirable, etc.
535 * Limiting:: You can limit the summary buffer.
536 * Threading:: How threads are made.
537 * Sorting the Summary Buffer:: How articles and threads are sorted.
538 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
539 * Article Caching:: You may store articles in a cache.
540 * Persistent Articles:: Making articles expiry-resistant.
541 * Article Backlog:: Having already read articles hang around.
542 * Saving Articles:: Ways of customizing article saving.
543 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
544 * Article Treatment:: The article buffer can be mangled at will.
545 * MIME Commands:: Doing MIMEy things with the articles.
546 * Charsets:: Character set issues.
547 * Article Commands:: Doing various things with the article buffer.
548 * Summary Sorting:: Sorting the summary buffer in various ways.
549 * Finding the Parent:: No child support? Get the parent.
550 * Alternative Approaches:: Reading using non-default summaries.
551 * Tree Display:: A more visual display of threads.
552 * Mail Group Commands:: Some commands can only be used in mail groups.
553 * Various Summary Stuff:: What didn't fit anywhere else.
554 * Exiting the Summary Buffer:: Returning to the Group buffer,
555 or reselecting the current group.
556 * Crosspost Handling:: How crossposted articles are dealt with.
557 * Duplicate Suppression:: An alternative when crosspost handling fails.
558 * Security:: Decrypt and Verify.
559 * Mailing List:: Mailing list minor mode.
561 Summary Buffer Format
563 * Summary Buffer Lines:: You can specify how summary lines should look.
564 * To From Newsgroups:: How to not display your own name.
565 * Summary Buffer Mode Line:: You can say how the mode line should look.
566 * Summary Highlighting:: Making the summary buffer all pretty and nice.
570 * Choosing Commands:: Commands for choosing articles.
571 * Choosing Variables:: Variables that influence these commands.
573 Reply, Followup and Post
575 * Summary Mail Commands:: Sending mail.
576 * Summary Post Commands:: Sending news.
577 * Summary Message Commands:: Other Message-related commands.
578 * Canceling and Superseding::
582 * Unread Articles:: Marks for unread articles.
583 * Read Articles:: Marks for read articles.
584 * Other Marks:: Marks that do not affect readedness.
588 * Setting Marks:: How to set and remove marks.
589 * Generic Marking Commands:: How to customize the marking.
590 * Setting Process Marks:: How to mark articles for later processing.
594 * Customizing Threading:: Variables you can change to affect the threading.
595 * Thread Commands:: Thread based commands in the summary buffer.
597 Customizing Threading
599 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
600 * Filling In Threads:: Making the threads displayed look fuller.
601 * More Threading:: Even more variables for fiddling with threads.
602 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
606 * Uuencoded Articles:: Uudecode articles.
607 * Shell Archives:: Unshar articles.
608 * PostScript Files:: Split PostScript.
609 * Other Files:: Plain save and binhex.
610 * Decoding Variables:: Variables for a happy decoding.
611 * Viewing Files:: You want to look at the result of the decoding?
615 * Rule Variables:: Variables that say how a file is to be viewed.
616 * Other Decode Variables:: Other decode variables.
617 * Uuencoding and Posting:: Variables for customizing uuencoding.
621 * Article Highlighting:: You want to make the article look like fruit salad.
622 * Article Fontisizing:: Making emphasized text look nice.
623 * Article Hiding:: You also want to make certain info go away.
624 * Article Washing:: Lots of way-neat functions to make life better.
625 * Article Header:: Doing various header transformations.
626 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
627 * Article Button Levels:: Controlling appearance of buttons.
628 * Article Date:: Grumble, UT!
629 * Article Display:: Display various stuff---X-Face, Picons, Smileys
630 * Article Signature:: What is a signature?
631 * Article Miscellanea:: Various other stuff.
633 Alternative Approaches
635 * Pick and Read:: First mark articles and then read them.
636 * Binary Groups:: Auto-decode all articles.
638 Various Summary Stuff
640 * Summary Group Information:: Information oriented commands.
641 * Searching for Articles:: Multiple article commands.
642 * Summary Generation Commands::
643 * Really Various Summary Commands:: Those pesky non-conformant commands.
647 * Hiding Headers:: Deciding what headers should be displayed.
648 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
649 * Customizing Articles:: Tailoring the look of the articles.
650 * Article Keymap:: Keystrokes available in the article buffer.
651 * Misc Article:: Other stuff.
655 * Mail:: Mailing and replying.
656 * Posting Server:: What server should you post and mail via?
657 * POP before SMTP:: You cannot send a mail unless you read a mail.
658 * Mail and Post:: Mailing and posting at the same time.
659 * Archived Messages:: Where Gnus stores the messages you've sent.
660 * Posting Styles:: An easier way to specify who you are.
661 * Drafts:: Postponing messages and rejected messages.
662 * Rejected Articles:: What happens if the server doesn't like your article?
663 * Signing and encrypting:: How to compose secure messages.
667 * Server Buffer:: Making and editing virtual servers.
668 * Getting News:: Reading USENET news with Gnus.
669 * Getting Mail:: Reading your personal mail with Gnus.
670 * Browsing the Web:: Getting messages from a plethora of Web sources.
671 * IMAP:: Using Gnus as a @acronym{IMAP} client.
672 * Other Sources:: Reading directories, files, SOUP packets.
673 * Combined Groups:: Combining groups into one group.
674 * Gnus Unplugged:: Reading news and mail offline.
678 * Server Buffer Format:: You can customize the look of this buffer.
679 * Server Commands:: Commands to manipulate servers.
680 * Example Methods:: Examples server specifications.
681 * Creating a Virtual Server:: An example session.
682 * Server Variables:: Which variables to set.
683 * Servers and Methods:: You can use server names as select methods.
684 * Unavailable Servers:: Some servers you try to contact may be down.
688 * NNTP:: Reading news from an @acronym{NNTP} server.
689 * News Spool:: Reading news from the local spool.
693 * Direct Functions:: Connecting directly to the server.
694 * Indirect Functions:: Connecting indirectly to the server.
695 * Common Variables:: Understood by several connection functions.
699 * Mail in a Newsreader:: Important introductory notes.
700 * Getting Started Reading Mail:: A simple cookbook example.
701 * Splitting Mail:: How to create mail groups.
702 * Mail Sources:: How to tell Gnus where to get mail from.
703 * Mail Back End Variables:: Variables for customizing mail handling.
704 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
705 * Group Mail Splitting:: Use group customize to drive mail splitting.
706 * Incorporating Old Mail:: What about the old mail you have?
707 * Expiring Mail:: Getting rid of unwanted mail.
708 * Washing Mail:: Removing cruft from the mail you get.
709 * Duplicates:: Dealing with duplicated mail.
710 * Not Reading Mail:: Using mail back ends for reading other files.
711 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
715 * Mail Source Specifiers:: How to specify what a mail source is.
716 * Mail Source Customization:: Some variables that influence things.
717 * Fetching Mail:: Using the mail source specifiers.
719 Choosing a Mail Back End
721 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
722 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
723 * Mail Spool:: Store your mail in a private spool?
724 * MH Spool:: An mhspool-like back end.
725 * Maildir:: Another one-file-per-message format.
726 * Mail Folders:: Having one file for each group.
727 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
732 * Web Searches:: Creating groups from articles that match a string.
733 * Slashdot:: Reading the Slashdot comments.
734 * Ultimate:: The Ultimate Bulletin Board systems.
735 * Web Archive:: Reading mailing list archived on web.
736 * RSS:: Reading RDF site summary.
737 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
741 * Splitting in IMAP:: Splitting mail with nnimap.
742 * Expiring in IMAP:: Expiring mail with nnimap.
743 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
744 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
745 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
746 * Debugging IMAP:: What to do when things don't work.
750 * Directory Groups:: You can read a directory as if it was a newsgroup.
751 * Anything Groups:: Dired? Who needs dired?
752 * Document Groups:: Single files can be the basis of a group.
753 * SOUP:: Reading @sc{soup} packets ``offline''.
754 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
758 * Document Server Internals:: How to add your own document types.
762 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
763 * SOUP Groups:: A back end for reading @sc{soup} packets.
764 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
768 * Virtual Groups:: Combining articles from many groups.
769 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
773 * Agent Basics:: How it all is supposed to work.
774 * Agent Categories:: How to tell the Gnus Agent what to download.
775 * Agent Commands:: New commands for all the buffers.
776 * Agent Visuals:: Ways that the agent may effect your summary buffer.
777 * Agent as Cache:: The Agent is a big cache too.
778 * Agent Expiry:: How to make old articles go away.
779 * Agent Regeneration:: How to recover from lost connections and other accidents.
780 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
781 * Outgoing Messages:: What happens when you post/mail something?
782 * Agent Variables:: Customizing is fun.
783 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
784 * Batching Agents:: How to fetch news from a @code{cron} job.
785 * Agent Caveats:: What you think it'll do and what it does.
789 * Category Syntax:: What a category looks like.
790 * Category Buffer:: A buffer for maintaining categories.
791 * Category Variables:: Customize'r'Us.
795 * Group Agent Commands:: Configure groups and fetch their contents.
796 * Summary Agent Commands:: Manually select then fetch specific articles.
797 * Server Agent Commands:: Select the servers that are supported by the agent.
801 * Summary Score Commands:: Adding score entries for the current group.
802 * Group Score Commands:: General score commands.
803 * Score Variables:: Customize your scoring. (My, what terminology).
804 * Score File Format:: What a score file may contain.
805 * Score File Editing:: You can edit score files by hand as well.
806 * Adaptive Scoring:: Big Sister Gnus knows what you read.
807 * Home Score File:: How to say where new score entries are to go.
808 * Followups To Yourself:: Having Gnus notice when people answer you.
809 * Scoring On Other Headers:: Scoring on non-standard headers.
810 * Scoring Tips:: How to score effectively.
811 * Reverse Scoring:: That problem child of old is not problem.
812 * Global Score Files:: Earth-spanning, ear-splitting score files.
813 * Kill Files:: They are still here, but they can be ignored.
814 * Converting Kill Files:: Translating kill files to score files.
815 * Advanced Scoring:: Using logical expressions to build score rules.
816 * Score Decays:: It can be useful to let scores wither away.
820 * Advanced Scoring Syntax:: A definition.
821 * Advanced Scoring Examples:: What they look like.
822 * Advanced Scoring Tips:: Getting the most out of it.
826 * Process/Prefix:: A convention used by many treatment commands.
827 * Interactive:: Making Gnus ask you many questions.
828 * Symbolic Prefixes:: How to supply some Gnus functions with options.
829 * Formatting Variables:: You can specify what buffers should look like.
830 * Window Layout:: Configuring the Gnus buffer windows.
831 * Faces and Fonts:: How to change how faces look.
832 * Compilation:: How to speed Gnus up.
833 * Mode Lines:: Displaying information in the mode lines.
834 * Highlighting and Menus:: Making buffers look all nice and cozy.
835 * Buttons:: Get tendinitis in ten easy steps!
836 * Daemons:: Gnus can do things behind your back.
837 * NoCeM:: How to avoid spam and other fatty foods.
838 * Undo:: Some actions can be undone.
839 * Predicate Specifiers:: Specifying predicates.
840 * Moderation:: What to do if you're a moderator.
841 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
842 * Fuzzy Matching:: What's the big fuzz?
843 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
844 * Other modes:: Interaction with other modes.
845 * Various Various:: Things that are really various.
849 * Formatting Basics:: A formatting variable is basically a format string.
850 * Mode Line Formatting:: Some rules about mode line formatting variables.
851 * Advanced Formatting:: Modifying output in various ways.
852 * User-Defined Specs:: Having Gnus call your own functions.
853 * Formatting Fonts:: Making the formatting look colorful and nice.
854 * Positioning Point:: Moving point to a position after an operation.
855 * Tabulation:: Tabulating your output.
856 * Wide Characters:: Dealing with wide characters.
860 * X-Face:: Display a funky, teensy black-and-white image.
861 * Face:: Display a funkier, teensier colored image.
862 * Smileys:: Show all those happy faces the way they were meant to be shown.
863 * Picons:: How to display pictures of what you're reading.
864 * XVarious:: Other XEmacsy Gnusey variables.
868 * The problem of spam:: Some background, and some solutions
869 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
870 * SpamAssassin:: How to use external anti-spam tools.
871 * Hashcash:: Reduce spam by burning CPU time.
872 * Filtering Spam Using The Spam ELisp Package::
873 * Filtering Spam Using Statistics with spam-stat::
875 Filtering Spam Using The Spam ELisp Package
877 * Spam ELisp Package Sequence of Events::
878 * Spam ELisp Package Filtering of Incoming Mail::
879 * Spam ELisp Package Global Variables::
880 * Spam ELisp Package Configuration Examples::
881 * Blacklists and Whitelists::
883 * Gmane Spam Reporting::
884 * Anti-spam Hashcash Payments::
886 * Regular Expressions Header Matching::
888 * ifile spam filtering::
889 * spam-stat spam filtering::
891 * Extending the Spam ELisp package::
893 Filtering Spam Using Statistics with spam-stat
895 * Creating a spam-stat dictionary::
896 * Splitting mail using spam-stat::
897 * Low-level interface to the spam-stat dictionary::
901 * XEmacs:: Requirements for installing under XEmacs.
902 * History:: How Gnus got where it is today.
903 * On Writing Manuals:: Why this is not a beginner's guide.
904 * Terminology:: We use really difficult, like, words here.
905 * Customization:: Tailoring Gnus to your needs.
906 * Troubleshooting:: What you might try if things do not work.
907 * Gnus Reference Guide:: Rilly, rilly technical stuff.
908 * Emacs for Heathens:: A short introduction to Emacsian terms.
909 * Frequently Asked Questions:: The Gnus FAQ
913 * Gnus Versions:: What Gnus versions have been released.
914 * Other Gnus Versions:: Other Gnus versions that also have been released.
915 * Why?:: What's the point of Gnus?
916 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
917 * Conformity:: Gnus tries to conform to all standards.
918 * Emacsen:: Gnus can be run on a few modern Emacsen.
919 * Gnus Development:: How Gnus is developed.
920 * Contributors:: Oodles of people.
921 * New Features:: Pointers to some of the new stuff in Gnus.
925 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
926 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
927 * Red Gnus:: Third time best---Gnus 5.4/5.5.
928 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
929 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
930 * Oort Gnus:: It's big. It's far out. Gnus 5.10.
931 * No Gnus:: Lars, FIXME!
935 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
936 * Slow Terminal Connection:: You run a remote Emacs.
937 * Little Disk Space:: You feel that having large setup files is icky.
938 * Slow Machine:: You feel like buying a faster machine.
942 * Gnus Utility Functions:: Common functions and variable to use.
943 * Back End Interface:: How Gnus communicates with the servers.
944 * Score File Syntax:: A BNF definition of the score file standard.
945 * Headers:: How Gnus stores headers internally.
946 * Ranges:: A handy format for storing mucho numbers.
947 * Group Info:: The group info format.
948 * Extended Interactive:: Symbolic prefixes and stuff.
949 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
950 * Various File Formats:: Formats of files that Gnus use.
954 * Required Back End Functions:: Functions that must be implemented.
955 * Optional Back End Functions:: Functions that need not be implemented.
956 * Error Messaging:: How to get messages and report errors.
957 * Writing New Back Ends:: Extending old back ends.
958 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
959 * Mail-like Back Ends:: Some tips on mail back ends.
963 * Active File Format:: Information on articles and groups available.
964 * Newsgroups File Format:: Group descriptions.
968 * Keystrokes:: Entering text and executing commands.
969 * Emacs Lisp:: The built-in Emacs programming language.
975 @chapter Starting gnus
980 If your system administrator has set things up properly, starting gnus
981 and reading news is extremely easy---you just type @kbd{M-x gnus} in
984 @findex gnus-other-frame
985 @kindex M-x gnus-other-frame
986 If you want to start gnus in a different frame, you can use the command
987 @kbd{M-x gnus-other-frame} instead.
989 If things do not go smoothly at startup, you have to twiddle some
990 variables in your @file{~/.gnus.el} file. This file is similar to
991 @file{~/.emacs}, but is read when Gnus starts.
993 If you puzzle at any terms used in this manual, please refer to the
994 terminology section (@pxref{Terminology}).
997 * Finding the News:: Choosing a method for getting news.
998 * The First Time:: What does Gnus do the first time you start it?
999 * The Server is Down:: How can I read my mail then?
1000 * Slave Gnusae:: You can have more than one Gnus active at a time.
1001 * Fetching a Group:: Starting Gnus just to read a group.
1002 * New Groups:: What is Gnus supposed to do with new groups?
1003 * Changing Servers:: You may want to move from one server to another.
1004 * Startup Files:: Those pesky startup files---@file{.newsrc}.
1005 * Auto Save:: Recovering from a crash.
1006 * The Active File:: Reading the active file over a slow line Takes Time.
1007 * Startup Variables:: Other variables you might change.
1011 @node Finding the News
1012 @section Finding the News
1013 @cindex finding news
1015 @vindex gnus-select-method
1017 The @code{gnus-select-method} variable says where gnus should look for
1018 news. This variable should be a list where the first element says
1019 @dfn{how} and the second element says @dfn{where}. This method is your
1020 native method. All groups not fetched with this method are
1023 For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where
1024 you want to get your daily dosage of news from, you'd say:
1027 (setq gnus-select-method '(nntp "news.somewhere.edu"))
1030 If you want to read directly from the local spool, say:
1033 (setq gnus-select-method '(nnspool ""))
1036 If you can use a local spool, you probably should, as it will almost
1037 certainly be much faster. But do not use the local spool if your
1038 server is running Leafnode; in this case, use @code{(nntp "localhost")}.
1040 @vindex gnus-nntpserver-file
1042 @cindex @acronym{NNTP} server
1043 If this variable is not set, gnus will take a look at the
1044 @env{NNTPSERVER} environment variable. If that variable isn't set,
1045 gnus will see whether @code{gnus-nntpserver-file}
1046 (@file{/etc/nntpserver} by default) has any opinions on the matter.
1047 If that fails as well, gnus will try to use the machine running Emacs
1048 as an @acronym{NNTP} server. That's a long shot, though.
1050 @vindex gnus-nntp-server
1051 If @code{gnus-nntp-server} is set, this variable will override
1052 @code{gnus-select-method}. You should therefore set
1053 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1055 @vindex gnus-secondary-servers
1056 @vindex gnus-nntp-server
1057 You can also make gnus prompt you interactively for the name of an
1058 @acronym{NNTP} server. If you give a non-numerical prefix to @code{gnus}
1059 (i.e., @kbd{C-u M-x gnus}), gnus will let you choose between the servers
1060 in the @code{gnus-secondary-servers} list (if any). You can also just
1061 type in the name of any server you feel like visiting. (Note that this
1062 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1063 gnus} later in the same Emacs session, Gnus will contact the same
1066 @findex gnus-group-browse-foreign-server
1068 However, if you use one @acronym{NNTP} server regularly and are just
1069 interested in a couple of groups from a different server, you would be
1070 better served by using the @kbd{B} command in the group buffer. It will
1071 let you have a look at what groups are available, and you can subscribe
1072 to any of the groups you want to. This also makes @file{.newsrc}
1073 maintenance much tidier. @xref{Foreign Groups}.
1075 @vindex gnus-secondary-select-methods
1077 A slightly different approach to foreign groups is to set the
1078 @code{gnus-secondary-select-methods} variable. The select methods
1079 listed in this variable are in many ways just as native as the
1080 @code{gnus-select-method} server. They will also be queried for active
1081 files during startup (if that's required), and new newsgroups that
1082 appear on these servers will be subscribed (or not) just as native
1085 For instance, if you use the @code{nnmbox} back end to read your mail,
1086 you would typically set this variable to
1089 (setq gnus-secondary-select-methods '((nnmbox "")))
1093 @node The First Time
1094 @section The First Time
1095 @cindex first time usage
1097 If no startup files exist, gnus will try to determine what groups should
1098 be subscribed by default.
1100 @vindex gnus-default-subscribed-newsgroups
1101 If the variable @code{gnus-default-subscribed-newsgroups} is set, gnus
1102 will subscribe you to just those groups in that list, leaving the rest
1103 killed. Your system administrator should have set this variable to
1106 Since she hasn't, gnus will just subscribe you to a few arbitrarily
1107 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1108 here as @dfn{whatever Lars thinks you should read}.)
1110 You'll also be subscribed to the gnus documentation group, which should
1111 help you with most common problems.
1113 If @code{gnus-default-subscribed-newsgroups} is @code{t}, gnus will just
1114 use the normal functions for handling new groups, and not do anything
1118 @node The Server is Down
1119 @section The Server is Down
1120 @cindex server errors
1122 If the default server is down, gnus will understandably have some
1123 problems starting. However, if you have some mail groups in addition to
1124 the news groups, you may want to start gnus anyway.
1126 Gnus, being the trusting sort of program, will ask whether to proceed
1127 without a native select method if that server can't be contacted. This
1128 will happen whether the server doesn't actually exist (i.e., you have
1129 given the wrong address) or the server has just momentarily taken ill
1130 for some reason or other. If you decide to continue and have no foreign
1131 groups, you'll find it difficult to actually do anything in the group
1132 buffer. But, hey, that's your problem. Blllrph!
1134 @findex gnus-no-server
1135 @kindex M-x gnus-no-server
1137 If you know that the server is definitely down, or you just want to read
1138 your mail without bothering with the server at all, you can use the
1139 @code{gnus-no-server} command to start gnus. That might come in handy
1140 if you're in a hurry as well. This command will not attempt to contact
1141 your primary server---instead, it will just activate all groups on level
1142 1 and 2. (You should preferably keep no native groups on those two
1143 levels.) Also @pxref{Group Levels}.
1147 @section Slave Gnusae
1150 You might want to run more than one Emacs with more than one gnus at the
1151 same time. If you are using different @file{.newsrc} files (e.g., if you
1152 are using the two different gnusae to read from two different servers),
1153 that is no problem whatsoever. You just do it.
1155 The problem appears when you want to run two Gnusae that use the same
1156 @file{.newsrc} file.
1158 To work around that problem some, we here at the Think-Tank at the gnus
1159 Towers have come up with a new concept: @dfn{Masters} and
1160 @dfn{slaves}. (We have applied for a patent on this concept, and have
1161 taken out a copyright on those words. If you wish to use those words in
1162 conjunction with each other, you have to send $1 per usage instance to
1163 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1164 Applications}) will be much more expensive, of course.)
1167 Anyway, you start one gnus up the normal way with @kbd{M-x gnus} (or
1168 however you do it). Each subsequent slave gnusae should be started with
1169 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1170 files, but instead save @dfn{slave files} that contain information only
1171 on what groups have been read in the slave session. When a master gnus
1172 starts, it will read (and delete) these slave files, incorporating all
1173 information from them. (The slave files will be read in the sequence
1174 they were created, so the latest changes will have precedence.)
1176 Information from the slave files has, of course, precedence over the
1177 information in the normal (i.e., master) @file{.newsrc} file.
1179 If the @file{.newsrc*} files have not been saved in the master when the
1180 slave starts, you may be prompted as to whether to read an auto-save
1181 file. If you answer ``yes'', the unsaved changes to the master will be
1182 incorporated into the slave. If you answer ``no'', the slave may see some
1183 messages as unread that have been read in the master.
1185 @node Fetching a Group
1186 @section Fetching a Group
1187 @cindex fetching a group
1189 @findex gnus-fetch-group
1190 It is sometimes convenient to be able to just say ``I want to read this
1191 group and I don't care whether gnus has been started or not''. This is
1192 perhaps more useful for people who write code than for users, but the
1193 command @code{gnus-fetch-group} provides this functionality in any case.
1194 It takes the group name as a parameter.
1200 @cindex subscription
1202 @vindex gnus-check-new-newsgroups
1203 If you are satisfied that you really never want to see any new groups,
1204 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1205 also save you some time at startup. Even if this variable is
1206 @code{nil}, you can always subscribe to the new groups just by pressing
1207 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1208 is @code{ask-server} by default. If you set this variable to
1209 @code{always}, then Gnus will query the back ends for new groups even
1210 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1213 * Checking New Groups:: Determining what groups are new.
1214 * Subscription Methods:: What Gnus should do with new groups.
1215 * Filtering New Groups:: Making Gnus ignore certain new groups.
1219 @node Checking New Groups
1220 @subsection Checking New Groups
1222 Gnus normally determines whether a group is new or not by comparing the
1223 list of groups from the active file(s) with the lists of subscribed and
1224 dead groups. This isn't a particularly fast method. If
1225 @code{gnus-check-new-newsgroups} is @code{ask-server}, gnus will ask the
1226 server for new groups since the last time. This is both faster and
1227 cheaper. This also means that you can get rid of the list of killed
1228 groups altogether, so you may set @code{gnus-save-killed-list} to
1229 @code{nil}, which will save time both at startup, at exit, and all over.
1230 Saves disk space, too. Why isn't this the default, then?
1231 Unfortunately, not all servers support this command.
1233 I bet I know what you're thinking now: How do I find out whether my
1234 server supports @code{ask-server}? No? Good, because I don't have a
1235 fail-safe answer. I would suggest just setting this variable to
1236 @code{ask-server} and see whether any new groups appear within the next
1237 few days. If any do, then it works. If none do, then it doesn't
1238 work. I could write a function to make gnus guess whether the server
1239 supports @code{ask-server}, but it would just be a guess. So I won't.
1240 You could @code{telnet} to the server and say @code{HELP} and see
1241 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1242 it does, then it might work. (But there are servers that lists
1243 @samp{NEWGROUPS} without supporting the function properly.)
1245 This variable can also be a list of select methods. If so, gnus will
1246 issue an @code{ask-server} command to each of the select methods, and
1247 subscribe them (or not) using the normal methods. This might be handy
1248 if you are monitoring a few servers for new groups. A side effect is
1249 that startup will take much longer, so you can meditate while waiting.
1250 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1253 @node Subscription Methods
1254 @subsection Subscription Methods
1256 @vindex gnus-subscribe-newsgroup-method
1257 What gnus does when it encounters a new group is determined by the
1258 @code{gnus-subscribe-newsgroup-method} variable.
1260 This variable should contain a function. This function will be called
1261 with the name of the new group as the only parameter.
1263 Some handy pre-fab functions are:
1267 @item gnus-subscribe-zombies
1268 @vindex gnus-subscribe-zombies
1269 Make all new groups zombies. This is the default. You can browse the
1270 zombies later (with @kbd{A z}) and either kill them all off properly
1271 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1273 @item gnus-subscribe-randomly
1274 @vindex gnus-subscribe-randomly
1275 Subscribe all new groups in arbitrary order. This really means that all
1276 new groups will be added at ``the top'' of the group buffer.
1278 @item gnus-subscribe-alphabetically
1279 @vindex gnus-subscribe-alphabetically
1280 Subscribe all new groups in alphabetical order.
1282 @item gnus-subscribe-hierarchically
1283 @vindex gnus-subscribe-hierarchically
1284 Subscribe all new groups hierarchically. The difference between this
1285 function and @code{gnus-subscribe-alphabetically} is slight.
1286 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1287 alphabetical fashion, while this function will enter groups into its
1288 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1289 @samp{comp} hierarchy, this function will not mess that configuration
1290 up. Or something like that.
1292 @item gnus-subscribe-interactively
1293 @vindex gnus-subscribe-interactively
1294 Subscribe new groups interactively. This means that gnus will ask
1295 you about @strong{all} new groups. The groups you choose to subscribe
1296 to will be subscribed hierarchically.
1298 @item gnus-subscribe-killed
1299 @vindex gnus-subscribe-killed
1300 Kill all new groups.
1302 @item gnus-subscribe-topics
1303 @vindex gnus-subscribe-topics
1304 Put the groups into the topic that has a matching @code{subscribe} topic
1305 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1306 topic parameter that looks like
1312 will mean that all groups that match that regex will be subscribed under
1315 If no topics match the groups, the groups will be subscribed in the
1320 @vindex gnus-subscribe-hierarchical-interactive
1321 A closely related variable is
1322 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1323 mouthful.) If this variable is non-@code{nil}, gnus will ask you in a
1324 hierarchical fashion whether to subscribe to new groups or not. Gnus
1325 will ask you for each sub-hierarchy whether you want to descend the
1328 One common mistake is to set the variable a few paragraphs above
1329 (@code{gnus-subscribe-newsgroup-method}) to
1330 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1331 will not work. This is ga-ga. So don't do it.
1334 @node Filtering New Groups
1335 @subsection Filtering New Groups
1337 A nice and portable way to control which new newsgroups should be
1338 subscribed (or ignored) is to put an @dfn{options} line at the start of
1339 the @file{.newsrc} file. Here's an example:
1342 options -n !alt.all !rec.all sci.all
1345 @vindex gnus-subscribe-options-newsgroup-method
1346 This line obviously belongs to a serious-minded intellectual scientific
1347 person (or she may just be plain old boring), because it says that all
1348 groups that have names beginning with @samp{alt} and @samp{rec} should
1349 be ignored, and all groups with names beginning with @samp{sci} should
1350 be subscribed. Gnus will not use the normal subscription method for
1351 subscribing these groups.
1352 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1353 variable defaults to @code{gnus-subscribe-alphabetically}.
1355 @vindex gnus-options-not-subscribe
1356 @vindex gnus-options-subscribe
1357 If you don't want to mess with your @file{.newsrc} file, you can just
1358 set the two variables @code{gnus-options-subscribe} and
1359 @code{gnus-options-not-subscribe}. These two variables do exactly the
1360 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1361 and if the new group matches the former, it will be unconditionally
1362 subscribed, and if it matches the latter, it will be ignored.
1364 @vindex gnus-auto-subscribed-groups
1365 Yet another variable that meddles here is
1366 @code{gnus-auto-subscribed-groups}. It works exactly like
1367 @code{gnus-options-subscribe}, and is therefore really superfluous,
1368 but I thought it would be nice to have two of these. This variable is
1369 more meant for setting some ground rules, while the other variable is
1370 used more for user fiddling. By default this variable makes all new
1371 groups that come from mail back ends (@code{nnml}, @code{nnbabyl},
1372 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir})
1373 subscribed. If you don't like that, just set this variable to
1376 New groups that match this regexp are subscribed using
1377 @code{gnus-subscribe-options-newsgroup-method}.
1380 @node Changing Servers
1381 @section Changing Servers
1382 @cindex changing servers
1384 Sometimes it is necessary to move from one @acronym{NNTP} server to another.
1385 This happens very rarely, but perhaps you change jobs, or one server is
1386 very flaky and you want to use another.
1388 Changing the server is pretty easy, right? You just change
1389 @code{gnus-select-method} to point to the new server?
1393 Article numbers are not (in any way) kept synchronized between different
1394 @acronym{NNTP} servers, and the only way Gnus keeps track of what articles
1395 you have read is by keeping track of article numbers. So when you
1396 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1399 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1400 file from one server to another. They all have one thing in
1401 common---they take a looong time to run. You don't want to use these
1402 functions more than absolutely necessary.
1404 @kindex M-x gnus-change-server
1405 @findex gnus-change-server
1406 If you have access to both servers, Gnus can request the headers for all
1407 the articles you have read and compare @code{Message-ID}s and map the
1408 article numbers of the read articles and article marks. The @kbd{M-x
1409 gnus-change-server} command will do this for all your native groups. It
1410 will prompt for the method you want to move to.
1412 @kindex M-x gnus-group-move-group-to-server
1413 @findex gnus-group-move-group-to-server
1414 You can also move individual groups with the @kbd{M-x
1415 gnus-group-move-group-to-server} command. This is useful if you want to
1416 move a (foreign) group from one server to another.
1418 @kindex M-x gnus-group-clear-data-on-native-groups
1419 @findex gnus-group-clear-data-on-native-groups
1420 If you don't have access to both the old and new server, all your marks
1421 and read ranges have become worthless. You can use the @kbd{M-x
1422 gnus-group-clear-data-on-native-groups} command to clear out all data
1423 that you have on your native groups. Use with caution.
1425 @kindex M-x gnus-group-clear-data
1426 @findex gnus-group-clear-data
1427 Clear the data from the current group only---nix out marks and the
1428 list of read articles (@code{gnus-group-clear-data}).
1430 After changing servers, you @strong{must} move the cache hierarchy away,
1431 since the cached articles will have wrong article numbers, which will
1432 affect which articles Gnus thinks are read.
1433 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1434 to have it done automatically; for @code{gnus-group-clear-data}, you
1435 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1436 cache for all groups).
1440 @section Startup Files
1441 @cindex startup files
1446 Now, you all know about the @file{.newsrc} file. All subscription
1447 information is traditionally stored in this file.
1449 Things got a bit more complicated with @sc{gnus}. In addition to
1450 keeping the @file{.newsrc} file updated, it also used a file called
1451 @file{.newsrc.el} for storing all the information that didn't fit into
1452 the @file{.newsrc} file. (Actually, it also duplicated everything in
1453 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1454 files was the most recently saved, which enabled people to swap between
1455 @sc{gnus} and other newsreaders.
1457 That was kinda silly, so Gnus went one better: In addition to the
1458 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1459 @file{.newsrc.eld}. It will read whichever of these files that are most
1460 recent, but it will never write a @file{.newsrc.el} file. You should
1461 never delete the @file{.newsrc.eld} file---it contains much information
1462 not stored in the @file{.newsrc} file.
1464 @vindex gnus-save-newsrc-file
1465 @vindex gnus-read-newsrc-file
1466 You can turn off writing the @file{.newsrc} file by setting
1467 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1468 the file and save some space, as well as exiting from gnus faster.
1469 However, this will make it impossible to use other newsreaders than
1470 gnus. But hey, who would want to, right? Similarly, setting
1471 @code{gnus-read-newsrc-file} to @code{nil} makes gnus ignore the
1472 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1473 convenient if you have a tendency to use Netscape once in a while.
1475 @vindex gnus-save-killed-list
1476 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1477 will not save the list of killed groups to the startup file. This will
1478 save both time (when starting and quitting) and space (on disk). It
1479 will also mean that Gnus has no record of what groups are new or old,
1480 so the automatic new groups subscription methods become meaningless.
1481 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1482 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1483 Groups}). This variable can also be a regular expression. If that's
1484 the case, remove all groups that do not match this regexp before
1485 saving. This can be useful in certain obscure situations that involve
1486 several servers where not all servers support @code{ask-server}.
1488 @vindex gnus-startup-file
1489 @vindex gnus-backup-startup-file
1490 @vindex version-control
1491 The @code{gnus-startup-file} variable says where the startup files are.
1492 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1493 file being whatever that one is, with a @samp{.eld} appended.
1494 If you want version control for this file, set
1495 @code{gnus-backup-startup-file}. It respects the same values as the
1496 @code{version-control} variable.
1498 @vindex gnus-save-newsrc-hook
1499 @vindex gnus-save-quick-newsrc-hook
1500 @vindex gnus-save-standard-newsrc-hook
1501 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1502 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1503 saving the @file{.newsrc.eld} file, and
1504 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1505 @file{.newsrc} file. The latter two are commonly used to turn version
1506 control on or off. Version control is on by default when saving the
1507 startup files. If you want to turn backup creation off, say something like:
1510 (defun turn-off-backup ()
1511 (set (make-local-variable 'backup-inhibited) t))
1513 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1514 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1517 @vindex gnus-init-file
1518 @vindex gnus-site-init-file
1519 When gnus starts, it will read the @code{gnus-site-init-file}
1520 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1521 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1522 and can be used to avoid cluttering your @file{~/.emacs} and
1523 @file{site-init} files with gnus stuff. Gnus will also check for files
1524 with the same names as these, but with @file{.elc} and @file{.el}
1525 suffixes. In other words, if you have set @code{gnus-init-file} to
1526 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1527 and finally @file{~/.gnus} (in this order).
1533 @cindex dribble file
1536 Whenever you do something that changes the gnus data (reading articles,
1537 catching up, killing/subscribing groups), the change is added to a
1538 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1539 Emacs way. If your Emacs should crash before you have saved the
1540 @file{.newsrc} files, all changes you have made can be recovered from
1543 If gnus detects this file at startup, it will ask the user whether to
1544 read it. The auto save file is deleted whenever the real startup file is
1547 @vindex gnus-use-dribble-file
1548 If @code{gnus-use-dribble-file} is @code{nil}, gnus won't create and
1549 maintain a dribble buffer. The default is @code{t}.
1551 @vindex gnus-dribble-directory
1552 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1553 this variable is @code{nil}, which it is by default, gnus will dribble
1554 into the directory where the @file{.newsrc} file is located. (This is
1555 normally the user's home directory.) The dribble file will get the same
1556 file permissions as the @file{.newsrc} file.
1558 @vindex gnus-always-read-dribble-file
1559 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1560 read the dribble file on startup without querying the user.
1563 @node The Active File
1564 @section The Active File
1566 @cindex ignored groups
1568 When gnus starts, or indeed whenever it tries to determine whether new
1569 articles have arrived, it reads the active file. This is a very large
1570 file that lists all the active groups and articles on the server.
1572 @vindex gnus-ignored-newsgroups
1573 Before examining the active file, gnus deletes all lines that match the
1574 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1575 any groups with bogus names, but you can use this variable to make gnus
1576 ignore hierarchies you aren't ever interested in. However, this is not
1577 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1578 Groups} for an overview of other variables that can be used instead.
1581 @c @code{nil} by default, and will slow down active file handling somewhat
1582 @c if you set it to anything else.
1584 @vindex gnus-read-active-file
1586 The active file can be rather Huge, so if you have a slow network, you
1587 can set @code{gnus-read-active-file} to @code{nil} to prevent gnus from
1588 reading the active file. This variable is @code{some} by default.
1590 Gnus will try to make do by getting information just on the groups that
1591 you actually subscribe to.
1593 Note that if you subscribe to lots and lots of groups, setting this
1594 variable to @code{nil} will probably make gnus slower, not faster. At
1595 present, having this variable @code{nil} will slow gnus down
1596 considerably, unless you read news over a 2400 baud modem.
1598 This variable can also have the value @code{some}. Gnus will then
1599 attempt to read active info only on the subscribed groups. On some
1600 servers this is quite fast (on sparkling, brand new INN servers that
1601 support the @code{LIST ACTIVE group} command), on others this isn't fast
1602 at all. In any case, @code{some} should be faster than @code{nil}, and
1603 is certainly faster than @code{t} over slow lines.
1605 Some news servers (old versions of Leafnode and old versions of INN, for
1606 instance) do not support the @code{LIST ACTIVE group}. For these
1607 servers, @code{nil} is probably the most efficient value for this
1610 If this variable is @code{nil}, gnus will ask for group info in total
1611 lock-step, which isn't very fast. If it is @code{some} and you use an
1612 @acronym{NNTP} server, gnus will pump out commands as fast as it can, and
1613 read all the replies in one swoop. This will normally result in better
1614 performance, but if the server does not support the aforementioned
1615 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1617 If you think that starting up Gnus takes too long, try all the three
1618 different values for this variable and see what works best for you.
1620 In any case, if you use @code{some} or @code{nil}, you should definitely
1621 kill all groups that you aren't interested in to speed things up.
1623 Note that this variable also affects active file retrieval from
1624 secondary select methods.
1627 @node Startup Variables
1628 @section Startup Variables
1632 @item gnus-load-hook
1633 @vindex gnus-load-hook
1634 A hook run while gnus is being loaded. Note that this hook will
1635 normally be run just once in each Emacs session, no matter how many
1636 times you start gnus.
1638 @item gnus-before-startup-hook
1639 @vindex gnus-before-startup-hook
1640 A hook run after starting up gnus successfully.
1642 @item gnus-startup-hook
1643 @vindex gnus-startup-hook
1644 A hook run as the very last thing after starting up gnus
1646 @item gnus-started-hook
1647 @vindex gnus-started-hook
1648 A hook that is run as the very last thing after starting up gnus
1651 @item gnus-setup-news-hook
1652 @vindex gnus-setup-news-hook
1653 A hook that is run after reading the @file{.newsrc} file(s), but before
1654 generating the group buffer.
1656 @item gnus-check-bogus-newsgroups
1657 @vindex gnus-check-bogus-newsgroups
1658 If non-@code{nil}, gnus will check for and delete all bogus groups at
1659 startup. A @dfn{bogus group} is a group that you have in your
1660 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1661 bogus groups can take quite a while, so to save time and resources it's
1662 best to leave this option off, and do the checking for bogus groups once
1663 in a while from the group buffer instead (@pxref{Group Maintenance}).
1665 @item gnus-inhibit-startup-message
1666 @vindex gnus-inhibit-startup-message
1667 If non-@code{nil}, the startup message won't be displayed. That way,
1668 your boss might not notice as easily that you are reading news instead
1669 of doing your job. Note that this variable is used before
1670 @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1672 @item gnus-no-groups-message
1673 @vindex gnus-no-groups-message
1674 Message displayed by gnus when no groups are available.
1676 @item gnus-play-startup-jingle
1677 @vindex gnus-play-startup-jingle
1678 If non-@code{nil}, play the gnus jingle at startup.
1680 @item gnus-startup-jingle
1681 @vindex gnus-startup-jingle
1682 Jingle to be played if the above variable is non-@code{nil}. The
1683 default is @samp{Tuxedomoon.Jingle4.au}.
1689 @chapter Group Buffer
1690 @cindex group buffer
1692 @c Alex Schroeder suggests to rearrange this as follows:
1694 @c <kensanata> ok, just save it for reference. I'll go to bed in a minute.
1695 @c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1696 @c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1697 @c 7. Group Score, 8. Group Buffer Format
1698 @c <kensanata> Group Levels should have more information on levels 5 to 9. I
1699 @c suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1700 @c <kensanata> First, "Gnus considers groups... (default 9)."
1701 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1702 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1703 @c <kensanata> Then expand the next paragraph or add some more to it.
1704 @c This short one sentence explains levels 1 and 2, therefore I understand
1705 @c that I should keep important news at 3 and boring news at 4.
1706 @c Say so! Then go on to explain why I should bother with levels 6 to 9.
1707 @c Maybe keep those that you don't want to read temporarily at 6,
1708 @c those that you never want to read at 8, those that offend your
1709 @c human rights at 9...
1712 The @dfn{group buffer} lists all (or parts) of the available groups. It
1713 is the first buffer shown when gnus starts, and will never be killed as
1714 long as gnus is active.
1718 \gnusfigure{The Group Buffer}{320}{
1719 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1720 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1721 \put(120,38){\vector(1,2){10}}
1722 \put(40,60){\makebox(0,0)[r]{Mode line}}
1723 \put(40,58){\vector(1,0){30}}
1724 \put(200,28){\makebox(0,0)[t]{Native select method}}
1725 \put(200,26){\vector(-1,2){15}}
1731 * Group Buffer Format:: Information listed and how you can change it.
1732 * Group Maneuvering:: Commands for moving in the group buffer.
1733 * Selecting a Group:: Actually reading news.
1734 * Subscription Commands:: Unsubscribing, killing, subscribing.
1735 * Group Data:: Changing the info for a group.
1736 * Group Levels:: Levels? What are those, then?
1737 * Group Score:: A mechanism for finding out what groups you like.
1738 * Marking Groups:: You can mark groups for later processing.
1739 * Foreign Groups:: Creating and editing groups.
1740 * Group Parameters:: Each group may have different parameters set.
1741 * Listing Groups:: Gnus can list various subsets of the groups.
1742 * Sorting Groups:: Re-arrange the group order.
1743 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1744 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1745 * Exiting Gnus:: Stop reading news and get some work done.
1746 * Group Topics:: A folding group mode divided into topics.
1747 * Misc Group Stuff:: Other stuff that you can to do.
1751 @node Group Buffer Format
1752 @section Group Buffer Format
1755 * Group Line Specification:: Deciding how the group buffer is to look.
1756 * Group Mode Line Specification:: The group buffer mode line.
1757 * Group Highlighting:: Having nice colors in the group buffer.
1761 @node Group Line Specification
1762 @subsection Group Line Specification
1763 @cindex group buffer format
1765 The default format of the group buffer is nice and dull, but you can
1766 make it as exciting and ugly as you feel like.
1768 Here's a couple of example group lines:
1771 25: news.announce.newusers
1772 * 0: alt.fan.andrea-dworkin
1777 You can see that there are 25 unread articles in
1778 @samp{news.announce.newusers}. There are no unread articles, but some
1779 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1780 asterisk at the beginning of the line?).
1782 @vindex gnus-group-line-format
1783 You can change that format to whatever you want by fiddling with the
1784 @code{gnus-group-line-format} variable. This variable works along the
1785 lines of a @code{format} specification, which is pretty much the same as
1786 a @code{printf} specifications, for those of you who use (feh!) C.
1787 @xref{Formatting Variables}.
1789 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1791 There should always be a colon on the line; the cursor always moves to
1792 the colon after performing an operation. @xref{Positioning
1793 Point}. Nothing else is required---not even the group name. All
1794 displayed text is just window dressing, and is never examined by Gnus.
1795 Gnus stores all real information it needs using text properties.
1797 (Note that if you make a really strange, wonderful, spreadsheet-like
1798 layout, everybody will believe you are hard at work with the accounting
1799 instead of wasting time reading news.)
1801 Here's a list of all available format characters:
1806 An asterisk if the group only has marked articles.
1809 Whether the group is subscribed.
1812 Level of subscribedness.
1815 Number of unread articles.
1818 Number of dormant articles.
1821 Number of ticked articles.
1824 Number of read articles.
1827 Number of unseen articles.
1830 Estimated total number of articles. (This is really @var{max-number}
1831 minus @var{min-number} plus 1.)
1833 Gnus uses this estimation because the @acronym{NNTP} protocol provides
1834 efficient access to @var{max-number} and @var{min-number} but getting
1835 the true unread message count is not possible efficiently. For
1836 hysterical raisins, even the mail back ends, where the true number of
1837 unread messages might be available efficiently, use the same limited
1838 interface. To remove this restriction from Gnus means that the back
1839 end interface has to be changed, which is not an easy job. If you
1840 want to work on this, please contact the Gnus mailing list.
1843 Number of unread, unticked, non-dormant articles.
1846 Number of ticked and dormant articles.
1855 Group comment (@pxref{Group Parameters}) or group name if there is no
1856 comment element in the group parameters.
1859 Newsgroup description. You need to read the group descriptions
1860 before these will appear, and to do that, you either have to set
1861 @code{gnus-read-active-file} or use the group buffer @kbd{M-d}
1865 @samp{m} if moderated.
1868 @samp{(m)} if moderated.
1874 If the summary buffer for the group is open or not.
1880 A string that looks like @samp{<%s:%n>} if a foreign select method is
1884 Indentation based on the level of the topic (@pxref{Group Topics}).
1887 @vindex gnus-group-uncollapsed-levels
1888 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1889 variable says how many levels to leave at the end of the group name.
1890 The default is 1---this will mean that group names like
1891 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1894 @vindex gnus-new-mail-mark
1896 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1900 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1903 A string that says when you last read the group (@pxref{Group
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'd like.
3057 If you want to hear a beep when you enter a group, you could put
3058 something like @code{(dummy-variable (ding))} in the parameters of that
3059 group. @code{dummy-variable} will be set to the result of the
3060 @code{(ding)} form, but who cares?
3064 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
3065 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
3066 presents you with a Customize-like interface. The latter helps avoid
3067 silly Lisp errors.) You might also be interested in reading about topic
3068 parameters (@pxref{Topic Parameters}).
3070 @vindex gnus-parameters
3071 Group parameters can be set via the @code{gnus-parameters} variable too.
3072 But some variables, such as @code{visible}, have no effect. For
3076 (setq gnus-parameters
3078 (gnus-show-threads nil)
3079 (gnus-use-scoring nil)
3080 (gnus-summary-line-format
3081 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3085 ("^nnimap:\\(foo.bar\\)$"
3089 (gnus-use-scoring t))
3093 (broken-reply-to . t))))
3096 String value of parameters will be subjected to regexp substitution, as
3097 the @code{to-group} example shows.
3100 @node Listing Groups
3101 @section Listing Groups
3102 @cindex group listing
3104 These commands all list various slices of the groups available.
3112 @findex gnus-group-list-groups
3113 List all groups that have unread articles
3114 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
3115 command will list only groups of level ARG and lower. By default, it
3116 only lists groups of level five (i.e.,
3117 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3124 @findex gnus-group-list-all-groups
3125 List all groups, whether they have unread articles or not
3126 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
3127 this command will list only groups of level ARG and lower. By default,
3128 it lists groups of level seven or lower (i.e., just subscribed and
3129 unsubscribed groups).
3133 @findex gnus-group-list-level
3134 List all unread groups on a specific level
3135 (@code{gnus-group-list-level}). If given a prefix, also list the groups
3136 with no unread articles.
3140 @findex gnus-group-list-killed
3141 List all killed groups (@code{gnus-group-list-killed}). If given a
3142 prefix argument, really list all groups that are available, but aren't
3143 currently (un)subscribed. This could entail reading the active file
3148 @findex gnus-group-list-zombies
3149 List all zombie groups (@code{gnus-group-list-zombies}).
3153 @findex gnus-group-list-matching
3154 List all unread, subscribed groups with names that match a regexp
3155 (@code{gnus-group-list-matching}).
3159 @findex gnus-group-list-all-matching
3160 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3164 @findex gnus-group-list-active
3165 List absolutely all groups in the active file(s) of the
3166 server(s) you are connected to (@code{gnus-group-list-active}). This
3167 might very well take quite a while. It might actually be a better idea
3168 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3169 thing to match on. Also note that this command may list groups that
3170 don't exist (yet)---these will be listed as if they were killed groups.
3171 Take the output with some grains of salt.
3175 @findex gnus-group-apropos
3176 List all groups that have names that match a regexp
3177 (@code{gnus-group-apropos}).
3181 @findex gnus-group-description-apropos
3182 List all groups that have names or descriptions that match a regexp
3183 (@code{gnus-group-description-apropos}).
3187 @findex gnus-group-list-cached
3188 List all groups with cached articles (@code{gnus-group-list-cached}).
3192 @findex gnus-group-list-dormant
3193 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3197 @findex gnus-group-list-limit
3198 List groups limited within the current selection
3199 (@code{gnus-group-list-limit}).
3203 @findex gnus-group-list-flush
3204 Flush groups from the current selection (@code{gnus-group-list-flush}).
3208 @findex gnus-group-list-plus
3209 List groups plus the current selection (@code{gnus-group-list-plus}).
3213 @vindex gnus-permanently-visible-groups
3214 @cindex visible group parameter
3215 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3216 always be shown, whether they have unread articles or not. You can also
3217 add the @code{visible} element to the group parameters in question to
3218 get the same effect.
3220 @vindex gnus-list-groups-with-ticked-articles
3221 Groups that have just ticked articles in it are normally listed in the
3222 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
3223 @code{nil}, these groups will be treated just like totally empty
3224 groups. It is @code{t} by default.
3227 @node Sorting Groups
3228 @section Sorting Groups
3229 @cindex sorting groups
3231 @kindex C-c C-s (Group)
3232 @findex gnus-group-sort-groups
3233 @vindex gnus-group-sort-function
3234 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3235 group buffer according to the function(s) given by the
3236 @code{gnus-group-sort-function} variable. Available sorting functions
3241 @item gnus-group-sort-by-alphabet
3242 @findex gnus-group-sort-by-alphabet
3243 Sort the group names alphabetically. This is the default.
3245 @item gnus-group-sort-by-real-name
3246 @findex gnus-group-sort-by-real-name
3247 Sort the group alphabetically on the real (unprefixed) group names.
3249 @item gnus-group-sort-by-level
3250 @findex gnus-group-sort-by-level
3251 Sort by group level.
3253 @item gnus-group-sort-by-score
3254 @findex gnus-group-sort-by-score
3255 Sort by group score. @xref{Group Score}.
3257 @item gnus-group-sort-by-rank
3258 @findex gnus-group-sort-by-rank
3259 Sort by group score and then the group level. The level and the score
3260 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3262 @item gnus-group-sort-by-unread
3263 @findex gnus-group-sort-by-unread
3264 Sort by number of unread articles.
3266 @item gnus-group-sort-by-method
3267 @findex gnus-group-sort-by-method
3268 Sort alphabetically on the select method.
3270 @item gnus-group-sort-by-server
3271 @findex gnus-group-sort-by-server
3272 Sort alphabetically on the Gnus server name.
3277 @code{gnus-group-sort-function} can also be a list of sorting
3278 functions. In that case, the most significant sort key function must be
3282 There are also a number of commands for sorting directly according to
3283 some sorting criteria:
3287 @kindex G S a (Group)
3288 @findex gnus-group-sort-groups-by-alphabet
3289 Sort the group buffer alphabetically by group name
3290 (@code{gnus-group-sort-groups-by-alphabet}).
3293 @kindex G S u (Group)
3294 @findex gnus-group-sort-groups-by-unread
3295 Sort the group buffer by the number of unread articles
3296 (@code{gnus-group-sort-groups-by-unread}).
3299 @kindex G S l (Group)
3300 @findex gnus-group-sort-groups-by-level
3301 Sort the group buffer by group level
3302 (@code{gnus-group-sort-groups-by-level}).
3305 @kindex G S v (Group)
3306 @findex gnus-group-sort-groups-by-score
3307 Sort the group buffer by group score
3308 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3311 @kindex G S r (Group)
3312 @findex gnus-group-sort-groups-by-rank
3313 Sort the group buffer by group rank
3314 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3317 @kindex G S m (Group)
3318 @findex gnus-group-sort-groups-by-method
3319 Sort the group buffer alphabetically by back end name@*
3320 (@code{gnus-group-sort-groups-by-method}).
3323 @kindex G S n (Group)
3324 @findex gnus-group-sort-groups-by-real-name
3325 Sort the group buffer alphabetically by real (unprefixed) group name
3326 (@code{gnus-group-sort-groups-by-real-name}).
3330 All the commands below obey the process/prefix convention
3331 (@pxref{Process/Prefix}).
3333 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3334 commands will sort in reverse order.
3336 You can also sort a subset of the groups:
3340 @kindex G P a (Group)
3341 @findex gnus-group-sort-selected-groups-by-alphabet
3342 Sort the groups alphabetically by group name
3343 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3346 @kindex G P u (Group)
3347 @findex gnus-group-sort-selected-groups-by-unread
3348 Sort the groups by the number of unread articles
3349 (@code{gnus-group-sort-selected-groups-by-unread}).
3352 @kindex G P l (Group)
3353 @findex gnus-group-sort-selected-groups-by-level
3354 Sort the groups by group level
3355 (@code{gnus-group-sort-selected-groups-by-level}).
3358 @kindex G P v (Group)
3359 @findex gnus-group-sort-selected-groups-by-score
3360 Sort the groups by group score
3361 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3364 @kindex G P r (Group)
3365 @findex gnus-group-sort-selected-groups-by-rank
3366 Sort the groups by group rank
3367 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3370 @kindex G P m (Group)
3371 @findex gnus-group-sort-selected-groups-by-method
3372 Sort the groups alphabetically by back end name@*
3373 (@code{gnus-group-sort-selected-groups-by-method}).
3376 @kindex G P n (Group)
3377 @findex gnus-group-sort-selected-groups-by-real-name
3378 Sort the groups alphabetically by real (unprefixed) group name
3379 (@code{gnus-group-sort-selected-groups-by-real-name}).
3382 @kindex G P s (Group)
3383 @findex gnus-group-sort-selected-groups
3384 Sort the groups according to @code{gnus-group-sort-function}.
3388 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3392 @node Group Maintenance
3393 @section Group Maintenance
3394 @cindex bogus groups
3399 @findex gnus-group-check-bogus-groups
3400 Find bogus groups and delete them
3401 (@code{gnus-group-check-bogus-groups}).
3405 @findex gnus-group-find-new-groups
3406 Find new groups and process them (@code{gnus-group-find-new-groups}).
3407 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3408 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3409 to query the server for new groups, and subscribe the new groups as
3413 @kindex C-c C-x (Group)
3414 @findex gnus-group-expire-articles
3415 Run all expirable articles in the current group through the expiry
3416 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3417 all expirable articles in the group that have been around for a while.
3418 (@pxref{Expiring Mail}).
3421 @kindex C-c C-M-x (Group)
3422 @findex gnus-group-expire-all-groups
3423 Run all expirable articles in all groups through the expiry process
3424 (@code{gnus-group-expire-all-groups}).
3429 @node Browse Foreign Server
3430 @section Browse Foreign Server
3431 @cindex foreign servers
3432 @cindex browsing servers
3437 @findex gnus-group-browse-foreign-server
3438 You will be queried for a select method and a server name. Gnus will
3439 then attempt to contact this server and let you browse the groups there
3440 (@code{gnus-group-browse-foreign-server}).
3443 @findex gnus-browse-mode
3444 A new buffer with a list of available groups will appear. This buffer
3445 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3446 a lot) like a normal group buffer.
3448 Here's a list of keystrokes available in the browse mode:
3453 @findex gnus-group-next-group
3454 Go to the next group (@code{gnus-group-next-group}).
3458 @findex gnus-group-prev-group
3459 Go to the previous group (@code{gnus-group-prev-group}).
3462 @kindex SPACE (Browse)
3463 @findex gnus-browse-read-group
3464 Enter the current group and display the first article
3465 (@code{gnus-browse-read-group}).
3468 @kindex RET (Browse)
3469 @findex gnus-browse-select-group
3470 Enter the current group (@code{gnus-browse-select-group}).
3474 @findex gnus-browse-unsubscribe-current-group
3475 Unsubscribe to the current group, or, as will be the case here,
3476 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3482 @findex gnus-browse-exit
3483 Exit browse mode (@code{gnus-browse-exit}).
3487 @findex gnus-browse-describe-group
3488 Describe the current group (@code{gnus-browse-describe-group}).
3492 @findex gnus-browse-describe-briefly
3493 Describe browse mode briefly (well, there's not much to describe, is
3494 there) (@code{gnus-browse-describe-briefly}).
3499 @section Exiting gnus
3500 @cindex exiting gnus
3502 Yes, gnus is ex(c)iting.
3507 @findex gnus-group-suspend
3508 Suspend gnus (@code{gnus-group-suspend}). This doesn't really exit gnus,
3509 but it kills all buffers except the Group buffer. I'm not sure why this
3510 is a gain, but then who am I to judge?
3514 @findex gnus-group-exit
3515 @c @icon{gnus-group-exit}
3516 Quit gnus (@code{gnus-group-exit}).
3520 @findex gnus-group-quit
3521 Quit gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3522 The dribble file will be saved, though (@pxref{Auto Save}).
3525 @vindex gnus-exit-gnus-hook
3526 @vindex gnus-suspend-gnus-hook
3527 @vindex gnus-after-exiting-gnus-hook
3528 @code{gnus-suspend-gnus-hook} is called when you suspend gnus and
3529 @code{gnus-exit-gnus-hook} is called when you quit gnus, while
3530 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3536 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3537 numbly heavy and herself fall into a hazy trance as the boy sitting
3538 behind her drew repeated lines with his pencil across the back of her
3544 @section Group Topics
3547 If you read lots and lots of groups, it might be convenient to group
3548 them hierarchically according to topics. You put your Emacs groups over
3549 here, your sex groups over there, and the rest (what, two groups or so?)
3550 you put in some misc section that you never bother with anyway. You can
3551 even group the Emacs sex groups as a sub-topic to either the Emacs
3552 groups or the sex groups---or both! Go wild!
3556 \gnusfigure{Group Topics}{400}{
3557 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3568 2: alt.religion.emacs
3571 0: comp.talk.emacs.recovery
3573 8: comp.binaries.fractals
3574 13: comp.sources.unix
3577 @findex gnus-topic-mode
3579 To get this @emph{fab} functionality you simply turn on (ooh!) the
3580 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3581 is a toggling command.)
3583 Go ahead, just try it. I'll still be here when you get back. La de
3584 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3585 Yes, and now press @kbd{l}. There. All your groups are now listed
3586 under @samp{misc}. Doesn't that make you feel all warm and fuzzy?
3589 If you want this permanently enabled, you should add that minor mode to
3590 the hook for the group mode. Put the following line in your
3591 @file{~/.gnus.el} file:
3594 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3598 * Topic Commands:: Interactive E-Z commands.
3599 * Topic Variables:: How to customize the topics the Lisp Way.
3600 * Topic Sorting:: Sorting each topic individually.
3601 * Topic Topology:: A map of the world.
3602 * Topic Parameters:: Parameters that apply to all groups in a topic.
3606 @node Topic Commands
3607 @subsection Topic Commands
3608 @cindex topic commands
3610 When the topic minor mode is turned on, a new @kbd{T} submap will be
3611 available. In addition, a few of the standard keys change their
3612 definitions slightly.
3614 In general, the following kinds of operations are possible on topics.
3615 First of all, you want to create topics. Secondly, you want to put
3616 groups in topics and to move them around until you have an order you
3617 like. The third kind of operation is to show/hide parts of the whole
3618 shebang. You might want to hide a topic including its subtopics and
3619 groups, to get a better overview of the other groups.
3621 Here is a list of the basic keys that you might need to set up topics
3628 @findex gnus-topic-create-topic
3629 Prompt for a new topic name and create it
3630 (@code{gnus-topic-create-topic}).
3634 @kindex T TAB (Topic)
3636 @findex gnus-topic-indent
3637 ``Indent'' the current topic so that it becomes a sub-topic of the
3638 previous topic (@code{gnus-topic-indent}). If given a prefix,
3639 ``un-indent'' the topic instead.
3642 @kindex M-TAB (Topic)
3643 @findex gnus-topic-unindent
3644 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3645 parent of its current parent (@code{gnus-topic-unindent}).
3649 The following two keys can be used to move groups and topics around.
3650 They work like the well-known cut and paste. @kbd{C-k} is like cut and
3651 @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms
3652 kill and yank rather than cut and paste.
3658 @findex gnus-topic-kill-group
3659 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3660 topic will be removed along with the topic.
3664 @findex gnus-topic-yank-group
3665 Yank the previously killed group or topic
3666 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3669 So, to move a topic to the beginning of the list of topics, just hit
3670 @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then,
3671 move the cursor to the beginning of the buffer (just below the ``Gnus''
3672 topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and
3673 paste. Like I said -- E-Z.
3675 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So
3676 you can move topics around as well as groups.
3680 After setting up the topics the way you like them, you might wish to
3681 hide a topic, or to show it again. That's why we have the following
3688 @findex gnus-topic-select-group
3690 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3691 When you perform this command on a group, you'll enter the group, as
3692 usual. When done on a topic line, the topic will be folded (if it was
3693 visible) or unfolded (if it was folded already). So it's basically a
3694 toggling command on topics. In addition, if you give a numerical
3695 prefix, group on that level (and lower) will be displayed.
3699 Now for a list of other commands, in no particular order.
3705 @findex gnus-topic-move-group
3706 Move the current group to some other topic
3707 (@code{gnus-topic-move-group}). This command uses the process/prefix
3708 convention (@pxref{Process/Prefix}).
3712 @findex gnus-topic-jump-to-topic
3713 Go to a topic (@code{gnus-topic-jump-to-topic}).
3717 @findex gnus-topic-copy-group
3718 Copy the current group to some other topic
3719 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3720 convention (@pxref{Process/Prefix}).
3724 @findex gnus-topic-hide-topic
3725 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3726 a prefix, hide the topic permanently.
3730 @findex gnus-topic-show-topic
3731 Show the current topic (@code{gnus-topic-show-topic}). If given
3732 a prefix, show the topic permanently.
3736 @findex gnus-topic-remove-group
3737 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3738 This command is mainly useful if you have the same group in several
3739 topics and wish to remove it from one of the topics. You may also
3740 remove a group from all topics, but in that case, Gnus will add it to
3741 the root topic the next time you start Gnus. In fact, all new groups
3742 (which, naturally, don't belong to any topic) will show up in the root
3745 This command uses the process/prefix convention
3746 (@pxref{Process/Prefix}).
3750 @findex gnus-topic-move-matching
3751 Move all groups that match some regular expression to a topic
3752 (@code{gnus-topic-move-matching}).
3756 @findex gnus-topic-copy-matching
3757 Copy all groups that match some regular expression to a topic
3758 (@code{gnus-topic-copy-matching}).
3762 @findex gnus-topic-toggle-display-empty-topics
3763 Toggle hiding empty topics
3764 (@code{gnus-topic-toggle-display-empty-topics}).
3768 @findex gnus-topic-mark-topic
3769 Mark all groups in the current topic with the process mark
3770 (@code{gnus-topic-mark-topic}). This command works recursively on
3771 sub-topics unless given a prefix.
3774 @kindex T M-# (Topic)
3775 @findex gnus-topic-unmark-topic
3776 Remove the process mark from all groups in the current topic
3777 (@code{gnus-topic-unmark-topic}). This command works recursively on
3778 sub-topics unless given a prefix.
3781 @kindex C-c C-x (Topic)
3782 @findex gnus-topic-expire-articles
3783 Run all expirable articles in the current group or topic through the
3784 expiry process (if any)
3785 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3789 @findex gnus-topic-rename
3790 Rename a topic (@code{gnus-topic-rename}).
3793 @kindex T DEL (Topic)
3794 @findex gnus-topic-delete
3795 Delete an empty topic (@code{gnus-topic-delete}).
3799 @findex gnus-topic-list-active
3800 List all groups that gnus knows about in a topics-ified way
3801 (@code{gnus-topic-list-active}).
3804 @kindex T M-n (Topic)
3805 @findex gnus-topic-goto-next-topic
3806 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3809 @kindex T M-p (Topic)
3810 @findex gnus-topic-goto-previous-topic
3811 Go to the next topic (@code{gnus-topic-goto-previous-topic}).
3815 @findex gnus-topic-edit-parameters
3816 @cindex group parameters
3817 @cindex topic parameters
3819 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3820 @xref{Topic Parameters}.
3825 @node Topic Variables
3826 @subsection Topic Variables
3827 @cindex topic variables
3829 The previous section told you how to tell Gnus which topics to display.
3830 This section explains how to tell Gnus what to display about each topic.
3832 @vindex gnus-topic-line-format
3833 The topic lines themselves are created according to the
3834 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3847 Number of groups in the topic.
3849 Number of unread articles in the topic.
3851 Number of unread articles in the topic and all its subtopics.
3854 @vindex gnus-topic-indent-level
3855 Each sub-topic (and the groups in the sub-topics) will be indented with
3856 @code{gnus-topic-indent-level} times the topic level number of spaces.
3859 @vindex gnus-topic-mode-hook
3860 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3862 @vindex gnus-topic-display-empty-topics
3863 The @code{gnus-topic-display-empty-topics} says whether to display even
3864 topics that have no unread articles in them. The default is @code{t}.
3868 @subsection Topic Sorting
3869 @cindex topic sorting
3871 You can sort the groups in each topic individually with the following
3877 @kindex T S a (Topic)
3878 @findex gnus-topic-sort-groups-by-alphabet
3879 Sort the current topic alphabetically by group name
3880 (@code{gnus-topic-sort-groups-by-alphabet}).
3883 @kindex T S u (Topic)
3884 @findex gnus-topic-sort-groups-by-unread
3885 Sort the current topic by the number of unread articles
3886 (@code{gnus-topic-sort-groups-by-unread}).
3889 @kindex T S l (Topic)
3890 @findex gnus-topic-sort-groups-by-level
3891 Sort the current topic by group level
3892 (@code{gnus-topic-sort-groups-by-level}).
3895 @kindex T S v (Topic)
3896 @findex gnus-topic-sort-groups-by-score
3897 Sort the current topic by group score
3898 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
3901 @kindex T S r (Topic)
3902 @findex gnus-topic-sort-groups-by-rank
3903 Sort the current topic by group rank
3904 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
3907 @kindex T S m (Topic)
3908 @findex gnus-topic-sort-groups-by-method
3909 Sort the current topic alphabetically by back end name
3910 (@code{gnus-topic-sort-groups-by-method}).
3913 @kindex T S e (Topic)
3914 @findex gnus-topic-sort-groups-by-server
3915 Sort the current topic alphabetically by server name
3916 (@code{gnus-topic-sort-groups-by-server}).
3919 @kindex T S s (Topic)
3920 @findex gnus-topic-sort-groups
3921 Sort the current topic according to the function(s) given by the
3922 @code{gnus-group-sort-function} variable
3923 (@code{gnus-topic-sort-groups}).
3927 When given a prefix argument, all these commands will sort in reverse
3928 order. @xref{Sorting Groups}, for more information about group
3932 @node Topic Topology
3933 @subsection Topic Topology
3934 @cindex topic topology
3937 So, let's have a look at an example group buffer:
3944 2: alt.religion.emacs
3947 0: comp.talk.emacs.recovery
3949 8: comp.binaries.fractals
3950 13: comp.sources.unix
3954 So, here we have one top-level topic (@samp{Gnus}), two topics under
3955 that, and one sub-topic under one of the sub-topics. (There is always
3956 just one (1) top-level topic). This topology can be expressed as
3961 (("Emacs -- I wuw it!" visible)
3962 (("Naughty Emacs" visible)))
3966 @vindex gnus-topic-topology
3967 This is in fact how the variable @code{gnus-topic-topology} would look
3968 for the display above. That variable is saved in the @file{.newsrc.eld}
3969 file, and shouldn't be messed with manually---unless you really want
3970 to. Since this variable is read from the @file{.newsrc.eld} file,
3971 setting it in any other startup files will have no effect.
3973 This topology shows what topics are sub-topics of what topics (right),
3974 and which topics are visible. Two settings are currently
3975 allowed---@code{visible} and @code{invisible}.
3978 @node Topic Parameters
3979 @subsection Topic Parameters
3980 @cindex topic parameters
3982 All groups in a topic will inherit group parameters from the parent
3983 (and ancestor) topic parameters. All valid group parameters are valid
3984 topic parameters (@pxref{Group Parameters}). When the agent is
3985 enabled, all agent parameters (See Agent Parameters in @ref{Category
3986 Syntax}) are also valid topic parameters.
3988 In addition, the following parameters are only valid as topic
3993 When subscribing new groups by topic (@pxref{Subscription Methods}), the
3994 @code{subscribe} topic parameter says what groups go in what topic. Its
3995 value should be a regexp to match the groups that should go in that
3998 @item subscribe-level
3999 When subscribing new groups by topic (see the @code{subscribe} parameter),
4000 the group will be subscribed with the level specified in the
4001 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
4005 Group parameters (of course) override topic parameters, and topic
4006 parameters in sub-topics override topic parameters in super-topics. You
4007 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
4008 verb, although you may feel free to disagree with me here.)
4015 2: alt.religion.emacs
4019 0: comp.talk.emacs.recovery
4021 8: comp.binaries.fractals
4022 13: comp.sources.unix
4027 The @samp{Emacs} topic has the topic parameter @code{(score-file
4028 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4029 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4030 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
4031 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4032 . "religion.SCORE")}.
4034 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4035 will get the @file{relief.SCORE} home score file. If you enter the same
4036 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4037 score file. If you enter the group @samp{alt.religion.emacs}, you'll
4038 get the @file{religion.SCORE} home score file.
4040 This seems rather simple and self-evident, doesn't it? Well, yes. But
4041 there are some problems, especially with the @code{total-expiry}
4042 parameter. Say you have a mail group in two topics; one with
4043 @code{total-expiry} and one without. What happens when you do @kbd{M-x
4044 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
4045 of these topics you mean to expire articles from, so anything may
4046 happen. In fact, I hereby declare that it is @dfn{undefined} what
4047 happens. You just have to be careful if you do stuff like that.
4050 @node Misc Group Stuff
4051 @section Misc Group Stuff
4054 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
4055 * Group Information:: Information and help on groups and Gnus.
4056 * Group Timestamp:: Making Gnus keep track of when you last read a group.
4057 * File Commands:: Reading and writing the Gnus files.
4058 * Sieve Commands:: Managing Sieve scripts.
4065 @findex gnus-group-enter-server-mode
4066 Enter the server buffer (@code{gnus-group-enter-server-mode}).
4067 @xref{Server Buffer}.
4071 @findex gnus-group-post-news
4072 Start composing a message (a news by default)
4073 (@code{gnus-group-post-news}). If given a prefix, post to the group
4074 under the point. If the prefix is 1, prompt for a group to post to.
4075 Contrary to what the name of this function suggests, the prepared
4076 article might be a mail instead of a news, if a mail group is specified
4077 with the prefix argument. @xref{Composing Messages}.
4081 @findex gnus-group-mail
4082 Mail a message somewhere (@code{gnus-group-mail}). If given a prefix,
4083 use the posting style of the group under the point. If the prefix is 1,
4084 prompt for a group name to find the posting style.
4085 @xref{Composing Messages}.
4089 @findex gnus-group-news
4090 Start composing a news (@code{gnus-group-news}). If given a prefix,
4091 post to the group under the point. If the prefix is 1, prompt
4092 for group to post to. @xref{Composing Messages}.
4094 This function actually prepares a news even when using mail groups.
4095 This is useful for ``posting'' messages to mail groups without actually
4096 sending them over the network: they're just saved directly to the group
4097 in question. The corresponding back end must have a request-post method
4098 for this to work though.
4102 Variables for the group buffer:
4106 @item gnus-group-mode-hook
4107 @vindex gnus-group-mode-hook
4108 is called after the group buffer has been
4111 @item gnus-group-prepare-hook
4112 @vindex gnus-group-prepare-hook
4113 is called after the group buffer is
4114 generated. It may be used to modify the buffer in some strange,
4117 @item gnus-group-prepared-hook
4118 @vindex gnus-group-prepare-hook
4119 is called as the very last thing after the group buffer has been
4120 generated. It may be used to move point around, for instance.
4122 @item gnus-permanently-visible-groups
4123 @vindex gnus-permanently-visible-groups
4124 Groups matching this regexp will always be listed in the group buffer,
4125 whether they are empty or not.
4127 @item gnus-group-name-charset-method-alist
4128 @vindex gnus-group-name-charset-method-alist
4129 An alist of method and the charset for group names. It is used to show
4130 non-@acronym{ASCII} group names.
4134 (setq gnus-group-name-charset-method-alist
4135 '(((nntp "news.com.cn") . cn-gb-2312)))
4138 @item gnus-group-name-charset-group-alist
4139 @cindex UTF-8 group names
4140 @vindex gnus-group-name-charset-group-alist
4141 An alist of regexp of group name and the charset for group names. It
4142 is used to show non-@acronym{ASCII} group names. @code{((".*"
4143 utf-8))} is the default value if UTF-8 is supported, otherwise the
4144 default is @code{nil}.
4148 (setq gnus-group-name-charset-group-alist
4149 '(("\\.com\\.cn:" . cn-gb-2312)))
4154 @node Scanning New Messages
4155 @subsection Scanning New Messages
4156 @cindex new messages
4157 @cindex scanning new news
4163 @findex gnus-group-get-new-news
4164 @c @icon{gnus-group-get-new-news}
4165 Check the server(s) for new articles. If the numerical prefix is used,
4166 this command will check only groups of level @var{arg} and lower
4167 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
4168 command will force a total re-reading of the active file(s) from the
4173 @findex gnus-group-get-new-news-this-group
4174 @vindex gnus-goto-next-group-when-activating
4175 @c @icon{gnus-group-get-new-news-this-group}
4176 Check whether new articles have arrived in the current group
4177 (@code{gnus-group-get-new-news-this-group}).
4178 @code{gnus-goto-next-group-when-activating} says whether this command is
4179 to move point to the next group or not. It is @code{t} by default.
4181 @findex gnus-activate-all-groups
4182 @cindex activating groups
4184 @kindex C-c M-g (Group)
4185 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4190 @findex gnus-group-restart
4191 Restart gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
4192 file(s), closes the connection to all servers, clears up all run-time
4193 gnus variables, and then starts gnus all over again.
4197 @vindex gnus-get-new-news-hook
4198 @code{gnus-get-new-news-hook} is run just before checking for new news.
4200 @vindex gnus-after-getting-new-news-hook
4201 @code{gnus-after-getting-new-news-hook} is run after checking for new
4205 @node Group Information
4206 @subsection Group Information
4207 @cindex group information
4208 @cindex information on groups
4215 @findex gnus-group-fetch-faq
4216 @vindex gnus-group-faq-directory
4219 Try to fetch the @acronym{FAQ} for the current group
4220 (@code{gnus-group-fetch-faq}). Gnus will try to get the @acronym{FAQ}
4221 from @code{gnus-group-faq-directory}, which is usually a directory on
4222 a remote machine. This variable can also be a list of directories.
4223 In that case, giving a prefix to this command will allow you to choose
4224 between the various sites. @code{ange-ftp} (or @code{efs}) will be
4225 used for fetching the file.
4227 If fetching from the first site is unsuccessful, gnus will attempt to go
4228 through @code{gnus-group-faq-directory} and try to open them one by one.
4232 @findex gnus-group-fetch-charter
4233 @vindex gnus-group-charter-alist
4235 Try to open the charter for the current group in a web browser
4236 (@code{gnus-group-fetch-charter}). Query for a group if given a
4239 Gnus will use @code{gnus-group-charter-alist} to find the location of
4240 the charter. If no location is known, Gnus will fetch the control
4241 messages for the group, which in some cases includes the charter.
4245 @findex gnus-group-fetch-control
4246 @vindex gnus-group-fetch-control-use-browse-url
4247 @cindex control message
4248 Fetch the control messages for the group from the archive at
4249 @code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a
4250 group if given a prefix argument.
4252 If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
4253 Gnus will open the control messages in a browser using
4254 @code{browse-url}. Otherwise they are fetched using @code{ange-ftp}
4255 and displayed in an ephemeral group.
4257 Note that the control messages are compressed. To use this command
4258 you need to turn on @code{auto-compression-mode} (@pxref{Compressed
4259 Files, ,Compressed Files, emacs, The Emacs Manual}).
4263 @c @icon{gnus-group-describe-group}
4265 @kindex C-c C-d (Group)
4266 @cindex describing groups
4267 @cindex group description
4268 @findex gnus-group-describe-group
4269 Describe the current group (@code{gnus-group-describe-group}). If given
4270 a prefix, force Gnus to re-read the description from the server.
4274 @findex gnus-group-describe-all-groups
4275 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
4276 prefix, force gnus to re-read the description file from the server.
4283 @findex gnus-version
4284 Display current gnus version numbers (@code{gnus-version}).
4288 @findex gnus-group-describe-briefly
4289 Give a very short help message (@code{gnus-group-describe-briefly}).
4292 @kindex C-c C-i (Group)
4295 @findex gnus-info-find-node
4296 Go to the gnus info node (@code{gnus-info-find-node}).
4300 @node Group Timestamp
4301 @subsection Group Timestamp
4303 @cindex group timestamps
4305 It can be convenient to let gnus keep track of when you last read a
4306 group. To set the ball rolling, you should add
4307 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4310 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4313 After doing this, each time you enter a group, it'll be recorded.
4315 This information can be displayed in various ways---the easiest is to
4316 use the @samp{%d} spec in the group line format:
4319 (setq gnus-group-line-format
4320 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4323 This will result in lines looking like:
4326 * 0: mail.ding 19961002T012943
4327 0: custom 19961002T012713
4330 As you can see, the date is displayed in compact ISO 8601 format. This
4331 may be a bit too much, so to just display the date, you could say
4335 (setq gnus-group-line-format
4336 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4339 If you would like greater control of the time format, you can use a
4340 user-defined format spec. Something like the following should do the
4344 (setq gnus-group-line-format
4345 "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4346 (defun gnus-user-format-function-d (headers)
4347 (let ((time (gnus-group-timestamp gnus-tmp-group)))
4349 (format-time-string "%b %d %H:%M" time)
4355 @subsection File Commands
4356 @cindex file commands
4362 @findex gnus-group-read-init-file
4363 @vindex gnus-init-file
4364 @cindex reading init file
4365 Re-read the init file (@code{gnus-init-file}, which defaults to
4366 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
4370 @findex gnus-group-save-newsrc
4371 @cindex saving .newsrc
4372 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4373 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
4374 file(s) whether Gnus thinks it is necessary or not.
4377 @c @kindex Z (Group)
4378 @c @findex gnus-group-clear-dribble
4379 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4384 @node Sieve Commands
4385 @subsection Sieve Commands
4386 @cindex group sieve commands
4388 Sieve is a server-side mail filtering language. In Gnus you can use
4389 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4390 sieve rules that should apply to each group. Gnus provides two
4391 commands to translate all these group parameters into a proper Sieve
4392 script that can be transfered to the server somehow.
4394 @vindex gnus-sieve-file
4395 @vindex gnus-sieve-region-start
4396 @vindex gnus-sieve-region-end
4397 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4398 default @file{~/.sieve}). The Sieve code that Gnus generate is placed
4399 between two delimiters, @code{gnus-sieve-region-start} and
4400 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4401 outside these delimiters that will not be removed the next time you
4402 regenerate the Sieve script.
4404 @vindex gnus-sieve-crosspost
4405 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4406 is generated. If it is non-@code{nil} (the default) articles is
4407 placed in all groups that have matching rules, otherwise the article
4408 is only placed in the group with the first matching rule. For
4409 example, the group parameter @samp{(sieve address "sender"
4410 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4411 code if @code{gnus-sieve-crosspost} is @code{nil}. (When
4412 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
4413 except that the line containing the call to @code{stop} is removed.)
4416 if address "sender" "owner-ding@@hpc.uh.edu" @{
4417 fileinto "INBOX.ding";
4422 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
4428 @findex gnus-sieve-generate
4429 @vindex gnus-sieve-file
4430 @cindex generating sieve script
4431 Regenerate a Sieve script from the @code{sieve} group parameters and
4432 put you into the @code{gnus-sieve-file} without saving it.
4436 @findex gnus-sieve-update
4437 @vindex gnus-sieve-file
4438 @cindex updating sieve script
4439 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4440 @code{sieve} group parameters, save the file and upload it to the
4441 server using the @code{sieveshell} program.
4446 @node Summary Buffer
4447 @chapter Summary Buffer
4448 @cindex summary buffer
4450 A line for each article is displayed in the summary buffer. You can
4451 move around, read articles, post articles and reply to articles.
4453 The most common way to a summary buffer is to select a group from the
4454 group buffer (@pxref{Selecting a Group}).
4456 You can have as many summary buffers open as you wish.
4459 * Summary Buffer Format:: Deciding how the summary buffer is to look.
4460 * Summary Maneuvering:: Moving around the summary buffer.
4461 * Choosing Articles:: Reading articles.
4462 * Paging the Article:: Scrolling the current article.
4463 * Reply Followup and Post:: Posting articles.
4464 * Delayed Articles:: Send articles at a later time.
4465 * Marking Articles:: Marking articles as read, expirable, etc.
4466 * Limiting:: You can limit the summary buffer.
4467 * Threading:: How threads are made.
4468 * Sorting the Summary Buffer:: How articles and threads are sorted.
4469 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
4470 * Article Caching:: You may store articles in a cache.
4471 * Persistent Articles:: Making articles expiry-resistant.
4472 * Article Backlog:: Having already read articles hang around.
4473 * Saving Articles:: Ways of customizing article saving.
4474 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
4475 * Article Treatment:: The article buffer can be mangled at will.
4476 * MIME Commands:: Doing MIMEy things with the articles.
4477 * Charsets:: Character set issues.
4478 * Article Commands:: Doing various things with the article buffer.
4479 * Summary Sorting:: Sorting the summary buffer in various ways.
4480 * Finding the Parent:: No child support? Get the parent.
4481 * Alternative Approaches:: Reading using non-default summaries.
4482 * Tree Display:: A more visual display of threads.
4483 * Mail Group Commands:: Some commands can only be used in mail groups.
4484 * Various Summary Stuff:: What didn't fit anywhere else.
4485 * Exiting the Summary Buffer:: Returning to the Group buffer,
4486 or reselecting the current group.
4487 * Crosspost Handling:: How crossposted articles are dealt with.
4488 * Duplicate Suppression:: An alternative when crosspost handling fails.
4489 * Security:: Decrypt and Verify.
4490 * Mailing List:: Mailing list minor mode.
4494 @node Summary Buffer Format
4495 @section Summary Buffer Format
4496 @cindex summary buffer format
4500 \gnusfigure{The Summary Buffer}{180}{
4501 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4502 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4508 * Summary Buffer Lines:: You can specify how summary lines should look.
4509 * To From Newsgroups:: How to not display your own name.
4510 * Summary Buffer Mode Line:: You can say how the mode line should look.
4511 * Summary Highlighting:: Making the summary buffer all pretty and nice.
4514 @findex mail-extract-address-components
4515 @findex gnus-extract-address-components
4516 @vindex gnus-extract-address-components
4517 Gnus will use the value of the @code{gnus-extract-address-components}
4518 variable as a function for getting the name and address parts of a
4519 @code{From} header. Three pre-defined functions exist:
4520 @code{gnus-extract-address-components}, which is the default, quite
4521 fast, and too simplistic solution;
4522 @code{mail-extract-address-components}, which works nicely, but is
4523 slower; and @code{std11-extract-address-components}, which works very
4524 nicely, but is slower. The default function will return the wrong
4525 answer in 5% of the cases. If this is unacceptable to you, use the
4526 other function instead:
4529 (setq gnus-extract-address-components
4530 'mail-extract-address-components)
4533 @vindex gnus-summary-same-subject
4534 @code{gnus-summary-same-subject} is a string indicating that the current
4535 article has the same subject as the previous. This string will be used
4536 with those specs that require it. The default is @code{""}.
4539 @node Summary Buffer Lines
4540 @subsection Summary Buffer Lines
4542 @vindex gnus-summary-line-format
4543 You can change the format of the lines in the summary buffer by changing
4544 the @code{gnus-summary-line-format} variable. It works along the same
4545 lines as a normal @code{format} string, with some extensions
4546 (@pxref{Formatting Variables}).
4548 There should always be a colon or a point position marker on the line;
4549 the cursor always moves to the point position marker or the colon after
4550 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
4551 possible to change this. Just write a new function
4552 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4553 @xref{Positioning Point}.
4555 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4557 The following format specification characters and extended format
4558 specification(s) are understood:
4564 Subject string. List identifiers stripped,
4565 @code{gnus-list-identifies}. @xref{Article Hiding}.
4567 Subject if the article is the root of the thread or the previous article
4568 had a different subject, @code{gnus-summary-same-subject} otherwise.
4569 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4571 Full @code{From} header.
4573 The name (from the @code{From} header).
4575 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4578 The name (from the @code{From} header). This differs from the @code{n}
4579 spec in that it uses the function designated by the
4580 @code{gnus-extract-address-components} variable, which is slower, but
4581 may be more thorough.
4583 The address (from the @code{From} header). This works the same way as
4586 Number of lines in the article.
4588 Number of characters in the article. This specifier is not supported
4589 in some methods (like nnfolder).
4591 Pretty-printed version of the number of characters in the article;
4592 for example, @samp{1.2k} or @samp{0.4M}.
4594 Indentation based on thread level (@pxref{Customizing Threading}).
4596 A complex trn-style thread tree, showing response-connecting trace
4597 lines. A thread could be drawn like this:
4610 You can customize the appearance with the following options. Note
4611 that it is possible to make the thread display look really neat by
4612 replacing the default @acronym{ASCII} characters with graphic
4613 line-drawing glyphs.
4615 @item gnus-sum-thread-tree-root
4616 @vindex gnus-sum-thread-tree-root
4617 Used for the root of a thread. If @code{nil}, use subject
4618 instead. The default is @samp{> }.
4620 @item gnus-sum-thread-tree-false-root
4621 @vindex gnus-sum-thread-tree-false-root
4622 Used for the false root of a thread (@pxref{Loose Threads}). If
4623 @code{nil}, use subject instead. The default is @samp{> }.
4625 @item gnus-sum-thread-tree-single-indent
4626 @vindex gnus-sum-thread-tree-single-indent
4627 Used for a thread with just one message. If @code{nil}, use subject
4628 instead. The default is @samp{}.
4630 @item gnus-sum-thread-tree-vertical
4631 @vindex gnus-sum-thread-tree-vertical
4632 Used for drawing a vertical line. The default is @samp{| }.
4634 @item gnus-sum-thread-tree-indent
4635 @vindex gnus-sum-thread-tree-indent
4636 Used for indenting. The default is @samp{ }.
4638 @item gnus-sum-thread-tree-leaf-with-other
4639 @vindex gnus-sum-thread-tree-leaf-with-other
4640 Used for a leaf with brothers. The default is @samp{+-> }.
4642 @item gnus-sum-thread-tree-single-leaf
4643 @vindex gnus-sum-thread-tree-single-leaf
4644 Used for a leaf without brothers. The default is @samp{\-> }
4649 Nothing if the article is a root and lots of spaces if it isn't (it
4650 pushes everything after it off the screen).
4652 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4653 for adopted articles (@pxref{Customizing Threading}).
4655 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4656 for adopted articles.
4658 One space for each thread level.
4660 Twenty minus thread level spaces.
4662 Unread. @xref{Read Articles}.
4665 This misleadingly named specifier is the @dfn{secondary mark}. This
4666 mark will say whether the article has been replied to, has been cached,
4667 or has been saved. @xref{Other Marks}.
4670 Score as a number (@pxref{Scoring}).
4672 @vindex gnus-summary-zcore-fuzz
4673 Zcore, @samp{+} if above the default level and @samp{-} if below the
4674 default level. If the difference between
4675 @code{gnus-summary-default-score} and the score is less than
4676 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4684 The @code{Date} in @code{DD-MMM} format.
4686 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4692 Number of articles in the current sub-thread. Using this spec will slow
4693 down summary buffer generation somewhat.
4695 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4696 article has any children.
4702 Age sensitive date format. Various date format is defined in
4703 @code{gnus-user-date-format-alist}.
4705 User defined specifier. The next character in the format string should
4706 be a letter. Gnus will call the function
4707 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
4708 following @samp{%u}. The function will be passed the current header as
4709 argument. The function should return a string, which will be inserted
4710 into the summary just like information from any other summary specifier.
4713 Text between @samp{%(} and @samp{%)} will be highlighted with
4714 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4715 There can only be one such area.
4717 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4718 have to be handled with care. For reasons of efficiency, gnus will
4719 compute what column these characters will end up in, and ``hard-code''
4720 that. This means that it is invalid to have these specs after a
4721 variable-length spec. Well, you might not be arrested, but your summary
4722 buffer will look strange, which is bad enough.
4724 The smart choice is to have these specs as far to the left as possible.
4725 (Isn't that the case with everything, though? But I digress.)
4727 This restriction may disappear in later versions of gnus.
4730 @node To From Newsgroups
4731 @subsection To From Newsgroups
4735 In some groups (particularly in archive groups), the @code{From} header
4736 isn't very interesting, since all the articles there are written by
4737 you. To display the information in the @code{To} or @code{Newsgroups}
4738 headers instead, you need to decide three things: What information to
4739 gather; where to display it; and when to display it.
4743 @vindex gnus-extra-headers
4744 The reading of extra header information is controlled by the
4745 @code{gnus-extra-headers}. This is a list of header symbols. For
4749 (setq gnus-extra-headers
4750 '(To Newsgroups X-Newsreader))
4753 This will result in Gnus trying to obtain these three headers, and
4754 storing it in header structures for later easy retrieval.
4757 @findex gnus-extra-header
4758 The value of these extra headers can be accessed via the
4759 @code{gnus-extra-header} function. Here's a format line spec that will
4760 access the @code{X-Newsreader} header:
4763 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4767 @vindex gnus-ignored-from-addresses
4768 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4769 summary line spec returns the @code{To}, @code{Newsreader} or
4770 @code{From} header. If this regexp matches the contents of the
4771 @code{From} header, the value of the @code{To} or @code{Newsreader}
4772 headers are used instead.
4776 @vindex nnmail-extra-headers
4777 A related variable is @code{nnmail-extra-headers}, which controls when
4778 to include extra headers when generating overview (@acronym{NOV}) files.
4779 If you have old overview files, you should regenerate them after
4780 changing this variable, by entering the server buffer using @kbd{^},
4781 and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause
4784 @vindex gnus-summary-line-format
4785 You also have to instruct Gnus to display the data by changing the
4786 @code{%n} spec to the @code{%f} spec in the
4787 @code{gnus-summary-line-format} variable.
4789 In summary, you'd typically put something like the following in
4793 (setq gnus-extra-headers
4795 (setq nnmail-extra-headers gnus-extra-headers)
4796 (setq gnus-summary-line-format
4797 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
4798 (setq gnus-ignored-from-addresses
4802 (The values listed above are the default values in Gnus. Alter them
4805 A note for news server administrators, or for users who wish to try to
4806 convince their news server administrator to provide some additional
4809 The above is mostly useful for mail groups, where you have control over
4810 the @acronym{NOV} files that are created. However, if you can persuade your
4811 nntp admin to add (in the usual implementation, notably INN):
4817 to the end of her @file{overview.fmt} file, then you can use that just
4818 as you would the extra headers from the mail groups.
4821 @node Summary Buffer Mode Line
4822 @subsection Summary Buffer Mode Line
4824 @vindex gnus-summary-mode-line-format
4825 You can also change the format of the summary mode bar (@pxref{Mode Line
4826 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
4827 like. The default is @samp{Gnus: %%b [%A] %Z}.
4829 Here are the elements you can play with:
4835 Unprefixed group name.
4837 Current article number.
4839 Current article score.
4843 Number of unread articles in this group.
4845 Number of unread articles in this group that aren't displayed in the
4848 A string with the number of unread and unselected articles represented
4849 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4850 articles, and just as @samp{<%U more>} if there are just unread articles
4851 and no unselected ones.
4853 Shortish group name. For instance, @samp{rec.arts.anime} will be
4854 shortened to @samp{r.a.anime}.
4856 Subject of the current article.
4858 User-defined spec (@pxref{User-Defined Specs}).
4860 Name of the current score file (@pxref{Scoring}).
4862 Number of dormant articles (@pxref{Unread Articles}).
4864 Number of ticked articles (@pxref{Unread Articles}).
4866 Number of articles that have been marked as read in this session.
4868 Number of articles expunged by the score files.
4872 @node Summary Highlighting
4873 @subsection Summary Highlighting
4877 @item gnus-visual-mark-article-hook
4878 @vindex gnus-visual-mark-article-hook
4879 This hook is run after selecting an article. It is meant to be used for
4880 highlighting the article in some way. It is not run if
4881 @code{gnus-visual} is @code{nil}.
4883 @item gnus-summary-update-hook
4884 @vindex gnus-summary-update-hook
4885 This hook is called when a summary line is changed. It is not run if
4886 @code{gnus-visual} is @code{nil}.
4888 @item gnus-summary-selected-face
4889 @vindex gnus-summary-selected-face
4890 This is the face (or @dfn{font} as some people call it) used to
4891 highlight the current article in the summary buffer.
4893 @item gnus-summary-highlight
4894 @vindex gnus-summary-highlight
4895 Summary lines are highlighted according to this variable, which is a
4896 list where the elements are of the format @code{(@var{form}
4897 . @var{face})}. If you would, for instance, like ticked articles to be
4898 italic and high-scored articles to be bold, you could set this variable
4901 (((eq mark gnus-ticked-mark) . italic)
4902 ((> score default) . bold))
4904 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4905 @var{face} will be applied to the line.
4909 @node Summary Maneuvering
4910 @section Summary Maneuvering
4911 @cindex summary movement
4913 All the straight movement commands understand the numeric prefix and
4914 behave pretty much as you'd expect.
4916 None of these commands select articles.
4921 @kindex M-n (Summary)
4922 @kindex G M-n (Summary)
4923 @findex gnus-summary-next-unread-subject
4924 Go to the next summary line of an unread article
4925 (@code{gnus-summary-next-unread-subject}).
4929 @kindex M-p (Summary)
4930 @kindex G M-p (Summary)
4931 @findex gnus-summary-prev-unread-subject
4932 Go to the previous summary line of an unread article
4933 (@code{gnus-summary-prev-unread-subject}).
4936 @kindex G g (Summary)
4937 @findex gnus-summary-goto-subject
4938 Ask for an article number and then go to the summary line of that article
4939 without displaying the article (@code{gnus-summary-goto-subject}).
4942 If gnus asks you to press a key to confirm going to the next group, you
4943 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4944 buffer, searching for the next group to read without actually returning
4945 to the group buffer.
4947 Variables related to summary movement:
4951 @vindex gnus-auto-select-next
4952 @item gnus-auto-select-next
4953 If you issue one of the movement commands (like @kbd{n}) and there are
4954 no more unread articles after the current one, gnus will offer to go to
4955 the next group. If this variable is @code{t} and the next group is
4956 empty, gnus will exit summary mode and return to the group buffer. If
4957 this variable is neither @code{t} nor @code{nil}, gnus will select the
4958 next group with unread articles. As a special case, if this variable
4959 is @code{quietly}, Gnus will select the next group without asking for
4960 confirmation. If this variable is @code{almost-quietly}, the same
4961 will happen only if you are located on the last article in the group.
4962 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
4963 command will go to the next group without confirmation. Also
4964 @pxref{Group Levels}.
4966 @item gnus-auto-select-same
4967 @vindex gnus-auto-select-same
4968 If non-@code{nil}, all the movement commands will try to go to the next
4969 article with the same subject as the current. (@dfn{Same} here might
4970 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
4971 for details (@pxref{Customizing Threading}).) If there are no more
4972 articles with the same subject, go to the first unread article.
4974 This variable is not particularly useful if you use a threaded display.
4976 @item gnus-summary-check-current
4977 @vindex gnus-summary-check-current
4978 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4979 to the next (or previous) article if the current article is unread.
4980 Instead, they will choose the current article.
4982 @item gnus-auto-center-summary
4983 @vindex gnus-auto-center-summary
4984 If non-@code{nil}, gnus will keep the point in the summary buffer
4985 centered at all times. This makes things quite tidy, but if you have a
4986 slow network connection, or simply do not like this un-Emacsism, you can
4987 set this variable to @code{nil} to get the normal Emacs scrolling
4988 action. This will also inhibit horizontal re-centering of the summary
4989 buffer, which might make it more inconvenient to read extremely long
4992 This variable can also be a number. In that case, center the window at
4993 the given number of lines from the top.
4998 @node Choosing Articles
4999 @section Choosing Articles
5000 @cindex selecting articles
5003 * Choosing Commands:: Commands for choosing articles.
5004 * Choosing Variables:: Variables that influence these commands.
5008 @node Choosing Commands
5009 @subsection Choosing Commands
5011 None of the following movement commands understand the numeric prefix,
5012 and they all select and display an article.
5014 If you want to fetch new articles or redisplay the group, see
5015 @ref{Exiting the Summary Buffer}.
5019 @kindex SPACE (Summary)
5020 @findex gnus-summary-next-page
5021 Select the current article, or, if that one's read already, the next
5022 unread article (@code{gnus-summary-next-page}).
5024 If you have an article window open already and you press @kbd{SPACE}
5025 again, the article will be scrolled. This lets you conveniently
5026 @kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}.
5031 @kindex G n (Summary)
5032 @findex gnus-summary-next-unread-article
5033 @c @icon{gnus-summary-next-unread}
5034 Go to next unread article (@code{gnus-summary-next-unread-article}).
5039 @findex gnus-summary-prev-unread-article
5040 @c @icon{gnus-summary-prev-unread}
5041 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
5046 @kindex G N (Summary)
5047 @findex gnus-summary-next-article
5048 Go to the next article (@code{gnus-summary-next-article}).
5053 @kindex G P (Summary)
5054 @findex gnus-summary-prev-article
5055 Go to the previous article (@code{gnus-summary-prev-article}).
5058 @kindex G C-n (Summary)
5059 @findex gnus-summary-next-same-subject
5060 Go to the next article with the same subject
5061 (@code{gnus-summary-next-same-subject}).
5064 @kindex G C-p (Summary)
5065 @findex gnus-summary-prev-same-subject
5066 Go to the previous article with the same subject
5067 (@code{gnus-summary-prev-same-subject}).
5071 @kindex G f (Summary)
5073 @findex gnus-summary-first-unread-article
5074 Go to the first unread article
5075 (@code{gnus-summary-first-unread-article}).
5079 @kindex G b (Summary)
5081 @findex gnus-summary-best-unread-article
5082 Go to the unread article with the highest score
5083 (@code{gnus-summary-best-unread-article}). If given a prefix argument,
5084 go to the first unread article that has a score over the default score.
5089 @kindex G l (Summary)
5090 @findex gnus-summary-goto-last-article
5091 Go to the previous article read (@code{gnus-summary-goto-last-article}).
5094 @kindex G o (Summary)
5095 @findex gnus-summary-pop-article
5097 @cindex article history
5098 Pop an article off the summary history and go to this article
5099 (@code{gnus-summary-pop-article}). This command differs from the
5100 command above in that you can pop as many previous articles off the
5101 history as you like, while @kbd{l} toggles the two last read articles.
5102 For a somewhat related issue (if you use these commands a lot),
5103 @pxref{Article Backlog}.
5108 @kindex G j (Summary)
5109 @findex gnus-summary-goto-article
5110 Ask for an article number or @code{Message-ID}, and then go to that
5111 article (@code{gnus-summary-goto-article}).
5116 @node Choosing Variables
5117 @subsection Choosing Variables
5119 Some variables relevant for moving and selecting articles:
5122 @item gnus-auto-extend-newsgroup
5123 @vindex gnus-auto-extend-newsgroup
5124 All the movement commands will try to go to the previous (or next)
5125 article, even if that article isn't displayed in the Summary buffer if
5126 this variable is non-@code{nil}. Gnus will then fetch the article from
5127 the server and display it in the article buffer.
5129 @item gnus-select-article-hook
5130 @vindex gnus-select-article-hook
5131 This hook is called whenever an article is selected. By default it
5132 exposes any threads hidden under the selected article. If you would
5133 like each article to be saved in the Agent as you read it, putting
5134 @code{gnus-agent-fetch-selected-article} on this hook will do so.
5136 @item gnus-mark-article-hook
5137 @vindex gnus-mark-article-hook
5138 @findex gnus-summary-mark-unread-as-read
5139 @findex gnus-summary-mark-read-and-unread-as-read
5140 @findex gnus-unread-mark
5141 This hook is called whenever an article is selected. It is intended to
5142 be used for marking articles as read. The default value is
5143 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
5144 mark of almost any article you read to @code{gnus-unread-mark}. The
5145 only articles not affected by this function are ticked, dormant, and
5146 expirable articles. If you'd instead like to just have unread articles
5147 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
5148 instead. It will leave marks like @code{gnus-low-score-mark},
5149 @code{gnus-del-mark} (and so on) alone.
5154 @node Paging the Article
5155 @section Scrolling the Article
5156 @cindex article scrolling
5161 @kindex SPACE (Summary)
5162 @findex gnus-summary-next-page
5163 Pressing @kbd{SPACE} will scroll the current article forward one page,
5164 or, if you have come to the end of the current article, will choose the
5165 next article (@code{gnus-summary-next-page}).
5167 @vindex gnus-article-boring-faces
5168 @vindex gnus-article-skip-boring
5169 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
5170 the article consists only of citations and signature, then it will be
5171 skipped; the next article will be shown instead. You can customize
5172 what is considered uninteresting with
5173 @code{gnus-article-boring-faces}. You can manually view the article's
5174 pages, no matter how boring, using @kbd{C-M-v}.
5177 @kindex DEL (Summary)
5178 @findex gnus-summary-prev-page
5179 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5182 @kindex RET (Summary)
5183 @findex gnus-summary-scroll-up
5184 Scroll the current article one line forward
5185 (@code{gnus-summary-scroll-up}).
5188 @kindex M-RET (Summary)
5189 @findex gnus-summary-scroll-down
5190 Scroll the current article one line backward
5191 (@code{gnus-summary-scroll-down}).
5195 @kindex A g (Summary)
5197 @findex gnus-summary-show-article
5198 @vindex gnus-summary-show-article-charset-alist
5199 (Re)fetch the current article (@code{gnus-summary-show-article}). If
5200 given a prefix, fetch the current article, but don't run any of the
5201 article treatment functions. This will give you a ``raw'' article, just
5202 the way it came from the server.
5204 If given a numerical prefix, you can do semi-manual charset stuff.
5205 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5206 encoded in the @code{cn-gb-2312} charset. If you have
5209 (setq gnus-summary-show-article-charset-alist
5214 then you can say @kbd{C-u 1 g} to get the same effect.
5219 @kindex A < (Summary)
5220 @findex gnus-summary-beginning-of-article
5221 Scroll to the beginning of the article
5222 (@code{gnus-summary-beginning-of-article}).
5227 @kindex A > (Summary)
5228 @findex gnus-summary-end-of-article
5229 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5233 @kindex A s (Summary)
5235 @findex gnus-summary-isearch-article
5236 Perform an isearch in the article buffer
5237 (@code{gnus-summary-isearch-article}).
5241 @findex gnus-summary-select-article-buffer
5242 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5247 @node Reply Followup and Post
5248 @section Reply, Followup and Post
5251 * Summary Mail Commands:: Sending mail.
5252 * Summary Post Commands:: Sending news.
5253 * Summary Message Commands:: Other Message-related commands.
5254 * Canceling and Superseding::
5258 @node Summary Mail Commands
5259 @subsection Summary Mail Commands
5261 @cindex composing mail
5263 Commands for composing a mail message:
5269 @kindex S r (Summary)
5271 @findex gnus-summary-reply
5272 @c @icon{gnus-summary-mail-reply}
5273 @c @icon{gnus-summary-reply}
5274 Mail a reply to the author of the current article
5275 (@code{gnus-summary-reply}).
5280 @kindex S R (Summary)
5281 @findex gnus-summary-reply-with-original
5282 @c @icon{gnus-summary-reply-with-original}
5283 Mail a reply to the author of the current article and include the
5284 original message (@code{gnus-summary-reply-with-original}). This
5285 command uses the process/prefix convention.
5288 @kindex S w (Summary)
5289 @findex gnus-summary-wide-reply
5290 Mail a wide reply to the author of the current article
5291 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
5292 goes out to all people listed in the @code{To}, @code{From} (or
5293 @code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is
5294 present, that's used instead.
5297 @kindex S W (Summary)
5298 @findex gnus-summary-wide-reply-with-original
5299 Mail a wide reply to the current article and include the original
5300 message (@code{gnus-summary-wide-reply-with-original}). This command uses
5301 the process/prefix convention.
5304 @kindex S v (Summary)
5305 @findex gnus-summary-very-wide-reply
5306 Mail a very wide reply to the author of the current article
5307 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
5308 that goes out to all people listed in the @code{To}, @code{From} (or
5309 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5310 articles. This command uses the process/prefix convention.
5313 @kindex S V (Summary)
5314 @findex gnus-summary-very-wide-reply-with-original
5315 Mail a very wide reply to the author of the current article and include the
5316 original message (@code{gnus-summary-very-wide-reply-with-original}). This
5317 command uses the process/prefix convention.
5320 @kindex S B r (Summary)
5321 @findex gnus-summary-reply-broken-reply-to
5322 Mail a reply to the author of the current article but ignore the
5323 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5324 If you need this because a mailing list incorrectly sets a
5325 @code{Reply-To} header pointing to the list, you probably want to set
5326 the @code{broken-reply-to} group parameter instead, so things will work
5327 correctly. @xref{Group Parameters}.
5330 @kindex S B R (Summary)
5331 @findex gnus-summary-reply-broken-reply-to-with-original
5332 Mail a reply to the author of the current article and include the
5333 original message but ignore the @code{Reply-To} field
5334 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5338 @kindex S o m (Summary)
5339 @kindex C-c C-f (Summary)
5340 @findex gnus-summary-mail-forward
5341 @c @icon{gnus-summary-mail-forward}
5342 Forward the current article to some other person
5343 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
5344 headers of the forwarded article.
5349 @kindex S m (Summary)
5350 @findex gnus-summary-mail-other-window
5351 @c @icon{gnus-summary-mail-originate}
5352 Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use
5353 the posting style of the current group. If given a prefix, disable that.
5354 If the prefix is 1, prompt for a group name to find the posting style.
5359 @kindex S i (Summary)
5360 @findex gnus-summary-news-other-window
5361 Prepare a news (@code{gnus-summary-news-other-window}). By default,
5362 post to the current group. If given a prefix, disable that. If the
5363 prefix is 1, prompt for a group to post to.
5365 This function actually prepares a news even when using mail groups.
5366 This is useful for ``posting'' messages to mail groups without actually
5367 sending them over the network: they're just saved directly to the group
5368 in question. The corresponding back end must have a request-post method
5369 for this to work though.
5372 @kindex S D b (Summary)
5373 @findex gnus-summary-resend-bounced-mail
5374 @cindex bouncing mail
5375 If you have sent a mail, but the mail was bounced back to you for some
5376 reason (wrong address, transient failure), you can use this command to
5377 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
5378 will be popped into a mail buffer where you can edit the headers before
5379 sending the mail off again. If you give a prefix to this command, and
5380 the bounced mail is a reply to some other mail, gnus will try to fetch
5381 that mail and display it for easy perusal of its headers. This might
5382 very well fail, though.
5385 @kindex S D r (Summary)
5386 @findex gnus-summary-resend-message
5387 Not to be confused with the previous command,
5388 @code{gnus-summary-resend-message} will prompt you for an address to
5389 send the current message off to, and then send it to that place. The
5390 headers of the message won't be altered---but lots of headers that say
5391 @code{Resent-To}, @code{Resent-From} and so on will be added. This
5392 means that you actually send a mail to someone that has a @code{To}
5393 header that (probably) points to yourself. This will confuse people.
5394 So, natcherly you'll only do that if you're really eVIl.
5396 This command is mainly used if you have several accounts and want to
5397 ship a mail to a different account of yours. (If you're both
5398 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5399 to the @code{root} account, you may want to resend it to
5400 @code{postmaster}. Ordnung muss sein!
5402 This command understands the process/prefix convention
5403 (@pxref{Process/Prefix}).
5406 @kindex S D e (Summary)
5407 @findex gnus-summary-resend-message-edit
5409 Like the previous command, but will allow you to edit the message as
5410 if it were a new message before resending.
5413 @kindex S O m (Summary)
5414 @findex gnus-summary-digest-mail-forward
5415 Digest the current series (@pxref{Decoding Articles}) and forward the
5416 result using mail (@code{gnus-summary-digest-mail-forward}). This
5417 command uses the process/prefix convention (@pxref{Process/Prefix}).
5420 @kindex S M-c (Summary)
5421 @findex gnus-summary-mail-crosspost-complaint
5422 @cindex crossposting
5423 @cindex excessive crossposting
5424 Send a complaint about excessive crossposting to the author of the
5425 current article (@code{gnus-summary-mail-crosspost-complaint}).
5427 @findex gnus-crosspost-complaint
5428 This command is provided as a way to fight back against the current
5429 crossposting pandemic that's sweeping Usenet. It will compose a reply
5430 using the @code{gnus-crosspost-complaint} variable as a preamble. This
5431 command understands the process/prefix convention
5432 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5436 Also @xref{Header Commands, ,Header Commands, message, The Message
5437 Manual}, for more information.
5440 @node Summary Post Commands
5441 @subsection Summary Post Commands
5443 @cindex composing news
5445 Commands for posting a news article:
5451 @kindex S p (Summary)
5452 @findex gnus-summary-post-news
5453 @c @icon{gnus-summary-post-news}
5454 Prepare for posting an article (@code{gnus-summary-post-news}). By
5455 default, post to the current group. If given a prefix, disable that.
5456 If the prefix is 1, prompt for another group instead.
5461 @kindex S f (Summary)
5462 @findex gnus-summary-followup
5463 @c @icon{gnus-summary-followup}
5464 Post a followup to the current article (@code{gnus-summary-followup}).
5468 @kindex S F (Summary)
5470 @c @icon{gnus-summary-followup-with-original}
5471 @findex gnus-summary-followup-with-original
5472 Post a followup to the current article and include the original message
5473 (@code{gnus-summary-followup-with-original}). This command uses the
5474 process/prefix convention.
5477 @kindex S n (Summary)
5478 @findex gnus-summary-followup-to-mail
5479 Post a followup to the current article via news, even if you got the
5480 message through mail (@code{gnus-summary-followup-to-mail}).
5483 @kindex S N (Summary)
5484 @findex gnus-summary-followup-to-mail-with-original
5485 Post a followup to the current article via news, even if you got the
5486 message through mail and include the original message
5487 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
5488 the process/prefix convention.
5491 @kindex S o p (Summary)
5492 @findex gnus-summary-post-forward
5493 Forward the current article to a newsgroup
5494 (@code{gnus-summary-post-forward}). If given a prefix, include the full
5495 headers of the forwarded article.
5498 @kindex S O p (Summary)
5499 @findex gnus-summary-digest-post-forward
5501 @cindex making digests
5502 Digest the current series and forward the result to a newsgroup
5503 (@code{gnus-summary-digest-post-forward}). This command uses the
5504 process/prefix convention.
5507 @kindex S u (Summary)
5508 @findex gnus-uu-post-news
5509 @c @icon{gnus-uu-post-news}
5510 Uuencode a file, split it into parts, and post it as a series
5511 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
5514 Also @xref{Header Commands, ,Header Commands, message, The Message
5515 Manual}, for more information.
5518 @node Summary Message Commands
5519 @subsection Summary Message Commands
5523 @kindex S y (Summary)
5524 @findex gnus-summary-yank-message
5525 Yank the current article into an already existing Message composition
5526 buffer (@code{gnus-summary-yank-message}). This command prompts for
5527 what message buffer you want to yank into, and understands the
5528 process/prefix convention (@pxref{Process/Prefix}).
5533 @node Canceling and Superseding
5534 @subsection Canceling Articles
5535 @cindex canceling articles
5536 @cindex superseding articles
5538 Have you ever written something, and then decided that you really,
5539 really, really wish you hadn't posted that?
5541 Well, you can't cancel mail, but you can cancel posts.
5543 @findex gnus-summary-cancel-article
5545 @c @icon{gnus-summary-cancel-article}
5546 Find the article you wish to cancel (you can only cancel your own
5547 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
5548 c} (@code{gnus-summary-cancel-article}). Your article will be
5549 canceled---machines all over the world will be deleting your article.
5550 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5552 Be aware, however, that not all sites honor cancels, so your article may
5553 live on here and there, while most sites will delete the article in
5556 Gnus will use the ``current'' select method when canceling. If you
5557 want to use the standard posting method, use the @samp{a} symbolic
5558 prefix (@pxref{Symbolic Prefixes}).
5560 Gnus ensures that only you can cancel your own messages using a
5561 @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, ,
5562 message, Message Manual}).
5564 If you discover that you have made some mistakes and want to do some
5565 corrections, you can post a @dfn{superseding} article that will replace
5566 your original article.
5568 @findex gnus-summary-supersede-article
5570 Go to the original article and press @kbd{S s}
5571 (@code{gnus-summary-supersede-article}). You will be put in a buffer
5572 where you can edit the article all you want before sending it off the
5575 The same goes for superseding as for canceling, only more so: Some
5576 sites do not honor superseding. On those sites, it will appear that you
5577 have posted almost the same article twice.
5579 If you have just posted the article, and change your mind right away,
5580 there is a trick you can use to cancel/supersede the article without
5581 waiting for the article to appear on your site first. You simply return
5582 to the post buffer (which is called @code{*sent ...*}). There you will
5583 find the article you just posted, with all the headers intact. Change
5584 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5585 header by substituting one of those words for the word
5586 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
5587 you would do normally. The previous article will be
5588 canceled/superseded.
5590 Just remember, kids: There is no 'c' in 'supersede'.
5592 @node Delayed Articles
5593 @section Delayed Articles
5594 @cindex delayed sending
5595 @cindex send delayed
5597 Sometimes, you might wish to delay the sending of a message. For
5598 example, you might wish to arrange for a message to turn up just in time
5599 to remind your about the birthday of your Significant Other. For this,
5600 there is the @code{gnus-delay} package. Setup is simple:
5603 (gnus-delay-initialize)
5606 @findex gnus-delay-article
5607 Normally, to send a message you use the @kbd{C-c C-c} command from
5608 Message mode. To delay a message, use @kbd{C-c C-j}
5609 (@code{gnus-delay-article}) instead. This will ask you for how long the
5610 message should be delayed. Possible answers are:
5614 A time span. Consists of an integer and a letter. For example,
5615 @code{42d} means to delay for 42 days. Available letters are @code{m}
5616 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5617 (months) and @code{Y} (years).
5620 A specific date. Looks like @code{YYYY-MM-DD}. The message will be
5621 delayed until that day, at a specific time (eight o'clock by default).
5622 See also @code{gnus-delay-default-hour}.
5625 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
5626 stuff. The deadline will be at that time today, except if that time has
5627 already passed, then it's at the given time tomorrow. So if it's ten
5628 o'clock in the morning and you specify @code{11:15}, then the deadline
5629 is one hour and fifteen minutes hence. But if you specify @code{9:20},
5630 that means a time tomorrow.
5633 The action of the @code{gnus-delay-article} command is influenced by a
5634 couple of variables:
5637 @item gnus-delay-default-hour
5638 @vindex gnus-delay-default-hour
5639 When you specify a specific date, the message will be due on that hour
5640 on the given date. Possible values are integers 0 through 23.
5642 @item gnus-delay-default-delay
5643 @vindex gnus-delay-default-delay
5644 This is a string and gives the default delay. It can be of any of the
5645 formats described above.
5647 @item gnus-delay-group
5648 @vindex gnus-delay-group
5649 Delayed articles will be kept in this group on the drafts server until
5650 they are due. You probably don't need to change this. The default
5651 value is @code{"delayed"}.
5653 @item gnus-delay-header
5654 @vindex gnus-delay-header
5655 The deadline for each article will be stored in a header. This variable
5656 is a string and gives the header name. You probably don't need to
5657 change this. The default value is @code{"X-Gnus-Delayed"}.
5660 The way delaying works is like this: when you use the
5661 @code{gnus-delay-article} command, you give a certain delay. Gnus
5662 calculates the deadline of the message and stores it in the
5663 @code{X-Gnus-Delayed} header and puts the message in the
5664 @code{nndraft:delayed} group.
5666 @findex gnus-delay-send-queue
5667 And whenever you get new news, Gnus looks through the group for articles
5668 which are due and sends them. It uses the @code{gnus-delay-send-queue}
5669 function for this. By default, this function is added to the hook
5670 @code{gnus-get-new-news-hook}. But of course, you can change this.
5671 Maybe you want to use the demon to send drafts? Just tell the demon to
5672 execute the @code{gnus-delay-send-queue} function.
5675 @item gnus-delay-initialize
5676 @findex gnus-delay-initialize
5678 By default, this function installs @code{gnus-delay-send-queue} in
5679 @code{gnus-get-new-news-hook}. But it accepts the optional second
5680 argument @code{no-check}. If it is non-@code{nil},
5681 @code{gnus-get-new-news-hook} is not changed. The optional first
5682 argument is ignored.
5684 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5685 Presumably, you want to use the demon for sending due delayed articles.
5686 Just don't forget to set that up :-)
5690 @node Marking Articles
5691 @section Marking Articles
5692 @cindex article marking
5693 @cindex article ticking
5696 There are several marks you can set on an article.
5698 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5699 neologism ohoy!) of the article. Alphabetic marks generally mean
5700 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5702 In addition, you also have marks that do not affect readedness.
5705 * Unread Articles:: Marks for unread articles.
5706 * Read Articles:: Marks for read articles.
5707 * Other Marks:: Marks that do not affect readedness.
5711 There's a plethora of commands for manipulating these marks:
5715 * Setting Marks:: How to set and remove marks.
5716 * Generic Marking Commands:: How to customize the marking.
5717 * Setting Process Marks:: How to mark articles for later processing.
5721 @node Unread Articles
5722 @subsection Unread Articles
5724 The following marks mark articles as (kinda) unread, in one form or
5729 @vindex gnus-ticked-mark
5730 Marked as ticked (@code{gnus-ticked-mark}).
5732 @dfn{Ticked articles} are articles that will remain visible always. If
5733 you see an article that you find interesting, or you want to put off
5734 reading it, or replying to it, until sometime later, you'd typically
5735 tick it. However, articles can be expired (from news servers by the
5736 news server software, Gnus itself never expires ticked messages), so if
5737 you want to keep an article forever, you'll have to make it persistent
5738 (@pxref{Persistent Articles}).
5741 @vindex gnus-dormant-mark
5742 Marked as dormant (@code{gnus-dormant-mark}).
5744 @dfn{Dormant articles} will only appear in the summary buffer if there
5745 are followups to it. If you want to see them even if they don't have
5746 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
5747 Otherwise (except for the visibility issue), they are just like ticked
5751 @vindex gnus-unread-mark
5752 Marked as unread (@code{gnus-unread-mark}).
5754 @dfn{Unread articles} are articles that haven't been read at all yet.
5759 @subsection Read Articles
5760 @cindex expirable mark
5762 All the following marks mark articles as read.
5767 @vindex gnus-del-mark
5768 These are articles that the user has marked as read with the @kbd{d}
5769 command manually, more or less (@code{gnus-del-mark}).
5772 @vindex gnus-read-mark
5773 Articles that have actually been read (@code{gnus-read-mark}).
5776 @vindex gnus-ancient-mark
5777 Articles that were marked as read in previous sessions and are now
5778 @dfn{old} (@code{gnus-ancient-mark}).
5781 @vindex gnus-killed-mark
5782 Marked as killed (@code{gnus-killed-mark}).
5785 @vindex gnus-kill-file-mark
5786 Marked as killed by kill files (@code{gnus-kill-file-mark}).
5789 @vindex gnus-low-score-mark
5790 Marked as read by having too low a score (@code{gnus-low-score-mark}).
5793 @vindex gnus-catchup-mark
5794 Marked as read by a catchup (@code{gnus-catchup-mark}).
5797 @vindex gnus-canceled-mark
5798 Canceled article (@code{gnus-canceled-mark})
5801 @vindex gnus-souped-mark
5802 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
5805 @vindex gnus-sparse-mark
5806 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
5810 @vindex gnus-duplicate-mark
5811 Article marked as read by duplicate suppression
5812 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
5816 All these marks just mean that the article is marked as read, really.
5817 They are interpreted differently when doing adaptive scoring, though.
5819 One more special mark, though:
5823 @vindex gnus-expirable-mark
5824 Marked as expirable (@code{gnus-expirable-mark}).
5826 Marking articles as @dfn{expirable} (or have them marked as such
5827 automatically) doesn't make much sense in normal groups---a user doesn't
5828 control expiring of news articles, but in mail groups, for instance,
5829 articles marked as @dfn{expirable} can be deleted by gnus at
5835 @subsection Other Marks
5836 @cindex process mark
5839 There are some marks that have nothing to do with whether the article is
5845 You can set a bookmark in the current article. Say you are reading a
5846 long thesis on cats' urinary tracts, and have to go home for dinner
5847 before you've finished reading the thesis. You can then set a bookmark
5848 in the article, and gnus will jump to this bookmark the next time it
5849 encounters the article. @xref{Setting Marks}.
5852 @vindex gnus-replied-mark
5853 All articles that you have replied to or made a followup to (i.e., have
5854 answered) will be marked with an @samp{A} in the second column
5855 (@code{gnus-replied-mark}).
5858 @vindex gnus-forwarded-mark
5859 All articles that you have forwarded will be marked with an @samp{F} in
5860 the second column (@code{gnus-forwarded-mark}).
5863 @vindex gnus-cached-mark
5864 Articles stored in the article cache will be marked with an @samp{*} in
5865 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
5868 @vindex gnus-saved-mark
5869 Articles ``saved'' (in some manner or other; not necessarily
5870 religiously) are marked with an @samp{S} in the second column
5871 (@code{gnus-saved-mark}).
5874 @vindex gnus-recent-mark
5875 Articles that according to the server haven't been shown to the user
5876 before are marked with a @samp{N} in the second column
5877 (@code{gnus-recent-mark}). Note that not all servers support this
5878 mark, in which case it simply never appears. Compare with
5879 @code{gnus-unseen-mark}.
5882 @vindex gnus-unseen-mark
5883 Articles that haven't been seen before in Gnus by the user are marked
5884 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
5885 Compare with @code{gnus-recent-mark}.
5888 @vindex gnus-downloaded-mark
5889 When using the Gnus agent (@pxref{Agent Basics}), articles may be
5890 downloaded for unplugged (offline) viewing. If you are using the
5891 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
5892 (The variable @code{gnus-downloaded-mark} controls which character to
5896 @vindex gnus-undownloaded-mark
5897 When using the Gnus agent (@pxref{Agent Basics}), some articles might
5898 not have been downloaded. Such articles cannot be viewed while you
5899 are unplugged (offline). If you are using the @samp{%O} spec, these
5900 articles get the @samp{-} mark in that spec. (The variable
5901 @code{gnus-undownloaded-mark} controls which character to use.)
5904 @vindex gnus-downloadable-mark
5905 The Gnus agent (@pxref{Agent Basics}) downloads some articles
5906 automatically, but it is also possible to explicitly mark articles for
5907 download, even if they would not be downloaded automatically. Such
5908 explicitly-marked articles get the @samp{%} mark in the first column.
5909 (The variable @code{gnus-downloadable-mark} controls which character to
5913 @vindex gnus-not-empty-thread-mark
5914 @vindex gnus-empty-thread-mark
5915 If the @samp{%e} spec is used, the presence of threads or not will be
5916 marked with @code{gnus-not-empty-thread-mark} and
5917 @code{gnus-empty-thread-mark} in the third column, respectively.
5920 @vindex gnus-process-mark
5921 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
5922 variety of commands react to the presence of the process mark. For
5923 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5924 all articles that have been marked with the process mark. Articles
5925 marked with the process mark have a @samp{#} in the second column.
5929 You might have noticed that most of these ``non-readedness'' marks
5930 appear in the second column by default. So if you have a cached, saved,
5931 replied article that you have process-marked, what will that look like?
5933 Nothing much. The precedence rules go as follows: process -> cache ->
5934 replied -> saved. So if the article is in the cache and is replied,
5935 you'll only see the cache mark and not the replied mark.
5939 @subsection Setting Marks
5940 @cindex setting marks
5942 All the marking commands understand the numeric prefix.
5947 @kindex M c (Summary)
5948 @kindex M-u (Summary)
5949 @findex gnus-summary-clear-mark-forward
5950 @cindex mark as unread
5951 Clear all readedness-marks from the current article
5952 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
5958 @kindex M t (Summary)
5959 @findex gnus-summary-tick-article-forward
5960 Tick the current article (@code{gnus-summary-tick-article-forward}).
5961 @xref{Article Caching}.
5966 @kindex M ? (Summary)
5967 @findex gnus-summary-mark-as-dormant
5968 Mark the current article as dormant
5969 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
5973 @kindex M d (Summary)
5975 @findex gnus-summary-mark-as-read-forward
5976 Mark the current article as read
5977 (@code{gnus-summary-mark-as-read-forward}).
5981 @findex gnus-summary-mark-as-read-backward
5982 Mark the current article as read and move point to the previous line
5983 (@code{gnus-summary-mark-as-read-backward}).
5988 @kindex M k (Summary)
5989 @findex gnus-summary-kill-same-subject-and-select
5990 Mark all articles that have the same subject as the current one as read,
5991 and then select the next unread article
5992 (@code{gnus-summary-kill-same-subject-and-select}).
5996 @kindex M K (Summary)
5997 @kindex C-k (Summary)
5998 @findex gnus-summary-kill-same-subject
5999 Mark all articles that have the same subject as the current one as read
6000 (@code{gnus-summary-kill-same-subject}).
6003 @kindex M C (Summary)
6004 @findex gnus-summary-catchup
6005 @c @icon{gnus-summary-catchup}
6006 Mark all unread articles as read (@code{gnus-summary-catchup}).
6009 @kindex M C-c (Summary)
6010 @findex gnus-summary-catchup-all
6011 Mark all articles in the group as read---even the ticked and dormant
6012 articles (@code{gnus-summary-catchup-all}).
6015 @kindex M H (Summary)
6016 @findex gnus-summary-catchup-to-here
6017 Catchup the current group to point (before the point)
6018 (@code{gnus-summary-catchup-to-here}).
6021 @kindex M h (Summary)
6022 @findex gnus-summary-catchup-from-here
6023 Catchup the current group from point (after the point)
6024 (@code{gnus-summary-catchup-from-here}).
6027 @kindex C-w (Summary)
6028 @findex gnus-summary-mark-region-as-read
6029 Mark all articles between point and mark as read
6030 (@code{gnus-summary-mark-region-as-read}).
6033 @kindex M V k (Summary)
6034 @findex gnus-summary-kill-below
6035 Kill all articles with scores below the default score (or below the
6036 numeric prefix) (@code{gnus-summary-kill-below}).
6040 @kindex M e (Summary)
6042 @findex gnus-summary-mark-as-expirable
6043 Mark the current article as expirable
6044 (@code{gnus-summary-mark-as-expirable}).
6047 @kindex M b (Summary)
6048 @findex gnus-summary-set-bookmark
6049 Set a bookmark in the current article
6050 (@code{gnus-summary-set-bookmark}).
6053 @kindex M B (Summary)
6054 @findex gnus-summary-remove-bookmark
6055 Remove the bookmark from the current article
6056 (@code{gnus-summary-remove-bookmark}).
6059 @kindex M V c (Summary)
6060 @findex gnus-summary-clear-above
6061 Clear all marks from articles with scores over the default score (or
6062 over the numeric prefix) (@code{gnus-summary-clear-above}).
6065 @kindex M V u (Summary)
6066 @findex gnus-summary-tick-above
6067 Tick all articles with scores over the default score (or over the
6068 numeric prefix) (@code{gnus-summary-tick-above}).
6071 @kindex M V m (Summary)
6072 @findex gnus-summary-mark-above
6073 Prompt for a mark, and mark all articles with scores over the default
6074 score (or over the numeric prefix) with this mark
6075 (@code{gnus-summary-clear-above}).
6078 @vindex gnus-summary-goto-unread
6079 The @code{gnus-summary-goto-unread} variable controls what action should
6080 be taken after setting a mark. If non-@code{nil}, point will move to
6081 the next/previous unread article. If @code{nil}, point will just move
6082 one line up or down. As a special case, if this variable is
6083 @code{never}, all the marking commands as well as other commands (like
6084 @kbd{SPACE}) will move to the next article, whether it is unread or not.
6085 The default is @code{t}.
6088 @node Generic Marking Commands
6089 @subsection Generic Marking Commands
6091 Some people would like the command that ticks an article (@kbd{!}) go to
6092 the next article. Others would like it to go to the next unread
6093 article. Yet others would like it to stay on the current article. And
6094 even though I haven't heard of anybody wanting it to go to the
6095 previous (unread) article, I'm sure there are people that want that as
6098 Multiply these five behaviors with five different marking commands, and
6099 you get a potentially complex set of variable to control what each
6102 To sidestep that mess, Gnus provides commands that do all these
6103 different things. They can be found on the @kbd{M M} map in the summary
6104 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
6105 to list in this manual.
6107 While you can use these commands directly, most users would prefer
6108 altering the summary mode keymap. For instance, if you would like the
6109 @kbd{!} command to go to the next article instead of the next unread
6110 article, you could say something like:
6114 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
6115 (defun my-alter-summary-map ()
6116 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
6124 (defun my-alter-summary-map ()
6125 (local-set-key "!" "MM!n"))
6129 @node Setting Process Marks
6130 @subsection Setting Process Marks
6131 @cindex setting process marks
6133 Process marks are displayed as @code{#} in the summary buffer, and are
6134 used for marking articles in such a way that other commands will
6135 process these articles. For instance, if you process mark four
6136 articles and then use the @kbd{*} command, Gnus will enter these four
6137 commands into the cache. For more information,
6138 @pxref{Process/Prefix}.
6145 @kindex M P p (Summary)
6146 @findex gnus-summary-mark-as-processable
6147 Mark the current article with the process mark
6148 (@code{gnus-summary-mark-as-processable}).
6149 @findex gnus-summary-unmark-as-processable
6153 @kindex M P u (Summary)
6154 @kindex M-# (Summary)
6155 Remove the process mark, if any, from the current article
6156 (@code{gnus-summary-unmark-as-processable}).
6159 @kindex M P U (Summary)
6160 @findex gnus-summary-unmark-all-processable
6161 Remove the process mark from all articles
6162 (@code{gnus-summary-unmark-all-processable}).
6165 @kindex M P i (Summary)
6166 @findex gnus-uu-invert-processable
6167 Invert the list of process marked articles
6168 (@code{gnus-uu-invert-processable}).
6171 @kindex M P R (Summary)
6172 @findex gnus-uu-mark-by-regexp
6173 Mark articles that have a @code{Subject} header that matches a regular
6174 expression (@code{gnus-uu-mark-by-regexp}).
6177 @kindex M P G (Summary)
6178 @findex gnus-uu-unmark-by-regexp
6179 Unmark articles that have a @code{Subject} header that matches a regular
6180 expression (@code{gnus-uu-unmark-by-regexp}).
6183 @kindex M P r (Summary)
6184 @findex gnus-uu-mark-region
6185 Mark articles in region (@code{gnus-uu-mark-region}).
6188 @kindex M P g (Summary)
6189 @findex gnus-uu-unmark-region
6190 Unmark articles in region (@code{gnus-uu-unmark-region}).
6193 @kindex M P t (Summary)
6194 @findex gnus-uu-mark-thread
6195 Mark all articles in the current (sub)thread
6196 (@code{gnus-uu-mark-thread}).
6199 @kindex M P T (Summary)
6200 @findex gnus-uu-unmark-thread
6201 Unmark all articles in the current (sub)thread
6202 (@code{gnus-uu-unmark-thread}).
6205 @kindex M P v (Summary)
6206 @findex gnus-uu-mark-over
6207 Mark all articles that have a score above the prefix argument
6208 (@code{gnus-uu-mark-over}).
6211 @kindex M P s (Summary)
6212 @findex gnus-uu-mark-series
6213 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6216 @kindex M P S (Summary)
6217 @findex gnus-uu-mark-sparse
6218 Mark all series that have already had some articles marked
6219 (@code{gnus-uu-mark-sparse}).
6222 @kindex M P a (Summary)
6223 @findex gnus-uu-mark-all
6224 Mark all articles in series order (@code{gnus-uu-mark-series}).
6227 @kindex M P b (Summary)
6228 @findex gnus-uu-mark-buffer
6229 Mark all articles in the buffer in the order they appear
6230 (@code{gnus-uu-mark-buffer}).
6233 @kindex M P k (Summary)
6234 @findex gnus-summary-kill-process-mark
6235 Push the current process mark set onto the stack and unmark all articles
6236 (@code{gnus-summary-kill-process-mark}).
6239 @kindex M P y (Summary)
6240 @findex gnus-summary-yank-process-mark
6241 Pop the previous process mark set from the stack and restore it
6242 (@code{gnus-summary-yank-process-mark}).
6245 @kindex M P w (Summary)
6246 @findex gnus-summary-save-process-mark
6247 Push the current process mark set onto the stack
6248 (@code{gnus-summary-save-process-mark}).
6252 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
6253 set process marks based on article body contents.
6260 It can be convenient to limit the summary buffer to just show some
6261 subset of the articles currently in the group. The effect most limit
6262 commands have is to remove a few (or many) articles from the summary
6265 All limiting commands work on subsets of the articles already fetched
6266 from the servers. None of these commands query the server for
6267 additional articles.
6273 @kindex / / (Summary)
6274 @findex gnus-summary-limit-to-subject
6275 Limit the summary buffer to articles that match some subject
6276 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
6280 @kindex / a (Summary)
6281 @findex gnus-summary-limit-to-author
6282 Limit the summary buffer to articles that match some author
6283 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
6287 @kindex / x (Summary)
6288 @findex gnus-summary-limit-to-extra
6289 Limit the summary buffer to articles that match one of the ``extra''
6290 headers (@pxref{To From Newsgroups})
6291 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
6296 @kindex / u (Summary)
6298 @findex gnus-summary-limit-to-unread
6299 Limit the summary buffer to articles not marked as read
6300 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
6301 buffer to articles strictly unread. This means that ticked and
6302 dormant articles will also be excluded.
6305 @kindex / m (Summary)
6306 @findex gnus-summary-limit-to-marks
6307 Ask for a mark and then limit to all articles that have been marked
6308 with that mark (@code{gnus-summary-limit-to-marks}).
6311 @kindex / t (Summary)
6312 @findex gnus-summary-limit-to-age
6313 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
6314 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
6315 articles younger than that number of days.
6318 @kindex / n (Summary)
6319 @findex gnus-summary-limit-to-articles
6320 Limit the summary buffer to the current article
6321 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
6322 convention (@pxref{Process/Prefix}).
6325 @kindex / w (Summary)
6326 @findex gnus-summary-pop-limit
6327 Pop the previous limit off the stack and restore it
6328 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
6332 @kindex / . (Summary)
6333 @findex gnus-summary-limit-to-unseen
6334 Limit the summary buffer to the unseen articles
6335 (@code{gnus-summary-limit-to-unseen}).
6338 @kindex / v (Summary)
6339 @findex gnus-summary-limit-to-score
6340 Limit the summary buffer to articles that have a score at or above some
6341 score (@code{gnus-summary-limit-to-score}).
6344 @kindex / p (Summary)
6345 @findex gnus-summary-limit-to-display-predicate
6346 Limit the summary buffer to articles that satisfy the @code{display}
6347 group parameter predicate
6348 (@code{gnus-summary-limit-to-display-predicate}). @xref{Group
6349 Parameters}, for more on this predicate.
6352 @kindex / r (Summary)
6353 @findex gnus-summary-limit-to-replied
6354 Limit the summary buffer to replied articles
6355 (@code{gnus-summary-limit-to-replied}). If given a prefix, exclude
6360 @kindex M S (Summary)
6361 @kindex / E (Summary)
6362 @findex gnus-summary-limit-include-expunged
6363 Include all expunged articles in the limit
6364 (@code{gnus-summary-limit-include-expunged}).
6367 @kindex / D (Summary)
6368 @findex gnus-summary-limit-include-dormant
6369 Include all dormant articles in the limit
6370 (@code{gnus-summary-limit-include-dormant}).
6373 @kindex / * (Summary)
6374 @findex gnus-summary-limit-include-cached
6375 Include all cached articles in the limit
6376 (@code{gnus-summary-limit-include-cached}).
6379 @kindex / d (Summary)
6380 @findex gnus-summary-limit-exclude-dormant
6381 Exclude all dormant articles from the limit
6382 (@code{gnus-summary-limit-exclude-dormant}).
6385 @kindex / M (Summary)
6386 @findex gnus-summary-limit-exclude-marks
6387 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
6390 @kindex / T (Summary)
6391 @findex gnus-summary-limit-include-thread
6392 Include all the articles in the current thread in the limit.
6395 @kindex / c (Summary)
6396 @findex gnus-summary-limit-exclude-childless-dormant
6397 Exclude all dormant articles that have no children from the limit@*
6398 (@code{gnus-summary-limit-exclude-childless-dormant}).
6401 @kindex / C (Summary)
6402 @findex gnus-summary-limit-mark-excluded-as-read
6403 Mark all excluded unread articles as read
6404 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
6405 also mark excluded ticked and dormant articles as read.
6408 @kindex / N (Summary)
6409 @findex gnus-summary-insert-new-articles
6410 Insert all new articles in the summary buffer. It scans for new emails
6411 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
6414 @kindex / o (Summary)
6415 @findex gnus-summary-insert-old-articles
6416 Insert all old articles in the summary buffer. If given a numbered
6417 prefix, fetch this number of articles.
6425 @cindex article threading
6427 Gnus threads articles by default. @dfn{To thread} is to put responses
6428 to articles directly after the articles they respond to---in a
6429 hierarchical fashion.
6431 Threading is done by looking at the @code{References} headers of the
6432 articles. In a perfect world, this would be enough to build pretty
6433 trees, but unfortunately, the @code{References} header is often broken
6434 or simply missing. Weird news propagation exacerbates the problem,
6435 so one has to employ other heuristics to get pleasing results. A
6436 plethora of approaches exists, as detailed in horrible detail in
6437 @ref{Customizing Threading}.
6439 First, a quick overview of the concepts:
6443 The top-most article in a thread; the first article in the thread.
6446 A tree-like article structure.
6449 A small(er) section of this tree-like structure.
6452 Threads often lose their roots due to article expiry, or due to the root
6453 already having been read in a previous session, and not displayed in the
6454 summary buffer. We then typically have many sub-threads that really
6455 belong to one thread, but are without connecting roots. These are
6456 called loose threads.
6458 @item thread gathering
6459 An attempt to gather loose threads into bigger threads.
6461 @item sparse threads
6462 A thread where the missing articles have been ``guessed'' at, and are
6463 displayed as empty lines in the summary buffer.
6469 * Customizing Threading:: Variables you can change to affect the threading.
6470 * Thread Commands:: Thread based commands in the summary buffer.
6474 @node Customizing Threading
6475 @subsection Customizing Threading
6476 @cindex customizing threading
6479 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
6480 * Filling In Threads:: Making the threads displayed look fuller.
6481 * More Threading:: Even more variables for fiddling with threads.
6482 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
6487 @subsubsection Loose Threads
6490 @cindex loose threads
6493 @item gnus-summary-make-false-root
6494 @vindex gnus-summary-make-false-root
6495 If non-@code{nil}, gnus will gather all loose subtrees into one big tree
6496 and create a dummy root at the top. (Wait a minute. Root at the top?
6497 Yup.) Loose subtrees occur when the real root has expired, or you've
6498 read or killed the root in a previous session.
6500 When there is no real root of a thread, gnus will have to fudge
6501 something. This variable says what fudging method gnus should use.
6502 There are four possible values:
6506 \gnusfigure{The Summary Buffer}{390}{
6507 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6508 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6509 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6510 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6515 @cindex adopting articles
6520 Gnus will make the first of the orphaned articles the parent. This
6521 parent will adopt all the other articles. The adopted articles will be
6522 marked as such by pointy brackets (@samp{<>}) instead of the standard
6523 square brackets (@samp{[]}). This is the default method.
6526 @vindex gnus-summary-dummy-line-format
6527 @vindex gnus-summary-make-false-root-always
6528 Gnus will create a dummy summary line that will pretend to be the
6529 parent. This dummy line does not correspond to any real article, so
6530 selecting it will just select the first real article after the dummy
6531 article. @code{gnus-summary-dummy-line-format} is used to specify the
6532 format of the dummy roots. It accepts only one format spec: @samp{S},
6533 which is the subject of the article. @xref{Formatting Variables}.
6534 If you want all threads to have a dummy root, even the non-gathered
6535 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
6538 Gnus won't actually make any article the parent, but simply leave the
6539 subject field of all orphans except the first empty. (Actually, it will
6540 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6544 Don't make any article parent at all. Just gather the threads and
6545 display them after one another.
6548 Don't gather loose threads.
6551 @item gnus-summary-gather-subject-limit
6552 @vindex gnus-summary-gather-subject-limit
6553 Loose threads are gathered by comparing subjects of articles. If this
6554 variable is @code{nil}, gnus requires an exact match between the
6555 subjects of the loose threads before gathering them into one big
6556 super-thread. This might be too strict a requirement, what with the
6557 presence of stupid newsreaders that chop off long subject lines. If
6558 you think so, set this variable to, say, 20 to require that only the
6559 first 20 characters of the subjects have to match. If you set this
6560 variable to a really low number, you'll find that gnus will gather
6561 everything in sight into one thread, which isn't very helpful.
6563 @cindex fuzzy article gathering
6564 If you set this variable to the special value @code{fuzzy}, gnus will
6565 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6568 @item gnus-simplify-subject-fuzzy-regexp
6569 @vindex gnus-simplify-subject-fuzzy-regexp
6570 This can either be a regular expression or list of regular expressions
6571 that match strings that will be removed from subjects if fuzzy subject
6572 simplification is used.
6574 @item gnus-simplify-ignored-prefixes
6575 @vindex gnus-simplify-ignored-prefixes
6576 If you set @code{gnus-summary-gather-subject-limit} to something as low
6577 as 10, you might consider setting this variable to something sensible:
6579 @c Written by Michael Ernst <mernst@cs.rice.edu>
6581 (setq gnus-simplify-ignored-prefixes
6587 "wanted" "followup" "summary\\( of\\)?"
6588 "help" "query" "problem" "question"
6589 "answer" "reference" "announce"
6590 "How can I" "How to" "Comparison of"
6595 (mapconcat 'identity
6596 '("for" "for reference" "with" "about")
6598 "\\)?\\]?:?[ \t]*"))
6601 All words that match this regexp will be removed before comparing two
6604 @item gnus-simplify-subject-functions
6605 @vindex gnus-simplify-subject-functions
6606 If non-@code{nil}, this variable overrides
6607 @code{gnus-summary-gather-subject-limit}. This variable should be a
6608 list of functions to apply to the @code{Subject} string iteratively to
6609 arrive at the simplified version of the string.
6611 Useful functions to put in this list include:
6614 @item gnus-simplify-subject-re
6615 @findex gnus-simplify-subject-re
6616 Strip the leading @samp{Re:}.
6618 @item gnus-simplify-subject-fuzzy
6619 @findex gnus-simplify-subject-fuzzy
6622 @item gnus-simplify-whitespace
6623 @findex gnus-simplify-whitespace
6624 Remove excessive whitespace.
6626 @item gnus-simplify-all-whitespace
6627 @findex gnus-simplify-all-whitespace
6628 Remove all whitespace.
6631 You may also write your own functions, of course.
6634 @item gnus-summary-gather-exclude-subject
6635 @vindex gnus-summary-gather-exclude-subject
6636 Since loose thread gathering is done on subjects only, that might lead
6637 to many false hits, especially with certain common subjects like
6638 @samp{} and @samp{(none)}. To make the situation slightly better,
6639 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6640 what subjects should be excluded from the gathering process.@*
6641 The default is @samp{^ *$\\|^(none)$}.
6643 @item gnus-summary-thread-gathering-function
6644 @vindex gnus-summary-thread-gathering-function
6645 Gnus gathers threads by looking at @code{Subject} headers. This means
6646 that totally unrelated articles may end up in the same ``thread'', which
6647 is confusing. An alternate approach is to look at all the
6648 @code{Message-ID}s in all the @code{References} headers to find matches.
6649 This will ensure that no gathered threads ever include unrelated
6650 articles, but it also means that people who have posted with broken
6651 newsreaders won't be gathered properly. The choice is yours---plague or
6655 @item gnus-gather-threads-by-subject
6656 @findex gnus-gather-threads-by-subject
6657 This function is the default gathering function and looks at
6658 @code{Subject}s exclusively.
6660 @item gnus-gather-threads-by-references
6661 @findex gnus-gather-threads-by-references
6662 This function looks at @code{References} headers exclusively.
6665 If you want to test gathering by @code{References}, you could say
6669 (setq gnus-summary-thread-gathering-function
6670 'gnus-gather-threads-by-references)
6676 @node Filling In Threads
6677 @subsubsection Filling In Threads
6680 @item gnus-fetch-old-headers
6681 @vindex gnus-fetch-old-headers
6682 If non-@code{nil}, gnus will attempt to build old threads by fetching
6683 more old headers---headers to articles marked as read. If you would
6684 like to display as few summary lines as possible, but still connect as
6685 many loose threads as possible, you should set this variable to
6686 @code{some} or a number. If you set it to a number, no more than that
6687 number of extra old headers will be fetched. In either case, fetching
6688 old headers only works if the back end you are using carries overview
6689 files---this would normally be @code{nntp}, @code{nnspool},
6690 @code{nnml}, and @code{nnmaildir}. Also remember that if the root of
6691 the thread has been expired by the server, there's not much Gnus can
6694 This variable can also be set to @code{invisible}. This won't have any
6695 visible effects, but is useful if you use the @kbd{A T} command a lot
6696 (@pxref{Finding the Parent}).
6698 @item gnus-fetch-old-ephemeral-headers
6699 @vindex gnus-fetch-old-ephemeral-headers
6700 Same as @code{gnus-fetch-old-headers}, but only used for ephemeral
6703 @item gnus-build-sparse-threads
6704 @vindex gnus-build-sparse-threads
6705 Fetching old headers can be slow. A low-rent similar effect can be
6706 gotten by setting this variable to @code{some}. Gnus will then look at
6707 the complete @code{References} headers of all articles and try to string
6708 together articles that belong in the same thread. This will leave
6709 @dfn{gaps} in the threading display where gnus guesses that an article
6710 is missing from the thread. (These gaps appear like normal summary
6711 lines. If you select a gap, gnus will try to fetch the article in
6712 question.) If this variable is @code{t}, gnus will display all these
6713 ``gaps'' without regard for whether they are useful for completing the
6714 thread or not. Finally, if this variable is @code{more}, gnus won't cut
6715 off sparse leaf nodes that don't lead anywhere. This variable is
6716 @code{nil} by default.
6718 @item gnus-read-all-available-headers
6719 @vindex gnus-read-all-available-headers
6720 This is a rather obscure variable that few will find useful. It's
6721 intended for those non-news newsgroups where the back end has to fetch
6722 quite a lot to present the summary buffer, and where it's impossible to
6723 go back to parents of articles. This is mostly the case in the
6724 web-based groups, like the @code{nnultimate} groups.
6726 If you don't use those, then it's safe to leave this as the default
6727 @code{nil}. If you want to use this variable, it should be a regexp
6728 that matches the group name, or @code{t} for all groups.
6733 @node More Threading
6734 @subsubsection More Threading
6737 @item gnus-show-threads
6738 @vindex gnus-show-threads
6739 If this variable is @code{nil}, no threading will be done, and all of
6740 the rest of the variables here will have no effect. Turning threading
6741 off will speed group selection up a bit, but it is sure to make reading
6742 slower and more awkward.
6744 @item gnus-thread-hide-subtree
6745 @vindex gnus-thread-hide-subtree
6746 If non-@code{nil}, all threads will be hidden when the summary buffer is
6749 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
6750 Available predicates are @code{gnus-article-unread-p} and
6751 @code{gnus-article-unseen-p}.
6756 (setq gnus-thread-hide-subtree
6757 '(or gnus-article-unread-p
6758 gnus-article-unseen-p))
6761 (It's a pretty nonsensical example, since all unseen articles are also
6762 unread, but you get my drift.)
6765 @item gnus-thread-expunge-below
6766 @vindex gnus-thread-expunge-below
6767 All threads that have a total score (as defined by
6768 @code{gnus-thread-score-function}) less than this number will be
6769 expunged. This variable is @code{nil} by default, which means that no
6770 threads are expunged.
6772 @item gnus-thread-hide-killed
6773 @vindex gnus-thread-hide-killed
6774 if you kill a thread and this variable is non-@code{nil}, the subtree
6777 @item gnus-thread-ignore-subject
6778 @vindex gnus-thread-ignore-subject
6779 Sometimes somebody changes the subject in the middle of a thread. If
6780 this variable is non-@code{nil}, which is the default, the subject
6781 change is ignored. If it is @code{nil}, a change in the subject will
6782 result in a new thread.
6784 @item gnus-thread-indent-level
6785 @vindex gnus-thread-indent-level
6786 This is a number that says how much each sub-thread should be indented.
6789 @item gnus-sort-gathered-threads-function
6790 @vindex gnus-sort-gathered-threads-function
6791 Sometimes, particularly with mailing lists, the order in which mails
6792 arrive locally is not necessarily the same as the order in which they
6793 arrived on the mailing list. Consequently, when sorting sub-threads
6794 using the default @code{gnus-thread-sort-by-number}, responses can end
6795 up appearing before the article to which they are responding to.
6796 Setting this variable to an alternate value
6797 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
6798 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
6799 more logical sub-thread ordering in such instances.
6804 @node Low-Level Threading
6805 @subsubsection Low-Level Threading
6809 @item gnus-parse-headers-hook
6810 @vindex gnus-parse-headers-hook
6811 Hook run before parsing any headers. The default value is
6812 @code{(gnus-set-summary-default-charset)}, which sets up local value of
6813 @code{default-mime-charset} in summary buffer based on variable
6814 @code{gnus-newsgroup-default-charset-alist}.
6816 @item gnus-alter-header-function
6817 @vindex gnus-alter-header-function
6818 If non-@code{nil}, this function will be called to allow alteration of
6819 article header structures. The function is called with one parameter,
6820 the article header vector, which it may alter in any way. For instance,
6821 if you have a mail-to-news gateway which alters the @code{Message-ID}s
6822 in systematic ways (by adding prefixes and such), you can use this
6823 variable to un-scramble the @code{Message-ID}s so that they are more
6824 meaningful. Here's one example:
6827 (setq gnus-alter-header-function 'my-alter-message-id)
6829 (defun my-alter-message-id (header)
6830 (let ((id (mail-header-id header)))
6832 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
6834 (concat (match-string 1 id) "@@" (match-string 2 id))
6841 @node Thread Commands
6842 @subsection Thread Commands
6843 @cindex thread commands
6849 @kindex T k (Summary)
6850 @kindex C-M-k (Summary)
6851 @findex gnus-summary-kill-thread
6852 Mark all articles in the current (sub-)thread as read
6853 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
6854 remove all marks instead. If the prefix argument is negative, tick
6859 @kindex T l (Summary)
6860 @kindex C-M-l (Summary)
6861 @findex gnus-summary-lower-thread
6862 Lower the score of the current (sub-)thread
6863 (@code{gnus-summary-lower-thread}).
6866 @kindex T i (Summary)
6867 @findex gnus-summary-raise-thread
6868 Increase the score of the current (sub-)thread
6869 (@code{gnus-summary-raise-thread}).
6872 @kindex T # (Summary)
6873 @findex gnus-uu-mark-thread
6874 Set the process mark on the current (sub-)thread
6875 (@code{gnus-uu-mark-thread}).
6878 @kindex T M-# (Summary)
6879 @findex gnus-uu-unmark-thread
6880 Remove the process mark from the current (sub-)thread
6881 (@code{gnus-uu-unmark-thread}).
6884 @kindex T T (Summary)
6885 @findex gnus-summary-toggle-threads
6886 Toggle threading (@code{gnus-summary-toggle-threads}).
6889 @kindex T s (Summary)
6890 @findex gnus-summary-show-thread
6891 Expose the (sub-)thread hidden under the current article, if any@*
6892 (@code{gnus-summary-show-thread}).
6895 @kindex T h (Summary)
6896 @findex gnus-summary-hide-thread
6897 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
6900 @kindex T S (Summary)
6901 @findex gnus-summary-show-all-threads
6902 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
6905 @kindex T H (Summary)
6906 @findex gnus-summary-hide-all-threads
6907 Hide all threads (@code{gnus-summary-hide-all-threads}).
6910 @kindex T t (Summary)
6911 @findex gnus-summary-rethread-current
6912 Re-thread the current article's thread
6913 (@code{gnus-summary-rethread-current}). This works even when the
6914 summary buffer is otherwise unthreaded.
6917 @kindex T ^ (Summary)
6918 @findex gnus-summary-reparent-thread
6919 Make the current article the child of the marked (or previous) article
6920 (@code{gnus-summary-reparent-thread}).
6924 The following commands are thread movement commands. They all
6925 understand the numeric prefix.
6930 @kindex T n (Summary)
6932 @kindex C-M-n (Summary)
6934 @kindex M-down (Summary)
6935 @findex gnus-summary-next-thread
6936 Go to the next thread (@code{gnus-summary-next-thread}).
6939 @kindex T p (Summary)
6941 @kindex C-M-p (Summary)
6943 @kindex M-up (Summary)
6944 @findex gnus-summary-prev-thread
6945 Go to the previous thread (@code{gnus-summary-prev-thread}).
6948 @kindex T d (Summary)
6949 @findex gnus-summary-down-thread
6950 Descend the thread (@code{gnus-summary-down-thread}).
6953 @kindex T u (Summary)
6954 @findex gnus-summary-up-thread
6955 Ascend the thread (@code{gnus-summary-up-thread}).
6958 @kindex T o (Summary)
6959 @findex gnus-summary-top-thread
6960 Go to the top of the thread (@code{gnus-summary-top-thread}).
6963 @vindex gnus-thread-operation-ignore-subject
6964 If you ignore subject while threading, you'll naturally end up with
6965 threads that have several different subjects in them. If you then issue
6966 a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not
6967 wish to kill the entire thread, but just those parts of the thread that
6968 have the same subject as the current article. If you like this idea,
6969 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
6970 is non-@code{nil} (which it is by default), subjects will be ignored
6971 when doing thread commands. If this variable is @code{nil}, articles in
6972 the same thread with different subjects will not be included in the
6973 operation in question. If this variable is @code{fuzzy}, only articles
6974 that have subjects fuzzily equal will be included (@pxref{Fuzzy
6978 @node Sorting the Summary Buffer
6979 @section Sorting the Summary Buffer
6981 @findex gnus-thread-sort-by-total-score
6982 @findex gnus-thread-sort-by-date
6983 @findex gnus-thread-sort-by-score
6984 @findex gnus-thread-sort-by-subject
6985 @findex gnus-thread-sort-by-author
6986 @findex gnus-thread-sort-by-number
6987 @findex gnus-thread-sort-by-random
6988 @vindex gnus-thread-sort-functions
6989 @findex gnus-thread-sort-by-most-recent-number
6990 @findex gnus-thread-sort-by-most-recent-date
6991 If you are using a threaded summary display, you can sort the threads by
6992 setting @code{gnus-thread-sort-functions}, which can be either a single
6993 function, a list of functions, or a list containing functions and
6994 @code{(not some-function)} elements.
6996 By default, sorting is done on article numbers. Ready-made sorting
6997 predicate functions include @code{gnus-thread-sort-by-number},
6998 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
6999 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score},
7000 @code{gnus-thread-sort-by-most-recent-number},
7001 @code{gnus-thread-sort-by-most-recent-date},
7002 @code{gnus-thread-sort-by-random} and
7003 @code{gnus-thread-sort-by-total-score}.
7005 Each function takes two threads and returns non-@code{nil} if the first
7006 thread should be sorted before the other. Note that sorting really is
7007 normally done by looking only at the roots of each thread.
7009 If you use more than one function, the primary sort key should be the
7010 last function in the list. You should probably always include
7011 @code{gnus-thread-sort-by-number} in the list of sorting
7012 functions---preferably first. This will ensure that threads that are
7013 equal with respect to the other sort criteria will be displayed in
7014 ascending article order.
7016 If you would like to sort by reverse score, then by subject, and finally
7017 by number, you could do something like:
7020 (setq gnus-thread-sort-functions
7021 '(gnus-thread-sort-by-number
7022 gnus-thread-sort-by-subject
7023 (not gnus-thread-sort-by-total-score)))
7026 The threads that have highest score will be displayed first in the
7027 summary buffer. When threads have the same score, they will be sorted
7028 alphabetically. The threads that have the same score and the same
7029 subject will be sorted by number, which is (normally) the sequence in
7030 which the articles arrived.
7032 If you want to sort by score and then reverse arrival order, you could
7036 (setq gnus-thread-sort-functions
7038 (not (gnus-thread-sort-by-number t1 t2)))
7039 gnus-thread-sort-by-score))
7042 @vindex gnus-thread-score-function
7043 The function in the @code{gnus-thread-score-function} variable (default
7044 @code{+}) is used for calculating the total score of a thread. Useful
7045 functions might be @code{max}, @code{min}, or squared means, or whatever
7048 @findex gnus-article-sort-functions
7049 @findex gnus-article-sort-by-date
7050 @findex gnus-article-sort-by-score
7051 @findex gnus-article-sort-by-subject
7052 @findex gnus-article-sort-by-author
7053 @findex gnus-article-sort-by-random
7054 @findex gnus-article-sort-by-number
7055 If you are using an unthreaded display for some strange reason or
7056 other, you have to fiddle with the @code{gnus-article-sort-functions}
7057 variable. It is very similar to the
7058 @code{gnus-thread-sort-functions}, except that it uses slightly
7059 different functions for article comparison. Available sorting
7060 predicate functions are @code{gnus-article-sort-by-number},
7061 @code{gnus-article-sort-by-author},
7062 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
7063 @code{gnus-article-sort-by-random}, and
7064 @code{gnus-article-sort-by-score}.
7066 If you want to sort an unthreaded summary display by subject, you could
7070 (setq gnus-article-sort-functions
7071 '(gnus-article-sort-by-number
7072 gnus-article-sort-by-subject))
7077 @node Asynchronous Fetching
7078 @section Asynchronous Article Fetching
7079 @cindex asynchronous article fetching
7080 @cindex article pre-fetch
7083 If you read your news from an @acronym{NNTP} server that's far away, the
7084 network latencies may make reading articles a chore. You have to wait
7085 for a while after pressing @kbd{n} to go to the next article before the
7086 article appears. Why can't gnus just go ahead and fetch the article
7087 while you are reading the previous one? Why not, indeed.
7089 First, some caveats. There are some pitfalls to using asynchronous
7090 article fetching, especially the way gnus does it.
7092 Let's say you are reading article 1, which is short, and article 2 is
7093 quite long, and you are not interested in reading that. Gnus does not
7094 know this, so it goes ahead and fetches article 2. You decide to read
7095 article 3, but since gnus is in the process of fetching article 2, the
7096 connection is blocked.
7098 To avoid these situations, gnus will open two (count 'em two)
7099 connections to the server. Some people may think this isn't a very nice
7100 thing to do, but I don't see any real alternatives. Setting up that
7101 extra connection takes some time, so gnus startup will be slower.
7103 Gnus will fetch more articles than you will read. This will mean that
7104 the link between your machine and the @acronym{NNTP} server will become more
7105 loaded than if you didn't use article pre-fetch. The server itself will
7106 also become more loaded---both with the extra article requests, and the
7109 Ok, so now you know that you shouldn't really use this thing@dots{} unless
7112 @vindex gnus-asynchronous
7113 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
7114 happen automatically.
7116 @vindex gnus-use-article-prefetch
7117 You can control how many articles are to be pre-fetched by setting
7118 @code{gnus-use-article-prefetch}. This is 30 by default, which means
7119 that when you read an article in the group, the back end will pre-fetch
7120 the next 30 articles. If this variable is @code{t}, the back end will
7121 pre-fetch all the articles it can without bound. If it is
7122 @code{nil}, no pre-fetching will be done.
7124 @vindex gnus-async-prefetch-article-p
7125 @findex gnus-async-read-p
7126 There are probably some articles that you don't want to pre-fetch---read
7127 articles, for instance. The @code{gnus-async-prefetch-article-p}
7128 variable controls whether an article is to be pre-fetched. This
7129 function should return non-@code{nil} when the article in question is
7130 to be pre-fetched. The default is @code{gnus-async-read-p}, which
7131 returns @code{nil} on read articles. The function is called with an
7132 article data structure as the only parameter.
7134 If, for instance, you wish to pre-fetch only unread articles shorter
7135 than 100 lines, you could say something like:
7138 (defun my-async-short-unread-p (data)
7139 "Return non-nil for short, unread articles."
7140 (and (gnus-data-unread-p data)
7141 (< (mail-header-lines (gnus-data-header data))
7144 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
7147 These functions will be called many, many times, so they should
7148 preferably be short and sweet to avoid slowing down gnus too much.
7149 It's probably a good idea to byte-compile things like this.
7151 @vindex gnus-prefetched-article-deletion-strategy
7152 Articles have to be removed from the asynch buffer sooner or later. The
7153 @code{gnus-prefetched-article-deletion-strategy} says when to remove
7154 articles. This is a list that may contain the following elements:
7158 Remove articles when they are read.
7161 Remove articles when exiting the group.
7164 The default value is @code{(read exit)}.
7166 @c @vindex gnus-use-header-prefetch
7167 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
7168 @c from the next group.
7171 @node Article Caching
7172 @section Article Caching
7173 @cindex article caching
7176 If you have an @emph{extremely} slow @acronym{NNTP} connection, you may
7177 consider turning article caching on. Each article will then be stored
7178 locally under your home directory. As you may surmise, this could
7179 potentially use @emph{huge} amounts of disk space, as well as eat up all
7180 your inodes so fast it will make your head swim. In vodka.
7182 Used carefully, though, it could be just an easier way to save articles.
7184 @vindex gnus-use-long-file-name
7185 @vindex gnus-cache-directory
7186 @vindex gnus-use-cache
7187 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
7188 all articles ticked or marked as dormant will then be copied
7189 over to your local cache (@code{gnus-cache-directory}). Whether this
7190 cache is flat or hierarchical is controlled by the
7191 @code{gnus-use-long-file-name} variable, as usual.
7193 When re-selecting a ticked or dormant article, it will be fetched from the
7194 cache instead of from the server. As articles in your cache will never
7195 expire, this might serve as a method of saving articles while still
7196 keeping them where they belong. Just mark all articles you want to save
7197 as dormant, and don't worry.
7199 When an article is marked as read, is it removed from the cache.
7201 @vindex gnus-cache-remove-articles
7202 @vindex gnus-cache-enter-articles
7203 The entering/removal of articles from the cache is controlled by the
7204 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
7205 variables. Both are lists of symbols. The first is @code{(ticked
7206 dormant)} by default, meaning that ticked and dormant articles will be
7207 put in the cache. The latter is @code{(read)} by default, meaning that
7208 articles marked as read are removed from the cache. Possibly
7209 symbols in these two lists are @code{ticked}, @code{dormant},
7210 @code{unread} and @code{read}.
7212 @findex gnus-jog-cache
7213 So where does the massive article-fetching and storing come into the
7214 picture? The @code{gnus-jog-cache} command will go through all
7215 subscribed newsgroups, request all unread articles, score them, and
7216 store them in the cache. You should only ever, ever ever ever, use this
7217 command if 1) your connection to the @acronym{NNTP} server is really, really,
7218 really slow and 2) you have a really, really, really huge disk.
7219 Seriously. One way to cut down on the number of articles downloaded is
7220 to score unwanted articles down and have them marked as read. They will
7221 not then be downloaded by this command.
7223 @vindex gnus-uncacheable-groups
7224 @vindex gnus-cacheable-groups
7225 It is likely that you do not want caching on all groups. For instance,
7226 if your @code{nnml} mail is located under your home directory, it makes no
7227 sense to cache it somewhere else under your home directory. Unless you
7228 feel that it's neat to use twice as much space.
7230 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7231 regexp of groups to cache, @samp{^nntp} for instance, or set the
7232 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7233 Both variables are @code{nil} by default. If a group matches both
7234 variables, the group is not cached.
7236 @findex gnus-cache-generate-nov-databases
7237 @findex gnus-cache-generate-active
7238 @vindex gnus-cache-active-file
7239 The cache stores information on what articles it contains in its active
7240 file (@code{gnus-cache-active-file}). If this file (or any other parts
7241 of the cache) becomes all messed up for some reason or other, gnus
7242 offers two functions that will try to set things right. @kbd{M-x
7243 gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV}
7244 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7247 @findex gnus-cache-move-cache
7248 @code{gnus-cache-move-cache} will move your whole
7249 @code{gnus-cache-directory} to some other location. You get asked to
7250 where, isn't that cool?
7252 @node Persistent Articles
7253 @section Persistent Articles
7254 @cindex persistent articles
7256 Closely related to article caching, we have @dfn{persistent articles}.
7257 In fact, it's just a different way of looking at caching, and much more
7258 useful in my opinion.
7260 Say you're reading a newsgroup, and you happen on to some valuable gem
7261 that you want to keep and treasure forever. You'd normally just save it
7262 (using one of the many saving commands) in some file. The problem with
7263 that is that it's just, well, yucky. Ideally you'd prefer just having
7264 the article remain in the group where you found it forever; untouched by
7265 the expiry going on at the news server.
7267 This is what a @dfn{persistent article} is---an article that just won't
7268 be deleted. It's implemented using the normal cache functions, but
7269 you use two explicit commands for managing persistent articles:
7275 @findex gnus-cache-enter-article
7276 Make the current article persistent (@code{gnus-cache-enter-article}).
7279 @kindex M-* (Summary)
7280 @findex gnus-cache-remove-article
7281 Remove the current article from the persistent articles
7282 (@code{gnus-cache-remove-article}). This will normally delete the
7286 Both these commands understand the process/prefix convention.
7288 To avoid having all ticked articles (and stuff) entered into the cache,
7289 you should set @code{gnus-use-cache} to @code{passive} if you're just
7290 interested in persistent articles:
7293 (setq gnus-use-cache 'passive)
7297 @node Article Backlog
7298 @section Article Backlog
7300 @cindex article backlog
7302 If you have a slow connection, but the idea of using caching seems
7303 unappealing to you (and it is, really), you can help the situation some
7304 by switching on the @dfn{backlog}. This is where gnus will buffer
7305 already read articles so that it doesn't have to re-fetch articles
7306 you've already read. This only helps if you are in the habit of
7307 re-selecting articles you've recently read, of course. If you never do
7308 that, turning the backlog on will slow gnus down a little bit, and
7309 increase memory usage some.
7311 @vindex gnus-keep-backlog
7312 If you set @code{gnus-keep-backlog} to a number @var{n}, gnus will store
7313 at most @var{n} old articles in a buffer for later re-fetching. If this
7314 variable is non-@code{nil} and is not a number, gnus will store
7315 @emph{all} read articles, which means that your Emacs will grow without
7316 bound before exploding and taking your machine down with you. I put
7317 that in there just to keep y'all on your toes.
7319 The default value is 20.
7322 @node Saving Articles
7323 @section Saving Articles
7324 @cindex saving articles
7326 Gnus can save articles in a number of ways. Below is the documentation
7327 for saving articles in a fairly straight-forward fashion (i.e., little
7328 processing of the article is done before it is saved). For a different
7329 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7330 (@pxref{Decoding Articles}).
7332 For the commands listed here, the target is a file. If you want to
7333 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7334 command (@pxref{Mail Group Commands}).
7336 @vindex gnus-save-all-headers
7337 If @code{gnus-save-all-headers} is non-@code{nil}, gnus will not delete
7338 unwanted headers before saving the article.
7340 @vindex gnus-saved-headers
7341 If the preceding variable is @code{nil}, all headers that match the
7342 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7343 deleted before saving.
7349 @kindex O o (Summary)
7351 @findex gnus-summary-save-article
7352 @c @icon{gnus-summary-save-article}
7353 Save the current article using the default article saver
7354 (@code{gnus-summary-save-article}).
7357 @kindex O m (Summary)
7358 @findex gnus-summary-save-article-mail
7359 Save the current article in mail format
7360 (@code{gnus-summary-save-article-mail}).
7363 @kindex O r (Summary)
7364 @findex gnus-summary-save-article-rmail
7365 Save the current article in Rmail format
7366 (@code{gnus-summary-save-article-rmail}).
7369 @kindex O f (Summary)
7370 @findex gnus-summary-save-article-file
7371 @c @icon{gnus-summary-save-article-file}
7372 Save the current article in plain file format
7373 (@code{gnus-summary-save-article-file}).
7376 @kindex O F (Summary)
7377 @findex gnus-summary-write-article-file
7378 Write the current article in plain file format, overwriting any previous
7379 file contents (@code{gnus-summary-write-article-file}).
7382 @kindex O b (Summary)
7383 @findex gnus-summary-save-article-body-file
7384 Save the current article body in plain file format
7385 (@code{gnus-summary-save-article-body-file}).
7388 @kindex O h (Summary)
7389 @findex gnus-summary-save-article-folder
7390 Save the current article in mh folder format
7391 (@code{gnus-summary-save-article-folder}).
7394 @kindex O v (Summary)
7395 @findex gnus-summary-save-article-vm
7396 Save the current article in a VM folder
7397 (@code{gnus-summary-save-article-vm}).
7401 @kindex O p (Summary)
7403 @findex gnus-summary-pipe-output
7404 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
7405 the current article to a process (@code{gnus-summary-pipe-output}).
7406 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7407 complete headers in the piped output.
7410 @kindex O P (Summary)
7411 @findex gnus-summary-muttprint
7412 @vindex gnus-summary-muttprint-program
7413 Save the current article into muttprint. That is, print it using the
7414 external program @uref{http://muttprint.sourceforge.net/,
7415 Muttprint}. The program name and options to use is controlled by the
7416 variable @code{gnus-summary-muttprint-program}.
7417 (@code{gnus-summary-muttprint}).
7421 @vindex gnus-prompt-before-saving
7422 All these commands use the process/prefix convention
7423 (@pxref{Process/Prefix}). If you save bunches of articles using these
7424 functions, you might get tired of being prompted for files to save each
7425 and every article in. The prompting action is controlled by
7426 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7427 default, giving you that excessive prompting action you know and
7428 loathe. If you set this variable to @code{t} instead, you'll be prompted
7429 just once for each series of articles you save. If you like to really
7430 have Gnus do all your thinking for you, you can even set this variable
7431 to @code{nil}, which means that you will never be prompted for files to
7432 save articles in. Gnus will simply save all the articles in the default
7436 @vindex gnus-default-article-saver
7437 You can customize the @code{gnus-default-article-saver} variable to make
7438 gnus do what you want it to. You can use any of the six ready-made
7439 functions below, or you can create your own.
7443 @item gnus-summary-save-in-rmail
7444 @findex gnus-summary-save-in-rmail
7445 @vindex gnus-rmail-save-name
7446 @findex gnus-plain-save-name
7447 This is the default format, @dfn{Babyl}. Uses the function in the
7448 @code{gnus-rmail-save-name} variable to get a file name to save the
7449 article in. The default is @code{gnus-plain-save-name}.
7451 @item gnus-summary-save-in-mail
7452 @findex gnus-summary-save-in-mail
7453 @vindex gnus-mail-save-name
7454 Save in a Unix mail (mbox) file. Uses the function in the
7455 @code{gnus-mail-save-name} variable to get a file name to save the
7456 article in. The default is @code{gnus-plain-save-name}.
7458 @item gnus-summary-save-in-file
7459 @findex gnus-summary-save-in-file
7460 @vindex gnus-file-save-name
7461 @findex gnus-numeric-save-name
7462 Append the article straight to an ordinary file. Uses the function in
7463 the @code{gnus-file-save-name} variable to get a file name to save the
7464 article in. The default is @code{gnus-numeric-save-name}.
7466 @item gnus-summary-write-to-file
7467 @findex gnus-summary-write-to-file
7468 Write the article straight to an ordinary file. The file is
7469 overwritten if it exists. Uses the function in the
7470 @code{gnus-file-save-name} variable to get a file name to save the
7471 article in. The default is @code{gnus-numeric-save-name}.
7473 @item gnus-summary-save-body-in-file
7474 @findex gnus-summary-save-body-in-file
7475 Append the article body to an ordinary file. Uses the function in the
7476 @code{gnus-file-save-name} variable to get a file name to save the
7477 article in. The default is @code{gnus-numeric-save-name}.
7479 @item gnus-summary-save-in-folder
7480 @findex gnus-summary-save-in-folder
7481 @findex gnus-folder-save-name
7482 @findex gnus-Folder-save-name
7483 @vindex gnus-folder-save-name
7486 Save the article to an MH folder using @code{rcvstore} from the MH
7487 library. Uses the function in the @code{gnus-folder-save-name} variable
7488 to get a file name to save the article in. The default is
7489 @code{gnus-folder-save-name}, but you can also use
7490 @code{gnus-Folder-save-name}, which creates capitalized names.
7492 @item gnus-summary-save-in-vm
7493 @findex gnus-summary-save-in-vm
7494 Save the article in a VM folder. You have to have the VM mail
7495 reader to use this setting.
7498 @vindex gnus-article-save-directory
7499 All of these functions, except for the last one, will save the article
7500 in the @code{gnus-article-save-directory}, which is initialized from the
7501 @env{SAVEDIR} environment variable. This is @file{~/News/} by
7504 As you can see above, the functions use different functions to find a
7505 suitable name of a file to save the article in. Below is a list of
7506 available functions that generate names:
7510 @item gnus-Numeric-save-name
7511 @findex gnus-Numeric-save-name
7512 File names like @file{~/News/Alt.andrea-dworkin/45}.
7514 @item gnus-numeric-save-name
7515 @findex gnus-numeric-save-name
7516 File names like @file{~/News/alt.andrea-dworkin/45}.
7518 @item gnus-Plain-save-name
7519 @findex gnus-Plain-save-name
7520 File names like @file{~/News/Alt.andrea-dworkin}.
7522 @item gnus-plain-save-name
7523 @findex gnus-plain-save-name
7524 File names like @file{~/News/alt.andrea-dworkin}.
7526 @item gnus-sender-save-name
7527 @findex gnus-sender-save-name
7528 File names like @file{~/News/larsi}.
7531 @vindex gnus-split-methods
7532 You can have gnus suggest where to save articles by plonking a regexp into
7533 the @code{gnus-split-methods} alist. For instance, if you would like to
7534 save articles related to gnus in the file @file{gnus-stuff}, and articles
7535 related to VM in @file{vm-stuff}, you could set this variable to something
7539 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
7540 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
7541 (my-choosing-function "../other-dir/my-stuff")
7542 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
7545 We see that this is a list where each element is a list that has two
7546 elements---the @dfn{match} and the @dfn{file}. The match can either be
7547 a string (in which case it is used as a regexp to match on the article
7548 head); it can be a symbol (which will be called as a function with the
7549 group name as a parameter); or it can be a list (which will be
7550 @code{eval}ed). If any of these actions have a non-@code{nil} result,
7551 the @dfn{file} will be used as a default prompt. In addition, the
7552 result of the operation itself will be used if the function or form
7553 called returns a string or a list of strings.
7555 You basically end up with a list of file names that might be used when
7556 saving the current article. (All ``matches'' will be used.) You will
7557 then be prompted for what you really want to use as a name, with file
7558 name completion over the results from applying this variable.
7560 This variable is @code{((gnus-article-archive-name))} by default, which
7561 means that gnus will look at the articles it saves for an
7562 @code{Archive-name} line and use that as a suggestion for the file
7565 Here's an example function to clean up file names somewhat. If you have
7566 lots of mail groups called things like
7567 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
7568 these group names before creating the file name to save to. The
7569 following will do just that:
7572 (defun my-save-name (group)
7573 (when (string-match "^nnml:mail." group)
7574 (substring group (match-end 0))))
7576 (setq gnus-split-methods
7577 '((gnus-article-archive-name)
7582 @vindex gnus-use-long-file-name
7583 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
7584 @code{nil}, all the preceding functions will replace all periods
7585 (@samp{.}) in the group names with slashes (@samp{/})---which means that
7586 the functions will generate hierarchies of directories instead of having
7587 all the files in the top level directory
7588 (@file{~/News/alt/andrea-dworkin} instead of
7589 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
7590 on most systems. However, for historical reasons, this is @code{nil} on
7591 Xenix and usg-unix-v machines by default.
7593 This function also affects kill and score file names. If this variable
7594 is a list, and the list contains the element @code{not-score}, long file
7595 names will not be used for score files, if it contains the element
7596 @code{not-save}, long file names will not be used for saving, and if it
7597 contains the element @code{not-kill}, long file names will not be used
7600 If you'd like to save articles in a hierarchy that looks something like
7604 (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy}
7605 (setq gnus-default-article-saver
7606 'gnus-summary-save-in-file) ; @r{no encoding}
7609 Then just save with @kbd{o}. You'd then read this hierarchy with
7610 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
7611 the top level directory as the argument (@file{~/News/}). Then just walk
7612 around to the groups/directories with @code{nneething}.
7615 @node Decoding Articles
7616 @section Decoding Articles
7617 @cindex decoding articles
7619 Sometime users post articles (or series of articles) that have been
7620 encoded in some way or other. Gnus can decode them for you.
7623 * Uuencoded Articles:: Uudecode articles.
7624 * Shell Archives:: Unshar articles.
7625 * PostScript Files:: Split PostScript.
7626 * Other Files:: Plain save and binhex.
7627 * Decoding Variables:: Variables for a happy decoding.
7628 * Viewing Files:: You want to look at the result of the decoding?
7632 @cindex article series
7633 All these functions use the process/prefix convention
7634 (@pxref{Process/Prefix}) for finding out what articles to work on, with
7635 the extension that a ``single article'' means ``a single series''. Gnus
7636 can find out by itself what articles belong to a series, decode all the
7637 articles and unpack/view/save the resulting file(s).
7639 Gnus guesses what articles are in the series according to the following
7640 simplish rule: The subjects must be (nearly) identical, except for the
7641 last two numbers of the line. (Spaces are largely ignored, however.)
7643 For example: If you choose a subject called @samp{cat.gif (2/3)}, gnus
7644 will find all the articles that match the regexp @samp{^cat.gif
7645 ([0-9]+/[0-9]+).*$}.
7647 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
7648 series}, will not be properly recognized by any of the automatic viewing
7649 commands, and you have to mark the articles manually with @kbd{#}.
7652 @node Uuencoded Articles
7653 @subsection Uuencoded Articles
7655 @cindex uuencoded articles
7660 @kindex X u (Summary)
7661 @findex gnus-uu-decode-uu
7662 @c @icon{gnus-uu-decode-uu}
7663 Uudecodes the current series (@code{gnus-uu-decode-uu}).
7666 @kindex X U (Summary)
7667 @findex gnus-uu-decode-uu-and-save
7668 Uudecodes and saves the current series
7669 (@code{gnus-uu-decode-uu-and-save}).
7672 @kindex X v u (Summary)
7673 @findex gnus-uu-decode-uu-view
7674 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
7677 @kindex X v U (Summary)
7678 @findex gnus-uu-decode-uu-and-save-view
7679 Uudecodes, views and saves the current series
7680 (@code{gnus-uu-decode-uu-and-save-view}).
7684 Remember that these all react to the presence of articles marked with
7685 the process mark. If, for instance, you'd like to decode and save an
7686 entire newsgroup, you'd typically do @kbd{M P a}
7687 (@code{gnus-uu-mark-all}) and then @kbd{X U}
7688 (@code{gnus-uu-decode-uu-and-save}).
7690 All this is very much different from how @code{gnus-uu} worked with
7691 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
7692 the sun. This version of @code{gnus-uu} generally assumes that you mark
7693 articles in some way (@pxref{Setting Process Marks}) and then press
7696 @vindex gnus-uu-notify-files
7697 Note: When trying to decode articles that have names matching
7698 @code{gnus-uu-notify-files}, which is hard-coded to
7699 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
7700 automatically post an article on @samp{comp.unix.wizards} saying that
7701 you have just viewed the file in question. This feature can't be turned
7705 @node Shell Archives
7706 @subsection Shell Archives
7708 @cindex shell archives
7709 @cindex shared articles
7711 Shell archives (``shar files'') used to be a popular way to distribute
7712 sources, but it isn't used all that much today. In any case, we have
7713 some commands to deal with these:
7718 @kindex X s (Summary)
7719 @findex gnus-uu-decode-unshar
7720 Unshars the current series (@code{gnus-uu-decode-unshar}).
7723 @kindex X S (Summary)
7724 @findex gnus-uu-decode-unshar-and-save
7725 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
7728 @kindex X v s (Summary)
7729 @findex gnus-uu-decode-unshar-view
7730 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
7733 @kindex X v S (Summary)
7734 @findex gnus-uu-decode-unshar-and-save-view
7735 Unshars, views and saves the current series
7736 (@code{gnus-uu-decode-unshar-and-save-view}).
7740 @node PostScript Files
7741 @subsection PostScript Files
7747 @kindex X p (Summary)
7748 @findex gnus-uu-decode-postscript
7749 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
7752 @kindex X P (Summary)
7753 @findex gnus-uu-decode-postscript-and-save
7754 Unpack and save the current PostScript series
7755 (@code{gnus-uu-decode-postscript-and-save}).
7758 @kindex X v p (Summary)
7759 @findex gnus-uu-decode-postscript-view
7760 View the current PostScript series
7761 (@code{gnus-uu-decode-postscript-view}).
7764 @kindex X v P (Summary)
7765 @findex gnus-uu-decode-postscript-and-save-view
7766 View and save the current PostScript series
7767 (@code{gnus-uu-decode-postscript-and-save-view}).
7772 @subsection Other Files
7776 @kindex X o (Summary)
7777 @findex gnus-uu-decode-save
7778 Save the current series
7779 (@code{gnus-uu-decode-save}).
7782 @kindex X b (Summary)
7783 @findex gnus-uu-decode-binhex
7784 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
7785 doesn't really work yet.
7789 @node Decoding Variables
7790 @subsection Decoding Variables
7792 Adjective, not verb.
7795 * Rule Variables:: Variables that say how a file is to be viewed.
7796 * Other Decode Variables:: Other decode variables.
7797 * Uuencoding and Posting:: Variables for customizing uuencoding.
7801 @node Rule Variables
7802 @subsubsection Rule Variables
7803 @cindex rule variables
7805 Gnus uses @dfn{rule variables} to decide how to view a file. All these
7806 variables are of the form
7809 (list '(regexp1 command2)
7816 @item gnus-uu-user-view-rules
7817 @vindex gnus-uu-user-view-rules
7819 This variable is consulted first when viewing files. If you wish to use,
7820 for instance, @code{sox} to convert an @file{.au} sound file, you could
7823 (setq gnus-uu-user-view-rules
7824 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
7827 @item gnus-uu-user-view-rules-end
7828 @vindex gnus-uu-user-view-rules-end
7829 This variable is consulted if gnus couldn't make any matches from the
7830 user and default view rules.
7832 @item gnus-uu-user-archive-rules
7833 @vindex gnus-uu-user-archive-rules
7834 This variable can be used to say what commands should be used to unpack
7839 @node Other Decode Variables
7840 @subsubsection Other Decode Variables
7843 @vindex gnus-uu-grabbed-file-functions
7845 @item gnus-uu-grabbed-file-functions
7846 All functions in this list will be called right after each file has been
7847 successfully decoded---so that you can move or view files right away,
7848 and don't have to wait for all files to be decoded before you can do
7849 anything. Ready-made functions you can put in this list are:
7853 @item gnus-uu-grab-view
7854 @findex gnus-uu-grab-view
7857 @item gnus-uu-grab-move
7858 @findex gnus-uu-grab-move
7859 Move the file (if you're using a saving function.)
7862 @item gnus-uu-be-dangerous
7863 @vindex gnus-uu-be-dangerous
7864 Specifies what to do if unusual situations arise during decoding. If
7865 @code{nil}, be as conservative as possible. If @code{t}, ignore things
7866 that didn't work, and overwrite existing files. Otherwise, ask each
7869 @item gnus-uu-ignore-files-by-name
7870 @vindex gnus-uu-ignore-files-by-name
7871 Files with name matching this regular expression won't be viewed.
7873 @item gnus-uu-ignore-files-by-type
7874 @vindex gnus-uu-ignore-files-by-type
7875 Files with a @acronym{MIME} type matching this variable won't be viewed.
7876 Note that Gnus tries to guess what type the file is based on the name.
7877 @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly
7880 @item gnus-uu-tmp-dir
7881 @vindex gnus-uu-tmp-dir
7882 Where @code{gnus-uu} does its work.
7884 @item gnus-uu-do-not-unpack-archives
7885 @vindex gnus-uu-do-not-unpack-archives
7886 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
7887 looking for files to display.
7889 @item gnus-uu-view-and-save
7890 @vindex gnus-uu-view-and-save
7891 Non-@code{nil} means that the user will always be asked to save a file
7894 @item gnus-uu-ignore-default-view-rules
7895 @vindex gnus-uu-ignore-default-view-rules
7896 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
7899 @item gnus-uu-ignore-default-archive-rules
7900 @vindex gnus-uu-ignore-default-archive-rules
7901 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
7904 @item gnus-uu-kill-carriage-return
7905 @vindex gnus-uu-kill-carriage-return
7906 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
7909 @item gnus-uu-unmark-articles-not-decoded
7910 @vindex gnus-uu-unmark-articles-not-decoded
7911 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
7912 decoded articles as unread.
7914 @item gnus-uu-correct-stripped-uucode
7915 @vindex gnus-uu-correct-stripped-uucode
7916 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
7917 uuencoded files that have had trailing spaces deleted.
7919 @item gnus-uu-pre-uudecode-hook
7920 @vindex gnus-uu-pre-uudecode-hook
7921 Hook run before sending a message to @code{uudecode}.
7923 @item gnus-uu-view-with-metamail
7924 @vindex gnus-uu-view-with-metamail
7926 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
7927 commands defined by the rule variables and just fudge a @acronym{MIME}
7928 content type based on the file name. The result will be fed to
7929 @code{metamail} for viewing.
7931 @item gnus-uu-save-in-digest
7932 @vindex gnus-uu-save-in-digest
7933 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
7934 decoding, will save in digests. If this variable is @code{nil},
7935 @code{gnus-uu} will just save everything in a file without any
7936 embellishments. The digesting almost conforms to RFC 1153---no easy way
7937 to specify any meaningful volume and issue numbers were found, so I
7938 simply dropped them.
7943 @node Uuencoding and Posting
7944 @subsubsection Uuencoding and Posting
7948 @item gnus-uu-post-include-before-composing
7949 @vindex gnus-uu-post-include-before-composing
7950 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
7951 before you compose the article. If this variable is @code{t}, you can
7952 either include an encoded file with @kbd{C-c C-i} or have one included
7953 for you when you post the article.
7955 @item gnus-uu-post-length
7956 @vindex gnus-uu-post-length
7957 Maximum length of an article. The encoded file will be split into how
7958 many articles it takes to post the entire file.
7960 @item gnus-uu-post-threaded
7961 @vindex gnus-uu-post-threaded
7962 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
7963 thread. This may not be smart, as no other decoder I have seen is able
7964 to follow threads when collecting uuencoded articles. (Well, I have
7965 seen one package that does that---@code{gnus-uu}, but somehow, I don't
7966 think that counts@dots{}) Default is @code{nil}.
7968 @item gnus-uu-post-separate-description
7969 @vindex gnus-uu-post-separate-description
7970 Non-@code{nil} means that the description will be posted in a separate
7971 article. The first article will typically be numbered (0/x). If this
7972 variable is @code{nil}, the description the user enters will be included
7973 at the beginning of the first article, which will be numbered (1/x).
7974 Default is @code{t}.
7980 @subsection Viewing Files
7981 @cindex viewing files
7982 @cindex pseudo-articles
7984 After decoding, if the file is some sort of archive, gnus will attempt
7985 to unpack the archive and see if any of the files in the archive can be
7986 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
7987 containing the files @file{pic1.jpg} and @file{pic2.gif}, gnus will
7988 uncompress and de-tar the main file, and then view the two pictures.
7989 This unpacking process is recursive, so if the archive contains archives
7990 of archives, it'll all be unpacked.
7992 Finally, gnus will normally insert a @dfn{pseudo-article} for each
7993 extracted file into the summary buffer. If you go to these
7994 ``articles'', you will be prompted for a command to run (usually Gnus
7995 will make a suggestion), and then the command will be run.
7997 @vindex gnus-view-pseudo-asynchronously
7998 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
7999 until the viewing is done before proceeding.
8001 @vindex gnus-view-pseudos
8002 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
8003 the pseudo-articles into the summary buffer, but view them
8004 immediately. If this variable is @code{not-confirm}, the user won't even
8005 be asked for a confirmation before viewing is done.
8007 @vindex gnus-view-pseudos-separately
8008 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
8009 pseudo-article will be created for each file to be viewed. If
8010 @code{nil}, all files that use the same viewing command will be given as
8011 a list of parameters to that command.
8013 @vindex gnus-insert-pseudo-articles
8014 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
8015 pseudo-articles when decoding. It is @code{t} by default.
8017 So; there you are, reading your @emph{pseudo-articles} in your
8018 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
8019 Why isn't anything real anymore? How did we get here?
8022 @node Article Treatment
8023 @section Article Treatment
8025 Reading through this huge manual, you may have quite forgotten that the
8026 object of newsreaders is to actually, like, read what people have
8027 written. Reading articles. Unfortunately, people are quite bad at
8028 writing, so there are tons of functions and variables to make reading
8029 these articles easier.
8032 * Article Highlighting:: You want to make the article look like fruit salad.
8033 * Article Fontisizing:: Making emphasized text look nice.
8034 * Article Hiding:: You also want to make certain info go away.
8035 * Article Washing:: Lots of way-neat functions to make life better.
8036 * Article Header:: Doing various header transformations.
8037 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
8038 * Article Button Levels:: Controlling appearance of buttons.
8039 * Article Date:: Grumble, UT!
8040 * Article Display:: Display various stuff---X-Face, Picons, Smileys
8041 * Article Signature:: What is a signature?
8042 * Article Miscellanea:: Various other stuff.
8046 @node Article Highlighting
8047 @subsection Article Highlighting
8048 @cindex highlighting
8050 Not only do you want your article buffer to look like fruit salad, but
8051 you want it to look like technicolor fruit salad.
8056 @kindex W H a (Summary)
8057 @findex gnus-article-highlight
8058 @findex gnus-article-maybe-highlight
8059 Do much highlighting of the current article
8060 (@code{gnus-article-highlight}). This function highlights header, cited
8061 text, the signature, and adds buttons to the body and the head.
8064 @kindex W H h (Summary)
8065 @findex gnus-article-highlight-headers
8066 @vindex gnus-header-face-alist
8067 Highlight the headers (@code{gnus-article-highlight-headers}). The
8068 highlighting will be done according to the @code{gnus-header-face-alist}
8069 variable, which is a list where each element has the form
8070 @code{(@var{regexp} @var{name} @var{content})}.
8071 @var{regexp} is a regular expression for matching the
8072 header, @var{name} is the face used for highlighting the header name
8073 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
8074 the header value. The first match made will be used. Note that
8075 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
8078 @kindex W H c (Summary)
8079 @findex gnus-article-highlight-citation
8080 Highlight cited text (@code{gnus-article-highlight-citation}).
8082 Some variables to customize the citation highlights:
8085 @vindex gnus-cite-parse-max-size
8087 @item gnus-cite-parse-max-size
8088 If the article size if bigger than this variable (which is 25000 by
8089 default), no citation highlighting will be performed.
8091 @item gnus-cite-max-prefix
8092 @vindex gnus-cite-max-prefix
8093 Maximum possible length for a citation prefix (default 20).
8095 @item gnus-cite-face-list
8096 @vindex gnus-cite-face-list
8097 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
8098 When there are citations from multiple articles in the same message,
8099 gnus will try to give each citation from each article its own face.
8100 This should make it easier to see who wrote what.
8102 @item gnus-supercite-regexp
8103 @vindex gnus-supercite-regexp
8104 Regexp matching normal Supercite attribution lines.
8106 @item gnus-supercite-secondary-regexp
8107 @vindex gnus-supercite-secondary-regexp
8108 Regexp matching mangled Supercite attribution lines.
8110 @item gnus-cite-minimum-match-count
8111 @vindex gnus-cite-minimum-match-count
8112 Minimum number of identical prefixes we have to see before we believe
8113 that it's a citation.
8115 @item gnus-cite-attribution-prefix
8116 @vindex gnus-cite-attribution-prefix
8117 Regexp matching the beginning of an attribution line.
8119 @item gnus-cite-attribution-suffix
8120 @vindex gnus-cite-attribution-suffix
8121 Regexp matching the end of an attribution line.
8123 @item gnus-cite-attribution-face
8124 @vindex gnus-cite-attribution-face
8125 Face used for attribution lines. It is merged with the face for the
8126 cited text belonging to the attribution.
8132 @kindex W H s (Summary)
8133 @vindex gnus-signature-separator
8134 @vindex gnus-signature-face
8135 @findex gnus-article-highlight-signature
8136 Highlight the signature (@code{gnus-article-highlight-signature}).
8137 Everything after @code{gnus-signature-separator} (@pxref{Article
8138 Signature}) in an article will be considered a signature and will be
8139 highlighted with @code{gnus-signature-face}, which is @code{italic} by
8144 @xref{Customizing Articles}, for how to highlight articles automatically.
8147 @node Article Fontisizing
8148 @subsection Article Fontisizing
8150 @cindex article emphasis
8152 @findex gnus-article-emphasize
8153 @kindex W e (Summary)
8154 People commonly add emphasis to words in news articles by writing things
8155 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
8156 this look nicer by running the article through the @kbd{W e}
8157 (@code{gnus-article-emphasize}) command.
8159 @vindex gnus-emphasis-alist
8160 How the emphasis is computed is controlled by the
8161 @code{gnus-emphasis-alist} variable. This is an alist where the first
8162 element is a regular expression to be matched. The second is a number
8163 that says what regular expression grouping is used to find the entire
8164 emphasized word. The third is a number that says what regexp grouping
8165 should be displayed and highlighted. (The text between these two
8166 groupings will be hidden.) The fourth is the face used for
8170 (setq gnus-emphasis-alist
8171 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
8172 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
8181 @vindex gnus-emphasis-underline
8182 @vindex gnus-emphasis-bold
8183 @vindex gnus-emphasis-italic
8184 @vindex gnus-emphasis-underline-bold
8185 @vindex gnus-emphasis-underline-italic
8186 @vindex gnus-emphasis-bold-italic
8187 @vindex gnus-emphasis-underline-bold-italic
8188 By default, there are seven rules, and they use the following faces:
8189 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
8190 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
8191 @code{gnus-emphasis-underline-italic},
8192 @code{gnus-emphasis-underline-bold}, and
8193 @code{gnus-emphasis-underline-bold-italic}.
8195 If you want to change these faces, you can either use @kbd{M-x
8196 customize}, or you can use @code{copy-face}. For instance, if you want
8197 to make @code{gnus-emphasis-italic} use a red face instead, you could
8201 (copy-face 'red 'gnus-emphasis-italic)
8204 @vindex gnus-group-highlight-words-alist
8206 If you want to highlight arbitrary words, you can use the
8207 @code{gnus-group-highlight-words-alist} variable, which uses the same
8208 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
8209 parameter (@pxref{Group Parameters}) can also be used.
8211 @xref{Customizing Articles}, for how to fontize articles automatically.
8214 @node Article Hiding
8215 @subsection Article Hiding
8216 @cindex article hiding
8218 Or rather, hiding certain things in each article. There usually is much
8219 too much cruft in most articles.
8224 @kindex W W a (Summary)
8225 @findex gnus-article-hide
8226 Do quite a lot of hiding on the article buffer
8227 (@kbd{gnus-article-hide}). In particular, this function will hide
8228 headers, @acronym{PGP}, cited text and the signature.
8231 @kindex W W h (Summary)
8232 @findex gnus-article-hide-headers
8233 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
8237 @kindex W W b (Summary)
8238 @findex gnus-article-hide-boring-headers
8239 Hide headers that aren't particularly interesting
8240 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
8243 @kindex W W s (Summary)
8244 @findex gnus-article-hide-signature
8245 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
8249 @kindex W W l (Summary)
8250 @findex gnus-article-hide-list-identifiers
8251 @vindex gnus-list-identifiers
8252 Strip list identifiers specified in @code{gnus-list-identifiers}. These
8253 are strings some mailing list servers add to the beginning of all
8254 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
8255 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
8256 may not contain @code{\\(..\\)}.
8260 @item gnus-list-identifiers
8261 @vindex gnus-list-identifiers
8262 A regular expression that matches list identifiers to be removed from
8263 subject. This can also be a list of regular expressions.
8268 @kindex W W P (Summary)
8269 @findex gnus-article-hide-pem
8270 Hide @acronym{PEM} (privacy enhanced messages) cruft
8271 (@code{gnus-article-hide-pem}).
8274 @kindex W W B (Summary)
8275 @findex gnus-article-strip-banner
8276 @vindex gnus-article-banner-alist
8277 @vindex gnus-article-address-banner-alist
8280 @cindex stripping advertisements
8281 @cindex advertisements
8282 Strip the banner specified by the @code{banner} group parameter
8283 (@code{gnus-article-strip-banner}). This is mainly used to hide those
8284 annoying banners and/or signatures that some mailing lists and moderated
8285 groups adds to all the messages. The way to use this function is to add
8286 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8287 group you want banners stripped from. The parameter either be a string,
8288 which will be interpreted as a regular expression matching text to be
8289 removed, or the symbol @code{signature}, meaning that the (last)
8290 signature should be removed, or other symbol, meaning that the
8291 corresponding regular expression in @code{gnus-article-banner-alist} is
8294 Regardless of a group, you can hide things like advertisements only when
8295 the sender of an article has a certain mail address specified in
8296 @code{gnus-article-address-banner-alist}.
8300 @item gnus-article-address-banner-alist
8301 @vindex gnus-article-address-banner-alist
8302 Alist of mail addresses and banners. Each element has the form
8303 @code{(@var{address} . @var{banner})}, where @var{address} is a regexp
8304 matching a mail address in the From header, @var{banner} is one of a
8305 symbol @code{signature}, an item in @code{gnus-article-banner-alist},
8306 a regexp and @code{nil}. If @var{address} matches author's mail
8307 address, it will remove things like advertisements. For example, if a
8308 sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a
8309 banner something like @samp{Do You Yoo-hoo!?} in all articles he
8310 sends, you can use the following element to remove them:
8313 ("@@yoo-hoo\\.co\\.jp\\'" .
8314 "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8320 @kindex W W c (Summary)
8321 @findex gnus-article-hide-citation
8322 Hide citation (@code{gnus-article-hide-citation}). Some variables for
8323 customizing the hiding:
8327 @item gnus-cited-opened-text-button-line-format
8328 @itemx gnus-cited-closed-text-button-line-format
8329 @vindex gnus-cited-closed-text-button-line-format
8330 @vindex gnus-cited-opened-text-button-line-format
8331 Gnus adds buttons to show where the cited text has been hidden, and to
8332 allow toggle hiding the text. The format of the variable is specified
8333 by these format-like variable (@pxref{Formatting Variables}). These
8338 Starting point of the hidden text.
8340 Ending point of the hidden text.
8342 Number of characters in the hidden region.
8344 Number of lines of hidden text.
8347 @item gnus-cited-lines-visible
8348 @vindex gnus-cited-lines-visible
8349 The number of lines at the beginning of the cited text to leave
8350 shown. This can also be a cons cell with the number of lines at the top
8351 and bottom of the text, respectively, to remain visible.
8356 @kindex W W C-c (Summary)
8357 @findex gnus-article-hide-citation-maybe
8359 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8360 following two variables:
8363 @item gnus-cite-hide-percentage
8364 @vindex gnus-cite-hide-percentage
8365 If the cited text is of a bigger percentage than this variable (default
8366 50), hide the cited text.
8368 @item gnus-cite-hide-absolute
8369 @vindex gnus-cite-hide-absolute
8370 The cited text must have at least this length (default 10) before it
8375 @kindex W W C (Summary)
8376 @findex gnus-article-hide-citation-in-followups
8377 Hide cited text in articles that aren't roots
8378 (@code{gnus-article-hide-citation-in-followups}). This isn't very
8379 useful as an interactive command, but might be a handy function to stick
8380 have happen automatically (@pxref{Customizing Articles}).
8384 All these ``hiding'' commands are toggles, but if you give a negative
8385 prefix to these commands, they will show what they have previously
8386 hidden. If you give a positive prefix, they will always hide.
8388 Also @pxref{Article Highlighting} for further variables for
8389 citation customization.
8391 @xref{Customizing Articles}, for how to hide article elements
8395 @node Article Washing
8396 @subsection Article Washing
8398 @cindex article washing
8400 We call this ``article washing'' for a really good reason. Namely, the
8401 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8403 @dfn{Washing} is defined by us as ``changing something from something to
8404 something else'', but normally results in something looking better.
8407 @xref{Customizing Articles}, if you want to change how Gnus displays
8408 articles by default.
8413 This is not really washing, it's sort of the opposite of washing. If
8414 you type this, you see the article exactly as it exists on disk or on
8418 Force redisplaying of the current article
8419 (@code{gnus-summary-show-article}). This is also not really washing.
8420 If you type this, you see the article without any previously applied
8421 interactive Washing functions but with all default treatments
8422 (@pxref{Customizing Articles}).
8425 @kindex W l (Summary)
8426 @findex gnus-summary-stop-page-breaking
8427 Remove page breaks from the current article
8428 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
8432 @kindex W r (Summary)
8433 @findex gnus-summary-caesar-message
8434 @c @icon{gnus-summary-caesar-message}
8435 Do a Caesar rotate (rot13) on the article buffer
8436 (@code{gnus-summary-caesar-message}).
8437 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8438 (Typically offensive jokes and such.)
8440 It's commonly called ``rot13'' because each letter is rotated 13
8441 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
8442 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
8443 is rumored to have employed this form of, uh, somewhat weak encryption.
8446 @kindex W m (Summary)
8447 @findex gnus-summary-morse-message
8448 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8452 @kindex W t (Summary)
8454 @findex gnus-summary-toggle-header
8455 Toggle whether to display all headers in the article buffer
8456 (@code{gnus-summary-toggle-header}).
8459 @kindex W v (Summary)
8460 @findex gnus-summary-verbose-headers
8461 Toggle whether to display all headers in the article buffer permanently
8462 (@code{gnus-summary-verbose-headers}).
8465 @kindex W m (Summary)
8466 @findex gnus-summary-toggle-mime
8467 Toggle whether to run the article through @acronym{MIME} before
8468 displaying (@code{gnus-summary-toggle-mime}).
8471 @kindex W o (Summary)
8472 @findex gnus-article-treat-overstrike
8473 Treat overstrike (@code{gnus-article-treat-overstrike}).
8476 @kindex W d (Summary)
8477 @findex gnus-article-treat-dumbquotes
8478 @vindex gnus-article-dumbquotes-map
8480 @cindex M****s*** sm*rtq**t*s
8482 Treat M****s*** sm*rtq**t*s according to
8483 @code{gnus-article-dumbquotes-map}
8484 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
8485 whether a character is a sm*rtq**t* or not, so it should only be used
8488 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
8489 an attempt to provide more quoting characters. If you see something
8490 like @code{\222} or @code{\264} where you're expecting some kind of
8491 apostrophe or quotation mark, then try this wash.
8494 @kindex W Y f (Summary)
8495 @findex gnus-article-outlook-deuglify-article
8496 @cindex Outlook Express
8497 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
8498 unwrap lines, repair attribution and rearrange citation.
8499 (@code{gnus-article-outlook-deuglify-article}).
8502 @kindex W Y u (Summary)
8503 @findex gnus-article-outlook-unwrap-lines
8504 @vindex gnus-outlook-deuglify-unwrap-min
8505 @vindex gnus-outlook-deuglify-unwrap-max
8506 Unwrap lines that appear to be wrapped citation lines. You can control
8507 what lines will be unwrapped by frobbing
8508 @code{gnus-outlook-deuglify-unwrap-min} and
8509 @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and
8510 maximum length of an unwrapped citation line.
8511 (@code{gnus-article-outlook-unwrap-lines}).
8514 @kindex W Y a (Summary)
8515 @findex gnus-article-outlook-repair-attribution
8516 Repair a broken attribution line.@*
8517 (@code{gnus-article-outlook-repair-attribution}).
8520 @kindex W Y c (Summary)
8521 @findex gnus-article-outlook-rearrange-citation
8522 Repair broken citations by rearranging the text.
8523 (@code{gnus-article-outlook-rearrange-citation}).
8526 @kindex W w (Summary)
8527 @findex gnus-article-fill-cited-article
8528 Do word wrap (@code{gnus-article-fill-cited-article}).
8530 You can give the command a numerical prefix to specify the width to use
8534 @kindex W Q (Summary)
8535 @findex gnus-article-fill-long-lines
8536 Fill long lines (@code{gnus-article-fill-long-lines}).
8539 @kindex W C (Summary)
8540 @findex gnus-article-capitalize-sentences
8541 Capitalize the first word in each sentence
8542 (@code{gnus-article-capitalize-sentences}).
8545 @kindex W c (Summary)
8546 @findex gnus-article-remove-cr
8547 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
8548 (this takes care of DOS line endings), and then translate any remaining
8549 CRs into LF (this takes care of Mac line endings)
8550 (@code{gnus-article-remove-cr}).
8552 @kindex W q (Summary)
8553 @findex gnus-article-de-quoted-unreadable
8554 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
8555 Quoted-Printable is one common @acronym{MIME} encoding employed when
8556 sending non-@acronym{ASCII} (i.e., 8-bit) articles. It typically
8557 makes strings like @samp{d@'ej@`a vu} look like @samp{d=E9j=E0 vu},
8558 which doesn't look very readable to me. Note that this is usually
8559 done automatically by Gnus if the message in question has a
8560 @code{Content-Transfer-Encoding} header that says that this encoding
8561 has been done. If a prefix is given, a charset will be asked for.
8564 @kindex W 6 (Summary)
8565 @findex gnus-article-de-base64-unreadable
8566 Treat base64 (@code{gnus-article-de-base64-unreadable}). Base64 is
8567 one common @acronym{MIME} encoding employed when sending
8568 non-@acronym{ASCII} (i.e., 8-bit) articles. Note that this is
8569 usually done automatically by Gnus if the message in question has a
8570 @code{Content-Transfer-Encoding} header that says that this encoding
8571 has been done. If a prefix is given, a charset will be asked for.
8574 @kindex W Z (Summary)
8575 @findex gnus-article-decode-HZ
8576 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
8577 common encoding employed when sending Chinese articles. It typically
8578 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
8581 @kindex W A (Summary)
8582 @findex gnus-article-treat-ansi-sequences
8583 Translate ANSI SGR control sequences into overlays or extents
8584 (@code{gnus-article-treat-ansi-sequences}). ANSI sequences are used in
8585 some Chinese hierarchies for highlighting.
8588 @kindex W u (Summary)
8589 @findex gnus-article-unsplit-urls
8590 Remove newlines from within URLs. Some mailers insert newlines into
8591 outgoing email messages to keep lines short. This reformatting can
8592 split long URLs onto multiple lines. Repair those URLs by removing
8593 the newlines (@code{gnus-article-unsplit-urls}).
8596 @kindex W h (Summary)
8597 @findex gnus-article-wash-html
8598 Treat @acronym{HTML} (@code{gnus-article-wash-html}). Note that this is
8599 usually done automatically by Gnus if the message in question has a
8600 @code{Content-Type} header that says that the message is @acronym{HTML}.
8602 If a prefix is given, a charset will be asked for.
8604 @vindex gnus-article-wash-function
8605 The default is to use the function specified by
8606 @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
8607 Customization, emacs-mime, The Emacs MIME Manual}) to convert the
8608 @acronym{HTML}, but this is controlled by the
8609 @code{gnus-article-wash-function} variable. Pre-defined functions you
8617 Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
8620 Use @uref{http://links.sf.net/, Links}.
8623 Use @uref{http://lynx.isc.org/, Lynx}.
8626 Use html2text---a simple @acronym{HTML} converter included with Gnus.
8631 @kindex W b (Summary)
8632 @findex gnus-article-add-buttons
8633 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
8634 @xref{Article Buttons}.
8637 @kindex W B (Summary)
8638 @findex gnus-article-add-buttons-to-head
8639 Add clickable buttons to the article headers
8640 (@code{gnus-article-add-buttons-to-head}).
8643 @kindex W p (Summary)
8644 @findex gnus-article-verify-x-pgp-sig
8645 Verify a signed control message
8646 (@code{gnus-article-verify-x-pgp-sig}). Control messages such as
8647 @code{newgroup} and @code{checkgroups} are usually signed by the
8648 hierarchy maintainer. You need to add the @acronym{PGP} public key of
8649 the maintainer to your keyring to verify the
8650 message.@footnote{@acronym{PGP} keys for many hierarchies are
8651 available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
8654 @kindex W s (Summary)
8655 @findex gnus-summary-force-verify-and-decrypt
8656 Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or
8657 @acronym{S/MIME}) message
8658 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
8661 @kindex W a (Summary)
8662 @findex gnus-article-strip-headers-in-body
8663 Strip headers like the @code{X-No-Archive} header from the beginning of
8664 article bodies (@code{gnus-article-strip-headers-in-body}).
8667 @kindex W E l (Summary)
8668 @findex gnus-article-strip-leading-blank-lines
8669 Remove all blank lines from the beginning of the article
8670 (@code{gnus-article-strip-leading-blank-lines}).
8673 @kindex W E m (Summary)
8674 @findex gnus-article-strip-multiple-blank-lines
8675 Replace all blank lines with empty lines and then all multiple empty
8676 lines with a single empty line.
8677 (@code{gnus-article-strip-multiple-blank-lines}).
8680 @kindex W E t (Summary)
8681 @findex gnus-article-remove-trailing-blank-lines
8682 Remove all blank lines at the end of the article
8683 (@code{gnus-article-remove-trailing-blank-lines}).
8686 @kindex W E a (Summary)
8687 @findex gnus-article-strip-blank-lines
8688 Do all the three commands above
8689 (@code{gnus-article-strip-blank-lines}).
8692 @kindex W E A (Summary)
8693 @findex gnus-article-strip-all-blank-lines
8694 Remove all blank lines
8695 (@code{gnus-article-strip-all-blank-lines}).
8698 @kindex W E s (Summary)
8699 @findex gnus-article-strip-leading-space
8700 Remove all white space from the beginning of all lines of the article
8701 body (@code{gnus-article-strip-leading-space}).
8704 @kindex W E e (Summary)
8705 @findex gnus-article-strip-trailing-space
8706 Remove all white space from the end of all lines of the article
8707 body (@code{gnus-article-strip-trailing-space}).
8711 @xref{Customizing Articles}, for how to wash articles automatically.
8714 @node Article Header
8715 @subsection Article Header
8717 These commands perform various transformations of article header.
8722 @kindex W G u (Summary)
8723 @findex gnus-article-treat-unfold-headers
8724 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
8727 @kindex W G n (Summary)
8728 @findex gnus-article-treat-fold-newsgroups
8729 Fold the @code{Newsgroups} and @code{Followup-To} headers
8730 (@code{gnus-article-treat-fold-newsgroups}).
8733 @kindex W G f (Summary)
8734 @findex gnus-article-treat-fold-headers
8735 Fold all the message headers
8736 (@code{gnus-article-treat-fold-headers}).
8739 @kindex W E w (Summary)
8740 @findex gnus-article-remove-leading-whitespace
8741 Remove excessive whitespace from all headers
8742 (@code{gnus-article-remove-leading-whitespace}).
8747 @node Article Buttons
8748 @subsection Article Buttons
8751 People often include references to other stuff in articles, and it would
8752 be nice if Gnus could just fetch whatever it is that people talk about
8753 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
8754 button on these references.
8756 @vindex gnus-button-man-handler
8757 Gnus adds @dfn{buttons} to certain standard references by default:
8758 Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and
8759 Emacs or Gnus related references. This is controlled by two variables,
8760 one that handles article bodies and one that handles article heads:
8764 @item gnus-button-alist
8765 @vindex gnus-button-alist
8766 This is an alist where each entry has this form:
8769 (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8775 All text that match this regular expression (case insensitive) will be
8776 considered an external reference. Here's a typical regexp that matches
8777 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}. This can also be a
8778 variable containing a regexp, useful variables to use include
8779 @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}.
8782 Gnus has to know which parts of the matches is to be highlighted. This
8783 is a number that says what sub-expression of the regexp is to be
8784 highlighted. If you want it all highlighted, you use 0 here.
8787 This form will be @code{eval}ed, and if the result is non-@code{nil},
8788 this is considered a match. This is useful if you want extra sifting to
8789 avoid false matches. Often variables named
8790 @code{gnus-button-@var{*}-level} are used here, @xref{Article Button
8791 Levels}, but any other form may be used too.
8793 @c @code{use-p} is @code{eval}ed only if @code{regexp} matches.
8796 This function will be called when you click on this button.
8799 As with @var{button-par}, this is a sub-expression number, but this one
8800 says which part of the match is to be sent as data to @var{function}.
8804 So the full entry for buttonizing URLs is then
8807 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
8810 @item gnus-header-button-alist
8811 @vindex gnus-header-button-alist
8812 This is just like the other alist, except that it is applied to the
8813 article head only, and that each entry has an additional element that is
8814 used to say what headers to apply the buttonize coding to:
8817 (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8820 @var{header} is a regular expression.
8823 @subsubsection Related variables and functions
8826 @item gnus-button-@var{*}-level
8827 @xref{Article Button Levels}.
8829 @c Stuff related to gnus-button-browse-level
8831 @item gnus-button-url-regexp
8832 @vindex gnus-button-url-regexp
8833 A regular expression that matches embedded URLs. It is used in the
8834 default values of the variables above.
8836 @c Stuff related to gnus-button-man-level
8838 @item gnus-button-man-handler
8839 @vindex gnus-button-man-handler
8840 The function to use for displaying man pages. It must take at least one
8841 argument with a string naming the man page.
8843 @c Stuff related to gnus-button-message-level
8845 @item gnus-button-mid-or-mail-regexp
8846 @vindex gnus-button-mid-or-mail-regexp
8847 Regular expression that matches a message ID or a mail address.
8849 @item gnus-button-prefer-mid-or-mail
8850 @vindex gnus-button-prefer-mid-or-mail
8851 This variable determines what to do when the button on a string as
8852 @samp{foo123@@bar.invalid} is pushed. Strings like this can be either a
8853 message ID or a mail address. If it is one of the symbols @code{mid} or
8854 @code{mail}, Gnus will always assume that the string is a message ID or
8855 a mail address, respectively. If this variable is set to the symbol
8856 @code{ask}, always query the user what do do. If it is a function, this
8857 function will be called with the string as its only argument. The
8858 function must return @code{mid}, @code{mail}, @code{invalid} or
8859 @code{ask}. The default value is the function
8860 @code{gnus-button-mid-or-mail-heuristic}.
8862 @item gnus-button-mid-or-mail-heuristic
8863 @findex gnus-button-mid-or-mail-heuristic
8864 Function that guesses whether its argument is a message ID or a mail
8865 address. Returns @code{mid} if it's a message IDs, @code{mail} if
8866 it's a mail address, @code{ask} if unsure and @code{invalid} if the
8869 @item gnus-button-mid-or-mail-heuristic-alist
8870 @vindex gnus-button-mid-or-mail-heuristic-alist
8871 An alist of @code{(RATE . REGEXP)} pairs used by the function
8872 @code{gnus-button-mid-or-mail-heuristic}.
8874 @c Stuff related to gnus-button-tex-level
8876 @item gnus-button-ctan-handler
8877 @findex gnus-button-ctan-handler
8878 The function to use for displaying CTAN links. It must take one
8879 argument, the string naming the URL.
8882 @vindex gnus-ctan-url
8883 Top directory of a CTAN (Comprehensive TeX Archive Network) archive used
8884 by @code{gnus-button-ctan-handler}.
8888 @item gnus-article-button-face
8889 @vindex gnus-article-button-face
8890 Face used on buttons.
8892 @item gnus-article-mouse-face
8893 @vindex gnus-article-mouse-face
8894 Face used when the mouse cursor is over a button.
8898 @xref{Customizing Articles}, for how to buttonize articles automatically.
8901 @node Article Button Levels
8902 @subsection Article button levels
8903 @cindex button levels
8904 The higher the value of the variables @code{gnus-button-@var{*}-level},
8905 the more buttons will appear. If the level is zero, no corresponding
8906 buttons are displayed. With the default value (which is 5) you should
8907 already see quite a lot of buttons. With higher levels, you will see
8908 more buttons, but you may also get more false positives. To avoid them,
8909 you can set the variables @code{gnus-button-@var{*}-level} local to
8910 specific groups (@pxref{Group Parameters}). Here's an example for the
8911 variable @code{gnus-parameters}:
8914 ;; @r{increase @code{gnus-button-*-level} in some groups:}
8915 (setq gnus-parameters
8916 '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10))
8917 ("\\<unix\\>" (gnus-button-man-level 10))
8918 ("\\<tex\\>" (gnus-button-tex-level 10))))
8923 @item gnus-button-browse-level
8924 @vindex gnus-button-browse-level
8925 Controls the display of references to message IDs, mail addresses and
8926 news URLs. Related variables and functions include
8927 @code{gnus-button-url-regexp}, @code{browse-url}, and
8928 @code{browse-url-browser-function}.
8930 @item gnus-button-emacs-level
8931 @vindex gnus-button-emacs-level
8932 Controls the display of Emacs or Gnus references. Related functions are
8933 @code{gnus-button-handle-custom},
8934 @code{gnus-button-handle-describe-function},
8935 @code{gnus-button-handle-describe-variable},
8936 @code{gnus-button-handle-symbol},
8937 @code{gnus-button-handle-describe-key},
8938 @code{gnus-button-handle-apropos},
8939 @code{gnus-button-handle-apropos-command},
8940 @code{gnus-button-handle-apropos-variable},
8941 @code{gnus-button-handle-apropos-documentation}, and
8942 @code{gnus-button-handle-library}.
8944 @item gnus-button-man-level
8945 @vindex gnus-button-man-level
8946 Controls the display of references to (Unix) man pages.
8947 See @code{gnus-button-man-handler}.
8949 @item gnus-button-message-level
8950 @vindex gnus-button-message-level
8951 Controls the display of message IDs, mail addresses and news URLs.
8952 Related variables and functions include
8953 @code{gnus-button-mid-or-mail-regexp},
8954 @code{gnus-button-prefer-mid-or-mail},
8955 @code{gnus-button-mid-or-mail-heuristic}, and
8956 @code{gnus-button-mid-or-mail-heuristic-alist}.
8958 @item gnus-button-tex-level
8959 @vindex gnus-button-tex-level
8960 Controls the display of references to @TeX{} or LaTeX stuff, e.g. for CTAN
8961 URLs. See the variables @code{gnus-ctan-url},
8962 @code{gnus-button-ctan-handler},
8963 @code{gnus-button-ctan-directory-regexp}, and
8964 @code{gnus-button-handle-ctan-bogus-regexp}.
8970 @subsection Article Date
8972 The date is most likely generated in some obscure timezone you've never
8973 heard of, so it's quite nice to be able to find out what the time was
8974 when the article was sent.
8979 @kindex W T u (Summary)
8980 @findex gnus-article-date-ut
8981 Display the date in UT (aka. GMT, aka ZULU)
8982 (@code{gnus-article-date-ut}).
8985 @kindex W T i (Summary)
8986 @findex gnus-article-date-iso8601
8988 Display the date in international format, aka. ISO 8601
8989 (@code{gnus-article-date-iso8601}).
8992 @kindex W T l (Summary)
8993 @findex gnus-article-date-local
8994 Display the date in the local timezone (@code{gnus-article-date-local}).
8997 @kindex W T p (Summary)
8998 @findex gnus-article-date-english
8999 Display the date in a format that's easily pronounceable in English
9000 (@code{gnus-article-date-english}).
9003 @kindex W T s (Summary)
9004 @vindex gnus-article-time-format
9005 @findex gnus-article-date-user
9006 @findex format-time-string
9007 Display the date using a user-defined format
9008 (@code{gnus-article-date-user}). The format is specified by the
9009 @code{gnus-article-time-format} variable, and is a string that's passed
9010 to @code{format-time-string}. See the documentation of that variable
9011 for a list of possible format specs.
9014 @kindex W T e (Summary)
9015 @findex gnus-article-date-lapsed
9016 @findex gnus-start-date-timer
9017 @findex gnus-stop-date-timer
9018 Say how much time has elapsed between the article was posted and now
9019 (@code{gnus-article-date-lapsed}). It looks something like:
9022 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
9025 @vindex gnus-article-date-lapsed-new-header
9026 The value of @code{gnus-article-date-lapsed-new-header} determines
9027 whether this header will just be added below the old Date one, or will
9030 An advantage of using Gnus to read mail is that it converts simple bugs
9031 into wonderful absurdities.
9033 If you want to have this line updated continually, you can put
9036 (gnus-start-date-timer)
9039 in your @file{~/.gnus.el} file, or you can run it off of some hook. If
9040 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
9044 @kindex W T o (Summary)
9045 @findex gnus-article-date-original
9046 Display the original date (@code{gnus-article-date-original}). This can
9047 be useful if you normally use some other conversion function and are
9048 worried that it might be doing something totally wrong. Say, claiming
9049 that the article was posted in 1854. Although something like that is
9050 @emph{totally} impossible. Don't you trust me? *titter*
9054 @xref{Customizing Articles}, for how to display the date in your
9055 preferred format automatically.
9058 @node Article Display
9059 @subsection Article Display
9064 These commands add various frivolous display gimmicks to the article
9065 buffer in Emacs versions that support them.
9067 @code{X-Face} headers are small black-and-white images supplied by the
9068 message headers (@pxref{X-Face}).
9070 @code{Face} headers are small colored images supplied by the message
9071 headers (@pxref{Face}).
9073 Smileys are those little @samp{:-)} symbols that people like to litter
9074 their messages with (@pxref{Smileys}).
9076 Picons, on the other hand, reside on your own system, and Gnus will
9077 try to match the headers to what you have (@pxref{Picons}).
9079 All these functions are toggles---if the elements already exist,
9084 @kindex W D x (Summary)
9085 @findex gnus-article-display-x-face
9086 Display an @code{X-Face} in the @code{From} header.
9087 (@code{gnus-article-display-x-face}).
9090 @kindex W D d (Summary)
9091 @findex gnus-article-display-face
9092 Display a @code{Face} in the @code{From} header.
9093 (@code{gnus-article-display-face}).
9096 @kindex W D s (Summary)
9097 @findex gnus-treat-smiley
9098 Display smileys (@code{gnus-treat-smiley}).
9101 @kindex W D f (Summary)
9102 @findex gnus-treat-from-picon
9103 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
9106 @kindex W D m (Summary)
9107 @findex gnus-treat-mail-picon
9108 Piconify all mail headers (i. e., @code{Cc}, @code{To})
9109 (@code{gnus-treat-mail-picon}).
9112 @kindex W D n (Summary)
9113 @findex gnus-treat-newsgroups-picon
9114 Piconify all news headers (i. e., @code{Newsgroups} and
9115 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
9118 @kindex W D D (Summary)
9119 @findex gnus-article-remove-images
9120 Remove all images from the article buffer
9121 (@code{gnus-article-remove-images}).
9127 @node Article Signature
9128 @subsection Article Signature
9130 @cindex article signature
9132 @vindex gnus-signature-separator
9133 Each article is divided into two parts---the head and the body. The
9134 body can be divided into a signature part and a text part. The variable
9135 that says what is to be considered a signature is
9136 @code{gnus-signature-separator}. This is normally the standard
9137 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
9138 non-standard signature separators, so this variable can also be a list
9139 of regular expressions to be tested, one by one. (Searches are done
9140 from the end of the body towards the beginning.) One likely value is:
9143 (setq gnus-signature-separator
9144 '("^-- $" ; @r{The standard}
9145 "^-- *$" ; @r{A common mangling}
9146 "^-------*$" ; @r{Many people just use a looong}
9147 ; @r{line of dashes. Shame!}
9148 "^ *--------*$" ; @r{Double-shame!}
9149 "^________*$" ; @r{Underscores are also popular}
9150 "^========*$")) ; @r{Pervert!}
9153 The more permissive you are, the more likely it is that you'll get false
9156 @vindex gnus-signature-limit
9157 @code{gnus-signature-limit} provides a limit to what is considered a
9158 signature when displaying articles.
9162 If it is an integer, no signature may be longer (in characters) than
9165 If it is a floating point number, no signature may be longer (in lines)
9168 If it is a function, the function will be called without any parameters,
9169 and if it returns @code{nil}, there is no signature in the buffer.
9171 If it is a string, it will be used as a regexp. If it matches, the text
9172 in question is not a signature.
9175 This variable can also be a list where the elements may be of the types
9176 listed above. Here's an example:
9179 (setq gnus-signature-limit
9180 '(200.0 "^---*Forwarded article"))
9183 This means that if there are more than 200 lines after the signature
9184 separator, or the text after the signature separator is matched by
9185 the regular expression @samp{^---*Forwarded article}, then it isn't a
9186 signature after all.
9189 @node Article Miscellanea
9190 @subsection Article Miscellanea
9194 @kindex A t (Summary)
9195 @findex gnus-article-babel
9196 Translate the article from one language to another
9197 (@code{gnus-article-babel}).
9203 @section MIME Commands
9204 @cindex MIME decoding
9206 @cindex viewing attachments
9208 The following commands all understand the numerical prefix. For
9209 instance, @kbd{3 b} means ``view the third @acronym{MIME} part''.
9215 @kindex K v (Summary)
9216 View the @acronym{MIME} part.
9219 @kindex K o (Summary)
9220 Save the @acronym{MIME} part.
9223 @kindex K c (Summary)
9224 Copy the @acronym{MIME} part.
9227 @kindex K e (Summary)
9228 View the @acronym{MIME} part externally.
9231 @kindex K i (Summary)
9232 View the @acronym{MIME} part internally.
9235 @kindex K | (Summary)
9236 Pipe the @acronym{MIME} part to an external command.
9239 The rest of these @acronym{MIME} commands do not use the numerical prefix in
9244 @kindex K b (Summary)
9245 Make all the @acronym{MIME} parts have buttons in front of them. This is
9246 mostly useful if you wish to save (or perform other actions) on inlined
9250 @kindex K m (Summary)
9251 @findex gnus-summary-repair-multipart
9252 Some multipart messages are transmitted with missing or faulty headers.
9253 This command will attempt to ``repair'' these messages so that they can
9254 be viewed in a more pleasant manner
9255 (@code{gnus-summary-repair-multipart}).
9258 @kindex X m (Summary)
9259 @findex gnus-summary-save-parts
9260 Save all parts matching a @acronym{MIME} type to a directory
9261 (@code{gnus-summary-save-parts}). Understands the process/prefix
9262 convention (@pxref{Process/Prefix}).
9265 @kindex M-t (Summary)
9266 @findex gnus-summary-toggle-display-buttonized
9267 Toggle the buttonized display of the article buffer
9268 (@code{gnus-summary-toggle-display-buttonized}).
9271 @kindex W M w (Summary)
9272 @findex gnus-article-decode-mime-words
9273 Decode RFC 2047-encoded words in the article headers
9274 (@code{gnus-article-decode-mime-words}).
9277 @kindex W M c (Summary)
9278 @findex gnus-article-decode-charset
9279 Decode encoded article bodies as well as charsets
9280 (@code{gnus-article-decode-charset}).
9282 This command looks in the @code{Content-Type} header to determine the
9283 charset. If there is no such header in the article, you can give it a
9284 prefix, which will prompt for the charset to decode as. In regional
9285 groups where people post using some common encoding (but do not
9286 include @acronym{MIME} headers), you can set the @code{charset} group/topic
9287 parameter to the required charset (@pxref{Group Parameters}).
9290 @kindex W M v (Summary)
9291 @findex gnus-mime-view-all-parts
9292 View all the @acronym{MIME} parts in the current article
9293 (@code{gnus-mime-view-all-parts}).
9300 @item gnus-ignored-mime-types
9301 @vindex gnus-ignored-mime-types
9302 This is a list of regexps. @acronym{MIME} types that match a regexp from
9303 this list will be completely ignored by Gnus. The default value is
9306 To have all Vcards be ignored, you'd say something like this:
9309 (setq gnus-ignored-mime-types
9313 @item gnus-article-loose-mime
9314 @vindex gnus-article-loose-mime
9315 If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header
9316 before interpreting the message as a @acronym{MIME} message. This helps
9317 when reading messages from certain broken mail user agents. The
9318 default is @code{nil}.
9320 @item gnus-article-emulate-mime
9321 @vindex gnus-article-emulate-mime
9322 There are other, non-@acronym{MIME} encoding methods used. The most common
9323 is @samp{uuencode}, but yEncode is also getting to be popular. If
9324 this variable is non-@code{nil}, Gnus will look in message bodies to
9325 see if it finds these encodings, and if so, it'll run them through the
9326 Gnus @acronym{MIME} machinery. The default is @code{t}.
9328 @item gnus-unbuttonized-mime-types
9329 @vindex gnus-unbuttonized-mime-types
9330 This is a list of regexps. @acronym{MIME} types that match a regexp from
9331 this list won't have @acronym{MIME} buttons inserted unless they aren't
9332 displayed or this variable is overridden by
9333 @code{gnus-buttonized-mime-types}. The default value is
9334 @code{(".*/.*")}. This variable is only used when
9335 @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}.
9337 @item gnus-buttonized-mime-types
9338 @vindex gnus-buttonized-mime-types
9339 This is a list of regexps. @acronym{MIME} types that match a regexp from
9340 this list will have @acronym{MIME} buttons inserted unless they aren't
9341 displayed. This variable overrides
9342 @code{gnus-unbuttonized-mime-types}. The default value is @code{nil}.
9343 This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
9346 To see e.g. security buttons but no other buttons, you could set this
9347 variable to @code{("multipart/signed")} and leave
9348 @code{gnus-unbuttonized-mime-types} at the default value.
9350 @item gnus-inhibit-mime-unbuttonizing
9351 @vindex gnus-inhibit-mime-unbuttonizing
9352 If this is non-@code{nil}, then all @acronym{MIME} parts get buttons. The
9353 default value is @code{nil}.
9355 @item gnus-article-mime-part-function
9356 @vindex gnus-article-mime-part-function
9357 For each @acronym{MIME} part, this function will be called with the @acronym{MIME}
9358 handle as the parameter. The function is meant to be used to allow
9359 users to gather information from the article (e. g., add Vcard info to
9360 the bbdb database) or to do actions based on parts (e. g., automatically
9361 save all jpegs into some directory).
9363 Here's an example function the does the latter:
9366 (defun my-save-all-jpeg-parts (handle)
9367 (when (equal (car (mm-handle-type handle)) "image/jpeg")
9369 (insert (mm-get-part handle))
9370 (write-region (point-min) (point-max)
9371 (read-file-name "Save jpeg to: ")))))
9372 (setq gnus-article-mime-part-function
9373 'my-save-all-jpeg-parts)
9376 @vindex gnus-mime-multipart-functions
9377 @item gnus-mime-multipart-functions
9378 Alist of @acronym{MIME} multipart types and functions to handle them.
9380 @vindex mm-file-name-rewrite-functions
9381 @item mm-file-name-rewrite-functions
9382 List of functions used for rewriting file names of @acronym{MIME} parts.
9383 Each function takes a file name as input and returns a file name.
9385 Ready-made functions include@*
9386 @code{mm-file-name-delete-whitespace},
9387 @code{mm-file-name-trim-whitespace},
9388 @code{mm-file-name-collapse-whitespace}, and
9389 @code{mm-file-name-replace-whitespace}. The later uses the value of
9390 the variable @code{mm-file-name-replace-whitespace} to replace each
9391 whitespace character in a file name with that string; default value
9392 is @code{"_"} (a single underscore).
9393 @findex mm-file-name-delete-whitespace
9394 @findex mm-file-name-trim-whitespace
9395 @findex mm-file-name-collapse-whitespace
9396 @findex mm-file-name-replace-whitespace
9397 @vindex mm-file-name-replace-whitespace
9399 The standard functions @code{capitalize}, @code{downcase},
9400 @code{upcase}, and @code{upcase-initials} may be useful, too.
9402 Everybody knows that whitespace characters in file names are evil,
9403 except those who don't know. If you receive lots of attachments from
9404 such unenlightened users, you can make live easier by adding
9407 (setq mm-file-name-rewrite-functions
9408 '(mm-file-name-trim-whitespace
9409 mm-file-name-collapse-whitespace
9410 mm-file-name-replace-whitespace))
9414 to your @file{~/.gnus.el} file.
9423 People use different charsets, and we have @acronym{MIME} to let us know what
9424 charsets they use. Or rather, we wish we had. Many people use
9425 newsreaders and mailers that do not understand or use @acronym{MIME}, and
9426 just send out messages without saying what character sets they use. To
9427 help a bit with this, some local news hierarchies have policies that say
9428 what character set is the default. For instance, the @samp{fj}
9429 hierarchy uses @code{iso-2022-jp-2}.
9431 @vindex gnus-group-charset-alist
9432 This knowledge is encoded in the @code{gnus-group-charset-alist}
9433 variable, which is an alist of regexps (use the first item to match full
9434 group names) and default charsets to be used when reading these groups.
9436 @vindex gnus-newsgroup-ignored-charsets
9437 In addition, some people do use soi-disant @acronym{MIME}-aware agents that
9438 aren't. These blithely mark messages as being in @code{iso-8859-1}
9439 even if they really are in @code{koi-8}. To help here, the
9440 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
9441 charsets that are listed here will be ignored. The variable can be
9442 set on a group-by-group basis using the group parameters (@pxref{Group
9443 Parameters}). The default value is @code{(unknown-8bit x-unknown)},
9444 which includes values some agents insist on having in there.
9446 @vindex gnus-group-posting-charset-alist
9447 When posting, @code{gnus-group-posting-charset-alist} is used to
9448 determine which charsets should not be encoded using the @acronym{MIME}
9449 encodings. For instance, some hierarchies discourage using
9450 quoted-printable header encoding.
9452 This variable is an alist of regexps and permitted unencoded charsets
9453 for posting. Each element of the alist has the form @code{(}@var{test
9454 header body-list}@code{)}, where:
9458 is either a regular expression matching the newsgroup header or a
9461 is the charset which may be left unencoded in the header (@code{nil}
9462 means encode all charsets),
9464 is a list of charsets which may be encoded using 8bit content-transfer
9465 encoding in the body, or one of the special values @code{nil} (always
9466 encode using quoted-printable) or @code{t} (always use 8bit).
9473 @cindex coding system aliases
9474 @cindex preferred charset
9476 Other charset tricks that may be useful, although not Gnus-specific:
9478 If there are several @acronym{MIME} charsets that encode the same Emacs
9479 charset, you can choose what charset to use by saying the following:
9482 (put-charset-property 'cyrillic-iso8859-5
9483 'preferred-coding-system 'koi8-r)
9486 This means that Russian will be encoded using @code{koi8-r} instead of
9487 the default @code{iso-8859-5} @acronym{MIME} charset.
9489 If you want to read messages in @code{koi8-u}, you can cheat and say
9492 (define-coding-system-alias 'koi8-u 'koi8-r)
9495 This will almost do the right thing.
9497 And finally, to read charsets like @code{windows-1251}, you can say
9501 (codepage-setup 1251)
9502 (define-coding-system-alias 'windows-1251 'cp1251)
9506 @node Article Commands
9507 @section Article Commands
9514 @kindex A P (Summary)
9515 @vindex gnus-ps-print-hook
9516 @findex gnus-summary-print-article
9517 Generate and print a PostScript image of the article buffer
9518 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will
9519 be run just before printing the buffer. An alternative way to print
9520 article is to use Muttprint (@pxref{Saving Articles}).
9525 @node Summary Sorting
9526 @section Summary Sorting
9527 @cindex summary sorting
9529 You can have the summary buffer sorted in various ways, even though I
9530 can't really see why you'd want that.
9535 @kindex C-c C-s C-n (Summary)
9536 @findex gnus-summary-sort-by-number
9537 Sort by article number (@code{gnus-summary-sort-by-number}).
9540 @kindex C-c C-s C-a (Summary)
9541 @findex gnus-summary-sort-by-author
9542 Sort by author (@code{gnus-summary-sort-by-author}).
9545 @kindex C-c C-s C-s (Summary)
9546 @findex gnus-summary-sort-by-subject
9547 Sort by subject (@code{gnus-summary-sort-by-subject}).
9550 @kindex C-c C-s C-d (Summary)
9551 @findex gnus-summary-sort-by-date
9552 Sort by date (@code{gnus-summary-sort-by-date}).
9555 @kindex C-c C-s C-l (Summary)
9556 @findex gnus-summary-sort-by-lines
9557 Sort by lines (@code{gnus-summary-sort-by-lines}).
9560 @kindex C-c C-s C-c (Summary)
9561 @findex gnus-summary-sort-by-chars
9562 Sort by article length (@code{gnus-summary-sort-by-chars}).
9565 @kindex C-c C-s C-i (Summary)
9566 @findex gnus-summary-sort-by-score
9567 Sort by score (@code{gnus-summary-sort-by-score}).
9570 @kindex C-c C-s C-r (Summary)
9571 @findex gnus-summary-sort-by-random
9572 Randomize (@code{gnus-summary-sort-by-random}).
9575 @kindex C-c C-s C-o (Summary)
9576 @findex gnus-summary-sort-by-original
9577 Sort using the default sorting method
9578 (@code{gnus-summary-sort-by-original}).
9581 These functions will work both when you use threading and when you don't
9582 use threading. In the latter case, all summary lines will be sorted,
9583 line by line. In the former case, sorting will be done on a
9584 root-by-root basis, which might not be what you were looking for. To
9585 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
9589 @node Finding the Parent
9590 @section Finding the Parent
9591 @cindex parent articles
9592 @cindex referring articles
9597 @findex gnus-summary-refer-parent-article
9598 If you'd like to read the parent of the current article, and it is not
9599 displayed in the summary buffer, you might still be able to. That is,
9600 if the current group is fetched by @acronym{NNTP}, the parent hasn't expired
9601 and the @code{References} in the current article are not mangled, you
9602 can just press @kbd{^} or @kbd{A r}
9603 (@code{gnus-summary-refer-parent-article}). If everything goes well,
9604 you'll get the parent. If the parent is already displayed in the
9605 summary buffer, point will just move to this article.
9607 If given a positive numerical prefix, fetch that many articles back into
9608 the ancestry. If given a negative numerical prefix, fetch just that
9609 ancestor. So if you say @kbd{3 ^}, gnus will fetch the parent, the
9610 grandparent and the grandgrandparent of the current article. If you say
9611 @kbd{-3 ^}, gnus will only fetch the grandgrandparent of the current
9615 @findex gnus-summary-refer-references
9616 @kindex A R (Summary)
9617 Fetch all articles mentioned in the @code{References} header of the
9618 article (@code{gnus-summary-refer-references}).
9621 @findex gnus-summary-refer-thread
9622 @kindex A T (Summary)
9623 Display the full thread where the current article appears
9624 (@code{gnus-summary-refer-thread}). This command has to fetch all the
9625 headers in the current group to work, so it usually takes a while. If
9626 you do it often, you may consider setting @code{gnus-fetch-old-headers}
9627 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
9628 visible effects normally, but it'll make this command work a whole lot
9629 faster. Of course, it'll make group entry somewhat slow.
9631 @vindex gnus-refer-thread-limit
9632 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
9633 articles before the first displayed in the current group) headers to
9634 fetch when doing this command. The default is 200. If @code{t}, all
9635 the available headers will be fetched. This variable can be overridden
9636 by giving the @kbd{A T} command a numerical prefix.
9639 @findex gnus-summary-refer-article
9640 @kindex M-^ (Summary)
9642 @cindex fetching by Message-ID
9643 You can also ask the @acronym{NNTP} server for an arbitrary article, no
9644 matter what group it belongs to. @kbd{M-^}
9645 (@code{gnus-summary-refer-article}) will ask you for a
9646 @code{Message-ID}, which is one of those long, hard-to-read thingies
9647 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
9648 have to get it all exactly right. No fuzzy searches, I'm afraid.
9651 The current select method will be used when fetching by
9652 @code{Message-ID} from non-news select method, but you can override this
9653 by giving this command a prefix.
9655 @vindex gnus-refer-article-method
9656 If the group you are reading is located on a back end that does not
9657 support fetching by @code{Message-ID} very well (like @code{nnspool}),
9658 you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method. It
9659 would, perhaps, be best if the @acronym{NNTP} server you consult is the one
9660 updating the spool you are reading from, but that's not really
9663 It can also be a list of select methods, as well as the special symbol
9664 @code{current}, which means to use the current select method. If it
9665 is a list, Gnus will try all the methods in the list until it finds a
9668 Here's an example setting that will first try the current method, and
9669 then ask Google if that fails:
9672 (setq gnus-refer-article-method
9674 (nnweb "google" (nnweb-type google))))
9677 Most of the mail back ends support fetching by @code{Message-ID}, but
9678 do not do a particularly excellent job at it. That is, @code{nnmbox},
9679 @code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate
9680 articles from any groups, while @code{nnfolder}, and @code{nnimap} are
9681 only able to locate articles that have been posted to the current
9682 group. (Anything else would be too time consuming.) @code{nnmh} does
9683 not support this at all.
9686 @node Alternative Approaches
9687 @section Alternative Approaches
9689 Different people like to read news using different methods. This being
9690 gnus, we offer a small selection of minor modes for the summary buffers.
9693 * Pick and Read:: First mark articles and then read them.
9694 * Binary Groups:: Auto-decode all articles.
9699 @subsection Pick and Read
9700 @cindex pick and read
9702 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
9703 a two-phased reading interface. The user first marks in a summary
9704 buffer the articles she wants to read. Then she starts reading the
9705 articles with just an article buffer displayed.
9707 @findex gnus-pick-mode
9708 @kindex M-x gnus-pick-mode
9709 Gnus provides a summary buffer minor mode that allows
9710 this---@code{gnus-pick-mode}. This basically means that a few process
9711 mark commands become one-keystroke commands to allow easy marking, and
9712 it provides one additional command for switching to the summary buffer.
9714 Here are the available keystrokes when using pick mode:
9719 @findex gnus-pick-article-or-thread
9720 Pick the article or thread on the current line
9721 (@code{gnus-pick-article-or-thread}). If the variable
9722 @code{gnus-thread-hide-subtree} is true, then this key selects the
9723 entire thread when used at the first article of the thread. Otherwise,
9724 it selects just the article. If given a numerical prefix, go to that
9725 thread or article and pick it. (The line number is normally displayed
9726 at the beginning of the summary pick lines.)
9729 @kindex SPACE (Pick)
9730 @findex gnus-pick-next-page
9731 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
9732 at the end of the buffer, start reading the picked articles.
9736 @findex gnus-pick-unmark-article-or-thread.
9737 Unpick the thread or article
9738 (@code{gnus-pick-unmark-article-or-thread}). If the variable
9739 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
9740 thread if used at the first article of the thread. Otherwise it unpicks
9741 just the article. You can give this key a numerical prefix to unpick
9742 the thread or article at that line.
9746 @findex gnus-pick-start-reading
9747 @vindex gnus-pick-display-summary
9748 Start reading the picked articles (@code{gnus-pick-start-reading}). If
9749 given a prefix, mark all unpicked articles as read first. If
9750 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
9751 will still be visible when you are reading.
9755 All the normal summary mode commands are still available in the
9756 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
9757 which is mapped to the same function
9758 @code{gnus-summary-tick-article-forward}.
9760 If this sounds like a good idea to you, you could say:
9763 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
9766 @vindex gnus-pick-mode-hook
9767 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
9769 @vindex gnus-mark-unpicked-articles-as-read
9770 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
9771 all unpicked articles as read. The default is @code{nil}.
9773 @vindex gnus-summary-pick-line-format
9774 The summary line format in pick mode is slightly different from the
9775 standard format. At the beginning of each line the line number is
9776 displayed. The pick mode line format is controlled by the
9777 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
9778 Variables}). It accepts the same format specs that
9779 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
9783 @subsection Binary Groups
9784 @cindex binary groups
9786 @findex gnus-binary-mode
9787 @kindex M-x gnus-binary-mode
9788 If you spend much time in binary groups, you may grow tired of hitting
9789 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
9790 is a minor mode for summary buffers that makes all ordinary Gnus article
9791 selection functions uudecode series of articles and display the result
9792 instead of just displaying the articles the normal way.
9795 @findex gnus-binary-show-article
9796 The only way, in fact, to see the actual articles is the @kbd{g}
9797 command, when you have turned on this mode
9798 (@code{gnus-binary-show-article}).
9800 @vindex gnus-binary-mode-hook
9801 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
9805 @section Tree Display
9808 @vindex gnus-use-trees
9809 If you don't like the normal gnus summary display, you might try setting
9810 @code{gnus-use-trees} to @code{t}. This will create (by default) an
9811 additional @dfn{tree buffer}. You can execute all summary mode commands
9814 There are a few variables to customize the tree display, of course:
9817 @item gnus-tree-mode-hook
9818 @vindex gnus-tree-mode-hook
9819 A hook called in all tree mode buffers.
9821 @item gnus-tree-mode-line-format
9822 @vindex gnus-tree-mode-line-format
9823 A format string for the mode bar in the tree mode buffers (@pxref{Mode
9824 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
9825 of valid specs, @pxref{Summary Buffer Mode Line}.
9827 @item gnus-selected-tree-face
9828 @vindex gnus-selected-tree-face
9829 Face used for highlighting the selected article in the tree buffer. The
9830 default is @code{modeline}.
9832 @item gnus-tree-line-format
9833 @vindex gnus-tree-line-format
9834 A format string for the tree nodes. The name is a bit of a misnomer,
9835 though---it doesn't define a line, but just the node. The default value
9836 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
9837 the name of the poster. It is vital that all nodes are of the same
9838 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
9844 The name of the poster.
9846 The @code{From} header.
9848 The number of the article.
9850 The opening bracket.
9852 The closing bracket.
9857 @xref{Formatting Variables}.
9859 Variables related to the display are:
9862 @item gnus-tree-brackets
9863 @vindex gnus-tree-brackets
9864 This is used for differentiating between ``real'' articles and
9865 ``sparse'' articles. The format is
9867 ((@var{real-open} . @var{real-close})
9868 (@var{sparse-open} . @var{sparse-close})
9869 (@var{dummy-open} . @var{dummy-close}))
9871 and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
9873 @item gnus-tree-parent-child-edges
9874 @vindex gnus-tree-parent-child-edges
9875 This is a list that contains the characters used for connecting parent
9876 nodes to their children. The default is @code{(?- ?\\ ?|)}.
9880 @item gnus-tree-minimize-window
9881 @vindex gnus-tree-minimize-window
9882 If this variable is non-@code{nil}, gnus will try to keep the tree
9883 buffer as small as possible to allow more room for the other gnus
9884 windows. If this variable is a number, the tree buffer will never be
9885 higher than that number. The default is @code{t}. Note that if you
9886 have several windows displayed side-by-side in a frame and the tree
9887 buffer is one of these, minimizing the tree window will also resize all
9888 other windows displayed next to it.
9890 You may also wish to add the following hook to keep the window minimized
9894 (add-hook 'gnus-configure-windows-hook
9895 'gnus-tree-perhaps-minimize)
9898 @item gnus-generate-tree-function
9899 @vindex gnus-generate-tree-function
9900 @findex gnus-generate-horizontal-tree
9901 @findex gnus-generate-vertical-tree
9902 The function that actually generates the thread tree. Two predefined
9903 functions are available: @code{gnus-generate-horizontal-tree} and
9904 @code{gnus-generate-vertical-tree} (which is the default).
9908 Here's an example from a horizontal tree buffer:
9911 @{***@}-(***)-[odd]-[Gun]
9921 Here's the same thread displayed in a vertical tree buffer:
9926 |--------------------------\-----\-----\
9927 (***) [Bjo] [Gun] [Gun]
9929 [odd] [Jan] [odd] (***) [Jor]
9931 [Gun] [Eri] [Eri] [odd]
9937 If you're using horizontal trees, it might be nice to display the trees
9938 side-by-side with the summary buffer. You could add something like the
9939 following to your @file{~/.gnus.el} file:
9942 (setq gnus-use-trees t
9943 gnus-generate-tree-function 'gnus-generate-horizontal-tree
9944 gnus-tree-minimize-window nil)
9945 (gnus-add-configuration
9949 (summary 0.75 point)
9954 @xref{Window Layout}.
9957 @node Mail Group Commands
9958 @section Mail Group Commands
9959 @cindex mail group commands
9961 Some commands only make sense in mail groups. If these commands are
9962 invalid in the current group, they will raise a hell and let you know.
9964 All these commands (except the expiry and edit commands) use the
9965 process/prefix convention (@pxref{Process/Prefix}).
9970 @kindex B e (Summary)
9971 @findex gnus-summary-expire-articles
9972 Run all expirable articles in the current group through the expiry
9973 process (@code{gnus-summary-expire-articles}). That is, delete all
9974 expirable articles in the group that have been around for a while.
9975 (@pxref{Expiring Mail}).
9978 @kindex B C-M-e (Summary)
9979 @findex gnus-summary-expire-articles-now
9980 Delete all the expirable articles in the group
9981 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
9982 articles eligible for expiry in the current group will
9983 disappear forever into that big @file{/dev/null} in the sky.
9986 @kindex B DEL (Summary)
9987 @findex gnus-summary-delete-article
9988 @c @icon{gnus-summary-mail-delete}
9989 Delete the mail article. This is ``delete'' as in ``delete it from your
9990 disk forever and ever, never to return again.'' Use with caution.
9991 (@code{gnus-summary-delete-article}).
9994 @kindex B m (Summary)
9996 @findex gnus-summary-move-article
9997 @vindex gnus-preserve-marks
9998 Move the article from one mail group to another
9999 (@code{gnus-summary-move-article}). Marks will be preserved if
10000 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10003 @kindex B c (Summary)
10005 @findex gnus-summary-copy-article
10006 @c @icon{gnus-summary-mail-copy}
10007 Copy the article from one group (mail group or not) to a mail group
10008 (@code{gnus-summary-copy-article}). Marks will be preserved if
10009 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10012 @kindex B B (Summary)
10013 @cindex crosspost mail
10014 @findex gnus-summary-crosspost-article
10015 Crosspost the current article to some other group
10016 (@code{gnus-summary-crosspost-article}). This will create a new copy of
10017 the article in the other group, and the Xref headers of the article will
10018 be properly updated.
10021 @kindex B i (Summary)
10022 @findex gnus-summary-import-article
10023 Import an arbitrary file into the current mail newsgroup
10024 (@code{gnus-summary-import-article}). You will be prompted for a file
10025 name, a @code{From} header and a @code{Subject} header.
10028 @kindex B I (Summary)
10029 @findex gnus-summary-create-article
10030 Create an empty article in the current mail newsgroups
10031 (@code{gnus-summary-create-article}). You will be prompted for a
10032 @code{From} header and a @code{Subject} header.
10035 @kindex B r (Summary)
10036 @findex gnus-summary-respool-article
10037 @vindex gnus-summary-respool-default-method
10038 Respool the mail article (@code{gnus-summary-respool-article}).
10039 @code{gnus-summary-respool-default-method} will be used as the default
10040 select method when respooling. This variable is @code{nil} by default,
10041 which means that the current group select method will be used instead.
10042 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
10043 (which is the default).
10047 @kindex B w (Summary)
10048 @kindex e (Summary)
10049 @findex gnus-summary-edit-article
10050 @kindex C-c C-c (Article)
10051 @findex gnus-summary-edit-article-done
10052 Edit the current article (@code{gnus-summary-edit-article}). To finish
10053 editing and make the changes permanent, type @kbd{C-c C-c}
10054 (@code{gnus-summary-edit-article-done}). If you give a prefix to the
10055 @kbd{C-c C-c} command, gnus won't re-highlight the article.
10058 @kindex B q (Summary)
10059 @findex gnus-summary-respool-query
10060 If you want to re-spool an article, you might be curious as to what group
10061 the article will end up in before you do the re-spooling. This command
10062 will tell you (@code{gnus-summary-respool-query}).
10065 @kindex B t (Summary)
10066 @findex gnus-summary-respool-trace
10067 Similarly, this command will display all fancy splitting patterns used
10068 when respooling, if any (@code{gnus-summary-respool-trace}).
10071 @kindex B p (Summary)
10072 @findex gnus-summary-article-posted-p
10073 Some people have a tendency to send you ``courtesy'' copies when they
10074 follow up to articles you have posted. These usually have a
10075 @code{Newsgroups} header in them, but not always. This command
10076 (@code{gnus-summary-article-posted-p}) will try to fetch the current
10077 article from your news server (or rather, from
10078 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
10079 report back whether it found the article or not. Even if it says that
10080 it didn't find the article, it may have been posted anyway---mail
10081 propagation is much faster than news propagation, and the news copy may
10082 just not have arrived yet.
10085 @kindex K E (Summary)
10086 @findex gnus-article-encrypt-body
10087 @vindex gnus-article-encrypt-protocol
10088 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
10089 The body is encrypted with the encryption protocol specified by the
10090 variable @code{gnus-article-encrypt-protocol}.
10094 @vindex gnus-move-split-methods
10095 @cindex moving articles
10096 If you move (or copy) articles regularly, you might wish to have gnus
10097 suggest where to put the articles. @code{gnus-move-split-methods} is a
10098 variable that uses the same syntax as @code{gnus-split-methods}
10099 (@pxref{Saving Articles}). You may customize that variable to create
10100 suggestions you find reasonable. (Note that
10101 @code{gnus-move-split-methods} uses group names where
10102 @code{gnus-split-methods} uses file names.)
10105 (setq gnus-move-split-methods
10106 '(("^From:.*Lars Magne" "nnml:junk")
10107 ("^Subject:.*gnus" "nnfolder:important")
10108 (".*" "nnml:misc")))
10112 @node Various Summary Stuff
10113 @section Various Summary Stuff
10116 * Summary Group Information:: Information oriented commands.
10117 * Searching for Articles:: Multiple article commands.
10118 * Summary Generation Commands::
10119 * Really Various Summary Commands:: Those pesky non-conformant commands.
10123 @vindex gnus-summary-display-while-building
10124 @item gnus-summary-display-while-building
10125 If non-@code{nil}, show and update the summary buffer as it's being
10126 built. If @code{t}, update the buffer after every line is inserted.
10127 If the value is an integer, @var{n}, update the display every @var{n}
10128 lines. The default is @code{nil}.
10130 @vindex gnus-summary-display-arrow
10131 @item gnus-summary-display-arrow
10132 If non-@code{nil}, display an arrow in the fringe to indicate the
10135 @vindex gnus-summary-mode-hook
10136 @item gnus-summary-mode-hook
10137 This hook is called when creating a summary mode buffer.
10139 @vindex gnus-summary-generate-hook
10140 @item gnus-summary-generate-hook
10141 This is called as the last thing before doing the threading and the
10142 generation of the summary buffer. It's quite convenient for customizing
10143 the threading variables based on what data the newsgroup has. This hook
10144 is called from the summary buffer after most summary buffer variables
10147 @vindex gnus-summary-prepare-hook
10148 @item gnus-summary-prepare-hook
10149 It is called after the summary buffer has been generated. You might use
10150 it to, for instance, highlight lines or modify the look of the buffer in
10151 some other ungodly manner. I don't care.
10153 @vindex gnus-summary-prepared-hook
10154 @item gnus-summary-prepared-hook
10155 A hook called as the very last thing after the summary buffer has been
10158 @vindex gnus-summary-ignore-duplicates
10159 @item gnus-summary-ignore-duplicates
10160 When gnus discovers two articles that have the same @code{Message-ID},
10161 it has to do something drastic. No articles are allowed to have the
10162 same @code{Message-ID}, but this may happen when reading mail from some
10163 sources. Gnus allows you to customize what happens with this variable.
10164 If it is @code{nil} (which is the default), gnus will rename the
10165 @code{Message-ID} (for display purposes only) and display the article as
10166 any other article. If this variable is @code{t}, it won't display the
10167 article---it'll be as if it never existed.
10169 @vindex gnus-alter-articles-to-read-function
10170 @item gnus-alter-articles-to-read-function
10171 This function, which takes two parameters (the group name and the list
10172 of articles to be selected), is called to allow the user to alter the
10173 list of articles to be selected.
10175 For instance, the following function adds the list of cached articles to
10176 the list in one particular group:
10179 (defun my-add-cached-articles (group articles)
10180 (if (string= group "some.group")
10181 (append gnus-newsgroup-cached articles)
10185 @vindex gnus-newsgroup-variables
10186 @item gnus-newsgroup-variables
10187 A list of newsgroup (summary buffer) local variables, or cons of
10188 variables and their default values (when the default values are not
10189 @code{nil}), that should be made global while the summary buffer is
10190 active. These variables can be used to set variables in the group
10191 parameters while still allowing them to affect operations done in
10192 other buffers. For example:
10195 (setq gnus-newsgroup-variables
10196 '(message-use-followup-to
10197 (gnus-visible-headers .
10198 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
10204 @node Summary Group Information
10205 @subsection Summary Group Information
10210 @kindex H f (Summary)
10211 @findex gnus-summary-fetch-faq
10212 @vindex gnus-group-faq-directory
10213 Try to fetch the @acronym{FAQ} (list of frequently asked questions)
10214 for the current group (@code{gnus-summary-fetch-faq}). Gnus will try
10215 to get the @acronym{FAQ} from @code{gnus-group-faq-directory}, which
10216 is usually a directory on a remote machine. This variable can also be
10217 a list of directories. In that case, giving a prefix to this command
10218 will allow you to choose between the various sites. @code{ange-ftp}
10219 or @code{efs} will probably be used for fetching the file.
10222 @kindex H d (Summary)
10223 @findex gnus-summary-describe-group
10224 Give a brief description of the current group
10225 (@code{gnus-summary-describe-group}). If given a prefix, force
10226 rereading the description from the server.
10229 @kindex H h (Summary)
10230 @findex gnus-summary-describe-briefly
10231 Give an extremely brief description of the most important summary
10232 keystrokes (@code{gnus-summary-describe-briefly}).
10235 @kindex H i (Summary)
10236 @findex gnus-info-find-node
10237 Go to the gnus info node (@code{gnus-info-find-node}).
10241 @node Searching for Articles
10242 @subsection Searching for Articles
10247 @kindex M-s (Summary)
10248 @findex gnus-summary-search-article-forward
10249 Search through all subsequent (raw) articles for a regexp
10250 (@code{gnus-summary-search-article-forward}).
10253 @kindex M-r (Summary)
10254 @findex gnus-summary-search-article-backward
10255 Search through all previous (raw) articles for a regexp
10256 (@code{gnus-summary-search-article-backward}).
10259 @kindex & (Summary)
10260 @findex gnus-summary-execute-command
10261 This command will prompt you for a header, a regular expression to match
10262 on this field, and a command to be executed if the match is made
10263 (@code{gnus-summary-execute-command}). If the header is an empty
10264 string, the match is done on the entire article. If given a prefix,
10265 search backward instead.
10267 For instance, @kbd{& RET some.*string RET #} will put the process mark on
10268 all articles that have heads or bodies that match @samp{some.*string}.
10271 @kindex M-& (Summary)
10272 @findex gnus-summary-universal-argument
10273 Perform any operation on all articles that have been marked with
10274 the process mark (@code{gnus-summary-universal-argument}).
10277 @node Summary Generation Commands
10278 @subsection Summary Generation Commands
10283 @kindex Y g (Summary)
10284 @findex gnus-summary-prepare
10285 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
10288 @kindex Y c (Summary)
10289 @findex gnus-summary-insert-cached-articles
10290 Pull all cached articles (for the current group) into the summary buffer
10291 (@code{gnus-summary-insert-cached-articles}).
10294 @kindex Y d (Summary)
10295 @findex gnus-summary-insert-dormant-articles
10296 Pull all dormant articles (for the current group) into the summary buffer
10297 (@code{gnus-summary-insert-dormant-articles}).
10302 @node Really Various Summary Commands
10303 @subsection Really Various Summary Commands
10309 @kindex C-d (Summary)
10310 @kindex A D (Summary)
10311 @findex gnus-summary-enter-digest-group
10312 If the current article is a collection of other articles (for instance,
10313 a digest), you might use this command to enter a group based on the that
10314 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
10315 guess what article type is currently displayed unless you give a prefix
10316 to this command, which forces a ``digest'' interpretation. Basically,
10317 whenever you see a message that is a collection of other messages of
10318 some format, you @kbd{C-d} and read these messages in a more convenient
10322 @kindex C-M-d (Summary)
10323 @findex gnus-summary-read-document
10324 This command is very similar to the one above, but lets you gather
10325 several documents into one biiig group
10326 (@code{gnus-summary-read-document}). It does this by opening several
10327 @code{nndoc} groups for each document, and then opening an
10328 @code{nnvirtual} group on top of these @code{nndoc} groups. This
10329 command understands the process/prefix convention
10330 (@pxref{Process/Prefix}).
10333 @kindex C-t (Summary)
10334 @findex gnus-summary-toggle-truncation
10335 Toggle truncation of summary lines
10336 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
10337 line centering function in the summary buffer, so it's not a good idea
10338 to have truncation switched off while reading articles.
10341 @kindex = (Summary)
10342 @findex gnus-summary-expand-window
10343 Expand the summary buffer window (@code{gnus-summary-expand-window}).
10344 If given a prefix, force an @code{article} window configuration.
10347 @kindex C-M-e (Summary)
10348 @findex gnus-summary-edit-parameters
10349 Edit the group parameters (@pxref{Group Parameters}) of the current
10350 group (@code{gnus-summary-edit-parameters}).
10353 @kindex C-M-a (Summary)
10354 @findex gnus-summary-customize-parameters
10355 Customize the group parameters (@pxref{Group Parameters}) of the current
10356 group (@code{gnus-summary-customize-parameters}).
10361 @node Exiting the Summary Buffer
10362 @section Exiting the Summary Buffer
10363 @cindex summary exit
10364 @cindex exiting groups
10366 Exiting from the summary buffer will normally update all info on the
10367 group and return you to the group buffer.
10374 @kindex Z Z (Summary)
10375 @kindex Z Q (Summary)
10376 @kindex q (Summary)
10377 @findex gnus-summary-exit
10378 @vindex gnus-summary-exit-hook
10379 @vindex gnus-summary-prepare-exit-hook
10380 @vindex gnus-group-no-more-groups-hook
10381 @c @icon{gnus-summary-exit}
10382 Exit the current group and update all information on the group
10383 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
10384 called before doing much of the exiting, which calls
10385 @code{gnus-summary-expire-articles} by default.
10386 @code{gnus-summary-exit-hook} is called after finishing the exit
10387 process. @code{gnus-group-no-more-groups-hook} is run when returning to
10388 group mode having no more (unread) groups.
10392 @kindex Z E (Summary)
10393 @kindex Q (Summary)
10394 @findex gnus-summary-exit-no-update
10395 Exit the current group without updating any information on the group
10396 (@code{gnus-summary-exit-no-update}).
10400 @kindex Z c (Summary)
10401 @kindex c (Summary)
10402 @findex gnus-summary-catchup-and-exit
10403 @c @icon{gnus-summary-catchup-and-exit}
10404 Mark all unticked articles in the group as read and then exit
10405 (@code{gnus-summary-catchup-and-exit}).
10408 @kindex Z C (Summary)
10409 @findex gnus-summary-catchup-all-and-exit
10410 Mark all articles, even the ticked ones, as read and then exit
10411 (@code{gnus-summary-catchup-all-and-exit}).
10414 @kindex Z n (Summary)
10415 @findex gnus-summary-catchup-and-goto-next-group
10416 Mark all articles as read and go to the next group
10417 (@code{gnus-summary-catchup-and-goto-next-group}).
10421 @kindex Z R (Summary)
10422 @kindex C-x C-s (Summary)
10423 @findex gnus-summary-reselect-current-group
10424 Exit this group, and then enter it again
10425 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
10426 all articles, both read and unread.
10430 @kindex Z G (Summary)
10431 @kindex M-g (Summary)
10432 @findex gnus-summary-rescan-group
10433 @c @icon{gnus-summary-mail-get}
10434 Exit the group, check for new articles in the group, and select the
10435 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
10436 articles, both read and unread.
10439 @kindex Z N (Summary)
10440 @findex gnus-summary-next-group
10441 Exit the group and go to the next group
10442 (@code{gnus-summary-next-group}).
10445 @kindex Z P (Summary)
10446 @findex gnus-summary-prev-group
10447 Exit the group and go to the previous group
10448 (@code{gnus-summary-prev-group}).
10451 @kindex Z s (Summary)
10452 @findex gnus-summary-save-newsrc
10453 Save the current number of read/marked articles in the dribble buffer
10454 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
10455 given a prefix, also save the @file{.newsrc} file(s). Using this
10456 command will make exit without updating (the @kbd{Q} command) worthless.
10459 @vindex gnus-exit-group-hook
10460 @code{gnus-exit-group-hook} is called when you exit the current group
10461 with an ``updating'' exit. For instance @kbd{Q}
10462 (@code{gnus-summary-exit-no-update}) does not call this hook.
10464 @findex gnus-summary-wake-up-the-dead
10465 @findex gnus-dead-summary-mode
10466 @vindex gnus-kill-summary-on-exit
10467 If you're in the habit of exiting groups, and then changing your mind
10468 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
10469 If you do that, gnus won't kill the summary buffer when you exit it.
10470 (Quelle surprise!) Instead it will change the name of the buffer to
10471 something like @samp{*Dead Summary ... *} and install a minor mode
10472 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
10473 buffer, you'll find that all keys are mapped to a function called
10474 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
10475 summary buffer will result in a live, normal summary buffer.
10477 There will never be more than one dead summary buffer at any one time.
10479 @vindex gnus-use-cross-reference
10480 The data on the current group will be updated (which articles you have
10481 read, which articles you have replied to, etc.) when you exit the
10482 summary buffer. If the @code{gnus-use-cross-reference} variable is
10483 @code{t} (which is the default), articles that are cross-referenced to
10484 this group and are marked as read, will also be marked as read in the
10485 other subscribed groups they were cross-posted to. If this variable is
10486 neither @code{nil} nor @code{t}, the article will be marked as read in
10487 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
10490 @node Crosspost Handling
10491 @section Crosspost Handling
10495 Marking cross-posted articles as read ensures that you'll never have to
10496 read the same article more than once. Unless, of course, somebody has
10497 posted it to several groups separately. Posting the same article to
10498 several groups (not cross-posting) is called @dfn{spamming}, and you are
10499 by law required to send nasty-grams to anyone who perpetrates such a
10500 heinous crime. You may want to try NoCeM handling to filter out spam
10503 Remember: Cross-posting is kinda ok, but posting the same article
10504 separately to several groups is not. Massive cross-posting (aka.
10505 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
10506 @code{gnus-summary-mail-crosspost-complaint} command to complain about
10507 excessive crossposting (@pxref{Summary Mail Commands}).
10509 @cindex cross-posting
10511 @cindex @acronym{NOV}
10512 One thing that may cause Gnus to not do the cross-posting thing
10513 correctly is if you use an @acronym{NNTP} server that supports @sc{xover}
10514 (which is very nice, because it speeds things up considerably) which
10515 does not include the @code{Xref} header in its @acronym{NOV} lines. This is
10516 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
10517 even with @sc{xover} by registering the @code{Xref} lines of all
10518 articles you actually read, but if you kill the articles, or just mark
10519 them as read without reading them, Gnus will not get a chance to snoop
10520 the @code{Xref} lines out of these articles, and will be unable to use
10521 the cross reference mechanism.
10523 @cindex LIST overview.fmt
10524 @cindex overview.fmt
10525 To check whether your @acronym{NNTP} server includes the @code{Xref} header
10526 in its overview files, try @samp{telnet your.nntp.server nntp},
10527 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
10528 overview.fmt}. This may not work, but if it does, and the last line you
10529 get does not read @samp{Xref:full}, then you should shout and whine at
10530 your news admin until she includes the @code{Xref} header in the
10533 @vindex gnus-nov-is-evil
10534 If you want Gnus to get the @code{Xref}s right all the time, you have to
10535 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
10540 For an alternative approach, @pxref{Duplicate Suppression}.
10543 @node Duplicate Suppression
10544 @section Duplicate Suppression
10546 By default, gnus tries to make sure that you don't have to read the same
10547 article more than once by utilizing the crossposting mechanism
10548 (@pxref{Crosspost Handling}). However, that simple and efficient
10549 approach may not work satisfactory for some users for various
10554 The @acronym{NNTP} server may fail to generate the @code{Xref} header. This
10555 is evil and not very common.
10558 The @acronym{NNTP} server may fail to include the @code{Xref} header in the
10559 @file{.overview} data bases. This is evil and all too common, alas.
10562 You may be reading the same group (or several related groups) from
10563 different @acronym{NNTP} servers.
10566 You may be getting mail that duplicates articles posted to groups.
10569 I'm sure there are other situations where @code{Xref} handling fails as
10570 well, but these four are the most common situations.
10572 If, and only if, @code{Xref} handling fails for you, then you may
10573 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
10574 will remember the @code{Message-ID}s of all articles you have read or
10575 otherwise marked as read, and then, as if by magic, mark them as read
10576 all subsequent times you see them---in @emph{all} groups. Using this
10577 mechanism is quite likely to be somewhat inefficient, but not overly
10578 so. It's certainly preferable to reading the same articles more than
10581 Duplicate suppression is not a very subtle instrument. It's more like a
10582 sledge hammer than anything else. It works in a very simple
10583 fashion---if you have marked an article as read, it adds this Message-ID
10584 to a cache. The next time it sees this Message-ID, it will mark the
10585 article as read with the @samp{M} mark. It doesn't care what group it
10586 saw the article in.
10589 @item gnus-suppress-duplicates
10590 @vindex gnus-suppress-duplicates
10591 If non-@code{nil}, suppress duplicates.
10593 @item gnus-save-duplicate-list
10594 @vindex gnus-save-duplicate-list
10595 If non-@code{nil}, save the list of duplicates to a file. This will
10596 make startup and shutdown take longer, so the default is @code{nil}.
10597 However, this means that only duplicate articles read in a single gnus
10598 session are suppressed.
10600 @item gnus-duplicate-list-length
10601 @vindex gnus-duplicate-list-length
10602 This variable says how many @code{Message-ID}s to keep in the duplicate
10603 suppression list. The default is 10000.
10605 @item gnus-duplicate-file
10606 @vindex gnus-duplicate-file
10607 The name of the file to store the duplicate suppression list in. The
10608 default is @file{~/News/suppression}.
10611 If you have a tendency to stop and start gnus often, setting
10612 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
10613 you leave gnus running for weeks on end, you may have it @code{nil}. On
10614 the other hand, saving the list makes startup and shutdown much slower,
10615 so that means that if you stop and start gnus often, you should set
10616 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
10617 to you to figure out, I think.
10622 Gnus is able to verify signed messages or decrypt encrypted messages.
10623 The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME}
10624 and @acronym{S/MIME}, however you need some external programs to get
10629 To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to
10630 install an OpenPGP implementation such as GnuPG. The Lisp interface
10631 to GnuPG included with Gnus is called PGG (@pxref{Top, ,PGG, pgg, PGG
10632 Manual}), but Mailcrypt and gpg.el are also supported.
10635 To handle @acronym{S/MIME} message, you need to install OpenSSL. OpenSSL 0.9.6
10636 or newer is recommended.
10640 More information on how to set things up can be found in the message
10641 manual (@pxref{Security, ,Security, message, Message Manual}).
10644 @item mm-verify-option
10645 @vindex mm-verify-option
10646 Option of verifying signed parts. @code{never}, not verify;
10647 @code{always}, always verify; @code{known}, only verify known
10648 protocols. Otherwise, ask user.
10650 @item mm-decrypt-option
10651 @vindex mm-decrypt-option
10652 Option of decrypting encrypted parts. @code{never}, no decryption;
10653 @code{always}, always decrypt; @code{known}, only decrypt known
10654 protocols. Otherwise, ask user.
10657 @vindex mml1991-use
10658 Symbol indicating elisp interface to OpenPGP implementation for
10659 @acronym{PGP} messages. The default is @code{pgg}, but
10660 @code{mailcrypt} and @code{gpg} are also supported although
10664 @vindex mml2015-use
10665 Symbol indicating elisp interface to OpenPGP implementation for
10666 @acronym{PGP/MIME} messages. The default is @code{pgg}, but
10667 @code{mailcrypt} and @code{gpg} are also supported although
10672 @cindex snarfing keys
10673 @cindex importing PGP keys
10674 @cindex PGP key ring import
10675 Snarfing OpenPGP keys (i.e., importing keys from articles into your
10676 key ring) is not supported explicitly through a menu item or command,
10677 rather Gnus do detect and label keys as @samp{application/pgp-keys},
10678 allowing you to specify whatever action you think is appropriate
10679 through the usual @acronym{MIME} infrastructure. You can use a
10680 @file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The
10681 Emacs MIME Manual}) such as the following to import keys using GNU
10682 Privacy Guard when you click on the @acronym{MIME} button
10683 (@pxref{Using MIME}).
10686 application/pgp-keys; gpg --import --interactive --verbose; needsterminal
10689 This happens to also be the default action defined in
10690 @code{mailcap-mime-data}.
10693 @section Mailing List
10694 @cindex mailing list
10697 @kindex A M (summary)
10698 @findex gnus-mailing-list-insinuate
10699 Gnus understands some mailing list fields of RFC 2369. To enable it,
10700 add a @code{to-list} group parameter (@pxref{Group Parameters}),
10701 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
10704 That enables the following commands to the summary buffer:
10709 @kindex C-c C-n h (Summary)
10710 @findex gnus-mailing-list-help
10711 Send a message to fetch mailing list help, if List-Help field exists.
10714 @kindex C-c C-n s (Summary)
10715 @findex gnus-mailing-list-subscribe
10716 Send a message to subscribe the mailing list, if List-Subscribe field exists.
10719 @kindex C-c C-n u (Summary)
10720 @findex gnus-mailing-list-unsubscribe
10721 Send a message to unsubscribe the mailing list, if List-Unsubscribe
10725 @kindex C-c C-n p (Summary)
10726 @findex gnus-mailing-list-post
10727 Post to the mailing list, if List-Post field exists.
10730 @kindex C-c C-n o (Summary)
10731 @findex gnus-mailing-list-owner
10732 Send a message to the mailing list owner, if List-Owner field exists.
10735 @kindex C-c C-n a (Summary)
10736 @findex gnus-mailing-list-owner
10737 Browse the mailing list archive, if List-Archive field exists.
10742 @node Article Buffer
10743 @chapter Article Buffer
10744 @cindex article buffer
10746 The articles are displayed in the article buffer, of which there is only
10747 one. All the summary buffers share the same article buffer unless you
10748 tell gnus otherwise.
10751 * Hiding Headers:: Deciding what headers should be displayed.
10752 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
10753 * Customizing Articles:: Tailoring the look of the articles.
10754 * Article Keymap:: Keystrokes available in the article buffer.
10755 * Misc Article:: Other stuff.
10759 @node Hiding Headers
10760 @section Hiding Headers
10761 @cindex hiding headers
10762 @cindex deleting headers
10764 The top section of each article is the @dfn{head}. (The rest is the
10765 @dfn{body}, but you may have guessed that already.)
10767 @vindex gnus-show-all-headers
10768 There is a lot of useful information in the head: the name of the person
10769 who wrote the article, the date it was written and the subject of the
10770 article. That's well and nice, but there's also lots of information
10771 most people do not want to see---what systems the article has passed
10772 through before reaching you, the @code{Message-ID}, the
10773 @code{References}, etc. ad nauseam---and you'll probably want to get rid
10774 of some of those lines. If you want to keep all those lines in the
10775 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
10777 Gnus provides you with two variables for sifting headers:
10781 @item gnus-visible-headers
10782 @vindex gnus-visible-headers
10783 If this variable is non-@code{nil}, it should be a regular expression
10784 that says what headers you wish to keep in the article buffer. All
10785 headers that do not match this variable will be hidden.
10787 For instance, if you only want to see the name of the person who wrote
10788 the article and the subject, you'd say:
10791 (setq gnus-visible-headers "^From:\\|^Subject:")
10794 This variable can also be a list of regexps to match headers to
10797 @item gnus-ignored-headers
10798 @vindex gnus-ignored-headers
10799 This variable is the reverse of @code{gnus-visible-headers}. If this
10800 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
10801 should be a regular expression that matches all lines that you want to
10802 hide. All lines that do not match this variable will remain visible.
10804 For instance, if you just want to get rid of the @code{References} field
10805 and the @code{Xref} field, you might say:
10808 (setq gnus-ignored-headers "^References:\\|^Xref:")
10811 This variable can also be a list of regexps to match headers to
10814 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
10815 variable will have no effect.
10819 @vindex gnus-sorted-header-list
10820 Gnus can also sort the headers for you. (It does this by default.) You
10821 can control the sorting by setting the @code{gnus-sorted-header-list}
10822 variable. It is a list of regular expressions that says in what order
10823 the headers are to be displayed.
10825 For instance, if you want the name of the author of the article first,
10826 and then the subject, you might say something like:
10829 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
10832 Any headers that are to remain visible, but are not listed in this
10833 variable, will be displayed in random order after all the headers listed in this variable.
10835 @findex gnus-article-hide-boring-headers
10836 @vindex gnus-boring-article-headers
10837 You can hide further boring headers by setting
10838 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
10839 does depends on the @code{gnus-boring-article-headers} variable. It's a
10840 list, but this list doesn't actually contain header names. Instead it
10841 lists various @dfn{boring conditions} that Gnus can check and remove
10844 These conditions are:
10847 Remove all empty headers.
10849 Remove the @code{Followup-To} header if it is identical to the
10850 @code{Newsgroups} header.
10852 Remove the @code{Reply-To} header if it lists the same addresses as
10853 the @code{From} header, or if the @code{broken-reply-to} group
10856 Remove the @code{Newsgroups} header if it only contains the current group
10859 Remove the @code{To} header if it only contains the address identical to
10860 the current group's @code{to-address} parameter.
10862 Remove the @code{To} header if it only contains the address identical to
10863 the current group's @code{to-list} parameter.
10865 Remove the @code{CC} header if it only contains the address identical to
10866 the current group's @code{to-list} parameter.
10868 Remove the @code{Date} header if the article is less than three days
10871 Remove the @code{To} header if it is very long.
10873 Remove all @code{To} headers if there are more than one.
10876 To include these three elements, you could say something like:
10879 (setq gnus-boring-article-headers
10880 '(empty followup-to reply-to))
10883 This is also the default value for this variable.
10887 @section Using MIME
10888 @cindex @acronym{MIME}
10890 Mime is a standard for waving your hands through the air, aimlessly,
10891 while people stand around yawning.
10893 @acronym{MIME}, however, is a standard for encoding your articles, aimlessly,
10894 while all newsreaders die of fear.
10896 @acronym{MIME} may specify what character set the article uses, the encoding
10897 of the characters, and it also makes it possible to embed pictures and
10898 other naughty stuff in innocent-looking articles.
10900 @vindex gnus-show-mime
10901 @vindex gnus-article-display-method-for-mime
10902 @findex gnus-article-display-mime-message
10903 gnus handles @acronym{MIME} by pushing the articles through
10904 @code{gnus-article-display-method-for-mime}, which is
10905 @code{gnus-article-display-mime-message} by default. This function
10906 calls the @acronym{SEMI} MIME-View program to actually do the work. For
10907 more information on @acronym{SEMI} MIME-View, see its manual page
10908 (however it is not existed yet, sorry).
10910 Set @code{gnus-show-mime} to @code{t} if you want to use
10911 @acronym{MIME} all the time. If you have @code{gnus-show-mime} set,
10912 then you'll see some unfortunate display glitches in the article buffer.
10913 These can't be avoided.
10915 In GNUS or Gnus, it might be best to just use the toggling functions
10916 from the summary buffer to avoid getting nasty surprises. (For instance,
10917 you enter the group @samp{alt.sing-a-long} and, before you know it,
10918 @acronym{MIME} has decoded the sound file in the article and some
10919 horrible sing-a-long song comes screaming out your speakers, and you
10920 can't find the volume button, because there isn't one, and people are
10921 starting to look at you, and you try to stop the program, but you can't,
10922 and you can't find the program to control the volume, and everybody else
10923 in the room suddenly decides to look at you disdainfully, and you'll
10924 feel rather stupid.)
10926 Any similarity to real events and people is purely coincidental. Ahem.
10928 To avoid such kind of situation, gnus stops to use
10929 @code{metamail-buffer}. So now, you can set @code{gnus-show-mime} to
10930 non-@code{nil} every-time, then you can push button in the article
10931 buffer when there are nobody else.
10933 Also @pxref{MIME Commands}.
10936 @node Customizing Articles
10937 @section Customizing Articles
10938 @cindex article customization
10940 A slew of functions for customizing how the articles are to look like
10941 exist. You can call these functions interactively
10942 (@pxref{Article Washing}), or you can have them
10943 called automatically when you select the articles.
10945 To have them called automatically, you should set the corresponding
10946 ``treatment'' variable. For instance, to have headers hidden, you'd set
10947 @code{gnus-treat-hide-headers}. Below is a list of variables that can
10948 be set, but first we discuss the values these variables can have.
10950 Note: Some values, while valid, make little sense. Check the list below
10951 for sensible values.
10955 @code{nil}: Don't do this treatment.
10958 @code{t}: Do this treatment on all body parts.
10961 @code{head}: Do the treatment on the headers.
10964 @code{last}: Do this treatment on the last part.
10967 An integer: Do this treatment on all body parts that have a length less
10971 A list of strings: Do this treatment on all body parts that are in
10972 articles that are read in groups that have names that match one of the
10973 regexps in the list.
10976 A list where the first element is not a string:
10978 The list is evaluated recursively. The first element of the list is a
10979 predicate. The following predicates are recognized: @code{or},
10980 @code{and}, @code{not} and @code{typep}. Here's an example:
10984 (typep "text/x-vcard"))
10988 @code{mime}: Do this treatment if the value of @code{gnus-show-mime}' is
10993 You may have noticed that the word @dfn{part} is used here. This refers
10994 to the fact that some messages are @acronym{MIME} multipart articles that may
10995 be divided into several parts. Articles that are not multiparts are
10996 considered to contain just a single part.
10998 @vindex gnus-article-treat-types
10999 Are the treatments applied to all sorts of multipart parts? Yes, if you
11000 want to, but by default, only @samp{text/plain} parts are given the
11001 treatment. This is controlled by the @code{gnus-article-treat-types}
11002 variable, which is a list of regular expressions that are matched to the
11003 type of the part. This variable is ignored if the value of the
11004 controlling variable is a predicate list, as described above.
11006 The following treatment options are available. The easiest way to
11007 customize this is to examine the @code{gnus-article-treat} customization
11008 group. Values in parenthesis are suggested sensible values. Others are
11009 possible but those listed are probably sufficient for most people.
11012 @item gnus-treat-buttonize (t, integer)
11013 @item gnus-treat-buttonize-head (head)
11015 @xref{Article Buttons}.
11017 @item gnus-treat-capitalize-sentences (t, integer)
11018 @item gnus-treat-overstrike (t, integer)
11019 @item gnus-treat-strip-cr (t, integer)
11020 @item gnus-treat-strip-headers-in-body (t, integer)
11021 @item gnus-treat-strip-leading-blank-lines (t, integer)
11022 @item gnus-treat-strip-multiple-blank-lines (t, integer)
11023 @item gnus-treat-strip-pem (t, last, integer)
11024 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
11025 @item gnus-treat-unsplit-urls (t, integer)
11026 @item gnus-treat-wash-html (t, integer)
11027 @item gnus-treat-decode-article-as-default-mime-charset (t, integer)
11029 @xref{Article Washing}.
11031 @item gnus-treat-date-english (head)
11032 @item gnus-treat-date-iso8601 (head)
11033 @item gnus-treat-date-lapsed (head)
11034 @item gnus-treat-date-local (head)
11035 @item gnus-treat-date-original (head)
11036 @item gnus-treat-date-user-defined (head)
11037 @item gnus-treat-date-ut (head)
11039 @xref{Article Date}.
11041 @item gnus-treat-from-picon (head)
11042 @item gnus-treat-mail-picon (head)
11043 @item gnus-treat-newsgroups-picon (head)
11047 @item gnus-treat-display-smileys (t, integer)
11049 @item gnus-treat-body-boundary (head)
11051 @vindex gnus-body-boundary-delimiter
11052 Adds a delimiter between header and body, the string used as delimiter
11053 is controlled by @code{gnus-body-boundary-delimiter}.
11057 @item gnus-treat-display-x-face (head)
11061 @item gnus-treat-display-face (head)
11065 @item gnus-treat-emphasize (t, head, integer)
11066 @item gnus-treat-fill-article (t, integer)
11067 @item gnus-treat-fill-long-lines (t, integer)
11068 @item gnus-treat-hide-boring-headers (head)
11069 @item gnus-treat-hide-citation (t, integer)
11070 @item gnus-treat-hide-citation-maybe (t, integer)
11071 @item gnus-treat-hide-headers (head)
11072 @item gnus-treat-hide-signature (t, last)
11073 @item gnus-treat-strip-banner (t, last)
11074 @item gnus-treat-strip-list-identifiers (head)
11076 @xref{Article Hiding}.
11078 @item gnus-treat-highlight-citation (t, integer)
11079 @item gnus-treat-highlight-headers (head)
11080 @item gnus-treat-highlight-signature (t, last, integer)
11082 @xref{Article Highlighting}.
11084 @item gnus-treat-play-sounds
11085 @item gnus-treat-translate
11086 @item gnus-treat-x-pgp-sig (head)
11088 @item gnus-treat-unfold-headers (head)
11089 @item gnus-treat-fold-headers (head)
11090 @item gnus-treat-fold-newsgroups (head)
11091 @item gnus-treat-leading-whitespace (head)
11093 @xref{Article Header}.
11098 @vindex gnus-part-display-hook
11099 You can, of course, write your own functions to be called from
11100 @code{gnus-part-display-hook}. The functions are called narrowed to the
11101 part, and you can do anything you like, pretty much. There is no
11102 information that you have to keep in the buffer---you can change
11106 @node Article Keymap
11107 @section Article Keymap
11109 Most of the keystrokes in the summary buffer can also be used in the
11110 article buffer. They should behave as if you typed them in the summary
11111 buffer, which means that you don't actually have to have a summary
11112 buffer displayed while reading. You can do it all from the article
11115 A few additional keystrokes are available:
11120 @kindex SPACE (Article)
11121 @findex gnus-article-next-page
11122 Scroll forwards one page (@code{gnus-article-next-page}).
11123 This is exactly the same as @kbd{h SPACE h}.
11126 @kindex DEL (Article)
11127 @findex gnus-article-prev-page
11128 Scroll backwards one page (@code{gnus-article-prev-page}).
11129 This is exactly the same as @kbd{h DEL h}.
11132 @kindex C-c ^ (Article)
11133 @findex gnus-article-refer-article
11134 If point is in the neighborhood of a @code{Message-ID} and you press
11135 @kbd{C-c ^}, Gnus will try to get that article from the server
11136 (@code{gnus-article-refer-article}).
11139 @kindex C-c C-m (Article)
11140 @findex gnus-article-mail
11141 Send a reply to the address near point (@code{gnus-article-mail}). If
11142 given a prefix, include the mail.
11145 @kindex s (Article)
11146 @findex gnus-article-show-summary
11147 Reconfigure the buffers so that the summary buffer becomes visible
11148 (@code{gnus-article-show-summary}).
11151 @kindex ? (Article)
11152 @findex gnus-article-describe-briefly
11153 Give a very brief description of the available keystrokes
11154 (@code{gnus-article-describe-briefly}).
11157 @kindex TAB (Article)
11158 @findex gnus-article-next-button
11159 Go to the next button, if any (@code{gnus-article-next-button}). This
11160 only makes sense if you have buttonizing turned on.
11163 @kindex M-TAB (Article)
11164 @findex gnus-article-prev-button
11165 Go to the previous button, if any (@code{gnus-article-prev-button}).
11168 @kindex R (Article)
11169 @findex gnus-article-reply-with-original
11170 Send a reply to the current article and yank the current article
11171 (@code{gnus-article-reply-with-original}). If given a prefix, make a
11172 wide reply. If the region is active, only yank the text in the
11176 @kindex F (Article)
11177 @findex gnus-article-followup-with-original
11178 Send a followup to the current article and yank the current article
11179 (@code{gnus-article-followup-with-original}). If given a prefix, make
11180 a wide reply. If the region is active, only yank the text in the
11188 @section Misc Article
11192 @item gnus-single-article-buffer
11193 @vindex gnus-single-article-buffer
11194 If non-@code{nil}, use the same article buffer for all the groups.
11195 (This is the default.) If @code{nil}, each group will have its own
11198 @vindex gnus-article-decode-hook
11199 @item gnus-article-decode-hook
11200 @cindex @acronym{MIME}
11201 Hook used to decode @acronym{MIME} articles. The default value is
11202 @code{(article-decode-charset article-decode-encoded-words)}
11204 @vindex gnus-article-prepare-hook
11205 @item gnus-article-prepare-hook
11206 This hook is called right after the article has been inserted into the
11207 article buffer. It is mainly intended for functions that do something
11208 depending on the contents; it should probably not be used for changing
11209 the contents of the article buffer.
11211 @item gnus-article-mode-hook
11212 @vindex gnus-article-mode-hook
11213 Hook called in article mode buffers.
11215 @item gnus-article-mode-syntax-table
11216 @vindex gnus-article-mode-syntax-table
11217 Syntax table used in article buffers. It is initialized from
11218 @code{text-mode-syntax-table}.
11220 @vindex gnus-article-over-scroll
11221 @item gnus-article-over-scroll
11222 If non-@code{nil}, allow scrolling the article buffer even when there
11223 no more new text to scroll in. The default is @code{nil}.
11225 @vindex gnus-article-mode-line-format
11226 @item gnus-article-mode-line-format
11227 This variable is a format string along the same lines as
11228 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}). It
11229 accepts the same format specifications as that variable, with two
11235 The @dfn{wash status} of the article. This is a short string with one
11236 character for each possible article wash operation that may have been
11237 performed. The characters and their meaning:
11242 Displayed when cited text may be hidden in the article buffer.
11245 Displayed when headers are hidden in the article buffer.
11248 Displayed when article is digitally signed or encrypted, and Gnus has
11249 hidden the security headers. (N.B. does not tell anything about
11250 security status, i.e. good or bad signature.)
11253 Displayed when the signature has been hidden in the Article buffer.
11256 Displayed when Gnus has treated overstrike characters in the article buffer.
11259 Displayed when Gnus has treated emphasised strings in the article buffer.
11264 The number of @acronym{MIME} parts in the article.
11268 @vindex gnus-break-pages
11270 @item gnus-break-pages
11271 Controls whether @dfn{page breaking} is to take place. If this variable
11272 is non-@code{nil}, the articles will be divided into pages whenever a
11273 page delimiter appears in the article. If this variable is @code{nil},
11274 paging will not be done.
11276 @item gnus-page-delimiter
11277 @vindex gnus-page-delimiter
11278 This is the delimiter mentioned above. By default, it is @samp{^L}
11282 @cindex internationalized domain names
11283 @vindex gnus-use-idna
11284 @item gnus-use-idna
11285 This variable controls whether Gnus performs IDNA decoding of
11286 internationalized domain names inside @samp{From}, @samp{To} and
11287 @samp{Cc} headers. This requires
11288 @uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this
11289 variable is only enabled if you have installed it.
11294 @node Composing Messages
11295 @chapter Composing Messages
11296 @cindex composing messages
11299 @cindex sending mail
11304 @cindex using s/mime
11305 @cindex using smime
11307 @kindex C-c C-c (Post)
11308 All commands for posting and mailing will put you in a message buffer
11309 where you can edit the article all you like, before you send the
11310 article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message,
11311 Message Manual}. Where the message will be posted/mailed to depends
11312 on your setup (@pxref{Posting Server}).
11315 * Mail:: Mailing and replying.
11316 * Posting Server:: What server should you post and mail via?
11317 * POP before SMTP:: You cannot send a mail unless you read a mail.
11318 * Mail and Post:: Mailing and posting at the same time.
11319 * Archived Messages:: Where Gnus stores the messages you've sent.
11320 * Posting Styles:: An easier way to specify who you are.
11321 * Drafts:: Postponing messages and rejected messages.
11322 * Rejected Articles:: What happens if the server doesn't like your article?
11323 * Signing and encrypting:: How to compose secure messages.
11326 Also @pxref{Canceling and Superseding} for information on how to
11327 remove articles you shouldn't have posted.
11333 Variables for customizing outgoing mail:
11336 @item gnus-uu-digest-headers
11337 @vindex gnus-uu-digest-headers
11338 List of regexps to match headers included in digested messages. The
11339 headers will be included in the sequence they are matched. If
11340 @code{nil} include all headers.
11342 @item gnus-add-to-list
11343 @vindex gnus-add-to-list
11344 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
11345 that have none when you do a @kbd{a}.
11347 @item gnus-confirm-mail-reply-to-news
11348 @vindex gnus-confirm-mail-reply-to-news
11349 This can also be a function receiving the group name as the only
11350 parameter which should return non-@code{nil} if a confirmation is
11351 needed, or a regular expression matching group names, where
11352 confirmation is should be asked for.
11354 If you find yourself never wanting to reply to mail, but occasionally
11355 press R anyway, this variable might be for you.
11357 @item gnus-confirm-treat-mail-like-news
11358 @vindex gnus-confirm-treat-mail-like-news
11359 If non-@code{nil}, Gnus also requests confirmation according to
11360 @code{gnus-confirm-mail-reply-to-news} when replying to mail. This is
11361 useful for treating mailing lists like newsgroups.
11366 @node Posting Server
11367 @section Posting Server
11369 When you press those magical @kbd{C-c C-c} keys to ship off your latest
11370 (extremely intelligent, of course) article, where does it go?
11372 Thank you for asking. I hate you.
11374 It can be quite complicated.
11376 @vindex gnus-post-method
11377 When posting news, Message usually invokes @code{message-send-news}
11378 (@pxref{News Variables, , News Variables, message, Message Manual}).
11379 Normally, Gnus will post using the same select method as you're
11380 reading from (which might be convenient if you're reading lots of
11381 groups from different private servers). However. If the server
11382 you're reading from doesn't allow posting, just reading, you probably
11383 want to use some other server to post your (extremely intelligent and
11384 fabulously interesting) articles. You can then set the
11385 @code{gnus-post-method} to some other method:
11388 (setq gnus-post-method '(nnspool ""))
11391 Now, if you've done this, and then this server rejects your article, or
11392 this server is down, what do you do then? To override this variable you
11393 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
11394 the ``current'' server, to get back the default behavior, for posting.
11396 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
11397 gnus will prompt you for what method to use for posting.
11399 You can also set @code{gnus-post-method} to a list of select methods.
11400 If that's the case, gnus will always prompt you for what method to use
11403 Finally, if you want to always post using the native select method,
11404 you can set this variable to @code{native}.
11406 When sending mail, Message invokes @code{message-send-mail-function}.
11407 The default function, @code{message-send-mail-with-sendmail}, pipes
11408 your article to the @code{sendmail} binary for further queuing and
11409 sending. When your local system is not configured for sending mail
11410 using @code{sendmail}, and you have access to a remote @acronym{SMTP}
11411 server, you can set @code{message-send-mail-function} to
11412 @code{smtpmail-send-it} and make sure to setup the @code{smtpmail}
11413 package correctly. An example:
11416 (setq message-send-mail-function 'smtpmail-send-it
11417 smtpmail-default-smtp-server "YOUR SMTP HOST")
11418 ;; The following variable needs to be set because of the FLIM version of
11419 ;; smtpmail.el. Which smtpmail.el is used depends on the `load-path'.
11420 (setq smtp-default-smtp-server "YOUR SMTP HOST")
11423 To the thing similar to this, there is
11424 @code{message-smtpmail-send-it}. It is useful if your @acronym{ISP}
11425 requires the @acronym{POP}-before-@acronym{SMTP} authentication.
11426 @xref{POP before SMTP}.
11428 Other possible choices for @code{message-send-mail-function} includes
11429 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
11430 and @code{feedmail-send-it}.
11432 @node POP before SMTP
11433 @section POP before SMTP
11434 @cindex pop before smtp
11435 @findex message-smtpmail-send-it
11436 @findex mail-source-touch-pop
11438 Does your @acronym{ISP} require the @acronym{POP}-before-@acronym{SMTP}
11439 authentication? It is whether you need to connect to the @acronym{POP}
11440 mail server within a certain time before sending mails. If so, there is
11441 a convenient way. To do that, put the following lines in your
11442 @file{~/.gnus.el} file:
11445 (setq message-send-mail-function 'message-smtpmail-send-it)
11446 (add-hook 'message-send-mail-hook 'mail-source-touch-pop)
11450 It means to let Gnus connect to the @acronym{POP} mail server in advance
11451 whenever you send a mail. The @code{mail-source-touch-pop} function
11452 does only a @acronym{POP} authentication according to the value of
11453 @code{mail-sources} without fetching mails, just before sending a mail.
11454 Note that you have to use @code{message-smtpmail-send-it} which runs
11455 @code{message-send-mail-hook} rather than @code{smtpmail-send-it} and
11456 set the value of @code{mail-sources} for a @acronym{POP} connection
11457 (@pxref{Mail Sources}) correctly.
11459 @node Mail and Post
11460 @section Mail and Post
11462 Here's a list of variables relevant to both mailing and
11466 @item gnus-mailing-list-groups
11467 @findex gnus-mailing-list-groups
11468 @cindex mailing lists
11470 If your news server offers groups that are really mailing lists
11471 gatewayed to the @acronym{NNTP} server, you can read those groups without
11472 problems, but you can't post/followup to them without some difficulty.
11473 One solution is to add a @code{to-address} to the group parameters
11474 (@pxref{Group Parameters}). An easier thing to do is set the
11475 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
11476 really are mailing lists. Then, at least, followups to the mailing
11477 lists will work most of the time. Posting to these groups (@kbd{a}) is
11478 still a pain, though.
11480 @item gnus-user-agent
11481 @vindex gnus-user-agent
11484 This variable controls which information should be exposed in the
11485 User-Agent header. It can be one of the symbols @code{gnus} (show only
11486 Gnus version), @code{emacs-gnus} (show only Emacs and Gnus versions),
11487 @code{emacs-gnus-config} (same as @code{emacs-gnus} plus system
11488 configuration), @code{emacs-gnus-type} (same as @code{emacs-gnus} plus
11489 system type) or a custom string. If you set it to a string, be sure to
11490 use a valid format, see RFC 2616.
11494 You may want to do spell-checking on messages that you send out. Or, if
11495 you don't want to spell-check by hand, you could add automatic
11496 spell-checking via the @code{ispell} package:
11499 @findex ispell-message
11501 (add-hook 'message-send-hook 'ispell-message)
11504 If you want to change the @code{ispell} dictionary based on what group
11505 you're in, you could say something like the following:
11508 (add-hook 'gnus-select-group-hook
11512 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
11513 (ispell-change-dictionary "deutsch"))
11515 (ispell-change-dictionary "english")))))
11518 Modify to suit your needs.
11521 @node Archived Messages
11522 @section Archived Messages
11523 @cindex archived messages
11524 @cindex sent messages
11526 Gnus provides a few different methods for storing the mail and news you
11527 send. The default method is to use the @dfn{archive virtual server} to
11528 store the messages. If you want to disable this completely, the
11529 @code{gnus-message-archive-group} variable should be @code{nil}, which
11532 For archiving interesting messages in a group you read, see the
11533 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
11536 @vindex gnus-message-archive-method
11537 @code{gnus-message-archive-method} says what virtual server gnus is to
11538 use to store sent messages. The default is:
11541 (nnfolder "archive"
11542 (nnfolder-directory "~/Mail/archive")
11543 (nnfolder-active-file "~/Mail/archive/active")
11544 (nnfolder-get-new-mail nil)
11545 (nnfolder-inhibit-expiry t))
11548 You can, however, use any mail select method (@code{nnml},
11549 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
11550 for doing this sort of thing, though. If you don't like the default
11551 directory chosen, you could say something like:
11554 (setq gnus-message-archive-method
11555 '(nnfolder "archive"
11556 (nnfolder-inhibit-expiry t)
11557 (nnfolder-active-file "~/News/sent-mail/active")
11558 (nnfolder-directory "~/News/sent-mail/")))
11561 @vindex gnus-message-archive-group
11563 Gnus will insert @code{Gcc} headers in all outgoing messages that point
11564 to one or more group(s) on that server. Which group to use is
11565 determined by the @code{gnus-message-archive-group} variable.
11567 This variable can be used to do the following:
11571 Messages will be saved in that group.
11573 Note that you can include a select method in the group name, then the
11574 message will not be stored in the select method given by
11575 @code{gnus-message-archive-method}, but in the select method specified
11576 by the group name, instead. Suppose @code{gnus-message-archive-method}
11577 has the default value shown above. Then setting
11578 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
11579 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
11580 value @code{"nnml:foo"}, then outgoing messages will be stored in
11583 @item a list of strings
11584 Messages will be saved in all those groups.
11586 @item an alist of regexps, functions and forms
11587 When a key ``matches'', the result is used.
11590 No message archiving will take place. This is the default.
11595 Just saving to a single group called @samp{MisK}:
11597 (setq gnus-message-archive-group "MisK")
11600 Saving to two groups, @samp{MisK} and @samp{safe}:
11602 (setq gnus-message-archive-group '("MisK" "safe"))
11605 Save to different groups based on what group you are in:
11607 (setq gnus-message-archive-group
11608 '(("^alt" "sent-to-alt")
11609 ("mail" "sent-to-mail")
11610 (".*" "sent-to-misc")))
11613 More complex stuff:
11615 (setq gnus-message-archive-group
11616 '((if (message-news-p)
11621 How about storing all news messages in one file, but storing all mail
11622 messages in one file per month:
11625 (setq gnus-message-archive-group
11626 '((if (message-news-p)
11628 (concat "mail." (format-time-string "%Y-%m")))))
11631 @c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
11632 @c use a different value for @code{gnus-message-archive-group} there.)
11634 Now, when you send a message off, it will be stored in the appropriate
11635 group. (If you want to disable storing for just one particular message,
11636 you can just remove the @code{Gcc} header that has been inserted.) The
11637 archive group will appear in the group buffer the next time you start
11638 gnus, or the next time you press @kbd{F} in the group buffer. You can
11639 enter it and read the articles in it just like you'd read any other
11640 group. If the group gets really big and annoying, you can simply rename
11641 if (using @kbd{G r} in the group buffer) to something
11642 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
11643 continue to be stored in the old (now empty) group.
11645 That's the default method of archiving sent messages. Gnus offers a
11646 different way for the people who don't like the default method. In that
11647 case you should set @code{gnus-message-archive-group} to @code{nil};
11648 this will disable archiving.
11651 @item gnus-outgoing-message-group
11652 @vindex gnus-outgoing-message-group
11653 All outgoing messages will be put in this group. If you want to store
11654 all your outgoing mail and articles in the group @samp{nnml:archive},
11655 you set this variable to that value. This variable can also be a list of
11658 If you want to have greater control over what group to put each
11659 message in, you can set this variable to a function that checks the
11660 current newsgroup name and then returns a suitable group name (or list
11663 This variable can be used instead of @code{gnus-message-archive-group},
11664 but the latter is the preferred method.
11666 @item gnus-gcc-mark-as-read
11667 @vindex gnus-gcc-mark-as-read
11668 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
11670 @item gnus-gcc-externalize-attachments
11671 @vindex gnus-gcc-externalize-attachments
11672 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
11673 and matches the Gcc group name, attach files as external parts; if it is
11674 @code{all}, attach local files as external parts; if it is other
11675 non-@code{nil}, the behavior is the same as @code{all}, but it may be
11676 changed in the future.
11681 @node Posting Styles
11682 @section Posting Styles
11683 @cindex posting styles
11686 All them variables, they make my head swim.
11688 So what if you want a different @code{Organization} and signature based
11689 on what groups you post to? And you post both from your home machine
11690 and your work machine, and you want different @code{From} lines, and so
11693 @vindex gnus-posting-styles
11694 One way to do stuff like that is to write clever hooks that change the
11695 variables you need to have changed. That's a bit boring, so somebody
11696 came up with the bright idea of letting the user specify these things in
11697 a handy alist. Here's an example of a @code{gnus-posting-styles}
11702 (signature "Peace and happiness")
11703 (organization "What me?"))
11705 (signature "Death to everybody"))
11706 ("comp.emacs.i-love-it"
11707 (organization "Emacs is it")))
11710 As you might surmise from this example, this alist consists of several
11711 @dfn{styles}. Each style will be applicable if the first element
11712 ``matches'', in some form or other. The entire alist will be iterated
11713 over, from the beginning towards the end, and each match will be
11714 applied, which means that attributes in later styles that match override
11715 the same attributes in earlier matching styles. So
11716 @samp{comp.programming.literate} will have the @samp{Death to everybody}
11717 signature and the @samp{What me?} @code{Organization} header.
11719 The first element in each style is called the @code{match}. If it's a
11720 string, then Gnus will try to regexp match it against the group name.
11721 If it is the form @code{(header @var{match} @var{regexp})}, then Gnus
11722 will look in the original article for a header whose name is
11723 @var{match} and compare that @var{regexp}. @var{match} and
11724 @var{regexp} are strings. (The original article is the one you are
11725 replying or following up to. If you are not composing a reply or a
11726 followup, then there is nothing to match against.) If the
11727 @code{match} is a function symbol, that function will be called with
11728 no arguments. If it's a variable symbol, then the variable will be
11729 referenced. If it's a list, then that list will be @code{eval}ed. In
11730 any case, if this returns a non-@code{nil} value, then the style is
11731 said to @dfn{match}.
11733 Each style may contain an arbitrary amount of @dfn{attributes}. Each
11734 attribute consists of a @code{(@var{name} @var{value})} pair. The
11735 attribute name can be one of:
11738 @item @code{signature}
11739 @item @code{signature-file}
11740 @item @code{x-face-file}
11741 @item @code{address}, overriding @code{user-mail-address}
11742 @item @code{name}, overriding @code{(user-full-name)}
11746 The attribute name can also be a string or a symbol. In that case,
11747 this will be used as a header name, and the value will be inserted in
11748 the headers of the article; if the value is @code{nil}, the header
11749 name will be removed. If the attribute name is @code{eval}, the form
11750 is evaluated, and the result is thrown away.
11752 The attribute value can be a string (used verbatim), a function with
11753 zero arguments (the return value will be used), a variable (its value
11754 will be used) or a list (it will be @code{eval}ed and the return value
11755 will be used). The functions and sexps are called/@code{eval}ed in the
11756 message buffer that is being set up. The headers of the current article
11757 are available through the @code{message-reply-headers} variable, which
11758 is a vector of the following headers: number subject from date id
11759 references chars lines xref extra.
11761 @vindex message-reply-headers
11763 If you wish to check whether the message you are about to compose is
11764 meant to be a news article or a mail message, you can check the values
11765 of the @code{message-news-p} and @code{message-mail-p} functions.
11767 @findex message-mail-p
11768 @findex message-news-p
11770 So here's a new example:
11773 (setq gnus-posting-styles
11775 (signature-file "~/.signature")
11777 ("X-Home-Page" (getenv "WWW_HOME"))
11778 (organization "People's Front Against MWM"))
11780 (signature my-funny-signature-randomizer))
11781 ((equal (system-name) "gnarly") ;; @r{A form}
11782 (signature my-quote-randomizer))
11783 (message-news-p ;; @r{A function symbol}
11784 (signature my-news-signature))
11785 (window-system ;; @r{A value symbol}
11786 ("X-Window-System" (format "%s" window-system)))
11787 ;; @r{If I'm replying to Larsi, set the Organization header.}
11788 ((header "from" "larsi.*org")
11789 (Organization "Somewhere, Inc."))
11790 ((posting-from-work-p) ;; @r{A user defined function}
11791 (signature-file "~/.work-signature")
11792 (address "user@@bar.foo")
11793 (body "You are fired.\n\nSincerely, your boss.")
11794 (organization "Important Work, Inc"))
11796 (From (save-excursion
11797 (set-buffer gnus-article-buffer)
11798 (message-fetch-field "to"))))
11800 (signature-file "~/.mail-signature"))))
11803 The @samp{nnml:.*} rule means that you use the @code{To} address as the
11804 @code{From} address in all your outgoing replies, which might be handy
11805 if you fill many roles.
11807 Setting the @code{gnus-named-posting-styles} variable will make
11808 posting-styles allow to have distinctive names. You can specify an
11809 arbitrary posting-style when article posting with @kbd{S P} in the
11810 summary buffer. @code{gnus-named-posting-styles} is an alist which maps
11811 the names to styles. Once a posting-style is added to the alist, we can
11812 import it from @code{gnus-posting-styles}. If an attribute whose name
11813 is @code{import} is found, Gnus will look for the attribute value in
11814 @code{gnus-named-posting-styles} and expand it in place.
11819 (setq gnus-named-posting-styles
11821 (signature-file "~/.signature")
11823 ("X-Home-Page" (getenv "WWW_HOME"))
11824 (organization "People's Front Against MWM"))
11827 (organization "The Church of Emacs"))))
11830 The posting-style named "Emacs" will inherit all the attributes from
11831 "Default" except @code{organization}.
11838 If you are writing a message (mail or news) and suddenly remember that
11839 you have a steak in the oven (or some pesto in the food processor, you
11840 craaazy vegetarians), you'll probably wish there was a method to save
11841 the message you are writing so that you can continue editing it some
11842 other day, and send it when you feel its finished.
11844 Well, don't worry about it. Whenever you start composing a message of
11845 some sort using the gnus mail and post commands, the buffer you get will
11846 automatically associate to an article in a special @dfn{draft} group.
11847 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
11848 article will be saved there. (Auto-save files also go to the draft
11852 @vindex nndraft-directory
11853 The draft group is a special group (which is implemented as an
11854 @code{nndraft} group, if you absolutely have to know) called
11855 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
11856 @code{nndraft} is to store its files. What makes this group special is
11857 that you can't tick any articles in it or mark any articles as
11858 read---all articles in the group are permanently unread.
11860 If the group doesn't exist, it will be created and you'll be subscribed
11861 to it. The only way to make it disappear from the Group buffer is to
11862 unsubscribe it. The special properties of the draft group comes from
11863 a group property (@pxref{Group Parameters}), and if lost the group
11864 behaves like any other group. This means the commands below will not
11865 be available. To restore the special properties of the group, the
11866 simplest way is to kill the group, using @kbd{C-k}, and restart
11867 Gnus. The group is automatically created again with the
11868 correct parameters. The content of the group is not lost.
11870 @c @findex gnus-dissociate-buffer-from-draft
11871 @c @kindex C-c M-d (Mail)
11872 @c @kindex C-c M-d (Post)
11873 @c @findex gnus-associate-buffer-with-draft
11874 @c @kindex C-c C-d (Mail)
11875 @c @kindex C-c C-d (Post)
11876 @c If you're writing some super-secret message that you later want to
11877 @c encode with PGP before sending, you may wish to turn the auto-saving
11878 @c (and association with the draft group) off. You never know who might be
11879 @c interested in reading all your extremely valuable and terribly horrible
11880 @c and interesting secrets. The @kbd{C-c M-d}
11881 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
11882 @c If you change your mind and want to turn the auto-saving back on again,
11883 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
11885 @c @vindex gnus-use-draft
11886 @c To leave association with the draft group off by default, set
11887 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
11889 @findex gnus-draft-edit-message
11890 @kindex D e (Draft)
11891 When you want to continue editing the article, you simply enter the
11892 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
11893 that. You will be placed in a buffer where you left off.
11895 Rejected articles will also be put in this draft group (@pxref{Rejected
11898 @findex gnus-draft-send-all-messages
11899 @kindex D s (Draft)
11900 @findex gnus-draft-send-message
11901 @kindex D S (Draft)
11902 If you have lots of rejected messages you want to post (or mail) without
11903 doing further editing, you can use the @kbd{D s} command
11904 (@code{gnus-draft-send-message}). This command understands the
11905 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
11906 command (@code{gnus-draft-send-all-messages}) will ship off all messages
11909 @findex gnus-draft-toggle-sending
11910 @kindex D t (Draft)
11911 If you have some messages that you wish not to send, you can use the
11912 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
11913 as unsendable. This is a toggling command.
11916 @node Rejected Articles
11917 @section Rejected Articles
11918 @cindex rejected articles
11920 Sometimes a news server will reject an article. Perhaps the server
11921 doesn't like your face. Perhaps it just feels miserable. Perhaps
11922 @emph{there be demons}. Perhaps you have included too much cited text.
11923 Perhaps the disk is full. Perhaps the server is down.
11925 These situations are, of course, totally beyond the control of gnus.
11926 (Gnus, of course, loves the way you look, always feels great, has angels
11927 fluttering around inside of it, doesn't care about how much cited text
11928 you include, never runs full and never goes down.) So gnus saves these
11929 articles until some later time when the server feels better.
11931 The rejected articles will automatically be put in a special draft group
11932 (@pxref{Drafts}). When the server comes back up again, you'd then
11933 typically enter that group and send all the articles off.
11935 @node Signing and encrypting
11936 @section Signing and encrypting
11938 @cindex using s/mime
11939 @cindex using smime
11941 Gnus can digitally sign and encrypt your messages, using vanilla
11942 @acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}. For
11943 decoding such messages, see the @code{mm-verify-option} and
11944 @code{mm-decrypt-option} options (@pxref{Security}).
11946 @vindex gnus-message-replysign
11947 @vindex gnus-message-replyencrypt
11948 @vindex gnus-message-replysignencrypted
11949 Often, you would like to sign replies to people who send you signed
11950 messages. Even more often, you might want to encrypt messages which
11951 are in reply to encrypted messages. Gnus offers
11952 @code{gnus-message-replysign} to enable the former, and
11953 @code{gnus-message-replyencrypt} for the latter. In addition, setting
11954 @code{gnus-message-replysignencrypted} (on by default) will sign
11955 automatically encrypted messages.
11957 Instructing @acronym{MML} to perform security operations on a
11958 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
11959 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
11964 @kindex C-c C-m s s (Message)
11965 @findex mml-secure-message-sign-smime
11967 Digitally sign current message using @acronym{S/MIME}.
11970 @kindex C-c C-m s o (Message)
11971 @findex mml-secure-message-sign-pgp
11973 Digitally sign current message using @acronym{PGP}.
11976 @kindex C-c C-m s p (Message)
11977 @findex mml-secure-message-sign-pgp
11979 Digitally sign current message using @acronym{PGP/MIME}.
11982 @kindex C-c C-m c s (Message)
11983 @findex mml-secure-message-encrypt-smime
11985 Digitally encrypt current message using @acronym{S/MIME}.
11988 @kindex C-c C-m c o (Message)
11989 @findex mml-secure-message-encrypt-pgp
11991 Digitally encrypt current message using @acronym{PGP}.
11994 @kindex C-c C-m c p (Message)
11995 @findex mml-secure-message-encrypt-pgpmime
11997 Digitally encrypt current message using @acronym{PGP/MIME}.
12000 @kindex C-c C-m C-n (Message)
12001 @findex mml-unsecure-message
12002 Remove security related @acronym{MML} tags from message.
12006 @xref{Security, ,Security, message, Message Manual}, for more information.
12008 @node Select Methods
12009 @chapter Select Methods
12010 @cindex foreign groups
12011 @cindex select methods
12013 A @dfn{foreign group} is a group not read by the usual (or
12014 default) means. It could be, for instance, a group from a different
12015 @acronym{NNTP} server, it could be a virtual group, or it could be your own
12016 personal mail group.
12018 A foreign group (or any group, really) is specified by a @dfn{name} and
12019 a @dfn{select method}. To take the latter first, a select method is a
12020 list where the first element says what back end to use (e.g. @code{nntp},
12021 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
12022 name}. There may be additional elements in the select method, where the
12023 value may have special meaning for the back end in question.
12025 One could say that a select method defines a @dfn{virtual server}---so
12026 we do just that (@pxref{Server Buffer}).
12028 The @dfn{name} of the group is the name the back end will recognize the
12031 For instance, the group @samp{soc.motss} on the @acronym{NNTP} server
12032 @samp{some.where.edu} will have the name @samp{soc.motss} and select
12033 method @code{(nntp "some.where.edu")}. Gnus will call this group
12034 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
12035 back end just knows this group as @samp{soc.motss}.
12037 The different methods all have their peculiarities, of course.
12040 * Server Buffer:: Making and editing virtual servers.
12041 * Getting News:: Reading USENET news with Gnus.
12042 * Getting Mail:: Reading your personal mail with Gnus.
12043 * Browsing the Web:: Getting messages from a plethora of Web sources.
12044 * IMAP:: Using Gnus as a @acronym{IMAP} client.
12045 * Other Sources:: Reading directories, files, SOUP packets.
12046 * Combined Groups:: Combining groups into one group.
12047 * Gnus Unplugged:: Reading news and mail offline.
12051 @node Server Buffer
12052 @section Server Buffer
12054 Traditionally, a @dfn{server} is a machine or a piece of software that
12055 one connects to, and then requests information from. Gnus does not
12056 connect directly to any real servers, but does all transactions through
12057 one back end or other. But that's just putting one layer more between
12058 the actual media and Gnus, so we might just as well say that each
12059 back end represents a virtual server.
12061 For instance, the @code{nntp} back end may be used to connect to several
12062 different actual @acronym{NNTP} servers, or, perhaps, to many different ports
12063 on the same actual @acronym{NNTP} server. You tell Gnus which back end to
12064 use, and what parameters to set by specifying a @dfn{select method}.
12066 These select method specifications can sometimes become quite
12067 complicated---say, for instance, that you want to read from the
12068 @acronym{NNTP} server @samp{news.funet.fi} on port number 13, which
12069 hangs if queried for @acronym{NOV} headers and has a buggy select. Ahem.
12070 Anyway, if you had to specify that for each group that used this
12071 server, that would be too much work, so Gnus offers a way of naming
12072 select methods, which is what you do in the server buffer.
12074 To enter the server buffer, use the @kbd{^}
12075 (@code{gnus-group-enter-server-mode}) command in the group buffer.
12078 * Server Buffer Format:: You can customize the look of this buffer.
12079 * Server Commands:: Commands to manipulate servers.
12080 * Example Methods:: Examples server specifications.
12081 * Creating a Virtual Server:: An example session.
12082 * Server Variables:: Which variables to set.
12083 * Servers and Methods:: You can use server names as select methods.
12084 * Unavailable Servers:: Some servers you try to contact may be down.
12087 @vindex gnus-server-mode-hook
12088 @code{gnus-server-mode-hook} is run when creating the server buffer.
12091 @node Server Buffer Format
12092 @subsection Server Buffer Format
12093 @cindex server buffer format
12095 @vindex gnus-server-line-format
12096 You can change the look of the server buffer lines by changing the
12097 @code{gnus-server-line-format} variable. This is a @code{format}-like
12098 variable, with some simple extensions:
12103 How the news is fetched---the back end name.
12106 The name of this server.
12109 Where the news is to be fetched from---the address.
12112 The opened/closed/denied status of the server.
12115 @vindex gnus-server-mode-line-format
12116 The mode line can also be customized by using the
12117 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
12118 Formatting}). The following specs are understood:
12128 Also @pxref{Formatting Variables}.
12131 @node Server Commands
12132 @subsection Server Commands
12133 @cindex server commands
12139 @findex gnus-server-add-server
12140 Add a new server (@code{gnus-server-add-server}).
12144 @findex gnus-server-edit-server
12145 Edit a server (@code{gnus-server-edit-server}).
12148 @kindex SPACE (Server)
12149 @findex gnus-server-read-server
12150 Browse the current server (@code{gnus-server-read-server}).
12154 @findex gnus-server-exit
12155 Return to the group buffer (@code{gnus-server-exit}).
12159 @findex gnus-server-kill-server
12160 Kill the current server (@code{gnus-server-kill-server}).
12164 @findex gnus-server-yank-server
12165 Yank the previously killed server (@code{gnus-server-yank-server}).
12169 @findex gnus-server-copy-server
12170 Copy the current server (@code{gnus-server-copy-server}).
12174 @findex gnus-server-list-servers
12175 List all servers (@code{gnus-server-list-servers}).
12179 @findex gnus-server-scan-server
12180 Request that the server scan its sources for new articles
12181 (@code{gnus-server-scan-server}). This is mainly sensible with mail
12186 @findex gnus-server-regenerate-server
12187 Request that the server regenerate all its data structures
12188 (@code{gnus-server-regenerate-server}). This can be useful if you have
12189 a mail back end that has gotten out of sync.
12194 @node Example Methods
12195 @subsection Example Methods
12197 Most select methods are pretty simple and self-explanatory:
12200 (nntp "news.funet.fi")
12203 Reading directly from the spool is even simpler:
12209 As you can see, the first element in a select method is the name of the
12210 back end, and the second is the @dfn{address}, or @dfn{name}, if you
12213 After these two elements, there may be an arbitrary number of
12214 @code{(@var{variable} @var{form})} pairs.
12216 To go back to the first example---imagine that you want to read from
12217 port 15 on that machine. This is what the select method should
12221 (nntp "news.funet.fi" (nntp-port-number 15))
12224 You should read the documentation to each back end to find out what
12225 variables are relevant, but here's an @code{nnmh} example:
12227 @code{nnmh} is a mail back end that reads a spool-like structure. Say
12228 you have two structures that you wish to access: One is your private
12229 mail spool, and the other is a public one. Here's the possible spec for
12233 (nnmh "private" (nnmh-directory "~/private/mail/"))
12236 (This server is then called @samp{private}, but you may have guessed
12239 Here's the method for a public spool:
12243 (nnmh-directory "/usr/information/spool/")
12244 (nnmh-get-new-mail nil))
12250 If you are behind a firewall and only have access to the @acronym{NNTP}
12251 server from the firewall machine, you can instruct Gnus to @code{rlogin}
12252 on the firewall machine and telnet from there to the @acronym{NNTP} server.
12253 Doing this can be rather fiddly, but your virtual server definition
12254 should probably look something like this:
12258 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
12259 (nntp-via-address "the.firewall.machine")
12260 (nntp-address "the.real.nntp.host")
12261 (nntp-end-of-line "\n"))
12264 If you want to use the wonderful @code{ssh} program to provide a
12265 compressed connection over the modem line, you could add the following
12266 configuration to the example above:
12269 (nntp-via-rlogin-command "ssh")
12272 See also @code{nntp-via-rlogin-command-switches}.
12274 If you're behind a firewall, but have direct access to the outside world
12275 through a wrapper command like "runsocks", you could open a socksified
12276 telnet connection to the news server as follows:
12280 (nntp-pre-command "runsocks")
12281 (nntp-open-connection-function nntp-open-via-telnet)
12282 (nntp-address "the.news.server")
12283 (nntp-end-of-line "\n"))
12286 This means that you have to have set up @code{ssh-agent} correctly to
12287 provide automatic authorization, of course. And to get a compressed
12288 connection, you have to have the @samp{Compression} option in the
12289 @code{ssh} @file{config} file.
12292 @node Creating a Virtual Server
12293 @subsection Creating a Virtual Server
12295 If you're saving lots of articles in the cache by using persistent
12296 articles, you may want to create a virtual server to read the cache.
12298 First you need to add a new server. The @kbd{a} command does that. It
12299 would probably be best to use @code{nnml} to read the cache. You
12300 could also use @code{nnspool} or @code{nnmh}, though.
12302 Type @kbd{a nnml RET cache RET}.
12304 You should now have a brand new @code{nnml} virtual server called
12305 @samp{cache}. You now need to edit it to have the right definitions.
12306 Type @kbd{e} to edit the server. You'll be entered into a buffer that
12307 will contain the following:
12317 (nnml-directory "~/News/cache/")
12318 (nnml-active-file "~/News/cache/active"))
12321 Type @kbd{C-c C-c} to return to the server buffer. If you now press
12322 @kbd{RET} over this virtual server, you should be entered into a browse
12323 buffer, and you should be able to enter any of the groups displayed.
12326 @node Server Variables
12327 @subsection Server Variables
12328 @cindex server variables
12329 @cindex server parameters
12331 One sticky point when defining variables (both on back ends and in Emacs
12332 in general) is that some variables are typically initialized from other
12333 variables when the definition of the variables is being loaded. If you
12334 change the ``base'' variable after the variables have been loaded, you
12335 won't change the ``derived'' variables.
12337 This typically affects directory and file variables. For instance,
12338 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
12339 directory variables are initialized from that variable, so
12340 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
12341 new virtual @code{nnml} server, it will @emph{not} suffice to set just
12342 @code{nnml-directory}---you have to explicitly set all the file
12343 variables to be what you want them to be. For a complete list of
12344 variables for each back end, see each back end's section later in this
12345 manual, but here's an example @code{nnml} definition:
12349 (nnml-directory "~/my-mail/")
12350 (nnml-active-file "~/my-mail/active")
12351 (nnml-newsgroups-file "~/my-mail/newsgroups"))
12354 Server variables are often called @dfn{server parameters}.
12356 @node Servers and Methods
12357 @subsection Servers and Methods
12359 Wherever you would normally use a select method
12360 (e.g. @code{gnus-secondary-select-method}, in the group select method,
12361 when browsing a foreign server) you can use a virtual server name
12362 instead. This could potentially save lots of typing. And it's nice all
12366 @node Unavailable Servers
12367 @subsection Unavailable Servers
12369 If a server seems to be unreachable, Gnus will mark that server as
12370 @code{denied}. That means that any subsequent attempt to make contact
12371 with that server will just be ignored. ``It can't be opened,'' Gnus
12372 will tell you, without making the least effort to see whether that is
12373 actually the case or not.
12375 That might seem quite naughty, but it does make sense most of the time.
12376 Let's say you have 10 groups subscribed to on server
12377 @samp{nephelococcygia.com}. This server is located somewhere quite far
12378 away from you and the machine is quite slow, so it takes 1 minute just
12379 to find out that it refuses connection to you today. If Gnus were to
12380 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
12381 attempt to do that. Once it has gotten a single ``connection refused'',
12382 it will regard that server as ``down''.
12384 So, what happens if the machine was only feeling unwell temporarily?
12385 How do you test to see whether the machine has come up again?
12387 You jump to the server buffer (@pxref{Server Buffer}) and poke it
12388 with the following commands:
12394 @findex gnus-server-open-server
12395 Try to establish connection to the server on the current line
12396 (@code{gnus-server-open-server}).
12400 @findex gnus-server-close-server
12401 Close the connection (if any) to the server
12402 (@code{gnus-server-close-server}).
12406 @findex gnus-server-deny-server
12407 Mark the current server as unreachable
12408 (@code{gnus-server-deny-server}).
12411 @kindex M-o (Server)
12412 @findex gnus-server-open-all-servers
12413 Open the connections to all servers in the buffer
12414 (@code{gnus-server-open-all-servers}).
12417 @kindex M-c (Server)
12418 @findex gnus-server-close-all-servers
12419 Close the connections to all servers in the buffer
12420 (@code{gnus-server-close-all-servers}).
12424 @findex gnus-server-remove-denials
12425 Remove all marks to whether Gnus was denied connection from any servers
12426 (@code{gnus-server-remove-denials}).
12430 @findex gnus-server-offline-server
12431 Set server status to offline (@code{gnus-server-offline-server}).
12437 @section Getting News
12438 @cindex reading news
12439 @cindex news back ends
12441 A newsreader is normally used for reading news. Gnus currently provides
12442 only two methods of getting news---it can read from an @acronym{NNTP} server,
12443 or it can read from a local spool.
12446 * NNTP:: Reading news from an @acronym{NNTP} server.
12447 * News Spool:: Reading news from the local spool.
12455 Subscribing to a foreign group from an @acronym{NNTP} server is rather easy.
12456 You just specify @code{nntp} as method and the address of the @acronym{NNTP}
12457 server as the, uhm, address.
12459 If the @acronym{NNTP} server is located at a non-standard port, setting the
12460 third element of the select method to this port number should allow you
12461 to connect to the right port. You'll have to edit the group info for
12462 that (@pxref{Foreign Groups}).
12464 The name of the foreign group can be the same as a native group. In
12465 fact, you can subscribe to the same group from as many different servers
12466 you feel like. There will be no name collisions.
12468 The following variables can be used to create a virtual @code{nntp}
12473 @item nntp-server-opened-hook
12474 @vindex nntp-server-opened-hook
12475 @cindex @sc{mode reader}
12477 @cindex authentification
12478 @cindex nntp authentification
12479 @findex nntp-send-authinfo
12480 @findex nntp-send-mode-reader
12481 is run after a connection has been made. It can be used to send
12482 commands to the @acronym{NNTP} server after it has been contacted. By
12483 default it sends the command @code{MODE READER} to the server with the
12484 @code{nntp-send-mode-reader} function. This function should always be
12485 present in this hook.
12487 @item nntp-authinfo-function
12488 @vindex nntp-authinfo-function
12489 @findex nntp-send-authinfo
12490 @vindex nntp-authinfo-file
12491 This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP}
12492 server. The default function is @code{nntp-send-authinfo}, which looks
12493 through your @file{~/.authinfo} (or whatever you've set the
12494 @code{nntp-authinfo-file} variable to) for applicable entries. If none
12495 are found, it will prompt you for a login name and a password. The
12496 format of the @file{~/.authinfo} file is (almost) the same as the
12497 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
12498 manual page, but here are the salient facts:
12502 The file contains one or more line, each of which define one server.
12505 Each line may contain an arbitrary number of token/value pairs.
12507 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
12508 @samp{default}. In addition Gnus introduces two new tokens, not present
12509 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
12510 @samp{force}. (This is the only way the @file{.authinfo} file format
12511 deviates from the @file{.netrc} file format.) @samp{port} is used to
12512 indicate what port on the server the credentials apply to and
12513 @samp{force} is explained below.
12517 Here's an example file:
12520 machine news.uio.no login larsi password geheimnis
12521 machine nntp.ifi.uio.no login larsi force yes
12524 The token/value pairs may appear in any order; @samp{machine} doesn't
12525 have to be first, for instance.
12527 In this example, both login name and password have been supplied for the
12528 former server, while the latter has only the login name listed, and the
12529 user will be prompted for the password. The latter also has the
12530 @samp{force} tag, which means that the authinfo will be sent to the
12531 @var{nntp} server upon connection; the default (i.e., when there is not
12532 @samp{force} tag) is to not send authinfo to the @var{nntp} server
12533 until the @var{nntp} server asks for it.
12535 You can also add @samp{default} lines that will apply to all servers
12536 that don't have matching @samp{machine} lines.
12542 This will force sending @samp{AUTHINFO} commands to all servers not
12543 previously mentioned.
12545 Remember to not leave the @file{~/.authinfo} file world-readable.
12547 @item nntp-server-action-alist
12548 @vindex nntp-server-action-alist
12549 This is a list of regexps to match on server types and actions to be
12550 taken when matches are made. For instance, if you want Gnus to beep
12551 every time you connect to innd, you could say something like:
12554 (setq nntp-server-action-alist
12555 '(("innd" (ding))))
12558 You probably don't want to do that, though.
12560 The default value is
12563 '(("nntpd 1\\.5\\.11t"
12564 (remove-hook 'nntp-server-opened-hook
12565 'nntp-send-mode-reader)))
12568 This ensures that Gnus doesn't send the @code{MODE READER} command to
12569 nntpd 1.5.11t, since that command chokes that server, I've been told.
12571 @item nntp-maximum-request
12572 @vindex nntp-maximum-request
12573 If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end
12574 will collect headers by sending a series of @code{head} commands. To
12575 speed things up, the back end sends lots of these commands without
12576 waiting for reply, and then reads all the replies. This is controlled
12577 by the @code{nntp-maximum-request} variable, and is 400 by default. If
12578 your network is buggy, you should set this to 1.
12580 @item nntp-connection-timeout
12581 @vindex nntp-connection-timeout
12582 If you have lots of foreign @code{nntp} groups that you connect to
12583 regularly, you're sure to have problems with @acronym{NNTP} servers not
12584 responding properly, or being too loaded to reply within reasonable
12585 time. This is can lead to awkward problems, which can be helped
12586 somewhat by setting @code{nntp-connection-timeout}. This is an integer
12587 that says how many seconds the @code{nntp} back end should wait for a
12588 connection before giving up. If it is @code{nil}, which is the default,
12589 no timeouts are done.
12591 @c @item nntp-command-timeout
12592 @c @vindex nntp-command-timeout
12593 @c @cindex PPP connections
12594 @c @cindex dynamic IP addresses
12595 @c If you're running Gnus on a machine that has a dynamically assigned
12596 @c address, Gnus may become confused. If the address of your machine
12597 @c changes after connecting to the @acronym{NNTP} server, Gnus will simply sit
12598 @c waiting forever for replies from the server. To help with this
12599 @c unfortunate problem, you can set this command to a number. Gnus will
12600 @c then, if it sits waiting for a reply from the server longer than that
12601 @c number of seconds, shut down the connection, start a new one, and resend
12602 @c the command. This should hopefully be transparent to the user. A
12603 @c likely number is 30 seconds.
12605 @c @item nntp-retry-on-break
12606 @c @vindex nntp-retry-on-break
12607 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
12608 @c hangs. This will have much the same effect as the command timeout
12609 @c described above.
12611 @item nntp-server-hook
12612 @vindex nntp-server-hook
12613 This hook is run as the last step when connecting to an @acronym{NNTP}
12616 @item nntp-buggy-select
12617 @vindex nntp-buggy-select
12618 Set this to non-@code{nil} if your select routine is buggy.
12620 @item nntp-nov-is-evil
12621 @vindex nntp-nov-is-evil
12622 If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this
12623 variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV}
12626 @item nntp-xover-commands
12627 @vindex nntp-xover-commands
12628 @cindex @acronym{NOV}
12630 List of strings used as commands to fetch @acronym{NOV} lines from a
12631 server. The default value of this variable is @code{("XOVER"
12635 @vindex nntp-nov-gap
12636 @code{nntp} normally sends just one big request for @acronym{NOV} lines to
12637 the server. The server responds with one huge list of lines. However,
12638 if you have read articles 2-5000 in the group, and only want to read
12639 article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV}
12640 lines that you will not need. This variable says how
12641 big a gap between two consecutive articles is allowed to be before the
12642 @code{XOVER} request is split into several request. Note that if your
12643 network is fast, setting this variable to a really small number means
12644 that fetching will probably be slower. If this variable is @code{nil},
12645 @code{nntp} will never split requests. The default is 5.
12647 @item nntp-prepare-server-hook
12648 @vindex nntp-prepare-server-hook
12649 A hook run before attempting to connect to an @acronym{NNTP} server.
12651 @item nntp-warn-about-losing-connection
12652 @vindex nntp-warn-about-losing-connection
12653 If this variable is non-@code{nil}, some noise will be made when a
12654 server closes connection.
12656 @item nntp-record-commands
12657 @vindex nntp-record-commands
12658 If non-@code{nil}, @code{nntp} will log all commands it sends to the
12659 @acronym{NNTP} server (along with a timestamp) in the @samp{*nntp-log*}
12660 buffer. This is useful if you are debugging a Gnus/@acronym{NNTP} connection
12661 that doesn't seem to work.
12663 @item nntp-open-connection-function
12664 @vindex nntp-open-connection-function
12665 It is possible to customize how the connection to the nntp server will
12666 be opened. If you specify an @code{nntp-open-connection-function}
12667 parameter, Gnus will use that function to establish the connection.
12668 Five pre-made functions are supplied. These functions can be grouped in
12669 two categories: direct connection functions (three pre-made), and
12670 indirect ones (two pre-made).
12672 @item nntp-prepare-post-hook
12673 @vindex nntp-prepare-post-hook
12674 A hook run just before posting an article. If there is no
12675 @code{Message-ID} header in the article and the news server provides the
12676 recommended ID, it will be added to the article before running this
12677 hook. It is useful to make @code{Cancel-Lock} headers even if you
12678 inhibit Gnus to add a @code{Message-ID} header, you could say:
12681 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
12684 Note that not all servers support the recommended ID. This works for
12685 INN versions 2.3.0 and later, for instance.
12687 @item nntp-read-timeout
12688 @vindex nntp-read-timeout
12689 How long nntp should wait between checking for the end of output.
12690 Shorter values mean quicker response, but is more CPU intensive. The
12691 default is 0.1 seconds. If you have a slow line to the server (and
12692 don't like to see Emacs eat your available CPU power), you might set
12695 @item nntp-list-options
12696 @vindex nntp-list-options
12697 List of newsgroup name used for a option of the LIST command to restrict
12698 the listing output to only the specified newsgroups. Each newsgroup name
12699 can be a shell-style wildcard, for instance, @dfn{fj.*}, @dfn{japan.*},
12700 etc. Fortunately, if the server can accept such a option, it will
12701 probably make gnus run faster. You may use it as a server variable as
12705 (setq gnus-select-method
12706 '(nntp "news.somewhere.edu"
12707 (nntp-list-options ("fj.*" "japan.*"))))
12710 @item nntp-options-subscribe
12711 @vindex nntp-options-subscribe
12712 Regexp matching the newsgroup names which will be subscribed
12713 unconditionally. Use @dfn{ } instead of @dfn{$} for a regexp string.
12714 It may be effective as well as @code{nntp-list-options} even though the
12715 server could not accept a shell-style wildcard as a option of the LIST
12716 command. You may use it as a server variable as follows:
12719 (setq gnus-select-method
12720 '(nntp "news.somewhere.edu"
12721 (nntp-options-subscribe "^fj\\.\\|^japan\\.")))
12724 @item nntp-options-not-subscribe
12725 @vindex nntp-options-not-subscribe
12726 Regexp matching the newsgroup names which will not be subscribed
12727 unconditionally. Use @dfn{ } instead of @dfn{$} for a regexp string.
12728 It may be effective as well as @code{nntp-list-options} even though the
12729 server could not accept a shell-style wildcard as a option of the LIST
12730 command. You may use it as a server variable as follows:
12733 (setq gnus-select-method
12734 '(nntp "news.somewhere.edu"
12735 (nntp-options-not-subscribe "\\.binaries\\.")))
12740 * Direct Functions:: Connecting directly to the server.
12741 * Indirect Functions:: Connecting indirectly to the server.
12742 * Common Variables:: Understood by several connection functions.
12746 @node Direct Functions
12747 @subsubsection Direct Functions
12748 @cindex direct connection functions
12750 These functions are called direct because they open a direct connection
12751 between your machine and the @acronym{NNTP} server. The behavior of these
12752 functions is also affected by commonly understood variables
12753 (@pxref{Common Variables}).
12756 @findex nntp-open-network-stream
12757 @item nntp-open-network-stream
12758 This is the default, and simply connects to some port or other on the
12761 @findex nntp-open-tls-stream
12762 @item nntp-open-tls-stream
12763 Opens a connection to a server over a @dfn{secure} channel. To use
12764 this you must have @uref{http://www.gnu.org/software/gnutls/, GNUTLS}
12765 installed. You then define a server as follows:
12768 ;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}}
12769 ;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.}
12771 (nntp "snews.bar.com"
12772 (nntp-open-connection-function nntp-open-tls-stream)
12773 (nntp-port-number )
12774 (nntp-address "snews.bar.com"))
12777 @findex nntp-open-ssl-stream
12778 @item nntp-open-ssl-stream
12779 Opens a connection to a server over a @dfn{secure} channel. To use
12780 this you must have @uref{http://www.openssl.org, OpenSSL} or
12781 @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay} installed. You
12782 then define a server as follows:
12785 ;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}}
12786 ;; @r{however, @samp{openssl s_client -port} doesn't like named ports.}
12788 (nntp "snews.bar.com"
12789 (nntp-open-connection-function nntp-open-ssl-stream)
12790 (nntp-port-number 563)
12791 (nntp-address "snews.bar.com"))
12794 @findex nntp-open-telnet-stream
12795 @item nntp-open-telnet-stream
12796 Opens a connection to an @acronym{NNTP} server by simply @samp{telnet}'ing
12797 it. You might wonder why this function exists, since we have the
12798 default @code{nntp-open-network-stream} which would do the job. (One
12799 of) the reason(s) is that if you are behind a firewall but have direct
12800 connections to the outside world thanks to a command wrapper like
12801 @code{runsocks}, you can use it like this:
12805 (nntp-pre-command "runsocks")
12806 (nntp-open-connection-function nntp-open-telnet-stream)
12807 (nntp-address "the.news.server"))
12810 With the default method, you would need to wrap your whole Emacs
12811 session, which is not a good idea.
12815 @node Indirect Functions
12816 @subsubsection Indirect Functions
12817 @cindex indirect connection functions
12819 These functions are called indirect because they connect to an
12820 intermediate host before actually connecting to the @acronym{NNTP} server.
12821 All of these functions and related variables are also said to belong to
12822 the ``via'' family of connection: they're all prefixed with ``via'' to make
12823 things cleaner. The behavior of these functions is also affected by
12824 commonly understood variables (@pxref{Common Variables}).
12827 @item nntp-open-via-rlogin-and-telnet
12828 @findex nntp-open-via-rlogin-and-telnet
12829 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
12830 to the real @acronym{NNTP} server from there. This is useful for instance if
12831 you need to connect to a firewall machine first.
12833 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
12836 @item nntp-via-rlogin-command
12837 @vindex nntp-via-rlogin-command
12838 Command used to log in on the intermediate host. The default is
12839 @samp{rsh}, but @samp{ssh} is a popular alternative.
12841 @item nntp-via-rlogin-command-switches
12842 @vindex nntp-via-rlogin-command-switches
12843 List of strings to be used as the switches to
12844 @code{nntp-via-rlogin-command}. The default is @code{nil}. If you use
12845 @samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to
12846 @samp{("-C")} in order to compress all data connections, otherwise set
12847 this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if
12848 the telnet command requires a pseudo-tty allocation on an intermediate
12852 @item nntp-open-via-telnet-and-telnet
12853 @findex nntp-open-via-telnet-and-telnet
12854 Does essentially the same, but uses @samp{telnet} instead of
12855 @samp{rlogin} to connect to the intermediate host.
12857 @code{nntp-open-via-telnet-and-telnet}-specific variables:
12860 @item nntp-via-telnet-command
12861 @vindex nntp-via-telnet-command
12862 Command used to @code{telnet} the intermediate host. The default is
12865 @item nntp-via-telnet-switches
12866 @vindex nntp-via-telnet-switches
12867 List of strings to be used as the switches to the
12868 @code{nntp-via-telnet-command} command. The default is @samp{("-8")}.
12870 @item nntp-via-user-password
12871 @vindex nntp-via-user-password
12872 Password to use when logging in on the intermediate host.
12874 @item nntp-via-envuser
12875 @vindex nntp-via-envuser
12876 If non-@code{nil}, the intermediate @code{telnet} session (client and
12877 server both) will support the @code{ENVIRON} option and not prompt for
12878 login name. This works for Solaris @code{telnet}, for instance.
12880 @item nntp-via-shell-prompt
12881 @vindex nntp-via-shell-prompt
12882 Regexp matching the shell prompt on the intermediate host. The default
12883 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
12890 Here are some additional variables that are understood by all the above
12895 @item nntp-via-user-name
12896 @vindex nntp-via-user-name
12897 User name to use when connecting to the intermediate host.
12899 @item nntp-via-address
12900 @vindex nntp-via-address
12901 Address of the intermediate host to connect to.
12906 @node Common Variables
12907 @subsubsection Common Variables
12909 The following variables affect the behavior of all, or several of the
12910 pre-made connection functions. When not specified, all functions are
12915 @item nntp-pre-command
12916 @vindex nntp-pre-command
12917 A command wrapper to use when connecting through a non native
12918 connection function (all except @code{nntp-open-network-stream},
12919 @code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}. This is
12920 where you would put a @samp{SOCKS} wrapper for instance.
12923 @vindex nntp-address
12924 The address of the @acronym{NNTP} server.
12926 @item nntp-port-number
12927 @vindex nntp-port-number
12928 Port number to connect to the @acronym{NNTP} server. The default is
12929 @samp{nntp}. If you use @acronym{NNTP} over
12930 @acronym{TLS}/@acronym{SSL}, you may want to use integer ports rather
12931 than named ports (i.e, use @samp{563} instead of @samp{snews} or
12932 @samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may
12933 not work with named ports.
12935 @item nntp-end-of-line
12936 @vindex nntp-end-of-line
12937 String to use as end-of-line marker when talking to the @acronym{NNTP}
12938 server. This is @samp{\r\n} by default, but should be @samp{\n} when
12939 using a non native connection function.
12941 @item nntp-telnet-command
12942 @vindex nntp-telnet-command
12943 Command to use when connecting to the @acronym{NNTP} server through
12944 @samp{telnet}. This is @emph{not} for an intermediate host. This is
12945 just for the real @acronym{NNTP} server. The default is
12948 @item nntp-telnet-switches
12949 @vindex nntp-telnet-switches
12950 A list of switches to pass to @code{nntp-telnet-command}. The default
12957 @subsection News Spool
12961 Subscribing to a foreign group from the local spool is extremely easy,
12962 and might be useful, for instance, to speed up reading groups that
12963 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
12966 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
12967 anything else) as the address.
12969 If you have access to a local spool, you should probably use that as the
12970 native select method (@pxref{Finding the News}). It is normally faster
12971 than using an @code{nntp} select method, but might not be. It depends.
12972 You just have to try to find out what's best at your site.
12976 @item nnspool-inews-program
12977 @vindex nnspool-inews-program
12978 Program used to post an article.
12980 @item nnspool-inews-switches
12981 @vindex nnspool-inews-switches
12982 Parameters given to the inews program when posting an article.
12984 @item nnspool-spool-directory
12985 @vindex nnspool-spool-directory
12986 Where @code{nnspool} looks for the articles. This is normally
12987 @file{/usr/spool/news/}.
12989 @item nnspool-nov-directory
12990 @vindex nnspool-nov-directory
12991 Where @code{nnspool} will look for @acronym{NOV} files. This is normally@*
12992 @file{/usr/spool/news/over.view/}.
12994 @item nnspool-lib-dir
12995 @vindex nnspool-lib-dir
12996 Where the news lib dir is (@file{/usr/lib/news/} by default).
12998 @item nnspool-active-file
12999 @vindex nnspool-active-file
13000 The name of the active file.
13002 @item nnspool-newsgroups-file
13003 @vindex nnspool-newsgroups-file
13004 The name of the group descriptions file.
13006 @item nnspool-history-file
13007 @vindex nnspool-history-file
13008 The name of the news history file.
13010 @item nnspool-active-times-file
13011 @vindex nnspool-active-times-file
13012 The name of the active date file.
13014 @item nnspool-nov-is-evil
13015 @vindex nnspool-nov-is-evil
13016 If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files
13019 @item nnspool-sift-nov-with-sed
13020 @vindex nnspool-sift-nov-with-sed
13022 If non-@code{nil}, which is the default, use @code{sed} to get the
13023 relevant portion from the overview file. If @code{nil},
13024 @code{nnspool} will load the entire file into a buffer and process it
13031 @section Getting Mail
13032 @cindex reading mail
13035 Reading mail with a newsreader---isn't that just plain WeIrD? But of
13039 * Mail in a Newsreader:: Important introductory notes.
13040 * Getting Started Reading Mail:: A simple cookbook example.
13041 * Splitting Mail:: How to create mail groups.
13042 * Mail Sources:: How to tell Gnus where to get mail from.
13043 * Mail Back End Variables:: Variables for customizing mail handling.
13044 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
13045 * Group Mail Splitting:: Use group customize to drive mail splitting.
13046 * Incorporating Old Mail:: What about the old mail you have?
13047 * Expiring Mail:: Getting rid of unwanted mail.
13048 * Washing Mail:: Removing cruft from the mail you get.
13049 * Duplicates:: Dealing with duplicated mail.
13050 * Not Reading Mail:: Using mail back ends for reading other files.
13051 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
13055 @node Mail in a Newsreader
13056 @subsection Mail in a Newsreader
13058 If you are used to traditional mail readers, but have decided to switch
13059 to reading mail with Gnus, you may find yourself experiencing something
13060 of a culture shock.
13062 Gnus does not behave like traditional mail readers. If you want to make
13063 it behave that way, you can, but it's an uphill battle.
13065 Gnus, by default, handles all its groups using the same approach. This
13066 approach is very newsreaderly---you enter a group, see the new/unread
13067 messages, and when you read the messages, they get marked as read, and
13068 you don't see them any more. (Unless you explicitly ask for them.)
13070 In particular, you do not do anything explicitly to delete messages.
13072 Does this mean that all the messages that have been marked as read are
13073 deleted? How awful!
13075 But, no, it means that old messages are @dfn{expired} according to some
13076 scheme or other. For news messages, the expire process is controlled by
13077 the news administrator; for mail, the expire process is controlled by
13078 you. The expire process for mail is covered in depth in @ref{Expiring
13081 What many Gnus users find, after using it a while for both news and
13082 mail, is that the transport mechanism has very little to do with how
13083 they want to treat a message.
13085 Many people subscribe to several mailing lists. These are transported
13086 via @acronym{SMTP}, and are therefore mail. But we might go for weeks without
13087 answering, or even reading these messages very carefully. We may not
13088 need to save them because if we should need to read one again, they are
13089 archived somewhere else.
13091 Some people have local news groups which have only a handful of readers.
13092 These are transported via @acronym{NNTP}, and are therefore news. But we may need
13093 to read and answer a large fraction of the messages very carefully in
13094 order to do our work. And there may not be an archive, so we may need
13095 to save the interesting messages the same way we would personal mail.
13097 The important distinction turns out to be not the transport mechanism,
13098 but other factors such as how interested we are in the subject matter,
13099 or how easy it is to retrieve the message if we need to read it again.
13101 Gnus provides many options for sorting mail into ``groups'' which behave
13102 like newsgroups, and for treating each group (whether mail or news)
13105 Some users never get comfortable using the Gnus (ahem) paradigm and wish
13106 that Gnus should grow up and be a male, er, mail reader. It is possible
13107 to whip Gnus into a more mailreaderly being, but, as said before, it's
13108 not easy. People who prefer proper mail readers should try @sc{vm}
13109 instead, which is an excellent, and proper, mail reader.
13111 I don't mean to scare anybody off, but I want to make it clear that you
13112 may be required to learn a new way of thinking about messages. After
13113 you've been subjected to The Gnus Way, you will come to love it. I can
13114 guarantee it. (At least the guy who sold me the Emacs Subliminal
13115 Brain-Washing Functions that I've put into Gnus did guarantee it. You
13116 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
13120 @node Getting Started Reading Mail
13121 @subsection Getting Started Reading Mail
13123 It's quite easy to use Gnus to read your new mail. You just plonk the
13124 mail back end of your choice into @code{gnus-secondary-select-methods},
13125 and things will happen automatically.
13127 For instance, if you want to use @code{nnml} (which is a ``one file per
13128 mail'' back end), you could put the following in your @file{~/.gnus.el} file:
13131 (setq gnus-secondary-select-methods '((nnml "")))
13134 Now, the next time you start Gnus, this back end will be queried for new
13135 articles, and it will move all the messages in your spool file to its
13136 directory, which is @file{~/Mail/} by default. The new group that will
13137 be created (@samp{mail.misc}) will be subscribed, and you can read it
13138 like any other group.
13140 You will probably want to split the mail into several groups, though:
13143 (setq nnmail-split-methods
13144 '(("junk" "^From:.*Lars Ingebrigtsen")
13145 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
13149 This will result in three new @code{nnml} mail groups being created:
13150 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
13151 mail that doesn't fit into the first two groups will be placed in the
13154 This should be sufficient for reading mail with Gnus. You might want to
13155 give the other sections in this part of the manual a perusal, though.
13156 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
13159 @node Splitting Mail
13160 @subsection Splitting Mail
13161 @cindex splitting mail
13162 @cindex mail splitting
13163 @cindex mail filtering (splitting)
13165 @vindex nnmail-split-methods
13166 The @code{nnmail-split-methods} variable says how the incoming mail is
13167 to be split into groups.
13170 (setq nnmail-split-methods
13171 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
13172 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
13173 ("mail.other" "")))
13176 This variable is a list of lists, where the first element of each of
13177 these lists is the name of the mail group (they do not have to be called
13178 something beginning with @samp{mail}, by the way), and the second
13179 element is a regular expression used on the header of each mail to
13180 determine if it belongs in this mail group. The first string may
13181 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
13182 insert sub-expressions from the matched text. For instance:
13185 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
13188 The second element can also be a function. In that case, it will be
13189 called narrowed to the headers with the first element of the rule as the
13190 argument. It should return a non-@code{nil} value if it thinks that the
13191 mail belongs in that group.
13193 The last of these groups should always be a general one, and the regular
13194 expression should @emph{always} be @samp{*} so that it matches any mails
13195 that haven't been matched by any of the other regexps. (These rules are
13196 processed from the beginning of the alist toward the end. The first
13197 rule to make a match will ``win'', unless you have crossposting enabled.
13198 In that case, all matching rules will ``win''.)
13200 If you like to tinker with this yourself, you can set this variable to a
13201 function of your choice. This function will be called without any
13202 arguments in a buffer narrowed to the headers of an incoming mail
13203 message. The function should return a list of group names that it
13204 thinks should carry this mail message.
13206 Note that the mail back ends are free to maul the poor, innocent,
13207 incoming headers all they want to. They all add @code{Lines} headers;
13208 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
13209 @code{From<SPACE>} line to something else.
13211 @vindex nnmail-crosspost
13212 The mail back ends all support cross-posting. If several regexps match,
13213 the mail will be ``cross-posted'' to all those groups.
13214 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
13215 that no articles are crossposted to the general (@samp{*}) group.
13217 @vindex nnmail-crosspost-link-function
13220 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
13221 the crossposted articles. However, not all file systems support hard
13222 links. If that's the case for you, set
13223 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
13224 variable is @code{add-name-to-file} by default.)
13226 @kindex M-x nnmail-split-history
13227 @findex nnmail-split-history
13228 If you wish to see where the previous mail split put the messages, you
13229 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
13230 where re-spooling messages would put the messages, you can use
13231 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
13234 @vindex nnmail-split-header-length-limit
13235 Header lines longer than the value of
13236 @code{nnmail-split-header-length-limit} are excluded from the split
13239 @vindex nnmail-mail-splitting-charset
13240 @vindex nnmail-mail-splitting-decodes
13241 By default the splitting codes @acronym{MIME} decodes headers so you
13242 can match on non-@acronym{ASCII} strings. The
13243 @code{nnmail-mail-splitting-charset} variable specifies the default
13244 charset for decoding. The behaviour can be turned off completely by
13245 binding @code{nnmail-mail-splitting-decodes} to @code{nil}, which is
13246 useful if you want to match articles based on the raw header data.
13248 @vindex nnmail-resplit-incoming
13249 By default, splitting is performed on all incoming messages. If you
13250 specify a @code{directory} entry for the variable @code{mail-sources}
13251 (@pxref{Mail Source Specifiers}), however, then splitting does
13252 @emph{not} happen by default. You can set the variable
13253 @code{nnmail-resplit-incoming} to a non-@code{nil} value to make
13254 splitting happen even in this case. (This variable has no effect on
13255 other kinds of entries.)
13257 Gnus gives you all the opportunity you could possibly want for shooting
13258 yourself in the foot. Let's say you create a group that will contain
13259 all the mail you get from your boss. And then you accidentally
13260 unsubscribe from the group. Gnus will still put all the mail from your
13261 boss in the unsubscribed group, and so, when your boss mails you ``Have
13262 that report ready by Monday or you're fired!'', you'll never see it and,
13263 come Tuesday, you'll still believe that you're gainfully employed while
13264 you really should be out collecting empty bottles to save up for next
13265 month's rent money.
13269 @subsection Mail Sources
13271 Mail can be gotten from many different sources---the mail spool, from
13272 a @acronym{POP} mail server, from a procmail directory, or from a
13273 maildir, for instance.
13276 * Mail Source Specifiers:: How to specify what a mail source is.
13277 * Mail Source Customization:: Some variables that influence things.
13278 * Fetching Mail:: Using the mail source specifiers.
13282 @node Mail Source Specifiers
13283 @subsubsection Mail Source Specifiers
13285 @cindex mail server
13288 @cindex mail source
13290 You tell Gnus how to fetch mail by setting @code{mail-sources}
13291 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
13296 (pop :server "pop3.mailserver.com" :user "myname")
13299 As can be observed, a mail source specifier is a list where the first
13300 element is a @dfn{mail source type}, followed by an arbitrary number of
13301 @dfn{keywords}. Keywords that are not explicitly specified are given
13304 The following mail source types are available:
13308 Get mail from a single file; typically from the mail spool.
13314 The file name. Defaults to the value of the @env{MAIL}
13315 environment variable or the value of @code{rmail-spool-directory}
13316 (usually something like @file{/usr/mail/spool/user-name}).
13320 Script run before/after fetching mail.
13323 An example file mail source:
13326 (file :path "/usr/spool/mail/user-name")
13329 Or using the default file name:
13335 If the mail spool file is not located on the local machine, it's best
13336 to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail.
13337 You can not use ange-ftp file names here---it has no way to lock the
13338 mail spool while moving the mail.
13340 If it's impossible to set up a proper server, you can use ssh instead.
13344 '((file :prescript "ssh host bin/getmail >%t")))
13347 The @samp{getmail} script would look something like the following:
13351 # getmail - move mail from spool to stdout
13354 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
13356 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
13359 Alter this script to fit find the @samp{movemail} you want to use.
13363 @vindex nnmail-scan-directory-mail-source-once
13364 Get mail from several files in a directory. This is typically used
13365 when you have procmail split the incoming mail into several files.
13366 That is, there is a one-to-one correspondence between files in that
13367 directory and groups, so that mail from the file @file{foo.bar.spool}
13368 will be put in the group @code{foo.bar}. (You can change the suffix
13369 to be used instead of @code{.spool}.) Setting
13370 @code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces
13371 Gnus to scan the mail source only once. This is particularly useful
13372 if you want to scan mail groups at a specified level.
13374 @vindex nnmail-resplit-incoming
13375 There is also the variable @code{nnmail-resplit-incoming}, if you set
13376 that to a non-@code{nil} value, then the normal splitting process is
13377 applied to all the files from the directory, @ref{Splitting Mail}.
13383 The name of the directory where the files are. There is no default
13387 Only files ending with this suffix are used. The default is
13391 Only files that have this predicate return non-@code{nil} are returned.
13392 The default is @code{identity}. This is used as an additional
13393 filter---only files that have the right suffix @emph{and} satisfy this
13394 predicate are considered.
13398 Script run before/after fetching mail.
13402 An example directory mail source:
13405 (directory :path "/home/user-name/procmail-dir/"
13410 Get mail from a @acronym{POP} server.
13416 The name of the @acronym{POP} server. The default is taken from the
13417 @env{MAILHOST} environment variable.
13420 The port number of the @acronym{POP} server. This can be a number (eg,
13421 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
13422 string, it should be a service name as listed in @file{/etc/services} on
13423 Unix systems. The default is @samp{"pop3"}. On some systems you might
13424 need to specify it as @samp{"pop-3"} instead.
13427 The user name to give to the @acronym{POP} server. The default is the login
13431 The password to give to the @acronym{POP} server. If not specified,
13432 the user is prompted.
13435 The program to use to fetch mail from the @acronym{POP} server. This
13436 should be a @code{format}-like string. Here's an example:
13439 fetchmail %u@@%s -P %p %t
13442 The valid format specifier characters are:
13446 The name of the file the mail is to be moved to. This must always be
13447 included in this string.
13450 The name of the server.
13453 The port number of the server.
13456 The user name to use.
13459 The password to use.
13462 The values used for these specs are taken from the values you give the
13463 corresponding keywords.
13466 A script to be run before fetching the mail. The syntax is the same as
13467 the @code{:program} keyword. This can also be a function to be run.
13470 A script to be run after fetching the mail. The syntax is the same as
13471 the @code{:program} keyword. This can also be a function to be run.
13474 The function to use to fetch mail from the @acronym{POP} server. The
13475 function is called with one parameter---the name of the file where the
13476 mail should be moved to.
13478 @item :authentication
13479 This can be either the symbol @code{password} or the symbol @code{apop}
13480 and says what authentication scheme to use. The default is
13484 What stream to use for connecting to the server, this can be the symbol
13485 @code{ssl}, the symbol @code{tls} or others. The default is @code{nil}
13486 and use insecure connections. Note that for SSL/TLS, you need external
13487 programs and libraries:
13491 @dfn{ssl:} Connect through SSL@. Requires OpenSSL (the program
13492 @samp{openssl}) or SSLeay (@samp{s_client}) as well as the external
13493 library @samp{ssl.el}.
13495 @dfn{starttls:} Connect via the STARTTLS extension (similar to SSL)@.
13496 Requires the external library @samp{starttls.el} and program
13501 Non-@code{nil} if mail is to be left on the server and UIDL used for
13502 message retrieval. The default is @code{nil}.
13506 If the @code{:program} and @code{:function} keywords aren't specified,
13507 @code{pop3-movemail} will be used.
13509 Here are some examples. Fetch from the default @acronym{POP} server,
13510 using the default user name, and default fetcher:
13516 Fetch from a named server with a named user and password:
13519 (pop :server "my.pop.server"
13520 :user "user-name" :password "secret")
13523 Use @samp{movemail} to move the mail:
13526 (pop :program "movemail po:%u %t %p")
13530 Get mail from a maildir. This is a type of mailbox that is supported by
13531 at least qmail and postfix, where each file in a special directory
13532 contains exactly one mail.
13538 The name of the directory where the mails are stored. The default is
13539 taken from the @env{MAILDIR} environment variable or
13542 The subdirectories of the Maildir. The default is
13543 @samp{("new" "cur")}.
13545 @c If you sometimes look at your mail through a pop3 daemon before fetching
13546 @c them with Gnus, you may also have to fetch your mails from the
13547 @c @code{cur} directory inside the maildir, like in the first example
13550 You can also get mails from remote hosts (because maildirs don't suffer
13551 from locking problems).
13555 Two example maildir mail sources:
13558 (maildir :path "/home/user-name/Maildir/"
13559 :subdirs ("cur" "new"))
13563 (maildir :path "/user@@remotehost.org:~/Maildir/"
13568 Get mail from a @acronym{IMAP} server. If you don't want to use
13569 @acronym{IMAP} as intended, as a network mail reading protocol (ie
13570 with nnimap), for some reason or other, Gnus let you treat it similar
13571 to a @acronym{POP} server and fetches articles from a given
13572 @acronym{IMAP} mailbox. @xref{IMAP}, for more information.
13574 Note that for the Kerberos, GSSAPI, @acronym{TLS}/@acronym{SSL} and STARTTLS support you
13575 may need external programs and libraries, @xref{IMAP}.
13581 The name of the @acronym{IMAP} server. The default is taken from the
13582 @env{MAILHOST} environment variable.
13585 The port number of the @acronym{IMAP} server. The default is @samp{143}, or
13586 @samp{993} for @acronym{TLS}/@acronym{SSL} connections.
13589 The user name to give to the @acronym{IMAP} server. The default is the login
13593 The password to give to the @acronym{IMAP} server. If not specified, the user is
13597 What stream to use for connecting to the server, this is one of the
13598 symbols in @code{imap-stream-alist}. Right now, this means
13599 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls},
13600 @samp{ssl}, @samp{shell} or the default @samp{network}.
13602 @item :authentication
13603 Which authenticator to use for authenticating to the server, this is
13604 one of the symbols in @code{imap-authenticator-alist}. Right now,
13605 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
13606 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
13609 When using the `shell' :stream, the contents of this variable is
13610 mapped into the @code{imap-shell-program} variable. This should be a
13611 @code{format}-like string (or list of strings). Here's an example:
13617 The valid format specifier characters are:
13621 The name of the server.
13624 User name from @code{imap-default-user}.
13627 The port number of the server.
13630 The values used for these specs are taken from the values you give the
13631 corresponding keywords.
13634 The name of the mailbox to get mail from. The default is @samp{INBOX}
13635 which normally is the mailbox which receive incoming mail.
13638 The predicate used to find articles to fetch. The default, @samp{UNSEEN
13639 UNDELETED}, is probably the best choice for most people, but if you
13640 sometimes peek in your mailbox with a @acronym{IMAP} client and mark some
13641 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
13642 Then all articles in the mailbox is fetched, no matter what. For a
13643 complete list of predicates, see RFC 2060 section 6.4.4.
13646 How to flag fetched articles on the server, the default @samp{\Deleted}
13647 will mark them as deleted, an alternative would be @samp{\Seen} which
13648 would simply mark them as read. These are the two most likely choices,
13649 but more flags are defined in RFC 2060 section 2.3.2.
13652 If non-@code{nil}, don't remove all articles marked as deleted in the
13653 mailbox after finishing the fetch.
13657 An example @acronym{IMAP} mail source:
13660 (imap :server "mail.mycorp.com"
13662 :fetchflag "\\Seen")
13666 Get mail from a webmail server, such as @uref{http://www.hotmail.com/},
13667 @uref{http://webmail.netscape.com/}, @uref{http://www.netaddress.com/},
13668 @uref{http://mail.yahoo.com/}.
13670 NOTE: Webmail largely depends on cookies. A "one-line-cookie" patch is
13671 required for url "4.0pre.46".
13673 WARNING: Mails may be lost. NO WARRANTY.
13679 The type of the webmail server. The default is @code{hotmail}. The
13680 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
13683 The user name to give to the webmail server. The default is the login
13687 The password to give to the webmail server. If not specified, the user is
13691 If non-@code{nil}, only fetch unread articles and don't move them to
13692 trash folder after finishing the fetch.
13696 An example webmail source:
13699 (webmail :subtype 'hotmail
13701 :password "secret")
13706 @item Common Keywords
13707 Common keywords can be used in any type of mail source.
13713 If non-@code{nil}, fetch the mail even when Gnus is unplugged. If you
13714 use directory source to get mail, you can specify it as in this
13719 '((directory :path "/home/pavel/.Spool/"
13724 Gnus will then fetch your mail even when you are unplugged. This is
13725 useful when you use local mail and news.
13730 @subsubsection Function Interface
13732 Some of the above keywords specify a Lisp function to be executed.
13733 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
13734 the value of the keyword while the function is executing. For example,
13735 consider the following mail-source setting:
13738 (setq mail-sources '((pop :user "jrl"
13739 :server "pophost" :function fetchfunc)))
13742 While the function @code{fetchfunc} is executing, the symbol @code{user}
13743 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
13744 @code{"pophost"}. The symbols @code{port}, @code{password},
13745 @code{program}, @code{prescript}, @code{postscript}, @code{function},
13746 and @code{authentication} are also bound (to their default values).
13748 See above for a list of keywords for each type of mail source.
13751 @node Mail Source Customization
13752 @subsubsection Mail Source Customization
13754 The following is a list of variables that influence how the mail is
13755 fetched. You would normally not need to set or change any of these
13759 @item mail-source-crash-box
13760 @vindex mail-source-crash-box
13761 File where mail will be stored while processing it. The default is@*
13762 @file{~/.emacs-mail-crash-box}.
13764 @item mail-source-delete-incoming
13765 @vindex mail-source-delete-incoming
13766 If non-@code{nil}, delete incoming files after handling them. If
13767 @code{t}, delete the files immediately, if @code{nil}, never delete any
13768 files. If a positive number, delete files older than number of days
13769 (This will only happen, when receiving new mail). You may also set
13770 @code{mail-source-delete-incoming} to @code{nil} and call
13771 @code{mail-source-delete-old-incoming} from a hook or interactively.
13773 @item mail-source-delete-old-incoming-confirm
13774 @vindex mail-source-delete-old-incoming-confirm
13775 If non-@code{nil}, ask for for confirmation before deleting old incoming
13776 files. This variable only applies when
13777 @code{mail-source-delete-incoming} is a positive number.
13779 @item mail-source-ignore-errors
13780 @vindex mail-source-ignore-errors
13781 If non-@code{nil}, ignore errors when reading mail from a mail source.
13783 @item mail-source-directory
13784 @vindex mail-source-directory
13785 Directory where files (if any) will be stored. The default is
13786 @file{~/Mail/}. At present, the only thing this is used for is to say
13787 where the incoming files will be stored if the previous variable is
13790 @item mail-source-incoming-file-prefix
13791 @vindex mail-source-incoming-file-prefix
13792 Prefix for file name for storing incoming mail. The default is
13793 @file{Incoming}, in which case files will end up with names like
13794 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
13795 relevant if @code{mail-source-delete-incoming} is @code{nil}.
13797 @item mail-source-default-file-modes
13798 @vindex mail-source-default-file-modes
13799 All new mail files will get this file mode. The default is 384.
13801 @item mail-source-movemail-program
13802 @vindex mail-source-movemail-program
13803 If non-@code{nil}, name of program for fetching new mail. If
13804 @code{nil}, @code{movemail} in @var{exec-directory}.
13809 @node Fetching Mail
13810 @subsubsection Fetching Mail
13812 @vindex mail-sources
13813 @vindex nnmail-spool-file
13814 The way to actually tell Gnus where to get new mail from is to set
13815 @code{mail-sources} to a list of mail source specifiers
13816 (@pxref{Mail Source Specifiers}).
13818 If this variable (and the obsolescent @code{nnmail-spool-file}) is
13819 @code{nil}, the mail back ends will never attempt to fetch mail by
13822 If you want to fetch mail both from your local spool as well as a
13823 @acronym{POP} mail server, you'd say something like:
13828 (pop :server "pop3.mail.server"
13829 :password "secret")))
13832 Or, if you don't want to use any of the keyword defaults:
13836 '((file :path "/var/spool/mail/user-name")
13837 (pop :server "pop3.mail.server"
13840 :password "secret")))
13844 When you use a mail back end, Gnus will slurp all your mail from your
13845 inbox and plonk it down in your home directory. Gnus doesn't move any
13846 mail if you're not using a mail back end---you have to do a lot of magic
13847 invocations first. At the time when you have finished drawing the
13848 pentagram, lightened the candles, and sacrificed the goat, you really
13849 shouldn't be too surprised when Gnus moves your mail.
13853 @node Mail Back End Variables
13854 @subsection Mail Back End Variables
13856 These variables are (for the most part) pertinent to all the various
13860 @vindex nnmail-read-incoming-hook
13861 @item nnmail-read-incoming-hook
13862 The mail back ends all call this hook after reading new mail. You can
13863 use this hook to notify any mail watch programs, if you want to.
13865 @vindex nnmail-split-hook
13866 @item nnmail-split-hook
13867 @findex gnus-article-decode-encoded-words
13868 @cindex RFC 1522 decoding
13869 @cindex RFC 2047 decoding
13870 Hook run in the buffer where the mail headers of each message is kept
13871 just before the splitting based on these headers is done. The hook is
13872 free to modify the buffer contents in any way it sees fit---the buffer
13873 is discarded after the splitting has been done, and no changes performed
13874 in the buffer will show up in any files.
13875 @code{gnus-article-decode-encoded-words} is one likely function to add
13878 @vindex nnmail-pre-get-new-mail-hook
13879 @vindex nnmail-post-get-new-mail-hook
13880 @item nnmail-pre-get-new-mail-hook
13881 @itemx nnmail-post-get-new-mail-hook
13882 These are two useful hooks executed when treating new incoming
13883 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
13884 starting to handle the new mail) and
13885 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
13886 is done). Here's and example of using these two hooks to change the
13887 default file modes the new mail files get:
13890 (add-hook 'nnmail-pre-get-new-mail-hook
13891 (lambda () (set-default-file-modes 511)))
13893 (add-hook 'nnmail-post-get-new-mail-hook
13894 (lambda () (set-default-file-modes 551)))
13897 @item nnmail-use-long-file-names
13898 @vindex nnmail-use-long-file-names
13899 If non-@code{nil}, the mail back ends will use long file and directory
13900 names. Groups like @samp{mail.misc} will end up in directories
13901 (assuming use of @code{nnml} back end) or files (assuming use of
13902 @code{nnfolder} back end) like @file{mail.misc}. If it is @code{nil},
13903 the same group will end up in @file{mail/misc}.
13905 @item nnmail-delete-file-function
13906 @vindex nnmail-delete-file-function
13907 @findex delete-file
13908 Function called to delete files. It is @code{delete-file} by default.
13910 @item nnmail-cache-accepted-message-ids
13911 @vindex nnmail-cache-accepted-message-ids
13912 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
13913 the back end (via @code{Gcc}, for instance) into the mail duplication
13914 discovery cache. The default is @code{nil}.
13916 @item nnmail-cache-ignore-groups
13917 @vindex nnmail-cache-ignore-groups
13918 This can be a regular expression or a list of regular expressions.
13919 Group names that match any of the regular expressions will never be
13920 recorded in the @code{Message-ID} cache.
13922 This can be useful, for example, when using Fancy Splitting
13923 (@pxref{Fancy Mail Splitting}) together with the function
13924 @code{nnmail-split-fancy-with-parent}.
13929 @node Fancy Mail Splitting
13930 @subsection Fancy Mail Splitting
13931 @cindex mail splitting
13932 @cindex fancy mail splitting
13934 @vindex nnmail-split-fancy
13935 @findex nnmail-split-fancy
13936 If the rather simple, standard method for specifying how to split mail
13937 doesn't allow you to do what you want, you can set
13938 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
13939 play with the @code{nnmail-split-fancy} variable.
13941 Let's look at an example value of this variable first:
13944 ;; @r{Messages from the mailer daemon are not crossposted to any of}
13945 ;; @r{the ordinary groups. Warnings are put in a separate group}
13946 ;; @r{from real errors.}
13947 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
13949 ;; @r{Non-error messages are crossposted to all relevant}
13950 ;; @r{groups, but we don't crosspost between the group for the}
13951 ;; @r{(ding) list and the group for other (ding) related mail.}
13952 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
13953 ("subject" "ding" "ding.misc"))
13954 ;; @r{Other mailing lists@dots{}}
13955 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
13956 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
13957 ;; @r{Both lists below have the same suffix, so prevent}
13958 ;; @r{cross-posting to mkpkg.list of messages posted only to}
13959 ;; @r{the bugs- list, but allow cross-posting when the}
13960 ;; @r{message was really cross-posted.}
13961 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
13962 (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
13963 ;; @r{People@dots{}}
13964 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
13965 ;; @r{Unmatched mail goes to the catch all group.}
13969 This variable has the format of a @dfn{split}. A split is a
13970 (possibly) recursive structure where each split may contain other
13971 splits. Here are the possible split syntaxes:
13976 If the split is a string, that will be taken as a group name. Normal
13977 regexp match expansion will be done. See below for examples.
13979 @item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split})
13980 If the split is a list, the first element of which is a string, then
13981 store the message as specified by @var{split}, if header @var{field}
13982 (a regexp) contains @var{value} (also a regexp). If @var{restrict}
13983 (yet another regexp) matches some string after @var{field} and before
13984 the end of the matched @var{value}, the @var{split} is ignored. If
13985 none of the @var{restrict} clauses match, @var{split} is processed.
13987 @item (| @var{split} @dots{})
13988 If the split is a list, and the first element is @code{|} (vertical
13989 bar), then process each @var{split} until one of them matches. A
13990 @var{split} is said to match if it will cause the mail message to be
13991 stored in one or more groups.
13993 @item (& @var{split} @dots{})
13994 If the split is a list, and the first element is @code{&}, then
13995 process all @var{split}s in the list.
13998 If the split is the symbol @code{junk}, then don't save (i.e., delete)
13999 this message. Use with extreme caution.
14001 @item (: @var{function} @var{arg1} @var{arg2} @dots{})
14002 If the split is a list, and the first element is @samp{:}, then the
14003 second element will be called as a function with @var{args} given as
14004 arguments. The function should return a @var{split}.
14007 For instance, the following function could be used to split based on the
14008 body of the messages:
14011 (defun split-on-body ()
14015 (goto-char (point-min))
14016 (when (re-search-forward "Some.*string" nil t)
14020 The buffer is narrowed to the message in question when @var{function}
14021 is run. That's why @code{(widen)} needs to be called after
14022 @code{save-excursion} and @code{save-restriction} in the example
14023 above. Also note that with the nnimap backend, message bodies will
14024 not be downloaded by default. You need to set
14025 @code{nnimap-split-download-body} to @code{t} to do that
14026 (@pxref{Splitting in IMAP}).
14028 @item (! @var{func} @var{split})
14029 If the split is a list, and the first element is @code{!}, then
14030 @var{split} will be processed, and @var{func} will be called as a
14031 function with the result of @var{split} as argument. @var{func}
14032 should return a split.
14035 If the split is @code{nil}, it is ignored.
14039 In these splits, @var{field} must match a complete field name.
14040 @var{value} must match a complete word according to the fundamental mode
14041 syntax table. You can use @code{.*} in the regexps to match partial
14042 field names or words. In other words, all @var{value}'s are wrapped in
14043 @samp{\<} and @samp{\>} pairs.
14045 @vindex nnmail-split-abbrev-alist
14046 @var{field} and @var{value} can also be Lisp symbols, in that case
14047 they are expanded as specified by the variable
14048 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells,
14049 where the @sc{car} of a cell contains the key, and the @sc{cdr}
14050 contains the associated value. Predefined entries in
14051 @code{nnmail-split-abbrev-alist} include:
14055 Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields.
14057 Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To},
14058 @samp{Resent-To} and @samp{Resent-Cc} fields.
14060 Is the union of the @code{from} and @code{to} entries.
14063 @vindex nnmail-split-fancy-syntax-table
14064 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
14065 when all this splitting is performed.
14067 If you want to have Gnus create groups dynamically based on some
14068 information in the headers (i.e., do @code{replace-match}-like
14069 substitutions in the group names), you can say things like:
14072 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
14075 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
14076 will be filed in @samp{mail.debian.foo}.
14078 If the string contains the element @samp{\&}, then the previously
14079 matched string will be substituted. Similarly, the elements @samp{\\1}
14080 up to @samp{\\9} will be substituted with the text matched by the
14081 groupings 1 through 9.
14083 @vindex nnmail-split-fancy-match-partial-words
14084 @code{nnmail-split-fancy-match-partial-words} controls whether partial
14085 words are matched during fancy splitting.
14087 Normally, regular expressions given in @code{nnmail-split-fancy} are
14088 implicitly surrounded by @code{\<...\>} markers, which are word
14089 delimiters. If this variable is true, they are not implicitly
14090 surrounded by anything.
14093 (any "joe" "joemail")
14096 In this example, messages sent from @samp{joedavis@@foo.org} will
14097 normally not be filed in @samp{joemail}. With
14098 @code{nnmail-split-fancy-match-partial-words} set to t, however, the
14099 match will happen. In effect, the requirement of a word boundary is
14100 removed and instead the match becomes more like a grep.
14102 @findex nnmail-split-fancy-with-parent
14103 @code{nnmail-split-fancy-with-parent} is a function which allows you to
14104 split followups into the same groups their parents are in. Sometimes
14105 you can't make splitting rules for all your mail. For example, your
14106 boss might send you personal mail regarding different projects you are
14107 working on, and as you can't tell your boss to put a distinguishing
14108 string into the subject line, you have to resort to manually moving the
14109 messages into the right group. With this function, you only have to do
14110 it once per thread.
14112 To use this feature, you have to set @code{nnmail-treat-duplicates}
14113 and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil}
14114 value. And then you can include @code{nnmail-split-fancy-with-parent}
14115 using the colon feature, like so:
14117 (setq nnmail-treat-duplicates 'warn ; @r{or @code{delete}}
14118 nnmail-cache-accepted-message-ids t
14120 '(| (: nnmail-split-fancy-with-parent)
14121 ;; @r{other splits go here}
14125 This feature works as follows: when @code{nnmail-treat-duplicates} is
14126 non-@code{nil}, Gnus records the message id of every message it sees
14127 in the file specified by the variable
14128 @code{nnmail-message-id-cache-file}, together with the group it is in
14129 (the group is omitted for non-mail messages). When mail splitting is
14130 invoked, the function @code{nnmail-split-fancy-with-parent} then looks
14131 at the References (and In-Reply-To) header of each message to split
14132 and searches the file specified by @code{nnmail-message-id-cache-file}
14133 for the message ids. When it has found a parent, it returns the
14134 corresponding group name unless the group name matches the regexp
14135 @code{nnmail-split-fancy-with-parent-ignore-groups}. It is
14136 recommended that you set @code{nnmail-message-id-cache-length} to a
14137 somewhat higher number than the default so that the message ids are
14138 still in the cache. (A value of 5000 appears to create a file some
14139 300 kBytes in size.)
14140 @vindex nnmail-cache-accepted-message-ids
14141 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
14142 also records the message ids of moved articles, so that the followup
14143 messages goes into the new group.
14145 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
14146 want certain groups to be recorded in the cache. For example, if all
14147 outgoing messages are written to an ``outgoing'' group, you could set
14148 @code{nnmail-cache-ignore-groups} to match that group name.
14149 Otherwise, answers to all your messages would end up in the
14150 ``outgoing'' group.
14153 @node Group Mail Splitting
14154 @subsection Group Mail Splitting
14155 @cindex mail splitting
14156 @cindex group mail splitting
14158 @findex gnus-group-split
14159 If you subscribe to dozens of mailing lists but you don't want to
14160 maintain mail splitting rules manually, group mail splitting is for you.
14161 You just have to set @code{to-list} and/or @code{to-address} in group
14162 parameters or group customization and set @code{nnmail-split-methods} to
14163 @code{gnus-group-split}. This splitting function will scan all groups
14164 for those parameters and split mail accordingly, i.e., messages posted
14165 from or to the addresses specified in the parameters @code{to-list} or
14166 @code{to-address} of a mail group will be stored in that group.
14168 Sometimes, mailing lists have multiple addresses, and you may want mail
14169 splitting to recognize them all: just set the @code{extra-aliases} group
14170 parameter to the list of additional addresses and it's done. If you'd
14171 rather use a regular expression, set @code{split-regexp}.
14173 All these parameters in a group will be used to create an
14174 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
14175 the @var{value} is a single regular expression that matches
14176 @code{to-list}, @code{to-address}, all of @code{extra-aliases} and all
14177 matches of @code{split-regexp}, and the @var{split} is the name of the
14178 group. @var{restrict}s are also supported: just set the
14179 @code{split-exclude} parameter to a list of regular expressions.
14181 If you can't get the right split to be generated using all these
14182 parameters, or you just need something fancier, you can set the
14183 parameter @code{split-spec} to an @code{nnmail-split-fancy} split. In
14184 this case, all other aforementioned parameters will be ignored by
14185 @code{gnus-group-split}. In particular, @code{split-spec} may be set to
14186 @code{nil}, in which case the group will be ignored by
14187 @code{gnus-group-split}.
14189 @vindex gnus-group-split-default-catch-all-group
14190 @code{gnus-group-split} will do cross-posting on all groups that match,
14191 by defining a single @code{&} fancy split containing one split for each
14192 group. If a message doesn't match any split, it will be stored in the
14193 group named in @code{gnus-group-split-default-catch-all-group}, unless
14194 some group has @code{split-spec} set to @code{catch-all}, in which case
14195 that group is used as the catch-all group. Even though this variable is
14196 often used just to name a group, it may also be set to an arbitrarily
14197 complex fancy split (after all, a group name is a fancy split), and this
14198 may be useful to split mail that doesn't go to any mailing list to
14199 personal mail folders. Note that this fancy split is added as the last
14200 element of a @code{|} split list that also contains a @code{&} split
14201 with the rules extracted from group parameters.
14203 It's time for an example. Assume the following group parameters have
14208 ((to-address . "bar@@femail.com")
14209 (split-regexp . ".*@@femail\\.com"))
14211 ((to-list . "foo@@nowhere.gov")
14212 (extra-aliases "foo@@localhost" "foo-redist@@home")
14213 (split-exclude "bugs-foo" "rambling-foo")
14214 (admin-address . "foo-request@@nowhere.gov"))
14216 ((split-spec . catch-all))
14219 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
14220 behave as if @code{nnmail-split-fancy} had been selected and variable
14221 @code{nnmail-split-fancy} had been set as follows:
14224 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
14225 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
14226 - "bugs-foo" - "rambling-foo" "mail.foo"))
14230 @findex gnus-group-split-fancy
14231 If you'd rather not use group splitting for all your mail groups, you
14232 may use it for only some of them, by using @code{nnmail-split-fancy}
14236 (: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all})
14239 @var{groups} may be a regular expression or a list of group names whose
14240 parameters will be scanned to generate the output split.
14241 @var{no-crosspost} can be used to disable cross-posting; in this case, a
14242 single @code{|} split will be output. @var{catch-all} is the fall back
14243 fancy split, used like @code{gnus-group-split-default-catch-all-group}.
14244 If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the
14245 empty string in any selected group, no catch-all split will be issued.
14246 Otherwise, if some group has @code{split-spec} set to @code{catch-all},
14247 this group will override the value of the @var{catch-all} argument.
14249 @findex gnus-group-split-setup
14250 Unfortunately, scanning all groups and their parameters can be quite
14251 slow, especially considering that it has to be done for every message.
14252 But don't despair! The function @code{gnus-group-split-setup} can be
14253 used to enable @code{gnus-group-split} in a much more efficient way. It
14254 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
14255 @code{nnmail-split-fancy} to the split produced by
14256 @code{gnus-group-split-fancy}. Thus, the group parameters are only
14257 scanned once, no matter how many messages are split.
14259 @findex gnus-group-split-update
14260 However, if you change group parameters, you'd have to update
14261 @code{nnmail-split-fancy} manually. You can do it by running
14262 @code{gnus-group-split-update}. If you'd rather have it updated
14263 automatically, just tell @code{gnus-group-split-setup} to do it for
14264 you. For example, add to your @file{~/.gnus.el}:
14267 (gnus-group-split-setup @var{auto-update} @var{catch-all})
14270 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
14271 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
14272 have to worry about updating @code{nnmail-split-fancy} again. If you
14273 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
14274 @code{gnus-group-split-default-catch-all-group} will be set to its
14277 @vindex gnus-group-split-updated-hook
14278 Because you may want to change @code{nnmail-split-fancy} after it is set
14279 by @code{gnus-group-split-update}, this function will run
14280 @code{gnus-group-split-updated-hook} just before finishing.
14282 @node Incorporating Old Mail
14283 @subsection Incorporating Old Mail
14284 @cindex incorporating old mail
14285 @cindex import old mail
14287 Most people have lots of old mail stored in various file formats. If
14288 you have set up Gnus to read mail using one of the spiffy Gnus mail
14289 back ends, you'll probably wish to have that old mail incorporated into
14292 Doing so can be quite easy.
14294 To take an example: You're reading mail using @code{nnml}
14295 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
14296 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
14297 file filled with important, but old, mail. You want to move it into
14298 your @code{nnml} groups.
14304 Go to the group buffer.
14307 Type @kbd{G f} and give the file name to the mbox file when prompted to create an
14308 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
14311 Type @kbd{SPACE} to enter the newly created group.
14314 Type @kbd{M P b} to process-mark all articles in this group's buffer
14315 (@pxref{Setting Process Marks}).
14318 Type @kbd{B r} to respool all the process-marked articles, and answer
14319 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
14322 All the mail messages in the mbox file will now also be spread out over
14323 all your @code{nnml} groups. Try entering them and check whether things
14324 have gone without a glitch. If things look ok, you may consider
14325 deleting the mbox file, but I wouldn't do that unless I was absolutely
14326 sure that all the mail has ended up where it should be.
14328 Respooling is also a handy thing to do if you're switching from one mail
14329 back end to another. Just respool all the mail in the old mail groups
14330 using the new mail back end.
14333 @node Expiring Mail
14334 @subsection Expiring Mail
14335 @cindex article expiry
14337 Traditional mail readers have a tendency to remove mail articles when
14338 you mark them as read, in some way. Gnus takes a fundamentally
14339 different approach to mail reading.
14341 Gnus basically considers mail just to be news that has been received in
14342 a rather peculiar manner. It does not think that it has the power to
14343 actually change the mail, or delete any mail messages. If you enter a
14344 mail group, and mark articles as ``read'', or kill them in some other
14345 fashion, the mail articles will still exist on the system. I repeat:
14346 Gnus will not delete your old, read mail. Unless you ask it to, of
14349 To make Gnus get rid of your unwanted mail, you have to mark the
14350 articles as @dfn{expirable}. (With the default key bindings, this means
14351 that you have to type @kbd{E}.) This does not mean that the articles
14352 will disappear right away, however. In general, a mail article will be
14353 deleted from your system if, 1) it is marked as expirable, AND 2) it is
14354 more than one week old. If you do not mark an article as expirable, it
14355 will remain on your system until hell freezes over. This bears
14356 repeating one more time, with some spurious capitalizations: IF you do
14357 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
14359 You do not have to mark articles as expirable by hand. Gnus provides
14360 two features, called ``auto-expire'' and ``total-expire'', that can help you
14361 with this. In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E}
14362 for you when you select an article. And ``total-expire'' means that Gnus
14363 considers all articles as expirable that are read. So, in addition to
14364 the articles marked @samp{E}, also the articles marked @samp{r},
14365 @samp{R}, @samp{O}, @samp{K}, @samp{Y} and so on are considered
14368 When should either auto-expire or total-expire be used? Most people
14369 who are subscribed to mailing lists split each list into its own group
14370 and then turn on auto-expire or total-expire for those groups.
14371 (@xref{Splitting Mail}, for more information on splitting each list
14372 into its own group.)
14374 Which one is better, auto-expire or total-expire? It's not easy to
14375 answer. Generally speaking, auto-expire is probably faster. Another
14376 advantage of auto-expire is that you get more marks to work with: for
14377 the articles that are supposed to stick around, you can still choose
14378 between tick and dormant and read marks. But with total-expire, you
14379 only have dormant and ticked to choose from. The advantage of
14380 total-expire is that it works well with adaptive scoring (@pxref{Adaptive
14381 Scoring}). Auto-expire works with normal scoring but not with adaptive
14384 @vindex gnus-auto-expirable-newsgroups
14385 Groups that match the regular expression
14386 @code{gnus-auto-expirable-newsgroups} will have all articles that you
14387 read marked as expirable automatically. All articles marked as
14388 expirable have an @samp{E} in the first column in the summary buffer.
14390 By default, if you have auto expiry switched on, Gnus will mark all the
14391 articles you read as expirable, no matter if they were read or unread
14392 before. To avoid having articles marked as read marked as expirable
14393 automatically, you can put something like the following in your
14394 @file{~/.gnus.el} file:
14396 @vindex gnus-mark-article-hook
14398 (remove-hook 'gnus-mark-article-hook
14399 'gnus-summary-mark-read-and-unread-as-read)
14400 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
14403 Note that making a group auto-expirable doesn't mean that all read
14404 articles are expired---only the articles marked as expirable
14405 will be expired. Also note that using the @kbd{d} command won't make
14406 articles expirable---only semi-automatic marking of articles as read will
14407 mark the articles as expirable in auto-expirable groups.
14409 Let's say you subscribe to a couple of mailing lists, and you want the
14410 articles you have read to disappear after a while:
14413 (setq gnus-auto-expirable-newsgroups
14414 "mail.nonsense-list\\|mail.nice-list")
14417 Another way to have auto-expiry happen is to have the element
14418 @code{auto-expire} in the group parameters of the group.
14420 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
14421 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
14422 don't really mix very well.
14424 @vindex nnmail-expiry-wait
14425 The @code{nnmail-expiry-wait} variable supplies the default time an
14426 expirable article has to live. Gnus starts counting days from when the
14427 message @emph{arrived}, not from when it was sent. The default is seven
14430 Gnus also supplies a function that lets you fine-tune how long articles
14431 are to live, based on what group they are in. Let's say you want to
14432 have one month expiry period in the @samp{mail.private} group, a one day
14433 expiry period in the @samp{mail.junk} group, and a six day expiry period
14436 @vindex nnmail-expiry-wait-function
14438 (setq nnmail-expiry-wait-function
14440 (cond ((string= group "mail.private")
14442 ((string= group "mail.junk")
14444 ((string= group "important")
14450 The group names this function is fed are ``unadorned'' group
14451 names---no @samp{nnml:} prefixes and the like.
14453 The @code{nnmail-expiry-wait} variable and
14454 @code{nnmail-expiry-wait-function} function can either be a number (not
14455 necessarily an integer) or one of the symbols @code{immediate} or
14458 You can also use the @code{expiry-wait} group parameter to selectively
14459 change the expiry period (@pxref{Group Parameters}).
14461 @vindex nnmail-expiry-target
14462 The normal action taken when expiring articles is to delete them.
14463 However, in some circumstances it might make more sense to move them
14464 to other groups instead of deleting them. The variable
14465 @code{nnmail-expiry-target} (and the @code{expiry-target} group
14466 parameter) controls this. The variable supplies a default value for
14467 all groups, which can be overridden for specific groups by the group
14468 parameter. default value is @code{delete}, but this can also be a
14469 string (which should be the name of the group the message should be
14470 moved to), or a function (which will be called in a buffer narrowed to
14471 the message in question, and with the name of the group being moved
14472 from as its parameter) which should return a target---either a group
14473 name or @code{delete}.
14475 Here's an example for specifying a group name:
14477 (setq nnmail-expiry-target "nnml:expired")
14480 @findex nnmail-fancy-expiry-target
14481 @vindex nnmail-fancy-expiry-targets
14482 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
14483 expire mail to groups according to the variable
14484 @code{nnmail-fancy-expiry-targets}. Here's an example:
14487 (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
14488 nnmail-fancy-expiry-targets
14489 '((to-from "boss" "nnfolder:Work")
14490 ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
14491 ("from" ".*" "nnfolder:Archive-%Y")))
14494 With this setup, any mail that has @code{IMPORTANT} in its Subject
14495 header and was sent in the year @code{YYYY} and month @code{MMM}, will
14496 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
14497 From or To header contains the string @code{boss}, it will get expired
14498 to @code{nnfolder:Work}. All other mail will get expired to
14499 @code{nnfolder:Archive-YYYY}.
14501 @vindex nnmail-keep-last-article
14502 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
14503 expire the final article in a mail newsgroup. This is to make life
14504 easier for procmail users.
14506 @vindex gnus-total-expirable-newsgroups
14507 By the way: That line up there, about Gnus never expiring non-expirable
14508 articles, is a lie. If you put @code{total-expire} in the group
14509 parameters, articles will not be marked as expirable, but all read
14510 articles will be put through the expiry process. Use with extreme
14511 caution. Even more dangerous is the
14512 @code{gnus-total-expirable-newsgroups} variable. All groups that match
14513 this regexp will have all read articles put through the expiry process,
14514 which means that @emph{all} old mail articles in the groups in question
14515 will be deleted after a while. Use with extreme caution, and don't come
14516 crying to me when you discover that the regexp you used matched the
14517 wrong group and all your important mail has disappeared. Be a
14518 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
14521 Most people make most of their mail groups total-expirable, though.
14523 @vindex gnus-inhibit-user-auto-expire
14524 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
14525 commands will not mark an article as expirable, even if the group has
14526 auto-expire turned on.
14530 @subsection Washing Mail
14531 @cindex mail washing
14532 @cindex list server brain damage
14533 @cindex incoming mail treatment
14535 Mailers and list servers are notorious for doing all sorts of really,
14536 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
14537 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
14538 end of all lines passing through our server, so let's do that!!!!1!''
14539 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
14540 considered to be self-evident were not discussed. So. Here we are.
14542 Case in point: The German version of Microsoft Exchange adds @samp{AW:
14543 } to the subjects of replies instead of @samp{Re: }. I could pretend to
14544 be shocked and dismayed by this, but I haven't got the energy. It is to
14547 Gnus provides a plethora of functions for washing articles while
14548 displaying them, but it might be nicer to do the filtering before
14549 storing the mail to disk. For that purpose, we have three hooks and
14550 various functions that can be put in these hooks.
14553 @item nnmail-prepare-incoming-hook
14554 @vindex nnmail-prepare-incoming-hook
14555 This hook is called before doing anything with the mail and is meant for
14556 grand, sweeping gestures. It is called in a buffer that contains all
14557 the new, incoming mail. Functions to be used include:
14560 @item nnheader-ms-strip-cr
14561 @findex nnheader-ms-strip-cr
14562 Remove trailing carriage returns from each line. This is default on
14563 Emacs running on MS machines.
14567 @item nnmail-prepare-incoming-header-hook
14568 @vindex nnmail-prepare-incoming-header-hook
14569 This hook is called narrowed to each header. It can be used when
14570 cleaning up the headers. Functions that can be used include:
14573 @item nnmail-remove-leading-whitespace
14574 @findex nnmail-remove-leading-whitespace
14575 Clear leading white space that ``helpful'' listservs have added to the
14576 headers to make them look nice. Aaah.
14578 (Note that this function works on both the header on the body of all
14579 messages, so it is a potentially dangerous function to use (if a body
14580 of a message contains something that looks like a header line). So
14581 rather than fix the bug, it is of course the right solution to make it
14582 into a feature by documenting it.)
14584 @item nnmail-remove-list-identifiers
14585 @findex nnmail-remove-list-identifiers
14586 Some list servers add an identifier---for example, @samp{(idm)}---to the
14587 beginning of all @code{Subject} headers. I'm sure that's nice for
14588 people who use stone age mail readers. This function will remove
14589 strings that match the @code{nnmail-list-identifiers} regexp, which can
14590 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
14593 For instance, if you want to remove the @samp{(idm)} and the
14594 @samp{nagnagnag} identifiers:
14597 (setq nnmail-list-identifiers
14598 '("(idm)" "nagnagnag"))
14601 This can also be done non-destructively with
14602 @code{gnus-list-identifiers}, @xref{Article Hiding}.
14604 @item nnmail-remove-tabs
14605 @findex nnmail-remove-tabs
14606 Translate all @samp{TAB} characters into @samp{SPACE} characters.
14608 @item nnmail-fix-eudora-headers
14609 @findex nnmail-fix-eudora-headers
14611 Eudora produces broken @code{References} headers, but OK
14612 @code{In-Reply-To} headers. This function will get rid of the
14613 @code{References} headers.
14617 @item nnmail-prepare-incoming-message-hook
14618 @vindex nnmail-prepare-incoming-message-hook
14619 This hook is called narrowed to each message. Functions to be used
14623 @item article-de-quoted-unreadable
14624 @findex article-de-quoted-unreadable
14625 Decode Quoted Readable encoding.
14632 @subsection Duplicates
14634 @vindex nnmail-treat-duplicates
14635 @vindex nnmail-message-id-cache-length
14636 @vindex nnmail-message-id-cache-file
14637 @cindex duplicate mails
14638 If you are a member of a couple of mailing lists, you will sometimes
14639 receive two copies of the same mail. This can be quite annoying, so
14640 @code{nnmail} checks for and treats any duplicates it might find. To do
14641 this, it keeps a cache of old @code{Message-ID}s---
14642 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
14643 default. The approximate maximum number of @code{Message-ID}s stored
14644 there is controlled by the @code{nnmail-message-id-cache-length}
14645 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
14646 stored.) If all this sounds scary to you, you can set
14647 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
14648 default), and @code{nnmail} won't delete duplicate mails. Instead it
14649 will insert a warning into the head of the mail saying that it thinks
14650 that this is a duplicate of a different message.
14652 This variable can also be a function. If that's the case, the function
14653 will be called from a buffer narrowed to the message in question with
14654 the @code{Message-ID} as a parameter. The function must return either
14655 @code{nil}, @code{warn}, or @code{delete}.
14657 You can turn this feature off completely by setting the variable to
14660 If you want all the duplicate mails to be put into a special
14661 @dfn{duplicates} group, you could do that using the normal mail split
14665 (setq nnmail-split-fancy
14666 '(| ;; @r{Messages duplicates go to a separate group.}
14667 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
14668 ;; @r{Message from daemons, postmaster, and the like to another.}
14669 (any mail "mail.misc")
14670 ;; @r{Other rules.}
14676 (setq nnmail-split-methods
14677 '(("duplicates" "^Gnus-Warning:.*duplicate")
14678 ;; @r{Other rules.}
14682 Here's a neat feature: If you know that the recipient reads her mail
14683 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
14684 @code{delete}, you can send her as many insults as you like, just by
14685 using a @code{Message-ID} of a mail that you know that she's already
14686 received. Think of all the fun! She'll never see any of it! Whee!
14689 @node Not Reading Mail
14690 @subsection Not Reading Mail
14692 If you start using any of the mail back ends, they have the annoying
14693 habit of assuming that you want to read mail with them. This might not
14694 be unreasonable, but it might not be what you want.
14696 If you set @code{mail-sources} and @code{nnmail-spool-file} to
14697 @code{nil}, none of the back ends will ever attempt to read incoming
14698 mail, which should help.
14700 @vindex nnbabyl-get-new-mail
14701 @vindex nnmbox-get-new-mail
14702 @vindex nnml-get-new-mail
14703 @vindex nnmh-get-new-mail
14704 @vindex nnfolder-get-new-mail
14705 This might be too much, if, for instance, you are reading mail quite
14706 happily with @code{nnml} and just want to peek at some old Rmail
14707 file you have stashed away with @code{nnbabyl}. All back ends have
14708 variables called back-end-@code{get-new-mail}. If you want to disable
14709 the @code{nnbabyl} mail reading, you edit the virtual server for the
14710 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
14712 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
14713 narrowed to the article to be saved before saving it when reading
14717 @node Choosing a Mail Back End
14718 @subsection Choosing a Mail Back End
14720 Gnus will read the mail spool when you activate a mail group. The mail
14721 file is first copied to your home directory. What happens after that
14722 depends on what format you want to store your mail in.
14724 There are six different mail back ends in the standard Gnus, and more
14725 back ends are available separately. The mail back end most people use
14726 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
14730 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
14731 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
14732 * Mail Spool:: Store your mail in a private spool?
14733 * MH Spool:: An mhspool-like back end.
14734 * Maildir:: Another one-file-per-message format.
14735 * Mail Folders:: Having one file for each group.
14736 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
14740 @node Unix Mail Box
14741 @subsubsection Unix Mail Box
14743 @cindex unix mail box
14745 @vindex nnmbox-active-file
14746 @vindex nnmbox-mbox-file
14747 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
14748 mail. @code{nnmbox} will add extra headers to each mail article to say
14749 which group it belongs in.
14751 Virtual server settings:
14754 @item nnmbox-mbox-file
14755 @vindex nnmbox-mbox-file
14756 The name of the mail box in the user's home directory. Default is
14759 @item nnmbox-active-file
14760 @vindex nnmbox-active-file
14761 The name of the active file for the mail box. Default is
14762 @file{~/.mbox-active}.
14764 @item nnmbox-get-new-mail
14765 @vindex nnmbox-get-new-mail
14766 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
14767 into groups. Default is @code{t}.
14772 @subsubsection Rmail Babyl
14776 @vindex nnbabyl-active-file
14777 @vindex nnbabyl-mbox-file
14778 The @dfn{nnbabyl} back end will use a Babyl mail box (aka. @dfn{Rmail
14779 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
14780 mail article to say which group it belongs in.
14782 Virtual server settings:
14785 @item nnbabyl-mbox-file
14786 @vindex nnbabyl-mbox-file
14787 The name of the Rmail mbox file. The default is @file{~/RMAIL}
14789 @item nnbabyl-active-file
14790 @vindex nnbabyl-active-file
14791 The name of the active file for the rmail box. The default is
14792 @file{~/.rmail-active}
14794 @item nnbabyl-get-new-mail
14795 @vindex nnbabyl-get-new-mail
14796 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
14802 @subsubsection Mail Spool
14804 @cindex mail @acronym{NOV} spool
14806 The @dfn{nnml} spool mail format isn't compatible with any other known
14807 format. It should be used with some caution.
14809 @vindex nnml-directory
14810 If you use this back end, Gnus will split all incoming mail into files,
14811 one file for each mail, and put the articles into the corresponding
14812 directories under the directory specified by the @code{nnml-directory}
14813 variable. The default value is @file{~/Mail/}.
14815 You do not have to create any directories beforehand; Gnus will take
14818 If you have a strict limit as to how many files you are allowed to store
14819 in your account, you should not use this back end. As each mail gets its
14820 own file, you might very well occupy thousands of inodes within a few
14821 weeks. If this is no problem for you, and it isn't a problem for you
14822 having your friendly systems administrator walking around, madly,
14823 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
14824 know that this is probably the fastest format to use. You do not have
14825 to trudge through a big mbox file just to read your new mail.
14827 @code{nnml} is probably the slowest back end when it comes to article
14828 splitting. It has to create lots of files, and it also generates
14829 @acronym{NOV} databases for the incoming mails. This makes it possibly the
14830 fastest back end when it comes to reading mail.
14832 @cindex self contained nnml servers
14834 When the marks file is used (which it is by default), @code{nnml}
14835 servers have the property that you may backup them using @code{tar} or
14836 similar, and later be able to restore them into Gnus (by adding the
14837 proper @code{nnml} server) and have all your marks be preserved. Marks
14838 for a group is usually stored in the @code{.marks} file (but see
14839 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
14840 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
14841 to restore the group (after restoring the backup into the nnml
14844 If for some reason you believe your @file{.marks} files are screwed
14845 up, you can just delete them all. Gnus will then correctly regenerate
14846 them next time it starts.
14848 Virtual server settings:
14851 @item nnml-directory
14852 @vindex nnml-directory
14853 All @code{nnml} directories will be placed under this directory. The
14854 default is the value of @code{message-directory} (whose default value
14857 @item nnml-active-file
14858 @vindex nnml-active-file
14859 The active file for the @code{nnml} server. The default is
14860 @file{~/Mail/active}.
14862 @item nnml-newsgroups-file
14863 @vindex nnml-newsgroups-file
14864 The @code{nnml} group descriptions file. @xref{Newsgroups File
14865 Format}. The default is @file{~/Mail/newsgroups}.
14867 @item nnml-get-new-mail
14868 @vindex nnml-get-new-mail
14869 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
14872 @item nnml-nov-is-evil
14873 @vindex nnml-nov-is-evil
14874 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
14875 default is @code{nil}.
14877 @item nnml-nov-file-name
14878 @vindex nnml-nov-file-name
14879 The name of the @acronym{NOV} files. The default is @file{.overview}.
14881 @item nnml-prepare-save-mail-hook
14882 @vindex nnml-prepare-save-mail-hook
14883 Hook run narrowed to an article before saving.
14885 @item nnml-marks-is-evil
14886 @vindex nnml-marks-is-evil
14887 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
14888 default is @code{nil}.
14890 @item nnml-marks-file-name
14891 @vindex nnml-marks-file-name
14892 The name of the @dfn{marks} files. The default is @file{.marks}.
14894 @item nnml-use-compressed-files
14895 @vindex nnml-use-compressed-files
14896 If non-@code{nil}, @code{nnml} will allow using compressed message
14901 @findex nnml-generate-nov-databases
14902 If your @code{nnml} groups and @acronym{NOV} files get totally out of
14903 whack, you can do a complete update by typing @kbd{M-x
14904 nnml-generate-nov-databases}. This command will trawl through the
14905 entire @code{nnml} hierarchy, looking at each and every article, so it
14906 might take a while to complete. A better interface to this
14907 functionality can be found in the server buffer (@pxref{Server
14912 @subsubsection MH Spool
14914 @cindex mh-e mail spool
14916 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
14917 @acronym{NOV} databases and it doesn't keep an active file or marks
14918 file. This makes @code{nnmh} a @emph{much} slower back end than
14919 @code{nnml}, but it also makes it easier to write procmail scripts
14922 Virtual server settings:
14925 @item nnmh-directory
14926 @vindex nnmh-directory
14927 All @code{nnmh} directories will be located under this directory. The
14928 default is the value of @code{message-directory} (whose default is
14931 @item nnmh-get-new-mail
14932 @vindex nnmh-get-new-mail
14933 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
14937 @vindex nnmh-be-safe
14938 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
14939 sure that the articles in the folder are actually what Gnus thinks
14940 they are. It will check date stamps and stat everything in sight, so
14941 setting this to @code{t} will mean a serious slow-down. If you never
14942 use anything but Gnus to read the @code{nnmh} articles, you do not
14943 have to set this variable to @code{t}. The default is @code{nil}.
14948 @subsubsection Maildir
14952 @code{nnmaildir} stores mail in the maildir format, with each maildir
14953 corresponding to a group in Gnus. This format is documented here:
14954 @uref{http://cr.yp.to/proto/maildir.html} and here:
14955 @uref{http://www.qmail.org/man/man5/maildir.html}. @code{nnmaildir}
14956 also stores extra information in the @file{.nnmaildir/} directory
14959 Maildir format was designed to allow concurrent deliveries and
14960 reading, without needing locks. With other back ends, you would have
14961 your mail delivered to a spool of some kind, and then you would
14962 configure Gnus to split mail from that spool into your groups. You
14963 can still do that with @code{nnmaildir}, but the more common
14964 configuration is to have your mail delivered directly to the maildirs
14965 that appear as group in Gnus.
14967 @code{nnmaildir} is designed to be perfectly reliable: @kbd{C-g} will
14968 never corrupt its data in memory, and @code{SIGKILL} will never
14969 corrupt its data in the filesystem.
14971 @code{nnmaildir} stores article marks and @acronym{NOV} data in each
14972 maildir. So you can copy a whole maildir from one Gnus setup to
14973 another, and you will keep your marks.
14975 Virtual server settings:
14979 For each of your @code{nnmaildir} servers (it's very unlikely that
14980 you'd need more than one), you need to create a directory and populate
14981 it with maildirs or symlinks to maildirs (and nothing else; do not
14982 choose a directory already used for other purposes). Each maildir
14983 will be represented in Gnus as a newsgroup on that server; the
14984 filename of the symlink will be the name of the group. Any filenames
14985 in the directory starting with @samp{.} are ignored. The directory is
14986 scanned when you first start Gnus, and each time you type @kbd{g} in
14987 the group buffer; if any maildirs have been removed or added,
14988 @code{nnmaildir} notices at these times.
14990 The value of the @code{directory} parameter should be a Lisp form
14991 which is processed by @code{eval} and @code{expand-file-name} to get
14992 the path of the directory for this server. The form is @code{eval}ed
14993 only when the server is opened; the resulting string is used until the
14994 server is closed. (If you don't know about forms and @code{eval},
14995 don't worry---a simple string will work.) This parameter is not
14996 optional; you must specify it. I don't recommend using
14997 @code{"~/Mail"} or a subdirectory of it; several other parts of Gnus
14998 use that directory by default for various things, and may get confused
14999 if @code{nnmaildir} uses it too. @code{"~/.nnmaildir"} is a typical
15002 @item target-prefix
15003 This should be a Lisp form which is processed by @code{eval} and
15004 @code{expand-file-name}. The form is @code{eval}ed only when the
15005 server is opened; the resulting string is used until the server is
15008 When you create a group on an @code{nnmaildir} server, the maildir is
15009 created with @code{target-prefix} prepended to its name, and a symlink
15010 pointing to that maildir is created, named with the plain group name.
15011 So if @code{directory} is @code{"~/.nnmaildir"} and
15012 @code{target-prefix} is @code{"../maildirs/"}, then when you create
15013 the group @code{foo}, @code{nnmaildir} will create
15014 @file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create
15015 @file{~/.nnmaildir/foo} as a symlink pointing to
15016 @file{../maildirs/foo}.
15018 You can set @code{target-prefix} to a string without any slashes to
15019 create both maildirs and symlinks in the same @code{directory}; in
15020 this case, any maildirs found in @code{directory} whose names start
15021 with @code{target-prefix} will not be listed as groups (but the
15022 symlinks pointing to them will be).
15024 As a special case, if @code{target-prefix} is @code{""} (the default),
15025 then when you create a group, the maildir will be created in
15026 @code{directory} without a corresponding symlink. Beware that you
15027 cannot use @code{gnus-group-delete-group} on such groups without the
15028 @code{force} argument.
15030 @item directory-files
15031 This should be a function with the same interface as
15032 @code{directory-files} (such as @code{directory-files} itself). It is
15033 used to scan the server's @code{directory} for maildirs. This
15034 parameter is optional; the default is
15035 @code{nnheader-directory-files-safe} if
15036 @code{nnheader-directory-files-is-safe} is @code{nil}, and
15037 @code{directory-files} otherwise.
15038 (@code{nnheader-directory-files-is-safe} is checked only once when the
15039 server is opened; if you want to check it each time the directory is
15040 scanned, you'll have to provide your own function that does that.)
15043 If non-@code{nil}, then after scanning for new mail in the group
15044 maildirs themselves as usual, this server will also incorporate mail
15045 the conventional Gnus way, from @code{mail-sources} according to
15046 @code{nnmail-split-methods} or @code{nnmail-split-fancy}. The default
15047 value is @code{nil}.
15049 Do @emph{not} use the same maildir both in @code{mail-sources} and as
15050 an @code{nnmaildir} group. The results might happen to be useful, but
15051 that would be by chance, not by design, and the results might be
15052 different in the future. If your split rules create new groups,
15053 remember to supply a @code{create-directory} server parameter.
15056 @subsubsection Group parameters
15058 @code{nnmaildir} uses several group parameters. It's safe to ignore
15059 all this; the default behavior for @code{nnmaildir} is the same as the
15060 default behavior for other mail back ends: articles are deleted after
15061 one week, etc. Except for the expiry parameters, all this
15062 functionality is unique to @code{nnmaildir}, so you can ignore it if
15063 you're just trying to duplicate the behavior you already have with
15066 If the value of any of these parameters is a vector, the first element
15067 is evaluated as a Lisp form and the result is used, rather than the
15068 original value. If the value is not a vector, the value itself is
15069 evaluated as a Lisp form. (This is why these parameters use names
15070 different from those of other, similar parameters supported by other
15071 back ends: they have different, though similar, meanings.) (For
15072 numbers, strings, @code{nil}, and @code{t}, you can ignore the
15073 @code{eval} business again; for other values, remember to use an extra
15074 quote and wrap the value in a vector when appropriate.)
15078 An integer specifying the minimum age, in seconds, of an article
15079 before it will be expired, or the symbol @code{never} to specify that
15080 articles should never be expired. If this parameter is not set,
15081 @code{nnmaildir} falls back to the usual
15082 @code{nnmail-expiry-wait}(@code{-function}) variables (overrideable by
15083 the @code{expiry-wait}(@code{-function}) group parameters. If you
15084 wanted a value of 3 days, you could use something like @code{[(* 3 24
15085 60 60)]}; @code{nnmaildir} will evaluate the form and use the result.
15086 An article's age is measured starting from the article file's
15087 modification time. Normally, this is the same as the article's
15088 delivery time, but editing an article makes it younger. Moving an
15089 article (other than via expiry) may also make an article younger.
15092 If this is set to a string such as a full Gnus group name, like
15094 "backend+server.address.string:group.name"
15096 and if it is not the name of the same group that the parameter belongs
15097 to, then articles will be moved to the specified group during expiry
15098 before being deleted. @emph{If this is set to an @code{nnmaildir}
15099 group, the article will be just as old in the destination group as it
15100 was in the source group.} So be careful with @code{expire-age} in the
15101 destination group. If this is set to the name of the same group that
15102 the parameter belongs to, then the article is not expired at all. If
15103 you use the vector form, the first element is evaluated once for each
15104 article. So that form can refer to
15105 @code{nnmaildir-article-file-name}, etc., to decide where to put the
15106 article. @emph{If this parameter is not set, @code{nnmaildir} does
15107 not fall back to the @code{expiry-target} group parameter or the
15108 @code{nnmail-expiry-target} variable.}
15111 If this is set to @code{t}, @code{nnmaildir} will treat the articles
15112 in this maildir as read-only. This means: articles are not renamed
15113 from @file{new/} into @file{cur/}; articles are only found in
15114 @file{new/}, not @file{cur/}; articles are never deleted; articles
15115 cannot be edited. @file{new/} is expected to be a symlink to the
15116 @file{new/} directory of another maildir---e.g., a system-wide mailbox
15117 containing a mailing list of common interest. Everything in the
15118 maildir outside @file{new/} is @emph{not} treated as read-only, so for
15119 a shared mailbox, you do still need to set up your own maildir (or
15120 have write permission to the shared mailbox); your maildir just won't
15121 contain extra copies of the articles.
15123 @item directory-files
15124 A function with the same interface as @code{directory-files}. It is
15125 used to scan the directories in the maildir corresponding to this
15126 group to find articles. The default is the function specified by the
15127 server's @code{directory-files} parameter.
15129 @item distrust-Lines:
15130 If non-@code{nil}, @code{nnmaildir} will always count the lines of an
15131 article, rather than use the @code{Lines:} header field. If
15132 @code{nil}, the header field will be used if present.
15135 A list of mark symbols, such as @code{['(read expire)]}. Whenever
15136 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15137 say that all articles have these marks, regardless of whether the
15138 marks stored in the filesystem say so. This is a proof-of-concept
15139 feature that will probably be removed eventually; it ought to be done
15140 in Gnus proper, or abandoned if it's not worthwhile.
15143 A list of mark symbols, such as @code{['(tick expire)]}. Whenever
15144 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15145 say that no articles have these marks, regardless of whether the marks
15146 stored in the filesystem say so. @code{never-marks} overrides
15147 @code{always-marks}. This is a proof-of-concept feature that will
15148 probably be removed eventually; it ought to be done in Gnus proper, or
15149 abandoned if it's not worthwhile.
15151 @item nov-cache-size
15152 An integer specifying the size of the @acronym{NOV} memory cache. To
15153 speed things up, @code{nnmaildir} keeps @acronym{NOV} data in memory
15154 for a limited number of articles in each group. (This is probably not
15155 worthwhile, and will probably be removed in the future.) This
15156 parameter's value is noticed only the first time a group is seen after
15157 the server is opened---i.e., when you first start Gnus, typically.
15158 The @acronym{NOV} cache is never resized until the server is closed
15159 and reopened. The default is an estimate of the number of articles
15160 that would be displayed in the summary buffer: a count of articles
15161 that are either marked with @code{tick} or not marked with
15162 @code{read}, plus a little extra.
15165 @subsubsection Article identification
15166 Articles are stored in the @file{cur/} subdirectory of each maildir.
15167 Each article file is named like @code{uniq:info}, where @code{uniq}
15168 contains no colons. @code{nnmaildir} ignores, but preserves, the
15169 @code{:info} part. (Other maildir readers typically use this part of
15170 the filename to store marks.) The @code{uniq} part uniquely
15171 identifies the article, and is used in various places in the
15172 @file{.nnmaildir/} subdirectory of the maildir to store information
15173 about the corresponding article. The full pathname of an article is
15174 available in the variable @code{nnmaildir-article-file-name} after you
15175 request the article in the summary buffer.
15177 @subsubsection NOV data
15178 An article identified by @code{uniq} has its @acronym{NOV} data (used
15179 to generate lines in the summary buffer) stored in
15180 @code{.nnmaildir/nov/uniq}. There is no
15181 @code{nnmaildir-generate-nov-databases} function. (There isn't much
15182 need for it---an article's @acronym{NOV} data is updated automatically
15183 when the article or @code{nnmail-extra-headers} has changed.) You can
15184 force @code{nnmaildir} to regenerate the @acronym{NOV} data for a
15185 single article simply by deleting the corresponding @acronym{NOV}
15186 file, but @emph{beware}: this will also cause @code{nnmaildir} to
15187 assign a new article number for this article, which may cause trouble
15188 with @code{seen} marks, the Agent, and the cache.
15190 @subsubsection Article marks
15191 An article identified by @code{uniq} is considered to have the mark
15192 @code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists.
15193 When Gnus asks @code{nnmaildir} for a group's marks, @code{nnmaildir}
15194 looks for such files and reports the set of marks it finds. When Gnus
15195 asks @code{nnmaildir} to store a new set of marks, @code{nnmaildir}
15196 creates and deletes the corresponding files as needed. (Actually,
15197 rather than create a new file for each mark, it just creates hard
15198 links to @file{.nnmaildir/markfile}, to save inodes.)
15200 You can invent new marks by creating a new directory in
15201 @file{.nnmaildir/marks/}. You can tar up a maildir and remove it from
15202 your server, untar it later, and keep your marks. You can add and
15203 remove marks yourself by creating and deleting mark files. If you do
15204 this while Gnus is running and your @code{nnmaildir} server is open,
15205 it's best to exit all summary buffers for @code{nnmaildir} groups and
15206 type @kbd{s} in the group buffer first, and to type @kbd{g} or
15207 @kbd{M-g} in the group buffer afterwards. Otherwise, Gnus might not
15208 pick up the changes, and might undo them.
15212 @subsubsection Mail Folders
15214 @cindex mbox folders
15215 @cindex mail folders
15217 @code{nnfolder} is a back end for storing each mail group in a
15218 separate file. Each file is in the standard Un*x mbox format.
15219 @code{nnfolder} will add extra headers to keep track of article
15220 numbers and arrival dates.
15222 @cindex self contained nnfolder servers
15224 When the marks file is used (which it is by default), @code{nnfolder}
15225 servers have the property that you may backup them using @code{tar} or
15226 similar, and later be able to restore them into Gnus (by adding the
15227 proper @code{nnfolder} server) and have all your marks be preserved.
15228 Marks for a group is usually stored in a file named as the mbox file
15229 with @code{.mrk} concatenated to it (but see
15230 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder}
15231 directory. Individual @code{nnfolder} groups are also possible to
15232 backup, use @kbd{G m} to restore the group (after restoring the backup
15233 into the @code{nnfolder} directory).
15235 Virtual server settings:
15238 @item nnfolder-directory
15239 @vindex nnfolder-directory
15240 All the @code{nnfolder} mail boxes will be stored under this
15241 directory. The default is the value of @code{message-directory}
15242 (whose default is @file{~/Mail})
15244 @item nnfolder-active-file
15245 @vindex nnfolder-active-file
15246 The name of the active file. The default is @file{~/Mail/active}.
15248 @item nnfolder-newsgroups-file
15249 @vindex nnfolder-newsgroups-file
15250 The name of the group descriptions file. @xref{Newsgroups File
15251 Format}. The default is @file{~/Mail/newsgroups}
15253 @item nnfolder-get-new-mail
15254 @vindex nnfolder-get-new-mail
15255 If non-@code{nil}, @code{nnfolder} will read incoming mail. The
15256 default is @code{t}
15258 @item nnfolder-save-buffer-hook
15259 @vindex nnfolder-save-buffer-hook
15260 @cindex backup files
15261 Hook run before saving the folders. Note that Emacs does the normal
15262 backup renaming of files even with the @code{nnfolder} buffers. If
15263 you wish to switch this off, you could say something like the
15264 following in your @file{.emacs} file:
15267 (defun turn-off-backup ()
15268 (set (make-local-variable 'backup-inhibited) t))
15270 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
15273 @item nnfolder-delete-mail-hook
15274 @vindex nnfolder-delete-mail-hook
15275 Hook run in a buffer narrowed to the message that is to be deleted.
15276 This function can be used to copy the message to somewhere else, or to
15277 extract some information from it before removing it.
15279 @item nnfolder-nov-is-evil
15280 @vindex nnfolder-nov-is-evil
15281 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
15282 default is @code{nil}.
15284 @item nnfolder-nov-file-suffix
15285 @vindex nnfolder-nov-file-suffix
15286 The extension for @acronym{NOV} files. The default is @file{.nov}.
15288 @item nnfolder-nov-directory
15289 @vindex nnfolder-nov-directory
15290 The directory where the @acronym{NOV} files should be stored. If
15291 @code{nil}, @code{nnfolder-directory} is used.
15293 @item nnfolder-marks-is-evil
15294 @vindex nnfolder-marks-is-evil
15295 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15296 default is @code{nil}.
15298 @item nnfolder-marks-file-suffix
15299 @vindex nnfolder-marks-file-suffix
15300 The extension for @sc{marks} files. The default is @file{.mrk}.
15302 @item nnfolder-marks-directory
15303 @vindex nnfolder-marks-directory
15304 The directory where the @sc{marks} files should be stored. If
15305 @code{nil}, @code{nnfolder-directory} is used.
15310 @findex nnfolder-generate-active-file
15311 @kindex M-x nnfolder-generate-active-file
15312 If you have lots of @code{nnfolder}-like files you'd like to read with
15313 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
15314 command to make @code{nnfolder} aware of all likely files in
15315 @code{nnfolder-directory}. This only works if you use long file names,
15318 @node Comparing Mail Back Ends
15319 @subsubsection Comparing Mail Back Ends
15321 First, just for terminology, the @dfn{back end} is the common word for a
15322 low-level access method---a transport, if you will, by which something
15323 is acquired. The sense is that one's mail has to come from somewhere,
15324 and so selection of a suitable back end is required in order to get that
15325 mail within spitting distance of Gnus.
15327 The same concept exists for Usenet itself: Though access to articles is
15328 typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone
15329 in the world got at Usenet by running a reader on the machine where the
15330 articles lay (the machine which today we call an @acronym{NNTP} server), and
15331 access was by the reader stepping into the articles' directory spool
15332 area directly. One can still select between either the @code{nntp} or
15333 @code{nnspool} back ends, to select between these methods, if one happens
15334 actually to live on the server (or can see its spool directly, anyway,
15337 The goal in selecting a mail back end is to pick one which
15338 simultaneously represents a suitable way of dealing with the original
15339 format plus leaving mail in a form that is convenient to use in the
15340 future. Here are some high and low points on each:
15345 UNIX systems have historically had a single, very common, and well-
15346 defined format. All messages arrive in a single @dfn{spool file}, and
15347 they are delineated by a line whose regular expression matches
15348 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
15349 to make it clear in this instance that this is not the RFC-specified
15350 @samp{From:} header.) Because Emacs and therefore Gnus emanate
15351 historically from the Unix environment, it is simplest if one does not
15352 mess a great deal with the original mailbox format, so if one chooses
15353 this back end, Gnus' primary activity in getting mail from the real spool
15354 area to Gnus' preferred directory is simply to copy it, with no
15355 (appreciable) format change in the process. It is the ``dumbest'' way
15356 to move mail into availability in the Gnus environment. This makes it
15357 fast to move into place, but slow to parse, when Gnus has to look at
15362 Once upon a time, there was the DEC-10 and DEC-20, running operating
15363 systems called TOPS and related things, and the usual (only?) mail
15364 reading environment was a thing called Babyl. I don't know what format
15365 was used for mail landing on the system, but Babyl had its own internal
15366 format to which mail was converted, primarily involving creating a
15367 spool-file-like entity with a scheme for inserting Babyl-specific
15368 headers and status bits above the top of each message in the file.
15369 Rmail was Emacs' first mail reader, it was written by Richard Stallman,
15370 and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail
15371 to understand the mail files folks already had in existence. Gnus (and
15372 VM, for that matter) continue to support this format because it's
15373 perceived as having some good qualities in those mailer-specific
15374 headers/status bits stuff. Rmail itself still exists as well, of
15375 course, and is still maintained by Stallman.
15377 Both of the above forms leave your mail in a single file on your
15378 file system, and they must parse that entire file each time you take a
15383 @code{nnml} is the back end which smells the most as though you were
15384 actually operating with an @code{nnspool}-accessed Usenet system. (In
15385 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
15386 lo these years ago.) One's mail is taken from the original spool file,
15387 and is then cut up into individual message files, 1:1. It maintains a
15388 Usenet-style active file (analogous to what one finds in an INN- or
15389 CNews-based news system in (for instance) @file{/var/lib/news/active},
15390 or what is returned via the @samp{NNTP LIST} verb) and also creates
15391 @dfn{overview} files for efficient group entry, as has been defined for
15392 @acronym{NNTP} servers for some years now. It is slower in mail-splitting,
15393 due to the creation of lots of files, updates to the @code{nnml} active
15394 file, and additions to overview files on a per-message basis, but it is
15395 extremely fast on access because of what amounts to the indexing support
15396 provided by the active file and overviews.
15398 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
15399 resource which defines available places in the file system to put new
15400 files. Sysadmins take a dim view of heavy inode occupation within
15401 tight, shared file systems. But if you live on a personal machine where
15402 the file system is your own and space is not at a premium, @code{nnml}
15405 It is also problematic using this back end if you are living in a
15406 FAT16-based Windows world, since much space will be wasted on all these
15411 The Rand MH mail-reading system has been around UNIX systems for a very
15412 long time; it operates by splitting one's spool file of messages into
15413 individual files, but with little or no indexing support---@code{nnmh}
15414 is considered to be semantically equivalent to ``@code{nnml} without
15415 active file or overviews''. This is arguably the worst choice, because
15416 one gets the slowness of individual file creation married to the
15417 slowness of access parsing when learning what's new in one's groups.
15421 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
15422 method described above) on a per-group basis. That is, @code{nnmbox}
15423 itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a
15424 little bit of optimization to this so that each of one's mail groups has
15425 a Unix mail box file. It's faster than @code{nnmbox} because each group
15426 can be parsed separately, and still provides the simple Unix mail box
15427 format requiring minimal effort in moving the mail around. In addition,
15428 it maintains an ``active'' file making it much faster for Gnus to figure
15429 out how many messages there are in each separate group.
15431 If you have groups that are expected to have a massive amount of
15432 messages, @code{nnfolder} is not the best choice, but if you receive
15433 only a moderate amount of mail, @code{nnfolder} is probably the most
15434 friendly mail back end all over.
15438 For configuring expiry and other things, @code{nnmaildir} uses
15439 incompatible group parameters, slightly different from those of other
15442 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
15443 differences. Each message is stored in a separate file, but the
15444 filename is unrelated to the article number in Gnus. @code{nnmaildir}
15445 also stores the equivalent of @code{nnml}'s overview files in one file
15446 per article, so it uses about twice as many inodes as @code{nnml}. (Use
15447 @code{df -i} to see how plentiful your inode supply is.) If this slows
15448 you down or takes up very much space, consider switching to
15449 @uref{http://www.namesys.com/, ReiserFS} or another non-block-structured
15452 Since maildirs don't require locking for delivery, the maildirs you use
15453 as groups can also be the maildirs your mail is directly delivered to.
15454 This means you can skip Gnus' mail splitting if your mail is already
15455 organized into different mailboxes during delivery. A @code{directory}
15456 entry in @code{mail-sources} would have a similar effect, but would
15457 require one set of mailboxes for spooling deliveries (in mbox format,
15458 thus damaging message bodies), and another set to be used as groups (in
15459 whatever format you like). A maildir has a built-in spool, in the
15460 @code{new/} subdirectory. Beware that currently, mail moved from
15461 @code{new/} to @code{cur/} instead of via mail splitting will not
15462 undergo treatment such as duplicate checking.
15464 @code{nnmaildir} stores article marks for a given group in the
15465 corresponding maildir, in a way designed so that it's easy to manipulate
15466 them from outside Gnus. You can tar up a maildir, unpack it somewhere
15467 else, and still have your marks. @code{nnml} also stores marks, but
15468 it's not as easy to work with them from outside Gnus as with
15471 @code{nnmaildir} uses a significant amount of memory to speed things up.
15472 (It keeps in memory some of the things that @code{nnml} stores in files
15473 and that @code{nnmh} repeatedly parses out of message files.) If this
15474 is a problem for you, you can set the @code{nov-cache-size} group
15475 parameter to something small (0 would probably not work, but 1 probably
15476 would) to make it use less memory. This caching will probably be
15477 removed in the future.
15479 Startup is likely to be slower with @code{nnmaildir} than with other
15480 back ends. Everything else is likely to be faster, depending in part
15481 on your file system.
15483 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
15484 to write an @code{nnmaildir}-derived back end.
15489 @node Browsing the Web
15490 @section Browsing the Web
15492 @cindex browsing the web
15496 Web-based discussion forums are getting more and more popular. On many
15497 subjects, the web-based forums have become the most important forums,
15498 eclipsing the importance of mailing lists and news groups. The reason
15499 is easy to understand---they are friendly to new users; you just point
15500 and click, and there's the discussion. With mailing lists, you have to
15501 go through a cumbersome subscription procedure, and most people don't
15502 even know what a news group is.
15504 The problem with this scenario is that web browsers are not very good at
15505 being newsreaders. They do not keep track of what articles you've read;
15506 they do not allow you to score on subjects you're interested in; they do
15507 not allow off-line browsing; they require you to click around and drive
15508 you mad in the end.
15510 So---if web browsers suck at reading discussion forums, why not use Gnus
15513 Gnus has been getting a bit of a collection of back ends for providing
15514 interfaces to these sources.
15518 * Web Searches:: Creating groups from articles that match a string.
15519 * Slashdot:: Reading the Slashdot comments.
15520 * Ultimate:: The Ultimate Bulletin Board systems.
15521 * Web Archive:: Reading mailing list archived on web.
15522 * RSS:: Reading RDF site summary.
15523 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
15526 All the web sources require Emacs/w3 and the url library to work.
15528 The main caveat with all these web sources is that they probably won't
15529 work for a very long time. Gleaning information from the @acronym{HTML} data
15530 is guesswork at best, and when the layout is altered, the Gnus back end
15531 will fail. If you have reasonably new versions of these back ends,
15532 though, you should be ok.
15534 One thing all these Web methods have in common is that the Web sources
15535 are often down, unavailable or just plain too slow to be fun. In those
15536 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
15537 Unplugged}) handle downloading articles, and then you can read them at
15538 leisure from your local disk. No more World Wide Wait for you.
15540 @node Archiving Mail
15541 @subsection Archiving Mail
15542 @cindex archiving mail
15543 @cindex backup of mail
15545 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
15546 @code{nnmaildir}, now actually store the article marks with each group.
15547 For these servers, archiving and restoring a group while preserving
15548 marks is fairly simple.
15550 (Preserving the group level and group parameters as well still
15551 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
15554 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
15555 server, take a recursive copy of the server directory. There is no need
15556 to shut down Gnus, so archiving may be invoked by @code{cron} or
15557 similar. You restore the data by restoring the directory tree, and
15558 adding a server definition pointing to that directory in Gnus. The
15559 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
15560 might interfere with overwriting data, so you may want to shut down Gnus
15561 before you restore the data.
15563 It is also possible to archive individual @code{nnml},
15564 @code{nnfolder}, or @code{nnmaildir} groups, while preserving marks.
15565 For @code{nnml} or @code{nnmaildir}, you copy all files in the group's
15566 directory. For @code{nnfolder} you need to copy both the base folder
15567 file itself (@file{FOO}, say), and the marks file (@file{FOO.mrk} in
15568 this example). Restoring the group is done with @kbd{G m} from the Group
15569 buffer. The last step makes Gnus notice the new directory.
15570 @code{nnmaildir} notices the new directory automatically, so @kbd{G m}
15571 is unnecessary in that case.
15574 @subsection Web Searches
15579 @cindex Usenet searches
15580 @cindex searching the Usenet
15582 It's, like, too neat to search the Usenet for articles that match a
15583 string, but it, like, totally @emph{sucks}, like, totally, to use one of
15584 those, like, Web browsers, and you, like, have to, rilly, like, look at
15585 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
15586 searches without having to use a browser.
15588 The @code{nnweb} back end allows an easy interface to the mighty search
15589 engine. You create an @code{nnweb} group, enter a search pattern, and
15590 then enter the group and read the articles like you would any normal
15591 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
15592 Groups}) will do this in an easy-to-use fashion.
15594 @code{nnweb} groups don't really lend themselves to being solid
15595 groups---they have a very fleeting idea of article numbers. In fact,
15596 each time you enter an @code{nnweb} group (not even changing the search
15597 pattern), you are likely to get the articles ordered in a different
15598 manner. Not even using duplicate suppression (@pxref{Duplicate
15599 Suppression}) will help, since @code{nnweb} doesn't even know the
15600 @code{Message-ID} of the articles before reading them using some search
15601 engines (Google, for instance). The only possible way to keep track
15602 of which articles you've read is by scoring on the @code{Date}
15603 header---mark all articles posted before the last date you read the
15606 If the search engine changes its output substantially, @code{nnweb}
15607 won't be able to parse it and will fail. One could hardly fault the Web
15608 providers if they were to do this---their @emph{raison d'@^etre} is to
15609 make money off of advertisements, not to provide services to the
15610 community. Since @code{nnweb} washes the ads off all the articles, one
15611 might think that the providers might be somewhat miffed. We'll see.
15613 You must have the @code{url} and @code{w3} package installed to be able
15614 to use @code{nnweb}.
15616 Virtual server variables:
15621 What search engine type is being used. The currently supported types
15622 are @code{google}, @code{dejanews}, and @code{gmane}. Note that
15623 @code{dejanews} is an alias to @code{google}.
15626 @vindex nnweb-search
15627 The search string to feed to the search engine.
15629 @item nnweb-max-hits
15630 @vindex nnweb-max-hits
15631 Advisory maximum number of hits per search to display. The default is
15634 @item nnweb-type-definition
15635 @vindex nnweb-type-definition
15636 Type-to-definition alist. This alist says what @code{nnweb} should do
15637 with the various search engine types. The following elements must be
15642 Function to decode the article and provide something that Gnus
15646 Function to create an article number to message header and URL alist.
15649 Function to send the search string to the search engine.
15652 The address the aforementioned function should send the search string
15656 Format string URL to fetch an article by @code{Message-ID}.
15663 @subsection Slashdot
15667 @uref{http://slashdot.org/, Slashdot} is a popular news site, with
15668 lively discussion following the news articles. @code{nnslashdot} will
15669 let you read this forum in a convenient manner.
15671 The easiest way to read this source is to put something like the
15672 following in your @file{~/.gnus.el} file:
15675 (setq gnus-secondary-select-methods
15676 '((nnslashdot "")))
15679 This will make Gnus query the @code{nnslashdot} back end for new comments
15680 and groups. The @kbd{F} command will subscribe each new news article as
15681 a new Gnus group, and you can read the comments by entering these
15682 groups. (Note that the default subscription method is to subscribe new
15683 groups as zombies. Other methods are available (@pxref{Subscription
15686 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
15687 command is the most handy tool (@pxref{Foreign Groups}).
15689 When following up to @code{nnslashdot} comments (or posting new
15690 comments), some light @acronym{HTML}izations will be performed. In
15691 particular, text quoted with @samp{> } will be quoted with
15692 @samp{blockquote} instead, and signatures will have @samp{br} added to
15693 the end of each line. Other than that, you can just write @acronym{HTML}
15694 directly into the message buffer. Note that Slashdot filters out some
15695 @acronym{HTML} forms.
15697 The following variables can be altered to change its behavior:
15700 @item nnslashdot-threaded
15701 Whether @code{nnslashdot} should display threaded groups or not. The
15702 default is @code{t}. To be able to display threads, @code{nnslashdot}
15703 has to retrieve absolutely all comments in a group upon entry. If a
15704 threaded display is not required, @code{nnslashdot} will only retrieve
15705 the comments that are actually wanted by the user. Threading is nicer,
15706 but much, much slower than unthreaded.
15708 @item nnslashdot-login-name
15709 @vindex nnslashdot-login-name
15710 The login name to use when posting.
15712 @item nnslashdot-password
15713 @vindex nnslashdot-password
15714 The password to use when posting.
15716 @item nnslashdot-directory
15717 @vindex nnslashdot-directory
15718 Where @code{nnslashdot} will store its files. The default is
15719 @file{~/News/slashdot/}.
15721 @item nnslashdot-active-url
15722 @vindex nnslashdot-active-url
15723 The @acronym{URL} format string that will be used to fetch the
15724 information on news articles and comments. The default is@*
15725 @samp{http://slashdot.org/search.pl?section=&min=%d}.
15727 @item nnslashdot-comments-url
15728 @vindex nnslashdot-comments-url
15729 The @acronym{URL} format string that will be used to fetch comments.
15731 @item nnslashdot-article-url
15732 @vindex nnslashdot-article-url
15733 The @acronym{URL} format string that will be used to fetch the news
15734 article. The default is
15735 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
15737 @item nnslashdot-threshold
15738 @vindex nnslashdot-threshold
15739 The score threshold. The default is -1.
15741 @item nnslashdot-group-number
15742 @vindex nnslashdot-group-number
15743 The number of old groups, in addition to the ten latest, to keep
15744 updated. The default is 0.
15751 @subsection Ultimate
15753 @cindex Ultimate Bulletin Board
15755 @uref{http://www.ultimatebb.com/, The Ultimate Bulletin Board} is
15756 probably the most popular Web bulletin board system used. It has a
15757 quite regular and nice interface, and it's possible to get the
15758 information Gnus needs to keep groups updated.
15760 The easiest way to get started with @code{nnultimate} is to say
15761 something like the following in the group buffer: @kbd{B nnultimate RET
15762 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @acronym{URL}
15763 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
15764 you're interested in; there's quite a list of them on the Ultimate web
15765 site.) Then subscribe to the groups you're interested in from the
15766 server buffer, and read them from the group buffer.
15768 The following @code{nnultimate} variables can be altered:
15771 @item nnultimate-directory
15772 @vindex nnultimate-directory
15773 The directory where @code{nnultimate} stores its files. The default is@*
15774 @file{~/News/ultimate/}.
15779 @subsection Web Archive
15781 @cindex Web Archive
15783 Some mailing lists only have archives on Web servers, such as
15784 @uref{http://www.egroups.com/} and
15785 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
15786 interface, and it's possible to get the information Gnus needs to keep
15789 @findex gnus-group-make-warchive-group
15790 The easiest way to get started with @code{nnwarchive} is to say
15791 something like the following in the group buffer: @kbd{M-x
15792 gnus-group-make-warchive-group RET @var{an_egroup} RET egroups RET
15793 www.egroups.com RET @var{your@@email.address} RET}. (Substitute the
15794 @var{an_egroup} with the mailing list you subscribed, the
15795 @var{your@@email.address} with your email address.), or to browse the
15796 back end by @kbd{B nnwarchive RET mail-archive RET}.
15798 The following @code{nnwarchive} variables can be altered:
15801 @item nnwarchive-directory
15802 @vindex nnwarchive-directory
15803 The directory where @code{nnwarchive} stores its files. The default is@*
15804 @file{~/News/warchive/}.
15806 @item nnwarchive-login
15807 @vindex nnwarchive-login
15808 The account name on the web server.
15810 @item nnwarchive-passwd
15811 @vindex nnwarchive-passwd
15812 The password for your account on the web server.
15820 Some web sites have an RDF Site Summary (@acronym{RSS}).
15821 @acronym{RSS} is a format for summarizing headlines from news related
15822 sites (such as BBC or CNN). But basically anything list-like can be
15823 presented as an @acronym{RSS} feed: weblogs, changelogs or recent
15824 changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}).
15826 @acronym{RSS} has a quite regular and nice interface, and it's
15827 possible to get the information Gnus needs to keep groups updated.
15829 @kindex G R (Summary)
15830 Use @kbd{G R} from the summary buffer to subscribe to a feed---you
15831 will be prompted for the location of the feed.
15833 An easy way to get started with @code{nnrss} is to say something like
15834 the following in the group buffer: @kbd{B nnrss RET y}, then
15835 subscribe to groups.
15837 The following @code{nnrss} variables can be altered:
15840 @item nnrss-directory
15841 @vindex nnrss-directory
15842 The directory where @code{nnrss} stores its files. The default is
15843 @file{~/News/rss/}.
15845 @item nnrss-use-local
15846 @vindex nnrss-use-local
15847 @findex nnrss-generate-download-script
15848 If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read
15849 the feeds from local files in @code{nnrss-directory}. You can use
15850 the command @code{nnrss-generate-download-script} to generate a
15851 download script using @command{wget}.
15854 The following code may be helpful, if you want to show the description in
15855 the summary buffer.
15858 (add-to-list 'nnmail-extra-headers nnrss-description-field)
15859 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
15861 (defun gnus-user-format-function-X (header)
15863 (assq nnrss-description-field (mail-header-extra header))))
15864 (if descr (concat "\n\t" (cdr descr)) "")))
15867 The following code may be useful to open an nnrss url directly from the
15870 (require 'browse-url)
15872 (defun browse-nnrss-url( arg )
15874 (let ((url (assq nnrss-url-field
15877 (assq (gnus-summary-article-number)
15878 gnus-newsgroup-data))))))
15881 (browse-url (cdr url))
15882 (gnus-summary-mark-as-read-forward 1))
15883 (gnus-summary-scroll-up arg))))
15885 (eval-after-load "gnus"
15886 #'(define-key gnus-summary-mode-map
15887 (kbd "<RET>") 'browse-nnrss-url))
15888 (add-to-list 'nnmail-extra-headers nnrss-url-field)
15891 @node Customizing w3
15892 @subsection Customizing w3
15898 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
15899 pages. Emacs/w3 is documented in its own manual, but there are some
15900 things that may be more relevant for Gnus users.
15902 For instance, a common question is how to make Emacs/w3 follow links
15903 using the @code{browse-url} functions (which will call some external web
15904 browser like Netscape). Here's one way:
15907 (eval-after-load "w3"
15909 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
15910 (defun w3-fetch (&optional url target)
15911 (interactive (list (w3-read-url-with-default)))
15912 (if (eq major-mode 'gnus-article-mode)
15914 (w3-fetch-orig url target)))))
15917 Put that in your @file{.emacs} file, and hitting links in w3-rendered
15918 @acronym{HTML} in the Gnus article buffers will use @code{browse-url} to
15925 @cindex @acronym{IMAP}
15927 @acronym{IMAP} is a network protocol for reading mail (or news, or @dots{}),
15928 think of it as a modernized @acronym{NNTP}. Connecting to a @acronym{IMAP}
15929 server is much similar to connecting to a news server, you just
15930 specify the network address of the server.
15932 @acronym{IMAP} has two properties. First, @acronym{IMAP} can do
15933 everything that @acronym{POP} can, it can hence be viewed as a
15934 @acronym{POP++}. Secondly, @acronym{IMAP} is a mail storage protocol,
15935 similar to @acronym{NNTP} being a news storage protocol---however,
15936 @acronym{IMAP} offers more features than @acronym{NNTP} because news
15937 is more or less read-only whereas mail is read-write.
15939 If you want to use @acronym{IMAP} as a @acronym{POP++}, use an imap
15940 entry in @code{mail-sources}. With this, Gnus will fetch mails from
15941 the @acronym{IMAP} server and store them on the local disk. This is
15942 not the usage described in this section---@xref{Mail Sources}.
15944 If you want to use @acronym{IMAP} as a mail storage protocol, use an nnimap
15945 entry in @code{gnus-secondary-select-methods}. With this, Gnus will
15946 manipulate mails stored on the @acronym{IMAP} server. This is the kind of
15947 usage explained in this section.
15949 A server configuration in @file{~/.gnus.el} with a few @acronym{IMAP}
15950 servers might look something like the following. (Note that for
15951 @acronym{TLS}/@acronym{SSL}, you need external programs and libraries,
15955 (setq gnus-secondary-select-methods
15956 '((nnimap "simpleserver") ; @r{no special configuration}
15957 ; @r{perhaps a ssh port forwarded server:}
15959 (nnimap-address "localhost")
15960 (nnimap-server-port 1430))
15961 ; @r{a UW server running on localhost}
15963 (nnimap-server-port 143)
15964 (nnimap-address "localhost")
15965 (nnimap-list-pattern ("INBOX" "mail/*")))
15966 ; @r{anonymous public cyrus server:}
15967 (nnimap "cyrus.andrew.cmu.edu"
15968 (nnimap-authenticator anonymous)
15969 (nnimap-list-pattern "archive.*")
15970 (nnimap-stream network))
15971 ; @r{a ssl server on a non-standard port:}
15973 (nnimap-address "vic20.somewhere.com")
15974 (nnimap-server-port 9930)
15975 (nnimap-stream ssl))))
15978 After defining the new server, you can subscribe to groups on the
15979 server using normal Gnus commands such as @kbd{U} in the Group Buffer
15980 (@pxref{Subscription Commands}) or via the Server Buffer
15981 (@pxref{Server Buffer}).
15983 The following variables can be used to create a virtual @code{nnimap}
15988 @item nnimap-address
15989 @vindex nnimap-address
15991 The address of the remote @acronym{IMAP} server. Defaults to the virtual
15992 server name if not specified.
15994 @item nnimap-server-port
15995 @vindex nnimap-server-port
15996 Port on server to contact. Defaults to port 143, or 993 for @acronym{TLS}/@acronym{SSL}.
15998 Note that this should be an integer, example server specification:
16001 (nnimap "mail.server.com"
16002 (nnimap-server-port 4711))
16005 @item nnimap-list-pattern
16006 @vindex nnimap-list-pattern
16007 String or list of strings of mailboxes to limit available groups to.
16008 This is used when the server has very many mailboxes and you're only
16009 interested in a few---some servers export your home directory via
16010 @acronym{IMAP}, you'll probably want to limit the mailboxes to those in
16011 @file{~/Mail/*} then.
16013 The string can also be a cons of REFERENCE and the string as above, what
16014 REFERENCE is used for is server specific, but on the University of
16015 Washington server it's a directory that will be concatenated with the
16018 Example server specification:
16021 (nnimap "mail.server.com"
16022 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
16023 ("~friend/Mail/" . "list/*"))))
16026 @item nnimap-stream
16027 @vindex nnimap-stream
16028 The type of stream used to connect to your server. By default, nnimap
16029 will detect and automatically use all of the below, with the exception
16030 of @acronym{TLS}/@acronym{SSL}. (@acronym{IMAP} over
16031 @acronym{TLS}/@acronym{SSL} is being replaced by STARTTLS, which can
16032 be automatically detected, but it's not widely deployed yet.)
16034 Example server specification:
16037 (nnimap "mail.server.com"
16038 (nnimap-stream ssl))
16041 Please note that the value of @code{nnimap-stream} is a symbol!
16045 @dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5). Requires the
16046 @samp{gsasl} or @samp{imtest} program.
16048 @dfn{kerberos4:} Connect with Kerberos 4. Requires the @samp{imtest} program.
16050 @dfn{starttls:} Connect via the STARTTLS extension (similar to
16051 @acronym{TLS}/@acronym{SSL}). Requires the external library @samp{starttls.el} and program
16054 @dfn{tls:} Connect through @acronym{TLS}. Requires GNUTLS (the program
16055 @samp{gnutls-cli}).
16057 @dfn{ssl:} Connect through @acronym{SSL}. Requires OpenSSL (the program
16058 @samp{openssl}) or SSLeay (@samp{s_client}).
16060 @dfn{shell:} Use a shell command to start @acronym{IMAP} connection.
16062 @dfn{network:} Plain, TCP/IP network connection.
16065 @vindex imap-kerberos4-program
16066 The @samp{imtest} program is shipped with Cyrus IMAPD. If you're
16067 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
16068 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
16069 to make @code{imap.el} use a pty instead of a pipe when communicating
16070 with @samp{imtest}. You will then suffer from a line length
16071 restrictions on @acronym{IMAP} commands, which might make Gnus seem to hang
16072 indefinitely if you have many articles in a mailbox. The variable
16073 @code{imap-kerberos4-program} contain parameters to pass to the imtest
16076 For @acronym{TLS} connection, the @code{gnutls-cli} program from GNUTLS is
16077 needed. It is available from
16078 @uref{http://www.gnu.org/software/gnutls/}.
16080 @vindex imap-gssapi-program
16081 This parameter specifies a list of command lines that invoke a GSSAPI
16082 authenticated @acronym{IMAP} stream in a subshell. They are tried
16083 sequentially until a connection is made, or the list has been
16084 exhausted. By default, @samp{gsasl} from GNU SASL, available from
16085 @uref{http://www.gnu.org/software/gsasl/}, and the @samp{imtest}
16086 program from Cyrus IMAPD (see @code{imap-kerberos4-program}), are
16089 @vindex imap-ssl-program
16090 For @acronym{SSL} connections, the OpenSSL program is available from
16091 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
16092 and nnimap support it too---although the most recent versions of
16093 SSLeay, 0.9.x, are known to have serious bugs making it
16094 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
16095 work. The variable @code{imap-ssl-program} contain parameters to pass
16098 @vindex imap-shell-program
16099 @vindex imap-shell-host
16100 For @acronym{IMAP} connections using the @code{shell} stream, the variable
16101 @code{imap-shell-program} specify what program to call.
16103 @item nnimap-authenticator
16104 @vindex nnimap-authenticator
16106 The authenticator used to connect to the server. By default, nnimap
16107 will use the most secure authenticator your server is capable of.
16109 Example server specification:
16112 (nnimap "mail.server.com"
16113 (nnimap-authenticator anonymous))
16116 Please note that the value of @code{nnimap-authenticator} is a symbol!
16120 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Requires
16121 external program @code{gsasl} or @code{imtest}.
16123 @dfn{kerberos4:} Kerberos 4 authentication. Requires external program
16126 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Requires
16127 external library @code{digest-md5.el}.
16129 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
16131 @dfn{login:} Plain-text username/password via LOGIN.
16133 @dfn{anonymous:} Login as ``anonymous'', supplying your email address as password.
16136 @item nnimap-expunge-on-close
16138 @vindex nnimap-expunge-on-close
16139 Unlike Parmenides the @acronym{IMAP} designers have decided things that
16140 don't exist actually do exist. More specifically, @acronym{IMAP} has
16141 this concept of marking articles @code{Deleted} which doesn't actually
16142 delete them, and this (marking them @code{Deleted}, that is) is what
16143 nnimap does when you delete an article in Gnus (with @kbd{B DEL} or
16146 Since the articles aren't really removed when we mark them with the
16147 @code{Deleted} flag we'll need a way to actually delete them. Feel like
16148 running in circles yet?
16150 Traditionally, nnimap has removed all articles marked as @code{Deleted}
16151 when closing a mailbox but this is now configurable by this server
16154 The possible options are:
16159 The default behavior, delete all articles marked as ``Deleted'' when
16162 Never actually delete articles. Currently there is no way of showing
16163 the articles marked for deletion in nnimap, but other @acronym{IMAP} clients
16164 may allow you to do this. If you ever want to run the EXPUNGE command
16165 manually, @xref{Expunging mailboxes}.
16167 When closing mailboxes, nnimap will ask if you wish to expunge deleted
16172 @item nnimap-importantize-dormant
16173 @vindex nnimap-importantize-dormant
16175 If non-@code{nil} (the default), marks dormant articles as ticked (as
16176 well), for other @acronym{IMAP} clients. Within Gnus, dormant articles will
16177 naturally still (only) be marked as dormant. This is to make dormant
16178 articles stand out, just like ticked articles, in other @acronym{IMAP}
16179 clients. (In other words, Gnus has two ``Tick'' marks and @acronym{IMAP}
16182 Probably the only reason for frobing this would be if you're trying
16183 enable per-user persistent dormant flags, using something like:
16186 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
16187 (format "gnus-dormant-%s" (user-login-name)))
16188 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
16189 (format "KEYWORD gnus-dormant-%s" (user-login-name)))
16192 In this case, you would not want the per-user dormant flag showing up
16193 as ticked for other users.
16195 @item nnimap-expunge-search-string
16197 @vindex nnimap-expunge-search-string
16199 This variable contain the @acronym{IMAP} search command sent to server when
16200 searching for articles eligible for expiring. The default is
16201 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
16202 UID set and the second @code{%s} is replaced by a date.
16204 Probably the only useful value to change this to is
16205 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
16206 messages instead of the internal article date. See section 6.4.4 of
16207 RFC 2060 for more information on valid strings.
16209 @item nnimap-authinfo-file
16210 @vindex nnimap-authinfo-file
16212 A file containing credentials used to log in on servers. The format is
16213 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
16214 variable @code{nntp-authinfo-file} for exact syntax; also see
16217 @item nnimap-need-unselect-to-notice-new-mail
16218 @vindex nnimap-need-unselect-to-notice-new-mail
16220 Unselect mailboxes before looking for new mail in them. Some servers
16221 seem to need this under some circumstances; it was reported that
16227 * Splitting in IMAP:: Splitting mail with nnimap.
16228 * Expiring in IMAP:: Expiring mail with nnimap.
16229 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
16230 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
16231 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
16232 * Debugging IMAP:: What to do when things don't work.
16237 @node Splitting in IMAP
16238 @subsection Splitting in IMAP
16239 @cindex splitting imap mail
16241 Splitting is something Gnus users have loved and used for years, and now
16242 the rest of the world is catching up. Yeah, dream on, not many
16243 @acronym{IMAP} servers have server side splitting and those that have
16244 splitting seem to use some non-standard protocol. This means that
16245 @acronym{IMAP} support for Gnus has to do its own splitting.
16249 (Incidentally, people seem to have been dreaming on, and Sieve has
16250 gaining a market share and is supported by several IMAP servers.
16251 Fortunately, Gnus support it too, @xref{Sieve Commands}.)
16253 Here are the variables of interest:
16257 @item nnimap-split-crosspost
16258 @cindex splitting, crosspost
16260 @vindex nnimap-split-crosspost
16262 If non-@code{nil}, do crossposting if several split methods match the
16263 mail. If @code{nil}, the first match in @code{nnimap-split-rule}
16264 found will be used.
16266 Nnmail equivalent: @code{nnmail-crosspost}.
16268 @item nnimap-split-inbox
16269 @cindex splitting, inbox
16271 @vindex nnimap-split-inbox
16273 A string or a list of strings that gives the name(s) of @acronym{IMAP}
16274 mailboxes to split from. Defaults to @code{nil}, which means that
16275 splitting is disabled!
16278 (setq nnimap-split-inbox
16279 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
16282 No nnmail equivalent.
16284 @item nnimap-split-rule
16285 @cindex splitting, rules
16286 @vindex nnimap-split-rule
16288 New mail found in @code{nnimap-split-inbox} will be split according to
16291 This variable contains a list of lists, where the first element in the
16292 sublist gives the name of the @acronym{IMAP} mailbox to move articles
16293 matching the regexp in the second element in the sublist. Got that?
16294 Neither did I, we need examples.
16297 (setq nnimap-split-rule
16299 "^Sender: owner-nnimap@@vic20.globalcom.se")
16300 ("INBOX.junk" "^Subject:.*MAKE MONEY")
16301 ("INBOX.private" "")))
16304 This will put all articles from the nnimap mailing list into mailbox
16305 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
16306 into INBOX.junk and everything else in INBOX.private.
16308 The first string may contain @samp{\\1} forms, like the ones used by
16309 replace-match to insert sub-expressions from the matched text. For
16313 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
16316 The first element can also be the symbol @code{junk} to indicate that
16317 matching messages should simply be deleted. Use with care.
16319 The second element can also be a function. In that case, it will be
16320 called with the first element of the rule as the argument, in a buffer
16321 containing the headers of the article. It should return a
16322 non-@code{nil} value if it thinks that the mail belongs in that group.
16324 Nnmail users might recollect that the last regexp had to be empty to
16325 match all articles (like in the example above). This is not required in
16326 nnimap. Articles not matching any of the regexps will not be moved out
16327 of your inbox. (This might affect performance if you keep lots of
16328 unread articles in your inbox, since the splitting code would go over
16329 them every time you fetch new mail.)
16331 These rules are processed from the beginning of the alist toward the
16332 end. The first rule to make a match will ``win'', unless you have
16333 crossposting enabled. In that case, all matching rules will ``win''.
16335 This variable can also have a function as its value, the function will
16336 be called with the headers narrowed and should return a group where it
16337 thinks the article should be split to. See @code{nnimap-split-fancy}.
16339 The splitting code tries to create mailboxes if it needs to.
16341 To allow for different split rules on different virtual servers, and
16342 even different split rules in different inboxes on the same server,
16343 the syntax of this variable have been extended along the lines of:
16346 (setq nnimap-split-rule
16347 '(("my1server" (".*" (("ding" "ding@@gnus.org")
16348 ("junk" "From:.*Simon"))))
16349 ("my2server" ("INBOX" nnimap-split-fancy))
16350 ("my[34]server" (".*" (("private" "To:.*Simon")
16351 ("junk" my-junk-func))))))
16354 The virtual server name is in fact a regexp, so that the same rules
16355 may apply to several servers. In the example, the servers
16356 @code{my3server} and @code{my4server} both use the same rules.
16357 Similarly, the inbox string is also a regexp. The actual splitting
16358 rules are as before, either a function, or a list with group/regexp or
16359 group/function elements.
16361 Nnmail equivalent: @code{nnmail-split-methods}.
16363 @item nnimap-split-predicate
16365 @vindex nnimap-split-predicate
16367 Mail matching this predicate in @code{nnimap-split-inbox} will be
16368 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
16370 This might be useful if you use another @acronym{IMAP} client to read mail in
16371 your inbox but would like Gnus to split all articles in the inbox
16372 regardless of readedness. Then you might change this to
16375 @item nnimap-split-fancy
16376 @cindex splitting, fancy
16377 @findex nnimap-split-fancy
16378 @vindex nnimap-split-fancy
16380 It's possible to set @code{nnimap-split-rule} to
16381 @code{nnmail-split-fancy} if you want to use fancy
16382 splitting. @xref{Fancy Mail Splitting}.
16384 However, to be able to have different fancy split rules for nnmail and
16385 nnimap back ends you can set @code{nnimap-split-rule} to
16386 @code{nnimap-split-fancy} and define the nnimap specific fancy split
16387 rule in @code{nnimap-split-fancy}.
16392 (setq nnimap-split-rule 'nnimap-split-fancy
16393 nnimap-split-fancy ...)
16396 Nnmail equivalent: @code{nnmail-split-fancy}.
16398 @item nnimap-split-download-body
16399 @findex nnimap-split-download-body
16400 @vindex nnimap-split-download-body
16402 Set to non-@code{nil} to download entire articles during splitting.
16403 This is generally not required, and will slow things down
16404 considerably. You may need it if you want to use an advanced
16405 splitting function that analyses the body to split the article.
16409 @node Expiring in IMAP
16410 @subsection Expiring in IMAP
16411 @cindex expiring imap mail
16413 Even though @code{nnimap} is not a proper @code{nnmail} derived back
16414 end, it supports most features in regular expiring (@pxref{Expiring
16415 Mail}). Unlike splitting in @acronym{IMAP} (@pxref{Splitting in
16416 IMAP}) it does not clone the @code{nnmail} variables (i.e., creating
16417 @var{nnimap-expiry-wait}) but reuse the @code{nnmail} variables. What
16418 follows below are the variables used by the @code{nnimap} expiry
16421 A note on how the expire mark is stored on the @acronym{IMAP} server is
16422 appropriate here as well. The expire mark is translated into a
16423 @code{imap} client specific mark, @code{gnus-expire}, and stored on the
16424 message. This means that likely only Gnus will understand and treat
16425 the @code{gnus-expire} mark properly, although other clients may allow
16426 you to view client specific flags on the message. It also means that
16427 your server must support permanent storage of client specific flags on
16428 messages. Most do, fortunately.
16432 @item nnmail-expiry-wait
16433 @item nnmail-expiry-wait-function
16435 These variables are fully supported. The expire value can be a
16436 number, the symbol @code{immediate} or @code{never}.
16438 @item nnmail-expiry-target
16440 This variable is supported, and internally implemented by calling the
16441 @code{nnmail} functions that handle this. It contains an optimization
16442 that if the destination is a @acronym{IMAP} group on the same server, the
16443 article is copied instead of appended (that is, uploaded again).
16447 @node Editing IMAP ACLs
16448 @subsection Editing IMAP ACLs
16449 @cindex editing imap acls
16450 @cindex Access Control Lists
16451 @cindex Editing @acronym{IMAP} ACLs
16452 @kindex G l (Group)
16453 @findex gnus-group-nnimap-edit-acl
16455 ACL stands for Access Control List. ACLs are used in @acronym{IMAP} for
16456 limiting (or enabling) other users access to your mail boxes. Not all
16457 @acronym{IMAP} servers support this, this function will give an error if it
16460 To edit an ACL for a mailbox, type @kbd{G l}
16461 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with an ACL
16462 editing window with detailed instructions.
16464 Some possible uses:
16468 Giving ``anyone'' the ``lrs'' rights (lookup, read, keep seen/unseen flags)
16469 on your mailing list mailboxes enables other users on the same server to
16470 follow the list without subscribing to it.
16472 At least with the Cyrus server, you are required to give the user
16473 ``anyone'' posting ("p") capabilities to have ``plussing'' work (that is,
16474 mail sent to user+mailbox@@domain ending up in the @acronym{IMAP} mailbox
16478 @node Expunging mailboxes
16479 @subsection Expunging mailboxes
16483 @cindex manual expunging
16484 @kindex G x (Group)
16485 @findex gnus-group-nnimap-expunge
16487 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
16488 you may want the option of expunging all deleted articles in a mailbox
16489 manually. This is exactly what @kbd{G x} does.
16491 Currently there is no way of showing deleted articles, you can just
16494 @node A note on namespaces
16495 @subsection A note on namespaces
16496 @cindex IMAP namespace
16499 The @acronym{IMAP} protocol has a concept called namespaces, described
16500 by the following text in the RFC:
16503 5.1.2. Mailbox Namespace Naming Convention
16505 By convention, the first hierarchical element of any mailbox name
16506 which begins with "#" identifies the "namespace" of the remainder of
16507 the name. This makes it possible to disambiguate between different
16508 types of mailbox stores, each of which have their own namespaces.
16510 For example, implementations which offer access to USENET
16511 newsgroups MAY use the "#news" namespace to partition the USENET
16512 newsgroup namespace from that of other mailboxes. Thus, the
16513 comp.mail.misc newsgroup would have an mailbox name of
16514 "#news.comp.mail.misc", and the name "comp.mail.misc" could refer
16515 to a different object (e.g. a user's private mailbox).
16518 While there is nothing in this text that warrants concern for the
16519 @acronym{IMAP} implementation in Gnus, some servers use namespace
16520 prefixes in a way that does not work with how Gnus uses mailbox names.
16522 Specifically, University of Washington's @acronym{IMAP} server uses
16523 mailbox names like @code{#driver.mbx/read-mail} which are valid only
16524 in the @sc{create} and @sc{append} commands. After the mailbox is
16525 created (or a messages is appended to a mailbox), it must be accessed
16526 without the namespace prefix, i.e. @code{read-mail}. Since Gnus do
16527 not make it possible for the user to guarantee that user entered
16528 mailbox names will only be used with the CREATE and APPEND commands,
16529 you should simply not use the namespace prefixed mailbox names in
16532 See the UoW IMAPD documentation for the @code{#driver.*/} prefix
16533 for more information on how to use the prefixes. They are a power
16534 tool and should be used only if you are sure what the effects are.
16536 @node Debugging IMAP
16537 @subsection Debugging IMAP
16538 @cindex IMAP debugging
16539 @cindex protocol dump (IMAP)
16541 @acronym{IMAP} is a complex protocol, more so than @acronym{NNTP} or
16542 @acronym{POP3}. Implementation bugs are not unlikely, and we do our
16543 best to fix them right away. If you encounter odd behaviour, chances
16544 are that either the server or Gnus is buggy.
16546 If you are familiar with network protocols in general, you will
16547 probably be able to extract some clues from the protocol dump of the
16548 exchanges between Gnus and the server. Even if you are not familiar
16549 with network protocols, when you include the protocol dump in
16550 @acronym{IMAP}-related bug reports you are helping us with data
16551 critical to solving the problem. Therefore, we strongly encourage you
16552 to include the protocol dump when reporting IMAP bugs in Gnus.
16556 Because the protocol dump, when enabled, generates lots of data, it is
16557 disabled by default. You can enable it by setting @code{imap-log} as
16564 This instructs the @code{imap.el} package to log any exchanges with
16565 the server. The log is stored in the buffer @samp{*imap-log*}. Look
16566 for error messages, which sometimes are tagged with the keyword
16567 @code{BAD}---but when submitting a bug, make sure to include all the
16570 @node Other Sources
16571 @section Other Sources
16573 Gnus can do more than just read news or mail. The methods described
16574 below allow Gnus to view directories and files as if they were
16578 * Directory Groups:: You can read a directory as if it was a newsgroup.
16579 * Anything Groups:: Dired? Who needs dired?
16580 * Document Groups:: Single files can be the basis of a group.
16581 * SOUP:: Reading @sc{soup} packets ``offline''.
16582 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
16586 @node Directory Groups
16587 @subsection Directory Groups
16589 @cindex directory groups
16591 If you have a directory that has lots of articles in separate files in
16592 it, you might treat it as a newsgroup. The files have to have numerical
16595 This might be an opportune moment to mention @code{ange-ftp} (and its
16596 successor @code{efs}), that most wonderful of all wonderful Emacs
16597 packages. When I wrote @code{nndir}, I didn't think much about it---a
16598 back end to read directories. Big deal.
16600 @code{ange-ftp} changes that picture dramatically. For instance, if you
16601 enter the @code{ange-ftp} file name
16602 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
16603 @code{ange-ftp} or @code{efs} will actually allow you to read this
16604 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
16606 @code{nndir} will use @acronym{NOV} files if they are present.
16608 @code{nndir} is a ``read-only'' back end---you can't delete or expire
16609 articles with this method. You can use @code{nnmh} or @code{nnml} for
16610 whatever you use @code{nndir} for, so you could switch to any of those
16611 methods if you feel the need to have a non-read-only @code{nndir}.
16614 @node Anything Groups
16615 @subsection Anything Groups
16618 From the @code{nndir} back end (which reads a single spool-like
16619 directory), it's just a hop and a skip to @code{nneething}, which
16620 pretends that any arbitrary directory is a newsgroup. Strange, but
16623 When @code{nneething} is presented with a directory, it will scan this
16624 directory and assign article numbers to each file. When you enter such
16625 a group, @code{nneething} must create ``headers'' that Gnus can use.
16626 After all, Gnus is a newsreader, in case you're forgetting.
16627 @code{nneething} does this in a two-step process. First, it snoops each
16628 file in question. If the file looks like an article (i.e., the first
16629 few lines look like headers), it will use this as the head. If this is
16630 just some arbitrary file without a head (e.g. a C source file),
16631 @code{nneething} will cobble up a header out of thin air. It will use
16632 file ownership, name and date and do whatever it can with these
16635 All this should happen automatically for you, and you will be presented
16636 with something that looks very much like a newsgroup. Totally like a
16637 newsgroup, to be precise. If you select an article, it will be displayed
16638 in the article buffer, just as usual.
16640 If you select a line that represents a directory, Gnus will pop you into
16641 a new summary buffer for this @code{nneething} group. And so on. You can
16642 traverse the entire disk this way, if you feel like, but remember that
16643 Gnus is not dired, really, and does not intend to be, either.
16645 There are two overall modes to this action---ephemeral or solid. When
16646 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
16647 will not store information on what files you have read, and what files
16648 are new, and so on. If you create a solid @code{nneething} group the
16649 normal way with @kbd{G m}, Gnus will store a mapping table between
16650 article numbers and file names, and you can treat this group like any
16651 other groups. When you activate a solid @code{nneething} group, you will
16652 be told how many unread articles it contains, etc., etc.
16657 @item nneething-map-file-directory
16658 @vindex nneething-map-file-directory
16659 All the mapping files for solid @code{nneething} groups will be stored
16660 in this directory, which defaults to @file{~/.nneething/}.
16662 @item nneething-exclude-files
16663 @vindex nneething-exclude-files
16664 All files that match this regexp will be ignored. Nice to use to exclude
16665 auto-save files and the like, which is what it does by default.
16667 @item nneething-include-files
16668 @vindex nneething-include-files
16669 Regexp saying what files to include in the group. If this variable is
16670 non-@code{nil}, only files matching this regexp will be included.
16672 @item nneething-map-file
16673 @vindex nneething-map-file
16674 Name of the map files.
16678 @node Document Groups
16679 @subsection Document Groups
16681 @cindex documentation group
16684 @code{nndoc} is a cute little thing that will let you read a single file
16685 as a newsgroup. Several files types are supported:
16692 The Babyl (Rmail) mail box.
16697 The standard Unix mbox file.
16699 @cindex MMDF mail box
16701 The MMDF mail box format.
16704 Several news articles appended into a file.
16707 @cindex rnews batch files
16708 The rnews batch transport format.
16709 @cindex forwarded messages
16712 Forwarded articles.
16715 Netscape mail boxes.
16718 @acronym{MIME} multipart messages.
16720 @item standard-digest
16721 The standard (RFC 1153) digest format.
16724 A @acronym{MIME} digest of messages.
16726 @item lanl-gov-announce
16727 Announcement messages from LANL Gov Announce.
16729 @item rfc822-forward
16730 A message forwarded according to RFC822.
16733 The Outlook mail box.
16736 The Outlook Express dbx mail box.
16739 A bounce message from the Exim MTA.
16742 A message forwarded according to informal rules.
16745 An RFC934-forwarded message.
16751 A digest of Clarinet brief news items.
16754 Non-standard digest format---matches most things, but does it badly.
16760 You can also use the special ``file type'' @code{guess}, which means
16761 that @code{nndoc} will try to guess what file type it is looking at.
16762 @code{digest} means that @code{nndoc} should guess what digest type the
16765 @code{nndoc} will not try to change the file or insert any extra headers into
16766 it---it will simply, like, let you use the file as the basis for a
16767 group. And that's it.
16769 If you have some old archived articles that you want to insert into your
16770 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
16771 that. Say you have an old @file{RMAIL} file with mail that you now want
16772 to split into your new @code{nnml} groups. You look at that file using
16773 @code{nndoc} (using the @kbd{G f} command in the group buffer
16774 (@pxref{Foreign Groups})), set the process mark on all the articles in
16775 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
16776 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
16777 file is now also stored in lots of @code{nnml} directories, and you can
16778 delete that pesky @file{RMAIL} file. If you have the guts!
16780 Virtual server variables:
16783 @item nndoc-article-type
16784 @vindex nndoc-article-type
16785 This should be one of @code{mbox}, @code{babyl}, @code{digest},
16786 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
16787 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
16788 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
16789 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
16791 @item nndoc-post-type
16792 @vindex nndoc-post-type
16793 This variable says whether Gnus is to consider the group a news group or
16794 a mail group. There are two valid values: @code{mail} (the default)
16799 * Document Server Internals:: How to add your own document types.
16803 @node Document Server Internals
16804 @subsubsection Document Server Internals
16806 Adding new document types to be recognized by @code{nndoc} isn't
16807 difficult. You just have to whip up a definition of what the document
16808 looks like, write a predicate function to recognize that document type,
16809 and then hook into @code{nndoc}.
16811 First, here's an example document type definition:
16815 (article-begin . "^\^A\^A\^A\^A\n")
16816 (body-end . "^\^A\^A\^A\^A\n"))
16819 The definition is simply a unique @dfn{name} followed by a series of
16820 regexp pseudo-variable settings. Below are the possible
16821 variables---don't be daunted by the number of variables; most document
16822 types can be defined with very few settings:
16825 @item first-article
16826 If present, @code{nndoc} will skip past all text until it finds
16827 something that match this regexp. All text before this will be
16830 @item article-begin
16831 This setting has to be present in all document type definitions. It
16832 says what the beginning of each article looks like.
16834 @item head-begin-function
16835 If present, this should be a function that moves point to the head of
16838 @item nndoc-head-begin
16839 If present, this should be a regexp that matches the head of the
16842 @item nndoc-head-end
16843 This should match the end of the head of the article. It defaults to
16844 @samp{^$}---the empty line.
16846 @item body-begin-function
16847 If present, this function should move point to the beginning of the body
16851 This should match the beginning of the body of the article. It defaults
16854 @item body-end-function
16855 If present, this function should move point to the end of the body of
16859 If present, this should match the end of the body of the article.
16862 If present, this should match the end of the file. All text after this
16863 regexp will be totally ignored.
16867 So, using these variables @code{nndoc} is able to dissect a document
16868 file into a series of articles, each with a head and a body. However, a
16869 few more variables are needed since not all document types are all that
16870 news-like---variables needed to transform the head or the body into
16871 something that's palatable for Gnus:
16874 @item prepare-body-function
16875 If present, this function will be called when requesting an article. It
16876 will be called with point at the start of the body, and is useful if the
16877 document has encoded some parts of its contents.
16879 @item article-transform-function
16880 If present, this function is called when requesting an article. It's
16881 meant to be used for more wide-ranging transformation of both head and
16882 body of the article.
16884 @item generate-head-function
16885 If present, this function is called to generate a head that Gnus can
16886 understand. It is called with the article number as a parameter, and is
16887 expected to generate a nice head for the article in question. It is
16888 called when requesting the headers of all articles.
16892 Let's look at the most complicated example I can come up with---standard
16897 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
16898 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
16899 (prepare-body-function . nndoc-unquote-dashes)
16900 (body-end-function . nndoc-digest-body-end)
16901 (head-end . "^ ?$")
16902 (body-begin . "^ ?\n")
16903 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
16904 (subtype digest guess))
16907 We see that all text before a 70-width line of dashes is ignored; all
16908 text after a line that starts with that @samp{^End of} is also ignored;
16909 each article begins with a 30-width line of dashes; the line separating
16910 the head from the body may contain a single space; and that the body is
16911 run through @code{nndoc-unquote-dashes} before being delivered.
16913 To hook your own document definition into @code{nndoc}, use the
16914 @code{nndoc-add-type} function. It takes two parameters---the first
16915 is the definition itself and the second (optional) parameter says
16916 where in the document type definition alist to put this definition.
16917 The alist is traversed sequentially, and
16918 @code{nndoc-@var{type}-type-p} is called for a given type @var{type}.
16919 So @code{nndoc-mmdf-type-p} is called to see whether a document is of
16920 @code{mmdf} type, and so on. These type predicates should return
16921 @code{nil} if the document is not of the correct type; @code{t} if it
16922 is of the correct type; and a number if the document might be of the
16923 correct type. A high number means high probability; a low number
16924 means low probability with @samp{0} being the lowest valid number.
16932 In the PC world people often talk about ``offline'' newsreaders. These
16933 are thingies that are combined reader/news transport monstrosities.
16934 With built-in modem programs. Yecchh!
16936 Of course, us Unix Weenie types of human beans use things like
16937 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
16938 transport things like Ghod intended. And then we just use normal
16941 However, it can sometimes be convenient to do something that's a bit
16942 easier on the brain if you have a very slow modem, and you're not really
16943 that interested in doing things properly.
16945 A file format called @sc{soup} has been developed for transporting news
16946 and mail from servers to home machines and back again. It can be a bit
16949 First some terminology:
16954 This is the machine that is connected to the outside world and where you
16955 get news and/or mail from.
16958 This is the machine that you want to do the actual reading and responding
16959 on. It is typically not connected to the rest of the world in any way.
16962 Something that contains messages and/or commands. There are two kinds
16966 @item message packets
16967 These are packets made at the server, and typically contain lots of
16968 messages for you to read. These are called @file{SoupoutX.tgz} by
16969 default, where @var{x} is a number.
16971 @item response packets
16972 These are packets made at the home machine, and typically contains
16973 replies that you've written. These are called @file{SoupinX.tgz} by
16974 default, where @var{x} is a number.
16984 You log in on the server and create a @sc{soup} packet. You can either
16985 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
16986 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
16987 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
16990 You transfer the packet home. Rail, boat, car or modem will do fine.
16993 You put the packet in your home directory.
16996 You fire up Gnus on your home machine using the @code{nnsoup} back end as
16997 the native or secondary server.
17000 You read articles and mail and answer and followup to the things you
17001 want (@pxref{SOUP Replies}).
17004 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
17008 You transfer this packet to the server.
17011 You use Gnus to mail this packet out with the @kbd{G s s} command.
17014 You then repeat until you die.
17018 So you basically have a bipartite system---you use @code{nnsoup} for
17019 reading and Gnus for packing/sending these @sc{soup} packets.
17022 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
17023 * SOUP Groups:: A back end for reading @sc{soup} packets.
17024 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
17028 @node SOUP Commands
17029 @subsubsection SOUP Commands
17031 These are commands for creating and manipulating @sc{soup} packets.
17035 @kindex G s b (Group)
17036 @findex gnus-group-brew-soup
17037 Pack all unread articles in the current group
17038 (@code{gnus-group-brew-soup}). This command understands the
17039 process/prefix convention.
17042 @kindex G s w (Group)
17043 @findex gnus-soup-save-areas
17044 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
17047 @kindex G s s (Group)
17048 @findex gnus-soup-send-replies
17049 Send all replies from the replies packet
17050 (@code{gnus-soup-send-replies}).
17053 @kindex G s p (Group)
17054 @findex gnus-soup-pack-packet
17055 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
17058 @kindex G s r (Group)
17059 @findex nnsoup-pack-replies
17060 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
17063 @kindex O s (Summary)
17064 @findex gnus-soup-add-article
17065 This summary-mode command adds the current article to a @sc{soup} packet
17066 (@code{gnus-soup-add-article}). It understands the process/prefix
17067 convention (@pxref{Process/Prefix}).
17072 There are a few variables to customize where Gnus will put all these
17077 @item gnus-soup-directory
17078 @vindex gnus-soup-directory
17079 Directory where Gnus will save intermediate files while composing
17080 @sc{soup} packets. The default is @file{~/SoupBrew/}.
17082 @item gnus-soup-replies-directory
17083 @vindex gnus-soup-replies-directory
17084 This is what Gnus will use as a temporary directory while sending our
17085 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
17087 @item gnus-soup-prefix-file
17088 @vindex gnus-soup-prefix-file
17089 Name of the file where Gnus stores the last used prefix. The default is
17090 @samp{gnus-prefix}.
17092 @item gnus-soup-packer
17093 @vindex gnus-soup-packer
17094 A format string command for packing a @sc{soup} packet. The default is
17095 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
17097 @item gnus-soup-unpacker
17098 @vindex gnus-soup-unpacker
17099 Format string command for unpacking a @sc{soup} packet. The default is
17100 @samp{gunzip -c %s | tar xvf -}.
17102 @item gnus-soup-packet-directory
17103 @vindex gnus-soup-packet-directory
17104 Where Gnus will look for reply packets. The default is @file{~/}.
17106 @item gnus-soup-packet-regexp
17107 @vindex gnus-soup-packet-regexp
17108 Regular expression matching @sc{soup} reply packets in
17109 @code{gnus-soup-packet-directory}.
17115 @subsubsection SOUP Groups
17118 @code{nnsoup} is the back end for reading @sc{soup} packets. It will
17119 read incoming packets, unpack them, and put them in a directory where
17120 you can read them at leisure.
17122 These are the variables you can use to customize its behavior:
17126 @item nnsoup-tmp-directory
17127 @vindex nnsoup-tmp-directory
17128 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
17129 directory. (@file{/tmp/} by default.)
17131 @item nnsoup-directory
17132 @vindex nnsoup-directory
17133 @code{nnsoup} then moves each message and index file to this directory.
17134 The default is @file{~/SOUP/}.
17136 @item nnsoup-replies-directory
17137 @vindex nnsoup-replies-directory
17138 All replies will be stored in this directory before being packed into a
17139 reply packet. The default is @file{~/SOUP/replies/}.
17141 @item nnsoup-replies-format-type
17142 @vindex nnsoup-replies-format-type
17143 The @sc{soup} format of the replies packets. The default is @samp{?n}
17144 (rnews), and I don't think you should touch that variable. I probably
17145 shouldn't even have documented it. Drats! Too late!
17147 @item nnsoup-replies-index-type
17148 @vindex nnsoup-replies-index-type
17149 The index type of the replies packet. The default is @samp{?n}, which
17150 means ``none''. Don't fiddle with this one either!
17152 @item nnsoup-active-file
17153 @vindex nnsoup-active-file
17154 Where @code{nnsoup} stores lots of information. This is not an ``active
17155 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
17156 this file or mess it up in any way, you're dead. The default is
17157 @file{~/SOUP/active}.
17159 @item nnsoup-packer
17160 @vindex nnsoup-packer
17161 Format string command for packing a reply @sc{soup} packet. The default
17162 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
17164 @item nnsoup-unpacker
17165 @vindex nnsoup-unpacker
17166 Format string command for unpacking incoming @sc{soup} packets. The
17167 default is @samp{gunzip -c %s | tar xvf -}.
17169 @item nnsoup-packet-directory
17170 @vindex nnsoup-packet-directory
17171 Where @code{nnsoup} will look for incoming packets. The default is
17174 @item nnsoup-packet-regexp
17175 @vindex nnsoup-packet-regexp
17176 Regular expression matching incoming @sc{soup} packets. The default is
17179 @item nnsoup-always-save
17180 @vindex nnsoup-always-save
17181 If non-@code{nil}, save the replies buffer after each posted message.
17187 @subsubsection SOUP Replies
17189 Just using @code{nnsoup} won't mean that your postings and mailings end
17190 up in @sc{soup} reply packets automagically. You have to work a bit
17191 more for that to happen.
17193 @findex nnsoup-set-variables
17194 The @code{nnsoup-set-variables} command will set the appropriate
17195 variables to ensure that all your followups and replies end up in the
17198 In specific, this is what it does:
17201 (setq message-send-news-function 'nnsoup-request-post)
17202 (setq message-send-mail-function 'nnsoup-request-mail)
17205 And that's it, really. If you only want news to go into the @sc{soup}
17206 system you just use the first line. If you only want mail to be
17207 @sc{soup}ed you use the second.
17210 @node Mail-To-News Gateways
17211 @subsection Mail-To-News Gateways
17212 @cindex mail-to-news gateways
17215 If your local @code{nntp} server doesn't allow posting, for some reason
17216 or other, you can post using one of the numerous mail-to-news gateways.
17217 The @code{nngateway} back end provides the interface.
17219 Note that you can't read anything from this back end---it can only be
17225 @item nngateway-address
17226 @vindex nngateway-address
17227 This is the address of the mail-to-news gateway.
17229 @item nngateway-header-transformation
17230 @vindex nngateway-header-transformation
17231 News headers often have to be transformed in some odd way or other
17232 for the mail-to-news gateway to accept it. This variable says what
17233 transformation should be called, and defaults to
17234 @code{nngateway-simple-header-transformation}. The function is called
17235 narrowed to the headers to be transformed and with one parameter---the
17238 This default function just inserts a new @code{To} header based on the
17239 @code{Newsgroups} header and the gateway address.
17240 For instance, an article with this @code{Newsgroups} header:
17243 Newsgroups: alt.religion.emacs
17246 will get this @code{To} header inserted:
17249 To: alt-religion-emacs@@GATEWAY
17252 The following pre-defined functions exist:
17254 @findex nngateway-simple-header-transformation
17257 @item nngateway-simple-header-transformation
17258 Creates a @code{To} header that looks like
17259 @var{newsgroup}@@@code{nngateway-address}.
17261 @findex nngateway-mail2news-header-transformation
17263 @item nngateway-mail2news-header-transformation
17264 Creates a @code{To} header that looks like
17265 @code{nngateway-address}.
17273 (setq gnus-post-method
17275 "mail2news@@replay.com"
17276 (nngateway-header-transformation
17277 nngateway-mail2news-header-transformation)))
17280 So, to use this, simply say something like:
17283 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
17288 @node Combined Groups
17289 @section Combined Groups
17291 Gnus allows combining a mixture of all the other group types into bigger
17295 * Virtual Groups:: Combining articles from many groups.
17296 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
17300 @node Virtual Groups
17301 @subsection Virtual Groups
17303 @cindex virtual groups
17304 @cindex merging groups
17306 An @dfn{nnvirtual group} is really nothing more than a collection of
17309 For instance, if you are tired of reading many small groups, you can
17310 put them all in one big group, and then grow tired of reading one
17311 big, unwieldy group. The joys of computing!
17313 You specify @code{nnvirtual} as the method. The address should be a
17314 regexp to match component groups.
17316 All marks in the virtual group will stick to the articles in the
17317 component groups. So if you tick an article in a virtual group, the
17318 article will also be ticked in the component group from whence it
17319 came. (And vice versa---marks from the component groups will also be
17320 shown in the virtual group.). To create an empty virtual group, run
17321 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
17322 and edit the method regexp with @kbd{M-e}
17323 (@code{gnus-group-edit-group-method})
17325 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
17326 newsgroups into one, big, happy newsgroup:
17329 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
17332 The component groups can be native or foreign; everything should work
17333 smoothly, but if your computer explodes, it was probably my fault.
17335 Collecting the same group from several servers might actually be a good
17336 idea if users have set the Distribution header to limit distribution.
17337 If you would like to read @samp{soc.motss} both from a server in Japan
17338 and a server in Norway, you could use the following as the group regexp:
17341 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
17344 (Remember, though, that if you're creating the group with @kbd{G m}, you
17345 shouldn't double the backslashes, and you should leave off the quote
17346 characters at the beginning and the end of the string.)
17348 This should work kinda smoothly---all articles from both groups should
17349 end up in this one, and there should be no duplicates. Threading (and
17350 the rest) will still work as usual, but there might be problems with the
17351 sequence of articles. Sorting on date might be an option here
17352 (@pxref{Selecting a Group}).
17354 One limitation, however---all groups included in a virtual
17355 group have to be alive (i.e., subscribed or unsubscribed). Killed or
17356 zombie groups can't be component groups for @code{nnvirtual} groups.
17358 @vindex nnvirtual-always-rescan
17359 If the @code{nnvirtual-always-rescan} is non-@code{nil},
17360 @code{nnvirtual} will always scan groups for unread articles when
17361 entering a virtual group. If this variable is @code{nil} (which is the
17362 default) and you read articles in a component group after the virtual
17363 group has been activated, the read articles from the component group
17364 will show up when you enter the virtual group. You'll also see this
17365 effect if you have two virtual groups that have a component group in
17366 common. If that's the case, you should set this variable to @code{t}.
17367 Or you can just tap @code{M-g} on the virtual group every time before
17368 you enter it---it'll have much the same effect.
17370 @code{nnvirtual} can have both mail and news groups as component groups.
17371 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
17372 has to ask the back end of the component group the article comes from
17373 whether it is a news or mail back end. However, when you do a @kbd{^},
17374 there is typically no sure way for the component back end to know this,
17375 and in that case @code{nnvirtual} tells Gnus that the article came from a
17376 not-news back end. (Just to be on the safe side.)
17378 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
17379 line from the article you respond to in these cases.
17381 @code{nnvirtual} groups do not inherit anything but articles and marks
17382 from component groups---group parameters, for instance, are not
17386 @node Kibozed Groups
17387 @subsection Kibozed Groups
17391 @dfn{Kibozing} is defined by the @acronym{OED} as ``grepping through
17392 (parts of) the news feed''. @code{nnkiboze} is a back end that will
17393 do this for you. Oh joy! Now you can grind any @acronym{NNTP} server
17394 down to a halt with useless requests! Oh happiness!
17396 @kindex G k (Group)
17397 To create a kibozed group, use the @kbd{G k} command in the group
17400 The address field of the @code{nnkiboze} method is, as with
17401 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
17402 @code{nnkiboze} group. That's where most similarities between
17403 @code{nnkiboze} and @code{nnvirtual} end.
17405 In addition to this regexp detailing component groups, an
17406 @code{nnkiboze} group must have a score file to say what articles are
17407 to be included in the group (@pxref{Scoring}).
17409 @kindex M-x nnkiboze-generate-groups
17410 @findex nnkiboze-generate-groups
17411 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
17412 @code{nnkiboze} groups you want to have. This command will take time.
17413 Lots of time. Oodles and oodles of time. Gnus has to fetch the
17414 headers from all the articles in all the component groups and run them
17415 through the scoring process to determine if there are any articles in
17416 the groups that are to be part of the @code{nnkiboze} groups.
17418 Please limit the number of component groups by using restrictive
17419 regexps. Otherwise your sysadmin may become annoyed with you, and the
17420 @acronym{NNTP} site may throw you off and never let you back in again.
17421 Stranger things have happened.
17423 @code{nnkiboze} component groups do not have to be alive---they can be dead,
17424 and they can be foreign. No restrictions.
17426 @vindex nnkiboze-directory
17427 The generation of an @code{nnkiboze} group means writing two files in
17428 @code{nnkiboze-directory}, which is @file{~/News/kiboze/} by default.
17429 One contains the @acronym{NOV} header lines for all the articles in
17430 the group, and the other is an additional @file{.newsrc} file to store
17431 information on what groups have been searched through to find
17432 component articles.
17434 Articles marked as read in the @code{nnkiboze} group will have
17435 their @acronym{NOV} lines removed from the @acronym{NOV} file.
17438 @node Gnus Unplugged
17439 @section Gnus Unplugged
17444 @cindex Gnus unplugged
17446 In olden times (ca. February '88), people used to run their newsreaders
17447 on big machines with permanent connections to the net. News transport
17448 was dealt with by news servers, and all the newsreaders had to do was to
17449 read news. Believe it or not.
17451 Nowadays most people read news and mail at home, and use some sort of
17452 modem to connect to the net. To avoid running up huge phone bills, it
17453 would be nice to have a way to slurp down all the news and mail, hang up
17454 the phone, read for several hours, and then upload any responses you
17455 have to make. And then you repeat the procedure.
17457 Of course, you can use news servers for doing this as well. I've used
17458 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
17459 for some years, but doing that's a bore. Moving the news server
17460 functionality up to the newsreader makes sense if you're the only person
17461 reading news on a machine.
17463 Setting up Gnus as an ``offline'' newsreader is quite simple. In
17464 fact, you don't have to configure anything as the agent is now enabled
17465 by default (@pxref{Agent Variables, gnus-agent}).
17467 Of course, to use it as such, you have to learn a few new commands.
17470 * Agent Basics:: How it all is supposed to work.
17471 * Agent Categories:: How to tell the Gnus Agent what to download.
17472 * Agent Commands:: New commands for all the buffers.
17473 * Agent Visuals:: Ways that the agent may effect your summary buffer.
17474 * Agent as Cache:: The Agent is a big cache too.
17475 * Agent Expiry:: How to make old articles go away.
17476 * Agent Regeneration:: How to recover from lost connections and other accidents.
17477 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
17478 * Outgoing Messages:: What happens when you post/mail something?
17479 * Agent Variables:: Customizing is fun.
17480 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
17481 * Batching Agents:: How to fetch news from a @code{cron} job.
17482 * Agent Caveats:: What you think it'll do and what it does.
17487 @subsection Agent Basics
17489 First, let's get some terminology out of the way.
17491 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
17492 connection to the net (and notified the Agent that this is the case).
17493 When the connection to the net is up again (and Gnus knows this), the
17494 Agent is @dfn{plugged}.
17496 The @dfn{local} machine is the one you're running on, and which isn't
17497 connected to the net continuously.
17499 @dfn{Downloading} means fetching things from the net to your local
17500 machine. @dfn{Uploading} is doing the opposite.
17502 You know that Gnus gives you all the opportunity you'd ever want for
17503 shooting yourself in the foot. Some people call it flexibility. Gnus
17504 is also customizable to a great extent, which means that the user has a
17505 say on how Gnus behaves. Other newsreaders might unconditionally shoot
17506 you in your foot, but with Gnus, you have a choice!
17508 Gnus is never really in plugged or unplugged state. Rather, it applies
17509 that state to each server individually. This means that some servers
17510 can be plugged while others can be unplugged. Additionally, some
17511 servers can be ignored by the Agent altogether (which means that
17512 they're kinda like plugged always).
17514 So when you unplug the Agent and then wonder why is Gnus opening a
17515 connection to the Net, the next step to do is to look whether all
17516 servers are agentized. If there is an unagentized server, you found
17519 Another thing is the @dfn{offline} state. Sometimes, servers aren't
17520 reachable. When Gnus notices this, it asks you whether you want the
17521 server to be switched to offline state. If you say yes, then the
17522 server will behave somewhat as if it was unplugged, except that Gnus
17523 will ask you whether you want to switch it back online again.
17525 Let's take a typical Gnus session using the Agent.
17530 @findex gnus-unplugged
17531 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
17532 Agent in a disconnected state. You can read all the news that you have
17533 already fetched while in this mode.
17536 You then decide to see whether any new news has arrived. You connect
17537 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
17538 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
17539 as usual. To check for new mail in unplugged mode (@pxref{Mail
17540 Source Specifiers}).
17543 You can then read the new news immediately, or you can download the
17544 news onto your local machine. If you want to do the latter, you press
17545 @kbd{g} to check if there are any new news and then @kbd{J s} to fetch
17546 all the eligible articles in all the groups. (To let Gnus know which
17547 articles you want to download, @pxref{Agent Categories}).
17550 After fetching the articles, you press @kbd{J j} to make Gnus become
17551 unplugged again, and you shut down the PPP thing (or whatever). And
17552 then you read the news offline.
17555 And then you go to step 2.
17558 Here are some things you should do the first time (or so) that you use
17564 Decide which servers should be covered by the Agent. If you have a mail
17565 back end, it would probably be nonsensical to have it covered by the
17566 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
17567 @kbd{J a} on the server (or servers) that you wish to have covered by the
17568 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
17569 added servers you do not wish to have covered by the Agent. By default,
17570 all @code{nntp} and @code{nnimap} servers in @code{gnus-select-method} and
17571 @code{gnus-secondary-select-methods} are agentized.
17574 Decide on download policy. It's fairly simple once you decide whether
17575 you are going to use agent categories, topic parameters, and/or group
17576 parameters to implement your policy. If you're new to gnus, it
17577 is probably best to start with a category, @xref{Agent Categories}.
17579 Both topic parameters (@pxref{Topic Parameters}) and agent categories
17580 (@pxref{Agent Categories}) provide for setting a policy that applies
17581 to multiple groups. Which you use is entirely up to you. Topic
17582 parameters do override categories so, if you mix the two, you'll have
17583 to take that into account. If you have a few groups that deviate from
17584 your policy, you can use group parameters (@pxref{Group Parameters}) to
17588 Uhm@dots{} that's it.
17592 @node Agent Categories
17593 @subsection Agent Categories
17595 One of the main reasons to integrate the news transport layer into the
17596 newsreader is to allow greater control over what articles to download.
17597 There's not much point in downloading huge amounts of articles, just to
17598 find out that you're not interested in reading any of them. It's better
17599 to be somewhat more conservative in choosing what to download, and then
17600 mark the articles for downloading manually if it should turn out that
17601 you're interested in the articles anyway.
17603 One of the more effective methods for controlling what is to be
17604 downloaded is to create a @dfn{category} and then assign some (or all)
17605 groups to this category. Groups that do not belong in any other
17606 category belong to the @code{default} category. Gnus has its own
17607 buffer for creating and managing categories.
17609 If you prefer, you can also use group parameters (@pxref{Group
17610 Parameters}) and topic parameters (@pxref{Topic Parameters}) for an
17611 alternative approach to controlling the agent. The only real
17612 difference is that categories are specific to the agent (so there is
17613 less to learn) while group and topic parameters include the kitchen
17616 Since you can set agent parameters in several different places we have
17617 a rule to decide which source to believe. This rule specifies that
17618 the parameter sources are checked in the following order: group
17619 parameters, topic parameters, agent category, and finally customizable
17620 variables. So you can mix all of these sources to produce a wide range
17621 of behavior, just don't blame me if you don't remember where you put
17625 * Category Syntax:: What a category looks like.
17626 * Category Buffer:: A buffer for maintaining categories.
17627 * Category Variables:: Customize'r'Us.
17631 @node Category Syntax
17632 @subsubsection Category Syntax
17634 A category consists of a name, the list of groups belonging to the
17635 category, and a number of optional parameters that override the
17636 customizable variables. The complete list of agent parameters are
17639 @cindex Agent Parameters
17641 @item agent-cat-name
17642 The name of the category.
17645 The list of groups that are in this category.
17647 @item agent-predicate
17648 A predicate which (generally) gives a rough outline of which articles
17649 are eligible for downloading; and
17651 @item agent-score-file
17652 a score rule which (generally) gives you a finer granularity when
17653 deciding what articles to download. (Note that this @dfn{download
17654 score} is not necessarily related to normal scores.)
17656 @item agent-enable-expiration
17657 a boolean indicating whether the agent should expire old articles in
17658 this group. Most groups should be expired to conserve disk space. In
17659 fact, its probably safe to say that the gnus.* hierarchy contains the
17660 only groups that should not be expired.
17662 @item agent-days-until-old
17663 an integer indicating the number of days that the agent should wait
17664 before deciding that a read article is safe to expire.
17666 @item agent-low-score
17667 an integer that overrides the value of @code{gnus-agent-low-score}.
17669 @item agent-high-score
17670 an integer that overrides the value of @code{gnus-agent-high-score}.
17672 @item agent-length-when-short
17673 an integer that overrides the value of
17674 @code{gnus-agent-short-article}.
17676 @item agent-length-when-long
17677 an integer that overrides the value of @code{gnus-agent-long-article}.
17679 @item agent-enable-undownloaded-faces
17680 a symbol indicating whether the summary buffer should display
17681 undownloaded articles using the gnus-summary-*-undownloaded-face
17682 faces. Any symbol other than nil will enable the use of undownloaded
17686 The name of a category can not be changed once the category has been
17689 Each category maintains a list of groups that are exclusive members of
17690 that category. The exclusivity rule is automatically enforced, add a
17691 group to a new category and it is automatically removed from its old
17694 A predicate in its simplest form can be a single predicate such as
17695 @code{true} or @code{false}. These two will download every available
17696 article or nothing respectively. In the case of these two special
17697 predicates an additional score rule is superfluous.
17699 Predicates of @code{high} or @code{low} download articles in respect of
17700 their scores in relationship to @code{gnus-agent-high-score} and
17701 @code{gnus-agent-low-score} as described below.
17703 To gain even finer control of what is to be regarded eligible for
17704 download a predicate can consist of a number of predicates with logical
17705 operators sprinkled in between.
17707 Perhaps some examples are in order.
17709 Here's a simple predicate. (It's the default predicate, in fact, used
17710 for all groups that don't belong to any other category.)
17716 Quite simple, eh? This predicate is true if and only if the article is
17717 short (for some value of ``short'').
17719 Here's a more complex predicate:
17728 This means that an article should be downloaded if it has a high score,
17729 or if the score is not low and the article is not long. You get the
17732 The available logical operators are @code{or}, @code{and} and
17733 @code{not}. (If you prefer, you can use the more ``C''-ish operators
17734 @samp{|}, @code{&} and @code{!} instead.)
17736 The following predicates are pre-defined, but if none of these fit what
17737 you want to do, you can write your own.
17739 When evaluating each of these predicates, the named constant will be
17740 bound to the value determined by calling
17741 @code{gnus-agent-find-parameter} on the appropriate parameter. For
17742 example, gnus-agent-short-article will be bound to
17743 @code{(gnus-agent-find-parameter group 'agent-short-article)}. This
17744 means that you can specify a predicate in your category then tune that
17745 predicate to individual groups.
17749 True iff the article is shorter than @code{gnus-agent-short-article}
17750 lines; default 100.
17753 True iff the article is longer than @code{gnus-agent-long-article}
17754 lines; default 200.
17757 True iff the article has a download score less than
17758 @code{gnus-agent-low-score}; default 0.
17761 True iff the article has a download score greater than
17762 @code{gnus-agent-high-score}; default 0.
17765 True iff the Gnus Agent guesses that the article is spam. The
17766 heuristics may change over time, but at present it just computes a
17767 checksum and sees whether articles match.
17776 If you want to create your own predicate function, here's what you have
17777 to know: The functions are called with no parameters, but the
17778 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
17781 For example, you could decide that you don't want to download articles
17782 that were posted more than a certain number of days ago (e.g. posted
17783 more than @code{gnus-agent-expire-days} ago) you might write a function
17784 something along the lines of the following:
17787 (defun my-article-old-p ()
17788 "Say whether an article is old."
17789 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
17790 (- (time-to-days (current-time)) gnus-agent-expire-days)))
17793 with the predicate then defined as:
17796 (not my-article-old-p)
17799 or you could append your predicate to the predefined
17800 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
17804 (require 'gnus-agent)
17805 (setq gnus-category-predicate-alist
17806 (append gnus-category-predicate-alist
17807 '((old . my-article-old-p))))
17810 and simply specify your predicate as:
17816 If/when using something like the above, be aware that there are many
17817 misconfigured systems/mailers out there and so an article's date is not
17818 always a reliable indication of when it was posted. Hell, some people
17819 just don't give a damn.
17821 The above predicates apply to @emph{all} the groups which belong to the
17822 category. However, if you wish to have a specific predicate for an
17823 individual group within a category, or you're just too lazy to set up a
17824 new category, you can enter a group's individual predicate in its group
17825 parameters like so:
17828 (agent-predicate . short)
17831 This is the group/topic parameter equivalent of the agent category default.
17832 Note that when specifying a single word predicate like this, the
17833 @code{agent-predicate} specification must be in dotted pair notation.
17835 The equivalent of the longer example from above would be:
17838 (agent-predicate or high (and (not low) (not long)))
17841 The outer parenthesis required in the category specification are not
17842 entered here as, not being in dotted pair notation, the value of the
17843 predicate is assumed to be a list.
17846 Now, the syntax of the download score is the same as the syntax of
17847 normal score files, except that all elements that require actually
17848 seeing the article itself are verboten. This means that only the
17849 following headers can be scored on: @code{Subject}, @code{From},
17850 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
17851 @code{Lines}, and @code{Xref}.
17853 As with predicates, the specification of the @code{download score rule}
17854 to use in respect of a group can be in either the category definition if
17855 it's to be applicable to all groups in therein, or a group's parameters
17856 if it's to be specific to that group.
17858 In both of these places the @code{download score rule} can take one of
17865 This has the same syntax as a normal Gnus score file except only a
17866 subset of scoring keywords are available as mentioned above.
17872 Category specification
17876 ("Lars Ingebrigtsen" 1000000 nil s))
17882 Group/Topic Parameter specification
17885 (agent-score ("from"
17886 ("Lars Ingebrigtsen" 1000000 nil s))
17891 Again, note the omission of the outermost parenthesis here.
17897 These score files must @emph{only} contain the permitted scoring
17898 keywords stated above.
17904 Category specification
17907 ("~/News/agent.SCORE")
17913 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
17917 Group Parameter specification
17920 (agent-score "~/News/agent.SCORE")
17923 Additional score files can be specified as above. Need I say anything
17928 Use @code{normal} score files
17930 If you don't want to maintain two sets of scoring rules for a group, and
17931 your desired @code{downloading} criteria for a group are the same as your
17932 @code{reading} criteria then you can tell the agent to refer to your
17933 @code{normal} score files when deciding what to download.
17935 These directives in either the category definition or a group's
17936 parameters will cause the agent to read in all the applicable score
17937 files for a group, @emph{filtering out} those sections that do not
17938 relate to one of the permitted subset of scoring keywords.
17942 Category Specification
17949 Group Parameter specification
17952 (agent-score . file)
17957 @node Category Buffer
17958 @subsubsection Category Buffer
17960 You'd normally do all category maintenance from the category buffer.
17961 When you enter it for the first time (with the @kbd{J c} command from
17962 the group buffer), you'll only see the @code{default} category.
17964 The following commands are available in this buffer:
17968 @kindex q (Category)
17969 @findex gnus-category-exit
17970 Return to the group buffer (@code{gnus-category-exit}).
17973 @kindex e (Category)
17974 @findex gnus-category-customize-category
17975 Use a customization buffer to set all of the selected category's
17976 parameters at one time (@code{gnus-category-customize-category}).
17979 @kindex k (Category)
17980 @findex gnus-category-kill
17981 Kill the current category (@code{gnus-category-kill}).
17984 @kindex c (Category)
17985 @findex gnus-category-copy
17986 Copy the current category (@code{gnus-category-copy}).
17989 @kindex a (Category)
17990 @findex gnus-category-add
17991 Add a new category (@code{gnus-category-add}).
17994 @kindex p (Category)
17995 @findex gnus-category-edit-predicate
17996 Edit the predicate of the current category
17997 (@code{gnus-category-edit-predicate}).
18000 @kindex g (Category)
18001 @findex gnus-category-edit-groups
18002 Edit the list of groups belonging to the current category
18003 (@code{gnus-category-edit-groups}).
18006 @kindex s (Category)
18007 @findex gnus-category-edit-score
18008 Edit the download score rule of the current category
18009 (@code{gnus-category-edit-score}).
18012 @kindex l (Category)
18013 @findex gnus-category-list
18014 List all the categories (@code{gnus-category-list}).
18018 @node Category Variables
18019 @subsubsection Category Variables
18022 @item gnus-category-mode-hook
18023 @vindex gnus-category-mode-hook
18024 Hook run in category buffers.
18026 @item gnus-category-line-format
18027 @vindex gnus-category-line-format
18028 Format of the lines in the category buffer (@pxref{Formatting
18029 Variables}). Valid elements are:
18033 The name of the category.
18036 The number of groups in the category.
18039 @item gnus-category-mode-line-format
18040 @vindex gnus-category-mode-line-format
18041 Format of the category mode line (@pxref{Mode Line Formatting}).
18043 @item gnus-agent-short-article
18044 @vindex gnus-agent-short-article
18045 Articles that have fewer lines than this are short. Default 100.
18047 @item gnus-agent-long-article
18048 @vindex gnus-agent-long-article
18049 Articles that have more lines than this are long. Default 200.
18051 @item gnus-agent-low-score
18052 @vindex gnus-agent-low-score
18053 Articles that have a score lower than this have a low score. Default
18056 @item gnus-agent-high-score
18057 @vindex gnus-agent-high-score
18058 Articles that have a score higher than this have a high score. Default
18061 @item gnus-agent-expire-days
18062 @vindex gnus-agent-expire-days
18063 The number of days that a @samp{read} article must stay in the agent's
18064 local disk before becoming eligible for expiration (While the name is
18065 the same, this doesn't mean expiring the article on the server. It
18066 just means deleting the local copy of the article). What is also
18067 important to understand is that the counter starts with the time the
18068 article was written to the local disk and not the time the article was
18072 @item gnus-agent-enable-expiration
18073 @vindex gnus-agent-enable-expiration
18074 Determines whether articles in a group are, by default, expired or
18075 retained indefinitely. The default is @code{ENABLE} which means that
18076 you'll have to disable expiration when desired. On the other hand,
18077 you could set this to @code{DISABLE}. In that case, you would then
18078 have to enable expiration in selected groups.
18083 @node Agent Commands
18084 @subsection Agent Commands
18085 @findex gnus-agent-toggle-plugged
18086 @kindex J j (Agent)
18088 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
18089 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
18090 toggles the plugged/unplugged state of the Gnus Agent.
18094 * Group Agent Commands:: Configure groups and fetch their contents.
18095 * Summary Agent Commands:: Manually select then fetch specific articles.
18096 * Server Agent Commands:: Select the servers that are supported by the agent.
18102 @node Group Agent Commands
18103 @subsubsection Group Agent Commands
18107 @kindex J u (Agent Group)
18108 @findex gnus-agent-fetch-groups
18109 Fetch all eligible articles in the current group
18110 (@code{gnus-agent-fetch-groups}).
18113 @kindex J c (Agent Group)
18114 @findex gnus-enter-category-buffer
18115 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
18118 @kindex J s (Agent Group)
18119 @findex gnus-agent-fetch-session
18120 Fetch all eligible articles in all groups
18121 (@code{gnus-agent-fetch-session}).
18124 @kindex J S (Agent Group)
18125 @findex gnus-group-send-queue
18126 Send all sendable messages in the queue group
18127 (@code{gnus-group-send-queue}). @xref{Drafts}.
18130 @kindex J a (Agent Group)
18131 @findex gnus-agent-add-group
18132 Add the current group to an Agent category
18133 (@code{gnus-agent-add-group}). This command understands the
18134 process/prefix convention (@pxref{Process/Prefix}).
18137 @kindex J r (Agent Group)
18138 @findex gnus-agent-remove-group
18139 Remove the current group from its category, if any
18140 (@code{gnus-agent-remove-group}). This command understands the
18141 process/prefix convention (@pxref{Process/Prefix}).
18144 @kindex J Y (Agent Group)
18145 @findex gnus-agent-synchronize-flags
18146 Synchronize flags changed while unplugged with remote server, if any.
18152 @node Summary Agent Commands
18153 @subsubsection Summary Agent Commands
18157 @kindex J # (Agent Summary)
18158 @findex gnus-agent-mark-article
18159 Mark the article for downloading (@code{gnus-agent-mark-article}).
18162 @kindex J M-# (Agent Summary)
18163 @findex gnus-agent-unmark-article
18164 Remove the downloading mark from the article
18165 (@code{gnus-agent-unmark-article}).
18169 @kindex @@ (Agent Summary)
18170 @findex gnus-agent-toggle-mark
18171 Toggle whether to download the article
18172 (@code{gnus-agent-toggle-mark}). The download mark is @samp{%} by
18176 @kindex J c (Agent Summary)
18177 @findex gnus-agent-catchup
18178 Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable.
18181 @kindex J S (Agent Summary)
18182 @findex gnus-agent-fetch-group
18183 Download all eligible (@pxref{Agent Categories}) articles in this group.
18184 (@code{gnus-agent-fetch-group}).
18187 @kindex J s (Agent Summary)
18188 @findex gnus-agent-fetch-series
18189 Download all processable articles in this group.
18190 (@code{gnus-agent-fetch-series}).
18193 @kindex J u (Agent Summary)
18194 @findex gnus-agent-summary-fetch-group
18195 Download all downloadable articles in the current group
18196 (@code{gnus-agent-summary-fetch-group}).
18201 @node Server Agent Commands
18202 @subsubsection Server Agent Commands
18206 @kindex J a (Agent Server)
18207 @findex gnus-agent-add-server
18208 Add the current server to the list of servers covered by the Gnus Agent
18209 (@code{gnus-agent-add-server}).
18212 @kindex J r (Agent Server)
18213 @findex gnus-agent-remove-server
18214 Remove the current server from the list of servers covered by the Gnus
18215 Agent (@code{gnus-agent-remove-server}).
18220 @node Agent Visuals
18221 @subsection Agent Visuals
18223 If you open a summary while unplugged and, Gnus knows from the group's
18224 active range that there are more articles than the headers currently
18225 stored in the Agent, you may see some articles whose subject looks
18226 something like @samp{[Undownloaded article #####]}. These are
18227 placeholders for the missing headers. Aside from setting a mark,
18228 there is not much that can be done with one of these placeholders.
18229 When Gnus finally gets a chance to fetch the group's headers, the
18230 placeholders will automatically be replaced by the actual headers.
18231 You can configure the summary buffer's maneuvering to skip over the
18232 placeholders if you care (See @code{gnus-auto-goto-ignores}).
18234 While it may be obvious to all, the only headers and articles
18235 available while unplugged are those headers and articles that were
18236 fetched into the Agent while previously plugged. To put it another
18237 way, "If you forget to fetch something while plugged, you might have a
18238 less than satisfying unplugged session". For this reason, the Agent
18239 adds two visual effects to your summary buffer. These effects display
18240 the download status of each article so that you always know which
18241 articles will be available when unplugged.
18243 The first visual effect is the @samp{%O} spec. If you customize
18244 @code{gnus-summary-line-format} to include this specifier, you will add
18245 a single character field that indicates an article's download status.
18246 Articles that have been fetched into either the Agent or the Cache,
18247 will display @code{gnus-downloaded-mark} (defaults to @samp{+}). All
18248 other articles will display @code{gnus-undownloaded-mark} (defaults to
18249 @samp{-}). If you open a group that has not been agentized, a space
18250 (@samp{ }) will be displayed.
18252 The second visual effect are the undownloaded faces. The faces, there
18253 are three indicating the article's score (low, normal, high), seem to
18254 result in a love/hate response from many Gnus users. The problem is
18255 that the face selection is controlled by a list of condition tests and
18256 face names (See @code{gnus-summary-highlight}). Each condition is
18257 tested in the order in which it appears in the list so early
18258 conditions have precedence over later conditions. All of this means
18259 that, if you tick an undownloaded article, the article will continue
18260 to be displayed in the undownloaded face rather than the ticked face.
18262 If you use the Agent as a cache (to avoid downloading the same article
18263 each time you visit it or to minimize your connection time), the
18264 undownloaded face will probably seem like a good idea. The reason
18265 being that you do all of our work (marking, reading, deleting) with
18266 downloaded articles so the normal faces always appear. For those
18267 users using the agent to improve online performance by caching the NOV
18268 database (most users since 5.10.2), the undownloaded faces may appear
18269 to be an absolutely horrible idea. The issue being that, since none
18270 of their articles have been fetched into the Agent, all of the
18271 normal faces will be obscured by the undownloaded faces.
18273 If you would like to use the undownloaded faces, you must enable the
18274 undownloaded faces by setting the @code{agent-enable-undownloaded-faces}
18275 group parameter to t. This parameter, like all other agent
18276 parameters, may be set on an Agent Category (@pxref{Agent
18277 Categories}), a Group Topic (@pxref{Topic Parameters}), or an
18278 individual group (@pxref{Group Parameters}).
18280 @node Agent as Cache
18281 @subsection Agent as Cache
18283 When Gnus is plugged, it is not efficient to download headers or
18284 articles from the server again, if they are already stored in the
18285 Agent. So, Gnus normally only downloads headers once, and stores them
18286 in the Agent. These headers are later used when generating the summary
18287 buffer, regardless of whether you are plugged or unplugged. Articles
18288 are not cached in the Agent by default though (that would potentially
18289 consume lots of disk space), but if you have already downloaded an
18290 article into the Agent, Gnus will not download the article from the
18291 server again but use the locally stored copy instead.
18293 If you so desire, you can configure the agent (see @code{gnus-agent-cache}
18294 @pxref{Agent Variables}) to always download headers and articles while
18295 plugged. Gnus will almost certainly be slower, but it will be kept
18296 synchronized with the server. That last point probably won't make any
18297 sense if you are using a nntp or nnimap back end.
18300 @subsection Agent Expiry
18302 @vindex gnus-agent-expire-days
18303 @findex gnus-agent-expire
18304 @kindex M-x gnus-agent-expire
18305 @kindex M-x gnus-agent-expire-group
18306 @findex gnus-agent-expire-group
18307 @cindex agent expiry
18308 @cindex Gnus agent expiry
18311 The Agent back end, @code{nnagent}, doesn't handle expiry. Well, at
18312 least it doesn't handle it like other back ends. Instead, there are
18313 special @code{gnus-agent-expire} and @code{gnus-agent-expire-group}
18314 commands that will expire all read articles that are older than
18315 @code{gnus-agent-expire-days} days. They can be run whenever you feel
18316 that you're running out of space. Neither are particularly fast or
18317 efficient, and it's not a particularly good idea to interrupt them (with
18318 @kbd{C-g} or anything else) once you've started one of them.
18320 Note that other functions, e.g. @code{gnus-request-expire-articles},
18321 might run @code{gnus-agent-expire} for you to keep the agent
18322 synchronized with the group.
18324 The agent parameter @code{agent-enable-expiration} may be used to
18325 prevent expiration in selected groups.
18327 @vindex gnus-agent-expire-all
18328 If @code{gnus-agent-expire-all} is non-@code{nil}, the agent
18329 expiration commands will expire all articles---unread, read, ticked
18330 and dormant. If @code{nil} (which is the default), only read articles
18331 are eligible for expiry, and unread, ticked and dormant articles will
18332 be kept indefinitely.
18334 If you find that some articles eligible for expiry are never expired,
18335 perhaps some Gnus Agent files are corrupted. There's are special
18336 commands, @code{gnus-agent-regenerate} and
18337 @code{gnus-agent-regenerate-group}, to fix possible problems.
18339 @node Agent Regeneration
18340 @subsection Agent Regeneration
18342 @cindex agent regeneration
18343 @cindex Gnus agent regeneration
18344 @cindex regeneration
18346 The local data structures used by @code{nnagent} may become corrupted
18347 due to certain exceptional conditions. When this happens,
18348 @code{nnagent} functionality may degrade or even fail. The solution
18349 to this problem is to repair the local data structures by removing all
18350 internal inconsistencies.
18352 For example, if your connection to your server is lost while
18353 downloaded articles into the agent, the local data structures will not
18354 know about articles successfully downloaded prior to the connection
18355 failure. Running @code{gnus-agent-regenerate} or
18356 @code{gnus-agent-regenerate-group} will update the data structures
18357 such that you don't need to download these articles a second time.
18359 @findex gnus-agent-regenerate
18360 @kindex M-x gnus-agent-regenerate
18361 The command @code{gnus-agent-regenerate} will perform
18362 @code{gnus-agent-regenerate-group} on every agentized group. While
18363 you can run @code{gnus-agent-regenerate} in any buffer, it is strongly
18364 recommended that you first close all summary buffers.
18366 @findex gnus-agent-regenerate-group
18367 @kindex M-x gnus-agent-regenerate-group
18368 The command @code{gnus-agent-regenerate-group} uses the local copies
18369 of individual articles to repair the local @acronym{NOV}(header) database. It
18370 then updates the internal data structures that document which articles
18371 are stored locally. An optional argument will mark articles in the
18374 @node Agent and IMAP
18375 @subsection Agent and IMAP
18377 The Agent works with any Gnus back end, including nnimap. However,
18378 since there are some conceptual differences between @acronym{NNTP} and
18379 @acronym{IMAP}, this section (should) provide you with some information to
18380 make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client.
18382 The first thing to keep in mind is that all flags (read, ticked, etc)
18383 are kept on the @acronym{IMAP} server, rather than in @file{.newsrc} as is the
18384 case for nntp. Thus Gnus need to remember flag changes when
18385 disconnected, and synchronize these flags when you plug back in.
18387 Gnus keeps track of flag changes when reading nnimap groups under the
18388 Agent. When you plug back in, Gnus will check if you have any changed
18389 any flags and ask if you wish to synchronize these with the server.
18390 The behavior is customizable by @code{gnus-agent-synchronize-flags}.
18392 @vindex gnus-agent-synchronize-flags
18393 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
18394 never automatically synchronize flags. If it is @code{ask}, which is
18395 the default, the Agent will check if you made any changes and if so
18396 ask if you wish to synchronize these when you re-connect. If it has
18397 any other value, all flags will be synchronized automatically.
18399 If you do not wish to synchronize flags automatically when you
18400 re-connect, you can do it manually with the
18401 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
18402 in the group buffer.
18404 Some things are currently not implemented in the Agent that you'd might
18405 expect from a disconnected @acronym{IMAP} client, including:
18410 Copying/moving articles into nnimap groups when unplugged.
18413 Creating/deleting nnimap groups when unplugged.
18417 Technical note: the synchronization algorithm does not work by ``pushing''
18418 all local flags to the server, but rather incrementally update the
18419 server view of flags by changing only those flags that were changed by
18420 the user. Thus, if you set one flag on an article, quit the group and
18421 re-select the group and remove the flag; the flag will be set and
18422 removed from the server when you ``synchronize''. The queued flag
18423 operations can be found in the per-server @code{flags} file in the Agent
18424 directory. It's emptied when you synchronize flags.
18427 @node Outgoing Messages
18428 @subsection Outgoing Messages
18430 By default, when Gnus is unplugged, all outgoing messages (both mail
18431 and news) are stored in the draft group ``queue'' (@pxref{Drafts}).
18432 You can view them there after posting, and edit them at will.
18434 You can control the circumstances under which outgoing mail is queued
18435 (see @code{gnus-agent-queue-mail}, @pxref{Agent Variables}). Outgoing
18436 news is always queued when Gnus is unplugged, and never otherwise.
18438 You can send the messages either from the draft group with the special
18439 commands available there, or you can use the @kbd{J S} command in the
18440 group buffer to send all the sendable messages in the draft group.
18441 Posting news will only work when Gnus is plugged, but you can send
18444 If sending mail while unplugged does not work for you and you worry
18445 about hitting @kbd{J S} by accident when unplugged, you can have Gnus
18446 ask you to confirm your action (see
18447 @code{gnus-agent-prompt-send-queue}, @pxref{Agent Variables}).
18449 @node Agent Variables
18450 @subsection Agent Variables
18455 Is the agent enabled? The default is @code{t}. When first enabled,
18456 the agent will use @code{gnus-agent-auto-agentize-methods} to
18457 automatically mark some backends as agentized. You may change which
18458 backends are agentized using the agent commands in the server buffer.
18460 To enter the server buffer, use the @kbd{^}
18461 (@code{gnus-group-enter-server-mode}) command in the group buffer.
18464 @item gnus-agent-directory
18465 @vindex gnus-agent-directory
18466 Where the Gnus Agent will store its files. The default is
18467 @file{~/News/agent/}.
18469 @item gnus-agent-handle-level
18470 @vindex gnus-agent-handle-level
18471 Groups on levels (@pxref{Group Levels}) higher than this variable will
18472 be ignored by the Agent. The default is @code{gnus-level-subscribed},
18473 which means that only subscribed group will be considered by the Agent
18476 @item gnus-agent-plugged-hook
18477 @vindex gnus-agent-plugged-hook
18478 Hook run when connecting to the network.
18480 @item gnus-agent-unplugged-hook
18481 @vindex gnus-agent-unplugged-hook
18482 Hook run when disconnecting from the network.
18484 @item gnus-agent-fetched-hook
18485 @vindex gnus-agent-fetched-hook
18486 Hook run when finished fetching articles.
18488 @item gnus-agent-cache
18489 @vindex gnus-agent-cache
18490 Variable to control whether use the locally stored @acronym{NOV} and
18491 articles when plugged, e.g. essentially using the Agent as a cache.
18492 The default is non-@code{nil}, which means to use the Agent as a cache.
18494 @item gnus-agent-go-online
18495 @vindex gnus-agent-go-online
18496 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
18497 automatically switch offline servers into online status. If it is
18498 @code{ask}, the default, the Agent will ask if you wish to switch
18499 offline servers into online status when you re-connect. If it has any
18500 other value, all offline servers will be automatically switched into
18503 @item gnus-agent-mark-unread-after-downloaded
18504 @vindex gnus-agent-mark-unread-after-downloaded
18505 If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil},
18506 mark articles as unread after downloading. This is usually a safe
18507 thing to do as the newly downloaded article has obviously not been
18508 read. The default is t.
18510 @item gnus-agent-consider-all-articles
18511 @vindex gnus-agent-consider-all-articles
18512 If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the
18513 agent will let the agent predicate decide whether articles need to be
18514 downloaded or not, for all articles. When @code{nil}, the default,
18515 the agent will only let the predicate decide whether unread articles
18516 are downloaded or not. If you enable this, you may also want to look
18517 into the agent expiry settings (@pxref{Category Variables}), so that
18518 the agent doesn't download articles which the agent will later expire,
18519 over and over again.
18521 @item gnus-agent-max-fetch-size
18522 @vindex gnus-agent-max-fetch-size
18523 The agent fetches articles into a temporary buffer prior to parsing
18524 them into individual files. To avoid exceeding the max. buffer size,
18525 the agent alternates between fetching and parsing until all articles
18526 have been fetched. @code{gnus-agent-max-fetch-size} provides a size
18527 limit to control how often the cycling occurs. A large value improves
18528 performance. A small value minimizes the time lost should the
18529 connection be lost while fetching (You may need to run
18530 @code{gnus-agent-regenerate-group} to update the group's state.
18531 However, all articles parsed prior to loosing the connection will be
18532 available while unplugged). The default is 10M so it is unusual to
18535 @item gnus-server-unopen-status
18536 @vindex gnus-server-unopen-status
18537 Perhaps not an Agent variable, but closely related to the Agent, this
18538 variable says what will happen if Gnus cannot open a server. If the
18539 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
18540 whether to deny the server or whether to unplug the agent. If the
18541 Agent is disabled, Gnus always simply deny the server. Other choices
18542 for this variable include @code{denied} and @code{offline} the latter
18543 is only valid if the Agent is used.
18545 @item gnus-auto-goto-ignores
18546 @vindex gnus-auto-goto-ignores
18547 Another variable that isn't an Agent variable, yet so closely related
18548 that most will look for it here, this variable tells the summary
18549 buffer how to maneuver around undownloaded (only headers stored in the
18550 agent) and unfetched (neither article nor headers stored) articles.
18552 The legal values are @code{nil} (maneuver to any article),
18553 @code{undownloaded} (maneuvering while unplugged ignores articles that
18554 have not been fetched), @code{always-undownloaded} (maneuvering always
18555 ignores articles that have not been fetched), @code{unfetched}
18556 (maneuvering ignores articles whose headers have not been fetched).
18558 @item gnus-agent-queue-mail
18559 @vindex gnus-agent-queue-mail
18560 When @code{gnus-agent-queue-mail} is @code{always}, Gnus will always
18561 queue mail rather than sending it straight away. When @code{t}, Gnus
18562 will queue mail when unplugged only. When @code{nil}, never queue
18563 mail. The default is @code{t}.
18565 @item gnus-agent-prompt-send-queue
18566 @vindex gnus-agent-prompt-send-queue
18567 When @code{gnus-agent-prompt-send-queue} is non-@code{nil} Gnus will
18568 prompt you to confirm that you really wish to proceed if you hit
18569 @kbd{J S} while unplugged. The default is @code{nil}.
18571 @item gnus-agent-auto-agentize-methods
18572 @vindex gnus-agent-auto-agentize-methods
18573 If you have never used the Agent before (or more technically, if
18574 @file{~/News/agent/lib/servers} does not exist), Gnus will
18575 automatically agentize a few servers for you. This variable control
18576 which backends should be auto-agentized. It is typically only useful
18577 to agentize remote backends. The auto-agentizing has the same effect
18578 as running @kbd{J a} on the servers (@pxref{Server Agent Commands}).
18579 If the file exist, you must manage the servers manually by adding or
18580 removing them, this variable is only applicable the first time you
18581 start Gnus. The default is @samp{(nntp nnimap)}.
18586 @node Example Setup
18587 @subsection Example Setup
18589 If you don't want to read this manual, and you have a fairly standard
18590 setup, you may be able to use something like the following as your
18591 @file{~/.gnus.el} file to get started.
18594 ;;; @r{Define how Gnus is to fetch news. We do this over @acronym{NNTP}}
18595 ;;; @r{from your ISP's server.}
18596 (setq gnus-select-method '(nntp "news.your-isp.com"))
18598 ;;; @r{Define how Gnus is to read your mail. We read mail from}
18599 ;;; @r{your ISP's @acronym{POP} server.}
18600 (setq mail-sources '((pop :server "pop.your-isp.com")))
18602 ;;; @r{Say how Gnus is to store the mail. We use nnml groups.}
18603 (setq gnus-secondary-select-methods '((nnml "")))
18605 ;;; @r{Make Gnus into an offline newsreader.}
18606 ;;; (gnus-agentize) ; @r{The obsolete setting.}
18607 ;;; (setq gnus-agent t) ; @r{Now the default.}
18610 That should be it, basically. Put that in your @file{~/.gnus.el} file,
18611 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
18614 If this is the first time you've run Gnus, you will be subscribed
18615 automatically to a few default newsgroups. You'll probably want to
18616 subscribe to more groups, and to do that, you have to query the
18617 @acronym{NNTP} server for a complete list of groups with the @kbd{A A}
18618 command. This usually takes quite a while, but you only have to do it
18621 After reading and parsing a while, you'll be presented with a list of
18622 groups. Subscribe to the ones you want to read with the @kbd{u}
18623 command. @kbd{l} to make all the killed groups disappear after you've
18624 subscribe to all the groups you want to read. (@kbd{A k} will bring
18625 back all the killed groups.)
18627 You can now read the groups at once, or you can download the articles
18628 with the @kbd{J s} command. And then read the rest of this manual to
18629 find out which of the other gazillion things you want to customize.
18632 @node Batching Agents
18633 @subsection Batching Agents
18634 @findex gnus-agent-batch
18636 Having the Gnus Agent fetch articles (and post whatever messages you've
18637 written) is quite easy once you've gotten things set up properly. The
18638 following shell script will do everything that is necessary:
18640 You can run a complete batch command from the command line with the
18641 following incantation:
18645 emacs -batch -l ~/.emacs -l ~/.gnus.el gnus-agent-batch >/dev/null 2>&1
18649 @node Agent Caveats
18650 @subsection Agent Caveats
18652 The Gnus Agent doesn't seem to work like most other offline
18653 newsreaders. Here are some common questions that some imaginary people
18657 @item If I read an article while plugged, do they get entered into the Agent?
18659 @strong{No}. If you want this behaviour, add
18660 @code{gnus-agent-fetch-selected-article} to
18661 @code{gnus-select-article-hook}.
18663 @item If I read an article while plugged, and the article already exists in
18664 the Agent, will it get downloaded once more?
18666 @strong{No}, unless @code{gnus-agent-cache} is @code{nil}.
18670 In short, when Gnus is unplugged, it only looks into the locally stored
18671 articles; when it's plugged, it talks to your ISP and may also use the
18672 locally stored articles.
18679 Other people use @dfn{kill files}, but we here at Gnus Towers like
18680 scoring better than killing, so we'd rather switch than fight. They do
18681 something completely different as well, so sit up straight and pay
18684 @vindex gnus-summary-mark-below
18685 All articles have a default score (@code{gnus-summary-default-score}),
18686 which is 0 by default. This score may be raised or lowered either
18687 interactively or by score files. Articles that have a score lower than
18688 @code{gnus-summary-mark-below} are marked as read.
18690 Gnus will read any @dfn{score files} that apply to the current group
18691 before generating the summary buffer.
18693 There are several commands in the summary buffer that insert score
18694 entries based on the current article. You can, for instance, ask Gnus to
18695 lower or increase the score of all articles with a certain subject.
18697 There are two sorts of scoring entries: Permanent and temporary.
18698 Temporary score entries are self-expiring entries. Any entries that are
18699 temporary and have not been used for, say, a week, will be removed
18700 silently to help keep the sizes of the score files down.
18703 * Summary Score Commands:: Adding score entries for the current group.
18704 * Group Score Commands:: General score commands.
18705 * Score Variables:: Customize your scoring. (My, what terminology).
18706 * Score File Format:: What a score file may contain.
18707 * Score File Editing:: You can edit score files by hand as well.
18708 * Adaptive Scoring:: Big Sister Gnus knows what you read.
18709 * Home Score File:: How to say where new score entries are to go.
18710 * Followups To Yourself:: Having Gnus notice when people answer you.
18711 * Scoring On Other Headers:: Scoring on non-standard headers.
18712 * Scoring Tips:: How to score effectively.
18713 * Reverse Scoring:: That problem child of old is not problem.
18714 * Global Score Files:: Earth-spanning, ear-splitting score files.
18715 * Kill Files:: They are still here, but they can be ignored.
18716 * Converting Kill Files:: Translating kill files to score files.
18717 * Advanced Scoring:: Using logical expressions to build score rules.
18718 * Score Decays:: It can be useful to let scores wither away.
18722 @node Summary Score Commands
18723 @section Summary Score Commands
18724 @cindex score commands
18726 The score commands that alter score entries do not actually modify real
18727 score files. That would be too inefficient. Gnus maintains a cache of
18728 previously loaded score files, one of which is considered the
18729 @dfn{current score file alist}. The score commands simply insert
18730 entries into this list, and upon group exit, this list is saved.
18732 The current score file is by default the group's local score file, even
18733 if no such score file actually exists. To insert score commands into
18734 some other score file (e.g. @file{all.SCORE}), you must first make this
18735 score file the current one.
18737 General score commands that don't actually change the score file:
18742 @kindex V s (Summary)
18743 @findex gnus-summary-set-score
18744 Set the score of the current article (@code{gnus-summary-set-score}).
18747 @kindex V S (Summary)
18748 @findex gnus-summary-current-score
18749 Display the score of the current article
18750 (@code{gnus-summary-current-score}).
18753 @kindex V t (Summary)
18754 @findex gnus-score-find-trace
18755 Display all score rules that have been used on the current article
18756 (@code{gnus-score-find-trace}). In the @code{*Score Trace*} buffer, you
18757 may type @kbd{e} to edit score file corresponding to the score rule on
18758 current line and @kbd{f} to format (@code{gnus-score-pretty-print}) the
18759 score file and edit it.
18762 @kindex V w (Summary)
18763 @findex gnus-score-find-favourite-words
18764 List words used in scoring (@code{gnus-score-find-favourite-words}).
18767 @kindex V R (Summary)
18768 @findex gnus-summary-rescore
18769 Run the current summary through the scoring process
18770 (@code{gnus-summary-rescore}). This might be useful if you're playing
18771 around with your score files behind Gnus' back and want to see the
18772 effect you're having.
18775 @kindex V c (Summary)
18776 @findex gnus-score-change-score-file
18777 Make a different score file the current
18778 (@code{gnus-score-change-score-file}).
18781 @kindex V e (Summary)
18782 @findex gnus-score-edit-current-scores
18783 Edit the current score file (@code{gnus-score-edit-current-scores}).
18784 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
18788 @kindex V f (Summary)
18789 @findex gnus-score-edit-file
18790 Edit a score file and make this score file the current one
18791 (@code{gnus-score-edit-file}).
18794 @kindex V F (Summary)
18795 @findex gnus-score-flush-cache
18796 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
18797 after editing score files.
18800 @kindex V C (Summary)
18801 @findex gnus-score-customize
18802 Customize a score file in a visually pleasing manner
18803 (@code{gnus-score-customize}).
18807 The rest of these commands modify the local score file.
18812 @kindex V m (Summary)
18813 @findex gnus-score-set-mark-below
18814 Prompt for a score, and mark all articles with a score below this as
18815 read (@code{gnus-score-set-mark-below}).
18818 @kindex V x (Summary)
18819 @findex gnus-score-set-expunge-below
18820 Prompt for a score, and add a score rule to the current score file to
18821 expunge all articles below this score
18822 (@code{gnus-score-set-expunge-below}).
18825 The keystrokes for actually making score entries follow a very regular
18826 pattern, so there's no need to list all the commands. (Hundreds of
18829 @findex gnus-summary-increase-score
18830 @findex gnus-summary-lower-score
18834 The first key is either @kbd{I} (upper case i) for increasing the score
18835 or @kbd{L} for lowering the score.
18837 The second key says what header you want to score on. The following
18838 keys are available:
18842 Score on the author name.
18845 Score on the subject line.
18848 Score on the @code{Xref} line---i.e., the cross-posting line.
18851 Score on the @code{References} line.
18857 Score on the number of lines.
18860 Score on the @code{Message-ID} header.
18863 Score on an ``extra'' header, that is, one of those in gnus-extra-headers,
18864 if your @acronym{NNTP} server tracks additional header data in overviews.
18867 Score on followups---this matches the author name, and adds scores to
18868 the followups to this author. (Using this key leads to the creation of
18869 @file{ADAPT} files.)
18878 Score on thread. (Using this key leads to the creation of @file{ADAPT}
18884 The third key is the match type. Which match types are valid depends on
18885 what headers you are scoring on.
18897 Substring matching.
18900 Fuzzy matching (@pxref{Fuzzy Matching}).
18929 Greater than number.
18934 The fourth and usually final key says whether this is a temporary (i.e.,
18935 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
18936 or whether it is to be done immediately, without adding to the score
18941 Temporary score entry.
18944 Permanent score entry.
18947 Immediately scoring.
18951 If you are scoring on `e' (extra) headers, you will then be prompted for
18952 the header name on which you wish to score. This must be a header named
18953 in gnus-extra-headers, and @samp{TAB} completion is available.
18957 So, let's say you want to increase the score on the current author with
18958 exact matching permanently: @kbd{I a e p}. If you want to lower the
18959 score based on the subject line, using substring matching, and make a
18960 temporary score entry: @kbd{L s s t}. Pretty easy.
18962 To make things a bit more complicated, there are shortcuts. If you use
18963 a capital letter on either the second or third keys, Gnus will use
18964 defaults for the remaining one or two keystrokes. The defaults are
18965 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
18966 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
18968 These functions take both the numerical prefix and the symbolic prefix
18969 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
18970 (or increase) the score of the article. A symbolic prefix of @code{a}
18971 says to use the @file{all.SCORE} file for the command instead of the
18972 current score file.
18974 @vindex gnus-score-mimic-keymap
18975 The @code{gnus-score-mimic-keymap} says whether these commands will
18976 pretend they are keymaps or not.
18979 @node Group Score Commands
18980 @section Group Score Commands
18981 @cindex group score commands
18983 There aren't many of these as yet, I'm afraid.
18988 @kindex W e (Group)
18989 @findex gnus-score-edit-all-score
18990 Edit the apply-to-all-groups all.SCORE file. You will be popped into
18991 a @code{gnus-score-mode} buffer (@pxref{Score File Editing}).
18994 @kindex W f (Group)
18995 @findex gnus-score-flush-cache
18996 Gnus maintains a cache of score alists to avoid having to reload them
18997 all the time. This command will flush the cache
18998 (@code{gnus-score-flush-cache}).
19002 You can do scoring from the command line by saying something like:
19004 @findex gnus-batch-score
19005 @cindex batch scoring
19007 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
19011 @node Score Variables
19012 @section Score Variables
19013 @cindex score variables
19017 @item gnus-use-scoring
19018 @vindex gnus-use-scoring
19019 If @code{nil}, Gnus will not check for score files, and will not, in
19020 general, do any score-related work. This is @code{t} by default.
19022 @item gnus-kill-killed
19023 @vindex gnus-kill-killed
19024 If this variable is @code{nil}, Gnus will never apply score files to
19025 articles that have already been through the kill process. While this
19026 may save you lots of time, it also means that if you apply a kill file
19027 to a group, and then change the kill file and want to run it over you
19028 group again to kill more articles, it won't work. You have to set this
19029 variable to @code{t} to do that. (It is @code{t} by default.)
19031 @item gnus-kill-files-directory
19032 @vindex gnus-kill-files-directory
19033 All kill and score files will be stored in this directory, which is
19034 initialized from the @env{SAVEDIR} environment variable by default.
19035 This is @file{~/News/} by default.
19037 @item gnus-score-file-suffix
19038 @vindex gnus-score-file-suffix
19039 Suffix to add to the group name to arrive at the score file name
19040 (@file{SCORE} by default.)
19042 @item gnus-score-uncacheable-files
19043 @vindex gnus-score-uncacheable-files
19044 @cindex score cache
19045 All score files are normally cached to avoid excessive re-loading of
19046 score files. However, if this might make your Emacs grow big and
19047 bloated, so this regexp can be used to weed out score files unlikely
19048 to be needed again. It would be a bad idea to deny caching of
19049 @file{all.SCORE}, while it might be a good idea to not cache
19050 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
19051 variable is @samp{ADAPT$} by default, so no adaptive score files will
19054 @item gnus-save-score
19055 @vindex gnus-save-score
19056 If you have really complicated score files, and do lots of batch
19057 scoring, then you might set this variable to @code{t}. This will make
19058 Gnus save the scores into the @file{.newsrc.eld} file.
19060 If you do not set this to @code{t}, then manual scores (like those set
19061 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
19062 across group visits.
19064 @item gnus-score-interactive-default-score
19065 @vindex gnus-score-interactive-default-score
19066 Score used by all the interactive raise/lower commands to raise/lower
19067 score with. Default is 1000, which may seem excessive, but this is to
19068 ensure that the adaptive scoring scheme gets enough room to play with.
19069 We don't want the small changes from the adaptive scoring to overwrite
19070 manually entered data.
19072 @item gnus-summary-default-score
19073 @vindex gnus-summary-default-score
19074 Default score of an article, which is 0 by default.
19076 @item gnus-summary-expunge-below
19077 @vindex gnus-summary-expunge-below
19078 Don't display the summary lines of articles that have scores lower than
19079 this variable. This is @code{nil} by default, which means that no
19080 articles will be hidden. This variable is local to the summary buffers,
19081 and has to be set from @code{gnus-summary-mode-hook}.
19083 @item gnus-score-over-mark
19084 @vindex gnus-score-over-mark
19085 Mark (in the third column) used for articles with a score over the
19086 default. Default is @samp{+}.
19088 @item gnus-score-below-mark
19089 @vindex gnus-score-below-mark
19090 Mark (in the third column) used for articles with a score below the
19091 default. Default is @samp{-}.
19093 @item gnus-score-find-score-files-function
19094 @vindex gnus-score-find-score-files-function
19095 Function used to find score files for the current group. This function
19096 is called with the name of the group as the argument.
19098 Predefined functions available are:
19101 @item gnus-score-find-single
19102 @findex gnus-score-find-single
19103 Only apply the group's own score file.
19105 @item gnus-score-find-bnews
19106 @findex gnus-score-find-bnews
19107 Apply all score files that match, using bnews syntax. This is the
19108 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
19109 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
19110 @file{gnu.all.SCORE} would all apply. In short, the instances of
19111 @samp{all} in the score file names are translated into @samp{.*}, and
19112 then a regexp match is done.
19114 This means that if you have some score entries that you want to apply to
19115 all groups, then you put those entries in the @file{all.SCORE} file.
19117 The score files are applied in a semi-random order, although Gnus will
19118 try to apply the more general score files before the more specific score
19119 files. It does this by looking at the number of elements in the score
19120 file names---discarding the @samp{all} elements.
19122 @item gnus-score-find-hierarchical
19123 @findex gnus-score-find-hierarchical
19124 Apply all score files from all the parent groups. This means that you
19125 can't have score files like @file{all.SCORE}, but you can have
19126 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
19130 This variable can also be a list of functions. In that case, all
19131 these functions will be called with the group name as argument, and
19132 all the returned lists of score files will be applied. These
19133 functions can also return lists of lists of score alists directly. In
19134 that case, the functions that return these non-file score alists
19135 should probably be placed before the ``real'' score file functions, to
19136 ensure that the last score file returned is the local score file.
19139 For example, to do hierarchical scoring but use a non-server-specific
19140 overall score file, you could use the value
19142 (list (lambda (group) ("all.SCORE"))
19143 'gnus-score-find-hierarchical)
19146 @item gnus-score-expiry-days
19147 @vindex gnus-score-expiry-days
19148 This variable says how many days should pass before an unused score file
19149 entry is expired. If this variable is @code{nil}, no score file entries
19150 are expired. It's 7 by default.
19152 @item gnus-update-score-entry-dates
19153 @vindex gnus-update-score-entry-dates
19154 If this variable is non-@code{nil}, temporary score entries that have
19155 been triggered (matched) will have their dates updated. (This is how Gnus
19156 controls expiry---all non-matched-entries will become too old while
19157 matched entries will stay fresh and young.) However, if you set this
19158 variable to @code{nil}, even matched entries will grow old and will
19159 have to face that oh-so grim reaper.
19161 @item gnus-score-after-write-file-function
19162 @vindex gnus-score-after-write-file-function
19163 Function called with the name of the score file just written.
19165 @item gnus-score-thread-simplify
19166 @vindex gnus-score-thread-simplify
19167 If this variable is non-@code{nil}, article subjects will be
19168 simplified for subject scoring purposes in the same manner as with
19169 threading---according to the current value of
19170 @code{gnus-simplify-subject-functions}. If the scoring entry uses
19171 @code{substring} or @code{exact} matching, the match will also be
19172 simplified in this manner.
19177 @node Score File Format
19178 @section Score File Format
19179 @cindex score file format
19181 A score file is an @code{emacs-lisp} file that normally contains just a
19182 single form. Casual users are not expected to edit these files;
19183 everything can be changed from the summary buffer.
19185 Anyway, if you'd like to dig into it yourself, here's an example:
19189 ("Lars Ingebrigtsen" -10000)
19191 ("larsi\\|lmi" -50000 nil R))
19193 ("Ding is Badd" nil 728373))
19195 ("alt.politics" -1000 728372 s))
19200 (mark-and-expunge -10)
19204 (files "/hom/larsi/News/gnu.SCORE")
19205 (exclude-files "all.SCORE")
19206 (local (gnus-newsgroup-auto-expire t)
19207 (gnus-summary-make-false-root empty))
19211 This example demonstrates most score file elements. @xref{Advanced
19212 Scoring}, for a different approach.
19214 Even though this looks much like Lisp code, nothing here is actually
19215 @code{eval}ed. The Lisp reader is used to read this form, though, so it
19216 has to be valid syntactically, if not semantically.
19218 Six keys are supported by this alist:
19223 If the key is a string, it is the name of the header to perform the
19224 match on. Scoring can only be performed on these eight headers:
19225 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
19226 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
19227 these headers, there are three strings to tell Gnus to fetch the entire
19228 article and do the match on larger parts of the article: @code{Body}
19229 will perform the match on the body of the article, @code{Head} will
19230 perform the match on the head of the article, and @code{All} will
19231 perform the match on the entire article. Note that using any of these
19232 last three keys will slow down group entry @emph{considerably}. The
19233 final ``header'' you can score on is @code{Followup}. These score
19234 entries will result in new score entries being added for all follow-ups
19235 to articles that matches these score entries.
19237 Following this key is an arbitrary number of score entries, where each
19238 score entry has one to four elements.
19242 The first element is the @dfn{match element}. On most headers this will
19243 be a string, but on the Lines and Chars headers, this must be an
19247 If the second element is present, it should be a number---the @dfn{score
19248 element}. This number should be an integer in the neginf to posinf
19249 interval. This number is added to the score of the article if the match
19250 is successful. If this element is not present, the
19251 @code{gnus-score-interactive-default-score} number will be used
19252 instead. This is 1000 by default.
19255 If the third element is present, it should be a number---the @dfn{date
19256 element}. This date says when the last time this score entry matched,
19257 which provides a mechanism for expiring the score entries. It this
19258 element is not present, the score entry is permanent. The date is
19259 represented by the number of days since December 31, 1 BCE.
19262 If the fourth element is present, it should be a symbol---the @dfn{type
19263 element}. This element specifies what function should be used to see
19264 whether this score entry matches the article. What match types that can
19265 be used depends on what header you wish to perform the match on.
19268 @item From, Subject, References, Xref, Message-ID
19269 For most header types, there are the @code{r} and @code{R} (regexp), as
19270 well as @code{s} and @code{S} (substring) types, and @code{e} and
19271 @code{E} (exact match), and @code{w} (word match) types. If this
19272 element is not present, Gnus will assume that substring matching should
19273 be used. @code{R}, @code{S}, and @code{E} differ from the others in
19274 that the matches will be done in a case-sensitive manner. All these
19275 one-letter types are really just abbreviations for the @code{regexp},
19276 @code{string}, @code{exact}, and @code{word} types, which you can use
19277 instead, if you feel like.
19280 Just as for the standard string overview headers, if you are using
19281 gnus-extra-headers, you can score on these headers' values. In this
19282 case, there is a 5th element in the score entry, being the name of the
19283 header to be scored. The following entry is useful in your
19284 @file{all.SCORE} file in case of spam attacks from a single origin
19285 host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in
19289 ("111.222.333.444" -1000 nil s
19290 "NNTP-Posting-Host")
19294 These two headers use different match types: @code{<}, @code{>},
19295 @code{=}, @code{>=} and @code{<=}.
19297 These predicates are true if
19300 (PREDICATE HEADER MATCH)
19303 evaluates to non-@code{nil}. For instance, the advanced match
19304 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
19311 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
19312 the match, we get the score added if the article has less than 4 lines.
19313 (It's easy to get confused and think it's the other way around. But
19314 it's not. I think.)
19316 When matching on @code{Lines}, be careful because some back ends (like
19317 @code{nndir}) do not generate @code{Lines} header, so every article ends
19318 up being marked as having 0 lines. This can lead to strange results if
19319 you happen to lower score of the articles with few lines.
19322 For the Date header we have three kinda silly match types:
19323 @code{before}, @code{at} and @code{after}. I can't really imagine this
19324 ever being useful, but, like, it would feel kinda silly not to provide
19325 this function. Just in case. You never know. Better safe than sorry.
19326 Once burnt, twice shy. Don't judge a book by its cover. Never not have
19327 sex on a first date. (I have been told that at least one person, and I
19328 quote, ``found this function indispensable'', however.)
19332 A more useful match type is @code{regexp}. With it, you can match the
19333 date string using a regular expression. The date is normalized to
19334 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
19335 you want to match all articles that have been posted on April 1st in
19336 every year, you could use @samp{....0401.........} as a match string,
19337 for instance. (Note that the date is kept in its original time zone, so
19338 this will match articles that were posted when it was April 1st where
19339 the article was posted from. Time zones are such wholesome fun for the
19342 @item Head, Body, All
19343 These three match keys use the same match types as the @code{From} (etc)
19347 This match key is somewhat special, in that it will match the
19348 @code{From} header, and affect the score of not only the matching
19349 articles, but also all followups to the matching articles. This allows
19350 you e.g. increase the score of followups to your own articles, or
19351 decrease the score of followups to the articles of some known
19352 trouble-maker. Uses the same match types as the @code{From} header
19353 uses. (Using this match key will lead to creation of @file{ADAPT}
19357 This match key works along the same lines as the @code{Followup} match
19358 key. If you say that you want to score on a (sub-)thread started by an
19359 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
19360 match. This will add a new @samp{thread} match for each article that
19361 has @var{x} in its @code{References} header. (These new @samp{thread}
19362 matches will use the @code{Message-ID}s of these matching articles.)
19363 This will ensure that you can raise/lower the score of an entire thread,
19364 even though some articles in the thread may not have complete
19365 @code{References} headers. Note that using this may lead to
19366 undeterministic scores of the articles in the thread. (Using this match
19367 key will lead to creation of @file{ADAPT} files.)
19371 @cindex score file atoms
19373 The value of this entry should be a number. Any articles with a score
19374 lower than this number will be marked as read.
19377 The value of this entry should be a number. Any articles with a score
19378 lower than this number will be removed from the summary buffer.
19380 @item mark-and-expunge
19381 The value of this entry should be a number. Any articles with a score
19382 lower than this number will be marked as read and removed from the
19385 @item thread-mark-and-expunge
19386 The value of this entry should be a number. All articles that belong to
19387 a thread that has a total score below this number will be marked as read
19388 and removed from the summary buffer. @code{gnus-thread-score-function}
19389 says how to compute the total score for a thread.
19392 The value of this entry should be any number of file names. These files
19393 are assumed to be score files as well, and will be loaded the same way
19396 @item exclude-files
19397 The clue of this entry should be any number of files. These files will
19398 not be loaded, even though they would normally be so, for some reason or
19402 The value of this entry will be @code{eval}el. This element will be
19403 ignored when handling global score files.
19406 Read-only score files will not be updated or saved. Global score files
19407 should feature this atom (@pxref{Global Score Files}). (Note:
19408 @dfn{Global} here really means @dfn{global}; not your personal
19409 apply-to-all-groups score files.)
19412 The value of this entry should be a number. Articles that do not have
19413 parents will get this number added to their scores. Imagine you follow
19414 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
19415 will only follow a few of the threads, also want to see any new threads.
19417 You can do this with the following two score file entries:
19421 (mark-and-expunge -100)
19424 When you enter the group the first time, you will only see the new
19425 threads. You then raise the score of the threads that you find
19426 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
19427 rest. Next time you enter the group, you will see new articles in the
19428 interesting threads, plus any new threads.
19430 I.e.---the orphan score atom is for high-volume groups where a few
19431 interesting threads which can't be found automatically by ordinary
19432 scoring rules exist.
19435 This entry controls the adaptive scoring. If it is @code{t}, the
19436 default adaptive scoring rules will be used. If it is @code{ignore}, no
19437 adaptive scoring will be performed on this group. If it is a list, this
19438 list will be used as the adaptive scoring rules. If it isn't present,
19439 or is something other than @code{t} or @code{ignore}, the default
19440 adaptive scoring rules will be used. If you want to use adaptive
19441 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
19442 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
19443 not want adaptive scoring. If you only want adaptive scoring in a few
19444 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
19445 insert @code{(adapt t)} in the score files of the groups where you want
19449 All adaptive score entries will go to the file named by this entry. It
19450 will also be applied when entering the group. This atom might be handy
19451 if you want to adapt on several groups at once, using the same adaptive
19452 file for a number of groups.
19455 @cindex local variables
19456 The value of this entry should be a list of @code{(@var{var}
19457 @var{value})} pairs. Each @var{var} will be made buffer-local to the
19458 current summary buffer, and set to the value specified. This is a
19459 convenient, if somewhat strange, way of setting variables in some
19460 groups if you don't like hooks much. Note that the @var{value} won't
19465 @node Score File Editing
19466 @section Score File Editing
19468 You normally enter all scoring commands from the summary buffer, but you
19469 might feel the urge to edit them by hand as well, so we've supplied you
19470 with a mode for that.
19472 It's simply a slightly customized @code{emacs-lisp} mode, with these
19473 additional commands:
19478 @kindex C-c C-c (Score)
19479 @findex gnus-score-edit-done
19480 Save the changes you have made and return to the summary buffer
19481 (@code{gnus-score-edit-done}).
19484 @kindex C-c C-d (Score)
19485 @findex gnus-score-edit-insert-date
19486 Insert the current date in numerical format
19487 (@code{gnus-score-edit-insert-date}). This is really the day number, if
19488 you were wondering.
19491 @kindex C-c C-p (Score)
19492 @findex gnus-score-pretty-print
19493 The adaptive score files are saved in an unformatted fashion. If you
19494 intend to read one of these files, you want to @dfn{pretty print} it
19495 first. This command (@code{gnus-score-pretty-print}) does that for
19500 Type @kbd{M-x gnus-score-mode} to use this mode.
19502 @vindex gnus-score-mode-hook
19503 @code{gnus-score-menu-hook} is run in score mode buffers.
19505 In the summary buffer you can use commands like @kbd{V f}, @kbd{V e} and
19506 @kbd{V t} to begin editing score files.
19509 @node Adaptive Scoring
19510 @section Adaptive Scoring
19511 @cindex adaptive scoring
19513 If all this scoring is getting you down, Gnus has a way of making it all
19514 happen automatically---as if by magic. Or rather, as if by artificial
19515 stupidity, to be precise.
19517 @vindex gnus-use-adaptive-scoring
19518 When you read an article, or mark an article as read, or kill an
19519 article, you leave marks behind. On exit from the group, Gnus can sniff
19520 these marks and add score elements depending on what marks it finds.
19521 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
19522 @code{t} or @code{(line)}. If you want score adaptively on separate
19523 words appearing in the subjects, you should set this variable to
19524 @code{(word)}. If you want to use both adaptive methods, set this
19525 variable to @code{(word line)}.
19527 @vindex gnus-default-adaptive-score-alist
19528 To give you complete control over the scoring process, you can customize
19529 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
19530 might look something like this:
19533 (setq gnus-default-adaptive-score-alist
19534 '((gnus-unread-mark)
19535 (gnus-ticked-mark (from 4))
19536 (gnus-dormant-mark (from 5))
19537 (gnus-del-mark (from -4) (subject -1))
19538 (gnus-read-mark (from 4) (subject 2))
19539 (gnus-expirable-mark (from -1) (subject -1))
19540 (gnus-killed-mark (from -1) (subject -3))
19541 (gnus-kill-file-mark)
19542 (gnus-ancient-mark)
19543 (gnus-low-score-mark)
19544 (gnus-catchup-mark (from -1) (subject -1))))
19547 As you see, each element in this alist has a mark as a key (either a
19548 variable name or a ``real'' mark---a character). Following this key is
19549 a arbitrary number of header/score pairs. If there are no header/score
19550 pairs following the key, no adaptive scoring will be done on articles
19551 that have that key as the article mark. For instance, articles with
19552 @code{gnus-unread-mark} in the example above will not get adaptive score
19555 Each article can have only one mark, so just a single of these rules
19556 will be applied to each article.
19558 To take @code{gnus-del-mark} as an example---this alist says that all
19559 articles that have that mark (i.e., are marked with @samp{e}) will have a
19560 score entry added to lower based on the @code{From} header by -4, and
19561 lowered by @code{Subject} by -1. Change this to fit your prejudices.
19563 If you have marked 10 articles with the same subject with
19564 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
19565 That means that that subject will get a score of ten times -1, which
19566 should be, unless I'm much mistaken, -10.
19568 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
19569 the read articles will be marked with the @samp{E} mark. This'll
19570 probably make adaptive scoring slightly impossible, so auto-expiring and
19571 adaptive scoring doesn't really mix very well.
19573 The headers you can score on are @code{from}, @code{subject},
19574 @code{message-id}, @code{references}, @code{xref}, @code{lines},
19575 @code{chars} and @code{date}. In addition, you can score on
19576 @code{followup}, which will create an adaptive score entry that matches
19577 on the @code{References} header using the @code{Message-ID} of the
19578 current article, thereby matching the following thread.
19580 If you use this scheme, you should set the score file atom @code{mark}
19581 to something small---like -300, perhaps, to avoid having small random
19582 changes result in articles getting marked as read.
19584 After using adaptive scoring for a week or so, Gnus should start to
19585 become properly trained and enhance the authors you like best, and kill
19586 the authors you like least, without you having to say so explicitly.
19588 You can control what groups the adaptive scoring is to be performed on
19589 by using the score files (@pxref{Score File Format}). This will also
19590 let you use different rules in different groups.
19592 @vindex gnus-adaptive-file-suffix
19593 The adaptive score entries will be put into a file where the name is the
19594 group name with @code{gnus-adaptive-file-suffix} appended. The default
19597 @vindex gnus-score-exact-adapt-limit
19598 When doing adaptive scoring, substring or fuzzy matching would probably
19599 give you the best results in most cases. However, if the header one
19600 matches is short, the possibility for false positives is great, so if
19601 the length of the match is less than
19602 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
19603 this variable is @code{nil}, exact matching will always be used to avoid
19606 @vindex gnus-default-adaptive-word-score-alist
19607 As mentioned above, you can adapt either on individual words or entire
19608 headers. If you adapt on words, the
19609 @code{gnus-default-adaptive-word-score-alist} variable says what score
19610 each instance of a word should add given a mark.
19613 (setq gnus-default-adaptive-word-score-alist
19614 `((,gnus-read-mark . 30)
19615 (,gnus-catchup-mark . -10)
19616 (,gnus-killed-mark . -20)
19617 (,gnus-del-mark . -15)))
19620 This is the default value. If you have adaption on words enabled, every
19621 word that appears in subjects of articles marked with
19622 @code{gnus-read-mark} will result in a score rule that increase the
19623 score with 30 points.
19625 @vindex gnus-default-ignored-adaptive-words
19626 @vindex gnus-ignored-adaptive-words
19627 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
19628 will be ignored. If you wish to add more words to be ignored, use the
19629 @code{gnus-ignored-adaptive-words} list instead.
19631 @vindex gnus-adaptive-word-length-limit
19632 Some may feel that short words shouldn't count when doing adaptive
19633 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
19634 an integer. Words shorter than this number will be ignored. This
19635 variable defaults to @code{nil}.
19637 @vindex gnus-adaptive-word-syntax-table
19638 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
19639 syntax table in effect. It is similar to the standard syntax table, but
19640 it considers numbers to be non-word-constituent characters.
19642 @vindex gnus-adaptive-word-minimum
19643 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
19644 word scoring process will never bring down the score of an article to
19645 below this number. The default is @code{nil}.
19647 @vindex gnus-adaptive-word-no-group-words
19648 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
19649 won't adaptively word score any of the words in the group name. Useful
19650 for groups like @samp{comp.editors.emacs}, where most of the subject
19651 lines contain the word @samp{emacs}.
19653 After using this scheme for a while, it might be nice to write a
19654 @code{gnus-psychoanalyze-user} command to go through the rules and see
19655 what words you like and what words you don't like. Or perhaps not.
19657 Note that the adaptive word scoring thing is highly experimental and is
19658 likely to change in the future. Initial impressions seem to indicate
19659 that it's totally useless as it stands. Some more work (involving more
19660 rigorous statistical methods) will have to be done to make this useful.
19663 @node Home Score File
19664 @section Home Score File
19666 The score file where new score file entries will go is called the
19667 @dfn{home score file}. This is normally (and by default) the score file
19668 for the group itself. For instance, the home score file for
19669 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
19671 However, this may not be what you want. It is often convenient to share
19672 a common home score file among many groups---all @samp{emacs} groups
19673 could perhaps use the same home score file.
19675 @vindex gnus-home-score-file
19676 The variable that controls this is @code{gnus-home-score-file}. It can
19681 A string. Then this file will be used as the home score file for all
19685 A function. The result of this function will be used as the home score
19686 file. The function will be called with the name of the group as the
19690 A list. The elements in this list can be:
19694 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
19695 group name, the @var{file-name} will be used as the home score file.
19698 A function. If the function returns non-@code{nil}, the result will
19699 be used as the home score file.
19702 A string. Use the string as the home score file.
19705 The list will be traversed from the beginning towards the end looking
19710 So, if you want to use just a single score file, you could say:
19713 (setq gnus-home-score-file
19714 "my-total-score-file.SCORE")
19717 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
19718 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
19720 @findex gnus-hierarchial-home-score-file
19722 (setq gnus-home-score-file
19723 'gnus-hierarchial-home-score-file)
19726 This is a ready-made function provided for your convenience.
19727 Other functions include
19730 @item gnus-current-home-score-file
19731 @findex gnus-current-home-score-file
19732 Return the ``current'' regular score file. This will make scoring
19733 commands add entry to the ``innermost'' matching score file.
19737 If you want to have one score file for the @samp{emacs} groups and
19738 another for the @samp{comp} groups, while letting all other groups use
19739 their own home score files:
19742 (setq gnus-home-score-file
19743 ;; @r{All groups that match the regexp @code{"\\.emacs"}}
19744 '(("\\.emacs" "emacs.SCORE")
19745 ;; @r{All the comp groups in one score file}
19746 ("^comp" "comp.SCORE")))
19749 @vindex gnus-home-adapt-file
19750 @code{gnus-home-adapt-file} works exactly the same way as
19751 @code{gnus-home-score-file}, but says what the home adaptive score file
19752 is instead. All new adaptive file entries will go into the file
19753 specified by this variable, and the same syntax is allowed.
19755 In addition to using @code{gnus-home-score-file} and
19756 @code{gnus-home-adapt-file}, you can also use group parameters
19757 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
19758 Parameters}) to achieve much the same. Group and topic parameters take
19759 precedence over this variable.
19762 @node Followups To Yourself
19763 @section Followups To Yourself
19765 Gnus offers two commands for picking out the @code{Message-ID} header in
19766 the current buffer. Gnus will then add a score rule that scores using
19767 this @code{Message-ID} on the @code{References} header of other
19768 articles. This will, in effect, increase the score of all articles that
19769 respond to the article in the current buffer. Quite useful if you want
19770 to easily note when people answer what you've said.
19774 @item gnus-score-followup-article
19775 @findex gnus-score-followup-article
19776 This will add a score to articles that directly follow up your own
19779 @item gnus-score-followup-thread
19780 @findex gnus-score-followup-thread
19781 This will add a score to all articles that appear in a thread ``below''
19785 @vindex message-sent-hook
19786 These two functions are both primarily meant to be used in hooks like
19787 @code{message-sent-hook}, like this:
19789 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
19793 If you look closely at your own @code{Message-ID}, you'll notice that
19794 the first two or three characters are always the same. Here's two of
19798 <x6u3u47icf.fsf@@eyesore.no>
19799 <x6sp9o7ibw.fsf@@eyesore.no>
19802 So ``my'' ident on this machine is @samp{x6}. This can be
19803 exploited---the following rule will raise the score on all followups to
19808 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
19812 Whether it's the first two or first three characters that are ``yours''
19813 is system-dependent.
19816 @node Scoring On Other Headers
19817 @section Scoring On Other Headers
19818 @cindex scoring on other headers
19820 Gnus is quite fast when scoring the ``traditional''
19821 headers---@samp{From}, @samp{Subject} and so on. However, scoring
19822 other headers requires writing a @code{head} scoring rule, which means
19823 that Gnus has to request every single article from the back end to find
19824 matches. This takes a long time in big groups.
19826 Now, there's not much you can do about this for news groups, but for
19827 mail groups, you have greater control. In @ref{To From Newsgroups},
19828 it's explained in greater detail what this mechanism does, but here's
19829 a cookbook example for @code{nnml} on how to allow scoring on the
19830 @samp{To} and @samp{Cc} headers.
19832 Put the following in your @file{~/.gnus.el} file.
19835 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
19836 nnmail-extra-headers gnus-extra-headers)
19839 Restart Gnus and rebuild your @code{nnml} overview files with the
19840 @kbd{M-x nnml-generate-nov-databases} command. This will take a long
19841 time if you have much mail.
19843 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
19844 so: @kbd{I e s p To RET <your name> RET}.
19850 @section Scoring Tips
19851 @cindex scoring tips
19857 @cindex scoring crossposts
19858 If you want to lower the score of crossposts, the line to match on is
19859 the @code{Xref} header.
19861 ("xref" (" talk.politics.misc:" -1000))
19864 @item Multiple crossposts
19865 If you want to lower the score of articles that have been crossposted to
19866 more than, say, 3 groups:
19869 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
19873 @item Matching on the body
19874 This is generally not a very good idea---it takes a very long time.
19875 Gnus actually has to fetch each individual article from the server. But
19876 you might want to anyway, I guess. Even though there are three match
19877 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
19878 and stick with it in each score file. If you use any two, each article
19879 will be fetched @emph{twice}. If you want to match a bit on the
19880 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
19883 @item Marking as read
19884 You will probably want to mark articles that have scores below a certain
19885 number as read. This is most easily achieved by putting the following
19886 in your @file{all.SCORE} file:
19890 You may also consider doing something similar with @code{expunge}.
19892 @item Negated character classes
19893 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
19894 That will match newlines, which might lead to, well, The Unknown. Say
19895 @code{[^abcd\n]*} instead.
19899 @node Reverse Scoring
19900 @section Reverse Scoring
19901 @cindex reverse scoring
19903 If you want to keep just articles that have @samp{Sex with Emacs} in the
19904 subject header, and expunge all other articles, you could put something
19905 like this in your score file:
19909 ("Sex with Emacs" 2))
19914 So, you raise all articles that match @samp{Sex with Emacs} and mark the
19915 rest as read, and expunge them to boot.
19918 @node Global Score Files
19919 @section Global Score Files
19920 @cindex global score files
19922 Sure, other newsreaders have ``global kill files''. These are usually
19923 nothing more than a single kill file that applies to all groups, stored
19924 in the user's home directory. Bah! Puny, weak newsreaders!
19926 What I'm talking about here are Global Score Files. Score files from
19927 all over the world, from users everywhere, uniting all nations in one
19928 big, happy score file union! Ange-score! New and untested!
19930 @vindex gnus-global-score-files
19931 All you have to do to use other people's score files is to set the
19932 @code{gnus-global-score-files} variable. One entry for each score file,
19933 or each score file directory. Gnus will decide by itself what score
19934 files are applicable to which group.
19936 To use the score file
19937 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
19938 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
19942 (setq gnus-global-score-files
19943 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
19944 "/ftp@@ftp.some-where:/pub/score/"))
19947 @findex gnus-score-search-global-directories
19949 Simple, eh? Directory names must end with a @samp{/}. These
19950 directories are typically scanned only once during each Gnus session.
19951 If you feel the need to manually re-scan the remote directories, you can
19952 use the @code{gnus-score-search-global-directories} command.
19954 Note that, at present, using this option will slow down group entry
19955 somewhat. (That is---a lot.)
19957 If you want to start maintaining score files for other people to use,
19958 just put your score file up for anonymous ftp and announce it to the
19959 world. Become a retro-moderator! Participate in the retro-moderator
19960 wars sure to ensue, where retro-moderators battle it out for the
19961 sympathy of the people, luring them to use their score files on false
19962 premises! Yay! The net is saved!
19964 Here are some tips for the would-be retro-moderator, off the top of my
19970 Articles heavily crossposted are probably junk.
19972 To lower a single inappropriate article, lower by @code{Message-ID}.
19974 Particularly brilliant authors can be raised on a permanent basis.
19976 Authors that repeatedly post off-charter for the group can safely be
19977 lowered out of existence.
19979 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
19980 articles completely.
19983 Use expiring score entries to keep the size of the file down. You
19984 should probably have a long expiry period, though, as some sites keep
19985 old articles for a long time.
19988 @dots{} I wonder whether other newsreaders will support global score files
19989 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
19990 Wave, xrn and 1stReader are bound to implement scoring. Should we start
19991 holding our breath yet?
19995 @section Kill Files
19998 Gnus still supports those pesky old kill files. In fact, the kill file
19999 entries can now be expiring, which is something I wrote before Daniel
20000 Quinlan thought of doing score files, so I've left the code in there.
20002 In short, kill processing is a lot slower (and I do mean @emph{a lot})
20003 than score processing, so it might be a good idea to rewrite your kill
20004 files into score files.
20006 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
20007 forms into this file, which means that you can use kill files as some
20008 sort of primitive hook function to be run on group entry, even though
20009 that isn't a very good idea.
20011 Normal kill files look like this:
20014 (gnus-kill "From" "Lars Ingebrigtsen")
20015 (gnus-kill "Subject" "ding")
20019 This will mark every article written by me as read, and remove the
20020 marked articles from the summary buffer. Very useful, you'll agree.
20022 Other programs use a totally different kill file syntax. If Gnus
20023 encounters what looks like a @code{rn} kill file, it will take a stab at
20026 Two summary functions for editing a @sc{gnus} kill file:
20031 @kindex M-k (Summary)
20032 @findex gnus-summary-edit-local-kill
20033 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
20036 @kindex M-K (Summary)
20037 @findex gnus-summary-edit-global-kill
20038 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
20041 Two group mode functions for editing the kill files:
20046 @kindex M-k (Group)
20047 @findex gnus-group-edit-local-kill
20048 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
20051 @kindex M-K (Group)
20052 @findex gnus-group-edit-global-kill
20053 Edit the general kill file (@code{gnus-group-edit-global-kill}).
20056 Kill file variables:
20059 @item gnus-kill-file-name
20060 @vindex gnus-kill-file-name
20061 A kill file for the group @samp{soc.motss} is normally called
20062 @file{soc.motss.KILL}. The suffix appended to the group name to get
20063 this file name is detailed by the @code{gnus-kill-file-name} variable.
20064 The ``global'' kill file (not in the score file sense of ``global'', of
20065 course) is just called @file{KILL}.
20067 @vindex gnus-kill-save-kill-file
20068 @item gnus-kill-save-kill-file
20069 If this variable is non-@code{nil}, Gnus will save the
20070 kill file after processing, which is necessary if you use expiring
20073 @item gnus-apply-kill-hook
20074 @vindex gnus-apply-kill-hook
20075 @findex gnus-apply-kill-file-unless-scored
20076 @findex gnus-apply-kill-file
20077 A hook called to apply kill files to a group. It is
20078 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
20079 kill file if you have a score file for the same group, you can set this
20080 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
20081 kill files to be processed, you should set this variable to @code{nil}.
20083 @item gnus-kill-file-mode-hook
20084 @vindex gnus-kill-file-mode-hook
20085 A hook called in kill-file mode buffers.
20090 @node Converting Kill Files
20091 @section Converting Kill Files
20093 @cindex converting kill files
20095 If you have loads of old kill files, you may want to convert them into
20096 score files. If they are ``regular'', you can use
20097 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
20100 The kill to score conversion package isn't included in Gnus by default.
20101 You can fetch it from
20102 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
20104 If your old kill files are very complex---if they contain more
20105 non-@code{gnus-kill} forms than not, you'll have to convert them by
20106 hand. Or just let them be as they are. Gnus will still use them as
20110 @node Advanced Scoring
20111 @section Advanced Scoring
20113 Scoring on Subjects and From headers is nice enough, but what if you're
20114 really interested in what a person has to say only when she's talking
20115 about a particular subject? Or what if you really don't want to
20116 read what person A has to say when she's following up to person B, but
20117 want to read what she says when she's following up to person C?
20119 By using advanced scoring rules you may create arbitrarily complex
20123 * Advanced Scoring Syntax:: A definition.
20124 * Advanced Scoring Examples:: What they look like.
20125 * Advanced Scoring Tips:: Getting the most out of it.
20129 @node Advanced Scoring Syntax
20130 @subsection Advanced Scoring Syntax
20132 Ordinary scoring rules have a string as the first element in the rule.
20133 Advanced scoring rules have a list as the first element. The second
20134 element is the score to be applied if the first element evaluated to a
20135 non-@code{nil} value.
20137 These lists may consist of three logical operators, one redirection
20138 operator, and various match operators.
20145 This logical operator will evaluate each of its arguments until it finds
20146 one that evaluates to @code{false}, and then it'll stop. If all arguments
20147 evaluate to @code{true} values, then this operator will return
20152 This logical operator will evaluate each of its arguments until it finds
20153 one that evaluates to @code{true}. If no arguments are @code{true},
20154 then this operator will return @code{false}.
20159 This logical operator only takes a single argument. It returns the
20160 logical negation of the value of its argument.
20164 There is an @dfn{indirection operator} that will make its arguments
20165 apply to the ancestors of the current article being scored. For
20166 instance, @code{1-} will make score rules apply to the parent of the
20167 current article. @code{2-} will make score rules apply to the
20168 grandparent of the current article. Alternatively, you can write
20169 @code{^^}, where the number of @code{^}s (carets) says how far back into
20170 the ancestry you want to go.
20172 Finally, we have the match operators. These are the ones that do the
20173 real work. Match operators are header name strings followed by a match
20174 and a match type. A typical match operator looks like @samp{("from"
20175 "Lars Ingebrigtsen" s)}. The header names are the same as when using
20176 simple scoring, and the match types are also the same.
20179 @node Advanced Scoring Examples
20180 @subsection Advanced Scoring Examples
20182 Please note that the following examples are score file rules. To
20183 make a complete score file from them, surround them with another pair
20186 Let's say you want to increase the score of articles written by Lars
20187 when he's talking about Gnus:
20192 ("from" "Lars Ingebrigtsen")
20193 ("subject" "Gnus"))
20200 When he writes long articles, he sometimes has something nice to say:
20204 ("from" "Lars Ingebrigtsen")
20211 However, when he responds to things written by Reig Eigil Logge, you
20212 really don't want to read what he's written:
20216 ("from" "Lars Ingebrigtsen")
20217 (1- ("from" "Reig Eigir Logge")))
20221 Everybody that follows up Redmondo when he writes about disappearing
20222 socks should have their scores raised, but only when they talk about
20223 white socks. However, when Lars talks about socks, it's usually not
20230 ("from" "redmondo@@.*no" r)
20231 ("body" "disappearing.*socks" t)))
20232 (! ("from" "Lars Ingebrigtsen"))
20233 ("body" "white.*socks"))
20237 The possibilities are endless.
20240 @node Advanced Scoring Tips
20241 @subsection Advanced Scoring Tips
20243 The @code{&} and @code{|} logical operators do short-circuit logic.
20244 That is, they stop processing their arguments when it's clear what the
20245 result of the operation will be. For instance, if one of the arguments
20246 of an @code{&} evaluates to @code{false}, there's no point in evaluating
20247 the rest of the arguments. This means that you should put slow matches
20248 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
20249 @samp{subject}) first.
20251 The indirection arguments (@code{1-} and so on) will make their
20252 arguments work on previous generations of the thread. If you say
20263 Then that means "score on the from header of the grandparent of the
20264 current article". An indirection is quite fast, but it's better to say:
20270 ("subject" "Gnus")))
20277 (1- ("from" "Lars"))
20278 (1- ("subject" "Gnus")))
20283 @section Score Decays
20284 @cindex score decays
20287 You may find that your scores have a tendency to grow without
20288 bounds, especially if you're using adaptive scoring. If scores get too
20289 big, they lose all meaning---they simply max out and it's difficult to
20290 use them in any sensible way.
20292 @vindex gnus-decay-scores
20293 @findex gnus-decay-score
20294 @vindex gnus-decay-score-function
20295 Gnus provides a mechanism for decaying scores to help with this problem.
20296 When score files are loaded and @code{gnus-decay-scores} is
20297 non-@code{nil}, Gnus will run the score files through the decaying
20298 mechanism thereby lowering the scores of all non-permanent score rules.
20299 The decay itself if performed by the @code{gnus-decay-score-function}
20300 function, which is @code{gnus-decay-score} by default. Here's the
20301 definition of that function:
20304 (defun gnus-decay-score (score)
20305 "Decay SCORE according to `gnus-score-decay-constant'
20306 and `gnus-score-decay-scale'."
20308 (* (if (< score 0) -1 1)
20310 (max gnus-score-decay-constant
20312 gnus-score-decay-scale)))))))
20313 (if (and (featurep 'xemacs)
20314 ;; XEmacs' floor can handle only the floating point
20315 ;; number below the half of the maximum integer.
20316 (> (abs n) (lsh -1 -2)))
20318 (car (split-string (number-to-string n) "\\.")))
20322 @vindex gnus-score-decay-scale
20323 @vindex gnus-score-decay-constant
20324 @code{gnus-score-decay-constant} is 3 by default and
20325 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
20329 Scores between -3 and 3 will be set to 0 when this function is called.
20332 Scores with magnitudes between 3 and 60 will be shrunk by 3.
20335 Scores with magnitudes greater than 60 will be shrunk by 5% of the
20339 If you don't like this decay function, write your own. It is called
20340 with the score to be decayed as its only parameter, and it should return
20341 the new score, which should be an integer.
20343 Gnus will try to decay scores once a day. If you haven't run Gnus for
20344 four days, Gnus will decay the scores four times, for instance.
20349 @include message.texi
20350 @chapter Emacs MIME
20351 @include emacs-mime.texi
20353 @include sieve.texi
20355 @c @include pgg.texi
20357 @c @include sasl.texi
20365 * Process/Prefix:: A convention used by many treatment commands.
20366 * Interactive:: Making Gnus ask you many questions.
20367 * Symbolic Prefixes:: How to supply some Gnus functions with options.
20368 * Formatting Variables:: You can specify what buffers should look like.
20369 * Window Layout:: Configuring the Gnus buffer windows.
20370 * Faces and Fonts:: How to change how faces look.
20371 * Compilation:: How to speed Gnus up.
20372 * Mode Lines:: Displaying information in the mode lines.
20373 * Highlighting and Menus:: Making buffers look all nice and cozy.
20374 * Buttons:: Get tendinitis in ten easy steps!
20375 * Daemons:: Gnus can do things behind your back.
20376 * NoCeM:: How to avoid spam and other fatty foods.
20377 * Undo:: Some actions can be undone.
20378 * Predicate Specifiers:: Specifying predicates.
20379 * Moderation:: What to do if you're a moderator.
20380 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
20381 * Fuzzy Matching:: What's the big fuzz?
20382 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
20383 * Other modes:: Interaction with other modes.
20384 * Various Various:: Things that are really various.
20388 @node Process/Prefix
20389 @section Process/Prefix
20390 @cindex process/prefix convention
20392 Many functions, among them functions for moving, decoding and saving
20393 articles, use what is known as the @dfn{Process/Prefix convention}.
20395 This is a method for figuring out what articles the user wants the
20396 command to be performed on.
20400 If the numeric prefix is N, perform the operation on the next N
20401 articles, starting with the current one. If the numeric prefix is
20402 negative, perform the operation on the previous N articles, starting
20403 with the current one.
20405 @vindex transient-mark-mode
20406 If @code{transient-mark-mode} in non-@code{nil} and the region is
20407 active, all articles in the region will be worked upon.
20409 If there is no numeric prefix, but some articles are marked with the
20410 process mark, perform the operation on the articles marked with
20413 If there is neither a numeric prefix nor any articles marked with the
20414 process mark, just perform the operation on the current article.
20416 Quite simple, really, but it needs to be made clear so that surprises
20419 Commands that react to the process mark will push the current list of
20420 process marked articles onto a stack and will then clear all process
20421 marked articles. You can restore the previous configuration with the
20422 @kbd{M P y} command (@pxref{Setting Process Marks}).
20424 @vindex gnus-summary-goto-unread
20425 One thing that seems to shock & horrify lots of people is that, for
20426 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
20427 Since each @kbd{d} (which marks the current article as read) by default
20428 goes to the next unread article after marking, this means that @kbd{3 d}
20429 will mark the next three unread articles as read, no matter what the
20430 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
20431 @code{nil} for a more straightforward action.
20433 Many commands do not use the process/prefix convention. All commands
20434 that do explicitly say so in this manual. To apply the process/prefix
20435 convention to commands that do not use it, you can use the @kbd{M-&}
20436 command. For instance, to mark all the articles in the group as
20437 expirable, you could say @kbd{M P b M-& E}.
20441 @section Interactive
20442 @cindex interaction
20446 @item gnus-novice-user
20447 @vindex gnus-novice-user
20448 If this variable is non-@code{nil}, you are either a newcomer to the
20449 World of Usenet, or you are very cautious, which is a nice thing to be,
20450 really. You will be given questions of the type ``Are you sure you want
20451 to do this?'' before doing anything dangerous. This is @code{t} by
20454 @item gnus-expert-user
20455 @vindex gnus-expert-user
20456 If this variable is non-@code{nil}, you will seldom be asked any
20457 questions by Gnus. It will simply assume you know what you're doing, no
20458 matter how strange.
20460 @item gnus-interactive-catchup
20461 @vindex gnus-interactive-catchup
20462 Require confirmation before catching up a group if non-@code{nil}. It
20463 is @code{t} by default.
20465 @item gnus-interactive-exit
20466 @vindex gnus-interactive-exit
20467 Require confirmation before exiting Gnus. This variable is @code{t} by
20472 @node Symbolic Prefixes
20473 @section Symbolic Prefixes
20474 @cindex symbolic prefixes
20476 Quite a lot of Emacs commands react to the (numeric) prefix. For
20477 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
20478 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
20479 rule of 900 to the current article.
20481 This is all nice and well, but what if you want to give a command some
20482 additional information? Well, what most commands do is interpret the
20483 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
20484 doesn't want a backup file to be created when saving the current buffer,
20485 for instance. But what if you want to save without making a backup
20486 file, and you want Emacs to flash lights and play a nice tune at the
20487 same time? You can't, and you're probably perfectly happy that way.
20489 @kindex M-i (Summary)
20490 @findex gnus-symbolic-argument
20491 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
20492 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
20493 character typed in is the value. You can stack as many @kbd{M-i}
20494 prefixes as you want. @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
20495 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b C-M-u} means
20496 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
20497 @code{b}''. You get the drift.
20499 Typing in symbolic prefixes to commands that don't accept them doesn't
20500 hurt, but it doesn't do any good either. Currently not many Gnus
20501 functions make use of the symbolic prefix.
20503 If you're interested in how Gnus implements this, @pxref{Extended
20507 @node Formatting Variables
20508 @section Formatting Variables
20509 @cindex formatting variables
20511 Throughout this manual you've probably noticed lots of variables called
20512 things like @code{gnus-group-line-format} and
20513 @code{gnus-summary-mode-line-format}. These control how Gnus is to
20514 output lines in the various buffers. There's quite a lot of them.
20515 Fortunately, they all use the same syntax, so there's not that much to
20518 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
20519 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
20520 lots of percentages everywhere.
20523 * Formatting Basics:: A formatting variable is basically a format string.
20524 * Mode Line Formatting:: Some rules about mode line formatting variables.
20525 * Advanced Formatting:: Modifying output in various ways.
20526 * User-Defined Specs:: Having Gnus call your own functions.
20527 * Formatting Fonts:: Making the formatting look colorful and nice.
20528 * Positioning Point:: Moving point to a position after an operation.
20529 * Tabulation:: Tabulating your output.
20530 * Wide Characters:: Dealing with wide characters.
20533 Currently Gnus uses the following formatting variables:
20534 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
20535 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
20536 @code{gnus-group-mode-line-format},
20537 @code{gnus-summary-mode-line-format},
20538 @code{gnus-article-mode-line-format},
20539 @code{gnus-server-mode-line-format}, and
20540 @code{gnus-summary-pick-line-format}.
20542 All these format variables can also be arbitrary elisp forms. In that
20543 case, they will be @code{eval}ed to insert the required lines.
20545 @kindex M-x gnus-update-format
20546 @findex gnus-update-format
20547 Gnus includes a command to help you while creating your own format
20548 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
20549 update the spec in question and pop you to a buffer where you can
20550 examine the resulting Lisp code to be run to generate the line.
20554 @node Formatting Basics
20555 @subsection Formatting Basics
20557 Each @samp{%} element will be replaced by some string or other when the
20558 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
20559 spec, and pad with spaces to get a 5-character field''.
20561 As with normal C and Emacs Lisp formatting strings, the numerical
20562 modifier between the @samp{%} and the formatting type character will
20563 @dfn{pad} the output so that it is always at least that long.
20564 @samp{%5y} will make the field always (at least) five characters wide by
20565 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
20568 You may also wish to limit the length of the field to protect against
20569 particularly wide values. For that you can say @samp{%4,6y}, which
20570 means that the field will never be more than 6 characters wide and never
20571 less than 4 characters wide.
20573 Also Gnus supports some extended format specifications, such as
20574 @samp{%&user-date;}.
20577 @node Mode Line Formatting
20578 @subsection Mode Line Formatting
20580 Mode line formatting variables (e.g.,
20581 @code{gnus-summary-mode-line-format}) follow the same rules as other,
20582 buffer line oriented formatting variables (@pxref{Formatting Basics})
20583 with the following two differences:
20588 There must be no newline (@samp{\n}) at the end.
20591 The special @samp{%%b} spec can be used to display the buffer name.
20592 Well, it's no spec at all, really---@samp{%%} is just a way to quote
20593 @samp{%} to allow it to pass through the formatting machinery unmangled,
20594 so that Emacs receives @samp{%b}, which is something the Emacs mode line
20595 display interprets to mean ``show the buffer name''. For a full list of
20596 mode line specs Emacs understands, see the documentation of the
20597 @code{mode-line-format} variable.
20602 @node Advanced Formatting
20603 @subsection Advanced Formatting
20605 It is frequently useful to post-process the fields in some way.
20606 Padding, limiting, cutting off parts and suppressing certain values can
20607 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
20608 look like @samp{%~(cut 3)~(ignore "0")y}.
20610 These are the valid modifiers:
20615 Pad the field to the left with spaces until it reaches the required
20619 Pad the field to the right with spaces until it reaches the required
20624 Cut off characters from the left until it reaches the specified length.
20627 Cut off characters from the right until it reaches the specified
20632 Cut off the specified number of characters from the left.
20635 Cut off the specified number of characters from the right.
20638 Return an empty string if the field is equal to the specified value.
20641 Use the specified form as the field value when the @samp{@@} spec is
20647 "~(form (current-time-string))@@"
20652 Let's take an example. The @samp{%o} spec in the summary mode lines
20653 will return a date in compact ISO8601 format---@samp{19960809T230410}.
20654 This is quite a mouthful, so we want to shave off the century number and
20655 the time, leaving us with a six-character date. That would be
20656 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
20657 maxing, and we need the padding to ensure that the date is never less
20658 than 6 characters to make it look nice in columns.)
20660 Ignoring is done first; then cutting; then maxing; and then as the very
20661 last operation, padding.
20663 @vindex gnus-compile-user-specs
20664 If @code{gnus-compile-user-specs} is set to @code{nil} (@code{t} by
20665 default) with your strong personality, and use a lots of these advanced
20666 thingies, you'll find that Gnus gets quite slow. This can be helped
20667 enormously by running @kbd{M-x gnus-compile} when you are satisfied with
20668 the look of your lines.
20669 @xref{Compilation}.
20672 @node User-Defined Specs
20673 @subsection User-Defined Specs
20675 All the specs allow for inserting user defined specifiers---@samp{u}.
20676 The next character in the format string should be a letter. Gnus
20677 will call the function @code{gnus-user-format-function-}@samp{X}, where
20678 @samp{X} is the letter following @samp{%u}. The function will be passed
20679 a single parameter---what the parameter means depends on what buffer
20680 it's being called from. The function should return a string, which will
20681 be inserted into the buffer just like information from any other
20682 specifier. This function may also be called with dummy values, so it
20683 should protect against that.
20685 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
20686 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
20688 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
20689 much the same without defining new functions. Here's an example:
20690 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
20691 given here will be evaluated to yield the current line number, and then
20695 @node Formatting Fonts
20696 @subsection Formatting Fonts
20698 There are specs for highlighting, and these are shared by all the format
20699 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
20700 the special @code{mouse-face} property set, which means that it will be
20701 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
20704 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
20705 normal faces set using @code{gnus-face-0}, which is @code{bold} by
20706 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
20707 and so on. Create as many faces as you wish. The same goes for the
20708 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
20709 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
20711 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
20712 special @code{balloon-help} property set to
20713 @code{gnus-balloon-face-0}. If you say @samp{%1<<}, you'll get
20714 @code{gnus-balloon-face-1} and so on. The @code{gnus-balloon-face-*}
20715 variables should be either strings or symbols naming functions that
20716 return a string. When the mouse passes over text with this property
20717 set, a balloon window will appear and display the string. Please
20718 refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual},
20719 (in GNU Emacs) or the doc string of @code{balloon-help-mode} (in
20720 XEmacs) for more information on this. (For technical reasons, the
20721 guillemets have been approximated as @samp{<<} and @samp{>>} in this
20724 Here's an alternative recipe for the group buffer:
20727 ;; @r{Create three face types.}
20728 (setq gnus-face-1 'bold)
20729 (setq gnus-face-3 'italic)
20731 ;; @r{We want the article count to be in}
20732 ;; @r{a bold and green face. So we create}
20733 ;; @r{a new face called @code{my-green-bold}.}
20734 (copy-face 'bold 'my-green-bold)
20735 ;; @r{Set the color.}
20736 (set-face-foreground 'my-green-bold "ForestGreen")
20737 (setq gnus-face-2 'my-green-bold)
20739 ;; @r{Set the new & fancy format.}
20740 (setq gnus-group-line-format
20741 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
20744 I'm sure you'll be able to use this scheme to create totally unreadable
20745 and extremely vulgar displays. Have fun!
20747 Note that the @samp{%(} specs (and friends) do not make any sense on the
20748 mode-line variables.
20750 @node Positioning Point
20751 @subsection Positioning Point
20753 Gnus usually moves point to a pre-defined place on each line in most
20754 buffers. By default, point move to the first colon character on the
20755 line. You can customize this behaviour in three different ways.
20757 You can move the colon character to somewhere else on the line.
20759 @findex gnus-goto-colon
20760 You can redefine the function that moves the point to the colon. The
20761 function is called @code{gnus-goto-colon}.
20763 But perhaps the most convenient way to deal with this, if you don't want
20764 to have a colon in your line, is to use the @samp{%*} specifier. If you
20765 put a @samp{%*} somewhere in your format line definition, Gnus will
20770 @subsection Tabulation
20772 You can usually line up your displays by padding and cutting your
20773 strings. However, when combining various strings of different size, it
20774 can often be more convenient to just output the strings, and then worry
20775 about lining up the following text afterwards.
20777 To do that, Gnus supplies tabulator specs---@samp{%=}. There are two
20778 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
20780 @samp{%50=} will insert space characters to pad the line up to column
20781 50. If the text is already past column 50, nothing will be inserted.
20782 This is the soft tabulator.
20784 @samp{%-50=} will insert space characters to pad the line up to column
20785 50. If the text is already past column 50, the excess text past column
20786 50 will be removed. This is the hard tabulator.
20789 @node Wide Characters
20790 @subsection Wide Characters
20792 Fixed width fonts in most countries have characters of the same width.
20793 Some countries, however, use Latin characters mixed with wider
20794 characters---most notable East Asian countries.
20796 The problem is that when formatting, Gnus assumes that if a string is 10
20797 characters wide, it'll be 10 Latin characters wide on the screen. In
20798 these countries, that's not true.
20800 @vindex gnus-use-correct-string-widths
20801 To help fix this, you can set @code{gnus-use-correct-string-widths} to
20802 @code{t}. This makes buffer generation slower, but the results will be
20803 prettier. The default value under XEmacs is @code{t} but @code{nil}
20807 @node Window Layout
20808 @section Window Layout
20809 @cindex window layout
20811 No, there's nothing here about X, so be quiet.
20813 @vindex gnus-use-full-window
20814 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
20815 other windows and occupy the entire Emacs screen by itself. It is
20816 @code{t} by default.
20818 Setting this variable to @code{nil} kinda works, but there are
20819 glitches. Use at your own peril.
20821 @vindex gnus-buffer-configuration
20822 @code{gnus-buffer-configuration} describes how much space each Gnus
20823 buffer should be given. Here's an excerpt of this variable:
20826 ((group (vertical 1.0 (group 1.0 point)
20827 (if gnus-carpal (group-carpal 4))))
20828 (article (vertical 1.0 (summary 0.25 point)
20832 This is an alist. The @dfn{key} is a symbol that names some action or
20833 other. For instance, when displaying the group buffer, the window
20834 configuration function will use @code{group} as the key. A full list of
20835 possible names is listed below.
20837 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
20838 should occupy. To take the @code{article} split as an example -
20841 (article (vertical 1.0 (summary 0.25 point)
20845 This @dfn{split} says that the summary buffer should occupy 25% of upper
20846 half of the screen, and that it is placed over the article buffer. As
20847 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
20848 reaching for that calculator there). However, the special number
20849 @code{1.0} is used to signal that this buffer should soak up all the
20850 rest of the space available after the rest of the buffers have taken
20851 whatever they need. There should be only one buffer with the @code{1.0}
20852 size spec per split.
20854 Point will be put in the buffer that has the optional third element
20855 @code{point}. In a @code{frame} split, the last subsplit having a leaf
20856 split where the tag @code{frame-focus} is a member (i.e. is the third or
20857 fourth element in the list, depending on whether the @code{point} tag is
20858 present) gets focus.
20860 Here's a more complicated example:
20863 (article (vertical 1.0 (group 4)
20864 (summary 0.25 point)
20865 (if gnus-carpal (summary-carpal 4))
20869 If the size spec is an integer instead of a floating point number,
20870 then that number will be used to say how many lines a buffer should
20871 occupy, not a percentage.
20873 If the @dfn{split} looks like something that can be @code{eval}ed (to be
20874 precise---if the @code{car} of the split is a function or a subr), this
20875 split will be @code{eval}ed. If the result is non-@code{nil}, it will
20876 be used as a split. This means that there will be three buffers if
20877 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
20880 Not complicated enough for you? Well, try this on for size:
20883 (article (horizontal 1.0
20888 (summary 0.25 point)
20893 Whoops. Two buffers with the mystery 100% tag. And what's that
20894 @code{horizontal} thingie?
20896 If the first element in one of the split is @code{horizontal}, Gnus will
20897 split the window horizontally, giving you two windows side-by-side.
20898 Inside each of these strips you may carry on all you like in the normal
20899 fashion. The number following @code{horizontal} says what percentage of
20900 the screen is to be given to this strip.
20902 For each split, there @emph{must} be one element that has the 100% tag.
20903 The splitting is never accurate, and this buffer will eat any leftover
20904 lines from the splits.
20906 To be slightly more formal, here's a definition of what a valid split
20911 split = frame | horizontal | vertical | buffer | form
20912 frame = "(frame " size *split ")"
20913 horizontal = "(horizontal " size *split ")"
20914 vertical = "(vertical " size *split ")"
20915 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
20916 size = number | frame-params
20917 buf-name = group | article | summary ...
20921 The limitations are that the @code{frame} split can only appear as the
20922 top-level split. @var{form} should be an Emacs Lisp form that should
20923 return a valid split. We see that each split is fully recursive, and
20924 may contain any number of @code{vertical} and @code{horizontal} splits.
20926 @vindex gnus-window-min-width
20927 @vindex gnus-window-min-height
20928 @cindex window height
20929 @cindex window width
20930 Finding the right sizes can be a bit complicated. No window may be less
20931 than @code{gnus-window-min-height} (default 1) characters high, and all
20932 windows must be at least @code{gnus-window-min-width} (default 1)
20933 characters wide. Gnus will try to enforce this before applying the
20934 splits. If you want to use the normal Emacs window width/height limit,
20935 you can just set these two variables to @code{nil}.
20937 If you're not familiar with Emacs terminology, @code{horizontal} and
20938 @code{vertical} splits may work the opposite way of what you'd expect.
20939 Windows inside a @code{horizontal} split are shown side-by-side, and
20940 windows within a @code{vertical} split are shown above each other.
20942 @findex gnus-configure-frame
20943 If you want to experiment with window placement, a good tip is to call
20944 @code{gnus-configure-frame} directly with a split. This is the function
20945 that does all the real work when splitting buffers. Below is a pretty
20946 nonsensical configuration with 5 windows; two for the group buffer and
20947 three for the article buffer. (I said it was nonsensical.) If you
20948 @code{eval} the statement below, you can get an idea of how that would
20949 look straight away, without going through the normal Gnus channels.
20950 Play with it until you're satisfied, and then use
20951 @code{gnus-add-configuration} to add your new creation to the buffer
20952 configuration list.
20955 (gnus-configure-frame
20959 (article 0.3 point))
20967 You might want to have several frames as well. No prob---just use the
20968 @code{frame} split:
20971 (gnus-configure-frame
20974 (summary 0.25 point frame-focus)
20976 (vertical ((height . 5) (width . 15)
20977 (user-position . t)
20978 (left . -1) (top . 1))
20983 This split will result in the familiar summary/article window
20984 configuration in the first (or ``main'') frame, while a small additional
20985 frame will be created where picons will be shown. As you can see,
20986 instead of the normal @code{1.0} top-level spec, each additional split
20987 should have a frame parameter alist as the size spec.
20988 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
20989 Reference Manual}. Under XEmacs, a frame property list will be
20990 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
20992 The list of all possible keys for @code{gnus-buffer-configuration} can
20993 be found in its default value.
20995 Note that the @code{message} key is used for both
20996 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
20997 it is desirable to distinguish between the two, something like this
21001 (message (horizontal 1.0
21002 (vertical 1.0 (message 1.0 point))
21004 (if (buffer-live-p gnus-summary-buffer)
21009 One common desire for a multiple frame split is to have a separate frame
21010 for composing mail and news while leaving the original frame intact. To
21011 accomplish that, something like the following can be done:
21016 (if (not (buffer-live-p gnus-summary-buffer))
21017 (car (cdr (assoc 'group gnus-buffer-configuration)))
21018 (car (cdr (assoc 'summary gnus-buffer-configuration))))
21019 (vertical ((user-position . t) (top . 1) (left . 1)
21020 (name . "Message"))
21021 (message 1.0 point))))
21024 @findex gnus-add-configuration
21025 Since the @code{gnus-buffer-configuration} variable is so long and
21026 complicated, there's a function you can use to ease changing the config
21027 of a single setting: @code{gnus-add-configuration}. If, for instance,
21028 you want to change the @code{article} setting, you could say:
21031 (gnus-add-configuration
21032 '(article (vertical 1.0
21034 (summary .25 point)
21038 You'd typically stick these @code{gnus-add-configuration} calls in your
21039 @file{~/.gnus.el} file or in some startup hook---they should be run after
21040 Gnus has been loaded.
21042 @vindex gnus-always-force-window-configuration
21043 If all windows mentioned in the configuration are already visible, Gnus
21044 won't change the window configuration. If you always want to force the
21045 ``right'' window configuration, you can set
21046 @code{gnus-always-force-window-configuration} to non-@code{nil}.
21048 If you're using tree displays (@pxref{Tree Display}), and the tree
21049 window is displayed vertically next to another window, you may also want
21050 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
21053 @subsection Example Window Configurations
21057 Narrow left hand side occupied by group buffer. Right hand side split
21058 between summary buffer (top one-sixth) and article buffer (bottom).
21073 (gnus-add-configuration
21076 (vertical 25 (group 1.0))
21078 (summary 0.16 point)
21081 (gnus-add-configuration
21084 (vertical 25 (group 1.0))
21085 (vertical 1.0 (summary 1.0 point)))))
21091 @node Faces and Fonts
21092 @section Faces and Fonts
21097 Fiddling with fonts and faces used to be very difficult, but these days
21098 it is very simple. You simply say @kbd{M-x customize-face}, pick out
21099 the face you want to alter, and alter it via the standard Customize
21104 @section Compilation
21105 @cindex compilation
21106 @cindex byte-compilation
21108 @findex gnus-compile
21110 Remember all those line format specification variables?
21111 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
21112 on. By default, T-gnus will use the byte-compiled codes of these
21113 variables and we can keep a slow-down to a minimum. However, if you set
21114 @code{gnus-compile-user-specs} to @code{nil} (@code{t} by default),
21115 unfortunately, changing them will mean a quite significant slow-down.
21116 (The default values of these variables have byte-compiled functions
21117 associated with them, while the user-generated versions do not, of
21120 To help with this, you can run @kbd{M-x gnus-compile} after you've
21121 fiddled around with the variables and feel that you're (kind of)
21122 satisfied. This will result in the new specs being byte-compiled, and
21123 you'll get top speed again. Note that T-gnus will not save these
21124 compiled specs in the @file{.newsrc.eld} file.
21127 @item gnus-compile-user-specs
21128 @vindex gnus-compile-user-specs
21129 If it is non-nil, the user-defined format specs will be byte-compiled
21130 automatically. The default value of this variable is @code{t}. It has
21131 an effect on the values of @code{gnus-*-line-format-spec}.
21136 @section Mode Lines
21139 @vindex gnus-updated-mode-lines
21140 @code{gnus-updated-mode-lines} says what buffers should keep their mode
21141 lines updated. It is a list of symbols. Supported symbols include
21142 @code{group}, @code{article}, @code{summary}, @code{server},
21143 @code{browse}, and @code{tree}. If the corresponding symbol is present,
21144 Gnus will keep that mode line updated with information that may be
21145 pertinent. If this variable is @code{nil}, screen refresh may be
21148 @cindex display-time
21150 @vindex gnus-mode-non-string-length
21151 By default, Gnus displays information on the current article in the mode
21152 lines of the summary and article buffers. The information Gnus wishes
21153 to display (e.g. the subject of the article) is often longer than the
21154 mode lines, and therefore have to be cut off at some point. The
21155 @code{gnus-mode-non-string-length} variable says how long the other
21156 elements on the line is (i.e., the non-info part). If you put
21157 additional elements on the mode line (e.g. a clock), you should modify
21160 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
21162 (add-hook 'display-time-hook
21163 (lambda () (setq gnus-mode-non-string-length
21165 (if line-number-mode 5 0)
21166 (if column-number-mode 4 0)
21167 (length display-time-string)))))
21170 If this variable is @code{nil} (which is the default), the mode line
21171 strings won't be chopped off, and they won't be padded either. Note
21172 that the default is unlikely to be desirable, as even the percentage
21173 complete in the buffer may be crowded off the mode line; the user should
21174 configure this variable appropriately for her configuration.
21177 @node Highlighting and Menus
21178 @section Highlighting and Menus
21180 @cindex highlighting
21183 @vindex gnus-visual
21184 The @code{gnus-visual} variable controls most of the Gnus-prettifying
21185 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
21186 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
21189 This variable can be a list of visual properties that are enabled. The
21190 following elements are valid, and are all included by default:
21193 @item group-highlight
21194 Do highlights in the group buffer.
21195 @item summary-highlight
21196 Do highlights in the summary buffer.
21197 @item article-highlight
21198 Do highlights in the article buffer.
21200 Turn on highlighting in all buffers.
21202 Create menus in the group buffer.
21204 Create menus in the summary buffers.
21206 Create menus in the article buffer.
21208 Create menus in the browse buffer.
21210 Create menus in the server buffer.
21212 Create menus in the score buffers.
21214 Create menus in all buffers.
21217 So if you only want highlighting in the article buffer and menus in all
21218 buffers, you could say something like:
21221 (setq gnus-visual '(article-highlight menu))
21224 If you want highlighting only and no menus whatsoever, you'd say:
21227 (setq gnus-visual '(highlight))
21230 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
21231 in all Gnus buffers.
21233 Other general variables that influence the look of all buffers include:
21236 @item gnus-mouse-face
21237 @vindex gnus-mouse-face
21238 This is the face (i.e., font) used for mouse highlighting in Gnus. No
21239 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
21243 There are hooks associated with the creation of all the different menus:
21247 @item gnus-article-menu-hook
21248 @vindex gnus-article-menu-hook
21249 Hook called after creating the article mode menu.
21251 @item gnus-group-menu-hook
21252 @vindex gnus-group-menu-hook
21253 Hook called after creating the group mode menu.
21255 @item gnus-summary-menu-hook
21256 @vindex gnus-summary-menu-hook
21257 Hook called after creating the summary mode menu.
21259 @item gnus-server-menu-hook
21260 @vindex gnus-server-menu-hook
21261 Hook called after creating the server mode menu.
21263 @item gnus-browse-menu-hook
21264 @vindex gnus-browse-menu-hook
21265 Hook called after creating the browse mode menu.
21267 @item gnus-score-menu-hook
21268 @vindex gnus-score-menu-hook
21269 Hook called after creating the score mode menu.
21280 Those new-fangled @dfn{mouse} contraptions is very popular with the
21281 young, hep kids who don't want to learn the proper way to do things
21282 these days. Why, I remember way back in the summer of '89, when I was
21283 using Emacs on a Tops 20 system. Three hundred users on one single
21284 machine, and every user was running Simula compilers. Bah!
21288 @vindex gnus-carpal
21289 Well, you can make Gnus display bufferfuls of buttons you can click to
21290 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
21291 really. Tell the chiropractor I sent you.
21296 @item gnus-carpal-mode-hook
21297 @vindex gnus-carpal-mode-hook
21298 Hook run in all carpal mode buffers.
21300 @item gnus-carpal-button-face
21301 @vindex gnus-carpal-button-face
21302 Face used on buttons.
21304 @item gnus-carpal-header-face
21305 @vindex gnus-carpal-header-face
21306 Face used on carpal buffer headers.
21308 @item gnus-carpal-group-buffer-buttons
21309 @vindex gnus-carpal-group-buffer-buttons
21310 Buttons in the group buffer.
21312 @item gnus-carpal-summary-buffer-buttons
21313 @vindex gnus-carpal-summary-buffer-buttons
21314 Buttons in the summary buffer.
21316 @item gnus-carpal-server-buffer-buttons
21317 @vindex gnus-carpal-server-buffer-buttons
21318 Buttons in the server buffer.
21320 @item gnus-carpal-browse-buffer-buttons
21321 @vindex gnus-carpal-browse-buffer-buttons
21322 Buttons in the browse buffer.
21325 All the @code{buttons} variables are lists. The elements in these list
21326 are either cons cells where the @code{car} contains a text to be displayed and
21327 the @code{cdr} contains a function symbol, or a simple string.
21335 Gnus, being larger than any program ever written (allegedly), does lots
21336 of strange stuff that you may wish to have done while you're not
21337 present. For instance, you may want it to check for new mail once in a
21338 while. Or you may want it to close down all connections to all servers
21339 when you leave Emacs idle. And stuff like that.
21341 Gnus will let you do stuff like that by defining various
21342 @dfn{handlers}. Each handler consists of three elements: A
21343 @var{function}, a @var{time}, and an @var{idle} parameter.
21345 Here's an example of a handler that closes connections when Emacs has
21346 been idle for thirty minutes:
21349 (gnus-demon-close-connections nil 30)
21352 Here's a handler that scans for @acronym{PGP} headers every hour when
21356 (gnus-demon-scan-pgp 60 t)
21359 This @var{time} parameter and that @var{idle} parameter work together
21360 in a strange, but wonderful fashion. Basically, if @var{idle} is
21361 @code{nil}, then the function will be called every @var{time} minutes.
21363 If @var{idle} is @code{t}, then the function will be called after
21364 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
21365 the function will never be called. But once Emacs goes idle, the
21366 function will be called every @var{time} minutes.
21368 If @var{idle} is a number and @var{time} is a number, the function will
21369 be called every @var{time} minutes only when Emacs has been idle for
21370 @var{idle} minutes.
21372 If @var{idle} is a number and @var{time} is @code{nil}, the function
21373 will be called once every time Emacs has been idle for @var{idle}
21376 And if @var{time} is a string, it should look like @samp{07:31}, and
21377 the function will then be called once every day somewhere near that
21378 time. Modified by the @var{idle} parameter, of course.
21380 @vindex gnus-demon-timestep
21381 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
21382 seconds. This is 60 by default. If you change that variable,
21383 all the timings in the handlers will be affected.)
21385 So, if you want to add a handler, you could put something like this in
21386 your @file{~/.gnus.el} file:
21388 @findex gnus-demon-add-handler
21390 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
21393 @findex gnus-demon-add-nocem
21394 @findex gnus-demon-add-scanmail
21395 @findex gnus-demon-add-rescan
21396 @findex gnus-demon-add-scan-timestamps
21397 @findex gnus-demon-add-disconnection
21398 Some ready-made functions to do this have been created:
21399 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
21400 @code{gnus-demon-add-nntp-close-connection},
21401 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
21402 @code{gnus-demon-add-scanmail}. Just put those functions in your
21403 @file{~/.gnus.el} if you want those abilities.
21405 @findex gnus-demon-init
21406 @findex gnus-demon-cancel
21407 @vindex gnus-demon-handlers
21408 If you add handlers to @code{gnus-demon-handlers} directly, you should
21409 run @code{gnus-demon-init} to make the changes take hold. To cancel all
21410 daemons, you can use the @code{gnus-demon-cancel} function.
21412 Note that adding daemons can be pretty naughty if you over do it. Adding
21413 functions that scan all news and mail from all servers every two seconds
21414 is a sure-fire way of getting booted off any respectable system. So
21423 @dfn{Spamming} is posting the same article lots and lots of times.
21424 Spamming is bad. Spamming is evil.
21426 Spamming is usually canceled within a day or so by various anti-spamming
21427 agencies. These agencies usually also send out @dfn{NoCeM} messages.
21428 NoCeM is pronounced ``no see-'em'', and means what the name
21429 implies---these are messages that make the offending articles, like, go
21432 What use are these NoCeM messages if the articles are canceled anyway?
21433 Some sites do not honor cancel messages and some sites just honor cancels
21434 from a select few people. Then you may wish to make use of the NoCeM
21435 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
21437 Gnus can read and parse the messages in this group automatically, and
21438 this will make spam disappear.
21440 There are some variables to customize, of course:
21443 @item gnus-use-nocem
21444 @vindex gnus-use-nocem
21445 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
21448 @item gnus-nocem-groups
21449 @vindex gnus-nocem-groups
21450 Gnus will look for NoCeM messages in the groups in this list. The
21453 ("news.lists.filters" "news.admin.net-abuse.bulletins"
21454 "alt.nocem.misc" "news.admin.net-abuse.announce")
21457 @item gnus-nocem-issuers
21458 @vindex gnus-nocem-issuers
21459 There are many people issuing NoCeM messages. This list says what
21460 people you want to listen to. The default is
21462 ("Automoose-1" "clewis@@ferret.ocunix.on.ca"
21463 "cosmo.roadkill" "SpamHippo" "hweede@@snafu.de")
21465 fine, upstanding citizens all of them.
21467 Known despammers that you can put in this list are listed at@*
21468 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
21470 You do not have to heed NoCeM messages from all these people---just the
21471 ones you want to listen to. You also don't have to accept all NoCeM
21472 messages from the people you like. Each NoCeM message has a @dfn{type}
21473 header that gives the message a (more or less, usually less) rigorous
21474 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
21475 @samp{binary}, and @samp{troll}. To specify this, you have to use
21476 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
21477 Each condition is either a string (which is a regexp that matches types
21478 you want to use) or a list on the form @code{(not @var{string})}, where
21479 @var{string} is a regexp that matches types you don't want to use.
21481 For instance, if you want all NoCeM messages from Chris Lewis except his
21482 @samp{troll} messages, you'd say:
21485 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
21488 On the other hand, if you just want nothing but his @samp{spam} and
21489 @samp{spew} messages, you'd say:
21492 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
21495 The specs are applied left-to-right.
21498 @item gnus-nocem-verifyer
21499 @vindex gnus-nocem-verifyer
21501 This should be a function for verifying that the NoCeM issuer is who she
21502 says she is. The default is @code{mc-verify}, which is a Mailcrypt
21503 function. If this is too slow and you don't care for verification
21504 (which may be dangerous), you can set this variable to @code{nil}.
21506 If you want signed NoCeM messages to be verified and unsigned messages
21507 not to be verified (but used anyway), you could do something like:
21510 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
21512 (defun my-gnus-mc-verify ()
21520 This might be dangerous, though.
21522 @item gnus-nocem-directory
21523 @vindex gnus-nocem-directory
21524 This is where Gnus will store its NoCeM cache files. The default is@*
21525 @file{~/News/NoCeM/}.
21527 @item gnus-nocem-expiry-wait
21528 @vindex gnus-nocem-expiry-wait
21529 The number of days before removing old NoCeM entries from the cache.
21530 The default is 15. If you make it shorter Gnus will be faster, but you
21531 might then see old spam.
21533 @item gnus-nocem-check-from
21534 @vindex gnus-nocem-check-from
21535 Non-@code{nil} means check for valid issuers in message bodies.
21536 Otherwise don't bother fetching articles unless their author matches a
21537 valid issuer; that is much faster if you are selective about the
21540 @item gnus-nocem-check-article-limit
21541 @vindex gnus-nocem-check-article-limit
21542 If non-@code{nil}, the maximum number of articles to check in any NoCeM
21543 group. NoCeM groups can be huge and very slow to process.
21547 Using NoCeM could potentially be a memory hog. If you have many living
21548 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
21549 big. If this is a problem, you should kill off all (or most) of your
21550 unsubscribed groups (@pxref{Subscription Commands}).
21557 It is very useful to be able to undo actions one has done. In normal
21558 Emacs buffers, it's easy enough---you just push the @code{undo} button.
21559 In Gnus buffers, however, it isn't that simple.
21561 The things Gnus displays in its buffer is of no value whatsoever to
21562 Gnus---it's all just data designed to look nice to the user.
21563 Killing a group in the group buffer with @kbd{C-k} makes the line
21564 disappear, but that's just a side-effect of the real action---the
21565 removal of the group in question from the internal Gnus structures.
21566 Undoing something like that can't be done by the normal Emacs
21567 @code{undo} function.
21569 Gnus tries to remedy this somewhat by keeping track of what the user
21570 does and coming up with actions that would reverse the actions the user
21571 takes. When the user then presses the @code{undo} key, Gnus will run
21572 the code to reverse the previous action, or the previous actions.
21573 However, not all actions are easily reversible, so Gnus currently offers
21574 a few key functions to be undoable. These include killing groups,
21575 yanking groups, and changing the list of read articles of groups.
21576 That's it, really. More functions may be added in the future, but each
21577 added function means an increase in data to be stored, so Gnus will
21578 never be totally undoable.
21580 @findex gnus-undo-mode
21581 @vindex gnus-use-undo
21583 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
21584 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
21585 default. The @kbd{C-M-_} key performs the @code{gnus-undo}
21586 command, which should feel kinda like the normal Emacs @code{undo}
21590 @node Predicate Specifiers
21591 @section Predicate Specifiers
21592 @cindex predicate specifiers
21594 Some Gnus variables are @dfn{predicate specifiers}. This is a special
21595 form that allows flexible specification of predicates without having
21596 to type all that much.
21598 These specifiers are lists consisting of functions, symbols and lists.
21603 (or gnus-article-unseen-p
21604 gnus-article-unread-p)
21607 The available symbols are @code{or}, @code{and} and @code{not}. The
21608 functions all take one parameter.
21610 @findex gnus-make-predicate
21611 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
21612 to create a function that can be called. This input parameter to this
21613 function will be passed along to all the functions in the predicate
21618 @section Moderation
21621 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
21622 It is not included in the standard Gnus package. Write a mail to
21623 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
21626 The moderation package is implemented as a minor mode for summary
21630 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
21633 in your @file{~/.gnus.el} file.
21635 If you are the moderator of @samp{rec.zoofle}, this is how it's
21640 You split your incoming mail by matching on
21641 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
21642 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
21645 You enter that group once in a while and post articles using the @kbd{e}
21646 (edit-and-post) or @kbd{s} (just send unedited) commands.
21649 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
21650 articles that weren't approved by you, you can cancel them with the
21654 To use moderation mode in these two groups, say:
21657 (setq gnus-moderated-list
21658 "^nnml:rec.zoofle$\\|^rec.zoofle$")
21662 @node Image Enhancements
21663 @section Image Enhancements
21665 XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't
21666 support images yet.}, is able to display pictures and stuff, so Gnus has
21667 taken advantage of that.
21670 * X-Face:: Display a funky, teensy black-and-white image.
21671 * Face:: Display a funkier, teensier colored image.
21672 * Smileys:: Show all those happy faces the way they were meant to be shown.
21673 * Picons:: How to display pictures of what you're reading.
21674 * XVarious:: Other XEmacsy Gnusey variables.
21682 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
21683 depth) image that's supposed to represent the author of the message.
21684 It seems to be supported by an ever-growing number of mail and news
21688 @findex gnus-article-display-x-face
21689 @vindex gnus-article-x-face-command
21690 @vindex gnus-article-x-face-too-ugly
21698 Gnus now uses the internal ELisp-based @code{uncompface} program for
21699 decoding an @code{X-Face} header normally in Emacs. While it doesn't
21700 require any other external program, you may feel it is slow if you are
21701 using a slow machine. In such a case, you can modify the following
21705 @item uncompface-use-external
21706 @vindex uncompface-use-external
21707 Specify which of the internal or the external decoder should be used.
21708 @code{nil} means to use the internal ELisp-based @code{uncompface}
21709 program. @code{t} means to use the external decoder. The default value
21710 is normally @code{undecided} which means to determine it by checking
21711 whether the host machine is slow, being controlled by
21712 @code{uncompface-use-external-threshold} (which see).
21714 @item uncompface-use-external-threshold
21715 @vindex uncompface-use-external-threshold
21716 A number of seconds to check whether the host machine is slow. If the
21717 host takes time larger than this value for decoding an @code{X-Face}
21718 using the internal ELisp-based @code{uncompface} program, it will be
21719 changed to using the external decoder. The default is 0.1 seconds.
21722 If the internal decoder is invalidated or if you are using XEmacs,
21723 decoding an @code{X-Face} header either requires an Emacs that has
21724 @samp{compface} support (which most XEmacs versions has), or that you
21725 have @samp{compface} installed on your system. If either is true,
21726 Gnus will default to displaying @code{X-Face} headers.
21728 The variable that controls this is the
21729 @code{gnus-article-x-face-command} variable. If this variable is a
21730 string, this string will be executed in a sub-shell. If it is a
21731 function, this function will be called with the face as the argument.
21732 If the @code{gnus-article-x-face-too-ugly} (which is a regexp) matches
21733 the @code{From} header, the face will not be shown.
21735 The default action under Emacs 20 is to fork off the @code{display}
21736 program@footnote{@code{display} is from the ImageMagick package. For
21737 the @code{uncompface} and @code{icontopbm} programs look for a package
21738 like @code{compface} or @code{faces-xface} on a GNU/Linux system.} to
21741 Under XEmacs or Emacs 21+ with suitable image support, the default
21742 action is to display the face before the @code{From} header. (It's
21743 nicer if XEmacs has been compiled with @code{X-Face} support---that
21744 will make display somewhat faster. If there's no native @code{X-Face}
21745 support, Gnus will try to convert the @code{X-Face} header using
21746 external programs from the @code{pbmplus} package and
21747 friends.@footnote{On a GNU/Linux system look for packages with names
21748 like @code{netpbm}, @code{libgr-progs} and @code{compface}.})
21750 (Note: @code{x-face} is used in the variable/function names, not
21758 @vindex gnus-x-face
21759 Face to show X-Face. The colors from this face are used as the
21760 foreground and background colors of the displayed X-Faces. The
21761 default colors are black and white.
21763 @item gnus-face-properties-alist
21764 @vindex gnus-face-properties-alist
21765 Alist of image types and properties applied to Face (@pxref{Face}) and
21766 X-Face images. The default value is @code{((pbm . (:face gnus-x-face))
21767 (png . nil))} for Emacs or @code{((xface . (:face gnus-x-face)))} for
21768 XEmacs. Here are examples:
21771 ;; Specify the altitude of Face and X-Face images in the From header.
21772 (setq gnus-face-properties-alist
21773 '((pbm . (:face gnus-x-face :ascent 80))
21774 (png . (:ascent 80))))
21776 ;; Show Face and X-Face images as pressed buttons.
21777 (setq gnus-face-properties-alist
21778 '((pbm . (:face gnus-x-face :relief -2))
21779 (png . (:relief -2))))
21782 @pxref{Image Descriptors, ,Image Descriptors, elisp, The Emacs Lisp
21783 Reference Manual} for the valid properties for various image types.
21784 Currently, @code{pbm} is used for X-Face images and @code{png} is used
21785 for Face images in Emacs. Only the @code{:face} property is effective
21786 on the @code{xface} image type in XEmacs if it is built with the
21787 @samp{libcompface} library.
21790 Gnus provides a few convenience functions and variables to allow
21791 easier insertion of X-Face headers in outgoing messages.
21793 @findex gnus-random-x-face
21794 @vindex gnus-convert-pbm-to-x-face-command
21795 @vindex gnus-x-face-directory
21796 @code{gnus-random-x-face} goes through all the @samp{pbm} files in
21797 @code{gnus-x-face-directory} and picks one at random, and then
21798 converts it to the X-Face format by using the
21799 @code{gnus-convert-pbm-to-x-face-command} shell command. The
21800 @samp{pbm} files should be 48x48 pixels big. It returns the X-Face
21801 header data as a string.
21803 @findex gnus-insert-random-x-face-header
21804 @code{gnus-insert-random-x-face-header} calls
21805 @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the
21806 randomly generated data.
21808 @findex gnus-x-face-from-file
21809 @vindex gnus-convert-image-to-x-face-command
21810 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
21811 converts the file to X-Face format by using the
21812 @code{gnus-convert-image-to-x-face-command} shell command.
21814 Here's how you would typically use the first function. Put something
21815 like the following in your @file{~/.gnus.el} file:
21818 (setq message-required-news-headers
21819 (nconc message-required-news-headers
21820 (list '(X-Face . gnus-random-x-face))))
21823 Using the last function would be something like this:
21826 (setq message-required-news-headers
21827 (nconc message-required-news-headers
21828 (list '(X-Face . (lambda ()
21829 (gnus-x-face-from-file
21830 "~/My-face.gif"))))))
21838 @c #### FIXME: faces and x-faces'implementations should really be harmonized.
21840 @code{Face} headers are essentially a funkier version of @code{X-Face}
21841 ones. They describe a 48x48 pixel colored image that's supposed to
21842 represent the author of the message.
21845 @findex gnus-article-display-face
21846 The contents of a @code{Face} header must be a base64 encoded PNG image.
21847 See @uref{http://quimby.gnus.org/circus/face/} for the precise
21850 The @code{gnus-face-properties-alist} variable affects the appearance of
21851 displayed Face images. @xref{X-Face}.
21853 Gnus provides a few convenience functions and variables to allow
21854 easier insertion of Face headers in outgoing messages.
21856 @findex gnus-convert-png-to-face
21857 @code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than
21858 726 bytes long, and converts it to a face.
21860 @findex gnus-face-from-file
21861 @vindex gnus-convert-image-to-face-command
21862 @code{gnus-face-from-file} takes a JPEG file as the parameter, and then
21863 converts the file to Face format by using the
21864 @code{gnus-convert-image-to-face-command} shell command.
21866 Here's how you would typically use this function. Put something like the
21867 following in your @file{~/.gnus.el} file:
21870 (setq message-required-news-headers
21871 (nconc message-required-news-headers
21872 (list '(Face . (lambda ()
21873 (gnus-face-from-file "~/face.jpg"))))))
21878 @subsection Smileys
21883 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
21888 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
21889 currently the only package that uses Smiley, it is documented here.
21891 In short---to use Smiley in Gnus, put the following in your
21892 @file{~/.gnus.el} file:
21895 (setq gnus-treat-display-smileys t)
21898 Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and
21899 the like---to pictures and displays those instead of the text smiley
21900 faces. The conversion is controlled by a list of regexps that matches
21901 text and maps that to file names.
21903 @vindex smiley-regexp-alist
21904 The alist used is specified by the @code{smiley-regexp-alist}
21905 variable. The first item in each element is the regexp to be matched;
21906 the second element is the regexp match group that is to be replaced by
21907 the picture; and the third element is the name of the file to be
21910 The following variables customize where Smiley will look for these
21915 @item smiley-data-directory
21916 @vindex smiley-data-directory
21917 Where Smiley will look for smiley faces files.
21919 @item gnus-smiley-file-types
21920 @vindex gnus-smiley-file-types
21921 List of suffixes on smiley file names to try.
21935 So@dots{} You want to slow down your news reader even more! This is a
21936 good way to do so. It's also a great way to impress people staring
21937 over your shoulder as you read news.
21939 What are Picons? To quote directly from the Picons Web site:
21948 @dfn{Picons} is short for ``personal icons''. They're small,
21949 constrained images used to represent users and domains on the net,
21950 organized into databases so that the appropriate image for a given
21951 e-mail address can be found. Besides users and domains, there are picon
21952 databases for Usenet newsgroups and weather forecasts. The picons are
21953 in either monochrome @code{XBM} format or color @code{XPM} and
21954 @code{GIF} formats.
21957 @vindex gnus-picon-databases
21958 For instructions on obtaining and installing the picons databases,
21959 point your Web browser at
21960 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.
21962 If you are using Debian GNU/Linux, saying @samp{apt-get install
21963 picons.*} will install the picons where Gnus can find them.
21965 To enable displaying picons, simply make sure that
21966 @code{gnus-picon-databases} points to the directory containing the
21969 The following variables offer control over where things are located.
21973 @item gnus-picon-databases
21974 @vindex gnus-picon-databases
21975 The location of the picons database. This is a list of directories
21976 containing the @file{news}, @file{domains}, @file{users} (and so on)
21977 subdirectories. Defaults to @code{("/usr/lib/picon"
21978 "/usr/local/faces")}.
21980 @item gnus-picon-news-directories
21981 @vindex gnus-picon-news-directories
21982 List of subdirectories to search in @code{gnus-picon-databases} for
21983 newsgroups faces. @code{("news")} is the default.
21985 @item gnus-picon-user-directories
21986 @vindex gnus-picon-user-directories
21987 List of subdirectories to search in @code{gnus-picon-databases} for user
21988 faces. @code{("users" "usenix" "local" "misc")} is the default.
21990 @item gnus-picon-domain-directories
21991 @vindex gnus-picon-domain-directories
21992 List of subdirectories to search in @code{gnus-picon-databases} for
21993 domain name faces. Defaults to @code{("domains")}. Some people may
21994 want to add @samp{"unknown"} to this list.
21996 @item gnus-picon-file-types
21997 @vindex gnus-picon-file-types
21998 Ordered list of suffixes on picon file names to try. Defaults to
21999 @code{("xpm" "gif" "xbm")} minus those not built-in your Emacs.
22005 @subsection Various XEmacs Variables
22008 @item gnus-xmas-glyph-directory
22009 @vindex gnus-xmas-glyph-directory
22010 This is where Gnus will look for pictures. Gnus will normally
22011 auto-detect this directory, but you may set it manually if you have an
22012 unusual directory structure.
22014 @item gnus-xmas-logo-color-alist
22015 @vindex gnus-xmas-logo-color-alist
22016 This is an alist where the key is a type symbol and the values are the
22017 foreground and background color of the splash page glyph.
22019 @item gnus-xmas-logo-color-style
22020 @vindex gnus-xmas-logo-color-style
22021 This is the key used to look up the color in the alist described above.
22022 Valid values include @code{flame}, @code{pine}, @code{moss},
22023 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
22024 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
22026 @item gnus-xmas-modeline-glyph
22027 @vindex gnus-xmas-modeline-glyph
22028 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
22033 @subsubsection Toolbar
22037 @item gnus-use-toolbar
22038 @vindex gnus-use-toolbar
22039 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
22040 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
22041 @code{right-toolbar}, or @code{left-toolbar}.
22043 @item gnus-group-toolbar
22044 @vindex gnus-group-toolbar
22045 The toolbar in the group buffer.
22047 @item gnus-summary-toolbar
22048 @vindex gnus-summary-toolbar
22049 The toolbar in the summary buffer.
22051 @item gnus-summary-mail-toolbar
22052 @vindex gnus-summary-mail-toolbar
22053 The toolbar in the summary buffer of mail groups.
22064 @node Fuzzy Matching
22065 @section Fuzzy Matching
22066 @cindex fuzzy matching
22068 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
22069 things like scoring, thread gathering and thread comparison.
22071 As opposed to regular expression matching, fuzzy matching is very fuzzy.
22072 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
22073 means, and the implementation has changed over time.
22075 Basically, it tries to remove all noise from lines before comparing.
22076 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
22077 out of the strings before comparing the results. This often leads to
22078 adequate results---even when faced with strings generated by text
22079 manglers masquerading as newsreaders.
22082 @node Thwarting Email Spam
22083 @section Thwarting Email Spam
22087 @cindex unsolicited commercial email
22089 In these last days of the Usenet, commercial vultures are hanging about
22090 and grepping through news like crazy to find email addresses they can
22091 foist off their scams and products to. As a reaction to this, many
22092 people have started putting nonsense addresses into their @code{From}
22093 lines. I think this is counterproductive---it makes it difficult for
22094 people to send you legitimate mail in response to things you write, as
22095 well as making it difficult to see who wrote what. This rewriting may
22096 perhaps be a bigger menace than the unsolicited commercial email itself
22099 The biggest problem I have with email spam is that it comes in under
22100 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
22101 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
22102 mail group, only to find two pyramid schemes, seven advertisements
22103 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
22104 and one mail asking me to repent and find some god.
22106 This is annoying. Here's what you can do about it.
22109 * The problem of spam:: Some background, and some solutions
22110 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
22111 * SpamAssassin:: How to use external anti-spam tools.
22112 * Hashcash:: Reduce spam by burning CPU time.
22113 * Filtering Spam Using The Spam ELisp Package::
22114 * Filtering Spam Using Statistics with spam-stat::
22117 @node The problem of spam
22118 @subsection The problem of spam
22120 @cindex spam filtering approaches
22121 @cindex filtering approaches, spam
22123 @cindex unsolicited commercial email
22125 First, some background on spam.
22127 If you have access to e-mail, you are familiar with spam (technically
22128 termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it
22129 exists because e-mail delivery is very cheap compared to paper mail,
22130 so only a very small percentage of people need to respond to an UCE to
22131 make it worthwhile to the advertiser. Ironically, one of the most
22132 common spams is the one offering a database of e-mail addresses for
22133 further spamming. Senders of spam are usually called @emph{spammers},
22134 but terms like @emph{vermin}, @emph{scum}, @emph{sociopaths}, and
22135 @emph{morons} are in common use as well.
22137 Spam comes from a wide variety of sources. It is simply impossible to
22138 dispose of all spam without discarding useful messages. A good
22139 example is the TMDA system, which requires senders
22140 unknown to you to confirm themselves as legitimate senders before
22141 their e-mail can reach you. Without getting into the technical side
22142 of TMDA, a downside is clearly that e-mail from legitimate sources may
22143 be discarded if those sources can't or won't confirm themselves
22144 through the TMDA system. Another problem with TMDA is that it
22145 requires its users to have a basic understanding of e-mail delivery
22148 The simplest approach to filtering spam is filtering, at the mail
22149 server or when you sort through incoming mail. If you get 200 spam
22150 messages per day from @samp{random-address@@vmadmin.com}, you block
22151 @samp{vmadmin.com}. If you get 200 messages about @samp{VIAGRA}, you
22152 discard all messages with @samp{VIAGRA} in the message. If you get
22153 lots of spam from Bulgaria, for example, you try to filter all mail
22154 from Bulgarian IPs.
22156 This, unfortunately, is a great way to discard legitimate e-mail. The
22157 risks of blocking a whole country (Bulgaria, Norway, Nigeria, China,
22158 etc.) or even a continent (Asia, Africa, Europe, etc.) from contacting
22159 you should be obvious, so don't do it if you have the choice.
22161 In another instance, the very informative and useful RISKS digest has
22162 been blocked by overzealous mail filters because it @strong{contained}
22163 words that were common in spam messages. Nevertheless, in isolated
22164 cases, with great care, direct filtering of mail can be useful.
22166 Another approach to filtering e-mail is the distributed spam
22167 processing, for instance DCC implements such a system. In essence,
22168 @var{N} systems around the world agree that a machine @var{X} in
22169 Ghana, Estonia, or California is sending out spam e-mail, and these
22170 @var{N} systems enter @var{X} or the spam e-mail from @var{X} into a
22171 database. The criteria for spam detection vary---it may be the number
22172 of messages sent, the content of the messages, and so on. When a user
22173 of the distributed processing system wants to find out if a message is
22174 spam, he consults one of those @var{N} systems.
22176 Distributed spam processing works very well against spammers that send
22177 a large number of messages at once, but it requires the user to set up
22178 fairly complicated checks. There are commercial and free distributed
22179 spam processing systems. Distributed spam processing has its risks as
22180 well. For instance legitimate e-mail senders have been accused of
22181 sending spam, and their web sites and mailing lists have been shut
22182 down for some time because of the incident.
22184 The statistical approach to spam filtering is also popular. It is
22185 based on a statistical analysis of previous spam messages. Usually
22186 the analysis is a simple word frequency count, with perhaps pairs of
22187 words or 3-word combinations thrown into the mix. Statistical
22188 analysis of spam works very well in most of the cases, but it can
22189 classify legitimate e-mail as spam in some cases. It takes time to
22190 run the analysis, the full message must be analyzed, and the user has
22191 to store the database of spam analyses. Statistical analysis on the
22192 server is gaining popularity. This has the advantage of letting the
22193 user Just Read Mail, but has the disadvantage that it's harder to tell
22194 the server that it has misclassified mail.
22196 Fighting spam is not easy, no matter what anyone says. There is no
22197 magic switch that will distinguish Viagra ads from Mom's e-mails.
22198 Even people are having a hard time telling spam apart from non-spam,
22199 because spammers are actively looking to fool us into thinking they
22200 are Mom, essentially. Spamming is irritating, irresponsible, and
22201 idiotic behavior from a bunch of people who think the world owes them
22202 a favor. We hope the following sections will help you in fighting the
22205 @node Anti-Spam Basics
22206 @subsection Anti-Spam Basics
22210 @cindex unsolicited commercial email
22212 One way of dealing with spam is having Gnus split out all spam into a
22213 @samp{spam} mail group (@pxref{Splitting Mail}).
22215 First, pick one (1) valid mail address that you can be reached at, and
22216 put it in your @code{From} header of all your news articles. (I've
22217 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
22218 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
22219 sysadmin whether your sendmail installation accepts keywords in the local
22220 part of the mail address.)
22223 (setq message-default-news-headers
22224 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
22227 Then put the following split rule in @code{nnmail-split-fancy}
22228 (@pxref{Fancy Mail Splitting}):
22232 (to "larsi@@trym.ifi.uio.no"
22233 (| ("subject" "re:.*" "misc")
22234 ("references" ".*@@.*" "misc")
22239 This says that all mail to this address is suspect, but if it has a
22240 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
22241 header, it's probably ok. All the rest goes to the @samp{spam} group.
22242 (This idea probably comes from Tim Pierce.)
22244 In addition, many mail spammers talk directly to your @acronym{SMTP} server
22245 and do not include your email address explicitly in the @code{To}
22246 header. Why they do this is unknown---perhaps it's to thwart this
22247 thwarting scheme? In any case, this is trivial to deal with---you just
22248 put anything not addressed to you in the @samp{spam} group by ending
22249 your fancy split rule in this way:
22254 (to "larsi" "misc")
22258 In my experience, this will sort virtually everything into the right
22259 group. You still have to check the @samp{spam} group from time to time to
22260 check for legitimate mail, though. If you feel like being a good net
22261 citizen, you can even send off complaints to the proper authorities on
22262 each unsolicited commercial email---at your leisure.
22264 This works for me. It allows people an easy way to contact me (they can
22265 just press @kbd{r} in the usual way), and I'm not bothered at all with
22266 spam. It's a win-win situation. Forging @code{From} headers to point
22267 to non-existent domains is yucky, in my opinion.
22269 Be careful with this approach. Spammers are wise to it.
22273 @subsection SpamAssassin, Vipul's Razor, DCC, etc
22274 @cindex SpamAssassin
22275 @cindex Vipul's Razor
22278 The days where the hints in the previous section were sufficient in
22279 avoiding spam are coming to an end. There are many tools out there
22280 that claim to reduce the amount of spam you get. This section could
22281 easily become outdated fast, as new products replace old, but
22282 fortunately most of these tools seem to have similar interfaces. Even
22283 though this section will use SpamAssassin as an example, it should be
22284 easy to adapt it to most other tools.
22286 Note that this section does not involve the @code{spam.el} package,
22287 which is discussed in the next section. If you don't care for all
22288 the features of @code{spam.el}, you can make do with these simple
22291 If the tool you are using is not installed on the mail server, you
22292 need to invoke it yourself. Ideas on how to use the
22293 @code{:postscript} mail source parameter (@pxref{Mail Source
22294 Specifiers}) follow.
22298 '((file :prescript "formail -bs spamassassin < /var/mail/%u")
22302 "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
22305 Once you manage to process your incoming spool somehow, thus making
22306 the mail contain e.g.@: a header indicating it is spam, you are ready to
22307 filter it out. Using normal split methods (@pxref{Splitting Mail}):
22310 (setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES")
22314 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
22317 (setq nnmail-split-methods 'nnmail-split-fancy
22318 nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
22322 Some people might not like the idea of piping the mail through various
22323 programs using a @code{:prescript} (if some program is buggy, you
22324 might lose all mail). If you are one of them, another solution is to
22325 call the external tools during splitting. Example fancy split method:
22328 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
22330 (defun kevin-spamassassin ()
22334 (if (eq 1 (call-process-region (point-min) (point-max)
22335 "spamc" nil nil nil "-c"))
22339 Note that with the nnimap backend, message bodies will not be
22340 downloaded by default. You need to set
22341 @code{nnimap-split-download-body} to @code{t} to do that
22342 (@pxref{Splitting in IMAP}).
22344 That is about it. As some spam is likely to get through anyway, you
22345 might want to have a nifty function to call when you happen to read
22346 spam. And here is the nifty function:
22349 (defun my-gnus-raze-spam ()
22350 "Submit SPAM to Vipul's Razor, then mark it as expirable."
22352 (gnus-summary-show-raw-article)
22353 (gnus-summary-save-in-pipe "razor-report -f -d")
22354 (gnus-summary-mark-as-expirable 1))
22358 @subsection Hashcash
22361 A novel technique to fight spam is to require senders to do something
22362 costly for each message they send. This has the obvious drawback that
22363 you cannot rely on everyone in the world using this technique,
22364 since it is not part of the Internet standards, but it may be useful
22365 in smaller communities.
22367 While the tools in the previous section work well in practice, they
22368 work only because the tools are constantly maintained and updated as
22369 new form of spam appears. This means that a small percentage of spam
22370 will always get through. It also means that somewhere, someone needs
22371 to read lots of spam to update these tools. Hashcash avoids that, but
22372 instead prefers that everyone you contact through e-mail supports the
22373 scheme. You can view the two approaches as pragmatic vs dogmatic.
22374 The approaches have their own advantages and disadvantages, but as
22375 often in the real world, a combination of them is stronger than either
22376 one of them separately.
22379 The ``something costly'' is to burn CPU time, more specifically to
22380 compute a hash collision up to a certain number of bits. The
22381 resulting hashcash cookie is inserted in a @samp{X-Hashcash:}
22382 header. For more details, and for the external application
22383 @code{hashcash} you need to install to use this feature, see
22384 @uref{http://www.cypherspace.org/~adam/hashcash/}. Even more
22385 information can be found at @uref{http://www.camram.org/}.
22387 If you wish to call hashcash for each message you send, say something
22391 (require 'hashcash)
22392 (add-hook 'message-send-hook 'mail-add-payment)
22395 The @file{hashcash.el} library can be found in the Gnus development
22396 contrib directory or at
22397 @uref{http://users.actrix.gen.nz/mycroft/hashcash.el}.
22399 You will need to set up some additional variables as well:
22403 @item hashcash-default-payment
22404 @vindex hashcash-default-payment
22405 This variable indicates the default number of bits the hash collision
22406 should consist of. By default this is 0, meaning nothing will be
22407 done. Suggested useful values include 17 to 29.
22409 @item hashcash-payment-alist
22410 @vindex hashcash-payment-alist
22411 Some receivers may require you to spend burn more CPU time than the
22412 default. This variable contains a list of @samp{(@var{addr}
22413 @var{amount})} cells, where @var{addr} is the receiver (email address
22414 or newsgroup) and @var{amount} is the number of bits in the collision
22415 that is needed. It can also contain @samp{(@var{addr} @var{string}
22416 @var{amount})} cells, where the @var{string} is the string to use
22417 (normally the email address or newsgroup name is used).
22421 Where the @code{hashcash} binary is installed.
22425 Currently there is no built in functionality in Gnus to verify
22426 hashcash cookies, it is expected that this is performed by your hand
22427 customized mail filtering scripts. Improvements in this area would be
22428 a useful contribution, however.
22430 @node Filtering Spam Using The Spam ELisp Package
22431 @subsection Filtering Spam Using The Spam ELisp Package
22432 @cindex spam filtering
22435 The idea behind @file{spam.el} is to have a control center for spam detection
22436 and filtering in Gnus. To that end, @file{spam.el} does two things: it
22437 filters new mail, and it analyzes mail known to be spam or ham.
22438 @dfn{Ham} is the name used throughout @file{spam.el} to indicate
22441 First of all, you @strong{must} run the function
22442 @code{spam-initialize} to autoload @code{spam.el} and to install the
22443 @code{spam.el} hooks. There is one exception: if you use the
22444 @code{spam-use-stat} (@pxref{spam-stat spam filtering}) setting, you
22445 should turn it on before @code{spam-initialize}:
22448 (setq spam-use-stat t) ;; if needed
22452 So, what happens when you load @file{spam.el}?
22454 First, some hooks will get installed by @code{spam-initialize}. There
22455 are some hooks for @code{spam-stat} so it can save its databases, and
22456 there are hooks so interesting things will happen when you enter and
22457 leave a group. More on the sequence of events later (@pxref{Spam
22458 ELisp Package Sequence of Events}).
22460 You get the following keyboard commands:
22470 @findex gnus-summary-mark-as-spam
22471 @code{gnus-summary-mark-as-spam}.
22473 Mark current article as spam, showing it with the @samp{$} mark.
22474 Whenever you see a spam article, make sure to mark its summary line
22475 with @kbd{M-d} before leaving the group. This is done automatically
22476 for unread articles in @emph{spam} groups.
22482 @findex spam-bogofilter-score
22483 @code{spam-bogofilter-score}.
22485 You must have Bogofilter installed for that command to work properly.
22491 Also, when you load @file{spam.el}, you will be able to customize its
22492 variables. Try @code{customize-group} on the @samp{spam} variable
22496 * Spam ELisp Package Sequence of Events::
22497 * Spam ELisp Package Filtering of Incoming Mail::
22498 * Spam ELisp Package Global Variables::
22499 * Spam ELisp Package Configuration Examples::
22500 * Blacklists and Whitelists::
22501 * BBDB Whitelists::
22502 * Gmane Spam Reporting::
22503 * Anti-spam Hashcash Payments::
22505 * Regular Expressions Header Matching::
22507 * ifile spam filtering::
22508 * spam-stat spam filtering::
22510 * Extending the Spam ELisp package::
22513 @node Spam ELisp Package Sequence of Events
22514 @subsubsection Spam ELisp Package Sequence of Events
22515 @cindex spam filtering
22516 @cindex spam filtering sequence of events
22519 You must read this section to understand how @code{spam.el} works.
22520 Do not skip, speed-read, or glance through this section.
22522 There are two @emph{contact points}, if you will, between
22523 @code{spam.el} and the rest of Gnus: checking new mail for spam, and
22526 Getting new mail is done in one of two ways. You can either split
22527 your incoming mail or you can classify new articles as ham or spam
22528 when you enter the group.
22530 Splitting incoming mail is better suited to mail backends such as
22531 @code{nnml} or @code{nnimap} where new mail appears in a single file
22532 called a @dfn{Spool File}. See @xref{Spam ELisp Package Filtering of
22535 For backends such as @code{nntp} there is no incoming mail spool, so
22536 an alternate mechanism must be used. This may also happen for
22537 backends where the server is in charge of splitting incoming mail, and
22538 Gnus does not do further splitting. The @code{spam-autodetect} and
22539 @code{spam-autodetect-methods} group parameters (accessible with
22540 @kbd{G c} and @kbd{G p} as usual), and the corresponding variables
22541 @code{gnus-spam-autodetect} and
22542 @code{gnus-spam-autodetect-methods} (accessible with @kbd{M-x
22543 customize-variable} as usual).
22545 When @code{spam-autodetect} is used, it hooks into the process of
22546 entering a group. Thus, entering a group with unseen or unread
22547 articles becomes the substitute for checking incoming mail. Whether
22548 only unseen articles or all unread articles will be processed is
22549 determined by the @code{spam-autodetect-recheck-messages}. When set
22550 to @code{t}, unread messages will be rechecked.
22552 @code{spam-autodetect} grants the user at once more and less control
22553 of spam filtering. The user will have more control over each group's
22554 spam methods, so for instance the @samp{ding} group may have
22555 @code{spam-use-BBDB} as the autodetection method, while the
22556 @samp{suspect} group may have the @code{spam-use-blacklist} and
22557 @code{spam-use-bogofilter} methods enabled. Every article detected to
22558 be spam will be marked with the spam mark @samp{$} and processed on
22559 exit from the group as normal spam. The user has less control over
22560 the @emph{sequence} of checks, as he might with @code{spam-split}.
22562 When the newly split mail goes into groups, or messages are
22563 autodetected to be ham or spam, those groups must be exited (after
22564 entering, if needed) for further spam processing to happen. It
22565 matters whether the group is considered a ham group, a spam group, or
22566 is unclassified, based on its @code{spam-content} parameter
22567 (@pxref{Spam ELisp Package Global Variables}). Spam groups have the
22568 additional characteristic that, when entered, any unseen or unread
22569 articles (depending on the @code{spam-mark-only-unseen-as-spam}
22570 variable) will be marked as spam. Thus, mail split into a spam group
22571 gets automatically marked as spam when you enter the group.
22573 So, when you exit a group, the @code{spam-processors} are applied, if
22574 any are set, and the processed mail is moved to the
22575 @code{ham-process-destination} or the @code{spam-process-destination}
22576 depending on the article's classification. If the
22577 @code{ham-process-destination} or the @code{spam-process-destination},
22578 whichever is appropriate, are @code{nil}, the article is left in the
22581 If a spam is found in any group (this can be changed to only non-spam
22582 groups with @code{spam-move-spam-nonspam-groups-only}), it is
22583 processed by the active @code{spam-processors} (@pxref{Spam ELisp
22584 Package Global Variables}) when the group is exited. Furthermore, the
22585 spam is moved to the @code{spam-process-destination} (@pxref{Spam
22586 ELisp Package Global Variables}) for further training or deletion.
22587 You have to load the @code{gnus-registry.el} package and enable the
22588 @code{spam-log-to-registry} variable if you want spam to be processed
22589 no more than once. Thus, spam is detected and processed everywhere,
22590 which is what most people want. If the
22591 @code{spam-process-destination} is @code{nil}, the spam is marked as
22592 expired, which is usually the right thing to do.
22594 If spam can not be moved---because of a read-only backend such as
22595 @acronym{NNTP}, for example, it will be copied.
22597 If a ham mail is found in a ham group, as determined by the
22598 @code{ham-marks} parameter, it is processed as ham by the active ham
22599 @code{spam-processor} when the group is exited. With the variables
22600 @code{spam-process-ham-in-spam-groups} and
22601 @code{spam-process-ham-in-nonham-groups} the behavior can be further
22602 altered so ham found anywhere can be processed. You have to load the
22603 @code{gnus-registry.el} package and enable the
22604 @code{spam-log-to-registry} variable if you want ham to be processed
22605 no more than once. Thus, ham is detected and processed only when
22606 necessary, which is what most people want. More on this in
22607 @xref{Spam ELisp Package Configuration Examples}.
22609 If ham can not be moved---because of a read-only backend such as
22610 @acronym{NNTP}, for example, it will be copied.
22612 If all this seems confusing, don't worry. Soon it will be as natural
22613 as typing Lisp one-liners on a neural interface@dots{} err, sorry, that's
22614 50 years in the future yet. Just trust us, it's not so bad.
22616 @node Spam ELisp Package Filtering of Incoming Mail
22617 @subsubsection Spam ELisp Package Filtering of Incoming Mail
22618 @cindex spam filtering
22619 @cindex spam filtering incoming mail
22622 To use the @file{spam.el} facilities for incoming mail filtering, you
22623 must add the following to your fancy split list
22624 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}:
22630 Note that the fancy split may be called @code{nnmail-split-fancy} or
22631 @code{nnimap-split-fancy}, depending on whether you use the nnmail or
22632 nnimap back ends to retrieve your mail.
22634 Also, @code{spam-split} will not modify incoming mail in any way.
22636 The @code{spam-split} function will process incoming mail and send the
22637 mail considered to be spam into the group name given by the variable
22638 @code{spam-split-group}. By default that group name is @samp{spam},
22639 but you can customize @code{spam-split-group}. Make sure the contents
22640 of @code{spam-split-group} are an @emph{unqualified} group name, for
22641 instance in an @code{nnimap} server @samp{your-server} the value
22642 @samp{spam} will turn out to be @samp{nnimap+your-server:spam}. The
22643 value @samp{nnimap+server:spam}, therefore, is wrong and will
22644 actually give you the group
22645 @samp{nnimap+your-server:nnimap+server:spam} which may or may not
22646 work depending on your server's tolerance for strange group names.
22648 You can also give @code{spam-split} a parameter,
22649 e.g. @code{spam-use-regex-headers} or @code{"maybe-spam"}. Why is
22652 Take these split rules (with @code{spam-use-regex-headers} and
22653 @code{spam-use-blackholes} set):
22656 nnimap-split-fancy '(|
22657 (any "ding" "ding")
22659 ;; @r{default mailbox}
22663 Now, the problem is that you want all ding messages to make it to the
22664 ding folder. But that will let obvious spam (for example, spam
22665 detected by SpamAssassin, and @code{spam-use-regex-headers}) through,
22666 when it's sent to the ding list. On the other hand, some messages to
22667 the ding list are from a mail server in the blackhole list, so the
22668 invocation of @code{spam-split} can't be before the ding rule.
22670 You can let SpamAssassin headers supersede ding rules, but all other
22671 @code{spam-split} rules (including a second invocation of the
22672 regex-headers check) will be after the ding rule:
22677 ;; @r{all spam detected by @code{spam-use-regex-headers} goes to @samp{regex-spam}}
22678 (: spam-split "regex-spam" 'spam-use-regex-headers)
22679 (any "ding" "ding")
22680 ;; @r{all other spam detected by spam-split goes to @code{spam-split-group}}
22682 ;; @r{default mailbox}
22686 This lets you invoke specific @code{spam-split} checks depending on
22687 your particular needs, and to target the results of those checks to a
22688 particular spam group. You don't have to throw all mail into all the
22689 spam tests. Another reason why this is nice is that messages to
22690 mailing lists you have rules for don't have to have resource-intensive
22691 blackhole checks performed on them. You could also specify different
22692 spam checks for your nnmail split vs. your nnimap split. Go crazy.
22694 You should still have specific checks such as
22695 @code{spam-use-regex-headers} set to @code{t}, even if you
22696 specifically invoke @code{spam-split} with the check. The reason is
22697 that when loading @file{spam.el}, some conditional loading is done
22698 depending on what @code{spam-use-xyz} variables you have set. This
22699 is usually not critical, though.
22701 @emph{Note for IMAP users}
22703 The boolean variable @code{nnimap-split-download-body} needs to be
22704 set, if you want to split based on the whole message instead of just
22705 the headers. By default, the nnimap back end will only retrieve the
22706 message headers. If you use @code{spam-check-bogofilter},
22707 @code{spam-check-ifile}, or @code{spam-check-stat} (the splitters that
22708 can benefit from the full message body), you should set this variable.
22709 It is not set by default because it will slow @acronym{IMAP} down, and
22710 that is not an appropriate decision to make on behalf of the user.
22712 @xref{Splitting in IMAP}.
22714 @emph{TODO: spam.el needs to provide a uniform way of training all the
22715 statistical databases. Some have that functionality built-in, others
22718 @node Spam ELisp Package Global Variables
22719 @subsubsection Spam ELisp Package Global Variables
22720 @cindex spam filtering
22721 @cindex spam filtering variables
22722 @cindex spam variables
22725 @vindex gnus-spam-process-newsgroups
22726 The concepts of ham processors and spam processors are very important.
22727 Ham processors and spam processors for a group can be set with the
22728 @code{spam-process} group parameter, or the
22729 @code{gnus-spam-process-newsgroups} variable. Ham processors take
22730 mail known to be non-spam (@emph{ham}) and process it in some way so
22731 that later similar mail will also be considered non-spam. Spam
22732 processors take mail known to be spam and process it so similar spam
22733 will be detected later.
22735 The format of the spam or ham processor entry used to be a symbol,
22736 but now it is a @sc{cons} cell. See the individual spam processor entries
22737 for more information.
22739 @vindex gnus-spam-newsgroup-contents
22740 Gnus learns from the spam you get. You have to collect your spam in
22741 one or more spam groups, and set or customize the variable
22742 @code{spam-junk-mailgroups} as appropriate. You can also declare
22743 groups to contain spam by setting their group parameter
22744 @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or
22745 by customizing the corresponding variable
22746 @code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group
22747 parameter and the @code{gnus-spam-newsgroup-contents} variable can
22748 also be used to declare groups as @emph{ham} groups if you set their
22749 classification to @code{gnus-group-spam-classification-ham}. If
22750 groups are not classified by means of @code{spam-junk-mailgroups},
22751 @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are
22752 considered @emph{unclassified}. All groups are unclassified by
22755 @vindex gnus-spam-mark
22757 In spam groups, all messages are considered to be spam by default:
22758 they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the
22759 group. If you have seen a message, had it marked as spam, then
22760 unmarked it, it won't be marked as spam when you enter the group
22761 thereafter. You can disable that behavior, so all unread messages
22762 will get the @samp{$} mark, if you set the
22763 @code{spam-mark-only-unseen-as-spam} parameter to @code{nil}. You
22764 should remove the @samp{$} mark when you are in the group summary
22765 buffer for every message that is not spam after all. To remove the
22766 @samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or
22767 @kbd{d} for declaring it read the non-spam way. When you leave a
22768 group, all spam-marked (@samp{$}) articles are sent to a spam
22769 processor which will study them as spam samples.
22771 Messages may also be deleted in various other ways, and unless
22772 @code{ham-marks} group parameter gets overridden below, marks @samp{R}
22773 and @samp{r} for default read or explicit delete, marks @samp{X} and
22774 @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for
22775 low scores, are all considered to be associated with articles which
22776 are not spam. This assumption might be false, in particular if you
22777 use kill files or score files as means for detecting genuine spam, you
22778 should then adjust the @code{ham-marks} group parameter.
22781 You can customize this group or topic parameter to be the list of
22782 marks you want to consider ham. By default, the list contains the
22783 deleted, read, killed, kill-filed, and low-score marks (the idea is
22784 that these articles have been read, but are not spam). It can be
22785 useful to also include the tick mark in the ham marks. It is not
22786 recommended to make the unread mark a ham mark, because it normally
22787 indicates a lack of classification. But you can do it, and we'll be
22792 You can customize this group or topic parameter to be the list of
22793 marks you want to consider spam. By default, the list contains only
22794 the spam mark. It is not recommended to change that, but you can if
22795 you really want to.
22798 When you leave @emph{any} group, regardless of its
22799 @code{spam-contents} classification, all spam-marked articles are sent
22800 to a spam processor, which will study these as spam samples. If you
22801 explicit kill a lot, you might sometimes end up with articles marked
22802 @samp{K} which you never saw, and which might accidentally contain
22803 spam. Best is to make sure that real spam is marked with @samp{$},
22806 @vindex gnus-ham-process-destinations
22807 When you leave a @emph{spam} group, all spam-marked articles are
22808 marked as expired after processing with the spam processor. This is
22809 not done for @emph{unclassified} or @emph{ham} groups. Also, any
22810 @strong{ham} articles in a spam group will be moved to a location
22811 determined by either the @code{ham-process-destination} group
22812 parameter or a match in the @code{gnus-ham-process-destinations}
22813 variable, which is a list of regular expressions matched with group
22814 names (it's easiest to customize this variable with @kbd{M-x
22815 customize-variable @key{RET} gnus-ham-process-destinations}). Each
22816 newsgroup specification has the format @code{(@var{regexp}
22817 @var{processor})} in a standard Lisp list, if you prefer to customize
22818 the variable manually. The ultimate location is a group name or
22819 names. If the @code{ham-process-destination} parameter is not set,
22820 ham articles are left in place. If the
22821 @code{spam-mark-ham-unread-before-move-from-spam-group} parameter is
22822 set, the ham articles are marked as unread before being moved.
22824 If ham can not be moved---because of a read-only backend such as
22825 @acronym{NNTP}, for example, it will be copied.
22827 Note that you can use multiples destinations per group or regular
22828 expression! This enables you to send your ham to a regular mail
22829 group and to a @emph{ham training} group.
22831 When you leave a @emph{ham} group, all ham-marked articles are sent to
22832 a ham processor, which will study these as non-spam samples.
22834 @vindex spam-process-ham-in-spam-groups
22835 By default the variable @code{spam-process-ham-in-spam-groups} is
22836 @code{nil}. Set it to @code{t} if you want ham found in spam groups
22837 to be processed. Normally this is not done, you are expected instead
22838 to send your ham to a ham group and process it there.
22840 @vindex spam-process-ham-in-nonham-groups
22841 By default the variable @code{spam-process-ham-in-nonham-groups} is
22842 @code{nil}. Set it to @code{t} if you want ham found in non-ham (spam
22843 or unclassified) groups to be processed. Normally this is not done,
22844 you are expected instead to send your ham to a ham group and process
22847 @vindex gnus-spam-process-destinations
22848 When you leave a @emph{ham} or @emph{unclassified} group, all
22849 @strong{spam} articles are moved to a location determined by either
22850 the @code{spam-process-destination} group parameter or a match in the
22851 @code{gnus-spam-process-destinations} variable, which is a list of
22852 regular expressions matched with group names (it's easiest to
22853 customize this variable with @kbd{M-x customize-variable @key{RET}
22854 gnus-spam-process-destinations}). Each newsgroup specification has
22855 the repeated format @code{(@var{regexp} @var{group})} and they are all
22856 in a standard Lisp list, if you prefer to customize the variable
22857 manually. The ultimate location is a group name or names. If the
22858 @code{spam-process-destination} parameter is not set, the spam
22859 articles are only expired. The group name is fully qualified, meaning
22860 that if you see @samp{nntp:servername} before the group name in the
22861 group buffer then you need it here as well.
22863 If spam can not be moved---because of a read-only backend such as
22864 @acronym{NNTP}, for example, it will be copied.
22866 Note that you can use multiples destinations per group or regular
22867 expression! This enables you to send your spam to multiple @emph{spam
22870 @vindex spam-log-to-registry
22871 The problem with processing ham and spam is that Gnus doesn't track
22872 this processing by default. Enable the @code{spam-log-to-registry}
22873 variable so @code{spam.el} will use @code{gnus-registry.el} to track
22874 what articles have been processed, and avoid processing articles
22875 multiple times. Keep in mind that if you limit the number of registry
22876 entries, this won't work as well as it does without a limit.
22878 @vindex spam-mark-only-unseen-as-spam
22879 Set this variable if you want only unseen articles in spam groups to
22880 be marked as spam. By default, it is set. If you set it to
22881 @code{nil}, unread articles will also be marked as spam.
22883 @vindex spam-mark-ham-unread-before-move-from-spam-group
22884 Set this variable if you want ham to be unmarked before it is moved
22885 out of the spam group. This is very useful when you use something
22886 like the tick mark @samp{!} to mark ham---the article will be placed
22887 in your @code{ham-process-destination}, unmarked as if it came fresh
22888 from the mail server.
22890 @vindex spam-autodetect-recheck-messages
22891 When autodetecting spam, this variable tells @code{spam.el} whether
22892 only unseen articles or all unread articles should be checked for
22893 spam. It is recommended that you leave it off.
22895 @node Spam ELisp Package Configuration Examples
22896 @subsubsection Spam ELisp Package Configuration Examples
22897 @cindex spam filtering
22898 @cindex spam filtering configuration examples
22899 @cindex spam configuration examples
22902 @subsubheading Ted's setup
22904 From Ted Zlatanov <tzz@@lifelogs.com>.
22906 ;; @r{for @code{gnus-registry-split-fancy-with-parent} and spam autodetection}
22907 ;; @r{see @file{gnus-registry.el} for more information}
22908 (gnus-registry-initialize)
22911 ;; @r{I like @kbd{C-s} for marking spam}
22912 (define-key gnus-summary-mode-map "\C-s" 'gnus-summary-mark-as-spam)
22915 spam-log-to-registry t ; @r{for spam autodetection}
22917 spam-use-regex-headers t ; @r{catch X-Spam-Flag (SpamAssassin)}
22918 ;; @r{all groups with @samp{spam} in the name contain spam}
22919 gnus-spam-newsgroup-contents
22920 '(("spam" gnus-group-spam-classification-spam))
22921 ;; @r{see documentation for these}
22922 spam-move-spam-nonspam-groups-only nil
22923 spam-mark-only-unseen-as-spam t
22924 spam-mark-ham-unread-before-move-from-spam-group t
22925 nnimap-split-rule 'nnimap-split-fancy
22926 ;; @r{understand what this does before you copy it to your own setup!}
22927 nnimap-split-fancy '(|
22928 ;; @r{trace references to parents and put in their group}
22929 (: gnus-registry-split-fancy-with-parent)
22930 ;; @r{this will catch server-side SpamAssassin tags}
22931 (: spam-split 'spam-use-regex-headers)
22932 (any "ding" "ding")
22933 ;; @r{note that spam by default will go to @samp{spam}}
22935 ;; @r{default mailbox}
22938 ;; @r{my parameters, set with @kbd{G p}}
22940 ;; @r{all nnml groups, and all nnimap groups except}
22941 ;; @r{@samp{nnimap+mail.lifelogs.com:train} and}
22942 ;; @r{@samp{nnimap+mail.lifelogs.com:spam}: any spam goes to nnimap training,}
22943 ;; @r{because it must have been detected manually}
22945 ((spam-process-destination . "nnimap+mail.lifelogs.com:train"))
22947 ;; @r{all @acronym{NNTP} groups}
22948 ;; @r{autodetect spam with the blacklist and ham with the BBDB}
22949 ((spam-autodetect-methods spam-use-blacklist spam-use-BBDB)
22950 ;; @r{send all spam to the training group}
22951 (spam-process-destination . "nnimap+mail.lifelogs.com:train"))
22953 ;; @r{only some @acronym{NNTP} groups, where I want to autodetect spam}
22954 ((spam-autodetect . t))
22956 ;; @r{my nnimap @samp{nnimap+mail.lifelogs.com:spam} group}
22958 ;; @r{this is a spam group}
22959 ((spam-contents gnus-group-spam-classification-spam)
22961 ;; @r{any spam (which happens when I enter for all unseen messages,}
22962 ;; @r{because of the @code{gnus-spam-newsgroup-contents} setting above), goes to}
22963 ;; @r{@samp{nnimap+mail.lifelogs.com:train} unless I mark it as ham}
22965 (spam-process-destination "nnimap+mail.lifelogs.com:train")
22967 ;; @r{any ham goes to my @samp{nnimap+mail.lifelogs.com:mail} folder, but}
22968 ;; @r{also to my @samp{nnimap+mail.lifelogs.com:trainham} folder for training}
22970 (ham-process-destination "nnimap+mail.lifelogs.com:mail"
22971 "nnimap+mail.lifelogs.com:trainham")
22972 ;; @r{in this group, only @samp{!} marks are ham}
22974 (gnus-ticked-mark))
22975 ;; @r{remembers senders in the blacklist on the way out---this is}
22976 ;; @r{definitely not needed, it just makes me feel better}
22977 (spam-process (gnus-group-spam-exit-processor-blacklist)))
22979 ;; @r{Later, on the @acronym{IMAP} server I use the @samp{train} group for training}
22980 ;; @r{SpamAssassin to recognize spam, and the @samp{trainham} group fora}
22981 ;; @r{recognizing ham---but Gnus has nothing to do with it.}
22985 @subsubheading Using @file{spam.el} on an IMAP server with a statistical filter on the server
22986 From Reiner Steib <reiner.steib@@gmx.de>.
22988 My provider has set up bogofilter (in combination with @acronym{DCC}) on
22989 the mail server (@acronym{IMAP}). Recognized spam goes to
22990 @samp{spam.detected}, the rest goes through the normal filter rules,
22991 i.e. to @samp{some.folder} or to @samp{INBOX}. Training on false
22992 positives or negatives is done by copying or moving the article to
22993 @samp{training.ham} or @samp{training.spam} respectively. A cron job on
22994 the server feeds those to bogofilter with the suitable ham or spam
22995 options and deletes them from the @samp{training.ham} and
22996 @samp{training.spam} folders.
22998 With the following entries in @code{gnus-parameters}, @code{spam.el}
22999 does most of the job for me:
23002 ("nnimap:spam\\.detected"
23003 (gnus-article-sort-functions '(gnus-article-sort-by-chars))
23004 (ham-process-destination "nnimap:INBOX" "nnimap:training.ham")
23005 (spam-contents gnus-group-spam-classification-spam))
23006 ("nnimap:\\(INBOX\\|other-folders\\)"
23007 (spam-process-destination . "nnimap:training.spam")
23008 (spam-contents gnus-group-spam-classification-ham))
23013 @item @b{The Spam folder:}
23015 In the folder @samp{spam.detected}, I have to check for false positives
23016 (i.e. legitimate mails, that were wrongly judged as spam by
23017 bogofilter or DCC).
23019 Because of the @code{gnus-group-spam-classification-spam} entry, all
23020 messages are marked as spam (with @code{$}). When I find a false
23021 positive, I mark the message with some other ham mark (@code{ham-marks},
23022 @ref{Spam ELisp Package Global Variables}). On group exit, those
23023 messages are copied to both groups, @samp{INBOX} (where I want to have
23024 the article) and @samp{training.ham} (for training bogofilter) and
23025 deleted from the @samp{spam.detected} folder.
23027 The @code{gnus-article-sort-by-chars} entry simplifies detection of
23028 false positives for me. I receive lots of worms (sweN, @dots{}), that all
23029 have a similar size. Grouping them by size (i.e. chars) makes finding
23030 other false positives easier. (Of course worms aren't @i{spam}
23031 (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is
23032 an excellent tool for filtering those unwanted mails for me.)
23034 @item @b{Ham folders:}
23036 In my ham folders, I just hit @kbd{S x}
23037 (@code{gnus-summary-mark-as-spam}) whenever I see an unrecognized spam
23038 mail (false negative). On group exit, those messages are moved to
23039 @samp{training.ham}.
23042 @subsubheading Reporting spam articles in Gmane groups with @code{spam-report.el}
23044 From Reiner Steib <reiner.steib@@gmx.de>.
23046 With following entry in @code{gnus-parameters}, @kbd{S x}
23047 (@code{gnus-summary-mark-as-spam}) marks articles in @code{gmane.*}
23048 groups as spam and reports the to Gmane at group exit:
23052 (spam-process (gnus-group-spam-exit-processor-report-gmane)))
23055 Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)}
23056 because I don't read the groups directly from news.gmane.org, but
23057 through my local news server (leafnode). I.e. the article numbers are
23058 not the same as on news.gmane.org, thus @code{spam-report.el} has to check
23059 the @code{X-Report-Spam} header to find the correct number.
23061 @node Blacklists and Whitelists
23062 @subsubsection Blacklists and Whitelists
23063 @cindex spam filtering
23064 @cindex whitelists, spam filtering
23065 @cindex blacklists, spam filtering
23068 @defvar spam-use-blacklist
23070 Set this variable to @code{t} if you want to use blacklists when
23071 splitting incoming mail. Messages whose senders are in the blacklist
23072 will be sent to the @code{spam-split-group}. This is an explicit
23073 filter, meaning that it acts only on mail senders @emph{declared} to
23078 @defvar spam-use-whitelist
23080 Set this variable to @code{t} if you want to use whitelists when
23081 splitting incoming mail. Messages whose senders are not in the
23082 whitelist will be sent to the next spam-split rule. This is an
23083 explicit filter, meaning that unless someone is in the whitelist, their
23084 messages are not assumed to be spam or ham.
23088 @defvar spam-use-whitelist-exclusive
23090 Set this variable to @code{t} if you want to use whitelists as an
23091 implicit filter, meaning that every message will be considered spam
23092 unless the sender is in the whitelist. Use with care.
23096 @defvar gnus-group-spam-exit-processor-blacklist
23098 Add this symbol to a group's @code{spam-process} parameter by
23099 customizing the group parameters or the
23100 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23101 added to a group's @code{spam-process} parameter, the senders of
23102 spam-marked articles will be added to the blacklist.
23106 Instead of the obsolete
23107 @code{gnus-group-spam-exit-processor-blacklist}, it is recommended
23108 that you use @code{'(spam spam-use-blacklist)}. Everything will work
23109 the same way, we promise.
23113 @defvar gnus-group-ham-exit-processor-whitelist
23115 Add this symbol to a group's @code{spam-process} parameter by
23116 customizing the group parameters or the
23117 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23118 added to a group's @code{spam-process} parameter, the senders of
23119 ham-marked articles in @emph{ham} groups will be added to the
23120 whitelist. Note that this ham processor has no effect in @emph{spam}
23121 or @emph{unclassified} groups.
23125 Instead of the obsolete
23126 @code{gnus-group-ham-exit-processor-whitelist}, it is recommended
23127 that you use @code{'(ham spam-use-whitelist)}. Everything will work
23128 the same way, we promise.
23132 Blacklists are lists of regular expressions matching addresses you
23133 consider to be spam senders. For instance, to block mail from any
23134 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
23135 blacklist. You start out with an empty blacklist. Blacklist entries
23136 use the Emacs regular expression syntax.
23138 Conversely, whitelists tell Gnus what addresses are considered
23139 legitimate. All messages from whitelisted addresses are considered
23140 non-spam. Also see @ref{BBDB Whitelists}. Whitelist entries use the
23141 Emacs regular expression syntax.
23143 The blacklist and whitelist file locations can be customized with the
23144 @code{spam-directory} variable (@file{~/News/spam} by default), or
23145 the @code{spam-whitelist} and @code{spam-blacklist} variables
23146 directly. The whitelist and blacklist files will by default be in the
23147 @code{spam-directory} directory, named @file{whitelist} and
23148 @file{blacklist} respectively.
23150 @node BBDB Whitelists
23151 @subsubsection BBDB Whitelists
23152 @cindex spam filtering
23153 @cindex BBDB whitelists, spam filtering
23154 @cindex BBDB, spam filtering
23157 @defvar spam-use-BBDB
23159 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
23160 Whitelists}), but uses the BBDB as the source of whitelisted
23161 addresses, without regular expressions. You must have the BBDB loaded
23162 for @code{spam-use-BBDB} to work properly. Messages whose senders are
23163 not in the BBDB will be sent to the next spam-split rule. This is an
23164 explicit filter, meaning that unless someone is in the BBDB, their
23165 messages are not assumed to be spam or ham.
23169 @defvar spam-use-BBDB-exclusive
23171 Set this variable to @code{t} if you want to use the BBDB as an
23172 implicit filter, meaning that every message will be considered spam
23173 unless the sender is in the BBDB. Use with care. Only sender
23174 addresses in the BBDB will be allowed through; all others will be
23175 classified as spammers.
23179 @defvar gnus-group-ham-exit-processor-BBDB
23181 Add this symbol to a group's @code{spam-process} parameter by
23182 customizing the group parameters or the
23183 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23184 added to a group's @code{spam-process} parameter, the senders of
23185 ham-marked articles in @emph{ham} groups will be added to the
23186 BBDB. Note that this ham processor has no effect in @emph{spam}
23187 or @emph{unclassified} groups.
23191 Instead of the obsolete
23192 @code{gnus-group-ham-exit-processor-BBDB}, it is recommended
23193 that you use @code{'(ham spam-use-BBDB)}. Everything will work
23194 the same way, we promise.
23198 @node Gmane Spam Reporting
23199 @subsubsection Gmane Spam Reporting
23200 @cindex spam reporting
23201 @cindex Gmane, spam reporting
23202 @cindex Gmane, spam reporting
23205 @defvar gnus-group-spam-exit-processor-report-gmane
23207 Add this symbol to a group's @code{spam-process} parameter by
23208 customizing the group parameters or the
23209 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23210 added to a group's @code{spam-process} parameter, the spam-marked
23211 articles groups will be reported to the Gmane administrators via a
23214 Gmane can be found at @uref{http://gmane.org}.
23218 Instead of the obsolete
23219 @code{gnus-group-spam-exit-processor-report-gmane}, it is recommended
23220 that you use @code{'(spam spam-use-gmane)}. Everything will work the
23221 same way, we promise.
23225 @defvar spam-report-gmane-use-article-number
23227 This variable is @code{t} by default. Set it to @code{nil} if you are
23228 running your own news server, for instance, and the local article
23229 numbers don't correspond to the Gmane article numbers. When
23230 @code{spam-report-gmane-use-article-number} is @code{nil},
23231 @code{spam-report.el} will use the @code{X-Report-Spam} header that
23236 @node Anti-spam Hashcash Payments
23237 @subsubsection Anti-spam Hashcash Payments
23238 @cindex spam filtering
23239 @cindex hashcash, spam filtering
23242 @defvar spam-use-hashcash
23244 Similar to @code{spam-use-whitelist} (@pxref{Blacklists and
23245 Whitelists}), but uses hashcash tokens for whitelisting messages
23246 instead of the sender address. You must have the @code{hashcash.el}
23247 package loaded for @code{spam-use-hashcash} to work properly.
23248 Messages without a hashcash payment token will be sent to the next
23249 spam-split rule. This is an explicit filter, meaning that unless a
23250 hashcash token is found, the messages are not assumed to be spam or
23256 @subsubsection Blackholes
23257 @cindex spam filtering
23258 @cindex blackholes, spam filtering
23261 @defvar spam-use-blackholes
23263 This option is disabled by default. You can let Gnus consult the
23264 blackhole-type distributed spam processing systems (DCC, for instance)
23265 when you set this option. The variable @code{spam-blackhole-servers}
23266 holds the list of blackhole servers Gnus will consult. The current
23267 list is fairly comprehensive, but make sure to let us know if it
23268 contains outdated servers.
23270 The blackhole check uses the @code{dig.el} package, but you can tell
23271 @file{spam.el} to use @code{dns.el} instead for better performance if
23272 you set @code{spam-use-dig} to @code{nil}. It is not recommended at
23273 this time to set @code{spam-use-dig} to @code{nil} despite the
23274 possible performance improvements, because some users may be unable to
23275 use it, but you can try it and see if it works for you.
23279 @defvar spam-blackhole-servers
23281 The list of servers to consult for blackhole checks.
23285 @defvar spam-blackhole-good-server-regex
23287 A regular expression for IPs that should not be checked against the
23288 blackhole server list. When set to @code{nil}, it has no effect.
23292 @defvar spam-use-dig
23294 Use the @code{dig.el} package instead of the @code{dns.el} package.
23295 The default setting of @code{t} is recommended.
23299 Blackhole checks are done only on incoming mail. There is no spam or
23300 ham processor for blackholes.
23302 @node Regular Expressions Header Matching
23303 @subsubsection Regular Expressions Header Matching
23304 @cindex spam filtering
23305 @cindex regular expressions header matching, spam filtering
23308 @defvar spam-use-regex-headers
23310 This option is disabled by default. You can let Gnus check the
23311 message headers against lists of regular expressions when you set this
23312 option. The variables @code{spam-regex-headers-spam} and
23313 @code{spam-regex-headers-ham} hold the list of regular expressions.
23314 Gnus will check against the message headers to determine if the
23315 message is spam or ham, respectively.
23319 @defvar spam-regex-headers-spam
23321 The list of regular expressions that, when matched in the headers of
23322 the message, positively identify it as spam.
23326 @defvar spam-regex-headers-ham
23328 The list of regular expressions that, when matched in the headers of
23329 the message, positively identify it as ham.
23333 Regular expression header checks are done only on incoming mail.
23334 There is no specific spam or ham processor for regular expressions.
23337 @subsubsection Bogofilter
23338 @cindex spam filtering
23339 @cindex bogofilter, spam filtering
23342 @defvar spam-use-bogofilter
23344 Set this variable if you want @code{spam-split} to use Eric Raymond's
23347 With a minimum of care for associating the @samp{$} mark for spam
23348 articles only, Bogofilter training all gets fairly automatic. You
23349 should do this until you get a few hundreds of articles in each
23350 category, spam or not. The command @kbd{S t} in summary mode, either
23351 for debugging or for curiosity, shows the @emph{spamicity} score of
23352 the current article (between 0.0 and 1.0).
23354 Bogofilter determines if a message is spam based on a specific
23355 threshold. That threshold can be customized, consult the Bogofilter
23358 If the @code{bogofilter} executable is not in your path, Bogofilter
23359 processing will be turned off.
23361 You should not enable this if you use @code{spam-use-bogofilter-headers}.
23365 @defvar spam-use-bogofilter-headers
23367 Set this variable if you want @code{spam-split} to use Eric Raymond's
23368 speedy Bogofilter, looking only at the message headers. It works
23369 similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header
23370 must be in the message already. Normally you would do this with a
23371 procmail recipe or something similar; consult the Bogofilter
23372 installation documents for details.
23374 You should not enable this if you use @code{spam-use-bogofilter}.
23378 @defvar gnus-group-spam-exit-processor-bogofilter
23379 Add this symbol to a group's @code{spam-process} parameter by
23380 customizing the group parameters or the
23381 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23382 added to a group's @code{spam-process} parameter, spam-marked articles
23383 will be added to the Bogofilter spam database.
23387 Instead of the obsolete
23388 @code{gnus-group-spam-exit-processor-bogofilter}, it is recommended
23389 that you use @code{'(spam spam-use-bogofilter)}. Everything will work
23390 the same way, we promise.
23393 @defvar gnus-group-ham-exit-processor-bogofilter
23394 Add this symbol to a group's @code{spam-process} parameter by
23395 customizing the group parameters or the
23396 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23397 added to a group's @code{spam-process} parameter, the ham-marked
23398 articles in @emph{ham} groups will be added to the Bogofilter database
23399 of non-spam messages. Note that this ham processor has no effect in
23400 @emph{spam} or @emph{unclassified} groups.
23404 Instead of the obsolete
23405 @code{gnus-group-ham-exit-processor-bogofilter}, it is recommended
23406 that you use @code{'(ham spam-use-bogofilter)}. Everything will work
23407 the same way, we promise.
23410 @defvar spam-bogofilter-database-directory
23412 This is the directory where Bogofilter will store its databases. It
23413 is not specified by default, so Bogofilter will use its own default
23414 database directory.
23418 The Bogofilter mail classifier is similar to @command{ifile} in intent and
23419 purpose. A ham and a spam processor are provided, plus the
23420 @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers}
23421 variables to indicate to spam-split that Bogofilter should either be
23422 used, or has already been used on the article. The 0.9.2.1 version of
23423 Bogofilter was used to test this functionality.
23425 @node ifile spam filtering
23426 @subsubsection ifile spam filtering
23427 @cindex spam filtering
23428 @cindex ifile, spam filtering
23431 @defvar spam-use-ifile
23433 Enable this variable if you want @code{spam-split} to use @command{ifile}, a
23434 statistical analyzer similar to Bogofilter.
23438 @defvar spam-ifile-all-categories
23440 Enable this variable if you want @code{spam-use-ifile} to give you all
23441 the ifile categories, not just spam/non-spam. If you use this, make
23442 sure you train ifile as described in its documentation.
23446 @defvar spam-ifile-spam-category
23448 This is the category of spam messages as far as ifile is concerned.
23449 The actual string used is irrelevant, but you probably want to leave
23450 the default value of @samp{spam}.
23453 @defvar spam-ifile-database-path
23455 This is the filename for the ifile database. It is not specified by
23456 default, so ifile will use its own default database name.
23460 The ifile mail classifier is similar to Bogofilter in intent and
23461 purpose. A ham and a spam processor are provided, plus the
23462 @code{spam-use-ifile} variable to indicate to spam-split that ifile
23463 should be used. The 1.2.1 version of ifile was used to test this
23466 @node spam-stat spam filtering
23467 @subsubsection spam-stat spam filtering
23468 @cindex spam filtering
23469 @cindex spam-stat, spam filtering
23473 @xref{Filtering Spam Using Statistics with spam-stat}.
23475 @defvar spam-use-stat
23477 Enable this variable if you want @code{spam-split} to use
23478 spam-stat.el, an Emacs Lisp statistical analyzer.
23482 @defvar gnus-group-spam-exit-processor-stat
23483 Add this symbol to a group's @code{spam-process} parameter by
23484 customizing the group parameters or the
23485 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23486 added to a group's @code{spam-process} parameter, the spam-marked
23487 articles will be added to the spam-stat database of spam messages.
23491 Instead of the obsolete
23492 @code{gnus-group-spam-exit-processor-stat}, it is recommended
23493 that you use @code{'(spam spam-use-stat)}. Everything will work
23494 the same way, we promise.
23497 @defvar gnus-group-ham-exit-processor-stat
23498 Add this symbol to a group's @code{spam-process} parameter by
23499 customizing the group parameters or the
23500 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23501 added to a group's @code{spam-process} parameter, the ham-marked
23502 articles in @emph{ham} groups will be added to the spam-stat database
23503 of non-spam messages. Note that this ham processor has no effect in
23504 @emph{spam} or @emph{unclassified} groups.
23508 Instead of the obsolete
23509 @code{gnus-group-ham-exit-processor-stat}, it is recommended
23510 that you use @code{'(ham spam-use-stat)}. Everything will work
23511 the same way, we promise.
23514 This enables @file{spam.el} to cooperate with @file{spam-stat.el}.
23515 @file{spam-stat.el} provides an internal (Lisp-only) spam database,
23516 which unlike ifile or Bogofilter does not require external programs.
23517 A spam and a ham processor, and the @code{spam-use-stat} variable for
23518 @code{spam-split} are provided.
23521 @subsubsection Using SpamOracle with Gnus
23522 @cindex spam filtering
23526 An easy way to filter out spam is to use SpamOracle. SpamOracle is an
23527 statistical mail filtering tool written by Xavier Leroy and needs to be
23528 installed separately.
23530 There are several ways to use SpamOracle with Gnus. In all cases, your
23531 mail is piped through SpamOracle in its @emph{mark} mode. SpamOracle will
23532 then enter an @samp{X-Spam} header indicating whether it regards the
23533 mail as a spam mail or not.
23535 One possibility is to run SpamOracle as a @code{:prescript} from the
23536 @xref{Mail Source Specifiers}, (@pxref{SpamAssassin}). This method has
23537 the advantage that the user can see the @emph{X-Spam} headers.
23539 The easiest method is to make @file{spam.el} (@pxref{Filtering Spam
23540 Using The Spam ELisp Package}) call SpamOracle.
23542 @vindex spam-use-spamoracle
23543 To enable SpamOracle usage by @file{spam.el}, set the variable
23544 @code{spam-use-spamoracle} to @code{t} and configure the
23545 @code{nnmail-split-fancy} or @code{nnimap-split-fancy} as described in
23546 the section @xref{Filtering Spam Using The Spam ELisp Package}. In
23547 this example the @samp{INBOX} of an nnimap server is filtered using
23548 SpamOracle. Mails recognized as spam mails will be moved to
23549 @code{spam-split-group}, @samp{Junk} in this case. Ham messages stay
23553 (setq spam-use-spamoracle t
23554 spam-split-group "Junk"
23555 nnimap-split-inbox '("INBOX")
23556 nnimap-split-rule 'nnimap-split-fancy
23557 nnimap-split-fancy '(| (: spam-split) "INBOX"))
23560 @defvar spam-use-spamoracle
23561 Set to @code{t} if you want Gnus to enable spam filtering using
23565 @defvar spam-spamoracle-binary
23566 Gnus uses the SpamOracle binary called @file{spamoracle} found in the
23567 user's PATH. Using the variable @code{spam-spamoracle-binary}, this
23571 @defvar spam-spamoracle-database
23572 By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to
23573 store its analyses. This is controlled by the variable
23574 @code{spam-spamoracle-database} which defaults to @code{nil}. That means
23575 the default SpamOracle database will be used. In case you want your
23576 database to live somewhere special, set
23577 @code{spam-spamoracle-database} to this path.
23580 SpamOracle employs a statistical algorithm to determine whether a
23581 message is spam or ham. In order to get good results, meaning few
23582 false hits or misses, SpamOracle needs training. SpamOracle learns the
23583 characteristics of your spam mails. Using the @emph{add} mode
23584 (training mode) one has to feed good (ham) and spam mails to
23585 SpamOracle. This can be done by pressing @kbd{|} in the Summary buffer
23586 and pipe the mail to a SpamOracle process or using @file{spam.el}'s
23587 spam- and ham-processors, which is much more convenient. For a
23588 detailed description of spam- and ham-processors, @xref{Filtering Spam
23589 Using The Spam ELisp Package}.
23591 @defvar gnus-group-spam-exit-processor-spamoracle
23592 Add this symbol to a group's @code{spam-process} parameter by
23593 customizing the group parameter or the
23594 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
23595 to a group's @code{spam-process} parameter, spam-marked articles will be
23596 sent to SpamOracle as spam samples.
23600 Instead of the obsolete
23601 @code{gnus-group-spam-exit-processor-spamoracle}, it is recommended
23602 that you use @code{'(spam spam-use-spamoracle)}. Everything will work
23603 the same way, we promise.
23606 @defvar gnus-group-ham-exit-processor-spamoracle
23607 Add this symbol to a group's @code{spam-process} parameter by
23608 customizing the group parameter or the
23609 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
23610 to a group's @code{spam-process} parameter, the ham-marked articles in
23611 @emph{ham} groups will be sent to the SpamOracle as samples of ham
23612 messages. Note that this ham processor has no effect in @emph{spam} or
23613 @emph{unclassified} groups.
23617 Instead of the obsolete
23618 @code{gnus-group-ham-exit-processor-spamoracle}, it is recommended
23619 that you use @code{'(ham spam-use-spamoracle)}. Everything will work
23620 the same way, we promise.
23623 @emph{Example:} These are the Group Parameters of a group that has been
23624 classified as a ham group, meaning that it should only contain ham
23627 ((spam-contents gnus-group-spam-classification-ham)
23628 (spam-process ((ham spam-use-spamoracle)
23629 (spam spam-use-spamoracle))))
23631 For this group the @code{spam-use-spamoracle} is installed for both
23632 ham and spam processing. If the group contains spam message
23633 (e.g. because SpamOracle has not had enough sample messages yet) and
23634 the user marks some messages as spam messages, these messages will be
23635 processed by SpamOracle. The processor sends the messages to
23636 SpamOracle as new samples for spam.
23638 @node Extending the Spam ELisp package
23639 @subsubsection Extending the Spam ELisp package
23640 @cindex spam filtering
23641 @cindex spam elisp package, extending
23642 @cindex extending the spam elisp package
23644 Say you want to add a new back end called blackbox. For filtering
23645 incoming mail, provide the following:
23653 (defvar spam-use-blackbox nil
23654 "True if blackbox should be used.")
23659 (spam-use-blackbox . spam-check-blackbox)
23661 to @code{spam-list-of-checks}.
23665 (gnus-group-ham-exit-processor-blackbox ham spam-use-blackbox)
23666 (gnus-group-spam-exit-processor-blackbox spam spam-use-blackbox)
23669 to @code{spam-list-of-processors}.
23673 (spam-use-blackbox spam-blackbox-register-routine
23675 spam-blackbox-unregister-routine
23679 to @code{spam-registration-functions}. Write the register/unregister
23680 routines using the bogofilter register/unregister routines as a
23681 start, or other restister/unregister routines more appropriate to
23687 Write the @code{spam-check-blackbox} function. It should return
23688 @samp{nil} or @code{spam-split-group}, observing the other
23689 conventions. See the existing @code{spam-check-*} functions for
23690 examples of what you can do, and stick to the template unless you
23691 fully understand the reasons why you aren't.
23693 Make sure to add @code{spam-use-blackbox} to
23694 @code{spam-list-of-statistical-checks} if Blackbox is a statistical
23695 mail analyzer that needs the full message body to operate.
23699 For processing spam and ham messages, provide the following:
23706 Note you don't have to provide a spam or a ham processor. Only
23707 provide them if Blackbox supports spam or ham processing.
23709 Also, ham and spam processors are being phased out as single
23710 variables. Instead the form @code{'(spam spam-use-blackbox)} or
23711 @code{'(ham spam-use-blackbox)} is favored. For now, spam/ham
23712 processor variables are still around but they won't be for long.
23715 (defvar gnus-group-spam-exit-processor-blackbox "blackbox-spam"
23716 "The Blackbox summary exit spam processor.
23717 Only applicable to spam groups.")
23719 (defvar gnus-group-ham-exit-processor-blackbox "blackbox-ham"
23720 "The whitelist summary exit ham processor.
23721 Only applicable to non-spam (unclassified and ham) groups.")
23730 (const :tag "Spam: Blackbox" (spam spam-use-blackbox))
23731 (const :tag "Ham: Blackbox" (ham spam-use-blackbox))
23733 to the @code{spam-process} group parameter in @code{gnus.el}. Make
23734 sure you do it twice, once for the parameter and once for the
23735 variable customization.
23739 (variable-item spam-use-blackbox)
23741 to the @code{spam-autodetect-methods} group parameter in
23747 @node Filtering Spam Using Statistics with spam-stat
23748 @subsection Filtering Spam Using Statistics with spam-stat
23749 @cindex Paul Graham
23750 @cindex Graham, Paul
23751 @cindex naive Bayesian spam filtering
23752 @cindex Bayesian spam filtering, naive
23753 @cindex spam filtering, naive Bayesian
23755 Paul Graham has written an excellent essay about spam filtering using
23756 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
23757 Spam}. In it he describes the inherent deficiency of rule-based
23758 filtering as used by SpamAssassin, for example: Somebody has to write
23759 the rules, and everybody else has to install these rules. You are
23760 always late. It would be much better, he argues, to filter mail based
23761 on whether it somehow resembles spam or non-spam. One way to measure
23762 this is word distribution. He then goes on to describe a solution
23763 that checks whether a new mail resembles any of your other spam mails
23766 The basic idea is this: Create a two collections of your mail, one
23767 with spam, one with non-spam. Count how often each word appears in
23768 either collection, weight this by the total number of mails in the
23769 collections, and store this information in a dictionary. For every
23770 word in a new mail, determine its probability to belong to a spam or a
23771 non-spam mail. Use the 15 most conspicuous words, compute the total
23772 probability of the mail being spam. If this probability is higher
23773 than a certain threshold, the mail is considered to be spam.
23775 Gnus supports this kind of filtering. But it needs some setting up.
23776 First, you need two collections of your mail, one with spam, one with
23777 non-spam. Then you need to create a dictionary using these two
23778 collections, and save it. And last but not least, you need to use
23779 this dictionary in your fancy mail splitting rules.
23782 * Creating a spam-stat dictionary::
23783 * Splitting mail using spam-stat::
23784 * Low-level interface to the spam-stat dictionary::
23787 @node Creating a spam-stat dictionary
23788 @subsubsection Creating a spam-stat dictionary
23790 Before you can begin to filter spam based on statistics, you must
23791 create these statistics based on two mail collections, one with spam,
23792 one with non-spam. These statistics are then stored in a dictionary
23793 for later use. In order for these statistics to be meaningful, you
23794 need several hundred emails in both collections.
23796 Gnus currently supports only the nnml back end for automated dictionary
23797 creation. The nnml back end stores all mails in a directory, one file
23798 per mail. Use the following:
23800 @defun spam-stat-process-spam-directory
23801 Create spam statistics for every file in this directory. Every file
23802 is treated as one spam mail.
23805 @defun spam-stat-process-non-spam-directory
23806 Create non-spam statistics for every file in this directory. Every
23807 file is treated as one non-spam mail.
23810 Usually you would call @code{spam-stat-process-spam-directory} on a
23811 directory such as @file{~/Mail/mail/spam} (this usually corresponds
23812 the the group @samp{nnml:mail.spam}), and you would call
23813 @code{spam-stat-process-non-spam-directory} on a directory such as
23814 @file{~/Mail/mail/misc} (this usually corresponds the the group
23815 @samp{nnml:mail.misc}).
23817 When you are using @acronym{IMAP}, you won't have the mails available
23818 locally, so that will not work. One solution is to use the Gnus Agent
23819 to cache the articles. Then you can use directories such as
23820 @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for
23821 @code{spam-stat-process-spam-directory}. @xref{Agent as Cache}.
23824 This variable holds the hash-table with all the statistics---the
23825 dictionary we have been talking about. For every word in either
23826 collection, this hash-table stores a vector describing how often the
23827 word appeared in spam and often it appeared in non-spam mails.
23830 If you want to regenerate the statistics from scratch, you need to
23831 reset the dictionary.
23833 @defun spam-stat-reset
23834 Reset the @code{spam-stat} hash-table, deleting all the statistics.
23837 When you are done, you must save the dictionary. The dictionary may
23838 be rather large. If you will not update the dictionary incrementally
23839 (instead, you will recreate it once a month, for example), then you
23840 can reduce the size of the dictionary by deleting all words that did
23841 not appear often enough or that do not clearly belong to only spam or
23842 only non-spam mails.
23844 @defun spam-stat-reduce-size
23845 Reduce the size of the dictionary. Use this only if you do not want
23846 to update the dictionary incrementally.
23849 @defun spam-stat-save
23850 Save the dictionary.
23853 @defvar spam-stat-file
23854 The filename used to store the dictionary. This defaults to
23855 @file{~/.spam-stat.el}.
23858 @node Splitting mail using spam-stat
23859 @subsubsection Splitting mail using spam-stat
23861 In order to use @code{spam-stat} to split your mail, you need to add the
23862 following to your @file{~/.gnus.el} file:
23865 (require 'spam-stat)
23869 This will load the necessary Gnus code, and the dictionary you
23872 Next, you need to adapt your fancy splitting rules: You need to
23873 determine how to use @code{spam-stat}. The following examples are for
23874 the nnml back end. Using the nnimap back end works just as well. Just
23875 use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}.
23877 In the simplest case, you only have two groups, @samp{mail.misc} and
23878 @samp{mail.spam}. The following expression says that mail is either
23879 spam or it should go into @samp{mail.misc}. If it is spam, then
23880 @code{spam-stat-split-fancy} will return @samp{mail.spam}.
23883 (setq nnmail-split-fancy
23884 `(| (: spam-stat-split-fancy)
23888 @defvar spam-stat-split-fancy-spam-group
23889 The group to use for spam. Default is @samp{mail.spam}.
23892 If you also filter mail with specific subjects into other groups, use
23893 the following expression. Only mails not matching the regular
23894 expression are considered potential spam.
23897 (setq nnmail-split-fancy
23898 `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
23899 (: spam-stat-split-fancy)
23903 If you want to filter for spam first, then you must be careful when
23904 creating the dictionary. Note that @code{spam-stat-split-fancy} must
23905 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
23906 non-spam, therefore both should be in your collection of non-spam
23907 mails, when creating the dictionary!
23910 (setq nnmail-split-fancy
23911 `(| (: spam-stat-split-fancy)
23912 ("Subject" "\\bspam-stat\\b" "mail.emacs")
23916 You can combine this with traditional filtering. Here, we move all
23917 HTML-only mails into the @samp{mail.spam.filtered} group. Note that since
23918 @code{spam-stat-split-fancy} will never see them, the mails in
23919 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
23920 nor in your collection of non-spam mails, when creating the
23924 (setq nnmail-split-fancy
23925 `(| ("Content-Type" "text/html" "mail.spam.filtered")
23926 (: spam-stat-split-fancy)
23927 ("Subject" "\\bspam-stat\\b" "mail.emacs")
23932 @node Low-level interface to the spam-stat dictionary
23933 @subsubsection Low-level interface to the spam-stat dictionary
23935 The main interface to using @code{spam-stat}, are the following functions:
23937 @defun spam-stat-buffer-is-spam
23938 Called in a buffer, that buffer is considered to be a new spam mail.
23939 Use this for new mail that has not been processed before.
23942 @defun spam-stat-buffer-is-no-spam
23943 Called in a buffer, that buffer is considered to be a new non-spam
23944 mail. Use this for new mail that has not been processed before.
23947 @defun spam-stat-buffer-change-to-spam
23948 Called in a buffer, that buffer is no longer considered to be normal
23949 mail but spam. Use this to change the status of a mail that has
23950 already been processed as non-spam.
23953 @defun spam-stat-buffer-change-to-non-spam
23954 Called in a buffer, that buffer is no longer considered to be spam but
23955 normal mail. Use this to change the status of a mail that has already
23956 been processed as spam.
23959 @defun spam-stat-save
23960 Save the hash table to the file. The filename used is stored in the
23961 variable @code{spam-stat-file}.
23964 @defun spam-stat-load
23965 Load the hash table from a file. The filename used is stored in the
23966 variable @code{spam-stat-file}.
23969 @defun spam-stat-score-word
23970 Return the spam score for a word.
23973 @defun spam-stat-score-buffer
23974 Return the spam score for a buffer.
23977 @defun spam-stat-split-fancy
23978 Use this function for fancy mail splitting. Add the rule @samp{(:
23979 spam-stat-split-fancy)} to @code{nnmail-split-fancy}
23982 Make sure you load the dictionary before using it. This requires the
23983 following in your @file{~/.gnus.el} file:
23986 (require 'spam-stat)
23990 Typical test will involve calls to the following functions:
23993 Reset: (setq spam-stat (make-hash-table :test 'equal))
23994 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
23995 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
23996 Save table: (spam-stat-save)
23997 File size: (nth 7 (file-attributes spam-stat-file))
23998 Number of words: (hash-table-count spam-stat)
23999 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
24000 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
24001 Reduce table size: (spam-stat-reduce-size)
24002 Save table: (spam-stat-save)
24003 File size: (nth 7 (file-attributes spam-stat-file))
24004 Number of words: (hash-table-count spam-stat)
24005 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
24006 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
24009 Here is how you would create your dictionary:
24012 Reset: (setq spam-stat (make-hash-table :test 'equal))
24013 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
24014 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
24015 Repeat for any other non-spam group you need...
24016 Reduce table size: (spam-stat-reduce-size)
24017 Save table: (spam-stat-save)
24021 @section Interaction with other modes
24026 @code{gnus-dired-minor-mode} provided some useful functions for dired
24027 buffers. It is enabled with
24029 (add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode)
24034 @findex gnus-dired-attach
24035 Send dired's marked files as an attachment (@code{gnus-dired-attach}).
24036 You will be prompted for a message buffer.
24039 @findex gnus-dired-find-file-mailcap
24040 Visit a file according to the appropriate mailcap entry
24041 (@code{gnus-dired-find-file-mailcap}). With prefix, open file in a new
24045 @findex gnus-dired-print
24046 Print file according to the mailcap entry (@code{gnus-dired-print}). If
24047 there is no print command, print in a PostScript image.
24050 @node Various Various
24051 @section Various Various
24057 @item gnus-home-directory
24058 @vindex gnus-home-directory
24059 All Gnus file and directory variables will be initialized from this
24060 variable, which defaults to @file{~/}.
24062 @item gnus-directory
24063 @vindex gnus-directory
24064 Most Gnus storage file and directory variables will be initialized from
24065 this variable, which defaults to the @env{SAVEDIR} environment
24066 variable, or @file{~/News/} if that variable isn't set.
24068 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
24069 This means that other directory variables that are initialized from this
24070 variable won't be set properly if you set this variable in
24071 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
24073 @item gnus-default-directory
24074 @vindex gnus-default-directory
24075 Not related to the above variable at all---this variable says what the
24076 default directory of all Gnus buffers should be. If you issue commands
24077 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
24078 default directory. If this variable is @code{nil} (which is the
24079 default), the default directory will be the default directory of the
24080 buffer you were in when you started Gnus.
24083 @vindex gnus-verbose
24084 This variable is an integer between zero and ten. The higher the value,
24085 the more messages will be displayed. If this variable is zero, Gnus
24086 will never flash any messages, if it is seven (which is the default),
24087 most important messages will be shown, and if it is ten, Gnus won't ever
24088 shut up, but will flash so many messages it will make your head swim.
24090 @item gnus-verbose-backends
24091 @vindex gnus-verbose-backends
24092 This variable works the same way as @code{gnus-verbose}, but it applies
24093 to the Gnus back ends instead of Gnus proper.
24095 @item nnheader-max-head-length
24096 @vindex nnheader-max-head-length
24097 When the back ends read straight heads of articles, they all try to read
24098 as little as possible. This variable (default 4096) specifies
24099 the absolute max length the back ends will try to read before giving up
24100 on finding a separator line between the head and the body. If this
24101 variable is @code{nil}, there is no upper read bound. If it is
24102 @code{t}, the back ends won't try to read the articles piece by piece,
24103 but read the entire articles. This makes sense with some versions of
24104 @code{ange-ftp} or @code{efs}.
24106 @item nnheader-head-chop-length
24107 @vindex nnheader-head-chop-length
24108 This variable (default 2048) says how big a piece of each article to
24109 read when doing the operation described above.
24111 @item nnheader-file-name-translation-alist
24112 @vindex nnheader-file-name-translation-alist
24114 @cindex invalid characters in file names
24115 @cindex characters in file names
24116 This is an alist that says how to translate characters in file names.
24117 For instance, if @samp{:} is invalid as a file character in file names
24118 on your system (you OS/2 user you), you could say something like:
24122 (setq nnheader-file-name-translation-alist
24127 In fact, this is the default value for this variable on OS/2 and MS
24128 Windows (phooey) systems.
24130 @item gnus-hidden-properties
24131 @vindex gnus-hidden-properties
24132 This is a list of properties to use to hide ``invisible'' text. It is
24133 @code{(invisible t intangible t)} by default on most systems, which
24134 makes invisible text invisible and intangible.
24136 @item gnus-parse-headers-hook
24137 @vindex gnus-parse-headers-hook
24138 A hook called before parsing headers. It can be used, for instance, to
24139 gather statistics on the headers fetched, or perhaps you'd like to prune
24140 some headers. I don't see why you'd want that, though.
24142 @item gnus-shell-command-separator
24143 @vindex gnus-shell-command-separator
24144 String used to separate two shell commands. The default is @samp{;}.
24146 @item gnus-invalid-group-regexp
24147 @vindex gnus-invalid-group-regexp
24149 Regexp to match ``invalid'' group names when querying user for a group
24150 name. The default value catches some @strong{really} invalid group
24151 names who could possibly mess up Gnus internally (like allowing
24152 @samp{:} in a group name, which is normally used to delimit method and
24155 @acronym{IMAP} users might want to allow @samp{/} in group names though.
24163 Well, that's the manual---you can get on with your life now. Keep in
24164 touch. Say hello to your cats from me.
24166 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
24168 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
24174 Not because of victories @*
24177 but for the common sunshine,@*
24179 the largess of the spring.
24183 but for the day's work done@*
24184 as well as I was able;@*
24185 not for a seat upon the dais@*
24186 but at the common table.@*
24191 @chapter Appendices
24194 * XEmacs:: Requirements for installing under XEmacs.
24195 * History:: How Gnus got where it is today.
24196 * On Writing Manuals:: Why this is not a beginner's guide.
24197 * Terminology:: We use really difficult, like, words here.
24198 * Customization:: Tailoring Gnus to your needs.
24199 * Troubleshooting:: What you might try if things do not work.
24200 * Gnus Reference Guide:: Rilly, rilly technical stuff.
24201 * Emacs for Heathens:: A short introduction to Emacsian terms.
24202 * Frequently Asked Questions:: The Gnus FAQ
24209 @cindex installing under XEmacs
24211 XEmacs is distributed as a collection of packages. You should install
24212 whatever packages the Gnus XEmacs package requires. The current
24213 requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base},
24214 @samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils},
24215 @samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{w3},
24216 @samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}.
24223 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
24224 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
24226 If you want to investigate the person responsible for this outrage,
24227 you can point your (feh!) web browser to
24228 @uref{http://quimby.gnus.org/}. This is also the primary
24229 distribution point for the new and spiffy versions of Gnus, and is
24230 known as The Site That Destroys Newsrcs And Drives People Mad.
24232 During the first extended alpha period of development, the new Gnus was
24233 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
24234 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
24235 (Besides, the ``Gnus'' in this abbreviation should probably be
24236 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
24237 appropriate name, don't you think?)
24239 In any case, after spending all that energy on coming up with a new and
24240 spunky name, we decided that the name was @emph{too} spunky, so we
24241 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
24242 ``@sc{gnus}''. New vs. old.
24245 * Gnus Versions:: What Gnus versions have been released.
24246 * Other Gnus Versions:: Other Gnus versions that also have been released.
24247 * Why?:: What's the point of Gnus?
24248 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
24249 * Conformity:: Gnus tries to conform to all standards.
24250 * Emacsen:: Gnus can be run on a few modern Emacsen.
24251 * Gnus Development:: How Gnus is developed.
24252 * Contributors:: Oodles of people.
24253 * New Features:: Pointers to some of the new stuff in Gnus.
24257 @node Gnus Versions
24258 @subsection Gnus Versions
24260 @cindex September Gnus
24262 @cindex Quassia Gnus
24263 @cindex Pterodactyl Gnus
24266 @cindex Gnus versions
24268 The first ``proper'' release of Gnus 5 was done in November 1995 when it
24269 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
24270 plus 15 Gnus 5.0 releases).
24272 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
24273 releases)) was released under the name ``Gnus 5.2'' (40 releases).
24275 On July 28th 1996 work on Red Gnus was begun, and it was released on
24276 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
24278 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
24279 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
24281 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
24282 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
24285 On the 26th of October 2000, Oort Gnus was begun.
24287 If you happen upon a version of Gnus that has a prefixed name --
24288 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
24289 ``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic. Don't let it know
24290 that you're frightened. Back away. Slowly. Whatever you do, don't
24291 run. Walk away, calmly, until you're out of its reach. Find a proper
24292 released version of Gnus and snuggle up to that instead.
24295 @node Other Gnus Versions
24296 @subsection Other Gnus Versions
24299 In addition to the versions of Gnus which have had their releases
24300 coordinated by Lars, one major development has been Semi-gnus from
24301 Japan. It's based on a library called @acronym{SEMI}, which provides
24302 @acronym{MIME} capabilities.
24304 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
24305 Collectively, they are called ``Semi-gnus'', and different strains are
24306 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
24307 @acronym{MIME} and multilingualization things, especially important for
24314 What's the point of Gnus?
24316 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
24317 newsreader, that lets you do anything you can think of. That was my
24318 original motivation, but while working on Gnus, it has become clear to
24319 me that this generation of newsreaders really belong in the stone age.
24320 Newsreaders haven't developed much since the infancy of the net. If the
24321 volume continues to rise with the current rate of increase, all current
24322 newsreaders will be pretty much useless. How do you deal with
24323 newsgroups that have thousands of new articles each day? How do you
24324 keep track of millions of people who post?
24326 Gnus offers no real solutions to these questions, but I would very much
24327 like to see Gnus being used as a testing ground for new methods of
24328 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
24329 to separate the newsreader from the back ends, Gnus now offers a simple
24330 interface for anybody who wants to write new back ends for fetching mail
24331 and news from different sources. I have added hooks for customizations
24332 everywhere I could imagine it being useful. By doing so, I'm inviting
24333 every one of you to explore and invent.
24335 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
24336 @kbd{C-u 100 M-x all-hail-xemacs}.
24339 @node Compatibility
24340 @subsection Compatibility
24342 @cindex compatibility
24343 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
24344 bindings have been kept. More key bindings have been added, of course,
24345 but only in one or two obscure cases have old bindings been changed.
24350 @center In a cloud bones of steel.
24354 All commands have kept their names. Some internal functions have changed
24357 The @code{gnus-uu} package has changed drastically. @xref{Decoding
24360 One major compatibility question is the presence of several summary
24361 buffers. All variables relevant while reading a group are
24362 buffer-local to the summary buffer they belong in. Although many
24363 important variables have their values copied into their global
24364 counterparts whenever a command is executed in the summary buffer, this
24365 change might lead to incorrect values being used unless you are careful.
24367 All code that relies on knowledge of @sc{gnus} internals will probably
24368 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
24369 changing it in any way, as a matter of fact) is strictly verboten. Gnus
24370 maintains a hash table that points to the entries in this alist (which
24371 speeds up many functions), and changing the alist directly will lead to
24375 @cindex highlighting
24376 Old hilit19 code does not work at all. In fact, you should probably
24377 remove all hilit code from all Gnus hooks
24378 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
24379 Gnus provides various integrated functions for highlighting. These are
24380 faster and more accurate. To make life easier for everybody, Gnus will
24381 by default remove all hilit calls from all hilit hooks. Uncleanliness!
24384 Packages like @code{expire-kill} will no longer work. As a matter of
24385 fact, you should probably remove all old @sc{gnus} packages (and other
24386 code) when you start using Gnus. More likely than not, Gnus already
24387 does what you have written code to make @sc{gnus} do. (Snicker.)
24389 Even though old methods of doing things are still supported, only the
24390 new methods are documented in this manual. If you detect a new method of
24391 doing something while reading this manual, that does not mean you have
24392 to stop doing it the old way.
24394 Gnus understands all @sc{gnus} startup files.
24396 @kindex M-x gnus-bug
24398 @cindex reporting bugs
24400 Overall, a casual user who hasn't written much code that depends on
24401 @sc{gnus} internals should suffer no problems. If problems occur,
24402 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
24404 @vindex gnus-bug-create-help-buffer
24405 If you are in the habit of sending bug reports @emph{very} often, you
24406 may find the helpful help buffer annoying after a while. If so, set
24407 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
24412 @subsection Conformity
24414 No rebels without a clue here, ma'am. We conform to all standards known
24415 to (wo)man. Except for those standards and/or conventions we disagree
24423 There are no known breaches of this standard.
24427 There are no known breaches of this standard, either.
24429 @item Son-of-RFC 1036
24430 @cindex Son-of-RFC 1036
24431 We do have some breaches to this one.
24437 These are considered to be ``vanity headers'', while I consider them
24438 to be consumer information. After seeing so many badly formatted
24439 articles coming from @code{tin} and @code{Netscape} I know not to use
24440 either of those for posting articles. I would not have known that if
24441 it wasn't for the @code{X-Newsreader} header.
24446 USEFOR is an IETF working group writing a successor to RFC 1036, based
24447 on Son-of-RFC 1036. They have produced a number of drafts proposing
24448 various changes to the format of news articles. The Gnus towers will
24449 look into implementing the changes when the draft is accepted as an RFC.
24451 @item MIME - RFC 2045-2049 etc
24452 @cindex @acronym{MIME}
24453 All the various @acronym{MIME} RFCs are supported.
24455 @item Disposition Notifications - RFC 2298
24456 Message Mode is able to request notifications from the receiver.
24458 @item PGP - RFC 1991 and RFC 2440
24461 RFC 1991 is the original @acronym{PGP} message specification,
24462 published as an informational RFC. RFC 2440 was the follow-up, now
24463 called Open PGP, and put on the Standards Track. Both document a
24464 non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both
24465 encoding (signing and encryption) and decoding (verification and
24468 @item PGP/MIME - RFC 2015/3156
24469 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
24470 1991) describes the @acronym{MIME}-wrapping around the RF 1991/2440 format.
24471 Gnus supports both encoding and decoding.
24473 @item S/MIME - RFC 2633
24474 RFC 2633 describes the @acronym{S/MIME} format.
24476 @item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
24477 RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060
24478 (@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5
24479 authentication for @acronym{IMAP}. RFC 2086 describes access control
24480 lists (ACLs) for @acronym{IMAP}. RFC 2359 describes a @acronym{IMAP}
24481 protocol enhancement. RFC 2595 describes the proper @acronym{TLS}
24482 integration (STARTTLS) with @acronym{IMAP}. RFC 1731 describes the
24483 GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}.
24487 If you ever notice Gnus acting non-compliant with regards to the texts
24488 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
24493 @subsection Emacsen
24499 Gnus should work on:
24507 XEmacs 21.4 and up.
24511 This Gnus version will absolutely not work on any Emacsen older than
24512 that. Not reliably, at least. Older versions of Gnus may work on older
24513 Emacs versions. However, T-gnus does support ``Mule 2.3 based on Emacs
24514 19.34'' and possibly the versions of XEmacs prior to 21.1.1, e.g. 20.4.
24515 See the file ``README'' in the T-gnus distribution for more details.
24517 There are some vague differences between Gnus on the various
24518 platforms---XEmacs features more graphics (a logo and a toolbar)---but
24519 other than that, things should look pretty much the same under all
24523 @node Gnus Development
24524 @subsection Gnus Development
24526 Gnus is developed in a two-phased cycle. The first phase involves much
24527 discussion on the @samp{ding@@gnus.org} mailing list, where people
24528 propose changes and new features, post patches and new back ends. This
24529 phase is called the @dfn{alpha} phase, since the Gnusae released in this
24530 phase are @dfn{alpha releases}, or (perhaps more commonly in other
24531 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
24532 unstable and should not be used by casual users. Gnus alpha releases
24533 have names like ``Red Gnus'' and ``Quassia Gnus''.
24535 After futzing around for 50-100 alpha releases, Gnus is declared
24536 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
24537 and is called things like ``Gnus 5.6.32'' instead. Normal people are
24538 supposed to be able to use these, and these are mostly discussed on the
24539 @samp{gnu.emacs.gnus} newsgroup.
24542 @vindex mail-source-delete-incoming
24543 Some variable defaults differ between alpha Gnusae and released Gnusae.
24544 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
24545 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
24546 lossage of mail if an alpha release hiccups while handling the mail.
24548 The division of discussion between the ding mailing list and the Gnus
24549 newsgroup is not purely based on publicity concerns. It's true that
24550 having people write about the horrible things that an alpha Gnus release
24551 can do (sometimes) in a public forum may scare people off, but more
24552 importantly, talking about new experimental features that have been
24553 introduced may confuse casual users. New features are frequently
24554 introduced, fiddled with, and judged to be found wanting, and then
24555 either discarded or totally rewritten. People reading the mailing list
24556 usually keep up with these rapid changes, while people on the newsgroup
24557 can't be assumed to do so.
24562 @subsection Contributors
24563 @cindex contributors
24565 The new Gnus version couldn't have been done without the help of all the
24566 people on the (ding) mailing list. Every day for over a year I have
24567 gotten billions of nice bug reports from them, filling me with joy,
24568 every single one of them. Smooches. The people on the list have been
24569 tried beyond endurance, what with my ``oh, that's a neat idea <type
24570 type>, yup, I'll release it right away <ship off> no wait, that doesn't
24571 work at all <type type>, yup, I'll ship that one off right away <ship
24572 off> no, wait, that absolutely does not work'' policy for releases.
24573 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
24574 ``worser''? ``much worser''? ``worsest''?)
24576 I would like to take this opportunity to thank the Academy for@dots{} oops,
24582 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
24585 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
24586 nnwarchive and many, many other things connected with @acronym{MIME} and
24587 other types of en/decoding, as well as general bug fixing, new
24588 functionality and stuff.
24591 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
24592 well as numerous other things).
24595 Luis Fernandes---design and graphics.
24598 Joe Reiss---creator of the smiley faces.
24601 Justin Sheehy---the @acronym{FAQ} maintainer.
24604 Erik Naggum---help, ideas, support, code and stuff.
24607 Wes Hardaker---@file{gnus-picon.el} and the manual section on
24608 @dfn{picons} (@pxref{Picons}).
24611 Kim-Minh Kaplan---further work on the picon code.
24614 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section.
24617 Sudish Joseph---innumerable bug fixes.
24620 Ilja Weis---@file{gnus-topic.el}.
24623 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
24626 Vladimir Alexiev---the refcard and reference booklets.
24629 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
24630 distribution by Felix Lee and JWZ.
24633 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
24636 Peter Mutsaers---orphan article scoring code.
24639 Ken Raeburn---POP mail support.
24642 Hallvard B Furuseth---various bits and pieces, especially dealing with
24646 Brian Edmonds---@file{gnus-bbdb.el}.
24649 David Moore---rewrite of @file{nnvirtual.el} and many other things.
24652 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
24655 Fran@,{c}ois Pinard---many, many interesting and thorough bug reports, as
24656 well as autoconf support.
24660 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
24661 Borges, and Jost Krieger proof-reading parts of the manual.
24663 The following people have contributed many patches and suggestions:
24678 Jason L. Tibbitts, III,
24680 Katsumi Yamaoka, @c Yamaoka
24684 Also thanks to the following for patches and stuff:
24694 Alexei V. Barantsev,
24709 Massimo Campostrini,
24714 Jae-you Chung, @c ?
24715 James H. Cloos, Jr.,
24719 Andrew J. Cosgriff,
24722 Geoffrey T. Dairiki,
24728 Michael Welsh Duggan,
24733 Enami Tsugutomo, @c Enami
24737 Nelson Jose dos Santos Ferreira,
24745 Arne Georg Gleditsch,
24747 Michelangelo Grigni,
24751 Kenichi Handa, @c Handa
24753 Yoshiki Hayashi, @c Hayashi
24755 Hisashige Kenji, @c Hisashige
24762 Fran@,{c}ois Felix Ingrand,
24763 Tatsuya Ichikawa, @c Ichikawa
24764 Ishikawa Ichiro, @c Ishikawa
24766 Iwamuro Motonori, @c Iwamuro
24776 Peter Skov Knudsen,
24777 Shuhei Kobayashi, @c Kobayashi
24779 Koseki Yoshinori, @c Koseki
24780 Thor Kristoffersen,
24783 Seokchan Lee, @c Lee
24801 Morioka Tomohiko, @c Morioka
24802 Erik Toubro Nielsen,
24809 Masaharu Onishi, @c Onishi
24814 Jens-Ulrik Holger Petersen,
24818 John McClary Prevost,
24824 Lars Balker Rasmussen,
24829 Christian von Roques,
24832 Wolfgang Rupprecht,
24839 Philippe Schnoebelen,
24841 Randal L. Schwartz,
24855 Kiyokazu Suto, @c Suto
24860 Tozawa Akihiko, @c Tozawa
24880 For a full overview of what each person has done, the ChangeLogs
24881 included in the Gnus alpha distributions should give ample reading
24882 (550kB and counting).
24884 Apologies to everybody that I've forgotten, of which there are many, I'm
24887 Gee, that's quite a list of people. I guess that must mean that there
24888 actually are people who are using Gnus. Who'd'a thunk it!
24892 @subsection New Features
24893 @cindex new features
24896 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
24897 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
24898 * Red Gnus:: Third time best---Gnus 5.4/5.5.
24899 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
24900 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
24901 * Oort Gnus:: It's big. It's far out. Gnus 5.10.
24902 * No Gnus:: Lars, FIXME!
24905 These lists are, of course, just @emph{short} overviews of the
24906 @emph{most} important new features. No, really. There are tons more.
24907 Yes, we have feeping creaturism in full effect.
24910 @subsubsection (ding) Gnus
24912 New features in Gnus 5.0/5.1:
24917 The look of all buffers can be changed by setting format-like variables
24918 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
24921 Local spool and several @acronym{NNTP} servers can be used at once
24922 (@pxref{Select Methods}).
24925 You can combine groups into virtual groups (@pxref{Virtual Groups}).
24928 You can read a number of different mail formats (@pxref{Getting Mail}).
24929 All the mail back ends implement a convenient mail expiry scheme
24930 (@pxref{Expiring Mail}).
24933 Gnus can use various strategies for gathering threads that have lost
24934 their roots (thereby gathering loose sub-threads into one thread) or it
24935 can go back and retrieve enough headers to build a complete thread
24936 (@pxref{Customizing Threading}).
24939 Killed groups can be displayed in the group buffer, and you can read
24940 them as well (@pxref{Listing Groups}).
24943 Gnus can do partial group updates---you do not have to retrieve the
24944 entire active file just to check for new articles in a few groups
24945 (@pxref{The Active File}).
24948 Gnus implements a sliding scale of subscribedness to groups
24949 (@pxref{Group Levels}).
24952 You can score articles according to any number of criteria
24953 (@pxref{Scoring}). You can even get Gnus to find out how to score
24954 articles for you (@pxref{Adaptive Scoring}).
24957 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
24958 manner, so it should be difficult to lose much data on what you have
24959 read if your machine should go down (@pxref{Auto Save}).
24962 Gnus now has its own startup file (@file{~/.gnus.el}) to avoid
24963 cluttering up the @file{.emacs} file.
24966 You can set the process mark on both groups and articles and perform
24967 operations on all the marked items (@pxref{Process/Prefix}).
24970 You can grep through a subset of groups and create a group from the
24971 results (@pxref{Kibozed Groups}).
24974 You can list subsets of groups according to, well, anything
24975 (@pxref{Listing Groups}).
24978 You can browse foreign servers and subscribe to groups from those
24979 servers (@pxref{Browse Foreign Server}).
24982 Gnus can fetch articles, asynchronously, on a second connection to the
24983 server (@pxref{Asynchronous Fetching}).
24986 You can cache articles locally (@pxref{Article Caching}).
24989 The uudecode functions have been expanded and generalized
24990 (@pxref{Decoding Articles}).
24993 You can still post uuencoded articles, which was a little-known feature
24994 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
24997 Fetching parents (and other articles) now actually works without
24998 glitches (@pxref{Finding the Parent}).
25001 Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}).
25004 Digests (and other files) can be used as the basis for groups
25005 (@pxref{Document Groups}).
25008 Articles can be highlighted and customized (@pxref{Customizing
25012 URLs and other external references can be buttonized (@pxref{Article
25016 You can do lots of strange stuff with the Gnus window & frame
25017 configuration (@pxref{Window Layout}).
25020 You can click on buttons instead of using the keyboard
25026 @node September Gnus
25027 @subsubsection September Gnus
25031 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
25035 New features in Gnus 5.2/5.3:
25040 A new message composition mode is used. All old customization variables
25041 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
25045 Gnus is now able to generate @dfn{sparse} threads---threads where
25046 missing articles are represented by empty nodes (@pxref{Customizing
25050 (setq gnus-build-sparse-threads 'some)
25054 Outgoing articles are stored on a special archive server
25055 (@pxref{Archived Messages}).
25058 Partial thread regeneration now happens when articles are
25062 Gnus can make use of GroupLens predictions.
25065 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
25068 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
25071 (setq gnus-use-trees t)
25075 An @code{nn}-like pick-and-read minor mode is available for the summary
25076 buffers (@pxref{Pick and Read}).
25079 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
25083 In binary groups you can use a special binary minor mode (@pxref{Binary
25087 Groups can be grouped in a folding topic hierarchy (@pxref{Group
25091 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
25095 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
25098 Groups can now have a score, and bubbling based on entry frequency
25099 is possible (@pxref{Group Score}).
25102 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
25106 Groups can be process-marked, and commands can be performed on
25107 groups of groups (@pxref{Marking Groups}).
25110 Caching is possible in virtual groups.
25113 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
25114 news batches, ClariNet briefs collections, and just about everything
25115 else (@pxref{Document Groups}).
25118 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets
25122 The Gnus cache is much faster.
25125 Groups can be sorted according to many criteria (@pxref{Sorting
25129 New group parameters have been introduced to set list-addresses and
25130 expiry times (@pxref{Group Parameters}).
25133 All formatting specs allow specifying faces to be used
25134 (@pxref{Formatting Fonts}).
25137 There are several more commands for setting/removing/acting on process
25138 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
25141 The summary buffer can be limited to show parts of the available
25142 articles based on a wide range of criteria. These commands have been
25143 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
25146 Articles can be made persistent with the @kbd{*} command
25147 (@pxref{Persistent Articles}).
25150 All functions for hiding article elements are now toggles.
25153 Article headers can be buttonized (@pxref{Article Washing}).
25156 All mail back ends support fetching articles by @code{Message-ID}.
25159 Duplicate mail can now be treated properly (@pxref{Duplicates}).
25162 All summary mode commands are available directly from the article
25163 buffer (@pxref{Article Keymap}).
25166 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
25170 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
25173 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
25178 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
25181 (setq gnus-use-nocem t)
25185 Groups can be made permanently visible (@pxref{Listing Groups}).
25188 (setq gnus-permanently-visible-groups "^nnml:")
25192 Many new hooks have been introduced to make customizing easier.
25195 Gnus respects the @code{Mail-Copies-To} header.
25198 Threads can be gathered by looking at the @code{References} header
25199 (@pxref{Customizing Threading}).
25202 (setq gnus-summary-thread-gathering-function
25203 'gnus-gather-threads-by-references)
25207 Read articles can be stored in a special backlog buffer to avoid
25208 refetching (@pxref{Article Backlog}).
25211 (setq gnus-keep-backlog 50)
25215 A clean copy of the current article is always stored in a separate
25216 buffer to allow easier treatment.
25219 Gnus can suggest where to save articles (@pxref{Saving Articles}).
25222 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
25226 (setq gnus-prompt-before-saving t)
25230 @code{gnus-uu} can view decoded files asynchronously while fetching
25231 articles (@pxref{Other Decode Variables}).
25234 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
25238 Filling in the article buffer now works properly on cited text
25239 (@pxref{Article Washing}).
25242 Hiding cited text adds buttons to toggle hiding, and how much
25243 cited text to hide is now customizable (@pxref{Article Hiding}).
25246 (setq gnus-cited-lines-visible 2)
25250 Boring headers can be hidden (@pxref{Article Hiding}).
25253 Default scoring values can now be set from the menu bar.
25256 Further syntax checking of outgoing articles have been added.
25262 @subsubsection Red Gnus
25264 New features in Gnus 5.4/5.5:
25268 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
25275 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
25278 Article prefetching functionality has been moved up into
25279 Gnus (@pxref{Asynchronous Fetching}).
25282 Scoring can now be performed with logical operators like @code{and},
25283 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
25287 Article washing status can be displayed in the
25288 article mode line (@pxref{Misc Article}).
25291 @file{gnus.el} has been split into many smaller files.
25294 Suppression of duplicate articles based on Message-ID can be done
25295 (@pxref{Duplicate Suppression}).
25298 (setq gnus-suppress-duplicates t)
25302 New variables for specifying what score and adapt files are to be
25303 considered home score and adapt files (@pxref{Home Score File}) have
25307 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
25308 Server Internals}).
25311 Groups can inherit group parameters from parent topics (@pxref{Topic
25315 Article editing has been revamped and is now actually usable.
25318 Signatures can be recognized in more intelligent fashions
25319 (@pxref{Article Signature}).
25322 Summary pick mode has been made to look more @code{nn}-like. Line
25323 numbers are displayed and the @kbd{.} command can be used to pick
25324 articles (@code{Pick and Read}).
25327 Commands for moving the @file{.newsrc.eld} from one server to
25328 another have been added (@pxref{Changing Servers}).
25331 There's a way now to specify that ``uninteresting'' fields be suppressed
25332 when generating lines in buffers (@pxref{Advanced Formatting}).
25335 Several commands in the group buffer can be undone with @kbd{C-M-_}
25339 Scoring can be done on words using the new score type @code{w}
25340 (@pxref{Score File Format}).
25343 Adaptive scoring can be done on a Subject word-by-word basis
25344 (@pxref{Adaptive Scoring}).
25347 (setq gnus-use-adaptive-scoring '(word))
25351 Scores can be decayed (@pxref{Score Decays}).
25354 (setq gnus-decay-scores t)
25358 Scoring can be performed using a regexp on the Date header. The Date is
25359 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
25362 A new command has been added to remove all data on articles from
25363 the native server (@pxref{Changing Servers}).
25366 A new command for reading collections of documents
25367 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
25368 (@pxref{Really Various Summary Commands}).
25371 Process mark sets can be pushed and popped (@pxref{Setting Process
25375 A new mail-to-news back end makes it possible to post even when the @acronym{NNTP}
25376 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
25379 A new back end for reading searches from Web search engines
25380 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
25381 (@pxref{Web Searches}).
25384 Groups inside topics can now be sorted using the standard sorting
25385 functions, and each topic can be sorted independently (@pxref{Topic
25389 Subsets of the groups can be sorted independently (@code{Sorting
25393 Cached articles can be pulled into the groups (@pxref{Summary Generation
25397 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
25402 Score files are now applied in a more reliable order (@pxref{Score
25406 Reports on where mail messages end up can be generated (@pxref{Splitting
25410 More hooks and functions have been added to remove junk from incoming
25411 mail before saving the mail (@pxref{Washing Mail}).
25414 Emphasized text can be properly fontisized:
25420 @subsubsection Quassia Gnus
25422 New features in Gnus 5.6:
25427 New functionality for using Gnus as an offline newsreader has been
25428 added. A plethora of new commands and modes have been added.
25429 @xref{Gnus Unplugged}, for the full story.
25432 The @code{nndraft} back end has returned, but works differently than
25433 before. All Message buffers are now also articles in the @code{nndraft}
25434 group, which is created automatically.
25437 @code{gnus-alter-header-function} can now be used to alter header
25441 @code{gnus-summary-goto-article} now accept Message-ID's.
25444 A new Message command for deleting text in the body of a message
25445 outside the region: @kbd{C-c C-v}.
25448 You can now post to component group in @code{nnvirtual} groups with
25452 @code{nntp-rlogin-program}---new variable to ease customization.
25455 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
25456 re-highlighting of the article buffer.
25459 New element in @code{gnus-boring-article-headers}---@code{long-to}.
25462 @kbd{M-i} symbolic prefix command. @xref{Symbolic Prefixes}, for
25466 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
25467 @kbd{a} to add the score rule to the @file{all.SCORE} file.
25470 @code{gnus-simplify-subject-functions} variable to allow greater
25471 control over simplification.
25474 @kbd{A T}---new command for fetching the current thread.
25477 @kbd{/ T}---new command for including the current thread in the
25481 @kbd{M-RET} is a new Message command for breaking cited text.
25484 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
25487 The @code{custom-face-lookup} function has been removed.
25488 If you used this function in your initialization files, you must
25489 rewrite them to use @code{face-spec-set} instead.
25492 Canceling now uses the current select method. Symbolic prefix
25493 @kbd{a} forces normal posting method.
25496 New command to translate M******** sm*rtq**t*s into proper
25500 For easier debugging of @code{nntp}, you can set
25501 @code{nntp-record-commands} to a non-@code{nil} value.
25504 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
25505 controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers.
25508 A command for editing group parameters from the summary buffer
25512 A history of where mails have been split is available.
25515 A new article date command has been added---@code{article-date-iso8601}.
25518 Subjects can be simplified when threading by setting
25519 @code{gnus-score-thread-simplify}.
25522 A new function for citing in Message has been
25523 added---@code{message-cite-original-without-signature}.
25526 @code{article-strip-all-blank-lines}---new article command.
25529 A new Message command to kill to the end of the article has
25533 A minimum adaptive score can be specified by using the
25534 @code{gnus-adaptive-word-minimum} variable.
25537 The ``lapsed date'' article header can be kept continually
25538 updated by the @code{gnus-start-date-timer} command.
25541 Web listserv archives can be read with the @code{nnlistserv} back end.
25544 Old dejanews archives can now be read by @code{nnweb}.
25548 @node Pterodactyl Gnus
25549 @subsubsection Pterodactyl Gnus
25551 New features in Gnus 5.8:
25556 The mail-fetching functions have changed. See the manual for the
25557 many details. In particular, all procmail fetching variables are gone.
25559 If you used procmail like in
25562 (setq nnmail-use-procmail t)
25563 (setq nnmail-spool-file 'procmail)
25564 (setq nnmail-procmail-directory "~/mail/incoming/")
25565 (setq nnmail-procmail-suffix "\\.in")
25568 this now has changed to
25572 '((directory :path "~/mail/incoming/"
25576 @xref{Mail Source Specifiers}.
25579 Gnus is now a @acronym{MIME}-capable reader. This affects many parts of
25580 Gnus, and adds a slew of new commands. See the manual for details.
25583 Gnus has also been multilingualized. This also affects too
25584 many parts of Gnus to summarize here, and adds many new variables.
25587 @code{gnus-auto-select-first} can now be a function to be
25588 called to position point.
25591 The user can now decide which extra headers should be included in
25592 summary buffers and @acronym{NOV} files.
25595 @code{gnus-article-display-hook} has been removed. Instead, a number
25596 of variables starting with @code{gnus-treat-} have been added.
25599 The Gnus posting styles have been redone again and now works in a
25600 subtly different manner.
25603 New web-based back ends have been added: @code{nnslashdot},
25604 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
25605 again, to keep up with ever-changing layouts.
25608 Gnus can now read @acronym{IMAP} mail via @code{nnimap}.
25613 @subsubsection Oort Gnus
25616 New features in Gnus 5.10:
25621 @code{gnus-group-read-ephemeral-group} can be called interactively,
25625 In draft groups, @kbd{e} is now bound to @code{gnus-draft-edit-message}.
25626 Use @kbd{B w} for @code{gnus-summary-edit-article} instead.
25629 The revised Gnus @acronym{FAQ} is included in the manual,
25630 @xref{Frequently Asked Questions}.
25633 Upgrading from previous (stable) version if you have used Oort.
25635 If you have tried Oort (the unstable Gnus branch leading to this
25636 release) but went back to a stable version, be careful when upgrading to
25637 this version. In particular, you will probably want to remove all
25638 @file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are
25639 read from your @file{.newsrc.eld} instead of from the
25640 @file{.marks}/@file{.mrk} file where this release store flags. See a
25641 later entry for more information about marks. Note that downgrading
25642 isn't save in general.
25647 More buttons for URLs, mail addresses, Message-IDs, Info links, man
25648 pages and Emacs or Gnus related references. @xref{Article Buttons}. The
25649 variables @code{gnus-button-@var{*}-level} can be used to control the
25650 appearance of all article buttons. @xref{Article Button Levels}.
25655 @code{gnus-dired-minor-mode} (see @ref{Other modes}) installs key
25656 bindings in dired buffers to send a file as an attachment, open a file
25657 using the appropriate mailcap entry, and print a file using the mailcap
25661 Gnus can display RSS newsfeeds as a newsgroup. @xref{RSS}.
25664 Single-part yenc encoded attachments can be decoded.
25669 The picons code has been reimplemented to work in GNU Emacs---some of
25670 the previous options have been removed or renamed.
25672 Picons are small ``personal icons'' representing users, domain and
25673 newsgroups, which can be displayed in the Article buffer.
25677 If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a
25678 boundary line is drawn at the end of the headers.
25681 Retrieval of charters and control messages
25683 There are new commands for fetching newsgroup charters (@kbd{H c}) and
25684 control messages (@kbd{H C}).
25689 You can delay the sending of a message with @kbd{C-c C-j} in the Message
25690 buffer. The messages are delivered at specified time. This is useful
25691 for sending yourself reminders. @xref{Delayed Articles}.
25694 If @code{auto-compression-mode} is enabled, attachments are automatically
25695 decompressed when activated.
25698 If the new option @code{nnml-use-compressed-files} is non-@code{nil},
25699 the nnml back end allows compressed message files.
25702 Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}.
25705 The Summary Buffer uses an arrow in the fringe to indicate the current
25706 article. Use @code{(setq gnus-summary-display-arrow nil)} to disable it.
25709 Warn about email replies to news
25711 Do you often find yourself replying to news by email by mistake? Then
25712 the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for
25716 If the new option @code{gnus-summary-display-while-building} is
25717 non-@code{nil}, the summary buffer is shown and updated as it's being
25721 The new @code{recent} mark @samp{.} indicates newly arrived messages (as
25722 opposed to old but unread messages).
25725 The new option @code{gnus-gcc-mark-as-read} automatically marks
25726 Gcc articles as read.
25729 The nndoc back end now supports mailman digests and exim bounces.
25732 Gnus supports RFC 2369 mailing list headers, and adds a number of
25733 related commands in mailing list groups. @xref{Mailing List}.
25736 The Date header can be displayed in a format that can be read aloud
25737 in English. @xref{Article Date}.
25740 The envelope sender address can be customized when using Sendmail.
25741 @xref{Mail Variables, Mail Variables,, message, Message Manual}.
25744 diffs are automatically highlighted in groups matching
25745 @code{mm-uu-diff-groups-regexp}
25748 @acronym{TLS} wrapper shipped with Gnus
25750 @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and
25751 @acronym{NNTP} via @file{tls.el} and GNUTLS. The old
25752 @acronym{TLS}/@acronym{SSL} support via (external third party)
25753 @file{ssl.el} and OpenSSL still works.
25756 New @file{make.bat} for compiling and installing Gnus under MS Windows
25758 Use @file{make.bat} if you want to install Gnus under MS Windows, the
25759 first argument to the batch-program should be the directory where
25760 @file{xemacs.exe} respectively @file{emacs.exe} is located, iff you want
25761 to install Gnus after compiling it, give @file{make.bat} @code{/copy} as
25762 the second parameter.
25764 @file{make.bat} has been rewritten from scratch, it now features
25765 automatic recognition of XEmacs and GNU Emacs, generates
25766 @file{gnus-load.el}, checks if errors occur while compilation and
25767 generation of info files and reports them at the end of the build
25768 process. It now uses @code{makeinfo} if it is available and falls
25769 back to @file{infohack.el} otherwise. @file{make.bat} should now
25770 install all files which are necessary to run Gnus and be generally a
25771 complete replacement for the @code{configure; make; make install}
25772 cycle used under Unix systems.
25774 The new @file{make.bat} makes @file{make-x.bat} superfluous, so it has
25778 Support for non-@acronym{ASCII} domain names
25780 Message supports non-@acronym{ASCII} domain names in From:, To: and
25781 Cc: and will query you whether to perform encoding when you try to
25782 send a message. The variable @code{message-use-idna} controls this.
25783 Gnus will also decode non-@acronym{ASCII} domain names in From:, To:
25784 and Cc: when you view a message. The variable @code{gnus-use-idna}
25788 Better handling of Microsoft citation styles
25790 Gnus now tries to recognize the mangled header block that some Microsoft
25791 mailers use to indicate that the rest of the message is a citation, even
25792 though it is not quoted in any way. The variable
25793 @code{gnus-cite-unsightly-citation-regexp} matches the start of these
25797 @code{gnus-article-skip-boring}
25799 If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will
25800 not scroll down to show you a page that contains only boring text,
25801 which by default means cited text and signature. You can customize
25802 what is skippable using @code{gnus-article-boring-faces}.
25804 This feature is especially useful if you read many articles that
25805 consist of a little new content at the top with a long, untrimmed
25806 message cited below.
25809 The format spec @code{%C} for positioning point has changed to @code{%*}.
25812 The new variable @code{gnus-parameters} can be used to set group parameters.
25814 Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored
25815 the parameters in @file{~/.newsrc.eld}, but via this variable you can
25816 enjoy the powers of customize, and simplified backups since you set the
25817 variable in @file{~/.emacs} instead of @file{~/.newsrc.eld}. The
25818 variable maps regular expressions matching group names to group
25821 (setq gnus-parameters
25823 (gnus-show-threads nil)
25824 (gnus-use-scoring nil))
25825 ("^nnimap:\\(foo.bar\\)$"
25826 (to-group . "\\1"))))
25830 Smileys (@samp{:-)}, @samp{;-)} etc) are now iconized for Emacs too.
25832 Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.emacs} to
25836 Gnus no longer generate the Sender: header automatically.
25838 Earlier it was generated iff the user configurable email address was
25839 different from the Gnus guessed default user address. As the guessing
25840 algorithm is rarely correct these days, and (more controversially) the
25841 only use of the Sender: header was to check if you are entitled to
25842 cancel/supersede news (which is now solved by Cancel Locks instead,
25843 see another entry), generation of the header has been disabled by
25844 default. See the variables @code{message-required-headers},
25845 @code{message-required-news-headers}, and
25846 @code{message-required-mail-headers}.
25849 Features from third party @file{message-utils.el} added to @file{message.el}.
25851 Message now asks if you wish to remove @samp{(was: <old subject>)} from
25852 subject lines (see @code{message-subject-trailing-was-query}). @kbd{C-c
25853 M-m} and @kbd{C-c M-f} inserts markers indicating included text.
25854 @kbd{C-c C-f a} adds a X-No-Archive: header. @kbd{C-c C-f x} inserts
25855 appropriate headers and a note in the body for cross-postings and
25856 followups (see the variables @code{message-cross-post-@var{*}}).
25859 References and X-Draft-Headers are no longer generated when you start
25860 composing messages and @code{message-generate-headers-first} is
25864 Improved anti-spam features.
25866 Gnus is now able to take out spam from your mail and news streams
25867 using a wide variety of programs and filter rules. Among the supported
25868 methods are RBL blocklists, bogofilter and white/blacklists. Hooks
25869 for easy use of external packages such as SpamAssassin and Hashcash
25870 are also new. @xref{Thwarting Email Spam}.
25873 Easy inclusion of X-Faces headers.
25876 Face headers handling.
25879 In the summary buffer, the new command @kbd{/ N} inserts new messages
25880 and @kbd{/ o} inserts old messages.
25883 Gnus decodes morse encoded messages if you press @kbd{W m}.
25886 Unread count correct in nnimap groups.
25888 The estimated number of unread articles in the group buffer should now
25889 be correct for nnimap groups. This is achieved by calling
25890 @code{nnimap-fixup-unread-after-getting-new-news} from the
25891 @code{gnus-setup-news-hook} (called on startup) and
25892 @code{gnus-after-getting-new-news-hook}. (called after getting new
25893 mail). If you have modified those variables from the default, you may
25894 want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If
25895 you were happy with the estimate and want to save some (minimal) time
25896 when getting new mail, remove the function.
25899 Group Carbon Copy (GCC) quoting
25901 To support groups that contains SPC and other weird characters, groups
25902 are quoted before they are placed in the Gcc: header. This means
25903 variables such as @code{gnus-message-archive-group} should no longer
25904 contain quote characters to make groups containing SPC work. Also, if
25905 you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc
25906 into two groups) you must change it to return the list
25907 @code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted
25908 incorrectly. Note that returning the string @samp{nnml:foo, nnml:bar}
25909 was incorrect earlier, it just didn't generate any problems since it
25910 was inserted directly.
25913 @file{~/News/overview/} not used.
25915 As a result of the following change, the @file{~/News/overview/}
25916 directory is not used any more. You can safely delete the entire
25922 The Gnus Agent has seen a major updated and is now enabled by default,
25923 and all nntp and nnimap servers from @code{gnus-select-method} and
25924 @code{gnus-secondary-select-method} are agentized by default. Earlier
25925 only the server in @code{gnus-select-method} was agentized by the
25926 default, and the agent was disabled by default. When the agent is
25927 enabled, headers are now also retrieved from the Agent cache instead
25928 of the back ends when possible. Earlier this only happened in the
25929 unplugged state. You can enroll or remove servers with @kbd{J a} and
25930 @kbd{J r} in the server buffer. Gnus will not download articles into
25931 the Agent cache, unless you instruct it to do so, though, by using
25932 @kbd{J u} or @kbd{J s} from the Group buffer. You revert to the old
25933 behaviour of having the Agent disabled with @code{(setq gnus-agent
25934 nil)}. Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el}
25935 is not needed any more.
25938 @code{gnus-summary-line-format}
25940 The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%)
25941 %s\n}. Moreover @code{gnus-extra-headers},
25942 @code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses}
25943 changed their default so that the users name will be replaced by the
25944 recipient's name or the group name posting to for @acronym{NNTP}
25948 @file{deuglify.el} (@code{gnus-article-outlook-deuglify-article})
25950 A new file from Raymond Scholz @email{rscholz@@zonix.de} for deuglifying
25951 broken Outlook (Express) articles.
25954 @code{(require 'gnus-load)}
25956 If you use a stand-alone Gnus distribution, you'd better add
25957 @code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus
25958 lisp directory into load-path.
25960 File @file{gnus-load.el} contains autoload commands, functions and variables,
25961 some of which may not be included in distributions of Emacsen.
25964 @code{gnus-slave-unplugged}
25966 A new command which starts Gnus offline in slave mode.
25969 @code{message-insinuate-rmail}
25971 Adding @code{(message-insinuate-rmail)} and @code{(setq
25972 mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to
25973 compose, reply and forward messages in message-mode, where you can
25974 enjoy the power of @acronym{MML}.
25977 @code{message-minibuffer-local-map}
25979 The line below enables BBDB in resending a message:
25981 (define-key message-minibuffer-local-map [(tab)]
25982 'bbdb-complete-name)
25986 Externalizing and deleting of attachments.
25988 If @code{gnus-gcc-externalize-attachments} or
25989 @code{message-fcc-externalize-attachments} is non-@code{nil}, attach
25990 local files as external parts.
25992 The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o}
25993 on @acronym{MIME} buttons) saves a part and replaces the part with an
25994 external one. @code{gnus-mime-delete-part} (bound to @kbd{d} on
25995 @acronym{MIME} buttons) removes a part. It works only on back ends
25996 that support editing.
25999 @code{gnus-default-charset}
26001 The default value is determined from the
26002 @code{current-language-environment} variable, instead of
26003 @code{iso-8859-1}. Also the @samp{.*} item in
26004 @code{gnus-group-charset-alist} is removed.
26007 @code{gnus-posting-styles}
26009 Add a new format of match like
26011 ((header "to" "larsi.*org")
26012 (Organization "Somewhere, Inc."))
26014 The old format like the lines below is obsolete, but still accepted.
26016 (header "to" "larsi.*org"
26017 (Organization "Somewhere, Inc."))
26021 @code{message-ignored-news-headers} and @code{message-ignored-mail-headers}
26023 @samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been
26024 added into these two variables. If you customized those, perhaps you
26025 need add those two headers too.
26028 Gnus reads the @acronym{NOV} and articles in the Agent if plugged.
26030 If one reads an article while plugged, and the article already exists
26031 in the Agent, it won't get downloaded once more. @code{(setq
26032 gnus-agent-cache nil)} reverts to the old behavior.
26035 Gnus supports the ``format=flowed'' (RFC 2646) parameter. On
26036 composing messages, it is enabled by @code{use-hard-newlines}.
26037 Decoding format=flowed was present but not documented in earlier
26041 Gnus supports the generation of RFC 2298 Disposition Notification requests.
26043 This is invoked with the @kbd{C-c M-n} key binding from message mode.
26046 Gnus supports Maildir groups.
26048 Gnus includes a new back end @file{nnmaildir.el}. @xref{Maildir}.
26051 Printing capabilities are enhanced.
26053 Gnus supports Muttprint natively with @kbd{O P} from the Summary and
26054 Article buffers. Also, each individual @acronym{MIME} part can be
26055 printed using @kbd{p} on the @acronym{MIME} button.
26058 Message supports the Importance: (RFC 2156) header.
26060 In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through
26064 Gnus supports Cancel Locks in News.
26066 This means a header @samp{Cancel-Lock} is inserted in news posting. It is
26067 used to determine if you wrote an article or not (for canceling and
26068 superseding). Gnus generates a random password string the first time
26069 you post a message, and saves it in your @file{~/.emacs} using the Custom
26070 system. While the variable is called @code{canlock-password}, it is not
26071 security sensitive data. Publishing your canlock string on the web
26072 will not allow anyone to be able to anything she could not already do.
26073 The behaviour can be changed by customizing @code{message-insert-canlock}.
26076 Gnus supports server-side mail filtering using Sieve.
26078 Sieve rules can be added as Group Parameters for groups, and the
26079 complete Sieve script is generated using @kbd{D g} from the Group
26080 buffer, and then uploaded to the server using @kbd{C-c C-l} in the
26081 generated Sieve buffer. @xref{Sieve Commands}, and the new Sieve
26082 manual @ref{Top, , Top, sieve, Emacs Sieve}.
26085 Extended format specs.
26087 Format spec @samp{%&user-date;} is added into
26088 @code{gnus-summary-line-format-alist}. Also, user defined extended
26089 format specs are supported. The extended format specs look like
26090 @samp{%u&foo;}, which invokes function
26091 @code{gnus-user-format-function-@var{foo}}. Because @samp{&} is used as the
26092 escape character, old user defined format @samp{%u&} is no longer supported.
26095 @kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten.
26097 It was aliased to @kbd{Y c}
26098 (@code{gnus-summary-insert-cached-articles}). The new function filters
26099 out other articles.
26101 @item Some limiting commands accept a @kbd{C-u} prefix to negate the match.
26103 If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/
26104 s}, @kbd{/ a}, and @kbd{/ x}
26105 (@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the
26106 result will be to display all articles that do not match the expression.
26109 Group names are treated as UTF-8 by default.
26111 This is supposedly what USEFOR wanted to migrate to. See
26112 @code{gnus-group-name-charset-group-alist} and
26113 @code{gnus-group-name-charset-method-alist} for customization.
26116 The nnml and nnfolder back ends store marks for each groups.
26118 This makes it possible to take backup of nnml/nnfolder servers/groups
26119 separately of @file{~/.newsrc.eld}, while preserving marks. It also
26120 makes it possible to share articles and marks between users (without
26121 sharing the @file{~/.newsrc.eld} file) within e.g. a department. It
26122 works by storing the marks stored in @file{~/.newsrc.eld} in a per-group
26123 file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for
26124 nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to
26125 another machine, Gnus will automatically use the @file{.marks} or
26126 @file{.mrk} file instead of the information in @file{~/.newsrc.eld}.
26127 The new server variables @code{nnml-marks-is-evil} and
26128 @code{nnfolder-marks-is-evil} can be used to disable this feature.
26131 The menu bar item (in Group and Summary buffer) named ``Misc'' has
26132 been renamed to ``Gnus''.
26135 The menu bar item (in Message mode) named ``@acronym{MML}'' has been
26136 renamed to ``Attachments''. Note that this menu also contains security
26137 related stuff, like signing and encryption (@pxref{Security, Security,,
26138 message, Message Manual}).
26141 @code{gnus-group-charset-alist} and
26142 @code{gnus-group-ignored-charsets-alist}.
26144 The regexps in these variables are compared with full group names
26145 instead of real group names in 5.8. Users who customize these
26146 variables should change those regexps accordingly. For example:
26148 ("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr)
26152 Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC
26153 2015/3156) and @acronym{S/MIME} (RFC 2630-2633).
26155 It needs an external @acronym{S/MIME} and OpenPGP implementation, but no
26156 additional Lisp libraries. This add several menu items to the
26157 Attachments menu, and @kbd{C-c RET} key bindings, when composing
26158 messages. This also obsoletes @code{gnus-article-hide-pgp-hook}.
26161 Gnus inlines external parts (message/external).
26164 @acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c
26167 This change was made to avoid conflict with the standard binding of
26168 @code{back-to-indentation}, which is also useful in message mode.
26171 The default for @code{message-forward-show-mml} changed to symbol @code{best}.
26173 The behaviour for the @code{best} value is to show @acronym{MML} (i.e.,
26174 convert to @acronym{MIME}) when appropriate. @acronym{MML} will not be
26175 used when forwarding signed or encrypted messages, as the conversion
26176 invalidate the digital signature.
26180 @subsubsection No Gnus
26183 New features in No Gnus:
26184 @c FIXME: Gnus 5.12?
26186 @include gnus-news.texi
26192 @section The Manual
26196 This manual was generated from a TeXinfo file and then run through
26197 either @code{texi2dvi}
26199 or my own home-brewed TeXinfo to \LaTeX\ transformer,
26200 and then run through @code{latex} and @code{dvips}
26202 to get what you hold in your hands now.
26204 The following conventions have been used:
26209 This is a @samp{string}
26212 This is a @kbd{keystroke}
26215 This is a @file{file}
26218 This is a @code{symbol}
26222 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
26226 (setq flargnoze "yes")
26229 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
26232 (setq flumphel 'yes)
26235 @samp{yes} and @code{yes} are two @emph{very} different things---don't
26236 ever get them confused.
26240 Of course, everything in this manual is of vital interest, so you should
26241 read it all. Several times. However, if you feel like skimming the
26242 manual, look for that gnu head you should see in the margin over
26243 there---it means that what's being discussed is of more importance than
26244 the rest of the stuff. (On the other hand, if everything is infinitely
26245 important, how can anything be more important than that? Just one more
26246 of the mysteries of this world, I guess.)
26252 @node On Writing Manuals
26253 @section On Writing Manuals
26255 I guess most manuals are written after-the-fact; documenting a program
26256 that's already there. This is not how this manual is written. When
26257 implementing something, I write the manual entry for that something
26258 straight away. I then see that it's difficult to explain the
26259 functionality, so I write how it's supposed to be, and then I change the
26260 implementation. Writing the documentation and writing the code goes
26263 This, of course, means that this manual has no, or little, flow. It
26264 documents absolutely everything in Gnus, but often not where you're
26265 looking for it. It is a reference manual, and not a guide to how to get
26268 That would be a totally different book, that should be written using the
26269 reference manual as source material. It would look quite differently.
26274 @section Terminology
26276 @cindex terminology
26281 This is what you are supposed to use this thing for---reading news.
26282 News is generally fetched from a nearby @acronym{NNTP} server, and is
26283 generally publicly available to everybody. If you post news, the entire
26284 world is likely to read just what you have written, and they'll all
26285 snigger mischievously. Behind your back.
26289 Everything that's delivered to you personally is mail. Some news/mail
26290 readers (like Gnus) blur the distinction between mail and news, but
26291 there is a difference. Mail is private. News is public. Mailing is
26292 not posting, and replying is not following up.
26296 Send a mail to the person who has written what you are reading.
26300 Post an article to the current newsgroup responding to the article you
26305 Gnus considers mail and news to be mostly the same, really. The only
26306 difference is how to access the actual articles. News articles are
26307 commonly fetched via the protocol @acronym{NNTP}, whereas mail
26308 messages could be read from a file on the local disk. The internal
26309 architecture of Gnus thus comprises a ``front end'' and a number of
26310 ``back ends''. Internally, when you enter a group (by hitting
26311 @key{RET}, say), you thereby invoke a function in the front end in
26312 Gnus. The front end then ``talks'' to a back end and says things like
26313 ``Give me the list of articles in the foo group'' or ``Show me article
26316 So a back end mainly defines either a protocol (the @code{nntp} back
26317 end accesses news via @acronym{NNTP}, the @code{nnimap} back end
26318 accesses mail via @acronym{IMAP}) or a file format and directory
26319 layout (the @code{nnspool} back end accesses news via the common
26320 ``spool directory'' format, the @code{nnml} back end access mail via a
26321 file format and directory layout that's quite similar).
26323 Gnus does not handle the underlying media, so to speak---this is all
26324 done by the back ends. A back end is a collection of functions to
26325 access the articles.
26327 However, sometimes the term ``back end'' is also used where ``server''
26328 would have been more appropriate. And then there is the term ``select
26329 method'' which can mean either. The Gnus terminology can be quite
26334 Gnus will always use one method (and back end) as the @dfn{native}, or
26335 default, way of getting news.
26339 You can also have any number of foreign groups active at the same time.
26340 These are groups that use non-native non-secondary back ends for getting
26345 Secondary back ends are somewhere half-way between being native and being
26346 foreign, but they mostly act like they are native.
26350 A message that has been posted as news.
26353 @cindex mail message
26354 A message that has been mailed.
26358 A mail message or news article
26362 The top part of a message, where administrative information (etc.) is
26367 The rest of an article. Everything not in the head is in the
26372 A line from the head of an article.
26376 A collection of such lines, or a collection of heads. Or even a
26377 collection of @acronym{NOV} lines.
26379 @item @acronym{NOV}
26380 @cindex @acronym{NOV}
26381 When Gnus enters a group, it asks the back end for the headers of all
26382 unread articles in the group. Most servers support the News OverView
26383 format, which is more compact and much faster to read and parse than the
26384 normal @sc{head} format.
26388 Each group is subscribed at some @dfn{level} or other (1-9). The ones
26389 that have a lower level are ``more'' subscribed than the groups with a
26390 higher level. In fact, groups on levels 1-5 are considered
26391 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
26392 are @dfn{killed}. Commands for listing groups and scanning for new
26393 articles will all use the numeric prefix as @dfn{working level}.
26395 @item killed groups
26396 @cindex killed groups
26397 No information on killed groups is stored or updated, which makes killed
26398 groups much easier to handle than subscribed groups.
26400 @item zombie groups
26401 @cindex zombie groups
26402 Just like killed groups, only slightly less dead.
26405 @cindex active file
26406 The news server has to keep track of what articles it carries, and what
26407 groups exist. All this information in stored in the active file, which
26408 is rather large, as you might surmise.
26411 @cindex bogus groups
26412 A group that exists in the @file{.newsrc} file, but isn't known to the
26413 server (i.e., it isn't in the active file), is a @emph{bogus group}.
26414 This means that the group probably doesn't exist (any more).
26417 @cindex activating groups
26418 The act of asking the server for info on a group and computing the
26419 number of unread articles is called @dfn{activating the group}.
26420 Un-activated groups are listed with @samp{*} in the group buffer.
26424 A machine one can connect to and get news (or mail) from.
26426 @item select method
26427 @cindex select method
26428 A structure that specifies the back end, the server and the virtual
26431 @item virtual server
26432 @cindex virtual server
26433 A named select method. Since a select method defines all there is to
26434 know about connecting to a (physical) server, taking the thing as a
26435 whole is a virtual server.
26439 Taking a buffer and running it through a filter of some sort. The
26440 result will (more often than not) be cleaner and more pleasing than the
26443 @item ephemeral groups
26444 @cindex ephemeral groups
26445 @cindex temporary groups
26446 Most groups store data on what articles you have read. @dfn{Ephemeral}
26447 groups are groups that will have no data stored---when you exit the
26448 group, it'll disappear into the aether.
26451 @cindex solid groups
26452 This is the opposite of ephemeral groups. All groups listed in the
26453 group buffer are solid groups.
26455 @item sparse articles
26456 @cindex sparse articles
26457 These are article placeholders shown in the summary buffer when
26458 @code{gnus-build-sparse-threads} has been switched on.
26462 To put responses to articles directly after the articles they respond
26463 to---in a hierarchical fashion.
26467 @cindex thread root
26468 The first article in a thread is the root. It is the ancestor of all
26469 articles in the thread.
26473 An article that has responses.
26477 An article that responds to a different article---its parent.
26481 A collection of messages in one file. The most common digest format is
26482 specified by RFC 1153.
26485 @cindex splitting, terminolgy
26486 @cindex mail sorting
26487 @cindex mail filtering (splitting)
26488 The action of sorting your emails according to certain rules. Sometimes
26489 incorrectly called mail filtering.
26495 @node Customization
26496 @section Customization
26497 @cindex general customization
26499 All variables are properly documented elsewhere in this manual. This
26500 section is designed to give general pointers on how to customize Gnus
26501 for some quite common situations.
26504 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
26505 * Slow Terminal Connection:: You run a remote Emacs.
26506 * Little Disk Space:: You feel that having large setup files is icky.
26507 * Slow Machine:: You feel like buying a faster machine.
26511 @node Slow/Expensive Connection
26512 @subsection Slow/Expensive NNTP Connection
26514 If you run Emacs on a machine locally, and get your news from a machine
26515 over some very thin strings, you want to cut down on the amount of data
26516 Gnus has to get from the @acronym{NNTP} server.
26520 @item gnus-read-active-file
26521 Set this to @code{nil}, which will inhibit Gnus from requesting the
26522 entire active file from the server. This file is often v. large. You
26523 also have to set @code{gnus-check-new-newsgroups} and
26524 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
26525 doesn't suddenly decide to fetch the active file anyway.
26527 @item gnus-nov-is-evil
26528 This one has to be @code{nil}. If not, grabbing article headers from
26529 the @acronym{NNTP} server will not be very fast. Not all @acronym{NNTP} servers
26530 support @sc{xover}; Gnus will detect this by itself.
26534 @node Slow Terminal Connection
26535 @subsection Slow Terminal Connection
26537 Let's say you use your home computer for dialing up the system that runs
26538 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
26539 possible) the amount of data sent over the wires.
26543 @item gnus-auto-center-summary
26544 Set this to @code{nil} to inhibit Gnus from re-centering the summary
26545 buffer all the time. If it is @code{vertical}, do only vertical
26546 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
26547 horizontal and vertical recentering.
26549 @item gnus-visible-headers
26550 Cut down on the headers included in the articles to the
26551 minimum. You can, in fact, make do without them altogether---most of the
26552 useful data is in the summary buffer, anyway. Set this variable to
26553 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
26555 Set this hook to all the available hiding commands:
26557 (setq gnus-treat-hide-headers 'head
26558 gnus-treat-hide-signature t
26559 gnus-treat-hide-citation t)
26562 @item gnus-use-full-window
26563 By setting this to @code{nil}, you can make all the windows smaller.
26564 While this doesn't really cut down much generally, it means that you
26565 have to see smaller portions of articles before deciding that you didn't
26566 want to read them anyway.
26568 @item gnus-thread-hide-subtree
26569 If this is non-@code{nil}, all threads in the summary buffer will be
26573 @item gnus-updated-mode-lines
26574 If this is @code{nil}, Gnus will not put information in the buffer mode
26575 lines, which might save some time.
26579 @node Little Disk Space
26580 @subsection Little Disk Space
26583 The startup files can get rather large, so you may want to cut their
26584 sizes a bit if you are running out of space.
26588 @item gnus-save-newsrc-file
26589 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
26590 only save @file{.newsrc.eld}. This means that you will not be able to
26591 use any other newsreaders than Gnus. This variable is @code{t} by
26594 @item gnus-read-newsrc-file
26595 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
26596 only read @file{.newsrc.eld}. This means that you will not be able to
26597 use any other newsreaders than Gnus. This variable is @code{t} by
26600 @item gnus-save-killed-list
26601 If this is @code{nil}, Gnus will not save the list of dead groups. You
26602 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
26603 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
26604 variable to @code{nil}. This variable is @code{t} by default.
26610 @subsection Slow Machine
26611 @cindex slow machine
26613 If you have a slow machine, or are just really impatient, there are a
26614 few things you can do to make Gnus run faster.
26616 Set @code{gnus-check-new-newsgroups} and
26617 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
26619 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
26620 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
26621 summary buffer faster.
26623 Gnus uses the internal ELisp-based @code{uncompface} program for
26624 decoding an @code{X-Face} header normally in Emacs. If you feel it is
26625 slow, set @code{uncompface-use-external} to @code{t}. @xref{X-Face}.
26629 @node Troubleshooting
26630 @section Troubleshooting
26631 @cindex troubleshooting
26633 Gnus works @emph{so} well straight out of the box---I can't imagine any
26641 Make sure your computer is switched on.
26644 Make sure that you really load the current Gnus version. If you have
26645 been running @sc{gnus}, you need to exit Emacs and start it up again before
26649 Try doing an @kbd{M-x gnus-version}. If you get something that looks
26650 like @samp{T-gnus 6.17.* (based on Gnus v5.10.*; for SEMI 1.1*, FLIM
26651 1.1*)} you have the right files loaded. Otherwise you have some old
26652 @file{.el} files lying around. Delete these.
26655 Read the help group (@kbd{G h} in the group buffer) for a
26656 @acronym{FAQ} and a how-to.
26659 @vindex max-lisp-eval-depth
26660 Gnus works on many recursive structures, and in some extreme (and very
26661 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
26662 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
26663 something like that.
26666 If all else fails, report the problem as a bug.
26669 @cindex reporting bugs
26671 @kindex M-x gnus-bug
26673 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
26674 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
26675 me the backtrace. I will fix bugs, but I can only fix them if you send
26676 me a precise description as to how to reproduce the bug.
26678 You really can never be too detailed in a bug report. Always use the
26679 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
26680 a 10Kb mail each time you use it, and even if you have sent me your
26681 environment 500 times before. I don't care. I want the full info each
26684 It is also important to remember that I have no memory whatsoever. If
26685 you send a bug report, and I send you a reply, and then you just send
26686 back ``No, it's not! Moron!'', I will have no idea what you are
26687 insulting me about. Always over-explain everything. It's much easier
26688 for all of us---if I don't have all the information I need, I will just
26689 mail you and ask for more info, and everything takes more time.
26691 If the problem you're seeing is very visual, and you can't quite explain
26692 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
26693 it somewhere it can be reached, and include the URL of the picture in
26697 If you would like to contribute a patch to fix bugs or make
26698 improvements, please produce the patch using @samp{diff -u}.
26701 If you want to debug your problem further before reporting, possibly
26702 in order to solve the problem yourself and send a patch, you can use
26703 edebug. Debugging Lisp code is documented in the Elisp manual
26704 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
26705 Lisp Reference Manual}). To get you started with edebug, consider if
26706 you discover some weird behaviour when pressing @kbd{c}, the first
26707 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
26708 the documentation buffer that leads you to the function definition,
26709 then press @kbd{M-x edebug-defun RET} with point inside that function,
26710 return to Gnus and press @kbd{c} to invoke the code. You will be
26711 placed in the lisp buffer and can single step using @kbd{SPC} and
26712 evaluate expressions using @kbd{M-:} or inspect variables using
26713 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
26714 @kbd{c} or @kbd{g}.
26719 Sometimes, a problem do not directly generate an elisp error but
26720 manifests itself by causing Gnus to be very slow. In these cases, you
26721 can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are
26722 slow, and then try to analyze the backtrace (repeating the procedure
26723 helps isolating the real problem areas).
26725 A fancier approach is to use the elisp profiler, ELP. The profiler is
26726 (or should be) fully documented elsewhere, but to get you started
26727 there are a few steps that need to be followed. First, instrument the
26728 part of Gnus you are interested in for profiling, e.g. @kbd{M-x
26729 elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package
26730 RET message}. Then perform the operation that is slow and press
26731 @kbd{M-x elp-results}. You will then see which operations that takes
26732 time, and can debug them further. If the entire operation takes much
26733 longer than the time spent in the slowest function in the profiler
26734 output, you probably profiled the wrong part of Gnus. To reset
26735 profiling statistics, use @kbd{M-x elp-reset-all}. @kbd{M-x
26736 elp-restore-all} is supposed to remove profiling, but given the
26737 complexities and dynamic code generation in Gnus, it might not always
26740 @cindex gnu.emacs.gnus
26741 @cindex ding mailing list
26742 If you just need help, you are better off asking on
26743 @samp{gnu.emacs.gnus}. I'm not very helpful. You can also ask on
26744 @email{ding@@gnus.org, the ding mailing list}. Write to
26745 @email{ding-request@@gnus.org} to subscribe.
26749 @node Gnus Reference Guide
26750 @section Gnus Reference Guide
26752 It is my hope that other people will figure out smart stuff that Gnus
26753 can do, and that other people will write those smart things as well. To
26754 facilitate that I thought it would be a good idea to describe the inner
26755 workings of Gnus. And some of the not-so-inner workings, while I'm at
26758 You can never expect the internals of a program not to change, but I
26759 will be defining (in some details) the interface between Gnus and its
26760 back ends (this is written in stone), the format of the score files
26761 (ditto), data structures (some are less likely to change than others)
26762 and general methods of operation.
26765 * Gnus Utility Functions:: Common functions and variable to use.
26766 * Back End Interface:: How Gnus communicates with the servers.
26767 * Score File Syntax:: A BNF definition of the score file standard.
26768 * Headers:: How Gnus stores headers internally.
26769 * Ranges:: A handy format for storing mucho numbers.
26770 * Group Info:: The group info format.
26771 * Extended Interactive:: Symbolic prefixes and stuff.
26772 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
26773 * Various File Formats:: Formats of files that Gnus use.
26777 @node Gnus Utility Functions
26778 @subsection Gnus Utility Functions
26779 @cindex Gnus utility functions
26780 @cindex utility functions
26782 @cindex internal variables
26784 When writing small functions to be run from hooks (and stuff), it's
26785 vital to have access to the Gnus internal functions and variables.
26786 Below is a list of the most common ones.
26790 @item gnus-newsgroup-name
26791 @vindex gnus-newsgroup-name
26792 This variable holds the name of the current newsgroup.
26794 @item gnus-find-method-for-group
26795 @findex gnus-find-method-for-group
26796 A function that returns the select method for @var{group}.
26798 @item gnus-group-real-name
26799 @findex gnus-group-real-name
26800 Takes a full (prefixed) Gnus group name, and returns the unprefixed
26803 @item gnus-group-prefixed-name
26804 @findex gnus-group-prefixed-name
26805 Takes an unprefixed group name and a select method, and returns the full
26806 (prefixed) Gnus group name.
26808 @item gnus-get-info
26809 @findex gnus-get-info
26810 Returns the group info list for @var{group}.
26812 @item gnus-group-unread
26813 @findex gnus-group-unread
26814 The number of unread articles in @var{group}, or @code{t} if that is
26818 @findex gnus-active
26819 The active entry for @var{group}.
26821 @item gnus-set-active
26822 @findex gnus-set-active
26823 Set the active entry for @var{group}.
26825 @item gnus-add-current-to-buffer-list
26826 @findex gnus-add-current-to-buffer-list
26827 Adds the current buffer to the list of buffers to be killed on Gnus
26830 @item gnus-continuum-version
26831 @findex gnus-continuum-version
26832 Takes a Gnus version string as a parameter and returns a floating point
26833 number. Earlier versions will always get a lower number than later
26836 @item gnus-group-read-only-p
26837 @findex gnus-group-read-only-p
26838 Says whether @var{group} is read-only or not.
26840 @item gnus-news-group-p
26841 @findex gnus-news-group-p
26842 Says whether @var{group} came from a news back end.
26844 @item gnus-ephemeral-group-p
26845 @findex gnus-ephemeral-group-p
26846 Says whether @var{group} is ephemeral or not.
26848 @item gnus-server-to-method
26849 @findex gnus-server-to-method
26850 Returns the select method corresponding to @var{server}.
26852 @item gnus-server-equal
26853 @findex gnus-server-equal
26854 Says whether two virtual servers are equal.
26856 @item gnus-group-native-p
26857 @findex gnus-group-native-p
26858 Says whether @var{group} is native or not.
26860 @item gnus-group-secondary-p
26861 @findex gnus-group-secondary-p
26862 Says whether @var{group} is secondary or not.
26864 @item gnus-group-foreign-p
26865 @findex gnus-group-foreign-p
26866 Says whether @var{group} is foreign or not.
26868 @item gnus-group-find-parameter
26869 @findex gnus-group-find-parameter
26870 Returns the parameter list of @var{group}. If given a second parameter,
26871 returns the value of that parameter for @var{group}.
26873 @item gnus-group-set-parameter
26874 @findex gnus-group-set-parameter
26875 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
26877 @item gnus-narrow-to-body
26878 @findex gnus-narrow-to-body
26879 Narrows the current buffer to the body of the article.
26881 @item gnus-check-backend-function
26882 @findex gnus-check-backend-function
26883 Takes two parameters, @var{function} and @var{group}. If the back end
26884 @var{group} comes from supports @var{function}, return non-@code{nil}.
26887 (gnus-check-backend-function "request-scan" "nnml:misc")
26891 @item gnus-read-method
26892 @findex gnus-read-method
26893 Prompts the user for a select method.
26898 @node Back End Interface
26899 @subsection Back End Interface
26901 Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual
26902 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
26903 server is a @dfn{back end} and some @dfn{back end variables}. As examples
26904 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
26905 examples of the latter we have @code{nntp-port-number} and
26906 @code{nnmbox-directory}.
26908 When Gnus asks for information from a back end---say @code{nntp}---on
26909 something, it will normally include a virtual server name in the
26910 function parameters. (If not, the back end should use the ``current''
26911 virtual server.) For instance, @code{nntp-request-list} takes a virtual
26912 server as its only (optional) parameter. If this virtual server hasn't
26913 been opened, the function should fail.
26915 Note that a virtual server name has no relation to some physical server
26916 name. Take this example:
26920 (nntp-address "ifi.uio.no")
26921 (nntp-port-number 4324))
26924 Here the virtual server name is @samp{odd-one} while the name of
26925 the physical server is @samp{ifi.uio.no}.
26927 The back ends should be able to switch between several virtual servers.
26928 The standard back ends implement this by keeping an alist of virtual
26929 server environments that they pull down/push up when needed.
26931 There are two groups of interface functions: @dfn{required functions},
26932 which must be present, and @dfn{optional functions}, which Gnus will
26933 always check for presence before attempting to call 'em.
26935 All these functions are expected to return data in the buffer
26936 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
26937 unfortunately named, but we'll have to live with it. When I talk about
26938 @dfn{resulting data}, I always refer to the data in that buffer. When I
26939 talk about @dfn{return value}, I talk about the function value returned by
26940 the function call. Functions that fail should return @code{nil} as the
26943 Some back ends could be said to be @dfn{server-forming} back ends, and
26944 some might be said not to be. The latter are back ends that generally
26945 only operate on one group at a time, and have no concept of ``server''
26946 ---they have a group, and they deliver info on that group and nothing
26949 Gnus identifies each message by way of group name and article number. A
26950 few remarks about these article numbers might be useful. First of all,
26951 the numbers are positive integers. Secondly, it is normally not
26952 possible for later articles to ``re-use'' older article numbers without
26953 confusing Gnus. That is, if a group has ever contained a message
26954 numbered 42, then no other message may get that number, or Gnus will get
26955 mightily confused.@footnote{See the function
26956 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
26957 Third, article numbers must be assigned in order of arrival in the
26958 group; this is not necessarily the same as the date of the message.
26960 The previous paragraph already mentions all the ``hard'' restrictions that
26961 article numbers must fulfill. But it seems that it might be useful to
26962 assign @emph{consecutive} article numbers, for Gnus gets quite confused
26963 if there are holes in the article numbering sequence. However, due to
26964 the ``no-reuse'' restriction, holes cannot be avoided altogether. It's
26965 also useful for the article numbers to start at 1 to avoid running out
26966 of numbers as long as possible.
26968 Note that by convention, back ends are named @code{nnsomething}, but
26969 Gnus also comes with some @code{nnnotbackends}, such as
26970 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
26972 In the examples and definitions I will refer to the imaginary back end
26975 @cindex @code{nnchoke}
26978 * Required Back End Functions:: Functions that must be implemented.
26979 * Optional Back End Functions:: Functions that need not be implemented.
26980 * Error Messaging:: How to get messages and report errors.
26981 * Writing New Back Ends:: Extending old back ends.
26982 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
26983 * Mail-like Back Ends:: Some tips on mail back ends.
26987 @node Required Back End Functions
26988 @subsubsection Required Back End Functions
26992 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
26994 @var{articles} is either a range of article numbers or a list of
26995 @code{Message-ID}s. Current back ends do not fully support either---only
26996 sequences (lists) of article numbers, and most back ends do not support
26997 retrieval of @code{Message-ID}s. But they should try for both.
26999 The result data should either be HEADs or @acronym{NOV} lines, and the result
27000 value should either be @code{headers} or @code{nov} to reflect this.
27001 This might later be expanded to @code{various}, which will be a mixture
27002 of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus.
27004 If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra
27005 headers'', in some meaning of the word. This is generally done by
27006 fetching (at most) @var{fetch-old} extra headers less than the smallest
27007 article number in @code{articles}, and filling the gaps as well. The
27008 presence of this parameter can be ignored if the back end finds it
27009 cumbersome to follow the request. If this is non-@code{nil} and not a
27010 number, do maximum fetches.
27012 Here's an example HEAD:
27015 221 1056 Article retrieved.
27016 Path: ifi.uio.no!sturles
27017 From: sturles@@ifi.uio.no (Sturle Sunde)
27018 Newsgroups: ifi.discussion
27019 Subject: Re: Something very droll
27020 Date: 27 Oct 1994 14:02:57 +0100
27021 Organization: Dept. of Informatics, University of Oslo, Norway
27023 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
27024 References: <38jdmq$4qu@@visbur.ifi.uio.no>
27025 NNTP-Posting-Host: holmenkollen.ifi.uio.no
27029 So a @code{headers} return value would imply that there's a number of
27030 these in the data buffer.
27032 Here's a BNF definition of such a buffer:
27036 head = error / valid-head
27037 error-message = [ "4" / "5" ] 2number " " <error message> eol
27038 valid-head = valid-message *header "." eol
27039 valid-message = "221 " <number> " Article retrieved." eol
27040 header = <text> eol
27044 (The version of BNF used here is the one used in RFC822.)
27046 If the return value is @code{nov}, the data buffer should contain
27047 @dfn{network overview database} lines. These are basically fields
27051 nov-buffer = *nov-line
27052 nov-line = field 7*8[ <TAB> field ] eol
27053 field = <text except TAB>
27056 For a closer look at what should be in those fields,
27060 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
27062 @var{server} is here the virtual server name. @var{definitions} is a
27063 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
27065 If the server can't be opened, no error should be signaled. The back end
27066 may then choose to refuse further attempts at connecting to this
27067 server. In fact, it should do so.
27069 If the server is opened already, this function should return a
27070 non-@code{nil} value. There should be no data returned.
27073 @item (nnchoke-close-server &optional SERVER)
27075 Close connection to @var{server} and free all resources connected
27076 to it. Return @code{nil} if the server couldn't be closed for some
27079 There should be no data returned.
27082 @item (nnchoke-request-close)
27084 Close connection to all servers and free all resources that the back end
27085 have reserved. All buffers that have been created by that back end
27086 should be killed. (Not the @code{nntp-server-buffer}, though.) This
27087 function is generally only called when Gnus is shutting down.
27089 There should be no data returned.
27092 @item (nnchoke-server-opened &optional SERVER)
27094 If @var{server} is the current virtual server, and the connection to the
27095 physical server is alive, then this function should return a
27096 non-@code{nil} value. This function should under no circumstances
27097 attempt to reconnect to a server we have lost connection to.
27099 There should be no data returned.
27102 @item (nnchoke-status-message &optional SERVER)
27104 This function should return the last error message from @var{server}.
27106 There should be no data returned.
27109 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
27111 The result data from this function should be the article specified by
27112 @var{article}. This might either be a @code{Message-ID} or a number.
27113 It is optional whether to implement retrieval by @code{Message-ID}, but
27114 it would be nice if that were possible.
27116 If @var{to-buffer} is non-@code{nil}, the result data should be returned
27117 in this buffer instead of the normal data buffer. This is to make it
27118 possible to avoid copying large amounts of data from one buffer to
27119 another, while Gnus mainly requests articles to be inserted directly
27120 into its article buffer.
27122 If it is at all possible, this function should return a cons cell where
27123 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
27124 the article number. This will enable Gnus to find out what the real
27125 group and article numbers are when fetching articles by
27126 @code{Message-ID}. If this isn't possible, @code{t} should be returned
27127 on successful article retrieval.
27130 @item (nnchoke-request-group GROUP &optional SERVER FAST)
27132 Get data on @var{group}. This function also has the side effect of
27133 making @var{group} the current group.
27135 If @var{fast}, don't bother to return useful data, just make @var{group}
27138 Here's an example of some result data and a definition of the same:
27141 211 56 1000 1059 ifi.discussion
27144 The first number is the status, which should be 211. Next is the
27145 total number of articles in the group, the lowest article number, the
27146 highest article number, and finally the group name. Note that the total
27147 number of articles may be less than one might think while just
27148 considering the highest and lowest article numbers, but some articles
27149 may have been canceled. Gnus just discards the total-number, so
27150 whether one should take the bother to generate it properly (if that is a
27151 problem) is left as an exercise to the reader. If the group contains no
27152 articles, the lowest article number should be reported as 1 and the
27156 group-status = [ error / info ] eol
27157 error = [ "4" / "5" ] 2<number> " " <Error message>
27158 info = "211 " 3* [ <number> " " ] <string>
27162 @item (nnchoke-close-group GROUP &optional SERVER)
27164 Close @var{group} and free any resources connected to it. This will be
27165 a no-op on most back ends.
27167 There should be no data returned.
27170 @item (nnchoke-request-list &optional SERVER)
27172 Return a list of all groups available on @var{server}. And that means
27175 Here's an example from a server that only carries two groups:
27178 ifi.test 0000002200 0000002000 y
27179 ifi.discussion 3324 3300 n
27182 On each line we have a group name, then the highest article number in
27183 that group, the lowest article number, and finally a flag. If the group
27184 contains no articles, the lowest article number should be reported as 1
27185 and the highest as 0.
27188 active-file = *active-line
27189 active-line = name " " <number> " " <number> " " flags eol
27191 flags = "n" / "y" / "m" / "x" / "j" / "=" name
27194 The flag says whether the group is read-only (@samp{n}), is moderated
27195 (@samp{m}), is dead (@samp{x}), is aliased to some other group
27196 (@samp{=other-group}) or none of the above (@samp{y}).
27199 @item (nnchoke-request-post &optional SERVER)
27201 This function should post the current buffer. It might return whether
27202 the posting was successful or not, but that's not required. If, for
27203 instance, the posting is done asynchronously, it has generally not been
27204 completed by the time this function concludes. In that case, this
27205 function should set up some kind of sentinel to beep the user loud and
27206 clear if the posting could not be completed.
27208 There should be no result data from this function.
27213 @node Optional Back End Functions
27214 @subsubsection Optional Back End Functions
27218 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
27220 @var{groups} is a list of groups, and this function should request data
27221 on all those groups. How it does it is of no concern to Gnus, but it
27222 should attempt to do this in a speedy fashion.
27224 The return value of this function can be either @code{active} or
27225 @code{group}, which says what the format of the result data is. The
27226 former is in the same format as the data from
27227 @code{nnchoke-request-list}, while the latter is a buffer full of lines
27228 in the same format as @code{nnchoke-request-group} gives.
27231 group-buffer = *active-line / *group-status
27235 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
27237 A Gnus group info (@pxref{Group Info}) is handed to the back end for
27238 alterations. This comes in handy if the back end really carries all
27239 the information (as is the case with virtual and imap groups). This
27240 function should destructively alter the info to suit its needs, and
27241 should return a non-@code{nil} value.
27243 There should be no result data from this function.
27246 @item (nnchoke-request-type GROUP &optional ARTICLE)
27248 When the user issues commands for ``sending news'' (@kbd{F} in the
27249 summary buffer, for instance), Gnus has to know whether the article the
27250 user is following up on is news or mail. This function should return
27251 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
27252 is mail and @code{unknown} if the type can't be decided. (The
27253 @var{article} parameter is necessary in @code{nnvirtual} groups which
27254 might very well combine mail groups and news groups.) Both @var{group}
27255 and @var{article} may be @code{nil}.
27257 There should be no result data from this function.
27260 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
27262 Set/remove/add marks on articles. Normally Gnus handles the article
27263 marks (such as read, ticked, expired etc) internally, and store them in
27264 @file{~/.newsrc.eld}. Some back ends (such as @acronym{IMAP}) however carry
27265 all information about the articles on the server, so Gnus need to
27266 propagate the mark information to the server.
27268 @var{action} is a list of mark setting requests, having this format:
27271 (RANGE ACTION MARK)
27274 @var{range} is a range of articles you wish to update marks on.
27275 @var{action} is @code{add} or @code{del}, used to add marks or remove
27276 marks (preserving all marks not mentioned). @var{mark} is a list of
27277 marks; where each mark is a symbol. Currently used marks are
27278 @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed},
27279 @code{dormant}, @code{save}, @code{download}, @code{unsend},
27280 @code{forward} and @code{recent}, but your back end should, if
27281 possible, not limit itself to these.
27283 Given contradictory actions, the last action in the list should be the
27284 effective one. That is, if your action contains a request to add the
27285 @code{tick} mark on article 1 and, later in the list, a request to
27286 remove the mark on the same article, the mark should in fact be removed.
27288 An example action list:
27291 (((5 12 30) 'del '(tick))
27292 ((10 . 90) 'add '(read expire))
27293 ((92 94) 'del '(read)))
27296 The function should return a range of articles it wasn't able to set the
27297 mark on (currently not used for anything).
27299 There should be no result data from this function.
27301 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
27303 If the user tries to set a mark that the back end doesn't like, this
27304 function may change the mark. Gnus will use whatever this function
27305 returns as the mark for @var{article} instead of the original
27306 @var{mark}. If the back end doesn't care, it must return the original
27307 @var{mark}, and not @code{nil} or any other type of garbage.
27309 The only use for this I can see is what @code{nnvirtual} does with
27310 it---if a component group is auto-expirable, marking an article as read
27311 in the virtual group should result in the article being marked as
27314 There should be no result data from this function.
27317 @item (nnchoke-request-scan &optional GROUP SERVER)
27319 This function may be called at any time (by Gnus or anything else) to
27320 request that the back end check for incoming articles, in one way or
27321 another. A mail back end will typically read the spool file or query
27322 the @acronym{POP} server when this function is invoked. The
27323 @var{group} doesn't have to be heeded---if the back end decides that
27324 it is too much work just scanning for a single group, it may do a
27325 total scan of all groups. It would be nice, however, to keep things
27326 local if that's practical.
27328 There should be no result data from this function.
27331 @item (nnchoke-request-group-description GROUP &optional SERVER)
27333 The result data from this function should be a description of
27337 description-line = name <TAB> description eol
27339 description = <text>
27342 @item (nnchoke-request-list-newsgroups &optional SERVER)
27344 The result data from this function should be the description of all
27345 groups available on the server.
27348 description-buffer = *description-line
27352 @item (nnchoke-request-newgroups DATE &optional SERVER)
27354 The result data from this function should be all groups that were
27355 created after @samp{date}, which is in normal human-readable date format
27356 (i.e., the date format used in mail and news headers, and returned by
27357 the function @code{message-make-date} by default). The data should be
27358 in the active buffer format.
27360 It is okay for this function to return ``too many'' groups; some back ends
27361 might find it cheaper to return the full list of groups, rather than
27362 just the new groups. But don't do this for back ends with many groups.
27363 Normally, if the user creates the groups herself, there won't be too
27364 many groups, so @code{nnml} and the like are probably safe. But for
27365 back ends like @code{nntp}, where the groups have been created by the
27366 server, it is quite likely that there can be many groups.
27369 @item (nnchoke-request-create-group GROUP &optional SERVER)
27371 This function should create an empty group with name @var{group}.
27373 There should be no return data.
27376 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
27378 This function should run the expiry process on all articles in the
27379 @var{articles} range (which is currently a simple list of article
27380 numbers.) It is left up to the back end to decide how old articles
27381 should be before they are removed by this function. If @var{force} is
27382 non-@code{nil}, all @var{articles} should be deleted, no matter how new
27385 This function should return a list of articles that it did not/was not
27388 There should be no result data returned.
27391 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST)
27393 This function should move @var{article} (which is a number) from
27394 @var{group} by calling @var{accept-form}.
27396 This function should ready the article in question for moving by
27397 removing any header lines it has added to the article, and generally
27398 should ``tidy up'' the article. Then it should @code{eval}
27399 @var{accept-form} in the buffer where the ``tidy'' article is. This
27400 will do the actual copying. If this @code{eval} returns a
27401 non-@code{nil} value, the article should be removed.
27403 If @var{last} is @code{nil}, that means that there is a high likelihood
27404 that there will be more requests issued shortly, so that allows some
27407 The function should return a cons where the @code{car} is the group name and
27408 the @code{cdr} is the article number that the article was entered as.
27410 The group should exist before the back end is asked to accept the
27411 article for that group.
27413 There should be no data returned.
27416 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
27418 This function takes the current buffer and inserts it into @var{group}.
27419 If @var{last} in @code{nil}, that means that there will be more calls to
27420 this function in short order.
27422 The function should return a cons where the @code{car} is the group name and
27423 the @code{cdr} is the article number that the article was entered as.
27425 There should be no data returned.
27428 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
27430 This function should remove @var{article} (which is a number) from
27431 @var{group} and insert @var{buffer} there instead.
27433 There should be no data returned.
27436 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
27438 This function should delete @var{group}. If @var{force}, it should
27439 really delete all the articles in the group, and then delete the group
27440 itself. (If there is such a thing as ``the group itself''.)
27442 There should be no data returned.
27445 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
27447 This function should rename @var{group} into @var{new-name}. All
27448 articles in @var{group} should move to @var{new-name}.
27450 There should be no data returned.
27455 @node Error Messaging
27456 @subsubsection Error Messaging
27458 @findex nnheader-report
27459 @findex nnheader-get-report
27460 The back ends should use the function @code{nnheader-report} to report
27461 error conditions---they should not raise errors when they aren't able to
27462 perform a request. The first argument to this function is the back end
27463 symbol, and the rest are interpreted as arguments to @code{format} if
27464 there are multiple of them, or just a string if there is one of them.
27465 This function must always returns @code{nil}.
27468 (nnheader-report 'nnchoke "You did something totally bogus")
27470 (nnheader-report 'nnchoke "Could not request group %s" group)
27473 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
27474 @code{nil} back from a server, and this function returns the most
27475 recently reported message for the back end in question. This function
27476 takes one argument---the server symbol.
27478 Internally, these functions access @var{back-end}@code{-status-string},
27479 so the @code{nnchoke} back end will have its error message stored in
27480 @code{nnchoke-status-string}.
27483 @node Writing New Back Ends
27484 @subsubsection Writing New Back Ends
27486 Many back ends are quite similar. @code{nnml} is just like
27487 @code{nnspool}, but it allows you to edit the articles on the server.
27488 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
27489 and it doesn't maintain overview databases. @code{nndir} is just like
27490 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
27493 It would make sense if it were possible to ``inherit'' functions from
27494 back ends when writing new back ends. And, indeed, you can do that if you
27495 want to. (You don't have to if you don't want to, of course.)
27497 All the back ends declare their public variables and functions by using a
27498 package called @code{nnoo}.
27500 To inherit functions from other back ends (and allow other back ends to
27501 inherit functions from the current back end), you should use the
27507 This macro declares the first parameter to be a child of the subsequent
27508 parameters. For instance:
27511 (nnoo-declare nndir
27515 @code{nndir} has declared here that it intends to inherit functions from
27516 both @code{nnml} and @code{nnmh}.
27519 This macro is equivalent to @code{defvar}, but registers the variable as
27520 a public server variable. Most state-oriented variables should be
27521 declared with @code{defvoo} instead of @code{defvar}.
27523 In addition to the normal @code{defvar} parameters, it takes a list of
27524 variables in the parent back ends to map the variable to when executing
27525 a function in those back ends.
27528 (defvoo nndir-directory nil
27529 "Where nndir will look for groups."
27530 nnml-current-directory nnmh-current-directory)
27533 This means that @code{nnml-current-directory} will be set to
27534 @code{nndir-directory} when an @code{nnml} function is called on behalf
27535 of @code{nndir}. (The same with @code{nnmh}.)
27537 @item nnoo-define-basics
27538 This macro defines some common functions that almost all back ends should
27542 (nnoo-define-basics nndir)
27546 This macro is just like @code{defun} and takes the same parameters. In
27547 addition to doing the normal @code{defun} things, it registers the
27548 function as being public so that other back ends can inherit it.
27550 @item nnoo-map-functions
27551 This macro allows mapping of functions from the current back end to
27552 functions from the parent back ends.
27555 (nnoo-map-functions nndir
27556 (nnml-retrieve-headers 0 nndir-current-group 0 0)
27557 (nnmh-request-article 0 nndir-current-group 0 0))
27560 This means that when @code{nndir-retrieve-headers} is called, the first,
27561 third, and fourth parameters will be passed on to
27562 @code{nnml-retrieve-headers}, while the second parameter is set to the
27563 value of @code{nndir-current-group}.
27566 This macro allows importing functions from back ends. It should be the
27567 last thing in the source file, since it will only define functions that
27568 haven't already been defined.
27574 nnmh-request-newgroups)
27578 This means that calls to @code{nndir-request-list} should just be passed
27579 on to @code{nnmh-request-list}, while all public functions from
27580 @code{nnml} that haven't been defined in @code{nndir} yet should be
27585 Below is a slightly shortened version of the @code{nndir} back end.
27588 ;;; @r{nndir.el --- single directory newsgroup access for Gnus}
27589 ;; @r{Copyright (C) 1995,96 Free Software Foundation, Inc.}
27593 (require 'nnheader)
27597 (eval-when-compile (require 'cl))
27599 (nnoo-declare nndir
27602 (defvoo nndir-directory nil
27603 "Where nndir will look for groups."
27604 nnml-current-directory nnmh-current-directory)
27606 (defvoo nndir-nov-is-evil nil
27607 "*Non-nil means that nndir will never retrieve NOV headers."
27610 (defvoo nndir-current-group ""
27612 nnml-current-group nnmh-current-group)
27613 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
27614 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
27616 (defvoo nndir-status-string "" nil nnmh-status-string)
27617 (defconst nndir-version "nndir 1.0")
27619 ;;; @r{Interface functions.}
27621 (nnoo-define-basics nndir)
27623 (deffoo nndir-open-server (server &optional defs)
27624 (setq nndir-directory
27625 (or (cadr (assq 'nndir-directory defs))
27627 (unless (assq 'nndir-directory defs)
27628 (push `(nndir-directory ,server) defs))
27629 (push `(nndir-current-group
27630 ,(file-name-nondirectory
27631 (directory-file-name nndir-directory)))
27633 (push `(nndir-top-directory
27634 ,(file-name-directory (directory-file-name nndir-directory)))
27636 (nnoo-change-server 'nndir server defs))
27638 (nnoo-map-functions nndir
27639 (nnml-retrieve-headers 0 nndir-current-group 0 0)
27640 (nnmh-request-article 0 nndir-current-group 0 0)
27641 (nnmh-request-group nndir-current-group 0 0)
27642 (nnmh-close-group nndir-current-group 0))
27646 nnmh-status-message
27648 nnmh-request-newgroups))
27654 @node Hooking New Back Ends Into Gnus
27655 @subsubsection Hooking New Back Ends Into Gnus
27657 @vindex gnus-valid-select-methods
27658 @findex gnus-declare-backend
27659 Having Gnus start using your new back end is rather easy---you just
27660 declare it with the @code{gnus-declare-backend} functions. This will
27661 enter the back end into the @code{gnus-valid-select-methods} variable.
27663 @code{gnus-declare-backend} takes two parameters---the back end name and
27664 an arbitrary number of @dfn{abilities}.
27669 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
27672 The above line would then go in the @file{nnchoke.el} file.
27674 The abilities can be:
27678 This is a mailish back end---followups should (probably) go via mail.
27680 This is a newsish back end---followups should (probably) go via news.
27682 This back end supports both mail and news.
27684 This is neither a post nor mail back end---it's something completely
27687 It supports respooling---or rather, it is able to modify its source
27688 articles and groups.
27690 The name of the server should be in the virtual server name. This is
27691 true for almost all back ends.
27692 @item prompt-address
27693 The user should be prompted for an address when doing commands like
27694 @kbd{B} in the group buffer. This is true for back ends like
27695 @code{nntp}, but not @code{nnmbox}, for instance.
27699 @node Mail-like Back Ends
27700 @subsubsection Mail-like Back Ends
27702 One of the things that separate the mail back ends from the rest of the
27703 back ends is the heavy dependence by most of the mail back ends on
27704 common functions in @file{nnmail.el}. For instance, here's the
27705 definition of @code{nnml-request-scan}:
27708 (deffoo nnml-request-scan (&optional group server)
27709 (setq nnml-article-file-alist nil)
27710 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
27713 It simply calls @code{nnmail-get-new-mail} with a few parameters,
27714 and @code{nnmail} takes care of all the moving and splitting of the
27717 This function takes four parameters.
27721 This should be a symbol to designate which back end is responsible for
27724 @item exit-function
27725 This function should be called after the splitting has been performed.
27727 @item temp-directory
27728 Where the temporary files should be stored.
27731 This optional argument should be a group name if the splitting is to be
27732 performed for one group only.
27735 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
27736 save each article. @var{back-end}@code{-active-number} will be called to
27737 find the article number assigned to this article.
27739 The function also uses the following variables:
27740 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
27741 this back end); and @var{back-end}@code{-group-alist} and
27742 @var{back-end}@code{-active-file} to generate the new active file.
27743 @var{back-end}@code{-group-alist} should be a group-active alist, like
27747 (("a-group" (1 . 10))
27748 ("some-group" (34 . 39)))
27752 @node Score File Syntax
27753 @subsection Score File Syntax
27755 Score files are meant to be easily parseable, but yet extremely
27756 mallable. It was decided that something that had the same read syntax
27757 as an Emacs Lisp list would fit that spec.
27759 Here's a typical score file:
27763 ("win95" -10000 nil s)
27770 BNF definition of a score file:
27773 score-file = "" / "(" *element ")"
27774 element = rule / atom
27775 rule = string-rule / number-rule / date-rule
27776 string-rule = "(" quote string-header quote space *string-match ")"
27777 number-rule = "(" quote number-header quote space *number-match ")"
27778 date-rule = "(" quote date-header quote space *date-match ")"
27780 string-header = "subject" / "from" / "references" / "message-id" /
27781 "xref" / "body" / "head" / "all" / "followup"
27782 number-header = "lines" / "chars"
27783 date-header = "date"
27784 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
27785 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
27786 score = "nil" / <integer>
27787 date = "nil" / <natural number>
27788 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
27789 "r" / "regex" / "R" / "Regex" /
27790 "e" / "exact" / "E" / "Exact" /
27791 "f" / "fuzzy" / "F" / "Fuzzy"
27792 number-match = "(" <integer> [ "" / [ space score [ "" /
27793 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
27794 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
27795 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
27796 space date [ "" / [ space date-match-t ] ] ] ] ")"
27797 date-match-t = "nil" / "at" / "before" / "after"
27798 atom = "(" [ required-atom / optional-atom ] ")"
27799 required-atom = mark / expunge / mark-and-expunge / files /
27800 exclude-files / read-only / touched
27801 optional-atom = adapt / local / eval
27802 mark = "mark" space nil-or-number
27803 nil-or-number = "nil" / <integer>
27804 expunge = "expunge" space nil-or-number
27805 mark-and-expunge = "mark-and-expunge" space nil-or-number
27806 files = "files" *[ space <string> ]
27807 exclude-files = "exclude-files" *[ space <string> ]
27808 read-only = "read-only" [ space "nil" / space "t" ]
27809 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
27810 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
27811 local = "local" *[ space "(" <string> space <form> ")" ]
27812 eval = "eval" space <form>
27813 space = *[ " " / <TAB> / <NEWLINE> ]
27816 Any unrecognized elements in a score file should be ignored, but not
27819 As you can see, white space is needed, but the type and amount of white
27820 space is irrelevant. This means that formatting of the score file is
27821 left up to the programmer---if it's simpler to just spew it all out on
27822 one looong line, then that's ok.
27824 The meaning of the various atoms are explained elsewhere in this
27825 manual (@pxref{Score File Format}).
27829 @subsection Headers
27831 Internally Gnus uses a format for storing article headers that
27832 corresponds to the @acronym{NOV} format in a mysterious fashion. One could
27833 almost suspect that the author looked at the @acronym{NOV} specification and
27834 just shamelessly @emph{stole} the entire thing, and one would be right.
27836 @dfn{Header} is a severely overloaded term. ``Header'' is used in
27837 RFC 1036 to talk about lines in the head of an article (e.g.,
27838 @code{From}). It is used by many people as a synonym for
27839 ``head''---``the header and the body''. (That should be avoided, in my
27840 opinion.) And Gnus uses a format internally that it calls ``header'',
27841 which is what I'm talking about here. This is a 9-element vector,
27842 basically, with each header (ouch) having one slot.
27844 These slots are, in order: @code{number}, @code{subject}, @code{from},
27845 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
27846 @code{xref}, and @code{extra}. There are macros for accessing and
27847 setting these slots---they all have predictable names beginning with
27848 @code{mail-header-} and @code{mail-header-set-}, respectively.
27850 All these slots contain strings, except the @code{extra} slot, which
27851 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
27857 @sc{gnus} introduced a concept that I found so useful that I've started
27858 using it a lot and have elaborated on it greatly.
27860 The question is simple: If you have a large amount of objects that are
27861 identified by numbers (say, articles, to take a @emph{wild} example)
27862 that you want to qualify as being ``included'', a normal sequence isn't
27863 very useful. (A 200,000 length sequence is a bit long-winded.)
27865 The solution is as simple as the question: You just collapse the
27869 (1 2 3 4 5 6 10 11 12)
27872 is transformed into
27875 ((1 . 6) (10 . 12))
27878 To avoid having those nasty @samp{(13 . 13)} elements to denote a
27879 lonesome object, a @samp{13} is a valid element:
27882 ((1 . 6) 7 (10 . 12))
27885 This means that comparing two ranges to find out whether they are equal
27886 is slightly tricky:
27889 ((1 . 5) 7 8 (10 . 12))
27895 ((1 . 5) (7 . 8) (10 . 12))
27898 are equal. In fact, any non-descending list is a range:
27904 is a perfectly valid range, although a pretty long-winded one. This is
27911 and is equal to the previous range.
27913 Here's a BNF definition of ranges. Of course, one must remember the
27914 semantic requirement that the numbers are non-descending. (Any number
27915 of repetition of the same number is allowed, but apt to disappear in
27919 range = simple-range / normal-range
27920 simple-range = "(" number " . " number ")"
27921 normal-range = "(" start-contents ")"
27922 contents = "" / simple-range *[ " " contents ] /
27923 number *[ " " contents ]
27926 Gnus currently uses ranges to keep track of read articles and article
27927 marks. I plan on implementing a number of range operators in C if The
27928 Powers That Be are willing to let me. (I haven't asked yet, because I
27929 need to do some more thinking on what operators I need to make life
27930 totally range-based without ever having to convert back to normal
27935 @subsection Group Info
27937 Gnus stores all permanent info on groups in a @dfn{group info} list.
27938 This list is from three to six elements (or more) long and exhaustively
27939 describes the group.
27941 Here are two example group infos; one is a very simple group while the
27942 second is a more complex one:
27945 ("no.group" 5 ((1 . 54324)))
27947 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
27948 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
27950 ((auto-expire . t) (to-address . "ding@@gnus.org")))
27953 The first element is the @dfn{group name}---as Gnus knows the group,
27954 anyway. The second element is the @dfn{subscription level}, which
27955 normally is a small integer. (It can also be the @dfn{rank}, which is a
27956 cons cell where the @code{car} is the level and the @code{cdr} is the
27957 score.) The third element is a list of ranges of read articles. The
27958 fourth element is a list of lists of article marks of various kinds.
27959 The fifth element is the select method (or virtual server, if you like).
27960 The sixth element is a list of @dfn{group parameters}, which is what
27961 this section is about.
27963 Any of the last three elements may be missing if they are not required.
27964 In fact, the vast majority of groups will normally only have the first
27965 three elements, which saves quite a lot of cons cells.
27967 Here's a BNF definition of the group info format:
27970 info = "(" group space ralevel space read
27971 [ "" / [ space marks-list [ "" / [ space method [ "" /
27972 space parameters ] ] ] ] ] ")"
27973 group = quote <string> quote
27974 ralevel = rank / level
27975 level = <integer in the range of 1 to inf>
27976 rank = "(" level "." score ")"
27977 score = <integer in the range of 1 to inf>
27979 marks-lists = nil / "(" *marks ")"
27980 marks = "(" <string> range ")"
27981 method = "(" <string> *elisp-forms ")"
27982 parameters = "(" *elisp-forms ")"
27985 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
27986 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
27989 If you have a Gnus info and want to access the elements, Gnus offers a
27990 series of macros for getting/setting these elements.
27993 @item gnus-info-group
27994 @itemx gnus-info-set-group
27995 @findex gnus-info-group
27996 @findex gnus-info-set-group
27997 Get/set the group name.
27999 @item gnus-info-rank
28000 @itemx gnus-info-set-rank
28001 @findex gnus-info-rank
28002 @findex gnus-info-set-rank
28003 Get/set the group rank (@pxref{Group Score}).
28005 @item gnus-info-level
28006 @itemx gnus-info-set-level
28007 @findex gnus-info-level
28008 @findex gnus-info-set-level
28009 Get/set the group level.
28011 @item gnus-info-score
28012 @itemx gnus-info-set-score
28013 @findex gnus-info-score
28014 @findex gnus-info-set-score
28015 Get/set the group score (@pxref{Group Score}).
28017 @item gnus-info-read
28018 @itemx gnus-info-set-read
28019 @findex gnus-info-read
28020 @findex gnus-info-set-read
28021 Get/set the ranges of read articles.
28023 @item gnus-info-marks
28024 @itemx gnus-info-set-marks
28025 @findex gnus-info-marks
28026 @findex gnus-info-set-marks
28027 Get/set the lists of ranges of marked articles.
28029 @item gnus-info-method
28030 @itemx gnus-info-set-method
28031 @findex gnus-info-method
28032 @findex gnus-info-set-method
28033 Get/set the group select method.
28035 @item gnus-info-params
28036 @itemx gnus-info-set-params
28037 @findex gnus-info-params
28038 @findex gnus-info-set-params
28039 Get/set the group parameters.
28042 All the getter functions take one parameter---the info list. The setter
28043 functions take two parameters---the info list and the new value.
28045 The last three elements in the group info aren't mandatory, so it may be
28046 necessary to extend the group info before setting the element. If this
28047 is necessary, you can just pass on a non-@code{nil} third parameter to
28048 the three final setter functions to have this happen automatically.
28051 @node Extended Interactive
28052 @subsection Extended Interactive
28053 @cindex interactive
28054 @findex gnus-interactive
28056 Gnus extends the standard Emacs @code{interactive} specification
28057 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
28058 Prefixes}). Here's an example of how this is used:
28061 (defun gnus-summary-increase-score (&optional score symp)
28062 (interactive (gnus-interactive "P\ny"))
28067 The best thing to do would have been to implement
28068 @code{gnus-interactive} as a macro which would have returned an
28069 @code{interactive} form, but this isn't possible since Emacs checks
28070 whether a function is interactive or not by simply doing an @code{assq}
28071 on the lambda form. So, instead we have @code{gnus-interactive}
28072 function that takes a string and returns values that are usable to
28073 @code{interactive}.
28075 This function accepts (almost) all normal @code{interactive} specs, but
28080 @vindex gnus-current-prefix-symbol
28081 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
28085 @vindex gnus-current-prefix-symbols
28086 A list of the current symbolic prefixes---the
28087 @code{gnus-current-prefix-symbol} variable.
28090 The current article number---the @code{gnus-summary-article-number}
28094 The current article header---the @code{gnus-summary-article-header}
28098 The current group name---the @code{gnus-group-group-name}
28104 @node Emacs/XEmacs Code
28105 @subsection Emacs/XEmacs Code
28109 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
28110 platforms must be the primary one. I chose Emacs. Not because I don't
28111 like XEmacs or Mule, but because it comes first alphabetically.
28113 This means that Gnus will byte-compile under Emacs with nary a warning,
28114 while XEmacs will pump out gigabytes of warnings while byte-compiling.
28115 As I use byte-compilation warnings to help me root out trivial errors in
28116 Gnus, that's very useful.
28118 I've also consistently used Emacs function interfaces, but have used
28119 Gnusey aliases for the functions. To take an example: Emacs defines a
28120 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
28121 function. I then define a function called @code{gnus-run-at-time} that
28122 takes the same parameters as the Emacs @code{run-at-time}. When running
28123 Gnus under Emacs, the former function is just an alias for the latter.
28124 However, when running under XEmacs, the former is an alias for the
28125 following function:
28128 (defun gnus-xmas-run-at-time (time repeat function &rest args)
28132 (,function ,@@args))
28136 This sort of thing has been done for bunches of functions. Gnus does
28137 not redefine any native Emacs functions while running under XEmacs---it
28138 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
28141 In the cases where the XEmacs function interface was obviously cleaner,
28142 I used it instead. For example @code{gnus-region-active-p} is an alias
28143 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
28145 Of course, I could have chosen XEmacs as my native platform and done
28146 mapping functions the other way around. But I didn't. The performance
28147 hit these indirections impose on Gnus under XEmacs should be slight.
28150 @node Various File Formats
28151 @subsection Various File Formats
28154 * Active File Format:: Information on articles and groups available.
28155 * Newsgroups File Format:: Group descriptions.
28159 @node Active File Format
28160 @subsubsection Active File Format
28162 The active file lists all groups available on the server in
28163 question. It also lists the highest and lowest current article numbers
28166 Here's an excerpt from a typical active file:
28169 soc.motss 296030 293865 y
28170 alt.binaries.pictures.fractals 3922 3913 n
28171 comp.sources.unix 1605 1593 m
28172 comp.binaries.ibm.pc 5097 5089 y
28173 no.general 1000 900 y
28176 Here's a pseudo-BNF definition of this file:
28179 active = *group-line
28180 group-line = group spc high-number spc low-number spc flag <NEWLINE>
28181 group = <non-white-space string>
28183 high-number = <non-negative integer>
28184 low-number = <positive integer>
28185 flag = "y" / "n" / "m" / "j" / "x" / "=" group
28188 For a full description of this file, see the manual pages for
28189 @samp{innd}, in particular @samp{active(5)}.
28192 @node Newsgroups File Format
28193 @subsubsection Newsgroups File Format
28195 The newsgroups file lists groups along with their descriptions. Not all
28196 groups on the server have to be listed, and not all groups in the file
28197 have to exist on the server. The file is meant purely as information to
28200 The format is quite simple; a group name, a tab, and the description.
28201 Here's the definition:
28205 line = group tab description <NEWLINE>
28206 group = <non-white-space string>
28208 description = <string>
28213 @node Emacs for Heathens
28214 @section Emacs for Heathens
28216 Believe it or not, but some people who use Gnus haven't really used
28217 Emacs much before they embarked on their journey on the Gnus Love Boat.
28218 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
28219 region'', and ``set @code{gnus-flargblossen} to an alist where the key
28220 is a regexp that is used for matching on the group name'' are magical
28221 phrases with little or no meaning, then this appendix is for you. If
28222 you are already familiar with Emacs, just ignore this and go fondle your
28226 * Keystrokes:: Entering text and executing commands.
28227 * Emacs Lisp:: The built-in Emacs programming language.
28232 @subsection Keystrokes
28236 Q: What is an experienced Emacs user?
28239 A: A person who wishes that the terminal had pedals.
28242 Yes, when you use Emacs, you are apt to use the control key, the shift
28243 key and the meta key a lot. This is very annoying to some people
28244 (notably @code{vi}le users), and the rest of us just love the hell out
28245 of it. Just give up and submit. Emacs really does stand for
28246 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
28247 may have heard from other disreputable sources (like the Emacs author).
28249 The shift keys are normally located near your pinky fingers, and are
28250 normally used to get capital letters and stuff. You probably use it all
28251 the time. The control key is normally marked ``CTRL'' or something like
28252 that. The meta key is, funnily enough, never marked as such on any
28253 keyboard. The one I'm currently at has a key that's marked ``Alt'',
28254 which is the meta key on this keyboard. It's usually located somewhere
28255 to the left hand side of the keyboard, usually on the bottom row.
28257 Now, us Emacs people don't say ``press the meta-control-m key'',
28258 because that's just too inconvenient. We say ``press the @kbd{C-M-m}
28259 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
28260 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
28261 down the control key, and hold it down while you press @kbd{k}''.
28262 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
28263 the control key and then press @kbd{k}''. Simple, ay?
28265 This is somewhat complicated by the fact that not all keyboards have a
28266 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
28267 means ``press escape, release escape, press @kbd{k}''. That's much more
28268 work than if you have a meta key, so if that's the case, I respectfully
28269 suggest you get a real keyboard with a meta key. You can't live without
28275 @subsection Emacs Lisp
28277 Emacs is the King of Editors because it's really a Lisp interpreter.
28278 Each and every key you tap runs some Emacs Lisp code snippet, and since
28279 Emacs Lisp is an interpreted language, that means that you can configure
28280 any key to run any arbitrary code. You just, like, do it.
28282 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
28283 functions. (These are byte-compiled for speed, but it's still
28284 interpreted.) If you decide that you don't like the way Gnus does
28285 certain things, it's trivial to have it do something a different way.
28286 (Well, at least if you know how to write Lisp code.) However, that's
28287 beyond the scope of this manual, so we are simply going to talk about
28288 some common constructs that you normally use in your @file{.emacs} file
28291 If you want to set the variable @code{gnus-florgbnize} to four (4), you
28292 write the following:
28295 (setq gnus-florgbnize 4)
28298 This function (really ``special form'') @code{setq} is the one that can
28299 set a variable to some value. This is really all you need to know. Now
28300 you can go and fill your @file{.emacs} file with lots of these to change
28303 If you have put that thing in your @file{.emacs} file, it will be read
28304 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
28305 start Emacs. If you want to change the variable right away, simply say
28306 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
28307 previous ``form'', which is a simple @code{setq} statement here.
28309 Go ahead---just try it, if you're located at your Emacs. After you
28310 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
28311 is the return value of the form you @code{eval}ed.
28315 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
28319 (setq gnus-read-active-file 'some)
28322 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
28323 @samp{nntp.ifi.uio.no}'', that means:
28326 (setq gnus-nntp-server "nntp.ifi.uio.no")
28329 So be careful not to mix up strings (the latter) with symbols (the
28330 former). The manual is unambiguous, but it can be confusing.
28333 @include gnus-faq.texi
28353 @c Local Variables:
28355 @c coding: iso-8859-1