4 @settitle T-gnus 6.16 Manual
10 * Gnus: (gnus). The newsreader Gnus.
15 @setchapternewpage odd
19 \documentclass[twoside,a4paper,openright,11pt]{book}
20 \usepackage[latin1]{inputenc}
21 \usepackage{pagestyle}
24 \input{gnusconfig.tex}
26 \ifx\pdfoutput\undefined
28 \usepackage[pdftex,bookmarks,colorlinks=true]{hyperref}
36 \newcommand{\gnusversionname}{T-gnus v6.16}
37 \newcommand{\gnuschaptername}{}
38 \newcommand{\gnussectionname}{}
40 \newcommand{\gnusbackslash}{/}
42 \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}}
43 \ifx\pdfoutput\undefined
44 \newcommand{\gnusuref}[1]{\gnustt{#1}}
46 \newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}}
48 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
49 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
51 \newcommand{\gnuskindex}[1]{\index{#1}}
52 \newcommand{\gnusindex}[1]{\index{#1}}
54 \newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}}
55 \newcommand{\gnuscode}[1]{\gnustt{#1}}
56 \newcommand{\gnusasis}[1]{\gnustt{#1}}
57 \newcommand{\gnusurl}[1]{\gnustt{#1}}
58 \newcommand{\gnuscommand}[1]{\gnustt{#1}}
59 \newcommand{\gnusenv}[1]{\gnustt{#1}}
60 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''}
61 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
62 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
63 \newcommand{\gnuskey}[1]{`\gnustt{#1}'}
64 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
65 \newcommand{\gnusdfn}[1]{\textit{#1}}
66 \newcommand{\gnusi}[1]{\textit{#1}}
67 \newcommand{\gnusr}[1]{\textrm{#1}}
68 \newcommand{\gnusstrong}[1]{\textbf{#1}}
69 \newcommand{\gnusemph}[1]{\textit{#1}}
70 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
71 \newcommand{\gnussc}[1]{\textsc{#1}}
72 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
73 \newcommand{\gnusversion}[1]{{\small\textit{#1}}}
74 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
75 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
76 \newcommand{\gnusacronym}[1]{\textsc{#1}}
77 \newcommand{\gnusemail}[1]{\textit{#1}}
79 \newcommand{\gnusbullet}{{${\bullet}$}}
80 \newcommand{\gnusdollar}{\$}
81 \newcommand{\gnusampersand}{\&}
82 \newcommand{\gnuspercent}{\%}
83 \newcommand{\gnushash}{\#}
84 \newcommand{\gnushat}{\symbol{"5E}}
85 \newcommand{\gnusunderline}{\symbol{"5F}}
86 \newcommand{\gnusnot}{$\neg$}
87 \newcommand{\gnustilde}{\symbol{"7E}}
88 \newcommand{\gnusless}{{$<$}}
89 \newcommand{\gnusgreater}{{$>$}}
90 \newcommand{\gnusbraceleft}{{$>$}}
91 \newcommand{\gnusbraceright}{{$>$}}
93 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}}
94 \newcommand{\gnusinteresting}{
95 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
98 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
100 \newcommand{\gnuspagechapter}[1]{
104 \newdimen{\gnusdimen}
107 \newcommand{\gnuschapter}[2]{
109 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
111 \renewcommand{\gnussectionname}{}
112 \renewcommand{\gnuschaptername}{#2}
113 \thispagestyle{empty}
115 \begin{picture}(500,500)(0,0)
116 \put(480,350){\makebox(0,0)[tr]{#1}}
117 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
122 \newcommand{\gnusfigure}[3]{
124 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
131 \newcommand{\gnusicon}[1]{
132 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}}
135 \newcommand{\gnuspicon}[1]{
136 \margindex{\epsfig{figure=#1,width=2cm}}
139 \newcommand{\gnusxface}[2]{
140 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
143 \newcommand{\gnussmiley}[2]{
144 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
147 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
149 \newcommand{\gnussection}[1]{
150 \renewcommand{\gnussectionname}{#1}
154 \newenvironment{codelist}%
159 \newenvironment{asislist}%
164 \newenvironment{kbdlist}%
170 \newenvironment{dfnlist}%
175 \newenvironment{stronglist}%
180 \newenvironment{samplist}%
185 \newenvironment{varlist}%
190 \newenvironment{emphlist}%
195 \newlength\gnusheadtextwidth
196 \setlength{\gnusheadtextwidth}{\headtextwidth}
197 \addtolength{\gnusheadtextwidth}{1cm}
199 \newpagestyle{gnuspreamble}%
204 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
208 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
217 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
219 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
224 \newpagestyle{gnusindex}%
229 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
233 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
241 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
243 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
253 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
257 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
265 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
267 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
272 \pagenumbering{roman}
273 \pagestyle{gnuspreamble}
283 %\addtolength{\oddsidemargin}{-5cm}
284 %\addtolength{\evensidemargin}{-5cm}
286 \addtolength{\textheight}{2cm}
288 \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\
291 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm}
294 \gnusauthor{by Lars Magne Ingebrigtsen}
301 \thispagestyle{empty}
303 Copyright \copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001,
305 Free Software Foundation, Inc.
308 Permission is granted to copy, distribute and/or modify this document
309 under the terms of the GNU Free Documentation License, Version 1.1 or
310 any later version published by the Free Software Foundation; with no
311 Invariant Sections, with the Front-Cover texts being ``A GNU
312 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
313 license is included in the section entitled ``GNU Free Documentation
314 License'' in the Emacs manual.
316 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
317 this GNU Manual, like GNU software. Copies published by the Free
318 Software Foundation raise funds for GNU development.''
320 This document is part of a collection distributed under the GNU Free
321 Documentation License. If you want to distribute this document
322 separately from the collection, you can do so by adding a copy of the
323 license to the document, as described in section 6 of the license.
331 This file documents gnus, the GNU Emacs newsreader.
333 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
334 Free Software Foundation, Inc.
336 Permission is granted to copy, distribute and/or modify this document
337 under the terms of the GNU Free Documentation License, Version 1.1 or
338 any later version published by the Free Software Foundation; with the
339 Invariant Sections being none, with the Front-Cover texts being ``A GNU
340 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
341 license is included in the section entitled ``GNU Free Documentation
342 License'' in the Emacs manual.
344 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
345 this GNU Manual, like GNU software. Copies published by the Free
346 Software Foundation raise funds for GNU development.''
348 This document is part of a collection distributed under the GNU Free
349 Documentation License. If you want to distribute this document
350 separately from the collection, you can do so by adding a copy of the
351 license to the document, as described in section 6 of the license.
357 @title T-gnus 6.16 Manual
359 @author by Lars Magne Ingebrigtsen
362 @vskip 0pt plus 1filll
363 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001,
365 Free Software Foundation, Inc.
367 Permission is granted to copy, distribute and/or modify this document
368 under the terms of the GNU Free Documentation License, Version 1.1 or
369 any later version published by the Free Software Foundation; with no
370 Invariant Sections, with the Front-Cover texts being ``A GNU
371 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
372 license is included in the section entitled ``GNU Free Documentation
373 License'' in the Emacs manual.
375 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
376 this GNU Manual, like GNU software. Copies published by the Free
377 Software Foundation raise funds for GNU development.''
379 This document is part of a collection distributed under the GNU Free
380 Documentation License. If you want to distribute this document
381 separately from the collection, you can do so by adding a copy of the
382 license to the document, as described in section 6 of the license.
391 @top The gnus Newsreader
395 You can read news (and mail) from within Emacs by using T-gnus. The news
396 can be gotten by any nefarious means you can think of---@acronym{NNTP}, local
397 spool or your mbox file. All at the same time, if you want to push your
400 T-gnus provides @acronym{MIME} features based on @acronym{SEMI} API. So
401 T-gnus supports your right to read strange messages including big images
402 or other various kinds of formats. T-gnus also supports
403 internationalization/localization and multiscript features based on MULE
404 API. So T-gnus does not discriminate various language communities. Oh,
405 if you are a Klingon, please wait Unicode Next Generation.
407 This manual corresponds to T-gnus 6.16.
418 Gnus is the advanced, self-documenting, customizable, extensible
419 unreal-time newsreader for GNU Emacs.
421 Oops. That sounds oddly familiar, so let's start over again to avoid
422 being accused of plagiarism:
424 Gnus is a message-reading laboratory. It will let you look at just
425 about anything as if it were a newsgroup. You can read mail with it,
426 you can browse directories with it, you can @code{ftp} with it---you
427 can even read news with it!
429 Gnus tries to empower people who read news the same way Emacs empowers
430 people who edit text. Gnus sets no limits to what the user should be
431 allowed to do. Users are encouraged to extend gnus to make it behave
432 like they want it to behave. A program should not control people;
433 people should be empowered to do what they want by using (or abusing)
439 * Starting Up:: Finding news can be a pain.
440 * Group Buffer:: Selecting, subscribing and killing groups.
441 * Summary Buffer:: Reading, saving and posting articles.
442 * Article Buffer:: Displaying and handling articles.
443 * Composing Messages:: Information on sending mail and news.
444 * Select Methods:: Gnus reads all messages from various select methods.
445 * Scoring:: Assigning values to articles.
446 * Various:: General purpose settings.
447 * The End:: Farewell and goodbye.
448 * Appendices:: Terminology, Emacs intro, @acronym{FAQ}, History, Internals.
449 * Index:: Variable, function and concept index.
450 * Key Index:: Key Index.
452 Other related manuals
454 * Message:(message). Composing messages.
455 * Emacs-MIME:(emacs-mime). Composing messages; @acronym{MIME}-specific parts.
456 * Sieve:(sieve). Managing Sieve scripts in Emacs.
457 * PGG:(pgg). @acronym{PGP/MIME} with Gnus.
460 --- The Detailed Node Listing ---
464 * Finding the News:: Choosing a method for getting news.
465 * The First Time:: What does Gnus do the first time you start it?
466 * The Server is Down:: How can I read my mail then?
467 * Slave Gnusae:: You can have more than one Gnus active at a time.
468 * Fetching a Group:: Starting Gnus just to read a group.
469 * New Groups:: What is Gnus supposed to do with new groups?
470 * Changing Servers:: You may want to move from one server to another.
471 * Startup Files:: Those pesky startup files---@file{.newsrc}.
472 * Auto Save:: Recovering from a crash.
473 * The Active File:: Reading the active file over a slow line Takes Time.
474 * Startup Variables:: Other variables you might change.
478 * Checking New Groups:: Determining what groups are new.
479 * Subscription Methods:: What Gnus should do with new groups.
480 * Filtering New Groups:: Making Gnus ignore certain new groups.
484 * Group Buffer Format:: Information listed and how you can change it.
485 * Group Maneuvering:: Commands for moving in the group buffer.
486 * Selecting a Group:: Actually reading news.
487 * Subscription Commands:: Unsubscribing, killing, subscribing.
488 * Group Data:: Changing the info for a group.
489 * Group Levels:: Levels? What are those, then?
490 * Group Score:: A mechanism for finding out what groups you like.
491 * Marking Groups:: You can mark groups for later processing.
492 * Foreign Groups:: Creating and editing groups.
493 * Group Parameters:: Each group may have different parameters set.
494 * Listing Groups:: Gnus can list various subsets of the groups.
495 * Sorting Groups:: Re-arrange the group order.
496 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
497 * Browse Foreign Server:: You can browse a server. See what it has to offer.
498 * Exiting Gnus:: Stop reading news and get some work done.
499 * Group Topics:: A folding group mode divided into topics.
500 * Misc Group Stuff:: Other stuff that you can to do.
504 * Group Line Specification:: Deciding how the group buffer is to look.
505 * Group Mode Line Specification:: The group buffer mode line.
506 * Group Highlighting:: Having nice colors in the group buffer.
510 * Topic Commands:: Interactive E-Z commands.
511 * Topic Variables:: How to customize the topics the Lisp Way.
512 * Topic Sorting:: Sorting each topic individually.
513 * Topic Topology:: A map of the world.
514 * Topic Parameters:: Parameters that apply to all groups in a topic.
518 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
519 * Group Information:: Information and help on groups and Gnus.
520 * Group Timestamp:: Making Gnus keep track of when you last read a group.
521 * File Commands:: Reading and writing the Gnus files.
522 * Sieve Commands:: Managing Sieve scripts.
526 * Summary Buffer Format:: Deciding how the summary buffer is to look.
527 * Summary Maneuvering:: Moving around the summary buffer.
528 * Choosing Articles:: Reading articles.
529 * Paging the Article:: Scrolling the current article.
530 * Reply Followup and Post:: Posting articles.
531 * Delayed Articles:: Send articles at a later time.
532 * Marking Articles:: Marking articles as read, expirable, etc.
533 * Limiting:: You can limit the summary buffer.
534 * Threading:: How threads are made.
535 * Sorting the Summary Buffer:: How articles and threads are sorted.
536 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
537 * Article Caching:: You may store articles in a cache.
538 * Persistent Articles:: Making articles expiry-resistant.
539 * Article Backlog:: Having already read articles hang around.
540 * Saving Articles:: Ways of customizing article saving.
541 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
542 * Article Treatment:: The article buffer can be mangled at will.
543 * MIME Commands:: Doing MIMEy things with the articles.
544 * Charsets:: Character set issues.
545 * Article Commands:: Doing various things with the article buffer.
546 * Summary Sorting:: Sorting the summary buffer in various ways.
547 * Finding the Parent:: No child support? Get the parent.
548 * Alternative Approaches:: Reading using non-default summaries.
549 * Tree Display:: A more visual display of threads.
550 * Mail Group Commands:: Some commands can only be used in mail groups.
551 * Various Summary Stuff:: What didn't fit anywhere else.
552 * Exiting the Summary Buffer:: Returning to the Group buffer,
553 or reselecting the current group.
554 * Crosspost Handling:: How crossposted articles are dealt with.
555 * Duplicate Suppression:: An alternative when crosspost handling fails.
556 * Security:: Decrypt and Verify.
557 * Mailing List:: Mailing list minor mode.
559 Summary Buffer Format
561 * Summary Buffer Lines:: You can specify how summary lines should look.
562 * To From Newsgroups:: How to not display your own name.
563 * Summary Buffer Mode Line:: You can say how the mode line should look.
564 * Summary Highlighting:: Making the summary buffer all pretty and nice.
568 * Choosing Commands:: Commands for choosing articles.
569 * Choosing Variables:: Variables that influence these commands.
571 Reply, Followup and Post
573 * Summary Mail Commands:: Sending mail.
574 * Summary Post Commands:: Sending news.
575 * Summary Message Commands:: Other Message-related commands.
576 * Canceling and Superseding::
580 * Unread Articles:: Marks for unread articles.
581 * Read Articles:: Marks for read articles.
582 * Other Marks:: Marks that do not affect readedness.
583 * Setting Marks:: How to set and remove marks.
584 * Generic Marking Commands:: How to customize the marking.
585 * Setting Process Marks:: How to mark articles for later processing.
589 * Customizing Threading:: Variables you can change to affect the threading.
590 * Thread Commands:: Thread based commands in the summary buffer.
592 Customizing Threading
594 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
595 * Filling In Threads:: Making the threads displayed look fuller.
596 * More Threading:: Even more variables for fiddling with threads.
597 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
601 * Uuencoded Articles:: Uudecode articles.
602 * Shell Archives:: Unshar articles.
603 * PostScript Files:: Split PostScript.
604 * Other Files:: Plain save and binhex.
605 * Decoding Variables:: Variables for a happy decoding.
606 * Viewing Files:: You want to look at the result of the decoding?
610 * Rule Variables:: Variables that say how a file is to be viewed.
611 * Other Decode Variables:: Other decode variables.
612 * Uuencoding and Posting:: Variables for customizing uuencoding.
616 * Article Highlighting:: You want to make the article look like fruit salad.
617 * Article Fontisizing:: Making emphasized text look nice.
618 * Article Hiding:: You also want to make certain info go away.
619 * Article Washing:: Lots of way-neat functions to make life better.
620 * Article Header:: Doing various header transformations.
621 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
622 * Article Button Levels:: Controlling appearance of buttons.
623 * Article Date:: Grumble, UT!
624 * Article Display:: Display various stuff---X-Face, Picons, Smileys
625 * Article Signature:: What is a signature?
626 * Article Miscellanea:: Various other stuff.
628 Alternative Approaches
630 * Pick and Read:: First mark articles and then read them.
631 * Binary Groups:: Auto-decode all articles.
633 Various Summary Stuff
635 * Summary Group Information:: Information oriented commands.
636 * Searching for Articles:: Multiple article commands.
637 * Summary Generation Commands::
638 * Really Various Summary Commands:: Those pesky non-conformant commands.
642 * Hiding Headers:: Deciding what headers should be displayed.
643 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
644 * Customizing Articles:: Tailoring the look of the articles.
645 * Article Keymap:: Keystrokes available in the article buffer.
646 * Misc Article:: Other stuff.
650 * Mail:: Mailing and replying.
651 * Posting Server:: What server should you post and mail via?
652 * Mail and Post:: Mailing and posting at the same time.
653 * Archived Messages:: Where Gnus stores the messages you've sent.
654 * Posting Styles:: An easier way to specify who you are.
655 * Drafts:: Postponing messages and rejected messages.
656 * Rejected Articles:: What happens if the server doesn't like your article?
657 * Signing and encrypting:: How to compose secure messages.
661 * Server Buffer:: Making and editing virtual servers.
662 * Getting News:: Reading USENET news with Gnus.
663 * Getting Mail:: Reading your personal mail with Gnus.
664 * Browsing the Web:: Getting messages from a plethora of Web sources.
665 * IMAP:: Using Gnus as a @acronym{IMAP} client.
666 * Other Sources:: Reading directories, files, SOUP packets.
667 * Combined Groups:: Combining groups into one group.
668 * Gnus Unplugged:: Reading news and mail offline.
672 * Server Buffer Format:: You can customize the look of this buffer.
673 * Server Commands:: Commands to manipulate servers.
674 * Example Methods:: Examples server specifications.
675 * Creating a Virtual Server:: An example session.
676 * Server Variables:: Which variables to set.
677 * Servers and Methods:: You can use server names as select methods.
678 * Unavailable Servers:: Some servers you try to contact may be down.
682 * NNTP:: Reading news from an @acronym{NNTP} server.
683 * News Spool:: Reading news from the local spool.
687 * Direct Functions:: Connecting directly to the server.
688 * Indirect Functions:: Connecting indirectly to the server.
689 * Common Variables:: Understood by several connection functions.
693 * Mail in a Newsreader:: Important introductory notes.
694 * Getting Started Reading Mail:: A simple cookbook example.
695 * Splitting Mail:: How to create mail groups.
696 * Mail Sources:: How to tell Gnus where to get mail from.
697 * Mail Back End Variables:: Variables for customizing mail handling.
698 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
699 * Group Mail Splitting:: Use group customize to drive mail splitting.
700 * Incorporating Old Mail:: What about the old mail you have?
701 * Expiring Mail:: Getting rid of unwanted mail.
702 * Washing Mail:: Removing cruft from the mail you get.
703 * Duplicates:: Dealing with duplicated mail.
704 * Not Reading Mail:: Using mail back ends for reading other files.
705 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
709 * Mail Source Specifiers:: How to specify what a mail source is.
710 * Mail Source Customization:: Some variables that influence things.
711 * Fetching Mail:: Using the mail source specifiers.
713 Choosing a Mail Back End
715 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
716 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
717 * Mail Spool:: Store your mail in a private spool?
718 * MH Spool:: An mhspool-like back end.
719 * Maildir:: Another one-file-per-message format.
720 * Mail Folders:: Having one file for each group.
721 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
726 * Web Searches:: Creating groups from articles that match a string.
727 * Slashdot:: Reading the Slashdot comments.
728 * Ultimate:: The Ultimate Bulletin Board systems.
729 * Web Archive:: Reading mailing list archived on web.
730 * RSS:: Reading RDF site summary.
731 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
735 * Splitting in IMAP:: Splitting mail with nnimap.
736 * Expiring in IMAP:: Expiring mail with nnimap.
737 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
738 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
739 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
740 * Debugging IMAP:: What to do when things don't work.
744 * Directory Groups:: You can read a directory as if it was a newsgroup.
745 * Anything Groups:: Dired? Who needs dired?
746 * Document Groups:: Single files can be the basis of a group.
747 * SOUP:: Reading @sc{soup} packets ``offline''.
748 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
752 * Document Server Internals:: How to add your own document types.
756 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
757 * SOUP Groups:: A back end for reading @sc{soup} packets.
758 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
762 * Virtual Groups:: Combining articles from many groups.
763 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
767 * Agent Basics:: How it all is supposed to work.
768 * Agent Categories:: How to tell the Gnus Agent what to download.
769 * Agent Commands:: New commands for all the buffers.
770 * Agent Visuals:: Ways that the agent may effect your summary buffer.
771 * Agent as Cache:: The Agent is a big cache too.
772 * Agent Expiry:: How to make old articles go away.
773 * Agent Regeneration:: How to recover from lost connections and other accidents.
774 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
775 * Outgoing Messages:: What happens when you post/mail something?
776 * Agent Variables:: Customizing is fun.
777 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
778 * Batching Agents:: How to fetch news from a @code{cron} job.
779 * Agent Caveats:: What you think it'll do and what it does.
783 * Category Syntax:: What a category looks like.
784 * Category Buffer:: A buffer for maintaining categories.
785 * Category Variables:: Customize'r'Us.
789 * Group Agent Commands:: Configure groups and fetch their contents.
790 * Summary Agent Commands:: Manually select then fetch specific articles.
791 * Server Agent Commands:: Select the servers that are supported by the agent.
795 * Summary Score Commands:: Adding score entries for the current group.
796 * Group Score Commands:: General score commands.
797 * Score Variables:: Customize your scoring. (My, what terminology).
798 * Score File Format:: What a score file may contain.
799 * Score File Editing:: You can edit score files by hand as well.
800 * Adaptive Scoring:: Big Sister Gnus knows what you read.
801 * Home Score File:: How to say where new score entries are to go.
802 * Followups To Yourself:: Having Gnus notice when people answer you.
803 * Scoring On Other Headers:: Scoring on non-standard headers.
804 * Scoring Tips:: How to score effectively.
805 * Reverse Scoring:: That problem child of old is not problem.
806 * Global Score Files:: Earth-spanning, ear-splitting score files.
807 * Kill Files:: They are still here, but they can be ignored.
808 * Converting Kill Files:: Translating kill files to score files.
809 * GroupLens:: Getting predictions on what you like to read.
810 * Advanced Scoring:: Using logical expressions to build score rules.
811 * Score Decays:: It can be useful to let scores wither away.
815 * Using GroupLens:: How to make Gnus use GroupLens.
816 * Rating Articles:: Letting GroupLens know how you rate articles.
817 * Displaying Predictions:: Displaying predictions given by GroupLens.
818 * GroupLens Variables:: Customizing GroupLens.
822 * Advanced Scoring Syntax:: A definition.
823 * Advanced Scoring Examples:: What they look like.
824 * Advanced Scoring Tips:: Getting the most out of it.
828 * Process/Prefix:: A convention used by many treatment commands.
829 * Interactive:: Making Gnus ask you many questions.
830 * Symbolic Prefixes:: How to supply some Gnus functions with options.
831 * Formatting Variables:: You can specify what buffers should look like.
832 * Window Layout:: Configuring the Gnus buffer windows.
833 * Faces and Fonts:: How to change how faces look.
834 * Compilation:: How to speed Gnus up.
835 * Mode Lines:: Displaying information in the mode lines.
836 * Highlighting and Menus:: Making buffers look all nice and cozy.
837 * Buttons:: Get tendinitis in ten easy steps!
838 * Daemons:: Gnus can do things behind your back.
839 * NoCeM:: How to avoid spam and other fatty foods.
840 * Undo:: Some actions can be undone.
841 * Predicate Specifiers:: Specifying predicates.
842 * Moderation:: What to do if you're a moderator.
843 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
844 * Fuzzy Matching:: What's the big fuzz?
845 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
846 * Various Various:: Things that are really various.
850 * Formatting Basics:: A formatting variable is basically a format string.
851 * Mode Line Formatting:: Some rules about mode line formatting variables.
852 * Advanced Formatting:: Modifying output in various ways.
853 * User-Defined Specs:: Having Gnus call your own functions.
854 * Formatting Fonts:: Making the formatting look colorful and nice.
855 * Positioning Point:: Moving point to a position after an operation.
856 * Tabulation:: Tabulating your output.
857 * Wide Characters:: Dealing with wide characters.
861 * X-Face:: Display a funky, teensy black-and-white image.
862 * Face:: Display a funkier, teensier colored image.
863 * Smileys:: Show all those happy faces the way they were meant to be shown.
864 * Picons:: How to display pictures of what you're reading.
865 * XVarious:: Other XEmacsy Gnusey variables.
869 * The problem of spam:: Some background, and some solutions
870 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
871 * SpamAssassin:: How to use external anti-spam tools.
872 * Hashcash:: Reduce spam by burning CPU time.
873 * Filtering Spam Using The Spam ELisp Package::
874 * Filtering Spam Using Statistics with spam-stat::
876 Filtering Spam Using The Spam ELisp Package
878 * Blacklists and Whitelists::
880 * Gmane Spam Reporting::
881 * Anti-spam Hashcash Payments::
883 * Regular Expressions Header Matching::
885 * ifile spam filtering::
886 * spam-stat spam filtering::
888 * Extending the spam elisp package::
890 Filtering Spam Using Statistics with spam-stat
892 * Creating a spam-stat dictionary::
893 * Splitting mail using spam-stat::
894 * Low-level interface to the spam-stat dictionary::
898 * XEmacs:: Requirements for installing under XEmacs.
899 * History:: How Gnus got where it is today.
900 * On Writing Manuals:: Why this is not a beginner's guide.
901 * Terminology:: We use really difficult, like, words here.
902 * Customization:: Tailoring Gnus to your needs.
903 * Troubleshooting:: What you might try if things do not work.
904 * Gnus Reference Guide:: Rilly, rilly technical stuff.
905 * Emacs for Heathens:: A short introduction to Emacsian terms.
906 * Frequently Asked Questions:: The Gnus FAQ.
910 * Gnus Versions:: What Gnus versions have been released.
911 * Other Gnus Versions:: Other Gnus versions that also have been released.
912 * Why?:: What's the point of Gnus?
913 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
914 * Conformity:: Gnus tries to conform to all standards.
915 * Emacsen:: Gnus can be run on a few modern Emacsen.
916 * Gnus Development:: How Gnus is developed.
917 * Contributors:: Oodles of people.
918 * New Features:: Pointers to some of the new stuff in Gnus.
922 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
923 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
924 * Red Gnus:: Third time best---Gnus 5.4/5.5.
925 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
926 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
927 * Oort Gnus:: It's big. It's far out. Gnus 5.10.
931 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
932 * Slow Terminal Connection:: You run a remote Emacs.
933 * Little Disk Space:: You feel that having large setup files is icky.
934 * Slow Machine:: You feel like buying a faster machine.
938 * Gnus Utility Functions:: Common functions and variable to use.
939 * Back End Interface:: How Gnus communicates with the servers.
940 * Score File Syntax:: A BNF definition of the score file standard.
941 * Headers:: How Gnus stores headers internally.
942 * Ranges:: A handy format for storing mucho numbers.
943 * Group Info:: The group info format.
944 * Extended Interactive:: Symbolic prefixes and stuff.
945 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
946 * Various File Formats:: Formats of files that Gnus use.
950 * Required Back End Functions:: Functions that must be implemented.
951 * Optional Back End Functions:: Functions that need not be implemented.
952 * Error Messaging:: How to get messages and report errors.
953 * Writing New Back Ends:: Extending old back ends.
954 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
955 * Mail-like Back Ends:: Some tips on mail back ends.
959 * Active File Format:: Information on articles and groups available.
960 * Newsgroups File Format:: Group descriptions.
964 * Keystrokes:: Entering text and executing commands.
965 * Emacs Lisp:: The built-in Emacs programming language.
971 @chapter Starting gnus
976 If your system administrator has set things up properly, starting gnus
977 and reading news is extremely easy---you just type @kbd{M-x gnus} in
980 @findex gnus-other-frame
981 @kindex M-x gnus-other-frame
982 If you want to start gnus in a different frame, you can use the command
983 @kbd{M-x gnus-other-frame} instead.
985 If things do not go smoothly at startup, you have to twiddle some
986 variables in your @file{~/.gnus.el} file. This file is similar to
987 @file{~/.emacs}, but is read when Gnus starts.
989 If you puzzle at any terms used in this manual, please refer to the
990 terminology section (@pxref{Terminology}).
993 * Finding the News:: Choosing a method for getting news.
994 * The First Time:: What does Gnus do the first time you start it?
995 * The Server is Down:: How can I read my mail then?
996 * Slave Gnusae:: You can have more than one Gnus active at a time.
997 * Fetching a Group:: Starting Gnus just to read a group.
998 * New Groups:: What is Gnus supposed to do with new groups?
999 * Changing Servers:: You may want to move from one server to another.
1000 * Startup Files:: Those pesky startup files---@file{.newsrc}.
1001 * Auto Save:: Recovering from a crash.
1002 * The Active File:: Reading the active file over a slow line Takes Time.
1003 * Startup Variables:: Other variables you might change.
1007 @node Finding the News
1008 @section Finding the News
1009 @cindex finding news
1011 @vindex gnus-select-method
1013 The @code{gnus-select-method} variable says where gnus should look for
1014 news. This variable should be a list where the first element says
1015 @dfn{how} and the second element says @dfn{where}. This method is your
1016 native method. All groups not fetched with this method are
1019 For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where
1020 you want to get your daily dosage of news from, you'd say:
1023 (setq gnus-select-method '(nntp "news.somewhere.edu"))
1026 If you want to read directly from the local spool, say:
1029 (setq gnus-select-method '(nnspool ""))
1032 If you can use a local spool, you probably should, as it will almost
1033 certainly be much faster. But do not use the local spool if your
1034 server is running Leafnode; in this case, use @code{(nntp "localhost")}.
1036 @vindex gnus-nntpserver-file
1038 @cindex @acronym{NNTP} server
1039 If this variable is not set, gnus will take a look at the
1040 @env{NNTPSERVER} environment variable. If that variable isn't set,
1041 gnus will see whether @code{gnus-nntpserver-file}
1042 (@file{/etc/nntpserver} by default) has any opinions on the matter.
1043 If that fails as well, gnus will try to use the machine running Emacs
1044 as an @acronym{NNTP} server. That's a long shot, though.
1046 @vindex gnus-nntp-server
1047 If @code{gnus-nntp-server} is set, this variable will override
1048 @code{gnus-select-method}. You should therefore set
1049 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1051 @vindex gnus-secondary-servers
1052 @vindex gnus-nntp-server
1053 You can also make gnus prompt you interactively for the name of an
1054 @acronym{NNTP} server. If you give a non-numerical prefix to @code{gnus}
1055 (i.e., @kbd{C-u M-x gnus}), gnus will let you choose between the servers
1056 in the @code{gnus-secondary-servers} list (if any). You can also just
1057 type in the name of any server you feel like visiting. (Note that this
1058 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1059 gnus} later in the same Emacs session, Gnus will contact the same
1062 @findex gnus-group-browse-foreign-server
1064 However, if you use one @acronym{NNTP} server regularly and are just
1065 interested in a couple of groups from a different server, you would be
1066 better served by using the @kbd{B} command in the group buffer. It will
1067 let you have a look at what groups are available, and you can subscribe
1068 to any of the groups you want to. This also makes @file{.newsrc}
1069 maintenance much tidier. @xref{Foreign Groups}.
1071 @vindex gnus-secondary-select-methods
1073 A slightly different approach to foreign groups is to set the
1074 @code{gnus-secondary-select-methods} variable. The select methods
1075 listed in this variable are in many ways just as native as the
1076 @code{gnus-select-method} server. They will also be queried for active
1077 files during startup (if that's required), and new newsgroups that
1078 appear on these servers will be subscribed (or not) just as native
1081 For instance, if you use the @code{nnmbox} back end to read your mail,
1082 you would typically set this variable to
1085 (setq gnus-secondary-select-methods '((nnmbox "")))
1089 @node The First Time
1090 @section The First Time
1091 @cindex first time usage
1093 If no startup files exist, gnus will try to determine what groups should
1094 be subscribed by default.
1096 @vindex gnus-default-subscribed-newsgroups
1097 If the variable @code{gnus-default-subscribed-newsgroups} is set, gnus
1098 will subscribe you to just those groups in that list, leaving the rest
1099 killed. Your system administrator should have set this variable to
1102 Since she hasn't, gnus will just subscribe you to a few arbitrarily
1103 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1104 here as @dfn{whatever Lars thinks you should read}.)
1106 You'll also be subscribed to the gnus documentation group, which should
1107 help you with most common problems.
1109 If @code{gnus-default-subscribed-newsgroups} is @code{t}, gnus will just
1110 use the normal functions for handling new groups, and not do anything
1114 @node The Server is Down
1115 @section The Server is Down
1116 @cindex server errors
1118 If the default server is down, gnus will understandably have some
1119 problems starting. However, if you have some mail groups in addition to
1120 the news groups, you may want to start gnus anyway.
1122 Gnus, being the trusting sort of program, will ask whether to proceed
1123 without a native select method if that server can't be contacted. This
1124 will happen whether the server doesn't actually exist (i.e., you have
1125 given the wrong address) or the server has just momentarily taken ill
1126 for some reason or other. If you decide to continue and have no foreign
1127 groups, you'll find it difficult to actually do anything in the group
1128 buffer. But, hey, that's your problem. Blllrph!
1130 @findex gnus-no-server
1131 @kindex M-x gnus-no-server
1133 If you know that the server is definitely down, or you just want to read
1134 your mail without bothering with the server at all, you can use the
1135 @code{gnus-no-server} command to start gnus. That might come in handy
1136 if you're in a hurry as well. This command will not attempt to contact
1137 your primary server---instead, it will just activate all groups on level
1138 1 and 2. (You should preferably keep no native groups on those two
1139 levels.) Also @pxref{Group Levels}.
1143 @section Slave Gnusae
1146 You might want to run more than one Emacs with more than one gnus at the
1147 same time. If you are using different @file{.newsrc} files (e.g., if you
1148 are using the two different gnusae to read from two different servers),
1149 that is no problem whatsoever. You just do it.
1151 The problem appears when you want to run two Gnusae that use the same
1152 @file{.newsrc} file.
1154 To work around that problem some, we here at the Think-Tank at the gnus
1155 Towers have come up with a new concept: @dfn{Masters} and
1156 @dfn{slaves}. (We have applied for a patent on this concept, and have
1157 taken out a copyright on those words. If you wish to use those words in
1158 conjunction with each other, you have to send $1 per usage instance to
1159 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1160 Applications}) will be much more expensive, of course.)
1163 Anyway, you start one gnus up the normal way with @kbd{M-x gnus} (or
1164 however you do it). Each subsequent slave gnusae should be started with
1165 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1166 files, but instead save @dfn{slave files} that contain information only
1167 on what groups have been read in the slave session. When a master gnus
1168 starts, it will read (and delete) these slave files, incorporating all
1169 information from them. (The slave files will be read in the sequence
1170 they were created, so the latest changes will have precedence.)
1172 Information from the slave files has, of course, precedence over the
1173 information in the normal (i.e., master) @file{.newsrc} file.
1175 If the @file{.newsrc*} files have not been saved in the master when the
1176 slave starts, you may be prompted as to whether to read an auto-save
1177 file. If you answer ``yes'', the unsaved changes to the master will be
1178 incorporated into the slave. If you answer ``no'', the slave may see some
1179 messages as unread that have been read in the master.
1181 @node Fetching a Group
1182 @section Fetching a Group
1183 @cindex fetching a group
1185 @findex gnus-fetch-group
1186 It is sometimes convenient to be able to just say ``I want to read this
1187 group and I don't care whether gnus has been started or not''. This is
1188 perhaps more useful for people who write code than for users, but the
1189 command @code{gnus-fetch-group} provides this functionality in any case.
1190 It takes the group name as a parameter.
1196 @cindex subscription
1198 @vindex gnus-check-new-newsgroups
1199 If you are satisfied that you really never want to see any new groups,
1200 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1201 also save you some time at startup. Even if this variable is
1202 @code{nil}, you can always subscribe to the new groups just by pressing
1203 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1204 is @code{ask-server} by default. If you set this variable to
1205 @code{always}, then Gnus will query the back ends for new groups even
1206 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1209 * Checking New Groups:: Determining what groups are new.
1210 * Subscription Methods:: What Gnus should do with new groups.
1211 * Filtering New Groups:: Making Gnus ignore certain new groups.
1215 @node Checking New Groups
1216 @subsection Checking New Groups
1218 Gnus normally determines whether a group is new or not by comparing the
1219 list of groups from the active file(s) with the lists of subscribed and
1220 dead groups. This isn't a particularly fast method. If
1221 @code{gnus-check-new-newsgroups} is @code{ask-server}, gnus will ask the
1222 server for new groups since the last time. This is both faster and
1223 cheaper. This also means that you can get rid of the list of killed
1224 groups altogether, so you may set @code{gnus-save-killed-list} to
1225 @code{nil}, which will save time both at startup, at exit, and all over.
1226 Saves disk space, too. Why isn't this the default, then?
1227 Unfortunately, not all servers support this command.
1229 I bet I know what you're thinking now: How do I find out whether my
1230 server supports @code{ask-server}? No? Good, because I don't have a
1231 fail-safe answer. I would suggest just setting this variable to
1232 @code{ask-server} and see whether any new groups appear within the next
1233 few days. If any do, then it works. If none do, then it doesn't
1234 work. I could write a function to make gnus guess whether the server
1235 supports @code{ask-server}, but it would just be a guess. So I won't.
1236 You could @code{telnet} to the server and say @code{HELP} and see
1237 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1238 it does, then it might work. (But there are servers that lists
1239 @samp{NEWGROUPS} without supporting the function properly.)
1241 This variable can also be a list of select methods. If so, gnus will
1242 issue an @code{ask-server} command to each of the select methods, and
1243 subscribe them (or not) using the normal methods. This might be handy
1244 if you are monitoring a few servers for new groups. A side effect is
1245 that startup will take much longer, so you can meditate while waiting.
1246 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1249 @node Subscription Methods
1250 @subsection Subscription Methods
1252 @vindex gnus-subscribe-newsgroup-method
1253 What gnus does when it encounters a new group is determined by the
1254 @code{gnus-subscribe-newsgroup-method} variable.
1256 This variable should contain a function. This function will be called
1257 with the name of the new group as the only parameter.
1259 Some handy pre-fab functions are:
1263 @item gnus-subscribe-zombies
1264 @vindex gnus-subscribe-zombies
1265 Make all new groups zombies. This is the default. You can browse the
1266 zombies later (with @kbd{A z}) and either kill them all off properly
1267 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1269 @item gnus-subscribe-randomly
1270 @vindex gnus-subscribe-randomly
1271 Subscribe all new groups in arbitrary order. This really means that all
1272 new groups will be added at ``the top'' of the group buffer.
1274 @item gnus-subscribe-alphabetically
1275 @vindex gnus-subscribe-alphabetically
1276 Subscribe all new groups in alphabetical order.
1278 @item gnus-subscribe-hierarchically
1279 @vindex gnus-subscribe-hierarchically
1280 Subscribe all new groups hierarchically. The difference between this
1281 function and @code{gnus-subscribe-alphabetically} is slight.
1282 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1283 alphabetical fashion, while this function will enter groups into its
1284 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1285 @samp{comp} hierarchy, this function will not mess that configuration
1286 up. Or something like that.
1288 @item gnus-subscribe-interactively
1289 @vindex gnus-subscribe-interactively
1290 Subscribe new groups interactively. This means that gnus will ask
1291 you about @strong{all} new groups. The groups you choose to subscribe
1292 to will be subscribed hierarchically.
1294 @item gnus-subscribe-killed
1295 @vindex gnus-subscribe-killed
1296 Kill all new groups.
1298 @item gnus-subscribe-topics
1299 @vindex gnus-subscribe-topics
1300 Put the groups into the topic that has a matching @code{subscribe} topic
1301 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1302 topic parameter that looks like
1308 will mean that all groups that match that regex will be subscribed under
1311 If no topics match the groups, the groups will be subscribed in the
1316 @vindex gnus-subscribe-hierarchical-interactive
1317 A closely related variable is
1318 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1319 mouthful.) If this variable is non-@code{nil}, gnus will ask you in a
1320 hierarchical fashion whether to subscribe to new groups or not. Gnus
1321 will ask you for each sub-hierarchy whether you want to descend the
1324 One common mistake is to set the variable a few paragraphs above
1325 (@code{gnus-subscribe-newsgroup-method}) to
1326 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1327 will not work. This is ga-ga. So don't do it.
1330 @node Filtering New Groups
1331 @subsection Filtering New Groups
1333 A nice and portable way to control which new newsgroups should be
1334 subscribed (or ignored) is to put an @dfn{options} line at the start of
1335 the @file{.newsrc} file. Here's an example:
1338 options -n !alt.all !rec.all sci.all
1341 @vindex gnus-subscribe-options-newsgroup-method
1342 This line obviously belongs to a serious-minded intellectual scientific
1343 person (or she may just be plain old boring), because it says that all
1344 groups that have names beginning with @samp{alt} and @samp{rec} should
1345 be ignored, and all groups with names beginning with @samp{sci} should
1346 be subscribed. Gnus will not use the normal subscription method for
1347 subscribing these groups.
1348 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1349 variable defaults to @code{gnus-subscribe-alphabetically}.
1351 @vindex gnus-options-not-subscribe
1352 @vindex gnus-options-subscribe
1353 If you don't want to mess with your @file{.newsrc} file, you can just
1354 set the two variables @code{gnus-options-subscribe} and
1355 @code{gnus-options-not-subscribe}. These two variables do exactly the
1356 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1357 and if the new group matches the former, it will be unconditionally
1358 subscribed, and if it matches the latter, it will be ignored.
1360 @vindex gnus-auto-subscribed-groups
1361 Yet another variable that meddles here is
1362 @code{gnus-auto-subscribed-groups}. It works exactly like
1363 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
1364 thought it would be nice to have two of these. This variable is more
1365 meant for setting some ground rules, while the other variable is used
1366 more for user fiddling. By default this variable makes all new groups
1367 that come from mail back ends (@code{nnml}, @code{nnbabyl},
1368 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir})
1369 subscribed. If you don't like that, just set this variable to
1372 New groups that match this regexp are subscribed using
1373 @code{gnus-subscribe-options-newsgroup-method}.
1376 @node Changing Servers
1377 @section Changing Servers
1378 @cindex changing servers
1380 Sometimes it is necessary to move from one @acronym{NNTP} server to another.
1381 This happens very rarely, but perhaps you change jobs, or one server is
1382 very flaky and you want to use another.
1384 Changing the server is pretty easy, right? You just change
1385 @code{gnus-select-method} to point to the new server?
1389 Article numbers are not (in any way) kept synchronized between different
1390 @acronym{NNTP} servers, and the only way Gnus keeps track of what articles
1391 you have read is by keeping track of article numbers. So when you
1392 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1395 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1396 file from one server to another. They all have one thing in
1397 common---they take a looong time to run. You don't want to use these
1398 functions more than absolutely necessary.
1400 @kindex M-x gnus-change-server
1401 @findex gnus-change-server
1402 If you have access to both servers, Gnus can request the headers for all
1403 the articles you have read and compare @code{Message-ID}s and map the
1404 article numbers of the read articles and article marks. The @kbd{M-x
1405 gnus-change-server} command will do this for all your native groups. It
1406 will prompt for the method you want to move to.
1408 @kindex M-x gnus-group-move-group-to-server
1409 @findex gnus-group-move-group-to-server
1410 You can also move individual groups with the @kbd{M-x
1411 gnus-group-move-group-to-server} command. This is useful if you want to
1412 move a (foreign) group from one server to another.
1414 @kindex M-x gnus-group-clear-data-on-native-groups
1415 @findex gnus-group-clear-data-on-native-groups
1416 If you don't have access to both the old and new server, all your marks
1417 and read ranges have become worthless. You can use the @kbd{M-x
1418 gnus-group-clear-data-on-native-groups} command to clear out all data
1419 that you have on your native groups. Use with caution.
1421 @kindex M-x gnus-group-clear-data
1422 @findex gnus-group-clear-data
1423 Clear the data from the current group only---nix out marks and the
1424 list of read articles (@code{gnus-group-clear-data}).
1426 After changing servers, you @strong{must} move the cache hierarchy away,
1427 since the cached articles will have wrong article numbers, which will
1428 affect which articles Gnus thinks are read.
1429 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1430 to have it done automatically; for @code{gnus-group-clear-data}, you
1431 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1432 cache for all groups).
1436 @section Startup Files
1437 @cindex startup files
1442 Now, you all know about the @file{.newsrc} file. All subscription
1443 information is traditionally stored in this file.
1445 Things got a bit more complicated with @sc{gnus}. In addition to
1446 keeping the @file{.newsrc} file updated, it also used a file called
1447 @file{.newsrc.el} for storing all the information that didn't fit into
1448 the @file{.newsrc} file. (Actually, it also duplicated everything in
1449 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1450 files was the most recently saved, which enabled people to swap between
1451 @sc{gnus} and other newsreaders.
1453 That was kinda silly, so Gnus went one better: In addition to the
1454 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1455 @file{.newsrc.eld}. It will read whichever of these files that are most
1456 recent, but it will never write a @file{.newsrc.el} file. You should
1457 never delete the @file{.newsrc.eld} file---it contains much information
1458 not stored in the @file{.newsrc} file.
1460 @vindex gnus-save-newsrc-file
1461 @vindex gnus-read-newsrc-file
1462 You can turn off writing the @file{.newsrc} file by setting
1463 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1464 the file and save some space, as well as exiting from gnus faster.
1465 However, this will make it impossible to use other newsreaders than
1466 gnus. But hey, who would want to, right? Similarly, setting
1467 @code{gnus-read-newsrc-file} to @code{nil} makes gnus ignore the
1468 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1469 convenient if you have a tendency to use Netscape once in a while.
1471 @vindex gnus-save-killed-list
1472 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1473 will not save the list of killed groups to the startup file. This will
1474 save both time (when starting and quitting) and space (on disk). It
1475 will also mean that Gnus has no record of what groups are new or old,
1476 so the automatic new groups subscription methods become meaningless.
1477 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1478 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1479 Groups}). This variable can also be a regular expression. If that's
1480 the case, remove all groups that do not match this regexp before
1481 saving. This can be useful in certain obscure situations that involve
1482 several servers where not all servers support @code{ask-server}.
1484 @vindex gnus-startup-file
1485 @vindex gnus-backup-startup-file
1486 @vindex version-control
1487 The @code{gnus-startup-file} variable says where the startup files are.
1488 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1489 file being whatever that one is, with a @samp{.eld} appended.
1490 If you want version control for this file, set
1491 @code{gnus-backup-startup-file}. It respects the same values as the
1492 @code{version-control} variable.
1494 @vindex gnus-save-newsrc-hook
1495 @vindex gnus-save-quick-newsrc-hook
1496 @vindex gnus-save-standard-newsrc-hook
1497 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1498 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1499 saving the @file{.newsrc.eld} file, and
1500 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1501 @file{.newsrc} file. The latter two are commonly used to turn version
1502 control on or off. Version control is on by default when saving the
1503 startup files. If you want to turn backup creation off, say something like:
1506 (defun turn-off-backup ()
1507 (set (make-local-variable 'backup-inhibited) t))
1509 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1510 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1513 @vindex gnus-init-file
1514 @vindex gnus-site-init-file
1515 When gnus starts, it will read the @code{gnus-site-init-file}
1516 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1517 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1518 and can be used to avoid cluttering your @file{~/.emacs} and
1519 @file{site-init} files with gnus stuff. Gnus will also check for files
1520 with the same names as these, but with @file{.elc} and @file{.el}
1521 suffixes. In other words, if you have set @code{gnus-init-file} to
1522 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1523 and finally @file{~/.gnus} (in this order).
1529 @cindex dribble file
1532 Whenever you do something that changes the gnus data (reading articles,
1533 catching up, killing/subscribing groups), the change is added to a
1534 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1535 Emacs way. If your Emacs should crash before you have saved the
1536 @file{.newsrc} files, all changes you have made can be recovered from
1539 If gnus detects this file at startup, it will ask the user whether to
1540 read it. The auto save file is deleted whenever the real startup file is
1543 @vindex gnus-use-dribble-file
1544 If @code{gnus-use-dribble-file} is @code{nil}, gnus won't create and
1545 maintain a dribble buffer. The default is @code{t}.
1547 @vindex gnus-dribble-directory
1548 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1549 this variable is @code{nil}, which it is by default, gnus will dribble
1550 into the directory where the @file{.newsrc} file is located. (This is
1551 normally the user's home directory.) The dribble file will get the same
1552 file permissions as the @file{.newsrc} file.
1554 @vindex gnus-always-read-dribble-file
1555 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1556 read the dribble file on startup without querying the user.
1559 @node The Active File
1560 @section The Active File
1562 @cindex ignored groups
1564 When gnus starts, or indeed whenever it tries to determine whether new
1565 articles have arrived, it reads the active file. This is a very large
1566 file that lists all the active groups and articles on the server.
1568 @vindex gnus-ignored-newsgroups
1569 Before examining the active file, gnus deletes all lines that match the
1570 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1571 any groups with bogus names, but you can use this variable to make gnus
1572 ignore hierarchies you aren't ever interested in. However, this is not
1573 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1574 Groups} for an overview of other variables that can be used instead.
1577 @c @code{nil} by default, and will slow down active file handling somewhat
1578 @c if you set it to anything else.
1580 @vindex gnus-read-active-file
1582 The active file can be rather Huge, so if you have a slow network, you
1583 can set @code{gnus-read-active-file} to @code{nil} to prevent gnus from
1584 reading the active file. This variable is @code{some} by default.
1586 Gnus will try to make do by getting information just on the groups that
1587 you actually subscribe to.
1589 Note that if you subscribe to lots and lots of groups, setting this
1590 variable to @code{nil} will probably make gnus slower, not faster. At
1591 present, having this variable @code{nil} will slow gnus down
1592 considerably, unless you read news over a 2400 baud modem.
1594 This variable can also have the value @code{some}. Gnus will then
1595 attempt to read active info only on the subscribed groups. On some
1596 servers this is quite fast (on sparkling, brand new INN servers that
1597 support the @code{LIST ACTIVE group} command), on others this isn't fast
1598 at all. In any case, @code{some} should be faster than @code{nil}, and
1599 is certainly faster than @code{t} over slow lines.
1601 Some news servers (old versions of Leafnode and old versions of INN, for
1602 instance) do not support the @code{LIST ACTIVE group}. For these
1603 servers, @code{nil} is probably the most efficient value for this
1606 If this variable is @code{nil}, gnus will ask for group info in total
1607 lock-step, which isn't very fast. If it is @code{some} and you use an
1608 @acronym{NNTP} server, gnus will pump out commands as fast as it can, and
1609 read all the replies in one swoop. This will normally result in better
1610 performance, but if the server does not support the aforementioned
1611 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1613 If you think that starting up Gnus takes too long, try all the three
1614 different values for this variable and see what works best for you.
1616 In any case, if you use @code{some} or @code{nil}, you should definitely
1617 kill all groups that you aren't interested in to speed things up.
1619 Note that this variable also affects active file retrieval from
1620 secondary select methods.
1623 @node Startup Variables
1624 @section Startup Variables
1628 @item gnus-load-hook
1629 @vindex gnus-load-hook
1630 A hook run while gnus is being loaded. Note that this hook will
1631 normally be run just once in each Emacs session, no matter how many
1632 times you start gnus.
1634 @item gnus-before-startup-hook
1635 @vindex gnus-before-startup-hook
1636 A hook run after starting up gnus successfully.
1638 @item gnus-startup-hook
1639 @vindex gnus-startup-hook
1640 A hook run as the very last thing after starting up gnus
1642 @item gnus-started-hook
1643 @vindex gnus-started-hook
1644 A hook that is run as the very last thing after starting up gnus
1647 @item gnus-setup-news-hook
1648 @vindex gnus-setup-news-hook
1649 A hook that is run after reading the @file{.newsrc} file(s), but before
1650 generating the group buffer.
1652 @item gnus-check-bogus-newsgroups
1653 @vindex gnus-check-bogus-newsgroups
1654 If non-@code{nil}, gnus will check for and delete all bogus groups at
1655 startup. A @dfn{bogus group} is a group that you have in your
1656 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1657 bogus groups can take quite a while, so to save time and resources it's
1658 best to leave this option off, and do the checking for bogus groups once
1659 in a while from the group buffer instead (@pxref{Group Maintenance}).
1661 @item gnus-inhibit-startup-message
1662 @vindex gnus-inhibit-startup-message
1663 If non-@code{nil}, the startup message won't be displayed. That way,
1664 your boss might not notice as easily that you are reading news instead
1665 of doing your job. Note that this variable is used before
1666 @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1668 @item gnus-no-groups-message
1669 @vindex gnus-no-groups-message
1670 Message displayed by gnus when no groups are available.
1672 @item gnus-play-startup-jingle
1673 @vindex gnus-play-startup-jingle
1674 If non-@code{nil}, play the gnus jingle at startup.
1676 @item gnus-startup-jingle
1677 @vindex gnus-startup-jingle
1678 Jingle to be played if the above variable is non-@code{nil}. The
1679 default is @samp{Tuxedomoon.Jingle4.au}.
1685 @chapter Group Buffer
1686 @cindex group buffer
1688 @c Alex Schroeder suggests to rearrange this as follows:
1690 @c <kensanata> ok, just save it for reference. I'll go to bed in a minute.
1691 @c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1692 @c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1693 @c 7. Group Score, 8. Group Buffer Format
1694 @c <kensanata> Group Levels should have more information on levels 5 to 9. I
1695 @c suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1696 @c <kensanata> First, "Gnus considers groups... (default 9)."
1697 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1698 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1699 @c <kensanata> Then expand the next paragraph or add some more to it.
1700 @c This short one sentence explains levels 1 and 2, therefore I understand
1701 @c that I should keep important news at 3 and boring news at 4.
1702 @c Say so! Then go on to explain why I should bother with levels 6 to 9.
1703 @c Maybe keep those that you don't want to read temporarily at 6,
1704 @c those that you never want to read at 8, those that offend your
1705 @c human rights at 9...
1708 The @dfn{group buffer} lists all (or parts) of the available groups. It
1709 is the first buffer shown when gnus starts, and will never be killed as
1710 long as gnus is active.
1714 \gnusfigure{The Group Buffer}{320}{
1715 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1716 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1717 \put(120,38){\vector(1,2){10}}
1718 \put(40,60){\makebox(0,0)[r]{Mode line}}
1719 \put(40,58){\vector(1,0){30}}
1720 \put(200,28){\makebox(0,0)[t]{Native select method}}
1721 \put(200,26){\vector(-1,2){15}}
1727 * Group Buffer Format:: Information listed and how you can change it.
1728 * Group Maneuvering:: Commands for moving in the group buffer.
1729 * Selecting a Group:: Actually reading news.
1730 * Subscription Commands:: Unsubscribing, killing, subscribing.
1731 * Group Data:: Changing the info for a group.
1732 * Group Levels:: Levels? What are those, then?
1733 * Group Score:: A mechanism for finding out what groups you like.
1734 * Marking Groups:: You can mark groups for later processing.
1735 * Foreign Groups:: Creating and editing groups.
1736 * Group Parameters:: Each group may have different parameters set.
1737 * Listing Groups:: Gnus can list various subsets of the groups.
1738 * Sorting Groups:: Re-arrange the group order.
1739 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1740 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1741 * Exiting Gnus:: Stop reading news and get some work done.
1742 * Group Topics:: A folding group mode divided into topics.
1743 * Misc Group Stuff:: Other stuff that you can to do.
1747 @node Group Buffer Format
1748 @section Group Buffer Format
1751 * Group Line Specification:: Deciding how the group buffer is to look.
1752 * Group Mode Line Specification:: The group buffer mode line.
1753 * Group Highlighting:: Having nice colors in the group buffer.
1757 @node Group Line Specification
1758 @subsection Group Line Specification
1759 @cindex group buffer format
1761 The default format of the group buffer is nice and dull, but you can
1762 make it as exciting and ugly as you feel like.
1764 Here's a couple of example group lines:
1767 25: news.announce.newusers
1768 * 0: alt.fan.andrea-dworkin
1773 You can see that there are 25 unread articles in
1774 @samp{news.announce.newusers}. There are no unread articles, but some
1775 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1776 asterisk at the beginning of the line?).
1778 @vindex gnus-group-line-format
1779 You can change that format to whatever you want by fiddling with the
1780 @code{gnus-group-line-format} variable. This variable works along the
1781 lines of a @code{format} specification, which is pretty much the same as
1782 a @code{printf} specifications, for those of you who use (feh!) C.
1783 @xref{Formatting Variables}.
1785 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1787 There should always be a colon on the line; the cursor always moves to
1788 the colon after performing an operation. @xref{Positioning
1789 Point}. Nothing else is required---not even the group name. All
1790 displayed text is just window dressing, and is never examined by Gnus.
1791 Gnus stores all real information it needs using text properties.
1793 (Note that if you make a really strange, wonderful, spreadsheet-like
1794 layout, everybody will believe you are hard at work with the accounting
1795 instead of wasting time reading news.)
1797 Here's a list of all available format characters:
1802 An asterisk if the group only has marked articles.
1805 Whether the group is subscribed.
1808 Level of subscribedness.
1811 Number of unread articles.
1814 Number of dormant articles.
1817 Number of ticked articles.
1820 Number of read articles.
1823 Number of unseen articles.
1826 Estimated total number of articles. (This is really @var{max-number}
1827 minus @var{min-number} plus 1.)
1829 Gnus uses this estimation because the @acronym{NNTP} protocol provides
1830 efficient access to @var{max-number} and @var{min-number} but getting
1831 the true unread message count is not possible efficiently. For
1832 hysterical raisins, even the mail back ends, where the true number of
1833 unread messages might be available efficiently, use the same limited
1834 interface. To remove this restriction from Gnus means that the back
1835 end interface has to be changed, which is not an easy job. If you
1836 want to work on this, please contact the Gnus mailing list.
1839 Number of unread, unticked, non-dormant articles.
1842 Number of ticked and dormant articles.
1851 Group comment (@pxref{Group Parameters}) or group name if there is no
1852 comment element in the group parameters.
1855 Newsgroup description. You need to read the group descriptions
1856 before these will appear, and to do that, you either have to set
1857 @code{gnus-read-active-file} or use the group buffer @kbd{M-d}
1861 @samp{m} if moderated.
1864 @samp{(m)} if moderated.
1870 If the summary buffer for the group is open or not.
1876 A string that looks like @samp{<%s:%n>} if a foreign select method is
1880 Indentation based on the level of the topic (@pxref{Group Topics}).
1883 @vindex gnus-group-uncollapsed-levels
1884 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1885 variable says how many levels to leave at the end of the group name.
1886 The default is 1---this will mean that group names like
1887 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1890 @vindex gnus-new-mail-mark
1892 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1896 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1899 A string that says when you last read the group (@pxref{Group
1903 User defined specifier. The next character in the format string should
1904 be a letter. Gnus will call the function
1905 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1906 following @samp{%u}. The function will be passed a single dummy
1907 parameter as argument. The function should return a string, which will
1908 be inserted into the buffer just like information from any other
1913 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1914 if no info is available---for instance, if it is a non-activated foreign
1915 group, or a bogus native group.
1918 @node Group Mode Line Specification
1919 @subsection Group Mode Line Specification
1920 @cindex group mode line
1922 @vindex gnus-group-mode-line-format
1923 The mode line can be changed by setting
1924 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1925 doesn't understand that many format specifiers:
1929 The native news server.
1931 The native select method.
1935 @node Group Highlighting
1936 @subsection Group Highlighting
1937 @cindex highlighting
1938 @cindex group highlighting
1940 @vindex gnus-group-highlight
1941 Highlighting in the group buffer is controlled by the
1942 @code{gnus-group-highlight} variable. This is an alist with elements
1943 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1944 something non-@code{nil}, the @var{face} will be used on the line.
1946 Here's an example value for this variable that might look nice if the
1950 (cond (window-system
1951 (setq custom-background-mode 'light)
1952 (defface my-group-face-1
1953 '((t (:foreground "Red" :bold t))) "First group face")
1954 (defface my-group-face-2
1955 '((t (:foreground "DarkSeaGreen4" :bold t)))
1956 "Second group face")
1957 (defface my-group-face-3
1958 '((t (:foreground "Green4" :bold t))) "Third group face")
1959 (defface my-group-face-4
1960 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1961 (defface my-group-face-5
1962 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1964 (setq gnus-group-highlight
1965 '(((> unread 200) . my-group-face-1)
1966 ((and (< level 3) (zerop unread)) . my-group-face-2)
1967 ((< level 3) . my-group-face-3)
1968 ((zerop unread) . my-group-face-4)
1969 (t . my-group-face-5)))
1972 Also @pxref{Faces and Fonts}.
1974 Variables that are dynamically bound when the forms are evaluated
1981 The number of unread articles in the group.
1985 Whether the group is a mail group.
1987 The level of the group.
1989 The score of the group.
1991 The number of ticked articles in the group.
1993 The total number of articles in the group. Or rather,
1994 @var{max-number} minus @var{min-number} plus one.
1996 When using the topic minor mode, this variable is bound to the current
1997 topic being inserted.
2000 When the forms are @code{eval}ed, point is at the beginning of the line
2001 of the group in question, so you can use many of the normal gnus
2002 functions for snarfing info on the group.
2004 @vindex gnus-group-update-hook
2005 @findex gnus-group-highlight-line
2006 @code{gnus-group-update-hook} is called when a group line is changed.
2007 It will not be called when @code{gnus-visual} is @code{nil}. This hook
2008 calls @code{gnus-group-highlight-line} by default.
2011 @node Group Maneuvering
2012 @section Group Maneuvering
2013 @cindex group movement
2015 All movement commands understand the numeric prefix and will behave as
2016 expected, hopefully.
2022 @findex gnus-group-next-unread-group
2023 Go to the next group that has unread articles
2024 (@code{gnus-group-next-unread-group}).
2030 @findex gnus-group-prev-unread-group
2031 Go to the previous group that has unread articles
2032 (@code{gnus-group-prev-unread-group}).
2036 @findex gnus-group-next-group
2037 Go to the next group (@code{gnus-group-next-group}).
2041 @findex gnus-group-prev-group
2042 Go to the previous group (@code{gnus-group-prev-group}).
2046 @findex gnus-group-next-unread-group-same-level
2047 Go to the next unread group on the same (or lower) level
2048 (@code{gnus-group-next-unread-group-same-level}).
2052 @findex gnus-group-prev-unread-group-same-level
2053 Go to the previous unread group on the same (or lower) level
2054 (@code{gnus-group-prev-unread-group-same-level}).
2057 Three commands for jumping to groups:
2063 @findex gnus-group-jump-to-group
2064 Jump to a group (and make it visible if it isn't already)
2065 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
2070 @findex gnus-group-best-unread-group
2071 Jump to the unread group with the lowest level
2072 (@code{gnus-group-best-unread-group}).
2076 @findex gnus-group-first-unread-group
2077 Jump to the first group with unread articles
2078 (@code{gnus-group-first-unread-group}).
2081 @vindex gnus-group-goto-unread
2082 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2083 commands will move to the next group, not the next unread group. Even
2084 the commands that say they move to the next unread group. The default
2088 @node Selecting a Group
2089 @section Selecting a Group
2090 @cindex group selection
2095 @kindex SPACE (Group)
2096 @findex gnus-group-read-group
2097 Select the current group, switch to the summary buffer and display the
2098 first unread article (@code{gnus-group-read-group}). If there are no
2099 unread articles in the group, or if you give a non-numerical prefix to
2100 this command, gnus will offer to fetch all the old articles in this
2101 group from the server. If you give a numerical prefix @var{n}, @var{n}
2102 determines the number of articles Gnus will fetch. If @var{n} is
2103 positive, Gnus fetches the @var{n} newest articles, if @var{n} is
2104 negative, Gnus fetches the @code{abs(@var{n})} oldest articles.
2106 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2107 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2108 - 4 2 SPC} fetches the 42 oldest ones.
2110 When you are in the group (in the Summary buffer), you can type
2111 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2116 @findex gnus-group-select-group
2117 Select the current group and switch to the summary buffer
2118 (@code{gnus-group-select-group}). Takes the same arguments as
2119 @code{gnus-group-read-group}---the only difference is that this command
2120 does not display the first unread article automatically upon group
2124 @kindex M-RET (Group)
2125 @findex gnus-group-quick-select-group
2126 This does the same as the command above, but tries to do it with the
2127 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
2128 scoring/killing will be performed, there will be no highlights and no
2129 expunging. This might be useful if you're in a real hurry and have to
2130 enter some humongous group. If you give a 0 prefix to this command
2131 (i.e., @kbd{0 M-RET}), gnus won't even generate the summary buffer,
2132 which is useful if you want to toggle threading before generating the
2133 summary buffer (@pxref{Summary Generation Commands}).
2136 @kindex M-SPACE (Group)
2137 @findex gnus-group-visible-select-group
2138 This is yet one more command that does the same as the @kbd{RET}
2139 command, but this one does it without expunging and hiding dormants
2140 (@code{gnus-group-visible-select-group}).
2143 @kindex C-M-RET (Group)
2144 @findex gnus-group-select-group-ephemerally
2145 Finally, this command selects the current group ephemerally without
2146 doing any processing of its contents
2147 (@code{gnus-group-select-group-ephemerally}). Even threading has been
2148 turned off. Everything you do in the group after selecting it in this
2149 manner will have no permanent effects.
2153 @vindex gnus-large-newsgroup
2154 The @code{gnus-large-newsgroup} variable says what Gnus should
2155 consider to be a big group. If it is @code{nil}, no groups are
2156 considered big. The default value is 200. If the group has more
2157 (unread and/or ticked) articles than this, gnus will query the user
2158 before entering the group. The user can then specify how many
2159 articles should be fetched from the server. If the user specifies a
2160 negative number (@var{-n}), the @var{n} oldest articles will be
2161 fetched. If it is positive, the @var{n} articles that have arrived
2162 most recently will be fetched.
2164 @vindex gnus-large-ephemeral-newsgroup
2165 @code{gnus-large-ephemeral-newsgroup} is the same as
2166 @code{gnus-large-newsgroup}, but is only used for ephemeral
2169 @vindex gnus-select-group-hook
2170 @vindex gnus-auto-select-first
2171 @vindex gnus-auto-select-subject
2172 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2173 automatically when entering a group with the @kbd{SPACE} command.
2174 Which article this is is controlled by the
2175 @code{gnus-auto-select-subject} variable. Valid values for this
2181 Place point on the subject line of the first unread article.
2184 Place point on the subject line of the first article.
2187 Place point on the subject line of the first unseen article.
2189 @item unseen-or-unread
2190 Place point on the subject line of the first unseen article, and if
2191 there is no such article, place point on the subject line of the first
2195 Place point on the subject line of the highest-scored unread article.
2199 This variable can also be a function. In that case, that function
2200 will be called to place point on a subject line.
2202 If you want to prevent automatic selection in some group (say, in a
2203 binary group with Huge articles) you can set the
2204 @code{gnus-auto-select-first} variable to @code{nil} in
2205 @code{gnus-select-group-hook}, which is called when a group is
2209 @node Subscription Commands
2210 @section Subscription Commands
2211 @cindex subscription
2219 @findex gnus-group-unsubscribe-current-group
2220 @c @icon{gnus-group-unsubscribe}
2221 Toggle subscription to the current group
2222 (@code{gnus-group-unsubscribe-current-group}).
2228 @findex gnus-group-unsubscribe-group
2229 Prompt for a group to subscribe, and then subscribe it. If it was
2230 subscribed already, unsubscribe it instead
2231 (@code{gnus-group-unsubscribe-group}).
2237 @findex gnus-group-kill-group
2238 @c @icon{gnus-group-kill-group}
2239 Kill the current group (@code{gnus-group-kill-group}).
2245 @findex gnus-group-yank-group
2246 Yank the last killed group (@code{gnus-group-yank-group}).
2249 @kindex C-x C-t (Group)
2250 @findex gnus-group-transpose-groups
2251 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2252 really a subscription command, but you can use it instead of a
2253 kill-and-yank sequence sometimes.
2259 @findex gnus-group-kill-region
2260 Kill all groups in the region (@code{gnus-group-kill-region}).
2264 @findex gnus-group-kill-all-zombies
2265 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2268 @kindex S C-k (Group)
2269 @findex gnus-group-kill-level
2270 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2271 These groups can't be yanked back after killing, so this command should
2272 be used with some caution. The only time where this command comes in
2273 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2274 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2275 kill off all unsubscribed groups that do not have message numbers in the
2276 @file{.newsrc} file.
2280 Also @pxref{Group Levels}.
2290 @findex gnus-group-catchup-current
2291 @vindex gnus-group-catchup-group-hook
2292 @c @icon{gnus-group-catchup-current}
2293 Mark all unticked articles in this group as read
2294 (@code{gnus-group-catchup-current}).
2295 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2300 @findex gnus-group-catchup-current-all
2301 Mark all articles in this group, even the ticked ones, as read
2302 (@code{gnus-group-catchup-current-all}).
2306 @findex gnus-group-clear-data
2307 Clear the data from the current group---nix out marks and the list of
2308 read articles (@code{gnus-group-clear-data}).
2310 @item M-x gnus-group-clear-data-on-native-groups
2311 @kindex M-x gnus-group-clear-data-on-native-groups
2312 @findex gnus-group-clear-data-on-native-groups
2313 If you have switched from one @acronym{NNTP} server to another, all your marks
2314 and read ranges have become worthless. You can use this command to
2315 clear out all data that you have on your native groups. Use with
2322 @section Group Levels
2326 All groups have a level of @dfn{subscribedness}. For instance, if a
2327 group is on level 2, it is more subscribed than a group on level 5. You
2328 can ask gnus to just list groups on a given level or lower
2329 (@pxref{Listing Groups}), or to just check for new articles in groups on
2330 a given level or lower (@pxref{Scanning New Messages}).
2332 Remember: The higher the level of the group, the less important it is.
2338 @findex gnus-group-set-current-level
2339 Set the level of the current group. If a numeric prefix is given, the
2340 next @var{n} groups will have their levels set. The user will be
2341 prompted for a level.
2344 @vindex gnus-level-killed
2345 @vindex gnus-level-zombie
2346 @vindex gnus-level-unsubscribed
2347 @vindex gnus-level-subscribed
2348 Gnus considers groups from levels 1 to
2349 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2350 @code{gnus-level-subscribed} (exclusive) and
2351 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2352 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2353 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2354 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2355 same, but zombie and killed groups have no information on what articles
2356 you have read, etc, stored. This distinction between dead and living
2357 groups isn't done because it is nice or clever, it is done purely for
2358 reasons of efficiency.
2360 It is recommended that you keep all your mail groups (if any) on quite
2361 low levels (e.g. 1 or 2).
2363 Maybe the following description of the default behavior of Gnus helps to
2364 understand what these levels are all about. By default, Gnus shows you
2365 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2366 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2367 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2368 groups are hidden, in a way.
2370 Zombie and killed groups are similar to unsubscribed groups in that they
2371 are hidden by default. But they are different from subscribed and
2372 unsubscribed groups in that Gnus doesn't ask the news server for
2373 information (number of messages, number of unread messages) on zombie
2374 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2375 aren't interested in. If most groups are killed, Gnus is faster.
2377 Why does Gnus distinguish between zombie and killed groups? Well, when
2378 a new group arrives on the server, Gnus by default makes it a zombie
2379 group. This means that you are normally not bothered with new groups,
2380 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2381 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2382 list of killed groups.)
2384 If you want to play with the level variables, you should show some care.
2385 Set them once, and don't touch them ever again. Better yet, don't touch
2386 them at all unless you know exactly what you're doing.
2388 @vindex gnus-level-default-unsubscribed
2389 @vindex gnus-level-default-subscribed
2390 Two closely related variables are @code{gnus-level-default-subscribed}
2391 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2392 which are the levels that new groups will be put on if they are
2393 (un)subscribed. These two variables should, of course, be inside the
2394 relevant valid ranges.
2396 @vindex gnus-keep-same-level
2397 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2398 will only move to groups of the same level (or lower). In
2399 particular, going from the last article in one group to the next group
2400 will go to the next group of the same level (or lower). This might be
2401 handy if you want to read the most important groups before you read the
2404 If this variable is @code{best}, Gnus will make the next newsgroup the
2405 one with the best level.
2407 @vindex gnus-group-default-list-level
2408 All groups with a level less than or equal to
2409 @code{gnus-group-default-list-level} will be listed in the group buffer
2412 @vindex gnus-group-list-inactive-groups
2413 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2414 groups will be listed along with the unread groups. This variable is
2415 @code{t} by default. If it is @code{nil}, inactive groups won't be
2418 @vindex gnus-group-use-permanent-levels
2419 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2420 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2421 use this level as the ``work'' level.
2423 @vindex gnus-activate-level
2424 Gnus will normally just activate (i. e., query the server about) groups
2425 on level @code{gnus-activate-level} or less. If you don't want to
2426 activate unsubscribed groups, for instance, you might set this variable
2427 to 5. The default is 6.
2431 @section Group Score
2436 You would normally keep important groups on high levels, but that scheme
2437 is somewhat restrictive. Don't you wish you could have Gnus sort the
2438 group buffer according to how often you read groups, perhaps? Within
2441 This is what @dfn{group score} is for. You can have Gnus assign a score
2442 to each group through the mechanism described below. You can then sort
2443 the group buffer based on this score. Alternatively, you can sort on
2444 score and then level. (Taken together, the level and the score is
2445 called the @dfn{rank} of the group. A group that is on level 4 and has
2446 a score of 1 has a higher rank than a group on level 5 that has a score
2447 of 300. (The level is the most significant part and the score is the
2448 least significant part.))
2450 @findex gnus-summary-bubble-group
2451 If you want groups you read often to get higher scores than groups you
2452 read seldom you can add the @code{gnus-summary-bubble-group} function to
2453 the @code{gnus-summary-exit-hook} hook. This will result (after
2454 sorting) in a bubbling sort of action. If you want to see that in
2455 action after each summary exit, you can add
2456 @code{gnus-group-sort-groups-by-rank} or
2457 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2458 slow things down somewhat.
2461 @node Marking Groups
2462 @section Marking Groups
2463 @cindex marking groups
2465 If you want to perform some command on several groups, and they appear
2466 subsequently in the group buffer, you would normally just give a
2467 numerical prefix to the command. Most group commands will then do your
2468 bidding on those groups.
2470 However, if the groups are not in sequential order, you can still
2471 perform a command on several groups. You simply mark the groups first
2472 with the process mark and then execute the command.
2480 @findex gnus-group-mark-group
2481 Set the mark on the current group (@code{gnus-group-mark-group}).
2487 @findex gnus-group-unmark-group
2488 Remove the mark from the current group
2489 (@code{gnus-group-unmark-group}).
2493 @findex gnus-group-unmark-all-groups
2494 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2498 @findex gnus-group-mark-region
2499 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2503 @findex gnus-group-mark-buffer
2504 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2508 @findex gnus-group-mark-regexp
2509 Mark all groups that match some regular expression
2510 (@code{gnus-group-mark-regexp}).
2513 Also @pxref{Process/Prefix}.
2515 @findex gnus-group-universal-argument
2516 If you want to execute some command on all groups that have been marked
2517 with the process mark, you can use the @kbd{M-&}
2518 (@code{gnus-group-universal-argument}) command. It will prompt you for
2519 the command to be executed.
2522 @node Foreign Groups
2523 @section Foreign Groups
2524 @cindex foreign groups
2526 Below are some group mode commands for making and editing general foreign
2527 groups, as well as commands to ease the creation of a few
2528 special-purpose groups. All these commands insert the newly created
2529 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2536 @findex gnus-group-make-group
2537 @cindex making groups
2538 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2539 for a name, a method and possibly an @dfn{address}. For an easier way
2540 to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}).
2544 @findex gnus-group-rename-group
2545 @cindex renaming groups
2546 Rename the current group to something else
2547 (@code{gnus-group-rename-group}). This is valid only on some
2548 groups---mail groups mostly. This command might very well be quite slow
2554 @findex gnus-group-customize
2555 Customize the group parameters (@code{gnus-group-customize}).
2559 @findex gnus-group-edit-group-method
2560 @cindex renaming groups
2561 Enter a buffer where you can edit the select method of the current
2562 group (@code{gnus-group-edit-group-method}).
2566 @findex gnus-group-edit-group-parameters
2567 Enter a buffer where you can edit the group parameters
2568 (@code{gnus-group-edit-group-parameters}).
2572 @findex gnus-group-edit-group
2573 Enter a buffer where you can edit the group info
2574 (@code{gnus-group-edit-group}).
2578 @findex gnus-group-make-directory-group
2580 Make a directory group (@pxref{Directory Groups}). You will be prompted
2581 for a directory name (@code{gnus-group-make-directory-group}).
2586 @findex gnus-group-make-help-group
2587 Make the gnus help group (@code{gnus-group-make-help-group}).
2591 @cindex (ding) archive
2592 @cindex archive group
2593 @findex gnus-group-make-archive-group
2594 @vindex gnus-group-archive-directory
2595 @vindex gnus-group-recent-archive-directory
2596 Make a gnus archive group (@code{gnus-group-make-archive-group}). By
2597 default a group pointing to the most recent articles will be created
2598 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2599 group will be created from @code{gnus-group-archive-directory}.
2603 @findex gnus-group-make-kiboze-group
2605 Make a kiboze group. You will be prompted for a name, for a regexp to
2606 match groups to be ``included'' in the kiboze group, and a series of
2607 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2608 @xref{Kibozed Groups}.
2612 @findex gnus-group-enter-directory
2614 Read an arbitrary directory as if it were a newsgroup with the
2615 @code{nneething} back end (@code{gnus-group-enter-directory}).
2616 @xref{Anything Groups}.
2620 @findex gnus-group-make-doc-group
2621 @cindex ClariNet Briefs
2623 Make a group based on some file or other
2624 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2625 command, you will be prompted for a file name and a file type.
2626 Currently supported types are @code{mbox}, @code{babyl},
2627 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2628 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2629 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2630 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}. If
2631 you run this command without a prefix, Gnus will guess at the file
2632 type. @xref{Document Groups}.
2636 @vindex gnus-useful-groups
2637 @findex gnus-group-make-useful-group
2638 Create one of the groups mentioned in @code{gnus-useful-groups}
2639 (@code{gnus-group-make-useful-group}).
2643 @findex gnus-group-make-web-group
2647 Make an ephemeral group based on a web search
2648 (@code{gnus-group-make-web-group}). If you give a prefix to this
2649 command, make a solid group instead. You will be prompted for the
2650 search engine type and the search string. Valid search engine types
2651 include @code{google}, @code{dejanews}, and @code{gmane}.
2652 @xref{Web Searches}.
2654 If you use the @code{google} search engine, you can limit the search
2655 to a particular group by using a match string like
2656 @samp{shaving group:alt.sysadmin.recovery}.
2660 @findex gnus-group-make-rss-group
2661 Make a group based on an @acronym{RSS} feed
2662 (@code{gnus-group-make-rss-group}). You will be prompted for an URL.
2666 @kindex G DEL (Group)
2667 @findex gnus-group-delete-group
2668 This function will delete the current group
2669 (@code{gnus-group-delete-group}). If given a prefix, this function will
2670 actually delete all the articles in the group, and forcibly remove the
2671 group itself from the face of the Earth. Use a prefix only if you are
2672 absolutely sure of what you are doing. This command can't be used on
2673 read-only groups (like @code{nntp} groups), though.
2677 @findex gnus-group-make-empty-virtual
2678 Make a new, fresh, empty @code{nnvirtual} group
2679 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2683 @findex gnus-group-add-to-virtual
2684 Add the current group to an @code{nnvirtual} group
2685 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2688 @xref{Select Methods}, for more information on the various select
2691 @vindex gnus-activate-foreign-newsgroups
2692 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2693 gnus will check all foreign groups with this level or lower at startup.
2694 This might take quite a while, especially if you subscribe to lots of
2695 groups from different @acronym{NNTP} servers. Also @pxref{Group Levels};
2696 @code{gnus-activate-level} also affects activation of foreign
2700 @node Group Parameters
2701 @section Group Parameters
2702 @cindex group parameters
2704 The group parameters store information local to a particular group.
2705 Here's an example group parameter list:
2708 ((to-address . "ding@@gnus.org")
2712 We see that each element consists of a ``dotted pair''---the thing before
2713 the dot is the key, while the thing after the dot is the value. All the
2714 parameters have this form @emph{except} local variable specs, which are
2715 not dotted pairs, but proper lists.
2717 Some parameters have correspondent customizable variables, each of which
2718 is an alist of regexps and values.
2720 The following group parameters can be used:
2725 Address used by when doing followups and new posts.
2728 (to-address . "some@@where.com")
2731 This is primarily useful in mail groups that represent closed mailing
2732 lists---mailing lists where it's expected that everybody that writes to
2733 the mailing list is subscribed to it. Since using this parameter
2734 ensures that the mail only goes to the mailing list itself, it means
2735 that members won't receive two copies of your followups.
2737 Using @code{to-address} will actually work whether the group is foreign
2738 or not. Let's say there's a group on the server that is called
2739 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2740 the articles from a mail-to-news gateway. Posting directly to this
2741 group is therefore impossible---you have to send mail to the mailing
2742 list address instead.
2744 See also @code{gnus-parameter-to-address-alist}.
2748 Address used when doing @kbd{a} in that group.
2751 (to-list . "some@@where.com")
2754 It is totally ignored
2755 when doing a followup---except that if it is present in a news group,
2756 you'll get mail group semantics when doing @kbd{f}.
2758 If you do an @kbd{a} command in a mail group and you have neither a
2759 @code{to-list} group parameter nor a @code{to-address} group parameter,
2760 then a @code{to-list} group parameter will be added automatically upon
2761 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2762 @vindex gnus-add-to-list
2764 @findex gnus-mailing-list-mode
2765 @cindex mail list groups
2766 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2767 entering summary buffer.
2769 See also @code{gnus-parameter-to-list-alist}.
2774 @cindex Mail-Followup-To
2775 @findex gnus-find-subscribed-addresses
2776 If this parameter is set to @code{t}, Gnus will consider the
2777 to-address and to-list parameters for this group as addresses of
2778 mailing lists you are subscribed to. Giving Gnus this information is
2779 (only) a first step in getting it to generate correct Mail-Followup-To
2780 headers for your posts to these lists. The second step is to put the
2781 following in your @file{.gnus.el}
2784 (setq message-subscribed-address-functions
2785 '(gnus-find-subscribed-addresses))
2788 @xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for
2789 a complete treatment of available MFT support.
2793 If the group parameter list has the element @code{(visible . t)},
2794 that group will always be visible in the Group buffer, regardless
2795 of whether it has any unread articles.
2797 @item broken-reply-to
2798 @cindex broken-reply-to
2799 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2800 headers in this group are to be ignored, and for the header to be hidden
2801 if @code{reply-to} is part of @code{gnus-boring-article-headers}. This
2802 can be useful if you're reading a mailing list group where the listserv
2803 has inserted @code{Reply-To} headers that point back to the listserv
2804 itself. That is broken behavior. So there!
2808 Elements like @code{(to-group . "some.group.name")} means that all
2809 posts in that group will be sent to @code{some.group.name}.
2813 If you have @code{(newsgroup . t)} in the group parameter list, gnus
2814 will treat all responses as if they were responses to news articles.
2815 This can be useful if you have a mail group that's really a mirror of a
2820 If @code{(gcc-self . t)} is present in the group parameter list, newly
2821 composed messages will be @code{Gcc}'d to the current group. If
2822 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2823 generated, if @code{(gcc-self . "string")} is present, this string will
2824 be inserted literally as a @code{gcc} header. This parameter takes
2825 precedence over any default @code{Gcc} rules as described later
2826 (@pxref{Archived Messages}).
2828 @strong{Caveat}: It yields an error putting @code{(gcc-self . t)} in
2829 groups of an @code{nntp} server or so, because an @code{nntp} server
2830 doesn't accept articles.
2834 If the group parameter has an element that looks like @code{(auto-expire
2835 . t)}, all articles read will be marked as expirable. For an
2836 alternative approach, @pxref{Expiring Mail}.
2838 See also @code{gnus-auto-expirable-newsgroups}.
2841 @cindex total-expire
2842 If the group parameter has an element that looks like
2843 @code{(total-expire . t)}, all read articles will be put through the
2844 expiry process, even if they are not marked as expirable. Use with
2845 caution. Unread, ticked and dormant articles are not eligible for
2848 See also @code{gnus-total-expirable-newsgroups}.
2852 @vindex nnmail-expiry-wait-function
2853 If the group parameter has an element that looks like
2854 @code{(expiry-wait . 10)}, this value will override any
2855 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2856 (@pxref{Expiring Mail}) when expiring expirable messages. The value
2857 can either be a number of days (not necessarily an integer) or the
2858 symbols @code{never} or @code{immediate}.
2861 @cindex expiry-target
2862 Where expired messages end up. This parameter overrides
2863 @code{nnmail-expiry-target}.
2866 @cindex score file group parameter
2867 Elements that look like @code{(score-file . "file")} will make
2868 @file{file} into the current score file for the group in question. All
2869 interactive score entries will be put into this file.
2872 @cindex adapt file group parameter
2873 Elements that look like @code{(adapt-file . "file")} will make
2874 @file{file} into the current adaptive file for the group in question.
2875 All adaptive score entries will be put into this file.
2878 @cindex admin-address
2879 When unsubscribing from a mailing list you should never send the
2880 unsubscription notice to the mailing list itself. Instead, you'd send
2881 messages to the administrative address. This parameter allows you to
2882 put the admin address somewhere convenient.
2886 Elements that look like @code{(display . MODE)} say which articles to
2887 display on entering the group. Valid values are:
2891 Display all articles, both read and unread.
2894 Display the last @var{integer} articles in the group. This is the same as
2895 entering the group with @kbd{C-u @var{integer}}.
2898 Display the default visible articles, which normally includes unread and
2902 Display articles that satisfy a predicate.
2904 Here are some examples:
2908 Display only unread articles.
2911 Display everything except expirable articles.
2913 @item [and (not reply) (not expire)]
2914 Display everything except expirable and articles you've already
2918 The available operators are @code{not}, @code{and} and @code{or}.
2919 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2920 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2921 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2922 @code{cache}, @code{forward}, @code{unseen} and @code{recent}.
2926 The @code{display} parameter works by limiting the summary buffer to
2927 the subset specified. You can pop the limit by using the @kbd{/ w}
2928 command (@pxref{Limiting}).
2932 Elements that look like @code{(comment . "This is a comment")} are
2933 arbitrary comments on the group. You can display comments in the
2934 group line (@pxref{Group Line Specification}).
2938 Elements that look like @code{(charset . iso-8859-1)} will make
2939 @code{iso-8859-1} the default charset; that is, the charset that will be
2940 used for all articles that do not specify a charset.
2942 See also @code{gnus-group-charset-alist}.
2944 @item ignored-charsets
2945 @cindex ignored-charset
2946 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
2947 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2948 default charset will be used for decoding articles.
2950 See also @code{gnus-group-ignored-charsets-alist}.
2953 @cindex posting-style
2954 You can store additional posting style information for this group
2955 here (@pxref{Posting Styles}). The format is that of an entry in the
2956 @code{gnus-posting-styles} alist, except that there's no regexp matching
2957 the group name (of course). Style elements in this group parameter will
2958 take precedence over the ones found in @code{gnus-posting-styles}.
2960 For instance, if you want a funky name and signature in this group only,
2961 instead of hacking @code{gnus-posting-styles}, you could put something
2962 like this in the group parameters:
2967 ("X-My-Header" "Funky Value")
2968 (signature "Funky Signature"))
2973 If it is set, the value is used as the method for posting message
2974 instead of @code{gnus-post-method}.
2978 An item like @code{(banner . @var{regexp})} causes any part of an article
2979 that matches the regular expression @var{regexp} to be stripped. Instead of
2980 @var{regexp}, you can also use the symbol @code{signature} which strips the
2981 last signature or any of the elements of the alist
2982 @code{gnus-article-banner-alist}.
2986 This parameter contains a Sieve test that should match incoming mail
2987 that should be placed in this group. From this group parameter, a
2988 Sieve @samp{IF} control structure is generated, having the test as the
2989 condition and @samp{fileinto "group.name";} as the body.
2991 For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve
2992 address "sender" "sieve-admin@@extundo.com")} group parameter, when
2993 translating the group parameter into a Sieve script (@pxref{Sieve
2994 Commands}) the following Sieve code is generated:
2997 if address \"sender\" \"sieve-admin@@extundo.com\" @{
2998 fileinto \"INBOX.list.sieve\";
3002 The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve,
3003 Top, sieve, Emacs Sieve}.
3005 @item (agent parameters)
3006 If the agent has been enabled, you can set any of the its parameters
3007 to control the behavior of the agent in individual groups. See Agent
3008 Parameters in @ref{Category Syntax}. Most users will choose to set
3009 agent parameters in either an agent category or group topic to
3010 minimize the configuration effort.
3012 @item (@var{variable} @var{form})
3013 You can use the group parameters to set variables local to the group you
3014 are entering. If you want to turn threading off in @samp{news.answers},
3015 you could put @code{(gnus-show-threads nil)} in the group parameters of
3016 that group. @code{gnus-show-threads} will be made into a local variable
3017 in the summary buffer you enter, and the form @code{nil} will be
3018 @code{eval}ed there.
3020 Note that this feature sets the variable locally to the summary buffer.
3021 But some variables are evaluated in the article buffer, or in the
3022 message buffer (of a reply or followup or otherwise newly created
3023 message). As a workaround, it might help to add the variable in
3024 question to @code{gnus-newsgroup-variables}. @xref{Various Summary
3025 Stuff}. So if you want to set @code{message-from-style} via the group
3026 parameters, then you may need the following statement elsewhere in your
3027 @file{~/.gnus} file:
3030 (add-to-list 'gnus-newsgroup-variables 'message-from-style)
3033 @vindex gnus-list-identifiers
3034 A use for this feature is to remove a mailing list identifier tag in
3035 the subject fields of articles. E.g. if the news group
3038 nntp+news.gnus.org:gmane.text.docbook.apps
3041 has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this
3042 tag can be removed from the article subjects in the summary buffer for
3043 the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")}
3044 into the group parameters for the group.
3046 This can also be used as a group-specific hook function, if you'd like.
3047 If you want to hear a beep when you enter a group, you could put
3048 something like @code{(dummy-variable (ding))} in the parameters of that
3049 group. @code{dummy-variable} will be set to the result of the
3050 @code{(ding)} form, but who cares?
3054 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
3055 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
3056 presents you with a Customize-like interface. The latter helps avoid
3057 silly Lisp errors.) You might also be interested in reading about topic
3058 parameters (@pxref{Topic Parameters}).
3060 @vindex gnus-parameters
3061 Group parameters can be set via the @code{gnus-parameters} variable too.
3062 But some variables, such as @code{visible}, have no effect. For
3066 (setq gnus-parameters
3068 (gnus-show-threads nil)
3069 (gnus-use-scoring nil)
3070 (gnus-summary-line-format
3071 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3075 ("^nnimap:\\(foo.bar\\)$"
3079 (gnus-use-scoring t))
3083 (broken-reply-to . t))))
3086 String value of parameters will be subjected to regexp substitution, as
3087 the @code{to-group} example shows.
3090 @node Listing Groups
3091 @section Listing Groups
3092 @cindex group listing
3094 These commands all list various slices of the groups available.
3102 @findex gnus-group-list-groups
3103 List all groups that have unread articles
3104 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
3105 command will list only groups of level ARG and lower. By default, it
3106 only lists groups of level five (i.e.,
3107 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3114 @findex gnus-group-list-all-groups
3115 List all groups, whether they have unread articles or not
3116 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
3117 this command will list only groups of level ARG and lower. By default,
3118 it lists groups of level seven or lower (i.e., just subscribed and
3119 unsubscribed groups).
3123 @findex gnus-group-list-level
3124 List all unread groups on a specific level
3125 (@code{gnus-group-list-level}). If given a prefix, also list the groups
3126 with no unread articles.
3130 @findex gnus-group-list-killed
3131 List all killed groups (@code{gnus-group-list-killed}). If given a
3132 prefix argument, really list all groups that are available, but aren't
3133 currently (un)subscribed. This could entail reading the active file
3138 @findex gnus-group-list-zombies
3139 List all zombie groups (@code{gnus-group-list-zombies}).
3143 @findex gnus-group-list-matching
3144 List all unread, subscribed groups with names that match a regexp
3145 (@code{gnus-group-list-matching}).
3149 @findex gnus-group-list-all-matching
3150 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3154 @findex gnus-group-list-active
3155 List absolutely all groups in the active file(s) of the
3156 server(s) you are connected to (@code{gnus-group-list-active}). This
3157 might very well take quite a while. It might actually be a better idea
3158 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3159 thing to match on. Also note that this command may list groups that
3160 don't exist (yet)---these will be listed as if they were killed groups.
3161 Take the output with some grains of salt.
3165 @findex gnus-group-apropos
3166 List all groups that have names that match a regexp
3167 (@code{gnus-group-apropos}).
3171 @findex gnus-group-description-apropos
3172 List all groups that have names or descriptions that match a regexp
3173 (@code{gnus-group-description-apropos}).
3177 @findex gnus-group-list-cached
3178 List all groups with cached articles (@code{gnus-group-list-cached}).
3182 @findex gnus-group-list-dormant
3183 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3187 @findex gnus-group-list-limit
3188 List groups limited within the current selection
3189 (@code{gnus-group-list-limit}).
3193 @findex gnus-group-list-flush
3194 Flush groups from the current selection (@code{gnus-group-list-flush}).
3198 @findex gnus-group-list-plus
3199 List groups plus the current selection (@code{gnus-group-list-plus}).
3203 @vindex gnus-permanently-visible-groups
3204 @cindex visible group parameter
3205 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3206 always be shown, whether they have unread articles or not. You can also
3207 add the @code{visible} element to the group parameters in question to
3208 get the same effect.
3210 @vindex gnus-list-groups-with-ticked-articles
3211 Groups that have just ticked articles in it are normally listed in the
3212 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
3213 @code{nil}, these groups will be treated just like totally empty
3214 groups. It is @code{t} by default.
3217 @node Sorting Groups
3218 @section Sorting Groups
3219 @cindex sorting groups
3221 @kindex C-c C-s (Group)
3222 @findex gnus-group-sort-groups
3223 @vindex gnus-group-sort-function
3224 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3225 group buffer according to the function(s) given by the
3226 @code{gnus-group-sort-function} variable. Available sorting functions
3231 @item gnus-group-sort-by-alphabet
3232 @findex gnus-group-sort-by-alphabet
3233 Sort the group names alphabetically. This is the default.
3235 @item gnus-group-sort-by-real-name
3236 @findex gnus-group-sort-by-real-name
3237 Sort the group alphabetically on the real (unprefixed) group names.
3239 @item gnus-group-sort-by-level
3240 @findex gnus-group-sort-by-level
3241 Sort by group level.
3243 @item gnus-group-sort-by-score
3244 @findex gnus-group-sort-by-score
3245 Sort by group score. @xref{Group Score}.
3247 @item gnus-group-sort-by-rank
3248 @findex gnus-group-sort-by-rank
3249 Sort by group score and then the group level. The level and the score
3250 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3252 @item gnus-group-sort-by-unread
3253 @findex gnus-group-sort-by-unread
3254 Sort by number of unread articles.
3256 @item gnus-group-sort-by-method
3257 @findex gnus-group-sort-by-method
3258 Sort alphabetically on the select method.
3260 @item gnus-group-sort-by-server
3261 @findex gnus-group-sort-by-server
3262 Sort alphabetically on the Gnus server name.
3267 @code{gnus-group-sort-function} can also be a list of sorting
3268 functions. In that case, the most significant sort key function must be
3272 There are also a number of commands for sorting directly according to
3273 some sorting criteria:
3277 @kindex G S a (Group)
3278 @findex gnus-group-sort-groups-by-alphabet
3279 Sort the group buffer alphabetically by group name
3280 (@code{gnus-group-sort-groups-by-alphabet}).
3283 @kindex G S u (Group)
3284 @findex gnus-group-sort-groups-by-unread
3285 Sort the group buffer by the number of unread articles
3286 (@code{gnus-group-sort-groups-by-unread}).
3289 @kindex G S l (Group)
3290 @findex gnus-group-sort-groups-by-level
3291 Sort the group buffer by group level
3292 (@code{gnus-group-sort-groups-by-level}).
3295 @kindex G S v (Group)
3296 @findex gnus-group-sort-groups-by-score
3297 Sort the group buffer by group score
3298 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3301 @kindex G S r (Group)
3302 @findex gnus-group-sort-groups-by-rank
3303 Sort the group buffer by group rank
3304 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3307 @kindex G S m (Group)
3308 @findex gnus-group-sort-groups-by-method
3309 Sort the group buffer alphabetically by back end name@*
3310 (@code{gnus-group-sort-groups-by-method}).
3313 @kindex G S n (Group)
3314 @findex gnus-group-sort-groups-by-real-name
3315 Sort the group buffer alphabetically by real (unprefixed) group name
3316 (@code{gnus-group-sort-groups-by-real-name}).
3320 All the commands below obey the process/prefix convention
3321 (@pxref{Process/Prefix}).
3323 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3324 commands will sort in reverse order.
3326 You can also sort a subset of the groups:
3330 @kindex G P a (Group)
3331 @findex gnus-group-sort-selected-groups-by-alphabet
3332 Sort the groups alphabetically by group name
3333 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3336 @kindex G P u (Group)
3337 @findex gnus-group-sort-selected-groups-by-unread
3338 Sort the groups by the number of unread articles
3339 (@code{gnus-group-sort-selected-groups-by-unread}).
3342 @kindex G P l (Group)
3343 @findex gnus-group-sort-selected-groups-by-level
3344 Sort the groups by group level
3345 (@code{gnus-group-sort-selected-groups-by-level}).
3348 @kindex G P v (Group)
3349 @findex gnus-group-sort-selected-groups-by-score
3350 Sort the groups by group score
3351 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3354 @kindex G P r (Group)
3355 @findex gnus-group-sort-selected-groups-by-rank
3356 Sort the groups by group rank
3357 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3360 @kindex G P m (Group)
3361 @findex gnus-group-sort-selected-groups-by-method
3362 Sort the groups alphabetically by back end name@*
3363 (@code{gnus-group-sort-selected-groups-by-method}).
3366 @kindex G P n (Group)
3367 @findex gnus-group-sort-selected-groups-by-real-name
3368 Sort the groups alphabetically by real (unprefixed) group name
3369 (@code{gnus-group-sort-selected-groups-by-real-name}).
3372 @kindex G P s (Group)
3373 @findex gnus-group-sort-selected-groups
3374 Sort the groups according to @code{gnus-group-sort-function}.
3378 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3382 @node Group Maintenance
3383 @section Group Maintenance
3384 @cindex bogus groups
3389 @findex gnus-group-check-bogus-groups
3390 Find bogus groups and delete them
3391 (@code{gnus-group-check-bogus-groups}).
3395 @findex gnus-group-find-new-groups
3396 Find new groups and process them (@code{gnus-group-find-new-groups}).
3397 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3398 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3399 to query the server for new groups, and subscribe the new groups as
3403 @kindex C-c C-x (Group)
3404 @findex gnus-group-expire-articles
3405 Run all expirable articles in the current group through the expiry
3406 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3407 all expirable articles in the group that have been around for a while.
3408 (@pxref{Expiring Mail}).
3411 @kindex C-c C-M-x (Group)
3412 @findex gnus-group-expire-all-groups
3413 Run all expirable articles in all groups through the expiry process
3414 (@code{gnus-group-expire-all-groups}).
3419 @node Browse Foreign Server
3420 @section Browse Foreign Server
3421 @cindex foreign servers
3422 @cindex browsing servers
3427 @findex gnus-group-browse-foreign-server
3428 You will be queried for a select method and a server name. Gnus will
3429 then attempt to contact this server and let you browse the groups there
3430 (@code{gnus-group-browse-foreign-server}).
3433 @findex gnus-browse-mode
3434 A new buffer with a list of available groups will appear. This buffer
3435 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3436 a lot) like a normal group buffer.
3438 Here's a list of keystrokes available in the browse mode:
3443 @findex gnus-group-next-group
3444 Go to the next group (@code{gnus-group-next-group}).
3448 @findex gnus-group-prev-group
3449 Go to the previous group (@code{gnus-group-prev-group}).
3452 @kindex SPACE (Browse)
3453 @findex gnus-browse-read-group
3454 Enter the current group and display the first article
3455 (@code{gnus-browse-read-group}).
3458 @kindex RET (Browse)
3459 @findex gnus-browse-select-group
3460 Enter the current group (@code{gnus-browse-select-group}).
3464 @findex gnus-browse-unsubscribe-current-group
3465 Unsubscribe to the current group, or, as will be the case here,
3466 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3472 @findex gnus-browse-exit
3473 Exit browse mode (@code{gnus-browse-exit}).
3477 @findex gnus-browse-describe-group
3478 Describe the current group (@code{gnus-browse-describe-group}).
3482 @findex gnus-browse-describe-briefly
3483 Describe browse mode briefly (well, there's not much to describe, is
3484 there) (@code{gnus-browse-describe-briefly}).
3489 @section Exiting gnus
3490 @cindex exiting gnus
3492 Yes, gnus is ex(c)iting.
3497 @findex gnus-group-suspend
3498 Suspend gnus (@code{gnus-group-suspend}). This doesn't really exit gnus,
3499 but it kills all buffers except the Group buffer. I'm not sure why this
3500 is a gain, but then who am I to judge?
3504 @findex gnus-group-exit
3505 @c @icon{gnus-group-exit}
3506 Quit gnus (@code{gnus-group-exit}).
3510 @findex gnus-group-quit
3511 Quit gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3512 The dribble file will be saved, though (@pxref{Auto Save}).
3515 @vindex gnus-exit-gnus-hook
3516 @vindex gnus-suspend-gnus-hook
3517 @vindex gnus-after-exiting-gnus-hook
3518 @code{gnus-suspend-gnus-hook} is called when you suspend gnus and
3519 @code{gnus-exit-gnus-hook} is called when you quit gnus, while
3520 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3526 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3527 numbly heavy and herself fall into a hazy trance as the boy sitting
3528 behind her drew repeated lines with his pencil across the back of her
3534 @section Group Topics
3537 If you read lots and lots of groups, it might be convenient to group
3538 them hierarchically according to topics. You put your Emacs groups over
3539 here, your sex groups over there, and the rest (what, two groups or so?)
3540 you put in some misc section that you never bother with anyway. You can
3541 even group the Emacs sex groups as a sub-topic to either the Emacs
3542 groups or the sex groups---or both! Go wild!
3546 \gnusfigure{Group Topics}{400}{
3547 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3558 2: alt.religion.emacs
3561 0: comp.talk.emacs.recovery
3563 8: comp.binaries.fractals
3564 13: comp.sources.unix
3567 @findex gnus-topic-mode
3569 To get this @emph{fab} functionality you simply turn on (ooh!) the
3570 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3571 is a toggling command.)
3573 Go ahead, just try it. I'll still be here when you get back. La de
3574 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3575 Yes, and now press @kbd{l}. There. All your groups are now listed
3576 under @samp{misc}. Doesn't that make you feel all warm and fuzzy?
3579 If you want this permanently enabled, you should add that minor mode to
3580 the hook for the group mode. Put the following line in your
3581 @file{~/.gnus.el} file:
3584 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3588 * Topic Commands:: Interactive E-Z commands.
3589 * Topic Variables:: How to customize the topics the Lisp Way.
3590 * Topic Sorting:: Sorting each topic individually.
3591 * Topic Topology:: A map of the world.
3592 * Topic Parameters:: Parameters that apply to all groups in a topic.
3596 @node Topic Commands
3597 @subsection Topic Commands
3598 @cindex topic commands
3600 When the topic minor mode is turned on, a new @kbd{T} submap will be
3601 available. In addition, a few of the standard keys change their
3602 definitions slightly.
3604 In general, the following kinds of operations are possible on topics.
3605 First of all, you want to create topics. Secondly, you want to put
3606 groups in topics and to move them around until you have an order you
3607 like. The third kind of operation is to show/hide parts of the whole
3608 shebang. You might want to hide a topic including its subtopics and
3609 groups, to get a better overview of the other groups.
3611 Here is a list of the basic keys that you might need to set up topics
3618 @findex gnus-topic-create-topic
3619 Prompt for a new topic name and create it
3620 (@code{gnus-topic-create-topic}).
3624 @kindex T TAB (Topic)
3626 @findex gnus-topic-indent
3627 ``Indent'' the current topic so that it becomes a sub-topic of the
3628 previous topic (@code{gnus-topic-indent}). If given a prefix,
3629 ``un-indent'' the topic instead.
3632 @kindex M-TAB (Topic)
3633 @findex gnus-topic-unindent
3634 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3635 parent of its current parent (@code{gnus-topic-unindent}).
3639 The following two keys can be used to move groups and topics around.
3640 They work like the well-known cut and paste. @kbd{C-k} is like cut and
3641 @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms
3642 kill and yank rather than cut and paste.
3648 @findex gnus-topic-kill-group
3649 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3650 topic will be removed along with the topic.
3654 @findex gnus-topic-yank-group
3655 Yank the previously killed group or topic
3656 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3659 So, to move a topic to the beginning of the list of topics, just hit
3660 @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then,
3661 move the cursor to the beginning of the buffer (just below the ``Gnus''
3662 topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and
3663 paste. Like I said -- E-Z.
3665 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So
3666 you can move topics around as well as groups.
3670 After setting up the topics the way you like them, you might wish to
3671 hide a topic, or to show it again. That's why we have the following
3678 @findex gnus-topic-select-group
3680 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3681 When you perform this command on a group, you'll enter the group, as
3682 usual. When done on a topic line, the topic will be folded (if it was
3683 visible) or unfolded (if it was folded already). So it's basically a
3684 toggling command on topics. In addition, if you give a numerical
3685 prefix, group on that level (and lower) will be displayed.
3689 Now for a list of other commands, in no particular order.
3695 @findex gnus-topic-move-group
3696 Move the current group to some other topic
3697 (@code{gnus-topic-move-group}). This command uses the process/prefix
3698 convention (@pxref{Process/Prefix}).
3702 @findex gnus-topic-jump-to-topic
3703 Go to a topic (@code{gnus-topic-jump-to-topic}).
3707 @findex gnus-topic-copy-group
3708 Copy the current group to some other topic
3709 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3710 convention (@pxref{Process/Prefix}).
3714 @findex gnus-topic-hide-topic
3715 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3716 a prefix, hide the topic permanently.
3720 @findex gnus-topic-show-topic
3721 Show the current topic (@code{gnus-topic-show-topic}). If given
3722 a prefix, show the topic permanently.
3726 @findex gnus-topic-remove-group
3727 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3728 This command is mainly useful if you have the same group in several
3729 topics and wish to remove it from one of the topics. You may also
3730 remove a group from all topics, but in that case, Gnus will add it to
3731 the root topic the next time you start Gnus. In fact, all new groups
3732 (which, naturally, don't belong to any topic) will show up in the root
3735 This command uses the process/prefix convention
3736 (@pxref{Process/Prefix}).
3740 @findex gnus-topic-move-matching
3741 Move all groups that match some regular expression to a topic
3742 (@code{gnus-topic-move-matching}).
3746 @findex gnus-topic-copy-matching
3747 Copy all groups that match some regular expression to a topic
3748 (@code{gnus-topic-copy-matching}).
3752 @findex gnus-topic-toggle-display-empty-topics
3753 Toggle hiding empty topics
3754 (@code{gnus-topic-toggle-display-empty-topics}).
3758 @findex gnus-topic-mark-topic
3759 Mark all groups in the current topic with the process mark
3760 (@code{gnus-topic-mark-topic}). This command works recursively on
3761 sub-topics unless given a prefix.
3764 @kindex T M-# (Topic)
3765 @findex gnus-topic-unmark-topic
3766 Remove the process mark from all groups in the current topic
3767 (@code{gnus-topic-unmark-topic}). This command works recursively on
3768 sub-topics unless given a prefix.
3771 @kindex C-c C-x (Topic)
3772 @findex gnus-topic-expire-articles
3773 Run all expirable articles in the current group or topic through the
3774 expiry process (if any)
3775 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3779 @findex gnus-topic-rename
3780 Rename a topic (@code{gnus-topic-rename}).
3783 @kindex T DEL (Topic)
3784 @findex gnus-topic-delete
3785 Delete an empty topic (@code{gnus-topic-delete}).
3789 @findex gnus-topic-list-active
3790 List all groups that gnus knows about in a topics-ified way
3791 (@code{gnus-topic-list-active}).
3794 @kindex T M-n (Topic)
3795 @findex gnus-topic-goto-next-topic
3796 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3799 @kindex T M-p (Topic)
3800 @findex gnus-topic-goto-previous-topic
3801 Go to the next topic (@code{gnus-topic-goto-previous-topic}).
3805 @findex gnus-topic-edit-parameters
3806 @cindex group parameters
3807 @cindex topic parameters
3809 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3810 @xref{Topic Parameters}.
3815 @node Topic Variables
3816 @subsection Topic Variables
3817 @cindex topic variables
3819 The previous section told you how to tell Gnus which topics to display.
3820 This section explains how to tell Gnus what to display about each topic.
3822 @vindex gnus-topic-line-format
3823 The topic lines themselves are created according to the
3824 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3837 Number of groups in the topic.
3839 Number of unread articles in the topic.
3841 Number of unread articles in the topic and all its subtopics.
3844 @vindex gnus-topic-indent-level
3845 Each sub-topic (and the groups in the sub-topics) will be indented with
3846 @code{gnus-topic-indent-level} times the topic level number of spaces.
3849 @vindex gnus-topic-mode-hook
3850 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3852 @vindex gnus-topic-display-empty-topics
3853 The @code{gnus-topic-display-empty-topics} says whether to display even
3854 topics that have no unread articles in them. The default is @code{t}.
3858 @subsection Topic Sorting
3859 @cindex topic sorting
3861 You can sort the groups in each topic individually with the following
3867 @kindex T S a (Topic)
3868 @findex gnus-topic-sort-groups-by-alphabet
3869 Sort the current topic alphabetically by group name
3870 (@code{gnus-topic-sort-groups-by-alphabet}).
3873 @kindex T S u (Topic)
3874 @findex gnus-topic-sort-groups-by-unread
3875 Sort the current topic by the number of unread articles
3876 (@code{gnus-topic-sort-groups-by-unread}).
3879 @kindex T S l (Topic)
3880 @findex gnus-topic-sort-groups-by-level
3881 Sort the current topic by group level
3882 (@code{gnus-topic-sort-groups-by-level}).
3885 @kindex T S v (Topic)
3886 @findex gnus-topic-sort-groups-by-score
3887 Sort the current topic by group score
3888 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
3891 @kindex T S r (Topic)
3892 @findex gnus-topic-sort-groups-by-rank
3893 Sort the current topic by group rank
3894 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
3897 @kindex T S m (Topic)
3898 @findex gnus-topic-sort-groups-by-method
3899 Sort the current topic alphabetically by back end name
3900 (@code{gnus-topic-sort-groups-by-method}).
3903 @kindex T S e (Topic)
3904 @findex gnus-topic-sort-groups-by-server
3905 Sort the current topic alphabetically by server name
3906 (@code{gnus-topic-sort-groups-by-server}).
3909 @kindex T S s (Topic)
3910 @findex gnus-topic-sort-groups
3911 Sort the current topic according to the function(s) given by the
3912 @code{gnus-group-sort-function} variable
3913 (@code{gnus-topic-sort-groups}).
3917 When given a prefix argument, all these commands will sort in reverse
3918 order. @xref{Sorting Groups}, for more information about group
3922 @node Topic Topology
3923 @subsection Topic Topology
3924 @cindex topic topology
3927 So, let's have a look at an example group buffer:
3934 2: alt.religion.emacs
3937 0: comp.talk.emacs.recovery
3939 8: comp.binaries.fractals
3940 13: comp.sources.unix
3944 So, here we have one top-level topic (@samp{Gnus}), two topics under
3945 that, and one sub-topic under one of the sub-topics. (There is always
3946 just one (1) top-level topic). This topology can be expressed as
3951 (("Emacs -- I wuw it!" visible)
3952 (("Naughty Emacs" visible)))
3956 @vindex gnus-topic-topology
3957 This is in fact how the variable @code{gnus-topic-topology} would look
3958 for the display above. That variable is saved in the @file{.newsrc.eld}
3959 file, and shouldn't be messed with manually---unless you really want
3960 to. Since this variable is read from the @file{.newsrc.eld} file,
3961 setting it in any other startup files will have no effect.
3963 This topology shows what topics are sub-topics of what topics (right),
3964 and which topics are visible. Two settings are currently
3965 allowed---@code{visible} and @code{invisible}.
3968 @node Topic Parameters
3969 @subsection Topic Parameters
3970 @cindex topic parameters
3972 All groups in a topic will inherit group parameters from the parent
3973 (and ancestor) topic parameters. All valid group parameters are valid
3974 topic parameters (@pxref{Group Parameters}). When the agent is
3975 enabled, all agent parameters (See Agent Parameters in @ref{Category
3976 Syntax}) are also valid topic parameters.
3978 In addition, the following parameters are only valid as topic
3983 When subscribing new groups by topic (@pxref{Subscription Methods}), the
3984 @code{subscribe} topic parameter says what groups go in what topic. Its
3985 value should be a regexp to match the groups that should go in that
3988 @item subscribe-level
3989 When subscribing new groups by topic (see the @code{subscribe} parameter),
3990 the group will be subscribed with the level specified in the
3991 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
3995 Group parameters (of course) override topic parameters, and topic
3996 parameters in sub-topics override topic parameters in super-topics. You
3997 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
3998 verb, although you may feel free to disagree with me here.)
4005 2: alt.religion.emacs
4009 0: comp.talk.emacs.recovery
4011 8: comp.binaries.fractals
4012 13: comp.sources.unix
4017 The @samp{Emacs} topic has the topic parameter @code{(score-file
4018 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4019 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4020 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
4021 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4022 . "religion.SCORE")}.
4024 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4025 will get the @file{relief.SCORE} home score file. If you enter the same
4026 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4027 score file. If you enter the group @samp{alt.religion.emacs}, you'll
4028 get the @file{religion.SCORE} home score file.
4030 This seems rather simple and self-evident, doesn't it? Well, yes. But
4031 there are some problems, especially with the @code{total-expiry}
4032 parameter. Say you have a mail group in two topics; one with
4033 @code{total-expiry} and one without. What happens when you do @kbd{M-x
4034 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
4035 of these topics you mean to expire articles from, so anything may
4036 happen. In fact, I hereby declare that it is @dfn{undefined} what
4037 happens. You just have to be careful if you do stuff like that.
4040 @node Misc Group Stuff
4041 @section Misc Group Stuff
4044 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
4045 * Group Information:: Information and help on groups and Gnus.
4046 * Group Timestamp:: Making Gnus keep track of when you last read a group.
4047 * File Commands:: Reading and writing the Gnus files.
4048 * Sieve Commands:: Managing Sieve scripts.
4055 @findex gnus-group-enter-server-mode
4056 Enter the server buffer (@code{gnus-group-enter-server-mode}).
4057 @xref{Server Buffer}.
4061 @findex gnus-group-post-news
4062 Start composing a message (a news by default)
4063 (@code{gnus-group-post-news}). If given a prefix, post to the group
4064 under the point. If the prefix is 1, prompt for a group to post to.
4065 Contrary to what the name of this function suggests, the prepared
4066 article might be a mail instead of a news, if a mail group is specified
4067 with the prefix argument. @xref{Composing Messages}.
4071 @findex gnus-group-mail
4072 Mail a message somewhere (@code{gnus-group-mail}). If given a prefix,
4073 use the posting style of the group under the point. If the prefix is 1,
4074 prompt for a group name to find the posting style.
4075 @xref{Composing Messages}.
4079 @findex gnus-group-news
4080 Start composing a news (@code{gnus-group-news}). If given a prefix,
4081 post to the group under the point. If the prefix is 1, prompt
4082 for group to post to. @xref{Composing Messages}.
4084 This function actually prepares a news even when using mail groups.
4085 This is useful for ``posting'' messages to mail groups without actually
4086 sending them over the network: they're just saved directly to the group
4087 in question. The corresponding back end must have a request-post method
4088 for this to work though.
4092 Variables for the group buffer:
4096 @item gnus-group-mode-hook
4097 @vindex gnus-group-mode-hook
4098 is called after the group buffer has been
4101 @item gnus-group-prepare-hook
4102 @vindex gnus-group-prepare-hook
4103 is called after the group buffer is
4104 generated. It may be used to modify the buffer in some strange,
4107 @item gnus-group-prepared-hook
4108 @vindex gnus-group-prepare-hook
4109 is called as the very last thing after the group buffer has been
4110 generated. It may be used to move point around, for instance.
4112 @item gnus-permanently-visible-groups
4113 @vindex gnus-permanently-visible-groups
4114 Groups matching this regexp will always be listed in the group buffer,
4115 whether they are empty or not.
4117 @item gnus-group-name-charset-method-alist
4118 @vindex gnus-group-name-charset-method-alist
4119 An alist of method and the charset for group names. It is used to show
4120 non-@acronym{ASCII} group names.
4124 (setq gnus-group-name-charset-method-alist
4125 '(((nntp "news.com.cn") . cn-gb-2312)))
4128 @item gnus-group-name-charset-group-alist
4129 @cindex UTF-8 group names
4130 @vindex gnus-group-name-charset-group-alist
4131 An alist of regexp of group name and the charset for group names. It
4132 is used to show non-@acronym{ASCII} group names. @code{((".*"
4133 utf-8))} is the default value if UTF-8 is supported, otherwise the
4134 default is @code{nil}.
4138 (setq gnus-group-name-charset-group-alist
4139 '(("\\.com\\.cn:" . cn-gb-2312)))
4144 @node Scanning New Messages
4145 @subsection Scanning New Messages
4146 @cindex new messages
4147 @cindex scanning new news
4153 @findex gnus-group-get-new-news
4154 @c @icon{gnus-group-get-new-news}
4155 Check the server(s) for new articles. If the numerical prefix is used,
4156 this command will check only groups of level @var{arg} and lower
4157 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
4158 command will force a total re-reading of the active file(s) from the
4163 @findex gnus-group-get-new-news-this-group
4164 @vindex gnus-goto-next-group-when-activating
4165 @c @icon{gnus-group-get-new-news-this-group}
4166 Check whether new articles have arrived in the current group
4167 (@code{gnus-group-get-new-news-this-group}).
4168 @code{gnus-goto-next-group-when-activating} says whether this command is
4169 to move point to the next group or not. It is @code{t} by default.
4171 @findex gnus-activate-all-groups
4172 @cindex activating groups
4174 @kindex C-c M-g (Group)
4175 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4180 @findex gnus-group-restart
4181 Restart gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
4182 file(s), closes the connection to all servers, clears up all run-time
4183 gnus variables, and then starts gnus all over again.
4187 @vindex gnus-get-new-news-hook
4188 @code{gnus-get-new-news-hook} is run just before checking for new news.
4190 @vindex gnus-after-getting-new-news-hook
4191 @code{gnus-after-getting-new-news-hook} is run after checking for new
4195 @node Group Information
4196 @subsection Group Information
4197 @cindex group information
4198 @cindex information on groups
4205 @findex gnus-group-fetch-faq
4206 @vindex gnus-group-faq-directory
4209 Try to fetch the @acronym{FAQ} for the current group
4210 (@code{gnus-group-fetch-faq}). Gnus will try to get the @acronym{FAQ}
4211 from @code{gnus-group-faq-directory}, which is usually a directory on
4212 a remote machine. This variable can also be a list of directories.
4213 In that case, giving a prefix to this command will allow you to choose
4214 between the various sites. @code{ange-ftp} (or @code{efs}) will be
4215 used for fetching the file.
4217 If fetching from the first site is unsuccessful, gnus will attempt to go
4218 through @code{gnus-group-faq-directory} and try to open them one by one.
4222 @findex gnus-group-fetch-charter
4223 @vindex gnus-group-charter-alist
4225 Try to open the charter for the current group in a web browser
4226 (@code{gnus-group-fetch-charter}). Query for a group if given a
4229 Gnus will use @code{gnus-group-charter-alist} to find the location of
4230 the charter. If no location is known, Gnus will fetch the control
4231 messages for the group, which in some cases includes the charter.
4235 @findex gnus-group-fetch-control
4236 @vindex gnus-group-fetch-control-use-browse-url
4237 @cindex control message
4238 Fetch the control messages for the group from the archive at
4239 @code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a
4240 group if given a prefix argument.
4242 If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
4243 Gnus will open the control messages in a browser using
4244 @code{browse-url}. Otherwise they are fetched using @code{ange-ftp}
4245 and displayed in an ephemeral group.
4247 Note that the control messages are compressed. To use this command
4248 you need to turn on @code{auto-compression-mode} (@pxref{Compressed
4249 Files, ,Compressed Files, emacs, The Emacs Manual}).
4253 @c @icon{gnus-group-describe-group}
4255 @kindex C-c C-d (Group)
4256 @cindex describing groups
4257 @cindex group description
4258 @findex gnus-group-describe-group
4259 Describe the current group (@code{gnus-group-describe-group}). If given
4260 a prefix, force Gnus to re-read the description from the server.
4264 @findex gnus-group-describe-all-groups
4265 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
4266 prefix, force gnus to re-read the description file from the server.
4273 @findex gnus-version
4274 Display current gnus version numbers (@code{gnus-version}).
4278 @findex gnus-group-describe-briefly
4279 Give a very short help message (@code{gnus-group-describe-briefly}).
4282 @kindex C-c C-i (Group)
4285 @findex gnus-info-find-node
4286 Go to the gnus info node (@code{gnus-info-find-node}).
4290 @node Group Timestamp
4291 @subsection Group Timestamp
4293 @cindex group timestamps
4295 It can be convenient to let gnus keep track of when you last read a
4296 group. To set the ball rolling, you should add
4297 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4300 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4303 After doing this, each time you enter a group, it'll be recorded.
4305 This information can be displayed in various ways---the easiest is to
4306 use the @samp{%d} spec in the group line format:
4309 (setq gnus-group-line-format
4310 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4313 This will result in lines looking like:
4316 * 0: mail.ding 19961002T012943
4317 0: custom 19961002T012713
4320 As you can see, the date is displayed in compact ISO 8601 format. This
4321 may be a bit too much, so to just display the date, you could say
4325 (setq gnus-group-line-format
4326 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4329 If you would like greater control of the time format, you can use a
4330 user-defined format spec. Something like the following should do the
4334 (setq gnus-group-line-format
4335 "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4336 (defun gnus-user-format-function-d (headers)
4337 (let ((time (gnus-group-timestamp gnus-tmp-group)))
4339 (format-time-string "%b %d %H:%M" time)
4345 @subsection File Commands
4346 @cindex file commands
4352 @findex gnus-group-read-init-file
4353 @vindex gnus-init-file
4354 @cindex reading init file
4355 Re-read the init file (@code{gnus-init-file}, which defaults to
4356 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
4360 @findex gnus-group-save-newsrc
4361 @cindex saving .newsrc
4362 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4363 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
4364 file(s) whether Gnus thinks it is necessary or not.
4367 @c @kindex Z (Group)
4368 @c @findex gnus-group-clear-dribble
4369 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4374 @node Sieve Commands
4375 @subsection Sieve Commands
4376 @cindex group sieve commands
4378 Sieve is a server-side mail filtering language. In Gnus you can use
4379 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4380 sieve rules that should apply to each group. Gnus provides two
4381 commands to translate all these group parameters into a proper Sieve
4382 script that can be transfered to the server somehow.
4384 @vindex gnus-sieve-file
4385 @vindex gnus-sieve-region-start
4386 @vindex gnus-sieve-region-end
4387 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4388 default @file{~/.sieve}). The Sieve code that Gnus generate is placed
4389 between two delimiters, @code{gnus-sieve-region-start} and
4390 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4391 outside these delimiters that will not be removed the next time you
4392 regenerate the Sieve script.
4394 @vindex gnus-sieve-crosspost
4395 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4396 is generated. If it is non-@code{nil} (the default) articles is
4397 placed in all groups that have matching rules, otherwise the article
4398 is only placed in the group with the first matching rule. For
4399 example, the group parameter @samp{(sieve address "sender"
4400 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4401 code if @code{gnus-sieve-crosspost} is @code{nil}. (When
4402 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
4403 except that the line containing the call to @code{stop} is removed.)
4406 if address "sender" "owner-ding@@hpc.uh.edu" @{
4407 fileinto "INBOX.ding";
4412 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
4418 @findex gnus-sieve-generate
4419 @vindex gnus-sieve-file
4420 @cindex generating sieve script
4421 Regenerate a Sieve script from the @code{sieve} group parameters and
4422 put you into the @code{gnus-sieve-file} without saving it.
4426 @findex gnus-sieve-update
4427 @vindex gnus-sieve-file
4428 @cindex updating sieve script
4429 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4430 @code{sieve} group parameters, save the file and upload it to the
4431 server using the @code{sieveshell} program.
4436 @node Summary Buffer
4437 @chapter Summary Buffer
4438 @cindex summary buffer
4440 A line for each article is displayed in the summary buffer. You can
4441 move around, read articles, post articles and reply to articles.
4443 The most common way to a summary buffer is to select a group from the
4444 group buffer (@pxref{Selecting a Group}).
4446 You can have as many summary buffers open as you wish.
4449 * Summary Buffer Format:: Deciding how the summary buffer is to look.
4450 * Summary Maneuvering:: Moving around the summary buffer.
4451 * Choosing Articles:: Reading articles.
4452 * Paging the Article:: Scrolling the current article.
4453 * Reply Followup and Post:: Posting articles.
4454 * Delayed Articles:: Send articles at a later time.
4455 * Marking Articles:: Marking articles as read, expirable, etc.
4456 * Limiting:: You can limit the summary buffer.
4457 * Threading:: How threads are made.
4458 * Sorting the Summary Buffer:: How articles and threads are sorted.
4459 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
4460 * Article Caching:: You may store articles in a cache.
4461 * Persistent Articles:: Making articles expiry-resistant.
4462 * Article Backlog:: Having already read articles hang around.
4463 * Saving Articles:: Ways of customizing article saving.
4464 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
4465 * Article Treatment:: The article buffer can be mangled at will.
4466 * MIME Commands:: Doing MIMEy things with the articles.
4467 * Charsets:: Character set issues.
4468 * Article Commands:: Doing various things with the article buffer.
4469 * Summary Sorting:: Sorting the summary buffer in various ways.
4470 * Finding the Parent:: No child support? Get the parent.
4471 * Alternative Approaches:: Reading using non-default summaries.
4472 * Tree Display:: A more visual display of threads.
4473 * Mail Group Commands:: Some commands can only be used in mail groups.
4474 * Various Summary Stuff:: What didn't fit anywhere else.
4475 * Exiting the Summary Buffer:: Returning to the Group buffer,
4476 or reselecting the current group.
4477 * Crosspost Handling:: How crossposted articles are dealt with.
4478 * Duplicate Suppression:: An alternative when crosspost handling fails.
4479 * Security:: Decrypt and Verify.
4480 * Mailing List:: Mailing list minor mode.
4484 @node Summary Buffer Format
4485 @section Summary Buffer Format
4486 @cindex summary buffer format
4490 \gnusfigure{The Summary Buffer}{180}{
4491 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4492 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4498 * Summary Buffer Lines:: You can specify how summary lines should look.
4499 * To From Newsgroups:: How to not display your own name.
4500 * Summary Buffer Mode Line:: You can say how the mode line should look.
4501 * Summary Highlighting:: Making the summary buffer all pretty and nice.
4504 @findex mail-extract-address-components
4505 @findex gnus-extract-address-components
4506 @vindex gnus-extract-address-components
4507 Gnus will use the value of the @code{gnus-extract-address-components}
4508 variable as a function for getting the name and address parts of a
4509 @code{From} header. Three pre-defined functions exist:
4510 @code{gnus-extract-address-components}, which is the default, quite
4511 fast, and too simplistic solution;
4512 @code{mail-extract-address-components}, which works nicely, but is
4513 slower; and @code{std11-extract-address-components}, which works very
4514 nicely, but is slower. The default function will return the wrong
4515 answer in 5% of the cases. If this is unacceptable to you, use the
4516 other function instead:
4519 (setq gnus-extract-address-components
4520 'mail-extract-address-components)
4523 @vindex gnus-summary-same-subject
4524 @code{gnus-summary-same-subject} is a string indicating that the current
4525 article has the same subject as the previous. This string will be used
4526 with those specs that require it. The default is @code{""}.
4529 @node Summary Buffer Lines
4530 @subsection Summary Buffer Lines
4532 @vindex gnus-summary-line-format
4533 You can change the format of the lines in the summary buffer by changing
4534 the @code{gnus-summary-line-format} variable. It works along the same
4535 lines as a normal @code{format} string, with some extensions
4536 (@pxref{Formatting Variables}).
4538 There should always be a colon or a point position marker on the line;
4539 the cursor always moves to the point position marker or the colon after
4540 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
4541 possible to change this. Just write a new function
4542 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4543 @xref{Positioning Point}.
4545 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4547 The following format specification characters and extended format
4548 specification(s) are understood:
4554 Subject string. List identifiers stripped,
4555 @code{gnus-list-identifies}. @xref{Article Hiding}.
4557 Subject if the article is the root of the thread or the previous article
4558 had a different subject, @code{gnus-summary-same-subject} otherwise.
4559 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4561 Full @code{From} header.
4563 The name (from the @code{From} header).
4565 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4568 The name (from the @code{From} header). This differs from the @code{n}
4569 spec in that it uses the function designated by the
4570 @code{gnus-extract-address-components} variable, which is slower, but
4571 may be more thorough.
4573 The address (from the @code{From} header). This works the same way as
4576 Number of lines in the article.
4578 Number of characters in the article. This specifier is not supported
4579 in some methods (like nnfolder).
4581 Pretty-printed version of the number of characters in the article;
4582 for example, @samp{1.2k} or @samp{0.4M}.
4584 Indentation based on thread level (@pxref{Customizing Threading}).
4586 A complex trn-style thread tree, showing response-connecting trace
4587 lines. A thread could be drawn like this:
4600 You can customize the appearance with the following options. Note
4601 that it is possible to make the thread display look really neat by
4602 replacing the default @acronym{ASCII} characters with graphic
4603 line-drawing glyphs.
4605 @item gnus-sum-thread-tree-root
4606 @vindex gnus-sum-thread-tree-root
4607 Used for the root of a thread. If @code{nil}, use subject
4608 instead. The default is @samp{> }.
4610 @item gnus-sum-thread-tree-false-root
4611 @vindex gnus-sum-thread-tree-false-root
4612 Used for the false root of a thread (@pxref{Loose Threads}). If
4613 @code{nil}, use subject instead. The default is @samp{> }.
4615 @item gnus-sum-thread-tree-single-indent
4616 @vindex gnus-sum-thread-tree-single-indent
4617 Used for a thread with just one message. If @code{nil}, use subject
4618 instead. The default is @samp{}.
4620 @item gnus-sum-thread-tree-vertical
4621 @vindex gnus-sum-thread-tree-vertical
4622 Used for drawing a vertical line. The default is @samp{| }.
4624 @item gnus-sum-thread-tree-indent
4625 @vindex gnus-sum-thread-tree-indent
4626 Used for indenting. The default is @samp{ }.
4628 @item gnus-sum-thread-tree-leaf-with-other
4629 @vindex gnus-sum-thread-tree-leaf-with-other
4630 Used for a leaf with brothers. The default is @samp{+-> }.
4632 @item gnus-sum-thread-tree-single-leaf
4633 @vindex gnus-sum-thread-tree-single-leaf
4634 Used for a leaf without brothers. The default is @samp{\-> }
4639 Nothing if the article is a root and lots of spaces if it isn't (it
4640 pushes everything after it off the screen).
4642 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4643 for adopted articles (@pxref{Customizing Threading}).
4645 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4646 for adopted articles.
4648 One space for each thread level.
4650 Twenty minus thread level spaces.
4652 Unread. @xref{Read Articles}.
4655 This misleadingly named specifier is the @dfn{secondary mark}. This
4656 mark will say whether the article has been replied to, has been cached,
4657 or has been saved. @xref{Other Marks}.
4660 Score as a number (@pxref{Scoring}).
4662 @vindex gnus-summary-zcore-fuzz
4663 Zcore, @samp{+} if above the default level and @samp{-} if below the
4664 default level. If the difference between
4665 @code{gnus-summary-default-score} and the score is less than
4666 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4674 The @code{Date} in @code{DD-MMM} format.
4676 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4682 Number of articles in the current sub-thread. Using this spec will slow
4683 down summary buffer generation somewhat.
4685 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4686 article has any children.
4692 Age sensitive date format. Various date format is defined in
4693 @code{gnus-user-date-format-alist}.
4695 User defined specifier. The next character in the format string should
4696 be a letter. Gnus will call the function
4697 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
4698 following @samp{%u}. The function will be passed the current header as
4699 argument. The function should return a string, which will be inserted
4700 into the summary just like information from any other summary specifier.
4703 Text between @samp{%(} and @samp{%)} will be highlighted with
4704 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4705 There can only be one such area.
4707 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4708 have to be handled with care. For reasons of efficiency, gnus will
4709 compute what column these characters will end up in, and ``hard-code''
4710 that. This means that it is invalid to have these specs after a
4711 variable-length spec. Well, you might not be arrested, but your summary
4712 buffer will look strange, which is bad enough.
4714 The smart choice is to have these specs as far to the left as possible.
4715 (Isn't that the case with everything, though? But I digress.)
4717 This restriction may disappear in later versions of gnus.
4720 @node To From Newsgroups
4721 @subsection To From Newsgroups
4725 In some groups (particularly in archive groups), the @code{From} header
4726 isn't very interesting, since all the articles there are written by
4727 you. To display the information in the @code{To} or @code{Newsgroups}
4728 headers instead, you need to decide three things: What information to
4729 gather; where to display it; and when to display it.
4733 @vindex gnus-extra-headers
4734 The reading of extra header information is controlled by the
4735 @code{gnus-extra-headers}. This is a list of header symbols. For
4739 (setq gnus-extra-headers
4740 '(To Newsgroups X-Newsreader))
4743 This will result in Gnus trying to obtain these three headers, and
4744 storing it in header structures for later easy retrieval.
4747 @findex gnus-extra-header
4748 The value of these extra headers can be accessed via the
4749 @code{gnus-extra-header} function. Here's a format line spec that will
4750 access the @code{X-Newsreader} header:
4753 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4757 @vindex gnus-ignored-from-addresses
4758 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4759 summary line spec returns the @code{To}, @code{Newsreader} or
4760 @code{From} header. If this regexp matches the contents of the
4761 @code{From} header, the value of the @code{To} or @code{Newsreader}
4762 headers are used instead.
4766 @vindex nnmail-extra-headers
4767 A related variable is @code{nnmail-extra-headers}, which controls when
4768 to include extra headers when generating overview (@acronym{NOV}) files.
4769 If you have old overview files, you should regenerate them after
4770 changing this variable, by entering the server buffer using @kbd{^},
4771 and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause
4774 @vindex gnus-summary-line-format
4775 You also have to instruct Gnus to display the data by changing the
4776 @code{%n} spec to the @code{%f} spec in the
4777 @code{gnus-summary-line-format} variable.
4779 In summary, you'd typically put something like the following in
4783 (setq gnus-extra-headers
4785 (setq nnmail-extra-headers gnus-extra-headers)
4786 (setq gnus-summary-line-format
4787 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
4788 (setq gnus-ignored-from-addresses
4792 (The values listed above are the default values in Gnus. Alter them
4795 A note for news server administrators, or for users who wish to try to
4796 convince their news server administrator to provide some additional
4799 The above is mostly useful for mail groups, where you have control over
4800 the @acronym{NOV} files that are created. However, if you can persuade your
4801 nntp admin to add (in the usual implementation, notably INN):
4807 to the end of her @file{overview.fmt} file, then you can use that just
4808 as you would the extra headers from the mail groups.
4811 @node Summary Buffer Mode Line
4812 @subsection Summary Buffer Mode Line
4814 @vindex gnus-summary-mode-line-format
4815 You can also change the format of the summary mode bar (@pxref{Mode Line
4816 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
4817 like. The default is @samp{Gnus: %%b [%A] %Z}.
4819 Here are the elements you can play with:
4825 Unprefixed group name.
4827 Current article number.
4829 Current article score.
4833 Number of unread articles in this group.
4835 Number of unread articles in this group that aren't displayed in the
4838 A string with the number of unread and unselected articles represented
4839 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4840 articles, and just as @samp{<%U more>} if there are just unread articles
4841 and no unselected ones.
4843 Shortish group name. For instance, @samp{rec.arts.anime} will be
4844 shortened to @samp{r.a.anime}.
4846 Subject of the current article.
4848 User-defined spec (@pxref{User-Defined Specs}).
4850 Name of the current score file (@pxref{Scoring}).
4852 Number of dormant articles (@pxref{Unread Articles}).
4854 Number of ticked articles (@pxref{Unread Articles}).
4856 Number of articles that have been marked as read in this session.
4858 Number of articles expunged by the score files.
4862 @node Summary Highlighting
4863 @subsection Summary Highlighting
4867 @item gnus-visual-mark-article-hook
4868 @vindex gnus-visual-mark-article-hook
4869 This hook is run after selecting an article. It is meant to be used for
4870 highlighting the article in some way. It is not run if
4871 @code{gnus-visual} is @code{nil}.
4873 @item gnus-summary-update-hook
4874 @vindex gnus-summary-update-hook
4875 This hook is called when a summary line is changed. It is not run if
4876 @code{gnus-visual} is @code{nil}.
4878 @item gnus-summary-selected-face
4879 @vindex gnus-summary-selected-face
4880 This is the face (or @dfn{font} as some people call it) used to
4881 highlight the current article in the summary buffer.
4883 @item gnus-summary-highlight
4884 @vindex gnus-summary-highlight
4885 Summary lines are highlighted according to this variable, which is a
4886 list where the elements are of the format @code{(@var{form}
4887 . @var{face})}. If you would, for instance, like ticked articles to be
4888 italic and high-scored articles to be bold, you could set this variable
4891 (((eq mark gnus-ticked-mark) . italic)
4892 ((> score default) . bold))
4894 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4895 @var{face} will be applied to the line.
4899 @node Summary Maneuvering
4900 @section Summary Maneuvering
4901 @cindex summary movement
4903 All the straight movement commands understand the numeric prefix and
4904 behave pretty much as you'd expect.
4906 None of these commands select articles.
4911 @kindex M-n (Summary)
4912 @kindex G M-n (Summary)
4913 @findex gnus-summary-next-unread-subject
4914 Go to the next summary line of an unread article
4915 (@code{gnus-summary-next-unread-subject}).
4919 @kindex M-p (Summary)
4920 @kindex G M-p (Summary)
4921 @findex gnus-summary-prev-unread-subject
4922 Go to the previous summary line of an unread article
4923 (@code{gnus-summary-prev-unread-subject}).
4926 @kindex G g (Summary)
4927 @findex gnus-summary-goto-subject
4928 Ask for an article number and then go to the summary line of that article
4929 without displaying the article (@code{gnus-summary-goto-subject}).
4932 If gnus asks you to press a key to confirm going to the next group, you
4933 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4934 buffer, searching for the next group to read without actually returning
4935 to the group buffer.
4937 Variables related to summary movement:
4941 @vindex gnus-auto-select-next
4942 @item gnus-auto-select-next
4943 If you issue one of the movement commands (like @kbd{n}) and there are
4944 no more unread articles after the current one, gnus will offer to go to
4945 the next group. If this variable is @code{t} and the next group is
4946 empty, gnus will exit summary mode and return to the group buffer. If
4947 this variable is neither @code{t} nor @code{nil}, gnus will select the
4948 next group with unread articles. As a special case, if this variable
4949 is @code{quietly}, Gnus will select the next group without asking for
4950 confirmation. If this variable is @code{almost-quietly}, the same
4951 will happen only if you are located on the last article in the group.
4952 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
4953 command will go to the next group without confirmation. Also
4954 @pxref{Group Levels}.
4956 @item gnus-auto-select-same
4957 @vindex gnus-auto-select-same
4958 If non-@code{nil}, all the movement commands will try to go to the next
4959 article with the same subject as the current. (@dfn{Same} here might
4960 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
4961 for details (@pxref{Customizing Threading}).) If there are no more
4962 articles with the same subject, go to the first unread article.
4964 This variable is not particularly useful if you use a threaded display.
4966 @item gnus-summary-check-current
4967 @vindex gnus-summary-check-current
4968 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4969 to the next (or previous) article if the current article is unread.
4970 Instead, they will choose the current article.
4972 @item gnus-auto-center-summary
4973 @vindex gnus-auto-center-summary
4974 If non-@code{nil}, gnus will keep the point in the summary buffer
4975 centered at all times. This makes things quite tidy, but if you have a
4976 slow network connection, or simply do not like this un-Emacsism, you can
4977 set this variable to @code{nil} to get the normal Emacs scrolling
4978 action. This will also inhibit horizontal re-centering of the summary
4979 buffer, which might make it more inconvenient to read extremely long
4982 This variable can also be a number. In that case, center the window at
4983 the given number of lines from the top.
4988 @node Choosing Articles
4989 @section Choosing Articles
4990 @cindex selecting articles
4993 * Choosing Commands:: Commands for choosing articles.
4994 * Choosing Variables:: Variables that influence these commands.
4998 @node Choosing Commands
4999 @subsection Choosing Commands
5001 None of the following movement commands understand the numeric prefix,
5002 and they all select and display an article.
5004 If you want to fetch new articles or redisplay the group, see
5005 @ref{Exiting the Summary Buffer}.
5009 @kindex SPACE (Summary)
5010 @findex gnus-summary-next-page
5011 Select the current article, or, if that one's read already, the next
5012 unread article (@code{gnus-summary-next-page}).
5014 If you have an article window open already and you press @kbd{SPACE}
5015 again, the article will be scrolled. This lets you conveniently
5016 @kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}.
5021 @kindex G n (Summary)
5022 @findex gnus-summary-next-unread-article
5023 @c @icon{gnus-summary-next-unread}
5024 Go to next unread article (@code{gnus-summary-next-unread-article}).
5029 @findex gnus-summary-prev-unread-article
5030 @c @icon{gnus-summary-prev-unread}
5031 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
5036 @kindex G N (Summary)
5037 @findex gnus-summary-next-article
5038 Go to the next article (@code{gnus-summary-next-article}).
5043 @kindex G P (Summary)
5044 @findex gnus-summary-prev-article
5045 Go to the previous article (@code{gnus-summary-prev-article}).
5048 @kindex G C-n (Summary)
5049 @findex gnus-summary-next-same-subject
5050 Go to the next article with the same subject
5051 (@code{gnus-summary-next-same-subject}).
5054 @kindex G C-p (Summary)
5055 @findex gnus-summary-prev-same-subject
5056 Go to the previous article with the same subject
5057 (@code{gnus-summary-prev-same-subject}).
5061 @kindex G f (Summary)
5063 @findex gnus-summary-first-unread-article
5064 Go to the first unread article
5065 (@code{gnus-summary-first-unread-article}).
5069 @kindex G b (Summary)
5071 @findex gnus-summary-best-unread-article
5072 Go to the unread article with the highest score
5073 (@code{gnus-summary-best-unread-article}). If given a prefix argument,
5074 go to the first unread article that has a score over the default score.
5079 @kindex G l (Summary)
5080 @findex gnus-summary-goto-last-article
5081 Go to the previous article read (@code{gnus-summary-goto-last-article}).
5084 @kindex G o (Summary)
5085 @findex gnus-summary-pop-article
5087 @cindex article history
5088 Pop an article off the summary history and go to this article
5089 (@code{gnus-summary-pop-article}). This command differs from the
5090 command above in that you can pop as many previous articles off the
5091 history as you like, while @kbd{l} toggles the two last read articles.
5092 For a somewhat related issue (if you use these commands a lot),
5093 @pxref{Article Backlog}.
5098 @kindex G j (Summary)
5099 @findex gnus-summary-goto-article
5100 Ask for an article number or @code{Message-ID}, and then go to that
5101 article (@code{gnus-summary-goto-article}).
5106 @node Choosing Variables
5107 @subsection Choosing Variables
5109 Some variables relevant for moving and selecting articles:
5112 @item gnus-auto-extend-newsgroup
5113 @vindex gnus-auto-extend-newsgroup
5114 All the movement commands will try to go to the previous (or next)
5115 article, even if that article isn't displayed in the Summary buffer if
5116 this variable is non-@code{nil}. Gnus will then fetch the article from
5117 the server and display it in the article buffer.
5119 @item gnus-select-article-hook
5120 @vindex gnus-select-article-hook
5121 This hook is called whenever an article is selected. By default it
5122 exposes any threads hidden under the selected article. If you would
5123 like each article to be saved in the Agent as you read it, putting
5124 @code{gnus-agent-fetch-selected-article} on this hook will do so.
5126 @item gnus-mark-article-hook
5127 @vindex gnus-mark-article-hook
5128 @findex gnus-summary-mark-unread-as-read
5129 @findex gnus-summary-mark-read-and-unread-as-read
5130 @findex gnus-unread-mark
5131 This hook is called whenever an article is selected. It is intended to
5132 be used for marking articles as read. The default value is
5133 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
5134 mark of almost any article you read to @code{gnus-unread-mark}. The
5135 only articles not affected by this function are ticked, dormant, and
5136 expirable articles. If you'd instead like to just have unread articles
5137 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
5138 instead. It will leave marks like @code{gnus-low-score-mark},
5139 @code{gnus-del-mark} (and so on) alone.
5144 @node Paging the Article
5145 @section Scrolling the Article
5146 @cindex article scrolling
5151 @kindex SPACE (Summary)
5152 @findex gnus-summary-next-page
5153 Pressing @kbd{SPACE} will scroll the current article forward one page,
5154 or, if you have come to the end of the current article, will choose the
5155 next article (@code{gnus-summary-next-page}).
5157 @vindex gnus-article-boring-faces
5158 @vindex gnus-article-skip-boring
5159 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
5160 the article consists only of citations and signature, then it will be
5161 skipped; the next article will be shown instead. You can customize
5162 what is considered uninteresting with
5163 @code{gnus-article-boring-faces}. You can manually view the article's
5164 pages, no matter how boring, using @kbd{C-M-v}.
5167 @kindex DEL (Summary)
5168 @findex gnus-summary-prev-page
5169 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5172 @kindex RET (Summary)
5173 @findex gnus-summary-scroll-up
5174 Scroll the current article one line forward
5175 (@code{gnus-summary-scroll-up}).
5178 @kindex M-RET (Summary)
5179 @findex gnus-summary-scroll-down
5180 Scroll the current article one line backward
5181 (@code{gnus-summary-scroll-down}).
5185 @kindex A g (Summary)
5187 @findex gnus-summary-show-article
5188 @vindex gnus-summary-show-article-charset-alist
5189 (Re)fetch the current article (@code{gnus-summary-show-article}). If
5190 given a prefix, fetch the current article, but don't run any of the
5191 article treatment functions. This will give you a ``raw'' article, just
5192 the way it came from the server.
5194 If given a numerical prefix, you can do semi-manual charset stuff.
5195 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5196 encoded in the @code{cn-gb-2312} charset. If you have
5199 (setq gnus-summary-show-article-charset-alist
5204 then you can say @kbd{C-u 1 g} to get the same effect.
5209 @kindex A < (Summary)
5210 @findex gnus-summary-beginning-of-article
5211 Scroll to the beginning of the article
5212 (@code{gnus-summary-beginning-of-article}).
5217 @kindex A > (Summary)
5218 @findex gnus-summary-end-of-article
5219 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5223 @kindex A s (Summary)
5225 @findex gnus-summary-isearch-article
5226 Perform an isearch in the article buffer
5227 (@code{gnus-summary-isearch-article}).
5231 @findex gnus-summary-select-article-buffer
5232 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5237 @node Reply Followup and Post
5238 @section Reply, Followup and Post
5241 * Summary Mail Commands:: Sending mail.
5242 * Summary Post Commands:: Sending news.
5243 * Summary Message Commands:: Other Message-related commands.
5244 * Canceling and Superseding::
5248 @node Summary Mail Commands
5249 @subsection Summary Mail Commands
5251 @cindex composing mail
5253 Commands for composing a mail message:
5259 @kindex S r (Summary)
5261 @findex gnus-summary-reply
5262 @c @icon{gnus-summary-mail-reply}
5263 @c @icon{gnus-summary-reply}
5264 Mail a reply to the author of the current article
5265 (@code{gnus-summary-reply}).
5270 @kindex S R (Summary)
5271 @findex gnus-summary-reply-with-original
5272 @c @icon{gnus-summary-reply-with-original}
5273 Mail a reply to the author of the current article and include the
5274 original message (@code{gnus-summary-reply-with-original}). This
5275 command uses the process/prefix convention.
5278 @kindex S w (Summary)
5279 @findex gnus-summary-wide-reply
5280 Mail a wide reply to the author of the current article
5281 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
5282 goes out to all people listed in the @code{To}, @code{From} (or
5283 @code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is
5284 present, that's used instead.
5287 @kindex S W (Summary)
5288 @findex gnus-summary-wide-reply-with-original
5289 Mail a wide reply to the current article and include the original
5290 message (@code{gnus-summary-wide-reply-with-original}). This command uses
5291 the process/prefix convention.
5294 @kindex S v (Summary)
5295 @findex gnus-summary-very-wide-reply
5296 Mail a very wide reply to the author of the current article
5297 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
5298 that goes out to all people listed in the @code{To}, @code{From} (or
5299 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5300 articles. This command uses the process/prefix convention.
5303 @kindex S V (Summary)
5304 @findex gnus-summary-very-wide-reply-with-original
5305 Mail a very wide reply to the author of the current article and include the
5306 original message (@code{gnus-summary-very-wide-reply-with-original}). This
5307 command uses the process/prefix convention.
5310 @kindex S B r (Summary)
5311 @findex gnus-summary-reply-broken-reply-to
5312 Mail a reply to the author of the current article but ignore the
5313 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5314 If you need this because a mailing list incorrectly sets a
5315 @code{Reply-To} header pointing to the list, you probably want to set
5316 the @code{broken-reply-to} group parameter instead, so things will work
5317 correctly. @xref{Group Parameters}.
5320 @kindex S B R (Summary)
5321 @findex gnus-summary-reply-broken-reply-to-with-original
5322 Mail a reply to the author of the current article and include the
5323 original message but ignore the @code{Reply-To} field
5324 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5328 @kindex S o m (Summary)
5329 @kindex C-c C-f (Summary)
5330 @findex gnus-summary-mail-forward
5331 @c @icon{gnus-summary-mail-forward}
5332 Forward the current article to some other person
5333 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
5334 headers of the forwarded article.
5339 @kindex S m (Summary)
5340 @findex gnus-summary-mail-other-window
5341 @c @icon{gnus-summary-mail-originate}
5342 Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use
5343 the posting style of the current group. If given a prefix, disable that.
5344 If the prefix is 1, prompt for a group name to find the posting style.
5349 @kindex S i (Summary)
5350 @findex gnus-summary-news-other-window
5351 Prepare a news (@code{gnus-summary-news-other-window}). By default,
5352 post to the current group. If given a prefix, disable that. If the
5353 prefix is 1, prompt for a group to post to.
5355 This function actually prepares a news even when using mail groups.
5356 This is useful for ``posting'' messages to mail groups without actually
5357 sending them over the network: they're just saved directly to the group
5358 in question. The corresponding back end must have a request-post method
5359 for this to work though.
5362 @kindex S D b (Summary)
5363 @findex gnus-summary-resend-bounced-mail
5364 @cindex bouncing mail
5365 If you have sent a mail, but the mail was bounced back to you for some
5366 reason (wrong address, transient failure), you can use this command to
5367 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
5368 will be popped into a mail buffer where you can edit the headers before
5369 sending the mail off again. If you give a prefix to this command, and
5370 the bounced mail is a reply to some other mail, gnus will try to fetch
5371 that mail and display it for easy perusal of its headers. This might
5372 very well fail, though.
5375 @kindex S D r (Summary)
5376 @findex gnus-summary-resend-message
5377 Not to be confused with the previous command,
5378 @code{gnus-summary-resend-message} will prompt you for an address to
5379 send the current message off to, and then send it to that place. The
5380 headers of the message won't be altered---but lots of headers that say
5381 @code{Resent-To}, @code{Resent-From} and so on will be added. This
5382 means that you actually send a mail to someone that has a @code{To}
5383 header that (probably) points to yourself. This will confuse people.
5384 So, natcherly you'll only do that if you're really eVIl.
5386 This command is mainly used if you have several accounts and want to
5387 ship a mail to a different account of yours. (If you're both
5388 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5389 to the @code{root} account, you may want to resend it to
5390 @code{postmaster}. Ordnung muss sein!
5392 This command understands the process/prefix convention
5393 (@pxref{Process/Prefix}).
5396 @kindex S O m (Summary)
5397 @findex gnus-summary-digest-mail-forward
5398 Digest the current series (@pxref{Decoding Articles}) and forward the
5399 result using mail (@code{gnus-summary-digest-mail-forward}). This
5400 command uses the process/prefix convention (@pxref{Process/Prefix}).
5403 @kindex S M-c (Summary)
5404 @findex gnus-summary-mail-crosspost-complaint
5405 @cindex crossposting
5406 @cindex excessive crossposting
5407 Send a complaint about excessive crossposting to the author of the
5408 current article (@code{gnus-summary-mail-crosspost-complaint}).
5410 @findex gnus-crosspost-complaint
5411 This command is provided as a way to fight back against the current
5412 crossposting pandemic that's sweeping Usenet. It will compose a reply
5413 using the @code{gnus-crosspost-complaint} variable as a preamble. This
5414 command understands the process/prefix convention
5415 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5419 Also @xref{Header Commands, ,Header Commands, message, The Message
5420 Manual}, for more information.
5423 @node Summary Post Commands
5424 @subsection Summary Post Commands
5426 @cindex composing news
5428 Commands for posting a news article:
5434 @kindex S p (Summary)
5435 @findex gnus-summary-post-news
5436 @c @icon{gnus-summary-post-news}
5437 Prepare for posting an article (@code{gnus-summary-post-news}). By
5438 default, post to the current group. If given a prefix, disable that.
5439 If the prefix is 1, prompt for another group instead.
5444 @kindex S f (Summary)
5445 @findex gnus-summary-followup
5446 @c @icon{gnus-summary-followup}
5447 Post a followup to the current article (@code{gnus-summary-followup}).
5451 @kindex S F (Summary)
5453 @c @icon{gnus-summary-followup-with-original}
5454 @findex gnus-summary-followup-with-original
5455 Post a followup to the current article and include the original message
5456 (@code{gnus-summary-followup-with-original}). This command uses the
5457 process/prefix convention.
5460 @kindex S n (Summary)
5461 @findex gnus-summary-followup-to-mail
5462 Post a followup to the current article via news, even if you got the
5463 message through mail (@code{gnus-summary-followup-to-mail}).
5466 @kindex S N (Summary)
5467 @findex gnus-summary-followup-to-mail-with-original
5468 Post a followup to the current article via news, even if you got the
5469 message through mail and include the original message
5470 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
5471 the process/prefix convention.
5474 @kindex S o p (Summary)
5475 @findex gnus-summary-post-forward
5476 Forward the current article to a newsgroup
5477 (@code{gnus-summary-post-forward}). If given a prefix, include the full
5478 headers of the forwarded article.
5481 @kindex S O p (Summary)
5482 @findex gnus-summary-digest-post-forward
5484 @cindex making digests
5485 Digest the current series and forward the result to a newsgroup
5486 (@code{gnus-summary-digest-post-forward}). This command uses the
5487 process/prefix convention.
5490 @kindex S u (Summary)
5491 @findex gnus-uu-post-news
5492 @c @icon{gnus-uu-post-news}
5493 Uuencode a file, split it into parts, and post it as a series
5494 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
5497 Also @xref{Header Commands, ,Header Commands, message, The Message
5498 Manual}, for more information.
5501 @node Summary Message Commands
5502 @subsection Summary Message Commands
5506 @kindex S y (Summary)
5507 @findex gnus-summary-yank-message
5508 Yank the current article into an already existing Message composition
5509 buffer (@code{gnus-summary-yank-message}). This command prompts for
5510 what message buffer you want to yank into, and understands the
5511 process/prefix convention (@pxref{Process/Prefix}).
5516 @node Canceling and Superseding
5517 @subsection Canceling Articles
5518 @cindex canceling articles
5519 @cindex superseding articles
5521 Have you ever written something, and then decided that you really,
5522 really, really wish you hadn't posted that?
5524 Well, you can't cancel mail, but you can cancel posts.
5526 @findex gnus-summary-cancel-article
5528 @c @icon{gnus-summary-cancel-article}
5529 Find the article you wish to cancel (you can only cancel your own
5530 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
5531 c} (@code{gnus-summary-cancel-article}). Your article will be
5532 canceled---machines all over the world will be deleting your article.
5533 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5535 Be aware, however, that not all sites honor cancels, so your article may
5536 live on here and there, while most sites will delete the article in
5539 Gnus will use the ``current'' select method when canceling. If you
5540 want to use the standard posting method, use the @samp{a} symbolic
5541 prefix (@pxref{Symbolic Prefixes}).
5543 If you discover that you have made some mistakes and want to do some
5544 corrections, you can post a @dfn{superseding} article that will replace
5545 your original article.
5547 @findex gnus-summary-supersede-article
5549 Go to the original article and press @kbd{S s}
5550 (@code{gnus-summary-supersede-article}). You will be put in a buffer
5551 where you can edit the article all you want before sending it off the
5554 The same goes for superseding as for canceling, only more so: Some
5555 sites do not honor superseding. On those sites, it will appear that you
5556 have posted almost the same article twice.
5558 If you have just posted the article, and change your mind right away,
5559 there is a trick you can use to cancel/supersede the article without
5560 waiting for the article to appear on your site first. You simply return
5561 to the post buffer (which is called @code{*sent ...*}). There you will
5562 find the article you just posted, with all the headers intact. Change
5563 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5564 header by substituting one of those words for the word
5565 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
5566 you would do normally. The previous article will be
5567 canceled/superseded.
5569 Just remember, kids: There is no 'c' in 'supersede'.
5571 @node Delayed Articles
5572 @section Delayed Articles
5573 @cindex delayed sending
5574 @cindex send delayed
5576 Sometimes, you might wish to delay the sending of a message. For
5577 example, you might wish to arrange for a message to turn up just in time
5578 to remind your about the birthday of your Significant Other. For this,
5579 there is the @code{gnus-delay} package. Setup is simple:
5582 (gnus-delay-initialize)
5585 @findex gnus-delay-article
5586 Normally, to send a message you use the @kbd{C-c C-c} command from
5587 Message mode. To delay a message, use @kbd{C-c C-j}
5588 (@code{gnus-delay-article}) instead. This will ask you for how long the
5589 message should be delayed. Possible answers are:
5593 A time span. Consists of an integer and a letter. For example,
5594 @code{42d} means to delay for 42 days. Available letters are @code{m}
5595 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5596 (months) and @code{Y} (years).
5599 A specific date. Looks like @code{YYYY-MM-DD}. The message will be
5600 delayed until that day, at a specific time (eight o'clock by default).
5601 See also @code{gnus-delay-default-hour}.
5604 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
5605 stuff. The deadline will be at that time today, except if that time has
5606 already passed, then it's at the given time tomorrow. So if it's ten
5607 o'clock in the morning and you specify @code{11:15}, then the deadline
5608 is one hour and fifteen minutes hence. But if you specify @code{9:20},
5609 that means a time tomorrow.
5612 The action of the @code{gnus-delay-article} command is influenced by a
5613 couple of variables:
5616 @item gnus-delay-default-hour
5617 @vindex gnus-delay-default-hour
5618 When you specify a specific date, the message will be due on that hour
5619 on the given date. Possible values are integers 0 through 23.
5621 @item gnus-delay-default-delay
5622 @vindex gnus-delay-default-delay
5623 This is a string and gives the default delay. It can be of any of the
5624 formats described above.
5626 @item gnus-delay-group
5627 @vindex gnus-delay-group
5628 Delayed articles will be kept in this group on the drafts server until
5629 they are due. You probably don't need to change this. The default
5630 value is @code{"delayed"}.
5632 @item gnus-delay-header
5633 @vindex gnus-delay-header
5634 The deadline for each article will be stored in a header. This variable
5635 is a string and gives the header name. You probably don't need to
5636 change this. The default value is @code{"X-Gnus-Delayed"}.
5639 The way delaying works is like this: when you use the
5640 @code{gnus-delay-article} command, you give a certain delay. Gnus
5641 calculates the deadline of the message and stores it in the
5642 @code{X-Gnus-Delayed} header and puts the message in the
5643 @code{nndraft:delayed} group.
5645 @findex gnus-delay-send-queue
5646 And whenever you get new news, Gnus looks through the group for articles
5647 which are due and sends them. It uses the @code{gnus-delay-send-queue}
5648 function for this. By default, this function is added to the hook
5649 @code{gnus-get-new-news-hook}. But of course, you can change this.
5650 Maybe you want to use the demon to send drafts? Just tell the demon to
5651 execute the @code{gnus-delay-send-queue} function.
5654 @item gnus-delay-initialize
5655 @findex gnus-delay-initialize
5657 By default, this function installs @code{gnus-delay-send-queue} in
5658 @code{gnus-get-new-news-hook}. But it accepts the optional second
5659 argument @code{no-check}. If it is non-@code{nil},
5660 @code{gnus-get-new-news-hook} is not changed. The optional first
5661 argument is ignored.
5663 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5664 Presumably, you want to use the demon for sending due delayed articles.
5665 Just don't forget to set that up :-)
5669 @node Marking Articles
5670 @section Marking Articles
5671 @cindex article marking
5672 @cindex article ticking
5675 There are several marks you can set on an article.
5677 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5678 neologism ohoy!) of the article. Alphabetic marks generally mean
5679 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5681 In addition, you also have marks that do not affect readedness.
5684 * Unread Articles:: Marks for unread articles.
5685 * Read Articles:: Marks for read articles.
5686 * Other Marks:: Marks that do not affect readedness.
5690 There's a plethora of commands for manipulating these marks:
5694 * Setting Marks:: How to set and remove marks.
5695 * Generic Marking Commands:: How to customize the marking.
5696 * Setting Process Marks:: How to mark articles for later processing.
5700 @node Unread Articles
5701 @subsection Unread Articles
5703 The following marks mark articles as (kinda) unread, in one form or
5708 @vindex gnus-ticked-mark
5709 Marked as ticked (@code{gnus-ticked-mark}).
5711 @dfn{Ticked articles} are articles that will remain visible always. If
5712 you see an article that you find interesting, or you want to put off
5713 reading it, or replying to it, until sometime later, you'd typically
5714 tick it. However, articles can be expired (from news servers by the
5715 news server software, Gnus itself never expires ticked messages), so if
5716 you want to keep an article forever, you'll have to make it persistent
5717 (@pxref{Persistent Articles}).
5720 @vindex gnus-dormant-mark
5721 Marked as dormant (@code{gnus-dormant-mark}).
5723 @dfn{Dormant articles} will only appear in the summary buffer if there
5724 are followups to it. If you want to see them even if they don't have
5725 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
5726 Otherwise (except for the visibility issue), they are just like ticked
5730 @vindex gnus-unread-mark
5731 Marked as unread (@code{gnus-unread-mark}).
5733 @dfn{Unread articles} are articles that haven't been read at all yet.
5738 @subsection Read Articles
5739 @cindex expirable mark
5741 All the following marks mark articles as read.
5746 @vindex gnus-del-mark
5747 These are articles that the user has marked as read with the @kbd{d}
5748 command manually, more or less (@code{gnus-del-mark}).
5751 @vindex gnus-read-mark
5752 Articles that have actually been read (@code{gnus-read-mark}).
5755 @vindex gnus-ancient-mark
5756 Articles that were marked as read in previous sessions and are now
5757 @dfn{old} (@code{gnus-ancient-mark}).
5760 @vindex gnus-killed-mark
5761 Marked as killed (@code{gnus-killed-mark}).
5764 @vindex gnus-kill-file-mark
5765 Marked as killed by kill files (@code{gnus-kill-file-mark}).
5768 @vindex gnus-low-score-mark
5769 Marked as read by having too low a score (@code{gnus-low-score-mark}).
5772 @vindex gnus-catchup-mark
5773 Marked as read by a catchup (@code{gnus-catchup-mark}).
5776 @vindex gnus-canceled-mark
5777 Canceled article (@code{gnus-canceled-mark})
5780 @vindex gnus-souped-mark
5781 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
5784 @vindex gnus-sparse-mark
5785 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
5789 @vindex gnus-duplicate-mark
5790 Article marked as read by duplicate suppression
5791 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
5795 All these marks just mean that the article is marked as read, really.
5796 They are interpreted differently when doing adaptive scoring, though.
5798 One more special mark, though:
5802 @vindex gnus-expirable-mark
5803 Marked as expirable (@code{gnus-expirable-mark}).
5805 Marking articles as @dfn{expirable} (or have them marked as such
5806 automatically) doesn't make much sense in normal groups---a user doesn't
5807 control expiring of news articles, but in mail groups, for instance,
5808 articles marked as @dfn{expirable} can be deleted by gnus at
5814 @subsection Other Marks
5815 @cindex process mark
5818 There are some marks that have nothing to do with whether the article is
5824 You can set a bookmark in the current article. Say you are reading a
5825 long thesis on cats' urinary tracts, and have to go home for dinner
5826 before you've finished reading the thesis. You can then set a bookmark
5827 in the article, and gnus will jump to this bookmark the next time it
5828 encounters the article. @xref{Setting Marks}.
5831 @vindex gnus-replied-mark
5832 All articles that you have replied to or made a followup to (i.e., have
5833 answered) will be marked with an @samp{A} in the second column
5834 (@code{gnus-replied-mark}).
5837 @vindex gnus-forwarded-mark
5838 All articles that you have forwarded will be marked with an @samp{F} in
5839 the second column (@code{gnus-forwarded-mark}).
5842 @vindex gnus-cached-mark
5843 Articles stored in the article cache will be marked with an @samp{*} in
5844 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
5847 @vindex gnus-saved-mark
5848 Articles ``saved'' (in some manner or other; not necessarily
5849 religiously) are marked with an @samp{S} in the second column
5850 (@code{gnus-saved-mark}).
5853 @vindex gnus-recent-mark
5854 Articles that according to the server haven't been shown to the user
5855 before are marked with a @samp{N} in the second column
5856 (@code{gnus-recent-mark}). Note that not all servers support this
5857 mark, in which case it simply never appears. Compare with
5858 @code{gnus-unseen-mark}.
5861 @vindex gnus-unseen-mark
5862 Articles that haven't been seen before in Gnus by the user are marked
5863 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
5864 Compare with @code{gnus-recent-mark}.
5867 @vindex gnus-downloaded-mark
5868 When using the Gnus agent (@pxref{Agent Basics}), articles may be
5869 downloaded for unplugged (offline) viewing. If you are using the
5870 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
5871 (The variable @code{gnus-downloaded-mark} controls which character to
5875 @vindex gnus-undownloaded-mark
5876 When using the Gnus agent (@pxref{Agent Basics}), some articles might
5877 not have been downloaded. Such articles cannot be viewed while you
5878 are unplugged (offline). If you are using the @samp{%O} spec, these
5879 articles get the @samp{-} mark in that spec. (The variable
5880 @code{gnus-undownloaded-mark} controls which character to use.)
5883 @vindex gnus-downloadable-mark
5884 The Gnus agent (@pxref{Agent Basics}) downloads some articles
5885 automatically, but it is also possible to explicitly mark articles for
5886 download, even if they would not be downloaded automatically. Such
5887 explicitly-marked articles get the @samp{%} mark in the first column.
5888 (The variable @code{gnus-downloadable-mark} controls which character to
5892 @vindex gnus-not-empty-thread-mark
5893 @vindex gnus-empty-thread-mark
5894 If the @samp{%e} spec is used, the presence of threads or not will be
5895 marked with @code{gnus-not-empty-thread-mark} and
5896 @code{gnus-empty-thread-mark} in the third column, respectively.
5899 @vindex gnus-process-mark
5900 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
5901 variety of commands react to the presence of the process mark. For
5902 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5903 all articles that have been marked with the process mark. Articles
5904 marked with the process mark have a @samp{#} in the second column.
5908 You might have noticed that most of these ``non-readedness'' marks
5909 appear in the second column by default. So if you have a cached, saved,
5910 replied article that you have process-marked, what will that look like?
5912 Nothing much. The precedence rules go as follows: process -> cache ->
5913 replied -> saved. So if the article is in the cache and is replied,
5914 you'll only see the cache mark and not the replied mark.
5918 @subsection Setting Marks
5919 @cindex setting marks
5921 All the marking commands understand the numeric prefix.
5926 @kindex M c (Summary)
5927 @kindex M-u (Summary)
5928 @findex gnus-summary-clear-mark-forward
5929 @cindex mark as unread
5930 Clear all readedness-marks from the current article
5931 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
5937 @kindex M t (Summary)
5938 @findex gnus-summary-tick-article-forward
5939 Tick the current article (@code{gnus-summary-tick-article-forward}).
5940 @xref{Article Caching}.
5945 @kindex M ? (Summary)
5946 @findex gnus-summary-mark-as-dormant
5947 Mark the current article as dormant
5948 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
5952 @kindex M d (Summary)
5954 @findex gnus-summary-mark-as-read-forward
5955 Mark the current article as read
5956 (@code{gnus-summary-mark-as-read-forward}).
5960 @findex gnus-summary-mark-as-read-backward
5961 Mark the current article as read and move point to the previous line
5962 (@code{gnus-summary-mark-as-read-backward}).
5967 @kindex M k (Summary)
5968 @findex gnus-summary-kill-same-subject-and-select
5969 Mark all articles that have the same subject as the current one as read,
5970 and then select the next unread article
5971 (@code{gnus-summary-kill-same-subject-and-select}).
5975 @kindex M K (Summary)
5976 @kindex C-k (Summary)
5977 @findex gnus-summary-kill-same-subject
5978 Mark all articles that have the same subject as the current one as read
5979 (@code{gnus-summary-kill-same-subject}).
5982 @kindex M C (Summary)
5983 @findex gnus-summary-catchup
5984 @c @icon{gnus-summary-catchup}
5985 Mark all unread articles as read (@code{gnus-summary-catchup}).
5988 @kindex M C-c (Summary)
5989 @findex gnus-summary-catchup-all
5990 Mark all articles in the group as read---even the ticked and dormant
5991 articles (@code{gnus-summary-catchup-all}).
5994 @kindex M H (Summary)
5995 @findex gnus-summary-catchup-to-here
5996 Catchup the current group to point (before the point)
5997 (@code{gnus-summary-catchup-to-here}).
6000 @kindex M h (Summary)
6001 @findex gnus-summary-catchup-from-here
6002 Catchup the current group from point (after the point)
6003 (@code{gnus-summary-catchup-from-here}).
6006 @kindex C-w (Summary)
6007 @findex gnus-summary-mark-region-as-read
6008 Mark all articles between point and mark as read
6009 (@code{gnus-summary-mark-region-as-read}).
6012 @kindex M V k (Summary)
6013 @findex gnus-summary-kill-below
6014 Kill all articles with scores below the default score (or below the
6015 numeric prefix) (@code{gnus-summary-kill-below}).
6019 @kindex M e (Summary)
6021 @findex gnus-summary-mark-as-expirable
6022 Mark the current article as expirable
6023 (@code{gnus-summary-mark-as-expirable}).
6026 @kindex M b (Summary)
6027 @findex gnus-summary-set-bookmark
6028 Set a bookmark in the current article
6029 (@code{gnus-summary-set-bookmark}).
6032 @kindex M B (Summary)
6033 @findex gnus-summary-remove-bookmark
6034 Remove the bookmark from the current article
6035 (@code{gnus-summary-remove-bookmark}).
6038 @kindex M V c (Summary)
6039 @findex gnus-summary-clear-above
6040 Clear all marks from articles with scores over the default score (or
6041 over the numeric prefix) (@code{gnus-summary-clear-above}).
6044 @kindex M V u (Summary)
6045 @findex gnus-summary-tick-above
6046 Tick all articles with scores over the default score (or over the
6047 numeric prefix) (@code{gnus-summary-tick-above}).
6050 @kindex M V m (Summary)
6051 @findex gnus-summary-mark-above
6052 Prompt for a mark, and mark all articles with scores over the default
6053 score (or over the numeric prefix) with this mark
6054 (@code{gnus-summary-clear-above}).
6057 @vindex gnus-summary-goto-unread
6058 The @code{gnus-summary-goto-unread} variable controls what action should
6059 be taken after setting a mark. If non-@code{nil}, point will move to
6060 the next/previous unread article. If @code{nil}, point will just move
6061 one line up or down. As a special case, if this variable is
6062 @code{never}, all the marking commands as well as other commands (like
6063 @kbd{SPACE}) will move to the next article, whether it is unread or not.
6064 The default is @code{t}.
6067 @node Generic Marking Commands
6068 @subsection Generic Marking Commands
6070 Some people would like the command that ticks an article (@kbd{!}) go to
6071 the next article. Others would like it to go to the next unread
6072 article. Yet others would like it to stay on the current article. And
6073 even though I haven't heard of anybody wanting it to go to the
6074 previous (unread) article, I'm sure there are people that want that as
6077 Multiply these five behaviors with five different marking commands, and
6078 you get a potentially complex set of variable to control what each
6081 To sidestep that mess, Gnus provides commands that do all these
6082 different things. They can be found on the @kbd{M M} map in the summary
6083 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
6084 to list in this manual.
6086 While you can use these commands directly, most users would prefer
6087 altering the summary mode keymap. For instance, if you would like the
6088 @kbd{!} command to go to the next article instead of the next unread
6089 article, you could say something like:
6093 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
6094 (defun my-alter-summary-map ()
6095 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
6103 (defun my-alter-summary-map ()
6104 (local-set-key "!" "MM!n"))
6108 @node Setting Process Marks
6109 @subsection Setting Process Marks
6110 @cindex setting process marks
6112 Process marks are displayed as @code{#} in the summary buffer, and are
6113 used for marking articles in such a way that other commands will
6114 process these articles. For instance, if you process mark four
6115 articles and then use the @kbd{*} command, Gnus will enter these four
6116 commands into the cache. For more information,
6117 @pxref{Process/Prefix}.
6124 @kindex M P p (Summary)
6125 @findex gnus-summary-mark-as-processable
6126 Mark the current article with the process mark
6127 (@code{gnus-summary-mark-as-processable}).
6128 @findex gnus-summary-unmark-as-processable
6132 @kindex M P u (Summary)
6133 @kindex M-# (Summary)
6134 Remove the process mark, if any, from the current article
6135 (@code{gnus-summary-unmark-as-processable}).
6138 @kindex M P U (Summary)
6139 @findex gnus-summary-unmark-all-processable
6140 Remove the process mark from all articles
6141 (@code{gnus-summary-unmark-all-processable}).
6144 @kindex M P i (Summary)
6145 @findex gnus-uu-invert-processable
6146 Invert the list of process marked articles
6147 (@code{gnus-uu-invert-processable}).
6150 @kindex M P R (Summary)
6151 @findex gnus-uu-mark-by-regexp
6152 Mark articles that have a @code{Subject} header that matches a regular
6153 expression (@code{gnus-uu-mark-by-regexp}).
6156 @kindex M P G (Summary)
6157 @findex gnus-uu-unmark-by-regexp
6158 Unmark articles that have a @code{Subject} header that matches a regular
6159 expression (@code{gnus-uu-unmark-by-regexp}).
6162 @kindex M P r (Summary)
6163 @findex gnus-uu-mark-region
6164 Mark articles in region (@code{gnus-uu-mark-region}).
6167 @kindex M P g (Summary)
6168 @findex gnus-uu-unmark-region
6169 Unmark articles in region (@code{gnus-uu-unmark-region}).
6172 @kindex M P t (Summary)
6173 @findex gnus-uu-mark-thread
6174 Mark all articles in the current (sub)thread
6175 (@code{gnus-uu-mark-thread}).
6178 @kindex M P T (Summary)
6179 @findex gnus-uu-unmark-thread
6180 Unmark all articles in the current (sub)thread
6181 (@code{gnus-uu-unmark-thread}).
6184 @kindex M P v (Summary)
6185 @findex gnus-uu-mark-over
6186 Mark all articles that have a score above the prefix argument
6187 (@code{gnus-uu-mark-over}).
6190 @kindex M P s (Summary)
6191 @findex gnus-uu-mark-series
6192 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6195 @kindex M P S (Summary)
6196 @findex gnus-uu-mark-sparse
6197 Mark all series that have already had some articles marked
6198 (@code{gnus-uu-mark-sparse}).
6201 @kindex M P a (Summary)
6202 @findex gnus-uu-mark-all
6203 Mark all articles in series order (@code{gnus-uu-mark-series}).
6206 @kindex M P b (Summary)
6207 @findex gnus-uu-mark-buffer
6208 Mark all articles in the buffer in the order they appear
6209 (@code{gnus-uu-mark-buffer}).
6212 @kindex M P k (Summary)
6213 @findex gnus-summary-kill-process-mark
6214 Push the current process mark set onto the stack and unmark all articles
6215 (@code{gnus-summary-kill-process-mark}).
6218 @kindex M P y (Summary)
6219 @findex gnus-summary-yank-process-mark
6220 Pop the previous process mark set from the stack and restore it
6221 (@code{gnus-summary-yank-process-mark}).
6224 @kindex M P w (Summary)
6225 @findex gnus-summary-save-process-mark
6226 Push the current process mark set onto the stack
6227 (@code{gnus-summary-save-process-mark}).
6231 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
6232 set process marks based on article body contents.
6239 It can be convenient to limit the summary buffer to just show some
6240 subset of the articles currently in the group. The effect most limit
6241 commands have is to remove a few (or many) articles from the summary
6244 All limiting commands work on subsets of the articles already fetched
6245 from the servers. None of these commands query the server for
6246 additional articles.
6252 @kindex / / (Summary)
6253 @findex gnus-summary-limit-to-subject
6254 Limit the summary buffer to articles that match some subject
6255 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
6259 @kindex / a (Summary)
6260 @findex gnus-summary-limit-to-author
6261 Limit the summary buffer to articles that match some author
6262 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
6266 @kindex / x (Summary)
6267 @findex gnus-summary-limit-to-extra
6268 Limit the summary buffer to articles that match one of the ``extra''
6269 headers (@pxref{To From Newsgroups})
6270 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
6275 @kindex / u (Summary)
6277 @findex gnus-summary-limit-to-unread
6278 Limit the summary buffer to articles not marked as read
6279 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
6280 buffer to articles strictly unread. This means that ticked and
6281 dormant articles will also be excluded.
6284 @kindex / m (Summary)
6285 @findex gnus-summary-limit-to-marks
6286 Ask for a mark and then limit to all articles that have been marked
6287 with that mark (@code{gnus-summary-limit-to-marks}).
6290 @kindex / t (Summary)
6291 @findex gnus-summary-limit-to-age
6292 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
6293 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
6294 articles younger than that number of days.
6297 @kindex / n (Summary)
6298 @findex gnus-summary-limit-to-articles
6299 Limit the summary buffer to the current article
6300 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
6301 convention (@pxref{Process/Prefix}).
6304 @kindex / w (Summary)
6305 @findex gnus-summary-pop-limit
6306 Pop the previous limit off the stack and restore it
6307 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
6311 @kindex / . (Summary)
6312 @findex gnus-summary-limit-to-unseen
6313 Limit the summary buffer to the unseen articles
6314 (@code{gnus-summary-limit-to-unseen}).
6317 @kindex / v (Summary)
6318 @findex gnus-summary-limit-to-score
6319 Limit the summary buffer to articles that have a score at or above some
6320 score (@code{gnus-summary-limit-to-score}).
6323 @kindex / p (Summary)
6324 @findex gnus-summary-limit-to-display-predicate
6325 Limit the summary buffer to articles that satisfy the @code{display}
6326 group parameter predicate
6327 (@code{gnus-summary-limit-to-display-predicate}). @xref{Group
6328 Parameters}, for more on this predicate.
6332 @kindex M S (Summary)
6333 @kindex / E (Summary)
6334 @findex gnus-summary-limit-include-expunged
6335 Include all expunged articles in the limit
6336 (@code{gnus-summary-limit-include-expunged}).
6339 @kindex / D (Summary)
6340 @findex gnus-summary-limit-include-dormant
6341 Include all dormant articles in the limit
6342 (@code{gnus-summary-limit-include-dormant}).
6345 @kindex / * (Summary)
6346 @findex gnus-summary-limit-include-cached
6347 Include all cached articles in the limit
6348 (@code{gnus-summary-limit-include-cached}).
6351 @kindex / d (Summary)
6352 @findex gnus-summary-limit-exclude-dormant
6353 Exclude all dormant articles from the limit
6354 (@code{gnus-summary-limit-exclude-dormant}).
6357 @kindex / M (Summary)
6358 @findex gnus-summary-limit-exclude-marks
6359 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
6362 @kindex / T (Summary)
6363 @findex gnus-summary-limit-include-thread
6364 Include all the articles in the current thread in the limit.
6367 @kindex / c (Summary)
6368 @findex gnus-summary-limit-exclude-childless-dormant
6369 Exclude all dormant articles that have no children from the limit@*
6370 (@code{gnus-summary-limit-exclude-childless-dormant}).
6373 @kindex / C (Summary)
6374 @findex gnus-summary-limit-mark-excluded-as-read
6375 Mark all excluded unread articles as read
6376 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
6377 also mark excluded ticked and dormant articles as read.
6380 @kindex / N (Summary)
6381 @findex gnus-summary-insert-new-articles
6382 Insert all new articles in the summary buffer. It scans for new emails
6383 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
6386 @kindex / o (Summary)
6387 @findex gnus-summary-insert-old-articles
6388 Insert all old articles in the summary buffer. If given a numbered
6389 prefix, fetch this number of articles.
6397 @cindex article threading
6399 Gnus threads articles by default. @dfn{To thread} is to put responses
6400 to articles directly after the articles they respond to---in a
6401 hierarchical fashion.
6403 Threading is done by looking at the @code{References} headers of the
6404 articles. In a perfect world, this would be enough to build pretty
6405 trees, but unfortunately, the @code{References} header is often broken
6406 or simply missing. Weird news propagation exacerbates the problem,
6407 so one has to employ other heuristics to get pleasing results. A
6408 plethora of approaches exists, as detailed in horrible detail in
6409 @ref{Customizing Threading}.
6411 First, a quick overview of the concepts:
6415 The top-most article in a thread; the first article in the thread.
6418 A tree-like article structure.
6421 A small(er) section of this tree-like structure.
6424 Threads often lose their roots due to article expiry, or due to the root
6425 already having been read in a previous session, and not displayed in the
6426 summary buffer. We then typically have many sub-threads that really
6427 belong to one thread, but are without connecting roots. These are
6428 called loose threads.
6430 @item thread gathering
6431 An attempt to gather loose threads into bigger threads.
6433 @item sparse threads
6434 A thread where the missing articles have been ``guessed'' at, and are
6435 displayed as empty lines in the summary buffer.
6441 * Customizing Threading:: Variables you can change to affect the threading.
6442 * Thread Commands:: Thread based commands in the summary buffer.
6446 @node Customizing Threading
6447 @subsection Customizing Threading
6448 @cindex customizing threading
6451 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
6452 * Filling In Threads:: Making the threads displayed look fuller.
6453 * More Threading:: Even more variables for fiddling with threads.
6454 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
6459 @subsubsection Loose Threads
6462 @cindex loose threads
6465 @item gnus-summary-make-false-root
6466 @vindex gnus-summary-make-false-root
6467 If non-@code{nil}, gnus will gather all loose subtrees into one big tree
6468 and create a dummy root at the top. (Wait a minute. Root at the top?
6469 Yup.) Loose subtrees occur when the real root has expired, or you've
6470 read or killed the root in a previous session.
6472 When there is no real root of a thread, gnus will have to fudge
6473 something. This variable says what fudging method gnus should use.
6474 There are four possible values:
6478 \gnusfigure{The Summary Buffer}{390}{
6479 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6480 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6481 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6482 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6487 @cindex adopting articles
6492 Gnus will make the first of the orphaned articles the parent. This
6493 parent will adopt all the other articles. The adopted articles will be
6494 marked as such by pointy brackets (@samp{<>}) instead of the standard
6495 square brackets (@samp{[]}). This is the default method.
6498 @vindex gnus-summary-dummy-line-format
6499 @vindex gnus-summary-make-false-root-always
6500 Gnus will create a dummy summary line that will pretend to be the
6501 parent. This dummy line does not correspond to any real article, so
6502 selecting it will just select the first real article after the dummy
6503 article. @code{gnus-summary-dummy-line-format} is used to specify the
6504 format of the dummy roots. It accepts only one format spec: @samp{S},
6505 which is the subject of the article. @xref{Formatting Variables}.
6506 If you want all threads to have a dummy root, even the non-gathered
6507 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
6510 Gnus won't actually make any article the parent, but simply leave the
6511 subject field of all orphans except the first empty. (Actually, it will
6512 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6516 Don't make any article parent at all. Just gather the threads and
6517 display them after one another.
6520 Don't gather loose threads.
6523 @item gnus-summary-gather-subject-limit
6524 @vindex gnus-summary-gather-subject-limit
6525 Loose threads are gathered by comparing subjects of articles. If this
6526 variable is @code{nil}, gnus requires an exact match between the
6527 subjects of the loose threads before gathering them into one big
6528 super-thread. This might be too strict a requirement, what with the
6529 presence of stupid newsreaders that chop off long subject lines. If
6530 you think so, set this variable to, say, 20 to require that only the
6531 first 20 characters of the subjects have to match. If you set this
6532 variable to a really low number, you'll find that gnus will gather
6533 everything in sight into one thread, which isn't very helpful.
6535 @cindex fuzzy article gathering
6536 If you set this variable to the special value @code{fuzzy}, gnus will
6537 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6540 @item gnus-simplify-subject-fuzzy-regexp
6541 @vindex gnus-simplify-subject-fuzzy-regexp
6542 This can either be a regular expression or list of regular expressions
6543 that match strings that will be removed from subjects if fuzzy subject
6544 simplification is used.
6546 @item gnus-simplify-ignored-prefixes
6547 @vindex gnus-simplify-ignored-prefixes
6548 If you set @code{gnus-summary-gather-subject-limit} to something as low
6549 as 10, you might consider setting this variable to something sensible:
6551 @c Written by Michael Ernst <mernst@cs.rice.edu>
6553 (setq gnus-simplify-ignored-prefixes
6559 "wanted" "followup" "summary\\( of\\)?"
6560 "help" "query" "problem" "question"
6561 "answer" "reference" "announce"
6562 "How can I" "How to" "Comparison of"
6567 (mapconcat 'identity
6568 '("for" "for reference" "with" "about")
6570 "\\)?\\]?:?[ \t]*"))
6573 All words that match this regexp will be removed before comparing two
6576 @item gnus-simplify-subject-functions
6577 @vindex gnus-simplify-subject-functions
6578 If non-@code{nil}, this variable overrides
6579 @code{gnus-summary-gather-subject-limit}. This variable should be a
6580 list of functions to apply to the @code{Subject} string iteratively to
6581 arrive at the simplified version of the string.
6583 Useful functions to put in this list include:
6586 @item gnus-simplify-subject-re
6587 @findex gnus-simplify-subject-re
6588 Strip the leading @samp{Re:}.
6590 @item gnus-simplify-subject-fuzzy
6591 @findex gnus-simplify-subject-fuzzy
6594 @item gnus-simplify-whitespace
6595 @findex gnus-simplify-whitespace
6596 Remove excessive whitespace.
6598 @item gnus-simplify-all-whitespace
6599 @findex gnus-simplify-all-whitespace
6600 Remove all whitespace.
6603 You may also write your own functions, of course.
6606 @item gnus-summary-gather-exclude-subject
6607 @vindex gnus-summary-gather-exclude-subject
6608 Since loose thread gathering is done on subjects only, that might lead
6609 to many false hits, especially with certain common subjects like
6610 @samp{} and @samp{(none)}. To make the situation slightly better,
6611 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6612 what subjects should be excluded from the gathering process.@*
6613 The default is @samp{^ *$\\|^(none)$}.
6615 @item gnus-summary-thread-gathering-function
6616 @vindex gnus-summary-thread-gathering-function
6617 Gnus gathers threads by looking at @code{Subject} headers. This means
6618 that totally unrelated articles may end up in the same ``thread'', which
6619 is confusing. An alternate approach is to look at all the
6620 @code{Message-ID}s in all the @code{References} headers to find matches.
6621 This will ensure that no gathered threads ever include unrelated
6622 articles, but it also means that people who have posted with broken
6623 newsreaders won't be gathered properly. The choice is yours---plague or
6627 @item gnus-gather-threads-by-subject
6628 @findex gnus-gather-threads-by-subject
6629 This function is the default gathering function and looks at
6630 @code{Subject}s exclusively.
6632 @item gnus-gather-threads-by-references
6633 @findex gnus-gather-threads-by-references
6634 This function looks at @code{References} headers exclusively.
6637 If you want to test gathering by @code{References}, you could say
6641 (setq gnus-summary-thread-gathering-function
6642 'gnus-gather-threads-by-references)
6648 @node Filling In Threads
6649 @subsubsection Filling In Threads
6652 @item gnus-fetch-old-headers
6653 @vindex gnus-fetch-old-headers
6654 If non-@code{nil}, gnus will attempt to build old threads by fetching
6655 more old headers---headers to articles marked as read. If you
6656 would like to display as few summary lines as possible, but still
6657 connect as many loose threads as possible, you should set this variable
6658 to @code{some} or a number. If you set it to a number, no more than
6659 that number of extra old headers will be fetched. In either case,
6660 fetching old headers only works if the back end you are using carries
6661 overview files---this would normally be @code{nntp}, @code{nnspool},
6662 @code{nnml}, and @code{nnmaildir}. Also remember that if the root of
6663 the thread has been expired by the server, there's not much Gnus can do
6666 This variable can also be set to @code{invisible}. This won't have any
6667 visible effects, but is useful if you use the @kbd{A T} command a lot
6668 (@pxref{Finding the Parent}).
6670 @item gnus-fetch-old-ephemeral-headers
6671 @vindex gnus-fetch-old-ephemeral-headers
6672 Same as @code{gnus-fetch-old-headers}, but only used for ephemeral
6675 @item gnus-build-sparse-threads
6676 @vindex gnus-build-sparse-threads
6677 Fetching old headers can be slow. A low-rent similar effect can be
6678 gotten by setting this variable to @code{some}. Gnus will then look at
6679 the complete @code{References} headers of all articles and try to string
6680 together articles that belong in the same thread. This will leave
6681 @dfn{gaps} in the threading display where gnus guesses that an article
6682 is missing from the thread. (These gaps appear like normal summary
6683 lines. If you select a gap, gnus will try to fetch the article in
6684 question.) If this variable is @code{t}, gnus will display all these
6685 ``gaps'' without regard for whether they are useful for completing the
6686 thread or not. Finally, if this variable is @code{more}, gnus won't cut
6687 off sparse leaf nodes that don't lead anywhere. This variable is
6688 @code{nil} by default.
6690 @item gnus-read-all-available-headers
6691 @vindex gnus-read-all-available-headers
6692 This is a rather obscure variable that few will find useful. It's
6693 intended for those non-news newsgroups where the back end has to fetch
6694 quite a lot to present the summary buffer, and where it's impossible to
6695 go back to parents of articles. This is mostly the case in the
6696 web-based groups, like the @code{nnultimate} groups.
6698 If you don't use those, then it's safe to leave this as the default
6699 @code{nil}. If you want to use this variable, it should be a regexp
6700 that matches the group name, or @code{t} for all groups.
6705 @node More Threading
6706 @subsubsection More Threading
6709 @item gnus-show-threads
6710 @vindex gnus-show-threads
6711 If this variable is @code{nil}, no threading will be done, and all of
6712 the rest of the variables here will have no effect. Turning threading
6713 off will speed group selection up a bit, but it is sure to make reading
6714 slower and more awkward.
6716 @item gnus-thread-hide-subtree
6717 @vindex gnus-thread-hide-subtree
6718 If non-@code{nil}, all threads will be hidden when the summary buffer is
6721 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
6722 Available predicates are @code{gnus-article-unread-p} and
6723 @code{gnus-article-unseen-p}.
6728 (setq gnus-thread-hide-subtree
6729 '(or gnus-article-unread-p
6730 gnus-article-unseen-p))
6733 (It's a pretty nonsensical example, since all unseen articles are also
6734 unread, but you get my drift.)
6737 @item gnus-thread-expunge-below
6738 @vindex gnus-thread-expunge-below
6739 All threads that have a total score (as defined by
6740 @code{gnus-thread-score-function}) less than this number will be
6741 expunged. This variable is @code{nil} by default, which means that no
6742 threads are expunged.
6744 @item gnus-thread-hide-killed
6745 @vindex gnus-thread-hide-killed
6746 if you kill a thread and this variable is non-@code{nil}, the subtree
6749 @item gnus-thread-ignore-subject
6750 @vindex gnus-thread-ignore-subject
6751 Sometimes somebody changes the subject in the middle of a thread. If
6752 this variable is non-@code{nil}, which is the default, the subject
6753 change is ignored. If it is @code{nil}, a change in the subject will
6754 result in a new thread.
6756 @item gnus-thread-indent-level
6757 @vindex gnus-thread-indent-level
6758 This is a number that says how much each sub-thread should be indented.
6761 @item gnus-sort-gathered-threads-function
6762 @vindex gnus-sort-gathered-threads-function
6763 Sometimes, particularly with mailing lists, the order in which mails
6764 arrive locally is not necessarily the same as the order in which they
6765 arrived on the mailing list. Consequently, when sorting sub-threads
6766 using the default @code{gnus-thread-sort-by-number}, responses can end
6767 up appearing before the article to which they are responding to.
6768 Setting this variable to an alternate value
6769 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
6770 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
6771 more logical sub-thread ordering in such instances.
6776 @node Low-Level Threading
6777 @subsubsection Low-Level Threading
6781 @item gnus-parse-headers-hook
6782 @vindex gnus-parse-headers-hook
6783 Hook run before parsing any headers. The default value is
6784 @code{(gnus-set-summary-default-charset)}, which sets up local value of
6785 @code{default-mime-charset} in summary buffer based on variable
6786 @code{gnus-newsgroup-default-charset-alist}.
6788 @item gnus-alter-header-function
6789 @vindex gnus-alter-header-function
6790 If non-@code{nil}, this function will be called to allow alteration of
6791 article header structures. The function is called with one parameter,
6792 the article header vector, which it may alter in any way. For instance,
6793 if you have a mail-to-news gateway which alters the @code{Message-ID}s
6794 in systematic ways (by adding prefixes and such), you can use this
6795 variable to un-scramble the @code{Message-ID}s so that they are more
6796 meaningful. Here's one example:
6799 (setq gnus-alter-header-function 'my-alter-message-id)
6801 (defun my-alter-message-id (header)
6802 (let ((id (mail-header-id header)))
6804 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
6806 (concat (match-string 1 id) "@@" (match-string 2 id))
6813 @node Thread Commands
6814 @subsection Thread Commands
6815 @cindex thread commands
6821 @kindex T k (Summary)
6822 @kindex C-M-k (Summary)
6823 @findex gnus-summary-kill-thread
6824 Mark all articles in the current (sub-)thread as read
6825 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
6826 remove all marks instead. If the prefix argument is negative, tick
6831 @kindex T l (Summary)
6832 @kindex C-M-l (Summary)
6833 @findex gnus-summary-lower-thread
6834 Lower the score of the current (sub-)thread
6835 (@code{gnus-summary-lower-thread}).
6838 @kindex T i (Summary)
6839 @findex gnus-summary-raise-thread
6840 Increase the score of the current (sub-)thread
6841 (@code{gnus-summary-raise-thread}).
6844 @kindex T # (Summary)
6845 @findex gnus-uu-mark-thread
6846 Set the process mark on the current (sub-)thread
6847 (@code{gnus-uu-mark-thread}).
6850 @kindex T M-# (Summary)
6851 @findex gnus-uu-unmark-thread
6852 Remove the process mark from the current (sub-)thread
6853 (@code{gnus-uu-unmark-thread}).
6856 @kindex T T (Summary)
6857 @findex gnus-summary-toggle-threads
6858 Toggle threading (@code{gnus-summary-toggle-threads}).
6861 @kindex T s (Summary)
6862 @findex gnus-summary-show-thread
6863 Expose the (sub-)thread hidden under the current article, if any@*
6864 (@code{gnus-summary-show-thread}).
6867 @kindex T h (Summary)
6868 @findex gnus-summary-hide-thread
6869 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
6872 @kindex T S (Summary)
6873 @findex gnus-summary-show-all-threads
6874 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
6877 @kindex T H (Summary)
6878 @findex gnus-summary-hide-all-threads
6879 Hide all threads (@code{gnus-summary-hide-all-threads}).
6882 @kindex T t (Summary)
6883 @findex gnus-summary-rethread-current
6884 Re-thread the current article's thread
6885 (@code{gnus-summary-rethread-current}). This works even when the
6886 summary buffer is otherwise unthreaded.
6889 @kindex T ^ (Summary)
6890 @findex gnus-summary-reparent-thread
6891 Make the current article the child of the marked (or previous) article
6892 (@code{gnus-summary-reparent-thread}).
6896 The following commands are thread movement commands. They all
6897 understand the numeric prefix.
6902 @kindex T n (Summary)
6904 @kindex C-M-n (Summary)
6906 @kindex M-down (Summary)
6907 @findex gnus-summary-next-thread
6908 Go to the next thread (@code{gnus-summary-next-thread}).
6911 @kindex T p (Summary)
6913 @kindex C-M-p (Summary)
6915 @kindex M-up (Summary)
6916 @findex gnus-summary-prev-thread
6917 Go to the previous thread (@code{gnus-summary-prev-thread}).
6920 @kindex T d (Summary)
6921 @findex gnus-summary-down-thread
6922 Descend the thread (@code{gnus-summary-down-thread}).
6925 @kindex T u (Summary)
6926 @findex gnus-summary-up-thread
6927 Ascend the thread (@code{gnus-summary-up-thread}).
6930 @kindex T o (Summary)
6931 @findex gnus-summary-top-thread
6932 Go to the top of the thread (@code{gnus-summary-top-thread}).
6935 @vindex gnus-thread-operation-ignore-subject
6936 If you ignore subject while threading, you'll naturally end up with
6937 threads that have several different subjects in them. If you then issue
6938 a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not
6939 wish to kill the entire thread, but just those parts of the thread that
6940 have the same subject as the current article. If you like this idea,
6941 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
6942 is non-@code{nil} (which it is by default), subjects will be ignored
6943 when doing thread commands. If this variable is @code{nil}, articles in
6944 the same thread with different subjects will not be included in the
6945 operation in question. If this variable is @code{fuzzy}, only articles
6946 that have subjects fuzzily equal will be included (@pxref{Fuzzy
6950 @node Sorting the Summary Buffer
6951 @section Sorting the Summary Buffer
6953 @findex gnus-thread-sort-by-total-score
6954 @findex gnus-thread-sort-by-date
6955 @findex gnus-thread-sort-by-score
6956 @findex gnus-thread-sort-by-subject
6957 @findex gnus-thread-sort-by-author
6958 @findex gnus-thread-sort-by-number
6959 @findex gnus-thread-sort-by-random
6960 @vindex gnus-thread-sort-functions
6961 @findex gnus-thread-sort-by-most-recent-number
6962 @findex gnus-thread-sort-by-most-recent-date
6963 If you are using a threaded summary display, you can sort the threads by
6964 setting @code{gnus-thread-sort-functions}, which can be either a single
6965 function, a list of functions, or a list containing functions and
6966 @code{(not some-function)} elements.
6968 By default, sorting is done on article numbers. Ready-made sorting
6969 predicate functions include @code{gnus-thread-sort-by-number},
6970 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
6971 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score},
6972 @code{gnus-thread-sort-by-most-recent-number},
6973 @code{gnus-thread-sort-by-most-recent-date},
6974 @code{gnus-thread-sort-by-random} and
6975 @code{gnus-thread-sort-by-total-score}.
6977 Each function takes two threads and returns non-@code{nil} if the first
6978 thread should be sorted before the other. Note that sorting really is
6979 normally done by looking only at the roots of each thread.
6981 If you use more than one function, the primary sort key should be the
6982 last function in the list. You should probably always include
6983 @code{gnus-thread-sort-by-number} in the list of sorting
6984 functions---preferably first. This will ensure that threads that are
6985 equal with respect to the other sort criteria will be displayed in
6986 ascending article order.
6988 If you would like to sort by reverse score, then by subject, and finally
6989 by number, you could do something like:
6992 (setq gnus-thread-sort-functions
6993 '(gnus-thread-sort-by-number
6994 gnus-thread-sort-by-subject
6995 (not gnus-thread-sort-by-total-score)))
6998 The threads that have highest score will be displayed first in the
6999 summary buffer. When threads have the same score, they will be sorted
7000 alphabetically. The threads that have the same score and the same
7001 subject will be sorted by number, which is (normally) the sequence in
7002 which the articles arrived.
7004 If you want to sort by score and then reverse arrival order, you could
7008 (setq gnus-thread-sort-functions
7010 (not (gnus-thread-sort-by-number t1 t2)))
7011 gnus-thread-sort-by-score))
7014 @vindex gnus-thread-score-function
7015 The function in the @code{gnus-thread-score-function} variable (default
7016 @code{+}) is used for calculating the total score of a thread. Useful
7017 functions might be @code{max}, @code{min}, or squared means, or whatever
7020 @findex gnus-article-sort-functions
7021 @findex gnus-article-sort-by-date
7022 @findex gnus-article-sort-by-score
7023 @findex gnus-article-sort-by-subject
7024 @findex gnus-article-sort-by-author
7025 @findex gnus-article-sort-by-random
7026 @findex gnus-article-sort-by-number
7027 If you are using an unthreaded display for some strange reason or
7028 other, you have to fiddle with the @code{gnus-article-sort-functions}
7029 variable. It is very similar to the
7030 @code{gnus-thread-sort-functions}, except that it uses slightly
7031 different functions for article comparison. Available sorting
7032 predicate functions are @code{gnus-article-sort-by-number},
7033 @code{gnus-article-sort-by-author},
7034 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
7035 @code{gnus-article-sort-by-random}, and
7036 @code{gnus-article-sort-by-score}.
7038 If you want to sort an unthreaded summary display by subject, you could
7042 (setq gnus-article-sort-functions
7043 '(gnus-article-sort-by-number
7044 gnus-article-sort-by-subject))
7049 @node Asynchronous Fetching
7050 @section Asynchronous Article Fetching
7051 @cindex asynchronous article fetching
7052 @cindex article pre-fetch
7055 If you read your news from an @acronym{NNTP} server that's far away, the
7056 network latencies may make reading articles a chore. You have to wait
7057 for a while after pressing @kbd{n} to go to the next article before the
7058 article appears. Why can't gnus just go ahead and fetch the article
7059 while you are reading the previous one? Why not, indeed.
7061 First, some caveats. There are some pitfalls to using asynchronous
7062 article fetching, especially the way gnus does it.
7064 Let's say you are reading article 1, which is short, and article 2 is
7065 quite long, and you are not interested in reading that. Gnus does not
7066 know this, so it goes ahead and fetches article 2. You decide to read
7067 article 3, but since gnus is in the process of fetching article 2, the
7068 connection is blocked.
7070 To avoid these situations, gnus will open two (count 'em two)
7071 connections to the server. Some people may think this isn't a very nice
7072 thing to do, but I don't see any real alternatives. Setting up that
7073 extra connection takes some time, so gnus startup will be slower.
7075 Gnus will fetch more articles than you will read. This will mean that
7076 the link between your machine and the @acronym{NNTP} server will become more
7077 loaded than if you didn't use article pre-fetch. The server itself will
7078 also become more loaded---both with the extra article requests, and the
7081 Ok, so now you know that you shouldn't really use this thing@dots{} unless
7084 @vindex gnus-asynchronous
7085 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
7086 happen automatically.
7088 @vindex gnus-use-article-prefetch
7089 You can control how many articles are to be pre-fetched by setting
7090 @code{gnus-use-article-prefetch}. This is 30 by default, which means
7091 that when you read an article in the group, the back end will pre-fetch
7092 the next 30 articles. If this variable is @code{t}, the back end will
7093 pre-fetch all the articles it can without bound. If it is
7094 @code{nil}, no pre-fetching will be done.
7096 @vindex gnus-async-prefetch-article-p
7097 @findex gnus-async-read-p
7098 There are probably some articles that you don't want to pre-fetch---read
7099 articles, for instance. The @code{gnus-async-prefetch-article-p}
7100 variable controls whether an article is to be pre-fetched. This
7101 function should return non-@code{nil} when the article in question is
7102 to be pre-fetched. The default is @code{gnus-async-read-p}, which
7103 returns @code{nil} on read articles. The function is called with an
7104 article data structure as the only parameter.
7106 If, for instance, you wish to pre-fetch only unread articles shorter
7107 than 100 lines, you could say something like:
7110 (defun my-async-short-unread-p (data)
7111 "Return non-nil for short, unread articles."
7112 (and (gnus-data-unread-p data)
7113 (< (mail-header-lines (gnus-data-header data))
7116 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
7119 These functions will be called many, many times, so they should
7120 preferably be short and sweet to avoid slowing down gnus too much.
7121 It's probably a good idea to byte-compile things like this.
7123 @vindex gnus-prefetched-article-deletion-strategy
7124 Articles have to be removed from the asynch buffer sooner or later. The
7125 @code{gnus-prefetched-article-deletion-strategy} says when to remove
7126 articles. This is a list that may contain the following elements:
7130 Remove articles when they are read.
7133 Remove articles when exiting the group.
7136 The default value is @code{(read exit)}.
7138 @c @vindex gnus-use-header-prefetch
7139 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
7140 @c from the next group.
7143 @node Article Caching
7144 @section Article Caching
7145 @cindex article caching
7148 If you have an @emph{extremely} slow @acronym{NNTP} connection, you may
7149 consider turning article caching on. Each article will then be stored
7150 locally under your home directory. As you may surmise, this could
7151 potentially use @emph{huge} amounts of disk space, as well as eat up all
7152 your inodes so fast it will make your head swim. In vodka.
7154 Used carefully, though, it could be just an easier way to save articles.
7156 @vindex gnus-use-long-file-name
7157 @vindex gnus-cache-directory
7158 @vindex gnus-use-cache
7159 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
7160 all articles ticked or marked as dormant will then be copied
7161 over to your local cache (@code{gnus-cache-directory}). Whether this
7162 cache is flat or hierarchical is controlled by the
7163 @code{gnus-use-long-file-name} variable, as usual.
7165 When re-selecting a ticked or dormant article, it will be fetched from the
7166 cache instead of from the server. As articles in your cache will never
7167 expire, this might serve as a method of saving articles while still
7168 keeping them where they belong. Just mark all articles you want to save
7169 as dormant, and don't worry.
7171 When an article is marked as read, is it removed from the cache.
7173 @vindex gnus-cache-remove-articles
7174 @vindex gnus-cache-enter-articles
7175 The entering/removal of articles from the cache is controlled by the
7176 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
7177 variables. Both are lists of symbols. The first is @code{(ticked
7178 dormant)} by default, meaning that ticked and dormant articles will be
7179 put in the cache. The latter is @code{(read)} by default, meaning that
7180 articles marked as read are removed from the cache. Possibly
7181 symbols in these two lists are @code{ticked}, @code{dormant},
7182 @code{unread} and @code{read}.
7184 @findex gnus-jog-cache
7185 So where does the massive article-fetching and storing come into the
7186 picture? The @code{gnus-jog-cache} command will go through all
7187 subscribed newsgroups, request all unread articles, score them, and
7188 store them in the cache. You should only ever, ever ever ever, use this
7189 command if 1) your connection to the @acronym{NNTP} server is really, really,
7190 really slow and 2) you have a really, really, really huge disk.
7191 Seriously. One way to cut down on the number of articles downloaded is
7192 to score unwanted articles down and have them marked as read. They will
7193 not then be downloaded by this command.
7195 @vindex gnus-uncacheable-groups
7196 @vindex gnus-cacheable-groups
7197 It is likely that you do not want caching on all groups. For instance,
7198 if your @code{nnml} mail is located under your home directory, it makes no
7199 sense to cache it somewhere else under your home directory. Unless you
7200 feel that it's neat to use twice as much space.
7202 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7203 regexp of groups to cache, @samp{^nntp} for instance, or set the
7204 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7205 Both variables are @code{nil} by default. If a group matches both
7206 variables, the group is not cached.
7208 @findex gnus-cache-generate-nov-databases
7209 @findex gnus-cache-generate-active
7210 @vindex gnus-cache-active-file
7211 The cache stores information on what articles it contains in its active
7212 file (@code{gnus-cache-active-file}). If this file (or any other parts
7213 of the cache) becomes all messed up for some reason or other, gnus
7214 offers two functions that will try to set things right. @kbd{M-x
7215 gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV}
7216 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7219 @findex gnus-cache-move-cache
7220 @code{gnus-cache-move-cache} will move your whole
7221 @code{gnus-cache-directory} to some other location. You get asked to
7222 where, isn't that cool?
7224 @node Persistent Articles
7225 @section Persistent Articles
7226 @cindex persistent articles
7228 Closely related to article caching, we have @dfn{persistent articles}.
7229 In fact, it's just a different way of looking at caching, and much more
7230 useful in my opinion.
7232 Say you're reading a newsgroup, and you happen on to some valuable gem
7233 that you want to keep and treasure forever. You'd normally just save it
7234 (using one of the many saving commands) in some file. The problem with
7235 that is that it's just, well, yucky. Ideally you'd prefer just having
7236 the article remain in the group where you found it forever; untouched by
7237 the expiry going on at the news server.
7239 This is what a @dfn{persistent article} is---an article that just won't
7240 be deleted. It's implemented using the normal cache functions, but
7241 you use two explicit commands for managing persistent articles:
7247 @findex gnus-cache-enter-article
7248 Make the current article persistent (@code{gnus-cache-enter-article}).
7251 @kindex M-* (Summary)
7252 @findex gnus-cache-remove-article
7253 Remove the current article from the persistent articles
7254 (@code{gnus-cache-remove-article}). This will normally delete the
7258 Both these commands understand the process/prefix convention.
7260 To avoid having all ticked articles (and stuff) entered into the cache,
7261 you should set @code{gnus-use-cache} to @code{passive} if you're just
7262 interested in persistent articles:
7265 (setq gnus-use-cache 'passive)
7269 @node Article Backlog
7270 @section Article Backlog
7272 @cindex article backlog
7274 If you have a slow connection, but the idea of using caching seems
7275 unappealing to you (and it is, really), you can help the situation some
7276 by switching on the @dfn{backlog}. This is where gnus will buffer
7277 already read articles so that it doesn't have to re-fetch articles
7278 you've already read. This only helps if you are in the habit of
7279 re-selecting articles you've recently read, of course. If you never do
7280 that, turning the backlog on will slow gnus down a little bit, and
7281 increase memory usage some.
7283 @vindex gnus-keep-backlog
7284 If you set @code{gnus-keep-backlog} to a number @var{n}, gnus will store
7285 at most @var{n} old articles in a buffer for later re-fetching. If this
7286 variable is non-@code{nil} and is not a number, gnus will store
7287 @emph{all} read articles, which means that your Emacs will grow without
7288 bound before exploding and taking your machine down with you. I put
7289 that in there just to keep y'all on your toes.
7291 The default value is 20.
7294 @node Saving Articles
7295 @section Saving Articles
7296 @cindex saving articles
7298 Gnus can save articles in a number of ways. Below is the documentation
7299 for saving articles in a fairly straight-forward fashion (i.e., little
7300 processing of the article is done before it is saved). For a different
7301 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7302 (@pxref{Decoding Articles}).
7304 For the commands listed here, the target is a file. If you want to
7305 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7306 command (@pxref{Mail Group Commands}).
7308 @vindex gnus-save-all-headers
7309 If @code{gnus-save-all-headers} is non-@code{nil}, gnus will not delete
7310 unwanted headers before saving the article.
7312 @vindex gnus-saved-headers
7313 If the preceding variable is @code{nil}, all headers that match the
7314 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7315 deleted before saving.
7321 @kindex O o (Summary)
7323 @findex gnus-summary-save-article
7324 @c @icon{gnus-summary-save-article}
7325 Save the current article using the default article saver
7326 (@code{gnus-summary-save-article}).
7329 @kindex O m (Summary)
7330 @findex gnus-summary-save-article-mail
7331 Save the current article in mail format
7332 (@code{gnus-summary-save-article-mail}).
7335 @kindex O r (Summary)
7336 @findex gnus-summary-save-article-rmail
7337 Save the current article in Rmail format
7338 (@code{gnus-summary-save-article-rmail}).
7341 @kindex O f (Summary)
7342 @findex gnus-summary-save-article-file
7343 @c @icon{gnus-summary-save-article-file}
7344 Save the current article in plain file format
7345 (@code{gnus-summary-save-article-file}).
7348 @kindex O F (Summary)
7349 @findex gnus-summary-write-article-file
7350 Write the current article in plain file format, overwriting any previous
7351 file contents (@code{gnus-summary-write-article-file}).
7354 @kindex O b (Summary)
7355 @findex gnus-summary-save-article-body-file
7356 Save the current article body in plain file format
7357 (@code{gnus-summary-save-article-body-file}).
7360 @kindex O h (Summary)
7361 @findex gnus-summary-save-article-folder
7362 Save the current article in mh folder format
7363 (@code{gnus-summary-save-article-folder}).
7366 @kindex O v (Summary)
7367 @findex gnus-summary-save-article-vm
7368 Save the current article in a VM folder
7369 (@code{gnus-summary-save-article-vm}).
7373 @kindex O p (Summary)
7375 @findex gnus-summary-pipe-output
7376 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
7377 the current article to a process (@code{gnus-summary-pipe-output}).
7378 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7379 complete headers in the piped output.
7382 @kindex O P (Summary)
7383 @findex gnus-summary-muttprint
7384 @vindex gnus-summary-muttprint-program
7385 Save the current article into muttprint. That is, print it using the
7386 external program @uref{http://muttprint.sourceforge.net/,
7387 Muttprint}. The program name and options to use is controlled by the
7388 variable @code{gnus-summary-muttprint-program}.
7389 (@code{gnus-summary-muttprint}).
7393 @vindex gnus-prompt-before-saving
7394 All these commands use the process/prefix convention
7395 (@pxref{Process/Prefix}). If you save bunches of articles using these
7396 functions, you might get tired of being prompted for files to save each
7397 and every article in. The prompting action is controlled by
7398 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7399 default, giving you that excessive prompting action you know and
7400 loathe. If you set this variable to @code{t} instead, you'll be prompted
7401 just once for each series of articles you save. If you like to really
7402 have Gnus do all your thinking for you, you can even set this variable
7403 to @code{nil}, which means that you will never be prompted for files to
7404 save articles in. Gnus will simply save all the articles in the default
7408 @vindex gnus-default-article-saver
7409 You can customize the @code{gnus-default-article-saver} variable to make
7410 gnus do what you want it to. You can use any of the six ready-made
7411 functions below, or you can create your own.
7415 @item gnus-summary-save-in-rmail
7416 @findex gnus-summary-save-in-rmail
7417 @vindex gnus-rmail-save-name
7418 @findex gnus-plain-save-name
7419 This is the default format, @dfn{Babyl}. Uses the function in the
7420 @code{gnus-rmail-save-name} variable to get a file name to save the
7421 article in. The default is @code{gnus-plain-save-name}.
7423 @item gnus-summary-save-in-mail
7424 @findex gnus-summary-save-in-mail
7425 @vindex gnus-mail-save-name
7426 Save in a Unix mail (mbox) file. Uses the function in the
7427 @code{gnus-mail-save-name} variable to get a file name to save the
7428 article in. The default is @code{gnus-plain-save-name}.
7430 @item gnus-summary-save-in-file
7431 @findex gnus-summary-save-in-file
7432 @vindex gnus-file-save-name
7433 @findex gnus-numeric-save-name
7434 Append the article straight to an ordinary file. Uses the function in
7435 the @code{gnus-file-save-name} variable to get a file name to save the
7436 article in. The default is @code{gnus-numeric-save-name}.
7438 @item gnus-summary-write-to-file
7439 @findex gnus-summary-write-to-file
7440 Write the article straight to an ordinary file. The file is
7441 overwritten if it exists. Uses the function in the
7442 @code{gnus-file-save-name} variable to get a file name to save the
7443 article in. The default is @code{gnus-numeric-save-name}.
7445 @item gnus-summary-save-body-in-file
7446 @findex gnus-summary-save-body-in-file
7447 Append the article body to an ordinary file. Uses the function in the
7448 @code{gnus-file-save-name} variable to get a file name to save the
7449 article in. The default is @code{gnus-numeric-save-name}.
7451 @item gnus-summary-save-in-folder
7452 @findex gnus-summary-save-in-folder
7453 @findex gnus-folder-save-name
7454 @findex gnus-Folder-save-name
7455 @vindex gnus-folder-save-name
7458 Save the article to an MH folder using @code{rcvstore} from the MH
7459 library. Uses the function in the @code{gnus-folder-save-name} variable
7460 to get a file name to save the article in. The default is
7461 @code{gnus-folder-save-name}, but you can also use
7462 @code{gnus-Folder-save-name}, which creates capitalized names.
7464 @item gnus-summary-save-in-vm
7465 @findex gnus-summary-save-in-vm
7466 Save the article in a VM folder. You have to have the VM mail
7467 reader to use this setting.
7470 @vindex gnus-article-save-directory
7471 All of these functions, except for the last one, will save the article
7472 in the @code{gnus-article-save-directory}, which is initialized from the
7473 @env{SAVEDIR} environment variable. This is @file{~/News/} by
7476 As you can see above, the functions use different functions to find a
7477 suitable name of a file to save the article in. Below is a list of
7478 available functions that generate names:
7482 @item gnus-Numeric-save-name
7483 @findex gnus-Numeric-save-name
7484 File names like @file{~/News/Alt.andrea-dworkin/45}.
7486 @item gnus-numeric-save-name
7487 @findex gnus-numeric-save-name
7488 File names like @file{~/News/alt.andrea-dworkin/45}.
7490 @item gnus-Plain-save-name
7491 @findex gnus-Plain-save-name
7492 File names like @file{~/News/Alt.andrea-dworkin}.
7494 @item gnus-plain-save-name
7495 @findex gnus-plain-save-name
7496 File names like @file{~/News/alt.andrea-dworkin}.
7498 @item gnus-sender-save-name
7499 @findex gnus-sender-save-name
7500 File names like @file{~/News/larsi}.
7503 @vindex gnus-split-methods
7504 You can have gnus suggest where to save articles by plonking a regexp into
7505 the @code{gnus-split-methods} alist. For instance, if you would like to
7506 save articles related to gnus in the file @file{gnus-stuff}, and articles
7507 related to VM in @file{vm-stuff}, you could set this variable to something
7511 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
7512 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
7513 (my-choosing-function "../other-dir/my-stuff")
7514 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
7517 We see that this is a list where each element is a list that has two
7518 elements---the @dfn{match} and the @dfn{file}. The match can either be
7519 a string (in which case it is used as a regexp to match on the article
7520 head); it can be a symbol (which will be called as a function with the
7521 group name as a parameter); or it can be a list (which will be
7522 @code{eval}ed). If any of these actions have a non-@code{nil} result,
7523 the @dfn{file} will be used as a default prompt. In addition, the
7524 result of the operation itself will be used if the function or form
7525 called returns a string or a list of strings.
7527 You basically end up with a list of file names that might be used when
7528 saving the current article. (All ``matches'' will be used.) You will
7529 then be prompted for what you really want to use as a name, with file
7530 name completion over the results from applying this variable.
7532 This variable is @code{((gnus-article-archive-name))} by default, which
7533 means that gnus will look at the articles it saves for an
7534 @code{Archive-name} line and use that as a suggestion for the file
7537 Here's an example function to clean up file names somewhat. If you have
7538 lots of mail groups called things like
7539 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
7540 these group names before creating the file name to save to. The
7541 following will do just that:
7544 (defun my-save-name (group)
7545 (when (string-match "^nnml:mail." group)
7546 (substring group (match-end 0))))
7548 (setq gnus-split-methods
7549 '((gnus-article-archive-name)
7554 @vindex gnus-use-long-file-name
7555 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
7556 @code{nil}, all the preceding functions will replace all periods
7557 (@samp{.}) in the group names with slashes (@samp{/})---which means that
7558 the functions will generate hierarchies of directories instead of having
7559 all the files in the top level directory
7560 (@file{~/News/alt/andrea-dworkin} instead of
7561 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
7562 on most systems. However, for historical reasons, this is @code{nil} on
7563 Xenix and usg-unix-v machines by default.
7565 This function also affects kill and score file names. If this variable
7566 is a list, and the list contains the element @code{not-score}, long file
7567 names will not be used for score files, if it contains the element
7568 @code{not-save}, long file names will not be used for saving, and if it
7569 contains the element @code{not-kill}, long file names will not be used
7572 If you'd like to save articles in a hierarchy that looks something like
7576 (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy}
7577 (setq gnus-default-article-saver
7578 'gnus-summary-save-in-file) ; @r{no encoding}
7581 Then just save with @kbd{o}. You'd then read this hierarchy with
7582 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
7583 the top level directory as the argument (@file{~/News/}). Then just walk
7584 around to the groups/directories with @code{nneething}.
7587 @node Decoding Articles
7588 @section Decoding Articles
7589 @cindex decoding articles
7591 Sometime users post articles (or series of articles) that have been
7592 encoded in some way or other. Gnus can decode them for you.
7595 * Uuencoded Articles:: Uudecode articles.
7596 * Shell Archives:: Unshar articles.
7597 * PostScript Files:: Split PostScript.
7598 * Other Files:: Plain save and binhex.
7599 * Decoding Variables:: Variables for a happy decoding.
7600 * Viewing Files:: You want to look at the result of the decoding?
7604 @cindex article series
7605 All these functions use the process/prefix convention
7606 (@pxref{Process/Prefix}) for finding out what articles to work on, with
7607 the extension that a ``single article'' means ``a single series''. Gnus
7608 can find out by itself what articles belong to a series, decode all the
7609 articles and unpack/view/save the resulting file(s).
7611 Gnus guesses what articles are in the series according to the following
7612 simplish rule: The subjects must be (nearly) identical, except for the
7613 last two numbers of the line. (Spaces are largely ignored, however.)
7615 For example: If you choose a subject called @samp{cat.gif (2/3)}, gnus
7616 will find all the articles that match the regexp @samp{^cat.gif
7617 ([0-9]+/[0-9]+).*$}.
7619 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
7620 series}, will not be properly recognized by any of the automatic viewing
7621 commands, and you have to mark the articles manually with @kbd{#}.
7624 @node Uuencoded Articles
7625 @subsection Uuencoded Articles
7627 @cindex uuencoded articles
7632 @kindex X u (Summary)
7633 @findex gnus-uu-decode-uu
7634 @c @icon{gnus-uu-decode-uu}
7635 Uudecodes the current series (@code{gnus-uu-decode-uu}).
7638 @kindex X U (Summary)
7639 @findex gnus-uu-decode-uu-and-save
7640 Uudecodes and saves the current series
7641 (@code{gnus-uu-decode-uu-and-save}).
7644 @kindex X v u (Summary)
7645 @findex gnus-uu-decode-uu-view
7646 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
7649 @kindex X v U (Summary)
7650 @findex gnus-uu-decode-uu-and-save-view
7651 Uudecodes, views and saves the current series
7652 (@code{gnus-uu-decode-uu-and-save-view}).
7656 Remember that these all react to the presence of articles marked with
7657 the process mark. If, for instance, you'd like to decode and save an
7658 entire newsgroup, you'd typically do @kbd{M P a}
7659 (@code{gnus-uu-mark-all}) and then @kbd{X U}
7660 (@code{gnus-uu-decode-uu-and-save}).
7662 All this is very much different from how @code{gnus-uu} worked with
7663 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
7664 the sun. This version of @code{gnus-uu} generally assumes that you mark
7665 articles in some way (@pxref{Setting Process Marks}) and then press
7668 @vindex gnus-uu-notify-files
7669 Note: When trying to decode articles that have names matching
7670 @code{gnus-uu-notify-files}, which is hard-coded to
7671 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
7672 automatically post an article on @samp{comp.unix.wizards} saying that
7673 you have just viewed the file in question. This feature can't be turned
7677 @node Shell Archives
7678 @subsection Shell Archives
7680 @cindex shell archives
7681 @cindex shared articles
7683 Shell archives (``shar files'') used to be a popular way to distribute
7684 sources, but it isn't used all that much today. In any case, we have
7685 some commands to deal with these:
7690 @kindex X s (Summary)
7691 @findex gnus-uu-decode-unshar
7692 Unshars the current series (@code{gnus-uu-decode-unshar}).
7695 @kindex X S (Summary)
7696 @findex gnus-uu-decode-unshar-and-save
7697 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
7700 @kindex X v s (Summary)
7701 @findex gnus-uu-decode-unshar-view
7702 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
7705 @kindex X v S (Summary)
7706 @findex gnus-uu-decode-unshar-and-save-view
7707 Unshars, views and saves the current series
7708 (@code{gnus-uu-decode-unshar-and-save-view}).
7712 @node PostScript Files
7713 @subsection PostScript Files
7719 @kindex X p (Summary)
7720 @findex gnus-uu-decode-postscript
7721 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
7724 @kindex X P (Summary)
7725 @findex gnus-uu-decode-postscript-and-save
7726 Unpack and save the current PostScript series
7727 (@code{gnus-uu-decode-postscript-and-save}).
7730 @kindex X v p (Summary)
7731 @findex gnus-uu-decode-postscript-view
7732 View the current PostScript series
7733 (@code{gnus-uu-decode-postscript-view}).
7736 @kindex X v P (Summary)
7737 @findex gnus-uu-decode-postscript-and-save-view
7738 View and save the current PostScript series
7739 (@code{gnus-uu-decode-postscript-and-save-view}).
7744 @subsection Other Files
7748 @kindex X o (Summary)
7749 @findex gnus-uu-decode-save
7750 Save the current series
7751 (@code{gnus-uu-decode-save}).
7754 @kindex X b (Summary)
7755 @findex gnus-uu-decode-binhex
7756 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
7757 doesn't really work yet.
7761 @node Decoding Variables
7762 @subsection Decoding Variables
7764 Adjective, not verb.
7767 * Rule Variables:: Variables that say how a file is to be viewed.
7768 * Other Decode Variables:: Other decode variables.
7769 * Uuencoding and Posting:: Variables for customizing uuencoding.
7773 @node Rule Variables
7774 @subsubsection Rule Variables
7775 @cindex rule variables
7777 Gnus uses @dfn{rule variables} to decide how to view a file. All these
7778 variables are of the form
7781 (list '(regexp1 command2)
7788 @item gnus-uu-user-view-rules
7789 @vindex gnus-uu-user-view-rules
7791 This variable is consulted first when viewing files. If you wish to use,
7792 for instance, @code{sox} to convert an @file{.au} sound file, you could
7795 (setq gnus-uu-user-view-rules
7796 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
7799 @item gnus-uu-user-view-rules-end
7800 @vindex gnus-uu-user-view-rules-end
7801 This variable is consulted if gnus couldn't make any matches from the
7802 user and default view rules.
7804 @item gnus-uu-user-archive-rules
7805 @vindex gnus-uu-user-archive-rules
7806 This variable can be used to say what commands should be used to unpack
7811 @node Other Decode Variables
7812 @subsubsection Other Decode Variables
7815 @vindex gnus-uu-grabbed-file-functions
7817 @item gnus-uu-grabbed-file-functions
7818 All functions in this list will be called right after each file has been
7819 successfully decoded---so that you can move or view files right away,
7820 and don't have to wait for all files to be decoded before you can do
7821 anything. Ready-made functions you can put in this list are:
7825 @item gnus-uu-grab-view
7826 @findex gnus-uu-grab-view
7829 @item gnus-uu-grab-move
7830 @findex gnus-uu-grab-move
7831 Move the file (if you're using a saving function.)
7834 @item gnus-uu-be-dangerous
7835 @vindex gnus-uu-be-dangerous
7836 Specifies what to do if unusual situations arise during decoding. If
7837 @code{nil}, be as conservative as possible. If @code{t}, ignore things
7838 that didn't work, and overwrite existing files. Otherwise, ask each
7841 @item gnus-uu-ignore-files-by-name
7842 @vindex gnus-uu-ignore-files-by-name
7843 Files with name matching this regular expression won't be viewed.
7845 @item gnus-uu-ignore-files-by-type
7846 @vindex gnus-uu-ignore-files-by-type
7847 Files with a @acronym{MIME} type matching this variable won't be viewed.
7848 Note that Gnus tries to guess what type the file is based on the name.
7849 @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly
7852 @item gnus-uu-tmp-dir
7853 @vindex gnus-uu-tmp-dir
7854 Where @code{gnus-uu} does its work.
7856 @item gnus-uu-do-not-unpack-archives
7857 @vindex gnus-uu-do-not-unpack-archives
7858 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
7859 looking for files to display.
7861 @item gnus-uu-view-and-save
7862 @vindex gnus-uu-view-and-save
7863 Non-@code{nil} means that the user will always be asked to save a file
7866 @item gnus-uu-ignore-default-view-rules
7867 @vindex gnus-uu-ignore-default-view-rules
7868 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
7871 @item gnus-uu-ignore-default-archive-rules
7872 @vindex gnus-uu-ignore-default-archive-rules
7873 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
7876 @item gnus-uu-kill-carriage-return
7877 @vindex gnus-uu-kill-carriage-return
7878 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
7881 @item gnus-uu-unmark-articles-not-decoded
7882 @vindex gnus-uu-unmark-articles-not-decoded
7883 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
7884 decoded articles as unread.
7886 @item gnus-uu-correct-stripped-uucode
7887 @vindex gnus-uu-correct-stripped-uucode
7888 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
7889 uuencoded files that have had trailing spaces deleted.
7891 @item gnus-uu-pre-uudecode-hook
7892 @vindex gnus-uu-pre-uudecode-hook
7893 Hook run before sending a message to @code{uudecode}.
7895 @item gnus-uu-view-with-metamail
7896 @vindex gnus-uu-view-with-metamail
7898 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
7899 commands defined by the rule variables and just fudge a @acronym{MIME}
7900 content type based on the file name. The result will be fed to
7901 @code{metamail} for viewing.
7903 @item gnus-uu-save-in-digest
7904 @vindex gnus-uu-save-in-digest
7905 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
7906 decoding, will save in digests. If this variable is @code{nil},
7907 @code{gnus-uu} will just save everything in a file without any
7908 embellishments. The digesting almost conforms to RFC 1153---no easy way
7909 to specify any meaningful volume and issue numbers were found, so I
7910 simply dropped them.
7915 @node Uuencoding and Posting
7916 @subsubsection Uuencoding and Posting
7920 @item gnus-uu-post-include-before-composing
7921 @vindex gnus-uu-post-include-before-composing
7922 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
7923 before you compose the article. If this variable is @code{t}, you can
7924 either include an encoded file with @kbd{C-c C-i} or have one included
7925 for you when you post the article.
7927 @item gnus-uu-post-length
7928 @vindex gnus-uu-post-length
7929 Maximum length of an article. The encoded file will be split into how
7930 many articles it takes to post the entire file.
7932 @item gnus-uu-post-threaded
7933 @vindex gnus-uu-post-threaded
7934 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
7935 thread. This may not be smart, as no other decoder I have seen is able
7936 to follow threads when collecting uuencoded articles. (Well, I have
7937 seen one package that does that---@code{gnus-uu}, but somehow, I don't
7938 think that counts@dots{}) Default is @code{nil}.
7940 @item gnus-uu-post-separate-description
7941 @vindex gnus-uu-post-separate-description
7942 Non-@code{nil} means that the description will be posted in a separate
7943 article. The first article will typically be numbered (0/x). If this
7944 variable is @code{nil}, the description the user enters will be included
7945 at the beginning of the first article, which will be numbered (1/x).
7946 Default is @code{t}.
7952 @subsection Viewing Files
7953 @cindex viewing files
7954 @cindex pseudo-articles
7956 After decoding, if the file is some sort of archive, gnus will attempt
7957 to unpack the archive and see if any of the files in the archive can be
7958 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
7959 containing the files @file{pic1.jpg} and @file{pic2.gif}, gnus will
7960 uncompress and de-tar the main file, and then view the two pictures.
7961 This unpacking process is recursive, so if the archive contains archives
7962 of archives, it'll all be unpacked.
7964 Finally, gnus will normally insert a @dfn{pseudo-article} for each
7965 extracted file into the summary buffer. If you go to these
7966 ``articles'', you will be prompted for a command to run (usually Gnus
7967 will make a suggestion), and then the command will be run.
7969 @vindex gnus-view-pseudo-asynchronously
7970 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
7971 until the viewing is done before proceeding.
7973 @vindex gnus-view-pseudos
7974 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
7975 the pseudo-articles into the summary buffer, but view them
7976 immediately. If this variable is @code{not-confirm}, the user won't even
7977 be asked for a confirmation before viewing is done.
7979 @vindex gnus-view-pseudos-separately
7980 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
7981 pseudo-article will be created for each file to be viewed. If
7982 @code{nil}, all files that use the same viewing command will be given as
7983 a list of parameters to that command.
7985 @vindex gnus-insert-pseudo-articles
7986 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
7987 pseudo-articles when decoding. It is @code{t} by default.
7989 So; there you are, reading your @emph{pseudo-articles} in your
7990 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
7991 Why isn't anything real anymore? How did we get here?
7994 @node Article Treatment
7995 @section Article Treatment
7997 Reading through this huge manual, you may have quite forgotten that the
7998 object of newsreaders is to actually, like, read what people have
7999 written. Reading articles. Unfortunately, people are quite bad at
8000 writing, so there are tons of functions and variables to make reading
8001 these articles easier.
8004 * Article Highlighting:: You want to make the article look like fruit salad.
8005 * Article Fontisizing:: Making emphasized text look nice.
8006 * Article Hiding:: You also want to make certain info go away.
8007 * Article Washing:: Lots of way-neat functions to make life better.
8008 * Article Header:: Doing various header transformations.
8009 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
8010 * Article Button Levels:: Controlling appearance of buttons.
8011 * Article Date:: Grumble, UT!
8012 * Article Display:: Display various stuff---X-Face, Picons, Smileys
8013 * Article Signature:: What is a signature?
8014 * Article Miscellanea:: Various other stuff.
8018 @node Article Highlighting
8019 @subsection Article Highlighting
8020 @cindex highlighting
8022 Not only do you want your article buffer to look like fruit salad, but
8023 you want it to look like technicolor fruit salad.
8028 @kindex W H a (Summary)
8029 @findex gnus-article-highlight
8030 @findex gnus-article-maybe-highlight
8031 Do much highlighting of the current article
8032 (@code{gnus-article-highlight}). This function highlights header, cited
8033 text, the signature, and adds buttons to the body and the head.
8036 @kindex W H h (Summary)
8037 @findex gnus-article-highlight-headers
8038 @vindex gnus-header-face-alist
8039 Highlight the headers (@code{gnus-article-highlight-headers}). The
8040 highlighting will be done according to the @code{gnus-header-face-alist}
8041 variable, which is a list where each element has the form
8042 @code{(@var{regexp} @var{name} @var{content})}.
8043 @var{regexp} is a regular expression for matching the
8044 header, @var{name} is the face used for highlighting the header name
8045 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
8046 the header value. The first match made will be used. Note that
8047 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
8050 @kindex W H c (Summary)
8051 @findex gnus-article-highlight-citation
8052 Highlight cited text (@code{gnus-article-highlight-citation}).
8054 Some variables to customize the citation highlights:
8057 @vindex gnus-cite-parse-max-size
8059 @item gnus-cite-parse-max-size
8060 If the article size if bigger than this variable (which is 25000 by
8061 default), no citation highlighting will be performed.
8063 @item gnus-cite-max-prefix
8064 @vindex gnus-cite-max-prefix
8065 Maximum possible length for a citation prefix (default 20).
8067 @item gnus-cite-face-list
8068 @vindex gnus-cite-face-list
8069 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
8070 When there are citations from multiple articles in the same message,
8071 gnus will try to give each citation from each article its own face.
8072 This should make it easier to see who wrote what.
8074 @item gnus-supercite-regexp
8075 @vindex gnus-supercite-regexp
8076 Regexp matching normal Supercite attribution lines.
8078 @item gnus-supercite-secondary-regexp
8079 @vindex gnus-supercite-secondary-regexp
8080 Regexp matching mangled Supercite attribution lines.
8082 @item gnus-cite-minimum-match-count
8083 @vindex gnus-cite-minimum-match-count
8084 Minimum number of identical prefixes we have to see before we believe
8085 that it's a citation.
8087 @item gnus-cite-attribution-prefix
8088 @vindex gnus-cite-attribution-prefix
8089 Regexp matching the beginning of an attribution line.
8091 @item gnus-cite-attribution-suffix
8092 @vindex gnus-cite-attribution-suffix
8093 Regexp matching the end of an attribution line.
8095 @item gnus-cite-attribution-face
8096 @vindex gnus-cite-attribution-face
8097 Face used for attribution lines. It is merged with the face for the
8098 cited text belonging to the attribution.
8104 @kindex W H s (Summary)
8105 @vindex gnus-signature-separator
8106 @vindex gnus-signature-face
8107 @findex gnus-article-highlight-signature
8108 Highlight the signature (@code{gnus-article-highlight-signature}).
8109 Everything after @code{gnus-signature-separator} (@pxref{Article
8110 Signature}) in an article will be considered a signature and will be
8111 highlighted with @code{gnus-signature-face}, which is @code{italic} by
8116 @xref{Customizing Articles}, for how to highlight articles automatically.
8119 @node Article Fontisizing
8120 @subsection Article Fontisizing
8122 @cindex article emphasis
8124 @findex gnus-article-emphasize
8125 @kindex W e (Summary)
8126 People commonly add emphasis to words in news articles by writing things
8127 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
8128 this look nicer by running the article through the @kbd{W e}
8129 (@code{gnus-article-emphasize}) command.
8131 @vindex gnus-emphasis-alist
8132 How the emphasis is computed is controlled by the
8133 @code{gnus-emphasis-alist} variable. This is an alist where the first
8134 element is a regular expression to be matched. The second is a number
8135 that says what regular expression grouping is used to find the entire
8136 emphasized word. The third is a number that says what regexp grouping
8137 should be displayed and highlighted. (The text between these two
8138 groupings will be hidden.) The fourth is the face used for
8142 (setq gnus-emphasis-alist
8143 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
8144 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
8153 @vindex gnus-emphasis-underline
8154 @vindex gnus-emphasis-bold
8155 @vindex gnus-emphasis-italic
8156 @vindex gnus-emphasis-underline-bold
8157 @vindex gnus-emphasis-underline-italic
8158 @vindex gnus-emphasis-bold-italic
8159 @vindex gnus-emphasis-underline-bold-italic
8160 By default, there are seven rules, and they use the following faces:
8161 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
8162 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
8163 @code{gnus-emphasis-underline-italic},
8164 @code{gnus-emphasis-underline-bold}, and
8165 @code{gnus-emphasis-underline-bold-italic}.
8167 If you want to change these faces, you can either use @kbd{M-x
8168 customize}, or you can use @code{copy-face}. For instance, if you want
8169 to make @code{gnus-emphasis-italic} use a red face instead, you could
8173 (copy-face 'red 'gnus-emphasis-italic)
8176 @vindex gnus-group-highlight-words-alist
8178 If you want to highlight arbitrary words, you can use the
8179 @code{gnus-group-highlight-words-alist} variable, which uses the same
8180 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
8181 parameter (@pxref{Group Parameters}) can also be used.
8183 @xref{Customizing Articles}, for how to fontize articles automatically.
8186 @node Article Hiding
8187 @subsection Article Hiding
8188 @cindex article hiding
8190 Or rather, hiding certain things in each article. There usually is much
8191 too much cruft in most articles.
8196 @kindex W W a (Summary)
8197 @findex gnus-article-hide
8198 Do quite a lot of hiding on the article buffer
8199 (@kbd{gnus-article-hide}). In particular, this function will hide
8200 headers, @acronym{PGP}, cited text and the signature.
8203 @kindex W W h (Summary)
8204 @findex gnus-article-hide-headers
8205 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
8209 @kindex W W b (Summary)
8210 @findex gnus-article-hide-boring-headers
8211 Hide headers that aren't particularly interesting
8212 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
8215 @kindex W W s (Summary)
8216 @findex gnus-article-hide-signature
8217 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
8221 @kindex W W l (Summary)
8222 @findex gnus-article-hide-list-identifiers
8223 @vindex gnus-list-identifiers
8224 Strip list identifiers specified in @code{gnus-list-identifiers}. These
8225 are strings some mailing list servers add to the beginning of all
8226 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
8227 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
8228 may not contain @code{\\(..\\)}.
8232 @item gnus-list-identifiers
8233 @vindex gnus-list-identifiers
8234 A regular expression that matches list identifiers to be removed from
8235 subject. This can also be a list of regular expressions.
8240 @kindex W W P (Summary)
8241 @findex gnus-article-hide-pem
8242 Hide @acronym{PEM} (privacy enhanced messages) cruft
8243 (@code{gnus-article-hide-pem}).
8246 @kindex W W B (Summary)
8247 @findex gnus-article-strip-banner
8248 @vindex gnus-article-banner-alist
8249 @vindex gnus-article-address-banner-alist
8252 @cindex stripping advertisements
8253 @cindex advertisements
8254 Strip the banner specified by the @code{banner} group parameter
8255 (@code{gnus-article-strip-banner}). This is mainly used to hide those
8256 annoying banners and/or signatures that some mailing lists and moderated
8257 groups adds to all the messages. The way to use this function is to add
8258 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8259 group you want banners stripped from. The parameter either be a string,
8260 which will be interpreted as a regular expression matching text to be
8261 removed, or the symbol @code{signature}, meaning that the (last)
8262 signature should be removed, or other symbol, meaning that the
8263 corresponding regular expression in @code{gnus-article-banner-alist} is
8266 Regardless of a group, you can hide things like advertisements only when
8267 the sender of an article has a certain mail address specified in
8268 @code{gnus-article-address-banner-alist}.
8272 @item gnus-article-address-banner-alist
8273 @vindex gnus-article-address-banner-alist
8274 Alist of mail addresses and banners. Each element has the form
8275 @code{(@var{address} . @var{banner})}, where @var{address} is a regexp
8276 matching a mail address in the From header, @var{banner} is one of a
8277 symbol @code{signature}, an item in @code{gnus-article-banner-alist},
8278 a regexp and @code{nil}. If @var{address} matches author's mail
8279 address, it will remove things like advertisements. For example, if a
8280 sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a
8281 banner something like @samp{Do You Yoo-hoo!?} in all articles he
8282 sends, you can use the following element to remove them:
8285 ("@@yoo-hoo\\.co\\.jp\\'" .
8286 "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8292 @kindex W W c (Summary)
8293 @findex gnus-article-hide-citation
8294 Hide citation (@code{gnus-article-hide-citation}). Some variables for
8295 customizing the hiding:
8299 @item gnus-cited-opened-text-button-line-format
8300 @itemx gnus-cited-closed-text-button-line-format
8301 @vindex gnus-cited-closed-text-button-line-format
8302 @vindex gnus-cited-opened-text-button-line-format
8303 Gnus adds buttons to show where the cited text has been hidden, and to
8304 allow toggle hiding the text. The format of the variable is specified
8305 by these format-like variable (@pxref{Formatting Variables}). These
8310 Starting point of the hidden text.
8312 Ending point of the hidden text.
8314 Number of characters in the hidden region.
8316 Number of lines of hidden text.
8319 @item gnus-cited-lines-visible
8320 @vindex gnus-cited-lines-visible
8321 The number of lines at the beginning of the cited text to leave
8322 shown. This can also be a cons cell with the number of lines at the top
8323 and bottom of the text, respectively, to remain visible.
8328 @kindex W W C-c (Summary)
8329 @findex gnus-article-hide-citation-maybe
8331 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8332 following two variables:
8335 @item gnus-cite-hide-percentage
8336 @vindex gnus-cite-hide-percentage
8337 If the cited text is of a bigger percentage than this variable (default
8338 50), hide the cited text.
8340 @item gnus-cite-hide-absolute
8341 @vindex gnus-cite-hide-absolute
8342 The cited text must have at least this length (default 10) before it
8347 @kindex W W C (Summary)
8348 @findex gnus-article-hide-citation-in-followups
8349 Hide cited text in articles that aren't roots
8350 (@code{gnus-article-hide-citation-in-followups}). This isn't very
8351 useful as an interactive command, but might be a handy function to stick
8352 have happen automatically (@pxref{Customizing Articles}).
8356 All these ``hiding'' commands are toggles, but if you give a negative
8357 prefix to these commands, they will show what they have previously
8358 hidden. If you give a positive prefix, they will always hide.
8360 Also @pxref{Article Highlighting} for further variables for
8361 citation customization.
8363 @xref{Customizing Articles}, for how to hide article elements
8367 @node Article Washing
8368 @subsection Article Washing
8370 @cindex article washing
8372 We call this ``article washing'' for a really good reason. Namely, the
8373 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8375 @dfn{Washing} is defined by us as ``changing something from something to
8376 something else'', but normally results in something looking better.
8379 @xref{Customizing Articles}, if you want to change how Gnus displays
8380 articles by default.
8385 This is not really washing, it's sort of the opposite of washing. If
8386 you type this, you see the article exactly as it exists on disk or on
8390 Force redisplaying of the current article
8391 (@code{gnus-summary-show-article}). This is also not really washing.
8392 If you type this, you see the article without any previously applied
8393 interactive Washing functions but with all default treatments
8394 (@pxref{Customizing Articles}).
8397 @kindex W l (Summary)
8398 @findex gnus-summary-stop-page-breaking
8399 Remove page breaks from the current article
8400 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
8404 @kindex W r (Summary)
8405 @findex gnus-summary-caesar-message
8406 @c @icon{gnus-summary-caesar-message}
8407 Do a Caesar rotate (rot13) on the article buffer
8408 (@code{gnus-summary-caesar-message}).
8409 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8410 (Typically offensive jokes and such.)
8412 It's commonly called ``rot13'' because each letter is rotated 13
8413 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
8414 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
8415 is rumored to have employed this form of, uh, somewhat weak encryption.
8418 @kindex W m (Summary)
8419 @findex gnus-summary-morse-message
8420 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8424 @kindex W t (Summary)
8426 @findex gnus-summary-toggle-header
8427 Toggle whether to display all headers in the article buffer
8428 (@code{gnus-summary-toggle-header}).
8431 @kindex W v (Summary)
8432 @findex gnus-summary-verbose-headers
8433 Toggle whether to display all headers in the article buffer permanently
8434 (@code{gnus-summary-verbose-headers}).
8437 @kindex W m (Summary)
8438 @findex gnus-summary-toggle-mime
8439 Toggle whether to run the article through @acronym{MIME} before
8440 displaying (@code{gnus-summary-toggle-mime}).
8443 @kindex W o (Summary)
8444 @findex gnus-article-treat-overstrike
8445 Treat overstrike (@code{gnus-article-treat-overstrike}).
8448 @kindex W d (Summary)
8449 @findex gnus-article-treat-dumbquotes
8450 @vindex gnus-article-dumbquotes-map
8452 @cindex M****s*** sm*rtq**t*s
8454 Treat M****s*** sm*rtq**t*s according to
8455 @code{gnus-article-dumbquotes-map}
8456 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
8457 whether a character is a sm*rtq**t* or not, so it should only be used
8460 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
8461 an attempt to provide more quoting characters. If you see something
8462 like @code{\222} or @code{\264} where you're expecting some kind of
8463 apostrophe or quotation mark, then try this wash.
8466 @kindex W Y f (Summary)
8467 @findex gnus-article-outlook-deuglify-article
8468 @cindex Outlook Express
8469 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
8470 unwrap lines, repair attribution and rearrange citation.
8471 (@code{gnus-article-outlook-deuglify-article}).
8474 @kindex W Y u (Summary)
8475 @findex gnus-article-outlook-unwrap-lines
8476 @vindex gnus-outlook-deuglify-unwrap-min
8477 @vindex gnus-outlook-deuglify-unwrap-max
8478 Unwrap lines that appear to be wrapped citation lines. You can control
8479 what lines will be unwrapped by frobbing
8480 @code{gnus-outlook-deuglify-unwrap-min} and
8481 @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and
8482 maximum length of an unwrapped citation line.
8483 (@code{gnus-article-outlook-unwrap-lines}).
8486 @kindex W Y a (Summary)
8487 @findex gnus-article-outlook-repair-attribution
8488 Repair a broken attribution line.@*
8489 (@code{gnus-article-outlook-repair-attribution}).
8492 @kindex W Y c (Summary)
8493 @findex gnus-article-outlook-rearrange-citation
8494 Repair broken citations by rearranging the text.
8495 (@code{gnus-article-outlook-rearrange-citation}).
8498 @kindex W w (Summary)
8499 @findex gnus-article-fill-cited-article
8500 Do word wrap (@code{gnus-article-fill-cited-article}).
8502 You can give the command a numerical prefix to specify the width to use
8506 @kindex W Q (Summary)
8507 @findex gnus-article-fill-long-lines
8508 Fill long lines (@code{gnus-article-fill-long-lines}).
8511 @kindex W C (Summary)
8512 @findex gnus-article-capitalize-sentences
8513 Capitalize the first word in each sentence
8514 (@code{gnus-article-capitalize-sentences}).
8517 @kindex W c (Summary)
8518 @findex gnus-article-remove-cr
8519 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
8520 (this takes care of DOS line endings), and then translate any remaining
8521 CRs into LF (this takes care of Mac line endings)
8522 (@code{gnus-article-remove-cr}).
8524 @kindex W q (Summary)
8525 @findex gnus-article-de-quoted-unreadable
8526 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
8527 Quoted-Printable is one common @acronym{MIME} encoding employed when
8528 sending non-@acronym{ASCII} (i.e., 8-bit) articles. It typically
8529 makes strings like @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which
8530 doesn't look very readable to me. Note that this is usually done
8531 automatically by Gnus if the message in question has a
8532 @code{Content-Transfer-Encoding} header that says that this encoding
8533 has been done. If a prefix is given, a charset will be asked for.
8536 @kindex W 6 (Summary)
8537 @findex gnus-article-de-base64-unreadable
8538 Treat base64 (@code{gnus-article-de-base64-unreadable}). Base64 is
8539 one common @acronym{MIME} encoding employed when sending
8540 non-@acronym{ASCII} (i.e., 8-bit) articles. Note that this is
8541 usually done automatically by Gnus if the message in question has a
8542 @code{Content-Transfer-Encoding} header that says that this encoding
8543 has been done. If a prefix is given, a charset will be asked for.
8546 @kindex W Z (Summary)
8547 @findex gnus-article-decode-HZ
8548 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
8549 common encoding employed when sending Chinese articles. It typically
8550 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
8553 @kindex W u (Summary)
8554 @findex gnus-article-unsplit-urls
8555 Remove newlines from within URLs. Some mailers insert newlines into
8556 outgoing email messages to keep lines short. This reformatting can
8557 split long URLs onto multiple lines. Repair those URLs by removing
8558 the newlines (@code{gnus-article-unsplit-urls}).
8561 @kindex W h (Summary)
8562 @findex gnus-article-wash-html
8563 Treat @acronym{HTML} (@code{gnus-article-wash-html}). Note that this is
8564 usually done automatically by Gnus if the message in question has a
8565 @code{Content-Type} header that says that the message is @acronym{HTML}.
8567 If a prefix is given, a charset will be asked for.
8569 @vindex gnus-article-wash-function
8570 The default is to use the function specified by
8571 @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
8572 Customization, emacs-mime, The Emacs MIME Manual}) to convert the
8573 @acronym{HTML}, but this is controlled by the
8574 @code{gnus-article-wash-function} variable. Pre-defined functions you
8582 Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
8585 Use @uref{http://links.sf.net/, Links}.
8588 Use @uref{http://lynx.isc.org/, Lynx}.
8591 Use html2text---a simple @acronym{HTML} converter included with Gnus.
8596 @kindex W b (Summary)
8597 @findex gnus-article-add-buttons
8598 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
8599 @xref{Article Buttons}.
8602 @kindex W B (Summary)
8603 @findex gnus-article-add-buttons-to-head
8604 Add clickable buttons to the article headers
8605 (@code{gnus-article-add-buttons-to-head}).
8608 @kindex W p (Summary)
8609 @findex gnus-article-verify-x-pgp-sig
8610 Verify a signed control message
8611 (@code{gnus-article-verify-x-pgp-sig}). Control messages such as
8612 @code{newgroup} and @code{checkgroups} are usually signed by the
8613 hierarchy maintainer. You need to add the @acronym{PGP} public key of
8614 the maintainer to your keyring to verify the
8615 message.@footnote{@acronym{PGP} keys for many hierarchies are
8616 available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
8619 @kindex W s (Summary)
8620 @findex gnus-summary-force-verify-and-decrypt
8621 Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or
8622 @acronym{S/MIME}) message
8623 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
8626 @kindex W a (Summary)
8627 @findex gnus-article-strip-headers-in-body
8628 Strip headers like the @code{X-No-Archive} header from the beginning of
8629 article bodies (@code{gnus-article-strip-headers-in-body}).
8632 @kindex W E l (Summary)
8633 @findex gnus-article-strip-leading-blank-lines
8634 Remove all blank lines from the beginning of the article
8635 (@code{gnus-article-strip-leading-blank-lines}).
8638 @kindex W E m (Summary)
8639 @findex gnus-article-strip-multiple-blank-lines
8640 Replace all blank lines with empty lines and then all multiple empty
8641 lines with a single empty line.
8642 (@code{gnus-article-strip-multiple-blank-lines}).
8645 @kindex W E t (Summary)
8646 @findex gnus-article-remove-trailing-blank-lines
8647 Remove all blank lines at the end of the article
8648 (@code{gnus-article-remove-trailing-blank-lines}).
8651 @kindex W E a (Summary)
8652 @findex gnus-article-strip-blank-lines
8653 Do all the three commands above
8654 (@code{gnus-article-strip-blank-lines}).
8657 @kindex W E A (Summary)
8658 @findex gnus-article-strip-all-blank-lines
8659 Remove all blank lines
8660 (@code{gnus-article-strip-all-blank-lines}).
8663 @kindex W E s (Summary)
8664 @findex gnus-article-strip-leading-space
8665 Remove all white space from the beginning of all lines of the article
8666 body (@code{gnus-article-strip-leading-space}).
8669 @kindex W E e (Summary)
8670 @findex gnus-article-strip-trailing-space
8671 Remove all white space from the end of all lines of the article
8672 body (@code{gnus-article-strip-trailing-space}).
8676 @xref{Customizing Articles}, for how to wash articles automatically.
8679 @node Article Header
8680 @subsection Article Header
8682 These commands perform various transformations of article header.
8687 @kindex W G u (Summary)
8688 @findex gnus-article-treat-unfold-headers
8689 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
8692 @kindex W G n (Summary)
8693 @findex gnus-article-treat-fold-newsgroups
8694 Fold the @code{Newsgroups} and @code{Followup-To} headers
8695 (@code{gnus-article-treat-fold-newsgroups}).
8698 @kindex W G f (Summary)
8699 @findex gnus-article-treat-fold-headers
8700 Fold all the message headers
8701 (@code{gnus-article-treat-fold-headers}).
8704 @kindex W E w (Summary)
8705 @findex gnus-article-remove-leading-whitespace
8706 Remove excessive whitespace from all headers
8707 (@code{gnus-article-remove-leading-whitespace}).
8712 @node Article Buttons
8713 @subsection Article Buttons
8716 People often include references to other stuff in articles, and it would
8717 be nice if Gnus could just fetch whatever it is that people talk about
8718 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
8719 button on these references.
8721 @vindex gnus-button-man-handler
8722 Gnus adds @dfn{buttons} to certain standard references by default:
8723 Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and
8724 Emacs or Gnus related references. This is controlled by two variables,
8725 one that handles article bodies and one that handles article heads:
8729 @item gnus-button-alist
8730 @vindex gnus-button-alist
8731 This is an alist where each entry has this form:
8734 (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8740 All text that match this regular expression (case insensitive) will be
8741 considered an external reference. Here's a typical regexp that matches
8742 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}. This can also be a
8743 variable containing a regexp, useful variables to use include
8744 @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}.
8747 Gnus has to know which parts of the matches is to be highlighted. This
8748 is a number that says what sub-expression of the regexp is to be
8749 highlighted. If you want it all highlighted, you use 0 here.
8752 This form will be @code{eval}ed, and if the result is non-@code{nil},
8753 this is considered a match. This is useful if you want extra sifting to
8754 avoid false matches. Often variables named
8755 @code{gnus-button-@var{*}-level} are used here, @xref{Article Button
8756 Levels}, but any other form may be used too.
8758 @c @code{use-p} is @code{eval}ed only if @code{regexp} matches.
8761 This function will be called when you click on this button.
8764 As with @var{button-par}, this is a sub-expression number, but this one
8765 says which part of the match is to be sent as data to @var{function}.
8769 So the full entry for buttonizing URLs is then
8772 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
8775 @item gnus-header-button-alist
8776 @vindex gnus-header-button-alist
8777 This is just like the other alist, except that it is applied to the
8778 article head only, and that each entry has an additional element that is
8779 used to say what headers to apply the buttonize coding to:
8782 (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8785 @var{header} is a regular expression.
8788 @subsubsection Related variables and functions
8791 @item gnus-button-@var{*}-level
8792 @xref{Article Button Levels}.
8794 @c Stuff related to gnus-button-browse-level
8796 @item gnus-button-url-regexp
8797 @vindex gnus-button-url-regexp
8798 A regular expression that matches embedded URLs. It is used in the
8799 default values of the variables above.
8801 @c Stuff related to gnus-button-man-level
8803 @item gnus-button-man-handler
8804 @vindex gnus-button-man-handler
8805 The function to use for displaying man pages. It must take at least one
8806 argument with a string naming the man page.
8808 @c Stuff related to gnus-button-message-level
8810 @item gnus-button-mid-or-mail-regexp
8811 @vindex gnus-button-mid-or-mail-regexp
8812 Regular expression that matches a message ID or a mail address.
8814 @item gnus-button-prefer-mid-or-mail
8815 @vindex gnus-button-prefer-mid-or-mail
8816 This variable determines what to do when the button on a string as
8817 @samp{foo123@@bar.invalid} is pushed. Strings like this can be either a
8818 message ID or a mail address. If it is one of the symbols @code{mid} or
8819 @code{mail}, Gnus will always assume that the string is a message ID or
8820 a mail address, respectively. If this variable is set to the symbol
8821 @code{ask}, always query the user what do do. If it is a function, this
8822 function will be called with the string as its only argument. The
8823 function must return @code{mid}, @code{mail}, @code{invalid} or
8824 @code{ask}. The default value is the function
8825 @code{gnus-button-mid-or-mail-heuristic}.
8827 @item gnus-button-mid-or-mail-heuristic
8828 @findex gnus-button-mid-or-mail-heuristic
8829 Function that guesses whether its argument is a message ID or a mail
8830 address. Returns @code{mid} if it's a message IDs, @code{mail} if
8831 it's a mail address, @code{ask} if unsure and @code{invalid} if the
8834 @item gnus-button-mid-or-mail-heuristic-alist
8835 @vindex gnus-button-mid-or-mail-heuristic-alist
8836 An alist of @code{(RATE . REGEXP)} pairs used by the function
8837 @code{gnus-button-mid-or-mail-heuristic}.
8839 @c Stuff related to gnus-button-tex-level
8841 @item gnus-button-ctan-handler
8842 @findex gnus-button-ctan-handler
8843 The function to use for displaying CTAN links. It must take one
8844 argument, the string naming the URL.
8847 @vindex gnus-ctan-url
8848 Top directory of a CTAN (Comprehensive TeX Archive Network) archive used
8849 by @code{gnus-button-ctan-handler}.
8853 @item gnus-article-button-face
8854 @vindex gnus-article-button-face
8855 Face used on buttons.
8857 @item gnus-article-mouse-face
8858 @vindex gnus-article-mouse-face
8859 Face used when the mouse cursor is over a button.
8863 @xref{Customizing Articles}, for how to buttonize articles automatically.
8866 @node Article Button Levels
8867 @subsection Article button levels
8868 @cindex button levels
8869 The higher the value of the variables @code{gnus-button-@var{*}-level},
8870 the more buttons will appear. If the level is zero, no corresponding
8871 buttons are displayed. With the default value (which is 5) you should
8872 already see quite a lot of buttons. With higher levels, you will see
8873 more buttons, but you may also get more false positives. To avoid them,
8874 you can set the variables @code{gnus-button-@var{*}-level} local to
8875 specific groups (@pxref{Group Parameters}). Here's an example for the
8876 variable @code{gnus-parameters}:
8879 ;; @r{increase @code{gnus-button-*-level} in some groups:}
8880 (setq gnus-parameters
8881 '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10))
8882 ("\\<unix\\>" (gnus-button-man-level 10))
8883 ("\\<tex\\>" (gnus-button-tex-level 10))))
8888 @item gnus-button-browse-level
8889 @vindex gnus-button-browse-level
8890 Controls the display of references to message IDs, mail addresses and
8891 news URLs. Related variables and functions include
8892 @code{gnus-button-url-regexp}, @code{browse-url}, and
8893 @code{browse-url-browser-function}.
8895 @item gnus-button-emacs-level
8896 @vindex gnus-button-emacs-level
8897 Controls the display of Emacs or Gnus references. Related functions are
8898 @code{gnus-button-handle-custom},
8899 @code{gnus-button-handle-describe-function},
8900 @code{gnus-button-handle-describe-variable},
8901 @code{gnus-button-handle-symbol},
8902 @code{gnus-button-handle-describe-key},
8903 @code{gnus-button-handle-apropos},
8904 @code{gnus-button-handle-apropos-command},
8905 @code{gnus-button-handle-apropos-variable},
8906 @code{gnus-button-handle-apropos-documentation}, and
8907 @code{gnus-button-handle-library}.
8909 @item gnus-button-man-level
8910 @vindex gnus-button-man-level
8911 Controls the display of references to (Unix) man pages.
8912 See @code{gnus-button-man-handler}.
8914 @item gnus-button-message-level
8915 @vindex gnus-button-message-level
8916 Controls the display of message IDs, mail addresses and news URLs.
8917 Related variables and functions include
8918 @code{gnus-button-mid-or-mail-regexp},
8919 @code{gnus-button-prefer-mid-or-mail},
8920 @code{gnus-button-mid-or-mail-heuristic}, and
8921 @code{gnus-button-mid-or-mail-heuristic-alist}.
8923 @item gnus-button-tex-level
8924 @vindex gnus-button-tex-level
8925 Controls the display of references to @TeX{} or LaTeX stuff, e.g. for CTAN
8926 URLs. See the variables @code{gnus-ctan-url},
8927 @code{gnus-button-ctan-handler},
8928 @code{gnus-button-ctan-directory-regexp}, and
8929 @code{gnus-button-handle-ctan-bogus-regexp}.
8935 @subsection Article Date
8937 The date is most likely generated in some obscure timezone you've never
8938 heard of, so it's quite nice to be able to find out what the time was
8939 when the article was sent.
8944 @kindex W T u (Summary)
8945 @findex gnus-article-date-ut
8946 Display the date in UT (aka. GMT, aka ZULU)
8947 (@code{gnus-article-date-ut}).
8950 @kindex W T i (Summary)
8951 @findex gnus-article-date-iso8601
8953 Display the date in international format, aka. ISO 8601
8954 (@code{gnus-article-date-iso8601}).
8957 @kindex W T l (Summary)
8958 @findex gnus-article-date-local
8959 Display the date in the local timezone (@code{gnus-article-date-local}).
8962 @kindex W T p (Summary)
8963 @findex gnus-article-date-english
8964 Display the date in a format that's easily pronounceable in English
8965 (@code{gnus-article-date-english}).
8968 @kindex W T s (Summary)
8969 @vindex gnus-article-time-format
8970 @findex gnus-article-date-user
8971 @findex format-time-string
8972 Display the date using a user-defined format
8973 (@code{gnus-article-date-user}). The format is specified by the
8974 @code{gnus-article-time-format} variable, and is a string that's passed
8975 to @code{format-time-string}. See the documentation of that variable
8976 for a list of possible format specs.
8979 @kindex W T e (Summary)
8980 @findex gnus-article-date-lapsed
8981 @findex gnus-start-date-timer
8982 @findex gnus-stop-date-timer
8983 Say how much time has elapsed between the article was posted and now
8984 (@code{gnus-article-date-lapsed}). It looks something like:
8987 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
8990 @vindex gnus-article-date-lapsed-new-header
8991 The value of @code{gnus-article-date-lapsed-new-header} determines
8992 whether this header will just be added below the old Date one, or will
8995 An advantage of using Gnus to read mail is that it converts simple bugs
8996 into wonderful absurdities.
8998 If you want to have this line updated continually, you can put
9001 (gnus-start-date-timer)
9004 in your @file{~/.gnus.el} file, or you can run it off of some hook. If
9005 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
9009 @kindex W T o (Summary)
9010 @findex gnus-article-date-original
9011 Display the original date (@code{gnus-article-date-original}). This can
9012 be useful if you normally use some other conversion function and are
9013 worried that it might be doing something totally wrong. Say, claiming
9014 that the article was posted in 1854. Although something like that is
9015 @emph{totally} impossible. Don't you trust me? *titter*
9019 @xref{Customizing Articles}, for how to display the date in your
9020 preferred format automatically.
9023 @node Article Display
9024 @subsection Article Display
9029 These commands add various frivolous display gimmicks to the article
9030 buffer in Emacs versions that support them.
9032 @code{X-Face} headers are small black-and-white images supplied by the
9033 message headers (@pxref{X-Face}).
9035 @code{Face} headers are small colored images supplied by the message
9036 headers (@pxref{Face}).
9038 Smileys are those little @samp{:-)} symbols that people like to litter
9039 their messages with (@pxref{Smileys}).
9041 Picons, on the other hand, reside on your own system, and Gnus will
9042 try to match the headers to what you have (@pxref{Picons}).
9044 All these functions are toggles---if the elements already exist,
9049 @kindex W D x (Summary)
9050 @findex gnus-article-display-x-face
9051 Display an @code{X-Face} in the @code{From} header.
9052 (@code{gnus-article-display-x-face}).
9055 @kindex W D d (Summary)
9056 @findex gnus-article-display-face
9057 Display a @code{Face} in the @code{From} header.
9058 (@code{gnus-article-display-face}).
9061 @kindex W D s (Summary)
9062 @findex gnus-treat-smiley
9063 Display smileys (@code{gnus-treat-smiley}).
9066 @kindex W D f (Summary)
9067 @findex gnus-treat-from-picon
9068 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
9071 @kindex W D m (Summary)
9072 @findex gnus-treat-mail-picon
9073 Piconify all mail headers (i. e., @code{Cc}, @code{To})
9074 (@code{gnus-treat-mail-picon}).
9077 @kindex W D n (Summary)
9078 @findex gnus-treat-newsgroups-picon
9079 Piconify all news headers (i. e., @code{Newsgroups} and
9080 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
9083 @kindex W D D (Summary)
9084 @findex gnus-article-remove-images
9085 Remove all images from the article buffer
9086 (@code{gnus-article-remove-images}).
9092 @node Article Signature
9093 @subsection Article Signature
9095 @cindex article signature
9097 @vindex gnus-signature-separator
9098 Each article is divided into two parts---the head and the body. The
9099 body can be divided into a signature part and a text part. The variable
9100 that says what is to be considered a signature is
9101 @code{gnus-signature-separator}. This is normally the standard
9102 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
9103 non-standard signature separators, so this variable can also be a list
9104 of regular expressions to be tested, one by one. (Searches are done
9105 from the end of the body towards the beginning.) One likely value is:
9108 (setq gnus-signature-separator
9109 '("^-- $" ; @r{The standard}
9110 "^-- *$" ; @r{A common mangling}
9111 "^-------*$" ; @r{Many people just use a looong}
9112 ; @r{line of dashes. Shame!}
9113 "^ *--------*$" ; @r{Double-shame!}
9114 "^________*$" ; @r{Underscores are also popular}
9115 "^========*$")) ; @r{Pervert!}
9118 The more permissive you are, the more likely it is that you'll get false
9121 @vindex gnus-signature-limit
9122 @code{gnus-signature-limit} provides a limit to what is considered a
9123 signature when displaying articles.
9127 If it is an integer, no signature may be longer (in characters) than
9130 If it is a floating point number, no signature may be longer (in lines)
9133 If it is a function, the function will be called without any parameters,
9134 and if it returns @code{nil}, there is no signature in the buffer.
9136 If it is a string, it will be used as a regexp. If it matches, the text
9137 in question is not a signature.
9140 This variable can also be a list where the elements may be of the types
9141 listed above. Here's an example:
9144 (setq gnus-signature-limit
9145 '(200.0 "^---*Forwarded article"))
9148 This means that if there are more than 200 lines after the signature
9149 separator, or the text after the signature separator is matched by
9150 the regular expression @samp{^---*Forwarded article}, then it isn't a
9151 signature after all.
9154 @node Article Miscellanea
9155 @subsection Article Miscellanea
9159 @kindex A t (Summary)
9160 @findex gnus-article-babel
9161 Translate the article from one language to another
9162 (@code{gnus-article-babel}).
9168 @section MIME Commands
9169 @cindex MIME decoding
9171 @cindex viewing attachments
9173 The following commands all understand the numerical prefix. For
9174 instance, @kbd{3 b} means ``view the third @acronym{MIME} part''.
9180 @kindex K v (Summary)
9181 View the @acronym{MIME} part.
9184 @kindex K o (Summary)
9185 Save the @acronym{MIME} part.
9188 @kindex K c (Summary)
9189 Copy the @acronym{MIME} part.
9192 @kindex K e (Summary)
9193 View the @acronym{MIME} part externally.
9196 @kindex K i (Summary)
9197 View the @acronym{MIME} part internally.
9200 @kindex K | (Summary)
9201 Pipe the @acronym{MIME} part to an external command.
9204 The rest of these @acronym{MIME} commands do not use the numerical prefix in
9209 @kindex K b (Summary)
9210 Make all the @acronym{MIME} parts have buttons in front of them. This is
9211 mostly useful if you wish to save (or perform other actions) on inlined
9215 @kindex K m (Summary)
9216 @findex gnus-summary-repair-multipart
9217 Some multipart messages are transmitted with missing or faulty headers.
9218 This command will attempt to ``repair'' these messages so that they can
9219 be viewed in a more pleasant manner
9220 (@code{gnus-summary-repair-multipart}).
9223 @kindex X m (Summary)
9224 @findex gnus-summary-save-parts
9225 Save all parts matching a @acronym{MIME} type to a directory
9226 (@code{gnus-summary-save-parts}). Understands the process/prefix
9227 convention (@pxref{Process/Prefix}).
9230 @kindex M-t (Summary)
9231 @findex gnus-summary-toggle-display-buttonized
9232 Toggle the buttonized display of the article buffer
9233 (@code{gnus-summary-toggle-display-buttonized}).
9236 @kindex W M w (Summary)
9237 @findex gnus-article-decode-mime-words
9238 Decode RFC 2047-encoded words in the article headers
9239 (@code{gnus-article-decode-mime-words}).
9242 @kindex W M c (Summary)
9243 @findex gnus-article-decode-charset
9244 Decode encoded article bodies as well as charsets
9245 (@code{gnus-article-decode-charset}).
9247 This command looks in the @code{Content-Type} header to determine the
9248 charset. If there is no such header in the article, you can give it a
9249 prefix, which will prompt for the charset to decode as. In regional
9250 groups where people post using some common encoding (but do not
9251 include @acronym{MIME} headers), you can set the @code{charset} group/topic
9252 parameter to the required charset (@pxref{Group Parameters}).
9255 @kindex W M v (Summary)
9256 @findex gnus-mime-view-all-parts
9257 View all the @acronym{MIME} parts in the current article
9258 (@code{gnus-mime-view-all-parts}).
9265 @item gnus-ignored-mime-types
9266 @vindex gnus-ignored-mime-types
9267 This is a list of regexps. @acronym{MIME} types that match a regexp from
9268 this list will be completely ignored by Gnus. The default value is
9271 To have all Vcards be ignored, you'd say something like this:
9274 (setq gnus-ignored-mime-types
9278 @item gnus-article-loose-mime
9279 @vindex gnus-article-loose-mime
9280 If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header
9281 before interpreting the message as a @acronym{MIME} message. This helps
9282 when reading messages from certain broken mail user agents. The
9283 default is @code{nil}.
9285 @item gnus-article-emulate-mime
9286 @vindex gnus-article-emulate-mime
9287 There are other, non-@acronym{MIME} encoding methods used. The most common
9288 is @samp{uuencode}, but yEncode is also getting to be popular. If
9289 this variable is non-@code{nil}, Gnus will look in message bodies to
9290 see if it finds these encodings, and if so, it'll run them through the
9291 Gnus @acronym{MIME} machinery. The default is @code{t}.
9293 @item gnus-unbuttonized-mime-types
9294 @vindex gnus-unbuttonized-mime-types
9295 This is a list of regexps. @acronym{MIME} types that match a regexp from
9296 this list won't have @acronym{MIME} buttons inserted unless they aren't
9297 displayed or this variable is overridden by
9298 @code{gnus-buttonized-mime-types}. The default value is
9299 @code{(".*/.*")}. This variable is only used when
9300 @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}.
9302 @item gnus-buttonized-mime-types
9303 @vindex gnus-buttonized-mime-types
9304 This is a list of regexps. @acronym{MIME} types that match a regexp from
9305 this list will have @acronym{MIME} buttons inserted unless they aren't
9306 displayed. This variable overrides
9307 @code{gnus-unbuttonized-mime-types}. The default value is @code{nil}.
9308 This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
9311 To see e.g. security buttons but no other buttons, you could set this
9312 variable to @code{("multipart/signed")} and leave
9313 @code{gnus-unbuttonized-mime-types} at the default value.
9315 @item gnus-inhibit-mime-unbuttonizing
9316 @vindex gnus-inhibit-mime-unbuttonizing
9317 If this is non-@code{nil}, then all @acronym{MIME} parts get buttons. The
9318 default value is @code{nil}.
9320 @item gnus-article-mime-part-function
9321 @vindex gnus-article-mime-part-function
9322 For each @acronym{MIME} part, this function will be called with the @acronym{MIME}
9323 handle as the parameter. The function is meant to be used to allow
9324 users to gather information from the article (e. g., add Vcard info to
9325 the bbdb database) or to do actions based on parts (e. g., automatically
9326 save all jpegs into some directory).
9328 Here's an example function the does the latter:
9331 (defun my-save-all-jpeg-parts (handle)
9332 (when (equal (car (mm-handle-type handle)) "image/jpeg")
9334 (insert (mm-get-part handle))
9335 (write-region (point-min) (point-max)
9336 (read-file-name "Save jpeg to: ")))))
9337 (setq gnus-article-mime-part-function
9338 'my-save-all-jpeg-parts)
9341 @vindex gnus-mime-multipart-functions
9342 @item gnus-mime-multipart-functions
9343 Alist of @acronym{MIME} multipart types and functions to handle them.
9345 @vindex mm-file-name-rewrite-functions
9346 @item mm-file-name-rewrite-functions
9347 List of functions used for rewriting file names of @acronym{MIME} parts.
9348 Each function takes a file name as input and returns a file name.
9350 Ready-made functions include@*
9351 @code{mm-file-name-delete-whitespace},
9352 @code{mm-file-name-trim-whitespace},
9353 @code{mm-file-name-collapse-whitespace}, and
9354 @code{mm-file-name-replace-whitespace}. The later uses the value of
9355 the variable @code{mm-file-name-replace-whitespace} to replace each
9356 whitespace character in a file name with that string; default value
9357 is @code{"_"} (a single underscore).
9358 @findex mm-file-name-delete-whitespace
9359 @findex mm-file-name-trim-whitespace
9360 @findex mm-file-name-collapse-whitespace
9361 @findex mm-file-name-replace-whitespace
9362 @vindex mm-file-name-replace-whitespace
9364 The standard functions @code{capitalize}, @code{downcase},
9365 @code{upcase}, and @code{upcase-initials} may be useful, too.
9367 Everybody knows that whitespace characters in file names are evil,
9368 except those who don't know. If you receive lots of attachments from
9369 such unenlightened users, you can make live easier by adding
9372 (setq mm-file-name-rewrite-functions
9373 '(mm-file-name-trim-whitespace
9374 mm-file-name-collapse-whitespace
9375 mm-file-name-replace-whitespace))
9379 to your @file{~/.gnus.el} file.
9388 People use different charsets, and we have @acronym{MIME} to let us know what
9389 charsets they use. Or rather, we wish we had. Many people use
9390 newsreaders and mailers that do not understand or use @acronym{MIME}, and
9391 just send out messages without saying what character sets they use. To
9392 help a bit with this, some local news hierarchies have policies that say
9393 what character set is the default. For instance, the @samp{fj}
9394 hierarchy uses @code{iso-2022-jp-2}.
9396 @vindex gnus-group-charset-alist
9397 This knowledge is encoded in the @code{gnus-group-charset-alist}
9398 variable, which is an alist of regexps (use the first item to match full
9399 group names) and default charsets to be used when reading these groups.
9401 @vindex gnus-newsgroup-ignored-charsets
9402 In addition, some people do use soi-disant @acronym{MIME}-aware agents that
9403 aren't. These blithely mark messages as being in @code{iso-8859-1}
9404 even if they really are in @code{koi-8}. To help here, the
9405 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
9406 charsets that are listed here will be ignored. The variable can be
9407 set on a group-by-group basis using the group parameters (@pxref{Group
9408 Parameters}). The default value is @code{(unknown-8bit x-unknown)},
9409 which includes values some agents insist on having in there.
9411 @vindex gnus-group-posting-charset-alist
9412 When posting, @code{gnus-group-posting-charset-alist} is used to
9413 determine which charsets should not be encoded using the @acronym{MIME}
9414 encodings. For instance, some hierarchies discourage using
9415 quoted-printable header encoding.
9417 This variable is an alist of regexps and permitted unencoded charsets
9418 for posting. Each element of the alist has the form @code{(}@var{test
9419 header body-list}@code{)}, where:
9423 is either a regular expression matching the newsgroup header or a
9426 is the charset which may be left unencoded in the header (@code{nil}
9427 means encode all charsets),
9429 is a list of charsets which may be encoded using 8bit content-transfer
9430 encoding in the body, or one of the special values @code{nil} (always
9431 encode using quoted-printable) or @code{t} (always use 8bit).
9438 @cindex coding system aliases
9439 @cindex preferred charset
9441 Other charset tricks that may be useful, although not Gnus-specific:
9443 If there are several @acronym{MIME} charsets that encode the same Emacs
9444 charset, you can choose what charset to use by saying the following:
9447 (put-charset-property 'cyrillic-iso8859-5
9448 'preferred-coding-system 'koi8-r)
9451 This means that Russian will be encoded using @code{koi8-r} instead of
9452 the default @code{iso-8859-5} @acronym{MIME} charset.
9454 If you want to read messages in @code{koi8-u}, you can cheat and say
9457 (define-coding-system-alias 'koi8-u 'koi8-r)
9460 This will almost do the right thing.
9462 And finally, to read charsets like @code{windows-1251}, you can say
9466 (codepage-setup 1251)
9467 (define-coding-system-alias 'windows-1251 'cp1251)
9471 @node Article Commands
9472 @section Article Commands
9479 @kindex A P (Summary)
9480 @vindex gnus-ps-print-hook
9481 @findex gnus-summary-print-article
9482 Generate and print a PostScript image of the article buffer
9483 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will
9484 be run just before printing the buffer. An alternative way to print
9485 article is to use Muttprint (@pxref{Saving Articles}).
9490 @node Summary Sorting
9491 @section Summary Sorting
9492 @cindex summary sorting
9494 You can have the summary buffer sorted in various ways, even though I
9495 can't really see why you'd want that.
9500 @kindex C-c C-s C-n (Summary)
9501 @findex gnus-summary-sort-by-number
9502 Sort by article number (@code{gnus-summary-sort-by-number}).
9505 @kindex C-c C-s C-a (Summary)
9506 @findex gnus-summary-sort-by-author
9507 Sort by author (@code{gnus-summary-sort-by-author}).
9510 @kindex C-c C-s C-s (Summary)
9511 @findex gnus-summary-sort-by-subject
9512 Sort by subject (@code{gnus-summary-sort-by-subject}).
9515 @kindex C-c C-s C-d (Summary)
9516 @findex gnus-summary-sort-by-date
9517 Sort by date (@code{gnus-summary-sort-by-date}).
9520 @kindex C-c C-s C-l (Summary)
9521 @findex gnus-summary-sort-by-lines
9522 Sort by lines (@code{gnus-summary-sort-by-lines}).
9525 @kindex C-c C-s C-c (Summary)
9526 @findex gnus-summary-sort-by-chars
9527 Sort by article length (@code{gnus-summary-sort-by-chars}).
9530 @kindex C-c C-s C-i (Summary)
9531 @findex gnus-summary-sort-by-score
9532 Sort by score (@code{gnus-summary-sort-by-score}).
9535 @kindex C-c C-s C-r (Summary)
9536 @findex gnus-summary-sort-by-random
9537 Randomize (@code{gnus-summary-sort-by-random}).
9540 @kindex C-c C-s C-o (Summary)
9541 @findex gnus-summary-sort-by-original
9542 Sort using the default sorting method
9543 (@code{gnus-summary-sort-by-original}).
9546 These functions will work both when you use threading and when you don't
9547 use threading. In the latter case, all summary lines will be sorted,
9548 line by line. In the former case, sorting will be done on a
9549 root-by-root basis, which might not be what you were looking for. To
9550 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
9554 @node Finding the Parent
9555 @section Finding the Parent
9556 @cindex parent articles
9557 @cindex referring articles
9562 @findex gnus-summary-refer-parent-article
9563 If you'd like to read the parent of the current article, and it is not
9564 displayed in the summary buffer, you might still be able to. That is,
9565 if the current group is fetched by @acronym{NNTP}, the parent hasn't expired
9566 and the @code{References} in the current article are not mangled, you
9567 can just press @kbd{^} or @kbd{A r}
9568 (@code{gnus-summary-refer-parent-article}). If everything goes well,
9569 you'll get the parent. If the parent is already displayed in the
9570 summary buffer, point will just move to this article.
9572 If given a positive numerical prefix, fetch that many articles back into
9573 the ancestry. If given a negative numerical prefix, fetch just that
9574 ancestor. So if you say @kbd{3 ^}, gnus will fetch the parent, the
9575 grandparent and the grandgrandparent of the current article. If you say
9576 @kbd{-3 ^}, gnus will only fetch the grandgrandparent of the current
9580 @findex gnus-summary-refer-references
9581 @kindex A R (Summary)
9582 Fetch all articles mentioned in the @code{References} header of the
9583 article (@code{gnus-summary-refer-references}).
9586 @findex gnus-summary-refer-thread
9587 @kindex A T (Summary)
9588 Display the full thread where the current article appears
9589 (@code{gnus-summary-refer-thread}). This command has to fetch all the
9590 headers in the current group to work, so it usually takes a while. If
9591 you do it often, you may consider setting @code{gnus-fetch-old-headers}
9592 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
9593 visible effects normally, but it'll make this command work a whole lot
9594 faster. Of course, it'll make group entry somewhat slow.
9596 @vindex gnus-refer-thread-limit
9597 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
9598 articles before the first displayed in the current group) headers to
9599 fetch when doing this command. The default is 200. If @code{t}, all
9600 the available headers will be fetched. This variable can be overridden
9601 by giving the @kbd{A T} command a numerical prefix.
9604 @findex gnus-summary-refer-article
9605 @kindex M-^ (Summary)
9607 @cindex fetching by Message-ID
9608 You can also ask the @acronym{NNTP} server for an arbitrary article, no
9609 matter what group it belongs to. @kbd{M-^}
9610 (@code{gnus-summary-refer-article}) will ask you for a
9611 @code{Message-ID}, which is one of those long, hard-to-read thingies
9612 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
9613 have to get it all exactly right. No fuzzy searches, I'm afraid.
9616 The current select method will be used when fetching by
9617 @code{Message-ID} from non-news select method, but you can override this
9618 by giving this command a prefix.
9620 @vindex gnus-refer-article-method
9621 If the group you are reading is located on a back end that does not
9622 support fetching by @code{Message-ID} very well (like @code{nnspool}),
9623 you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method. It
9624 would, perhaps, be best if the @acronym{NNTP} server you consult is the one
9625 updating the spool you are reading from, but that's not really
9628 It can also be a list of select methods, as well as the special symbol
9629 @code{current}, which means to use the current select method. If it
9630 is a list, Gnus will try all the methods in the list until it finds a
9633 Here's an example setting that will first try the current method, and
9634 then ask Google if that fails:
9637 (setq gnus-refer-article-method
9639 (nnweb "google" (nnweb-type google))))
9642 Most of the mail back ends support fetching by @code{Message-ID}, but do
9643 not do a particularly excellent job at it. That is, @code{nnmbox},
9644 @code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate
9645 articles from any groups, while @code{nnfolder}, and @code{nnimap} are
9646 only able to locate articles that have been posted to the current group.
9647 (Anything else would be too time consuming.) @code{nnmh} does not
9648 support this at all.
9651 @node Alternative Approaches
9652 @section Alternative Approaches
9654 Different people like to read news using different methods. This being
9655 gnus, we offer a small selection of minor modes for the summary buffers.
9658 * Pick and Read:: First mark articles and then read them.
9659 * Binary Groups:: Auto-decode all articles.
9664 @subsection Pick and Read
9665 @cindex pick and read
9667 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
9668 a two-phased reading interface. The user first marks in a summary
9669 buffer the articles she wants to read. Then she starts reading the
9670 articles with just an article buffer displayed.
9672 @findex gnus-pick-mode
9673 @kindex M-x gnus-pick-mode
9674 Gnus provides a summary buffer minor mode that allows
9675 this---@code{gnus-pick-mode}. This basically means that a few process
9676 mark commands become one-keystroke commands to allow easy marking, and
9677 it provides one additional command for switching to the summary buffer.
9679 Here are the available keystrokes when using pick mode:
9684 @findex gnus-pick-article-or-thread
9685 Pick the article or thread on the current line
9686 (@code{gnus-pick-article-or-thread}). If the variable
9687 @code{gnus-thread-hide-subtree} is true, then this key selects the
9688 entire thread when used at the first article of the thread. Otherwise,
9689 it selects just the article. If given a numerical prefix, go to that
9690 thread or article and pick it. (The line number is normally displayed
9691 at the beginning of the summary pick lines.)
9694 @kindex SPACE (Pick)
9695 @findex gnus-pick-next-page
9696 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
9697 at the end of the buffer, start reading the picked articles.
9701 @findex gnus-pick-unmark-article-or-thread.
9702 Unpick the thread or article
9703 (@code{gnus-pick-unmark-article-or-thread}). If the variable
9704 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
9705 thread if used at the first article of the thread. Otherwise it unpicks
9706 just the article. You can give this key a numerical prefix to unpick
9707 the thread or article at that line.
9711 @findex gnus-pick-start-reading
9712 @vindex gnus-pick-display-summary
9713 Start reading the picked articles (@code{gnus-pick-start-reading}). If
9714 given a prefix, mark all unpicked articles as read first. If
9715 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
9716 will still be visible when you are reading.
9720 All the normal summary mode commands are still available in the
9721 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
9722 which is mapped to the same function
9723 @code{gnus-summary-tick-article-forward}.
9725 If this sounds like a good idea to you, you could say:
9728 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
9731 @vindex gnus-pick-mode-hook
9732 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
9734 @vindex gnus-mark-unpicked-articles-as-read
9735 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
9736 all unpicked articles as read. The default is @code{nil}.
9738 @vindex gnus-summary-pick-line-format
9739 The summary line format in pick mode is slightly different from the
9740 standard format. At the beginning of each line the line number is
9741 displayed. The pick mode line format is controlled by the
9742 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
9743 Variables}). It accepts the same format specs that
9744 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
9748 @subsection Binary Groups
9749 @cindex binary groups
9751 @findex gnus-binary-mode
9752 @kindex M-x gnus-binary-mode
9753 If you spend much time in binary groups, you may grow tired of hitting
9754 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
9755 is a minor mode for summary buffers that makes all ordinary Gnus article
9756 selection functions uudecode series of articles and display the result
9757 instead of just displaying the articles the normal way.
9760 @findex gnus-binary-show-article
9761 The only way, in fact, to see the actual articles is the @kbd{g}
9762 command, when you have turned on this mode
9763 (@code{gnus-binary-show-article}).
9765 @vindex gnus-binary-mode-hook
9766 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
9770 @section Tree Display
9773 @vindex gnus-use-trees
9774 If you don't like the normal gnus summary display, you might try setting
9775 @code{gnus-use-trees} to @code{t}. This will create (by default) an
9776 additional @dfn{tree buffer}. You can execute all summary mode commands
9779 There are a few variables to customize the tree display, of course:
9782 @item gnus-tree-mode-hook
9783 @vindex gnus-tree-mode-hook
9784 A hook called in all tree mode buffers.
9786 @item gnus-tree-mode-line-format
9787 @vindex gnus-tree-mode-line-format
9788 A format string for the mode bar in the tree mode buffers (@pxref{Mode
9789 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
9790 of valid specs, @pxref{Summary Buffer Mode Line}.
9792 @item gnus-selected-tree-face
9793 @vindex gnus-selected-tree-face
9794 Face used for highlighting the selected article in the tree buffer. The
9795 default is @code{modeline}.
9797 @item gnus-tree-line-format
9798 @vindex gnus-tree-line-format
9799 A format string for the tree nodes. The name is a bit of a misnomer,
9800 though---it doesn't define a line, but just the node. The default value
9801 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
9802 the name of the poster. It is vital that all nodes are of the same
9803 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
9809 The name of the poster.
9811 The @code{From} header.
9813 The number of the article.
9815 The opening bracket.
9817 The closing bracket.
9822 @xref{Formatting Variables}.
9824 Variables related to the display are:
9827 @item gnus-tree-brackets
9828 @vindex gnus-tree-brackets
9829 This is used for differentiating between ``real'' articles and
9830 ``sparse'' articles. The format is
9832 ((@var{real-open} . @var{real-close})
9833 (@var{sparse-open} . @var{sparse-close})
9834 (@var{dummy-open} . @var{dummy-close}))
9836 and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
9838 @item gnus-tree-parent-child-edges
9839 @vindex gnus-tree-parent-child-edges
9840 This is a list that contains the characters used for connecting parent
9841 nodes to their children. The default is @code{(?- ?\\ ?|)}.
9845 @item gnus-tree-minimize-window
9846 @vindex gnus-tree-minimize-window
9847 If this variable is non-@code{nil}, gnus will try to keep the tree
9848 buffer as small as possible to allow more room for the other gnus
9849 windows. If this variable is a number, the tree buffer will never be
9850 higher than that number. The default is @code{t}. Note that if you
9851 have several windows displayed side-by-side in a frame and the tree
9852 buffer is one of these, minimizing the tree window will also resize all
9853 other windows displayed next to it.
9855 You may also wish to add the following hook to keep the window minimized
9859 (add-hook 'gnus-configure-windows-hook
9860 'gnus-tree-perhaps-minimize)
9863 @item gnus-generate-tree-function
9864 @vindex gnus-generate-tree-function
9865 @findex gnus-generate-horizontal-tree
9866 @findex gnus-generate-vertical-tree
9867 The function that actually generates the thread tree. Two predefined
9868 functions are available: @code{gnus-generate-horizontal-tree} and
9869 @code{gnus-generate-vertical-tree} (which is the default).
9873 Here's an example from a horizontal tree buffer:
9876 @{***@}-(***)-[odd]-[Gun]
9886 Here's the same thread displayed in a vertical tree buffer:
9891 |--------------------------\-----\-----\
9892 (***) [Bjo] [Gun] [Gun]
9894 [odd] [Jan] [odd] (***) [Jor]
9896 [Gun] [Eri] [Eri] [odd]
9902 If you're using horizontal trees, it might be nice to display the trees
9903 side-by-side with the summary buffer. You could add something like the
9904 following to your @file{~/.gnus.el} file:
9907 (setq gnus-use-trees t
9908 gnus-generate-tree-function 'gnus-generate-horizontal-tree
9909 gnus-tree-minimize-window nil)
9910 (gnus-add-configuration
9914 (summary 0.75 point)
9919 @xref{Window Layout}.
9922 @node Mail Group Commands
9923 @section Mail Group Commands
9924 @cindex mail group commands
9926 Some commands only make sense in mail groups. If these commands are
9927 invalid in the current group, they will raise a hell and let you know.
9929 All these commands (except the expiry and edit commands) use the
9930 process/prefix convention (@pxref{Process/Prefix}).
9935 @kindex B e (Summary)
9936 @findex gnus-summary-expire-articles
9937 Run all expirable articles in the current group through the expiry
9938 process (@code{gnus-summary-expire-articles}). That is, delete all
9939 expirable articles in the group that have been around for a while.
9940 (@pxref{Expiring Mail}).
9943 @kindex B C-M-e (Summary)
9944 @findex gnus-summary-expire-articles-now
9945 Delete all the expirable articles in the group
9946 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
9947 articles eligible for expiry in the current group will
9948 disappear forever into that big @file{/dev/null} in the sky.
9951 @kindex B DEL (Summary)
9952 @findex gnus-summary-delete-article
9953 @c @icon{gnus-summary-mail-delete}
9954 Delete the mail article. This is ``delete'' as in ``delete it from your
9955 disk forever and ever, never to return again.'' Use with caution.
9956 (@code{gnus-summary-delete-article}).
9959 @kindex B m (Summary)
9961 @findex gnus-summary-move-article
9962 @vindex gnus-preserve-marks
9963 Move the article from one mail group to another
9964 (@code{gnus-summary-move-article}). Marks will be preserved if
9965 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
9968 @kindex B c (Summary)
9970 @findex gnus-summary-copy-article
9971 @c @icon{gnus-summary-mail-copy}
9972 Copy the article from one group (mail group or not) to a mail group
9973 (@code{gnus-summary-copy-article}). Marks will be preserved if
9974 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
9977 @kindex B B (Summary)
9978 @cindex crosspost mail
9979 @findex gnus-summary-crosspost-article
9980 Crosspost the current article to some other group
9981 (@code{gnus-summary-crosspost-article}). This will create a new copy of
9982 the article in the other group, and the Xref headers of the article will
9983 be properly updated.
9986 @kindex B i (Summary)
9987 @findex gnus-summary-import-article
9988 Import an arbitrary file into the current mail newsgroup
9989 (@code{gnus-summary-import-article}). You will be prompted for a file
9990 name, a @code{From} header and a @code{Subject} header.
9993 @kindex B I (Summary)
9994 @findex gnus-summary-create-article
9995 Create an empty article in the current mail newsgroups
9996 (@code{gnus-summary-create-article}). You will be prompted for a
9997 @code{From} header and a @code{Subject} header.
10000 @kindex B r (Summary)
10001 @findex gnus-summary-respool-article
10002 @vindex gnus-summary-respool-default-method
10003 Respool the mail article (@code{gnus-summary-respool-article}).
10004 @code{gnus-summary-respool-default-method} will be used as the default
10005 select method when respooling. This variable is @code{nil} by default,
10006 which means that the current group select method will be used instead.
10007 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
10008 (which is the default).
10012 @kindex B w (Summary)
10013 @kindex e (Summary)
10014 @findex gnus-summary-edit-article
10015 @kindex C-c C-c (Article)
10016 @findex gnus-summary-edit-article-done
10017 Edit the current article (@code{gnus-summary-edit-article}). To finish
10018 editing and make the changes permanent, type @kbd{C-c C-c}
10019 (@code{gnus-summary-edit-article-done}). If you give a prefix to the
10020 @kbd{C-c C-c} command, gnus won't re-highlight the article.
10023 @kindex B q (Summary)
10024 @findex gnus-summary-respool-query
10025 If you want to re-spool an article, you might be curious as to what group
10026 the article will end up in before you do the re-spooling. This command
10027 will tell you (@code{gnus-summary-respool-query}).
10030 @kindex B t (Summary)
10031 @findex gnus-summary-respool-trace
10032 Similarly, this command will display all fancy splitting patterns used
10033 when respooling, if any (@code{gnus-summary-respool-trace}).
10036 @kindex B p (Summary)
10037 @findex gnus-summary-article-posted-p
10038 Some people have a tendency to send you ``courtesy'' copies when they
10039 follow up to articles you have posted. These usually have a
10040 @code{Newsgroups} header in them, but not always. This command
10041 (@code{gnus-summary-article-posted-p}) will try to fetch the current
10042 article from your news server (or rather, from
10043 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
10044 report back whether it found the article or not. Even if it says that
10045 it didn't find the article, it may have been posted anyway---mail
10046 propagation is much faster than news propagation, and the news copy may
10047 just not have arrived yet.
10050 @kindex K E (Summary)
10051 @findex gnus-article-encrypt-body
10052 @vindex gnus-article-encrypt-protocol
10053 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
10054 The body is encrypted with the encryption protocol specified by the
10055 variable @code{gnus-article-encrypt-protocol}.
10059 @vindex gnus-move-split-methods
10060 @cindex moving articles
10061 If you move (or copy) articles regularly, you might wish to have gnus
10062 suggest where to put the articles. @code{gnus-move-split-methods} is a
10063 variable that uses the same syntax as @code{gnus-split-methods}
10064 (@pxref{Saving Articles}). You may customize that variable to create
10065 suggestions you find reasonable. (Note that
10066 @code{gnus-move-split-methods} uses group names where
10067 @code{gnus-split-methods} uses file names.)
10070 (setq gnus-move-split-methods
10071 '(("^From:.*Lars Magne" "nnml:junk")
10072 ("^Subject:.*gnus" "nnfolder:important")
10073 (".*" "nnml:misc")))
10077 @node Various Summary Stuff
10078 @section Various Summary Stuff
10081 * Summary Group Information:: Information oriented commands.
10082 * Searching for Articles:: Multiple article commands.
10083 * Summary Generation Commands::
10084 * Really Various Summary Commands:: Those pesky non-conformant commands.
10088 @vindex gnus-summary-display-while-building
10089 @item gnus-summary-display-while-building
10090 If non-@code{nil}, show and update the summary buffer as it's being
10091 built. If @code{t}, update the buffer after every line is inserted.
10092 If the value is an integer, @var{n}, update the display every @var{n}
10093 lines. The default is @code{nil}.
10095 @vindex gnus-summary-display-arrow
10096 @item gnus-summary-display-arrow
10097 If non-@code{nil}, display an arrow in the fringe to indicate the
10100 @vindex gnus-summary-mode-hook
10101 @item gnus-summary-mode-hook
10102 This hook is called when creating a summary mode buffer.
10104 @vindex gnus-summary-generate-hook
10105 @item gnus-summary-generate-hook
10106 This is called as the last thing before doing the threading and the
10107 generation of the summary buffer. It's quite convenient for customizing
10108 the threading variables based on what data the newsgroup has. This hook
10109 is called from the summary buffer after most summary buffer variables
10112 @vindex gnus-summary-prepare-hook
10113 @item gnus-summary-prepare-hook
10114 It is called after the summary buffer has been generated. You might use
10115 it to, for instance, highlight lines or modify the look of the buffer in
10116 some other ungodly manner. I don't care.
10118 @vindex gnus-summary-prepared-hook
10119 @item gnus-summary-prepared-hook
10120 A hook called as the very last thing after the summary buffer has been
10123 @vindex gnus-summary-ignore-duplicates
10124 @item gnus-summary-ignore-duplicates
10125 When gnus discovers two articles that have the same @code{Message-ID},
10126 it has to do something drastic. No articles are allowed to have the
10127 same @code{Message-ID}, but this may happen when reading mail from some
10128 sources. Gnus allows you to customize what happens with this variable.
10129 If it is @code{nil} (which is the default), gnus will rename the
10130 @code{Message-ID} (for display purposes only) and display the article as
10131 any other article. If this variable is @code{t}, it won't display the
10132 article---it'll be as if it never existed.
10134 @vindex gnus-alter-articles-to-read-function
10135 @item gnus-alter-articles-to-read-function
10136 This function, which takes two parameters (the group name and the list
10137 of articles to be selected), is called to allow the user to alter the
10138 list of articles to be selected.
10140 For instance, the following function adds the list of cached articles to
10141 the list in one particular group:
10144 (defun my-add-cached-articles (group articles)
10145 (if (string= group "some.group")
10146 (append gnus-newsgroup-cached articles)
10150 @vindex gnus-newsgroup-variables
10151 @item gnus-newsgroup-variables
10152 A list of newsgroup (summary buffer) local variables, or cons of
10153 variables and their default values (when the default values are not
10154 @code{nil}), that should be made global while the summary buffer is
10155 active. These variables can be used to set variables in the group
10156 parameters while still allowing them to affect operations done in
10157 other buffers. For example:
10160 (setq gnus-newsgroup-variables
10161 '(message-use-followup-to
10162 (gnus-visible-headers .
10163 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
10169 @node Summary Group Information
10170 @subsection Summary Group Information
10175 @kindex H f (Summary)
10176 @findex gnus-summary-fetch-faq
10177 @vindex gnus-group-faq-directory
10178 Try to fetch the @acronym{FAQ} (list of frequently asked questions)
10179 for the current group (@code{gnus-summary-fetch-faq}). Gnus will try
10180 to get the @acronym{FAQ} from @code{gnus-group-faq-directory}, which
10181 is usually a directory on a remote machine. This variable can also be
10182 a list of directories. In that case, giving a prefix to this command
10183 will allow you to choose between the various sites. @code{ange-ftp}
10184 or @code{efs} will probably be used for fetching the file.
10187 @kindex H d (Summary)
10188 @findex gnus-summary-describe-group
10189 Give a brief description of the current group
10190 (@code{gnus-summary-describe-group}). If given a prefix, force
10191 rereading the description from the server.
10194 @kindex H h (Summary)
10195 @findex gnus-summary-describe-briefly
10196 Give an extremely brief description of the most important summary
10197 keystrokes (@code{gnus-summary-describe-briefly}).
10200 @kindex H i (Summary)
10201 @findex gnus-info-find-node
10202 Go to the gnus info node (@code{gnus-info-find-node}).
10206 @node Searching for Articles
10207 @subsection Searching for Articles
10212 @kindex M-s (Summary)
10213 @findex gnus-summary-search-article-forward
10214 Search through all subsequent (raw) articles for a regexp
10215 (@code{gnus-summary-search-article-forward}).
10218 @kindex M-r (Summary)
10219 @findex gnus-summary-search-article-backward
10220 Search through all previous (raw) articles for a regexp
10221 (@code{gnus-summary-search-article-backward}).
10224 @kindex & (Summary)
10225 @findex gnus-summary-execute-command
10226 This command will prompt you for a header, a regular expression to match
10227 on this field, and a command to be executed if the match is made
10228 (@code{gnus-summary-execute-command}). If the header is an empty
10229 string, the match is done on the entire article. If given a prefix,
10230 search backward instead.
10232 For instance, @kbd{& RET some.*string RET #} will put the process mark on
10233 all articles that have heads or bodies that match @samp{some.*string}.
10236 @kindex M-& (Summary)
10237 @findex gnus-summary-universal-argument
10238 Perform any operation on all articles that have been marked with
10239 the process mark (@code{gnus-summary-universal-argument}).
10242 @node Summary Generation Commands
10243 @subsection Summary Generation Commands
10248 @kindex Y g (Summary)
10249 @findex gnus-summary-prepare
10250 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
10253 @kindex Y c (Summary)
10254 @findex gnus-summary-insert-cached-articles
10255 Pull all cached articles (for the current group) into the summary buffer
10256 (@code{gnus-summary-insert-cached-articles}).
10259 @kindex Y d (Summary)
10260 @findex gnus-summary-insert-dormant-articles
10261 Pull all dormant articles (for the current group) into the summary buffer
10262 (@code{gnus-summary-insert-dormant-articles}).
10267 @node Really Various Summary Commands
10268 @subsection Really Various Summary Commands
10274 @kindex C-d (Summary)
10275 @kindex A D (Summary)
10276 @findex gnus-summary-enter-digest-group
10277 If the current article is a collection of other articles (for instance,
10278 a digest), you might use this command to enter a group based on the that
10279 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
10280 guess what article type is currently displayed unless you give a prefix
10281 to this command, which forces a ``digest'' interpretation. Basically,
10282 whenever you see a message that is a collection of other messages of
10283 some format, you @kbd{C-d} and read these messages in a more convenient
10287 @kindex C-M-d (Summary)
10288 @findex gnus-summary-read-document
10289 This command is very similar to the one above, but lets you gather
10290 several documents into one biiig group
10291 (@code{gnus-summary-read-document}). It does this by opening several
10292 @code{nndoc} groups for each document, and then opening an
10293 @code{nnvirtual} group on top of these @code{nndoc} groups. This
10294 command understands the process/prefix convention
10295 (@pxref{Process/Prefix}).
10298 @kindex C-t (Summary)
10299 @findex gnus-summary-toggle-truncation
10300 Toggle truncation of summary lines
10301 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
10302 line centering function in the summary buffer, so it's not a good idea
10303 to have truncation switched off while reading articles.
10306 @kindex = (Summary)
10307 @findex gnus-summary-expand-window
10308 Expand the summary buffer window (@code{gnus-summary-expand-window}).
10309 If given a prefix, force an @code{article} window configuration.
10312 @kindex C-M-e (Summary)
10313 @findex gnus-summary-edit-parameters
10314 Edit the group parameters (@pxref{Group Parameters}) of the current
10315 group (@code{gnus-summary-edit-parameters}).
10318 @kindex C-M-a (Summary)
10319 @findex gnus-summary-customize-parameters
10320 Customize the group parameters (@pxref{Group Parameters}) of the current
10321 group (@code{gnus-summary-customize-parameters}).
10326 @node Exiting the Summary Buffer
10327 @section Exiting the Summary Buffer
10328 @cindex summary exit
10329 @cindex exiting groups
10331 Exiting from the summary buffer will normally update all info on the
10332 group and return you to the group buffer.
10339 @kindex Z Z (Summary)
10340 @kindex Z Q (Summary)
10341 @kindex q (Summary)
10342 @findex gnus-summary-exit
10343 @vindex gnus-summary-exit-hook
10344 @vindex gnus-summary-prepare-exit-hook
10345 @vindex gnus-group-no-more-groups-hook
10346 @c @icon{gnus-summary-exit}
10347 Exit the current group and update all information on the group
10348 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
10349 called before doing much of the exiting, which calls
10350 @code{gnus-summary-expire-articles} by default.
10351 @code{gnus-summary-exit-hook} is called after finishing the exit
10352 process. @code{gnus-group-no-more-groups-hook} is run when returning to
10353 group mode having no more (unread) groups.
10357 @kindex Z E (Summary)
10358 @kindex Q (Summary)
10359 @findex gnus-summary-exit-no-update
10360 Exit the current group without updating any information on the group
10361 (@code{gnus-summary-exit-no-update}).
10365 @kindex Z c (Summary)
10366 @kindex c (Summary)
10367 @findex gnus-summary-catchup-and-exit
10368 @c @icon{gnus-summary-catchup-and-exit}
10369 Mark all unticked articles in the group as read and then exit
10370 (@code{gnus-summary-catchup-and-exit}).
10373 @kindex Z C (Summary)
10374 @findex gnus-summary-catchup-all-and-exit
10375 Mark all articles, even the ticked ones, as read and then exit
10376 (@code{gnus-summary-catchup-all-and-exit}).
10379 @kindex Z n (Summary)
10380 @findex gnus-summary-catchup-and-goto-next-group
10381 Mark all articles as read and go to the next group
10382 (@code{gnus-summary-catchup-and-goto-next-group}).
10386 @kindex Z R (Summary)
10387 @kindex C-x C-s (Summary)
10388 @findex gnus-summary-reselect-current-group
10389 Exit this group, and then enter it again
10390 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
10391 all articles, both read and unread.
10395 @kindex Z G (Summary)
10396 @kindex M-g (Summary)
10397 @findex gnus-summary-rescan-group
10398 @c @icon{gnus-summary-mail-get}
10399 Exit the group, check for new articles in the group, and select the
10400 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
10401 articles, both read and unread.
10404 @kindex Z N (Summary)
10405 @findex gnus-summary-next-group
10406 Exit the group and go to the next group
10407 (@code{gnus-summary-next-group}).
10410 @kindex Z P (Summary)
10411 @findex gnus-summary-prev-group
10412 Exit the group and go to the previous group
10413 (@code{gnus-summary-prev-group}).
10416 @kindex Z s (Summary)
10417 @findex gnus-summary-save-newsrc
10418 Save the current number of read/marked articles in the dribble buffer
10419 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
10420 given a prefix, also save the @file{.newsrc} file(s). Using this
10421 command will make exit without updating (the @kbd{Q} command) worthless.
10424 @vindex gnus-exit-group-hook
10425 @code{gnus-exit-group-hook} is called when you exit the current group
10426 with an ``updating'' exit. For instance @kbd{Q}
10427 (@code{gnus-summary-exit-no-update}) does not call this hook.
10429 @findex gnus-summary-wake-up-the-dead
10430 @findex gnus-dead-summary-mode
10431 @vindex gnus-kill-summary-on-exit
10432 If you're in the habit of exiting groups, and then changing your mind
10433 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
10434 If you do that, gnus won't kill the summary buffer when you exit it.
10435 (Quelle surprise!) Instead it will change the name of the buffer to
10436 something like @samp{*Dead Summary ... *} and install a minor mode
10437 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
10438 buffer, you'll find that all keys are mapped to a function called
10439 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
10440 summary buffer will result in a live, normal summary buffer.
10442 There will never be more than one dead summary buffer at any one time.
10444 @vindex gnus-use-cross-reference
10445 The data on the current group will be updated (which articles you have
10446 read, which articles you have replied to, etc.) when you exit the
10447 summary buffer. If the @code{gnus-use-cross-reference} variable is
10448 @code{t} (which is the default), articles that are cross-referenced to
10449 this group and are marked as read, will also be marked as read in the
10450 other subscribed groups they were cross-posted to. If this variable is
10451 neither @code{nil} nor @code{t}, the article will be marked as read in
10452 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
10455 @node Crosspost Handling
10456 @section Crosspost Handling
10460 Marking cross-posted articles as read ensures that you'll never have to
10461 read the same article more than once. Unless, of course, somebody has
10462 posted it to several groups separately. Posting the same article to
10463 several groups (not cross-posting) is called @dfn{spamming}, and you are
10464 by law required to send nasty-grams to anyone who perpetrates such a
10465 heinous crime. You may want to try NoCeM handling to filter out spam
10468 Remember: Cross-posting is kinda ok, but posting the same article
10469 separately to several groups is not. Massive cross-posting (aka.
10470 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
10471 @code{gnus-summary-mail-crosspost-complaint} command to complain about
10472 excessive crossposting (@pxref{Summary Mail Commands}).
10474 @cindex cross-posting
10476 @cindex @acronym{NOV}
10477 One thing that may cause Gnus to not do the cross-posting thing
10478 correctly is if you use an @acronym{NNTP} server that supports @sc{xover}
10479 (which is very nice, because it speeds things up considerably) which
10480 does not include the @code{Xref} header in its @acronym{NOV} lines. This is
10481 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
10482 even with @sc{xover} by registering the @code{Xref} lines of all
10483 articles you actually read, but if you kill the articles, or just mark
10484 them as read without reading them, Gnus will not get a chance to snoop
10485 the @code{Xref} lines out of these articles, and will be unable to use
10486 the cross reference mechanism.
10488 @cindex LIST overview.fmt
10489 @cindex overview.fmt
10490 To check whether your @acronym{NNTP} server includes the @code{Xref} header
10491 in its overview files, try @samp{telnet your.nntp.server nntp},
10492 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
10493 overview.fmt}. This may not work, but if it does, and the last line you
10494 get does not read @samp{Xref:full}, then you should shout and whine at
10495 your news admin until she includes the @code{Xref} header in the
10498 @vindex gnus-nov-is-evil
10499 If you want Gnus to get the @code{Xref}s right all the time, you have to
10500 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
10505 For an alternative approach, @pxref{Duplicate Suppression}.
10508 @node Duplicate Suppression
10509 @section Duplicate Suppression
10511 By default, gnus tries to make sure that you don't have to read the same
10512 article more than once by utilizing the crossposting mechanism
10513 (@pxref{Crosspost Handling}). However, that simple and efficient
10514 approach may not work satisfactory for some users for various
10519 The @acronym{NNTP} server may fail to generate the @code{Xref} header. This
10520 is evil and not very common.
10523 The @acronym{NNTP} server may fail to include the @code{Xref} header in the
10524 @file{.overview} data bases. This is evil and all too common, alas.
10527 You may be reading the same group (or several related groups) from
10528 different @acronym{NNTP} servers.
10531 You may be getting mail that duplicates articles posted to groups.
10534 I'm sure there are other situations where @code{Xref} handling fails as
10535 well, but these four are the most common situations.
10537 If, and only if, @code{Xref} handling fails for you, then you may
10538 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
10539 will remember the @code{Message-ID}s of all articles you have read or
10540 otherwise marked as read, and then, as if by magic, mark them as read
10541 all subsequent times you see them---in @emph{all} groups. Using this
10542 mechanism is quite likely to be somewhat inefficient, but not overly
10543 so. It's certainly preferable to reading the same articles more than
10546 Duplicate suppression is not a very subtle instrument. It's more like a
10547 sledge hammer than anything else. It works in a very simple
10548 fashion---if you have marked an article as read, it adds this Message-ID
10549 to a cache. The next time it sees this Message-ID, it will mark the
10550 article as read with the @samp{M} mark. It doesn't care what group it
10551 saw the article in.
10554 @item gnus-suppress-duplicates
10555 @vindex gnus-suppress-duplicates
10556 If non-@code{nil}, suppress duplicates.
10558 @item gnus-save-duplicate-list
10559 @vindex gnus-save-duplicate-list
10560 If non-@code{nil}, save the list of duplicates to a file. This will
10561 make startup and shutdown take longer, so the default is @code{nil}.
10562 However, this means that only duplicate articles read in a single gnus
10563 session are suppressed.
10565 @item gnus-duplicate-list-length
10566 @vindex gnus-duplicate-list-length
10567 This variable says how many @code{Message-ID}s to keep in the duplicate
10568 suppression list. The default is 10000.
10570 @item gnus-duplicate-file
10571 @vindex gnus-duplicate-file
10572 The name of the file to store the duplicate suppression list in. The
10573 default is @file{~/News/suppression}.
10576 If you have a tendency to stop and start gnus often, setting
10577 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
10578 you leave gnus running for weeks on end, you may have it @code{nil}. On
10579 the other hand, saving the list makes startup and shutdown much slower,
10580 so that means that if you stop and start gnus often, you should set
10581 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
10582 to you to figure out, I think.
10587 Gnus is able to verify signed messages or decrypt encrypted messages.
10588 The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME}
10589 and @acronym{S/MIME}, however you need some external programs to get
10594 To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to
10595 install an OpenPGP implementation such as GnuPG. The Lisp interface
10596 to GnuPG included with Gnus is called PGG (@pxref{Top, ,PGG, pgg, PGG
10597 Manual}), but Mailcrypt and gpg.el are also supported.
10600 To handle @acronym{S/MIME} message, you need to install OpenSSL. OpenSSL 0.9.6
10601 or newer is recommended.
10605 More information on how to set things up can be found in the message
10606 manual (@pxref{Security, ,Security, message, Message Manual}).
10609 @item mm-verify-option
10610 @vindex mm-verify-option
10611 Option of verifying signed parts. @code{never}, not verify;
10612 @code{always}, always verify; @code{known}, only verify known
10613 protocols. Otherwise, ask user.
10615 @item mm-decrypt-option
10616 @vindex mm-decrypt-option
10617 Option of decrypting encrypted parts. @code{never}, no decryption;
10618 @code{always}, always decrypt; @code{known}, only decrypt known
10619 protocols. Otherwise, ask user.
10622 @vindex mml1991-use
10623 Symbol indicating elisp interface to OpenPGP implementation for
10624 @acronym{PGP} messages. The default is @code{pgg}, but
10625 @code{mailcrypt} and @code{gpg} are also supported although
10629 @vindex mml2015-use
10630 Symbol indicating elisp interface to OpenPGP implementation for
10631 @acronym{PGP/MIME} messages. The default is @code{pgg}, but
10632 @code{mailcrypt} and @code{gpg} are also supported although
10637 @cindex snarfing keys
10638 @cindex importing PGP keys
10639 @cindex PGP key ring import
10640 Snarfing OpenPGP keys (i.e., importing keys from articles into your
10641 key ring) is not supported explicitly through a menu item or command,
10642 rather Gnus do detect and label keys as @samp{application/pgp-keys},
10643 allowing you to specify whatever action you think is appropriate
10644 through the usual @acronym{MIME} infrastructure. You can use a
10645 @file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The
10646 Emacs MIME Manual}) such as the following to import keys using GNU
10647 Privacy Guard when you click on the @acronym{MIME} button
10648 (@pxref{Using MIME}).
10651 application/pgp-keys; gpg --import --interactive --verbose; needsterminal
10654 This happens to also be the default action defined in
10655 @code{mailcap-mime-data}.
10658 @section Mailing List
10659 @cindex mailing list
10662 @kindex A M (summary)
10663 @findex gnus-mailing-list-insinuate
10664 Gnus understands some mailing list fields of RFC 2369. To enable it,
10665 add a @code{to-list} group parameter (@pxref{Group Parameters}),
10666 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
10669 That enables the following commands to the summary buffer:
10674 @kindex C-c C-n h (Summary)
10675 @findex gnus-mailing-list-help
10676 Send a message to fetch mailing list help, if List-Help field exists.
10679 @kindex C-c C-n s (Summary)
10680 @findex gnus-mailing-list-subscribe
10681 Send a message to subscribe the mailing list, if List-Subscribe field exists.
10684 @kindex C-c C-n u (Summary)
10685 @findex gnus-mailing-list-unsubscribe
10686 Send a message to unsubscribe the mailing list, if List-Unsubscribe
10690 @kindex C-c C-n p (Summary)
10691 @findex gnus-mailing-list-post
10692 Post to the mailing list, if List-Post field exists.
10695 @kindex C-c C-n o (Summary)
10696 @findex gnus-mailing-list-owner
10697 Send a message to the mailing list owner, if List-Owner field exists.
10700 @kindex C-c C-n a (Summary)
10701 @findex gnus-mailing-list-owner
10702 Browse the mailing list archive, if List-Archive field exists.
10707 @node Article Buffer
10708 @chapter Article Buffer
10709 @cindex article buffer
10711 The articles are displayed in the article buffer, of which there is only
10712 one. All the summary buffers share the same article buffer unless you
10713 tell gnus otherwise.
10716 * Hiding Headers:: Deciding what headers should be displayed.
10717 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
10718 * Customizing Articles:: Tailoring the look of the articles.
10719 * Article Keymap:: Keystrokes available in the article buffer.
10720 * Misc Article:: Other stuff.
10724 @node Hiding Headers
10725 @section Hiding Headers
10726 @cindex hiding headers
10727 @cindex deleting headers
10729 The top section of each article is the @dfn{head}. (The rest is the
10730 @dfn{body}, but you may have guessed that already.)
10732 @vindex gnus-show-all-headers
10733 There is a lot of useful information in the head: the name of the person
10734 who wrote the article, the date it was written and the subject of the
10735 article. That's well and nice, but there's also lots of information
10736 most people do not want to see---what systems the article has passed
10737 through before reaching you, the @code{Message-ID}, the
10738 @code{References}, etc. ad nauseam---and you'll probably want to get rid
10739 of some of those lines. If you want to keep all those lines in the
10740 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
10742 Gnus provides you with two variables for sifting headers:
10746 @item gnus-visible-headers
10747 @vindex gnus-visible-headers
10748 If this variable is non-@code{nil}, it should be a regular expression
10749 that says what headers you wish to keep in the article buffer. All
10750 headers that do not match this variable will be hidden.
10752 For instance, if you only want to see the name of the person who wrote
10753 the article and the subject, you'd say:
10756 (setq gnus-visible-headers "^From:\\|^Subject:")
10759 This variable can also be a list of regexps to match headers to
10762 @item gnus-ignored-headers
10763 @vindex gnus-ignored-headers
10764 This variable is the reverse of @code{gnus-visible-headers}. If this
10765 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
10766 should be a regular expression that matches all lines that you want to
10767 hide. All lines that do not match this variable will remain visible.
10769 For instance, if you just want to get rid of the @code{References} field
10770 and the @code{Xref} field, you might say:
10773 (setq gnus-ignored-headers "^References:\\|^Xref:")
10776 This variable can also be a list of regexps to match headers to
10779 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
10780 variable will have no effect.
10784 @vindex gnus-sorted-header-list
10785 Gnus can also sort the headers for you. (It does this by default.) You
10786 can control the sorting by setting the @code{gnus-sorted-header-list}
10787 variable. It is a list of regular expressions that says in what order
10788 the headers are to be displayed.
10790 For instance, if you want the name of the author of the article first,
10791 and then the subject, you might say something like:
10794 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
10797 Any headers that are to remain visible, but are not listed in this
10798 variable, will be displayed in random order after all the headers listed in this variable.
10800 @findex gnus-article-hide-boring-headers
10801 @vindex gnus-boring-article-headers
10802 You can hide further boring headers by setting
10803 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
10804 does depends on the @code{gnus-boring-article-headers} variable. It's a
10805 list, but this list doesn't actually contain header names. Instead it
10806 lists various @dfn{boring conditions} that Gnus can check and remove
10809 These conditions are:
10812 Remove all empty headers.
10814 Remove the @code{Followup-To} header if it is identical to the
10815 @code{Newsgroups} header.
10817 Remove the @code{Reply-To} header if it lists the same addresses as
10818 the @code{From} header, or if the @code{broken-reply-to} group
10821 Remove the @code{Newsgroups} header if it only contains the current group
10824 Remove the @code{To} header if it only contains the address identical to
10825 the current group's @code{to-address} parameter.
10827 Remove the @code{To} header if it only contains the address identical to
10828 the current group's @code{to-list} parameter.
10830 Remove the @code{CC} header if it only contains the address identical to
10831 the current group's @code{to-list} parameter.
10833 Remove the @code{Date} header if the article is less than three days
10836 Remove the @code{To} header if it is very long.
10838 Remove all @code{To} headers if there are more than one.
10841 To include these three elements, you could say something like:
10844 (setq gnus-boring-article-headers
10845 '(empty followup-to reply-to))
10848 This is also the default value for this variable.
10852 @section Using MIME
10853 @cindex @acronym{MIME}
10855 Mime is a standard for waving your hands through the air, aimlessly,
10856 while people stand around yawning.
10858 @acronym{MIME}, however, is a standard for encoding your articles, aimlessly,
10859 while all newsreaders die of fear.
10861 @acronym{MIME} may specify what character set the article uses, the encoding
10862 of the characters, and it also makes it possible to embed pictures and
10863 other naughty stuff in innocent-looking articles.
10865 @vindex gnus-show-mime
10866 @vindex gnus-article-display-method-for-mime
10867 @findex gnus-article-display-mime-message
10868 gnus handles @acronym{MIME} by pushing the articles through
10869 @code{gnus-article-display-method-for-mime}, which is
10870 @code{gnus-article-display-mime-message} by default. This function
10871 calls the @acronym{SEMI} MIME-View program to actually do the work. For
10872 more information on @acronym{SEMI} MIME-View, see its manual page
10873 (however it is not existed yet, sorry).
10875 Set @code{gnus-show-mime} to @code{t} if you want to use
10876 @acronym{MIME} all the time. If you have @code{gnus-show-mime} set,
10877 then you'll see some unfortunate display glitches in the article buffer.
10878 These can't be avoided.
10880 In GNUS or Gnus, it might be best to just use the toggling functions
10881 from the summary buffer to avoid getting nasty surprises. (For instance,
10882 you enter the group @samp{alt.sing-a-long} and, before you know it,
10883 @acronym{MIME} has decoded the sound file in the article and some
10884 horrible sing-a-long song comes screaming out your speakers, and you
10885 can't find the volume button, because there isn't one, and people are
10886 starting to look at you, and you try to stop the program, but you can't,
10887 and you can't find the program to control the volume, and everybody else
10888 in the room suddenly decides to look at you disdainfully, and you'll
10889 feel rather stupid.)
10891 Any similarity to real events and people is purely coincidental. Ahem.
10893 To avoid such kind of situation, gnus stops to use
10894 @code{metamail-buffer}. So now, you can set @code{gnus-show-mime} to
10895 non-@code{nil} every-time, then you can push button in the article
10896 buffer when there are nobody else.
10898 Also @pxref{MIME Commands}.
10901 @node Customizing Articles
10902 @section Customizing Articles
10903 @cindex article customization
10905 A slew of functions for customizing how the articles are to look like
10906 exist. You can call these functions interactively
10907 (@pxref{Article Washing}), or you can have them
10908 called automatically when you select the articles.
10910 To have them called automatically, you should set the corresponding
10911 ``treatment'' variable. For instance, to have headers hidden, you'd set
10912 @code{gnus-treat-hide-headers}. Below is a list of variables that can
10913 be set, but first we discuss the values these variables can have.
10915 Note: Some values, while valid, make little sense. Check the list below
10916 for sensible values.
10920 @code{nil}: Don't do this treatment.
10923 @code{t}: Do this treatment on all body parts.
10926 @code{head}: Do the treatment on the headers.
10929 @code{last}: Do this treatment on the last part.
10932 An integer: Do this treatment on all body parts that have a length less
10936 A list of strings: Do this treatment on all body parts that are in
10937 articles that are read in groups that have names that match one of the
10938 regexps in the list.
10941 A list where the first element is not a string:
10943 The list is evaluated recursively. The first element of the list is a
10944 predicate. The following predicates are recognized: @code{or},
10945 @code{and}, @code{not} and @code{typep}. Here's an example:
10949 (typep "text/x-vcard"))
10953 @code{mime}: Do this treatment if the value of @code{gnus-show-mime}' is
10958 You may have noticed that the word @dfn{part} is used here. This refers
10959 to the fact that some messages are @acronym{MIME} multipart articles that may
10960 be divided into several parts. Articles that are not multiparts are
10961 considered to contain just a single part.
10963 @vindex gnus-article-treat-types
10964 Are the treatments applied to all sorts of multipart parts? Yes, if you
10965 want to, but by default, only @samp{text/plain} parts are given the
10966 treatment. This is controlled by the @code{gnus-article-treat-types}
10967 variable, which is a list of regular expressions that are matched to the
10968 type of the part. This variable is ignored if the value of the
10969 controlling variable is a predicate list, as described above.
10971 The following treatment options are available. The easiest way to
10972 customize this is to examine the @code{gnus-article-treat} customization
10973 group. Values in parenthesis are suggested sensible values. Others are
10974 possible but those listed are probably sufficient for most people.
10977 @item gnus-treat-buttonize (t, integer)
10978 @item gnus-treat-buttonize-head (head)
10980 @xref{Article Buttons}.
10982 @item gnus-treat-capitalize-sentences (t, integer)
10983 @item gnus-treat-overstrike (t, integer)
10984 @item gnus-treat-strip-cr (t, integer)
10985 @item gnus-treat-strip-headers-in-body (t, integer)
10986 @item gnus-treat-strip-leading-blank-lines (t, integer)
10987 @item gnus-treat-strip-multiple-blank-lines (t, integer)
10988 @item gnus-treat-strip-pem (t, last, integer)
10989 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
10990 @item gnus-treat-unsplit-urls (t, integer)
10991 @item gnus-treat-wash-html (t, integer)
10992 @item gnus-treat-decode-article-as-default-mime-charset (t, integer)
10994 @xref{Article Washing}.
10996 @item gnus-treat-date-english (head)
10997 @item gnus-treat-date-iso8601 (head)
10998 @item gnus-treat-date-lapsed (head)
10999 @item gnus-treat-date-local (head)
11000 @item gnus-treat-date-original (head)
11001 @item gnus-treat-date-user-defined (head)
11002 @item gnus-treat-date-ut (head)
11004 @xref{Article Date}.
11006 @item gnus-treat-from-picon (head)
11007 @item gnus-treat-mail-picon (head)
11008 @item gnus-treat-newsgroups-picon (head)
11012 @item gnus-treat-display-smileys (t, integer)
11014 @item gnus-treat-body-boundary (head)
11016 @vindex gnus-body-boundary-delimiter
11017 Adds a delimiter between header and body, the string used as delimiter
11018 is controlled by @code{gnus-body-boundary-delimiter}.
11022 @item gnus-treat-display-x-face (head)
11026 @item gnus-treat-display-face (head)
11030 @item gnus-treat-emphasize (t, head, integer)
11031 @item gnus-treat-fill-article (t, integer)
11032 @item gnus-treat-fill-long-lines (t, integer)
11033 @item gnus-treat-hide-boring-headers (head)
11034 @item gnus-treat-hide-citation (t, integer)
11035 @item gnus-treat-hide-citation-maybe (t, integer)
11036 @item gnus-treat-hide-headers (head)
11037 @item gnus-treat-hide-signature (t, last)
11038 @item gnus-treat-strip-banner (t, last)
11039 @item gnus-treat-strip-list-identifiers (head)
11041 @xref{Article Hiding}.
11043 @item gnus-treat-highlight-citation (t, integer)
11044 @item gnus-treat-highlight-headers (head)
11045 @item gnus-treat-highlight-signature (t, last, integer)
11047 @xref{Article Highlighting}.
11049 @item gnus-treat-play-sounds
11050 @item gnus-treat-translate
11051 @item gnus-treat-x-pgp-sig (head)
11053 @item gnus-treat-unfold-headers (head)
11054 @item gnus-treat-fold-headers (head)
11055 @item gnus-treat-fold-newsgroups (head)
11056 @item gnus-treat-leading-whitespace (head)
11058 @xref{Article Header}.
11063 @vindex gnus-part-display-hook
11064 You can, of course, write your own functions to be called from
11065 @code{gnus-part-display-hook}. The functions are called narrowed to the
11066 part, and you can do anything you like, pretty much. There is no
11067 information that you have to keep in the buffer---you can change
11071 @node Article Keymap
11072 @section Article Keymap
11074 Most of the keystrokes in the summary buffer can also be used in the
11075 article buffer. They should behave as if you typed them in the summary
11076 buffer, which means that you don't actually have to have a summary
11077 buffer displayed while reading. You can do it all from the article
11080 A few additional keystrokes are available:
11085 @kindex SPACE (Article)
11086 @findex gnus-article-next-page
11087 Scroll forwards one page (@code{gnus-article-next-page}).
11088 This is exactly the same as @kbd{h SPACE h}.
11091 @kindex DEL (Article)
11092 @findex gnus-article-prev-page
11093 Scroll backwards one page (@code{gnus-article-prev-page}).
11094 This is exactly the same as @kbd{h DEL h}.
11097 @kindex C-c ^ (Article)
11098 @findex gnus-article-refer-article
11099 If point is in the neighborhood of a @code{Message-ID} and you press
11100 @kbd{C-c ^}, Gnus will try to get that article from the server
11101 (@code{gnus-article-refer-article}).
11104 @kindex C-c C-m (Article)
11105 @findex gnus-article-mail
11106 Send a reply to the address near point (@code{gnus-article-mail}). If
11107 given a prefix, include the mail.
11110 @kindex s (Article)
11111 @findex gnus-article-show-summary
11112 Reconfigure the buffers so that the summary buffer becomes visible
11113 (@code{gnus-article-show-summary}).
11116 @kindex ? (Article)
11117 @findex gnus-article-describe-briefly
11118 Give a very brief description of the available keystrokes
11119 (@code{gnus-article-describe-briefly}).
11122 @kindex TAB (Article)
11123 @findex gnus-article-next-button
11124 Go to the next button, if any (@code{gnus-article-next-button}). This
11125 only makes sense if you have buttonizing turned on.
11128 @kindex M-TAB (Article)
11129 @findex gnus-article-prev-button
11130 Go to the previous button, if any (@code{gnus-article-prev-button}).
11133 @kindex R (Article)
11134 @findex gnus-article-reply-with-original
11135 Send a reply to the current article and yank the current article
11136 (@code{gnus-article-reply-with-original}). If given a prefix, make a
11137 wide reply. If the region is active, only yank the text in the
11141 @kindex F (Article)
11142 @findex gnus-article-followup-with-original
11143 Send a followup to the current article and yank the current article
11144 (@code{gnus-article-followup-with-original}). If given a prefix, make
11145 a wide reply. If the region is active, only yank the text in the
11153 @section Misc Article
11157 @item gnus-single-article-buffer
11158 @vindex gnus-single-article-buffer
11159 If non-@code{nil}, use the same article buffer for all the groups.
11160 (This is the default.) If @code{nil}, each group will have its own
11163 @vindex gnus-article-decode-hook
11164 @item gnus-article-decode-hook
11165 @cindex @acronym{MIME}
11166 Hook used to decode @acronym{MIME} articles. The default value is
11167 @code{(article-decode-charset article-decode-encoded-words)}
11169 @vindex gnus-article-prepare-hook
11170 @item gnus-article-prepare-hook
11171 This hook is called right after the article has been inserted into the
11172 article buffer. It is mainly intended for functions that do something
11173 depending on the contents; it should probably not be used for changing
11174 the contents of the article buffer.
11176 @item gnus-article-mode-hook
11177 @vindex gnus-article-mode-hook
11178 Hook called in article mode buffers.
11180 @item gnus-article-mode-syntax-table
11181 @vindex gnus-article-mode-syntax-table
11182 Syntax table used in article buffers. It is initialized from
11183 @code{text-mode-syntax-table}.
11185 @vindex gnus-article-over-scroll
11186 @item gnus-article-over-scroll
11187 If non-@code{nil}, allow scrolling the article buffer even when there
11188 no more new text to scroll in. The default is @code{nil}.
11190 @vindex gnus-article-mode-line-format
11191 @item gnus-article-mode-line-format
11192 This variable is a format string along the same lines as
11193 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}). It
11194 accepts the same format specifications as that variable, with two
11200 The @dfn{wash status} of the article. This is a short string with one
11201 character for each possible article wash operation that may have been
11202 performed. The characters and their meaning:
11207 Displayed when cited text may be hidden in the article buffer.
11210 Displayed when headers are hidden in the article buffer.
11213 Displayed when article is digitally signed or encrypted, and Gnus has
11214 hidden the security headers. (N.B. does not tell anything about
11215 security status, i.e. good or bad signature.)
11218 Displayed when the signature has been hidden in the Article buffer.
11221 Displayed when Gnus has treated overstrike characters in the article buffer.
11224 Displayed when Gnus has treated emphasised strings in the article buffer.
11229 The number of @acronym{MIME} parts in the article.
11233 @vindex gnus-break-pages
11235 @item gnus-break-pages
11236 Controls whether @dfn{page breaking} is to take place. If this variable
11237 is non-@code{nil}, the articles will be divided into pages whenever a
11238 page delimiter appears in the article. If this variable is @code{nil},
11239 paging will not be done.
11241 @item gnus-page-delimiter
11242 @vindex gnus-page-delimiter
11243 This is the delimiter mentioned above. By default, it is @samp{^L}
11247 @cindex internationalized domain names
11248 @vindex gnus-use-idna
11249 @item gnus-use-idna
11250 This variable controls whether Gnus performs IDNA decoding of
11251 internationalized domain names inside @samp{From}, @samp{To} and
11252 @samp{Cc} headers. This requires
11253 @uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this
11254 variable is only enabled if you have installed it.
11259 @node Composing Messages
11260 @chapter Composing Messages
11261 @cindex composing messages
11264 @cindex sending mail
11269 @cindex using s/mime
11270 @cindex using smime
11272 @kindex C-c C-c (Post)
11273 All commands for posting and mailing will put you in a message buffer
11274 where you can edit the article all you like, before you send the
11275 article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message,
11276 Message Manual}. Where the message will be posted/mailed to depends
11277 on your setup (@pxref{Posting Server}).
11280 * Mail:: Mailing and replying.
11281 * Posting Server:: What server should you post and mail via?
11282 * Mail and Post:: Mailing and posting at the same time.
11283 * Archived Messages:: Where Gnus stores the messages you've sent.
11284 * Posting Styles:: An easier way to specify who you are.
11285 * Drafts:: Postponing messages and rejected messages.
11286 * Rejected Articles:: What happens if the server doesn't like your article?
11287 * Signing and encrypting:: How to compose secure messages.
11290 Also @pxref{Canceling and Superseding} for information on how to
11291 remove articles you shouldn't have posted.
11297 Variables for customizing outgoing mail:
11300 @item gnus-uu-digest-headers
11301 @vindex gnus-uu-digest-headers
11302 List of regexps to match headers included in digested messages. The
11303 headers will be included in the sequence they are matched. If
11304 @code{nil} include all headers.
11306 @item gnus-add-to-list
11307 @vindex gnus-add-to-list
11308 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
11309 that have none when you do a @kbd{a}.
11311 @item gnus-confirm-mail-reply-to-news
11312 @vindex gnus-confirm-mail-reply-to-news
11313 This can also be a function receiving the group name as the only
11314 parameter which should return non-@code{nil} if a confirmation is
11315 needed, or a regular expression matching group names, where
11316 confirmation is should be asked for.
11318 If you find yourself never wanting to reply to mail, but occasionally
11319 press R anyway, this variable might be for you.
11321 @item gnus-confirm-treat-mail-like-news
11322 @vindex gnus-confirm-treat-mail-like-news
11323 If non-@code{nil}, Gnus also requests confirmation according to
11324 @code{gnus-confirm-mail-reply-to-news} when replying to mail. This is
11325 useful for treating mailing lists like newsgroups.
11330 @node Posting Server
11331 @section Posting Server
11333 When you press those magical @kbd{C-c C-c} keys to ship off your latest
11334 (extremely intelligent, of course) article, where does it go?
11336 Thank you for asking. I hate you.
11338 It can be quite complicated.
11340 @vindex gnus-post-method
11341 When posting news, Message usually invokes @code{message-send-news}
11342 (@pxref{News Variables, , News Variables, message, Message Manual}).
11343 Normally, Gnus will post using the same select method as you're
11344 reading from (which might be convenient if you're reading lots of
11345 groups from different private servers). However. If the server
11346 you're reading from doesn't allow posting, just reading, you probably
11347 want to use some other server to post your (extremely intelligent and
11348 fabulously interesting) articles. You can then set the
11349 @code{gnus-post-method} to some other method:
11352 (setq gnus-post-method '(nnspool ""))
11355 Now, if you've done this, and then this server rejects your article, or
11356 this server is down, what do you do then? To override this variable you
11357 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
11358 the ``current'' server, to get back the default behavior, for posting.
11360 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
11361 gnus will prompt you for what method to use for posting.
11363 You can also set @code{gnus-post-method} to a list of select methods.
11364 If that's the case, gnus will always prompt you for what method to use
11367 Finally, if you want to always post using the native select method,
11368 you can set this variable to @code{native}.
11370 When sending mail, Message invokes @code{message-send-mail-function}.
11371 The default function, @code{message-send-mail-with-sendmail}, pipes
11372 your article to the @code{sendmail} binary for further queuing and
11373 sending. When your local system is not configured for sending mail
11374 using @code{sendmail}, and you have access to a remote @acronym{SMTP}
11375 server, you can set @code{message-send-mail-function} to
11376 @code{smtpmail-send-it} and make sure to setup the @code{smtpmail}
11377 package correctly. An example:
11380 (setq message-send-mail-function 'smtpmail-send-it
11381 smtpmail-default-smtp-server "YOUR SMTP HOST")
11382 ;; The following variable needs to be set because of the FLIM version of
11383 ;; smtpmail.el. Which smtpmail.el is used depends on the `load-path'.
11384 (setq smtp-default-smtp-server "YOUR SMTP HOST")
11387 To the thing similar to this, there is
11388 @code{message-smtpmail-send-it}. It is useful if your ISP requires
11389 the @acronym{POP}-before-@acronym{SMTP} authentication. See the
11390 documentation for the function @code{mail-source-touch-pop}.
11392 Other possible choices for @code{message-send-mail-function} includes
11393 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
11394 and @code{feedmail-send-it}.
11396 @node Mail and Post
11397 @section Mail and Post
11399 Here's a list of variables relevant to both mailing and
11403 @item gnus-mailing-list-groups
11404 @findex gnus-mailing-list-groups
11405 @cindex mailing lists
11407 If your news server offers groups that are really mailing lists
11408 gatewayed to the @acronym{NNTP} server, you can read those groups without
11409 problems, but you can't post/followup to them without some difficulty.
11410 One solution is to add a @code{to-address} to the group parameters
11411 (@pxref{Group Parameters}). An easier thing to do is set the
11412 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
11413 really are mailing lists. Then, at least, followups to the mailing
11414 lists will work most of the time. Posting to these groups (@kbd{a}) is
11415 still a pain, though.
11417 @item gnus-user-agent
11418 @vindex gnus-user-agent
11421 This variable controls which information should be exposed in the
11422 User-Agent header. It can be one of the symbols @code{gnus} (show only
11423 Gnus version), @code{emacs-gnus} (show only Emacs and Gnus versions),
11424 @code{emacs-gnus-config} (same as @code{emacs-gnus} plus system
11425 configuration), @code{emacs-gnus-type} (same as @code{emacs-gnus} plus
11426 system type) or a custom string. If you set it to a string, be sure to
11427 use a valid format, see RFC 2616.
11431 You may want to do spell-checking on messages that you send out. Or, if
11432 you don't want to spell-check by hand, you could add automatic
11433 spell-checking via the @code{ispell} package:
11436 @findex ispell-message
11438 (add-hook 'message-send-hook 'ispell-message)
11441 If you want to change the @code{ispell} dictionary based on what group
11442 you're in, you could say something like the following:
11445 (add-hook 'gnus-select-group-hook
11449 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
11450 (ispell-change-dictionary "deutsch"))
11452 (ispell-change-dictionary "english")))))
11455 Modify to suit your needs.
11458 @node Archived Messages
11459 @section Archived Messages
11460 @cindex archived messages
11461 @cindex sent messages
11463 Gnus provides a few different methods for storing the mail and news you
11464 send. The default method is to use the @dfn{archive virtual server} to
11465 store the messages. If you want to disable this completely, the
11466 @code{gnus-message-archive-group} variable should be @code{nil}, which
11469 For archiving interesting messages in a group you read, see the
11470 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
11473 @vindex gnus-message-archive-method
11474 @code{gnus-message-archive-method} says what virtual server gnus is to
11475 use to store sent messages. The default is:
11478 (nnfolder "archive"
11479 (nnfolder-directory "~/Mail/archive")
11480 (nnfolder-active-file "~/Mail/archive/active")
11481 (nnfolder-get-new-mail nil)
11482 (nnfolder-inhibit-expiry t))
11485 You can, however, use any mail select method (@code{nnml},
11486 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
11487 for doing this sort of thing, though. If you don't like the default
11488 directory chosen, you could say something like:
11491 (setq gnus-message-archive-method
11492 '(nnfolder "archive"
11493 (nnfolder-inhibit-expiry t)
11494 (nnfolder-active-file "~/News/sent-mail/active")
11495 (nnfolder-directory "~/News/sent-mail/")))
11498 @vindex gnus-message-archive-group
11500 Gnus will insert @code{Gcc} headers in all outgoing messages that point
11501 to one or more group(s) on that server. Which group to use is
11502 determined by the @code{gnus-message-archive-group} variable.
11504 This variable can be used to do the following:
11508 Messages will be saved in that group.
11510 Note that you can include a select method in the group name, then the
11511 message will not be stored in the select method given by
11512 @code{gnus-message-archive-method}, but in the select method specified
11513 by the group name, instead. Suppose @code{gnus-message-archive-method}
11514 has the default value shown above. Then setting
11515 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
11516 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
11517 value @code{"nnml:foo"}, then outgoing messages will be stored in
11520 @item a list of strings
11521 Messages will be saved in all those groups.
11523 @item an alist of regexps, functions and forms
11524 When a key ``matches'', the result is used.
11527 No message archiving will take place. This is the default.
11532 Just saving to a single group called @samp{MisK}:
11534 (setq gnus-message-archive-group "MisK")
11537 Saving to two groups, @samp{MisK} and @samp{safe}:
11539 (setq gnus-message-archive-group '("MisK" "safe"))
11542 Save to different groups based on what group you are in:
11544 (setq gnus-message-archive-group
11545 '(("^alt" "sent-to-alt")
11546 ("mail" "sent-to-mail")
11547 (".*" "sent-to-misc")))
11550 More complex stuff:
11552 (setq gnus-message-archive-group
11553 '((if (message-news-p)
11558 How about storing all news messages in one file, but storing all mail
11559 messages in one file per month:
11562 (setq gnus-message-archive-group
11563 '((if (message-news-p)
11565 (concat "mail." (format-time-string "%Y-%m")))))
11568 @c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
11569 @c use a different value for @code{gnus-message-archive-group} there.)
11571 Now, when you send a message off, it will be stored in the appropriate
11572 group. (If you want to disable storing for just one particular message,
11573 you can just remove the @code{Gcc} header that has been inserted.) The
11574 archive group will appear in the group buffer the next time you start
11575 gnus, or the next time you press @kbd{F} in the group buffer. You can
11576 enter it and read the articles in it just like you'd read any other
11577 group. If the group gets really big and annoying, you can simply rename
11578 if (using @kbd{G r} in the group buffer) to something
11579 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
11580 continue to be stored in the old (now empty) group.
11582 That's the default method of archiving sent messages. Gnus offers a
11583 different way for the people who don't like the default method. In that
11584 case you should set @code{gnus-message-archive-group} to @code{nil};
11585 this will disable archiving.
11588 @item gnus-outgoing-message-group
11589 @vindex gnus-outgoing-message-group
11590 All outgoing messages will be put in this group. If you want to store
11591 all your outgoing mail and articles in the group @samp{nnml:archive},
11592 you set this variable to that value. This variable can also be a list of
11595 If you want to have greater control over what group to put each
11596 message in, you can set this variable to a function that checks the
11597 current newsgroup name and then returns a suitable group name (or list
11600 This variable can be used instead of @code{gnus-message-archive-group},
11601 but the latter is the preferred method.
11603 @item gnus-gcc-mark-as-read
11604 @vindex gnus-gcc-mark-as-read
11605 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
11607 @item gnus-gcc-externalize-attachments
11608 @vindex gnus-gcc-externalize-attachments
11609 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
11610 and matches the Gcc group name, attach files as external parts; if it is
11611 @code{all}, attach local files as external parts; if it is other
11612 non-@code{nil}, the behavior is the same as @code{all}, but it may be
11613 changed in the future.
11618 @node Posting Styles
11619 @section Posting Styles
11620 @cindex posting styles
11623 All them variables, they make my head swim.
11625 So what if you want a different @code{Organization} and signature based
11626 on what groups you post to? And you post both from your home machine
11627 and your work machine, and you want different @code{From} lines, and so
11630 @vindex gnus-posting-styles
11631 One way to do stuff like that is to write clever hooks that change the
11632 variables you need to have changed. That's a bit boring, so somebody
11633 came up with the bright idea of letting the user specify these things in
11634 a handy alist. Here's an example of a @code{gnus-posting-styles}
11639 (signature "Peace and happiness")
11640 (organization "What me?"))
11642 (signature "Death to everybody"))
11643 ("comp.emacs.i-love-it"
11644 (organization "Emacs is it")))
11647 As you might surmise from this example, this alist consists of several
11648 @dfn{styles}. Each style will be applicable if the first element
11649 ``matches'', in some form or other. The entire alist will be iterated
11650 over, from the beginning towards the end, and each match will be
11651 applied, which means that attributes in later styles that match override
11652 the same attributes in earlier matching styles. So
11653 @samp{comp.programming.literate} will have the @samp{Death to everybody}
11654 signature and the @samp{What me?} @code{Organization} header.
11656 The first element in each style is called the @code{match}. If it's a
11657 string, then Gnus will try to regexp match it against the group name.
11658 If it is the form @code{(header @var{match} @var{regexp})}, then Gnus
11659 will look in the original article for a header whose name is
11660 @var{match} and compare that @var{regexp}. @var{match} and
11661 @var{regexp} are strings. (The original article is the one you are
11662 replying or following up to. If you are not composing a reply or a
11663 followup, then there is nothing to match against.) If the
11664 @code{match} is a function symbol, that function will be called with
11665 no arguments. If it's a variable symbol, then the variable will be
11666 referenced. If it's a list, then that list will be @code{eval}ed. In
11667 any case, if this returns a non-@code{nil} value, then the style is
11668 said to @dfn{match}.
11670 Each style may contain an arbitrary amount of @dfn{attributes}. Each
11671 attribute consists of a @code{(@var{name} @var{value})} pair. The
11672 attribute name can be one of:
11675 @item @code{signature}
11676 @item @code{signature-file}
11677 @item @code{x-face-file}
11678 @item @code{address}, overriding @code{user-mail-address}
11679 @item @code{name}, overriding @code{(user-full-name)}
11683 The attribute name can also be a string or a symbol. In that case,
11684 this will be used as a header name, and the value will be inserted in
11685 the headers of the article; if the value is @code{nil}, the header
11686 name will be removed. If the attribute name is @code{eval}, the form
11687 is evaluated, and the result is thrown away.
11689 The attribute value can be a string (used verbatim), a function with
11690 zero arguments (the return value will be used), a variable (its value
11691 will be used) or a list (it will be @code{eval}ed and the return value
11692 will be used). The functions and sexps are called/@code{eval}ed in the
11693 message buffer that is being set up. The headers of the current article
11694 are available through the @code{message-reply-headers} variable, which
11695 is a vector of the following headers: number subject from date id
11696 references chars lines xref extra.
11698 @vindex message-reply-headers
11700 If you wish to check whether the message you are about to compose is
11701 meant to be a news article or a mail message, you can check the values
11702 of the @code{message-news-p} and @code{message-mail-p} functions.
11704 @findex message-mail-p
11705 @findex message-news-p
11707 So here's a new example:
11710 (setq gnus-posting-styles
11712 (signature-file "~/.signature")
11714 ("X-Home-Page" (getenv "WWW_HOME"))
11715 (organization "People's Front Against MWM"))
11717 (signature my-funny-signature-randomizer))
11718 ((equal (system-name) "gnarly") ;; @r{A form}
11719 (signature my-quote-randomizer))
11720 (message-news-p ;; @r{A function symbol}
11721 (signature my-news-signature))
11722 (window-system ;; @r{A value symbol}
11723 ("X-Window-System" (format "%s" window-system)))
11724 ;; @r{If I'm replying to Larsi, set the Organization header.}
11725 ((header "from" "larsi.*org")
11726 (Organization "Somewhere, Inc."))
11727 ((posting-from-work-p) ;; @r{A user defined function}
11728 (signature-file "~/.work-signature")
11729 (address "user@@bar.foo")
11730 (body "You are fired.\n\nSincerely, your boss.")
11731 (organization "Important Work, Inc"))
11733 (From (save-excursion
11734 (set-buffer gnus-article-buffer)
11735 (message-fetch-field "to"))))
11737 (signature-file "~/.mail-signature"))))
11740 The @samp{nnml:.*} rule means that you use the @code{To} address as the
11741 @code{From} address in all your outgoing replies, which might be handy
11742 if you fill many roles.
11744 Setting the @code{gnus-named-posting-styles} variable will make
11745 posting-styles allow to have distinctive names. You can specify an
11746 arbitrary posting-style when article posting with @kbd{S P} in the
11747 summary buffer. @code{gnus-named-posting-styles} is an alist which maps
11748 the names to styles. Once a posting-style is added to the alist, we can
11749 import it from @code{gnus-posting-styles}. If an attribute whose name
11750 is @code{import} is found, Gnus will look for the attribute value in
11751 @code{gnus-named-posting-styles} and expand it in place.
11756 (setq gnus-named-posting-styles
11758 (signature-file "~/.signature")
11760 ("X-Home-Page" (getenv "WWW_HOME"))
11761 (organization "People's Front Against MWM"))
11764 (organization "The Church of Emacs"))))
11767 The posting-style named "Emacs" will inherit all the attributes from
11768 "Default" except @code{organization}.
11775 If you are writing a message (mail or news) and suddenly remember that
11776 you have a steak in the oven (or some pesto in the food processor, you
11777 craaazy vegetarians), you'll probably wish there was a method to save
11778 the message you are writing so that you can continue editing it some
11779 other day, and send it when you feel its finished.
11781 Well, don't worry about it. Whenever you start composing a message of
11782 some sort using the gnus mail and post commands, the buffer you get will
11783 automatically associate to an article in a special @dfn{draft} group.
11784 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
11785 article will be saved there. (Auto-save files also go to the draft
11789 @vindex nndraft-directory
11790 The draft group is a special group (which is implemented as an
11791 @code{nndraft} group, if you absolutely have to know) called
11792 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
11793 @code{nndraft} is to store its files. What makes this group special is
11794 that you can't tick any articles in it or mark any articles as
11795 read---all articles in the group are permanently unread.
11797 If the group doesn't exist, it will be created and you'll be subscribed
11798 to it. The only way to make it disappear from the Group buffer is to
11799 unsubscribe it. The special properties of the draft group comes from
11800 a group property (@pxref{Group Parameters}), and if lost the group
11801 behaves like any other group. This means the commands below will not
11802 be available. To restore the special properties of the group, the
11803 simplest way is to kill the group, using @kbd{C-k}, and restart
11804 Gnus. The group is automatically created again with the
11805 correct parameters. The content of the group is not lost.
11807 @c @findex gnus-dissociate-buffer-from-draft
11808 @c @kindex C-c M-d (Mail)
11809 @c @kindex C-c M-d (Post)
11810 @c @findex gnus-associate-buffer-with-draft
11811 @c @kindex C-c C-d (Mail)
11812 @c @kindex C-c C-d (Post)
11813 @c If you're writing some super-secret message that you later want to
11814 @c encode with PGP before sending, you may wish to turn the auto-saving
11815 @c (and association with the draft group) off. You never know who might be
11816 @c interested in reading all your extremely valuable and terribly horrible
11817 @c and interesting secrets. The @kbd{C-c M-d}
11818 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
11819 @c If you change your mind and want to turn the auto-saving back on again,
11820 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
11822 @c @vindex gnus-use-draft
11823 @c To leave association with the draft group off by default, set
11824 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
11826 @findex gnus-draft-edit-message
11827 @kindex D e (Draft)
11828 When you want to continue editing the article, you simply enter the
11829 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
11830 that. You will be placed in a buffer where you left off.
11832 Rejected articles will also be put in this draft group (@pxref{Rejected
11835 @findex gnus-draft-send-all-messages
11836 @kindex D s (Draft)
11837 @findex gnus-draft-send-message
11838 @kindex D S (Draft)
11839 If you have lots of rejected messages you want to post (or mail) without
11840 doing further editing, you can use the @kbd{D s} command
11841 (@code{gnus-draft-send-message}). This command understands the
11842 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
11843 command (@code{gnus-draft-send-all-messages}) will ship off all messages
11846 @findex gnus-draft-toggle-sending
11847 @kindex D t (Draft)
11848 If you have some messages that you wish not to send, you can use the
11849 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
11850 as unsendable. This is a toggling command.
11853 @node Rejected Articles
11854 @section Rejected Articles
11855 @cindex rejected articles
11857 Sometimes a news server will reject an article. Perhaps the server
11858 doesn't like your face. Perhaps it just feels miserable. Perhaps
11859 @emph{there be demons}. Perhaps you have included too much cited text.
11860 Perhaps the disk is full. Perhaps the server is down.
11862 These situations are, of course, totally beyond the control of gnus.
11863 (Gnus, of course, loves the way you look, always feels great, has angels
11864 fluttering around inside of it, doesn't care about how much cited text
11865 you include, never runs full and never goes down.) So gnus saves these
11866 articles until some later time when the server feels better.
11868 The rejected articles will automatically be put in a special draft group
11869 (@pxref{Drafts}). When the server comes back up again, you'd then
11870 typically enter that group and send all the articles off.
11872 @node Signing and encrypting
11873 @section Signing and encrypting
11875 @cindex using s/mime
11876 @cindex using smime
11878 Gnus can digitally sign and encrypt your messages, using vanilla
11879 @acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}. For
11880 decoding such messages, see the @code{mm-verify-option} and
11881 @code{mm-decrypt-option} options (@pxref{Security}).
11883 @vindex gnus-message-replysign
11884 @vindex gnus-message-replyencrypt
11885 @vindex gnus-message-replysignencrypted
11886 Often, you would like to sign replies to people who send you signed
11887 messages. Even more often, you might want to encrypt messages which
11888 are in reply to encrypted messages. Gnus offers
11889 @code{gnus-message-replysign} to enable the former, and
11890 @code{gnus-message-replyencrypt} for the latter. In addition, setting
11891 @code{gnus-message-replysignencrypted} (on by default) will sign
11892 automatically encrypted messages.
11894 Instructing @acronym{MML} to perform security operations on a
11895 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
11896 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
11901 @kindex C-c C-m s s (Message)
11902 @findex mml-secure-message-sign-smime
11904 Digitally sign current message using @acronym{S/MIME}.
11907 @kindex C-c C-m s o (Message)
11908 @findex mml-secure-message-sign-pgp
11910 Digitally sign current message using @acronym{PGP}.
11913 @kindex C-c C-m s p (Message)
11914 @findex mml-secure-message-sign-pgp
11916 Digitally sign current message using @acronym{PGP/MIME}.
11919 @kindex C-c C-m c s (Message)
11920 @findex mml-secure-message-encrypt-smime
11922 Digitally encrypt current message using @acronym{S/MIME}.
11925 @kindex C-c C-m c o (Message)
11926 @findex mml-secure-message-encrypt-pgp
11928 Digitally encrypt current message using @acronym{PGP}.
11931 @kindex C-c C-m c p (Message)
11932 @findex mml-secure-message-encrypt-pgpmime
11934 Digitally encrypt current message using @acronym{PGP/MIME}.
11937 @kindex C-c C-m C-n (Message)
11938 @findex mml-unsecure-message
11939 Remove security related @acronym{MML} tags from message.
11943 @xref{Security, ,Security, message, Message Manual}, for more information.
11945 @node Select Methods
11946 @chapter Select Methods
11947 @cindex foreign groups
11948 @cindex select methods
11950 A @dfn{foreign group} is a group not read by the usual (or
11951 default) means. It could be, for instance, a group from a different
11952 @acronym{NNTP} server, it could be a virtual group, or it could be your own
11953 personal mail group.
11955 A foreign group (or any group, really) is specified by a @dfn{name} and
11956 a @dfn{select method}. To take the latter first, a select method is a
11957 list where the first element says what back end to use (e.g. @code{nntp},
11958 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
11959 name}. There may be additional elements in the select method, where the
11960 value may have special meaning for the back end in question.
11962 One could say that a select method defines a @dfn{virtual server}---so
11963 we do just that (@pxref{Server Buffer}).
11965 The @dfn{name} of the group is the name the back end will recognize the
11968 For instance, the group @samp{soc.motss} on the @acronym{NNTP} server
11969 @samp{some.where.edu} will have the name @samp{soc.motss} and select
11970 method @code{(nntp "some.where.edu")}. Gnus will call this group
11971 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
11972 back end just knows this group as @samp{soc.motss}.
11974 The different methods all have their peculiarities, of course.
11977 * Server Buffer:: Making and editing virtual servers.
11978 * Getting News:: Reading USENET news with Gnus.
11979 * Getting Mail:: Reading your personal mail with Gnus.
11980 * Browsing the Web:: Getting messages from a plethora of Web sources.
11981 * IMAP:: Using Gnus as a @acronym{IMAP} client.
11982 * Other Sources:: Reading directories, files, SOUP packets.
11983 * Combined Groups:: Combining groups into one group.
11984 * Gnus Unplugged:: Reading news and mail offline.
11988 @node Server Buffer
11989 @section Server Buffer
11991 Traditionally, a @dfn{server} is a machine or a piece of software that
11992 one connects to, and then requests information from. Gnus does not
11993 connect directly to any real servers, but does all transactions through
11994 one back end or other. But that's just putting one layer more between
11995 the actual media and Gnus, so we might just as well say that each
11996 back end represents a virtual server.
11998 For instance, the @code{nntp} back end may be used to connect to several
11999 different actual @acronym{NNTP} servers, or, perhaps, to many different ports
12000 on the same actual @acronym{NNTP} server. You tell Gnus which back end to
12001 use, and what parameters to set by specifying a @dfn{select method}.
12003 These select method specifications can sometimes become quite
12004 complicated---say, for instance, that you want to read from the
12005 @acronym{NNTP} server @samp{news.funet.fi} on port number 13, which
12006 hangs if queried for @acronym{NOV} headers and has a buggy select. Ahem.
12007 Anyway, if you had to specify that for each group that used this
12008 server, that would be too much work, so Gnus offers a way of naming
12009 select methods, which is what you do in the server buffer.
12011 To enter the server buffer, use the @kbd{^}
12012 (@code{gnus-group-enter-server-mode}) command in the group buffer.
12015 * Server Buffer Format:: You can customize the look of this buffer.
12016 * Server Commands:: Commands to manipulate servers.
12017 * Example Methods:: Examples server specifications.
12018 * Creating a Virtual Server:: An example session.
12019 * Server Variables:: Which variables to set.
12020 * Servers and Methods:: You can use server names as select methods.
12021 * Unavailable Servers:: Some servers you try to contact may be down.
12024 @vindex gnus-server-mode-hook
12025 @code{gnus-server-mode-hook} is run when creating the server buffer.
12028 @node Server Buffer Format
12029 @subsection Server Buffer Format
12030 @cindex server buffer format
12032 @vindex gnus-server-line-format
12033 You can change the look of the server buffer lines by changing the
12034 @code{gnus-server-line-format} variable. This is a @code{format}-like
12035 variable, with some simple extensions:
12040 How the news is fetched---the back end name.
12043 The name of this server.
12046 Where the news is to be fetched from---the address.
12049 The opened/closed/denied status of the server.
12052 @vindex gnus-server-mode-line-format
12053 The mode line can also be customized by using the
12054 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
12055 Formatting}). The following specs are understood:
12065 Also @pxref{Formatting Variables}.
12068 @node Server Commands
12069 @subsection Server Commands
12070 @cindex server commands
12076 @findex gnus-server-add-server
12077 Add a new server (@code{gnus-server-add-server}).
12081 @findex gnus-server-edit-server
12082 Edit a server (@code{gnus-server-edit-server}).
12085 @kindex SPACE (Server)
12086 @findex gnus-server-read-server
12087 Browse the current server (@code{gnus-server-read-server}).
12091 @findex gnus-server-exit
12092 Return to the group buffer (@code{gnus-server-exit}).
12096 @findex gnus-server-kill-server
12097 Kill the current server (@code{gnus-server-kill-server}).
12101 @findex gnus-server-yank-server
12102 Yank the previously killed server (@code{gnus-server-yank-server}).
12106 @findex gnus-server-copy-server
12107 Copy the current server (@code{gnus-server-copy-server}).
12111 @findex gnus-server-list-servers
12112 List all servers (@code{gnus-server-list-servers}).
12116 @findex gnus-server-scan-server
12117 Request that the server scan its sources for new articles
12118 (@code{gnus-server-scan-server}). This is mainly sensible with mail
12123 @findex gnus-server-regenerate-server
12124 Request that the server regenerate all its data structures
12125 (@code{gnus-server-regenerate-server}). This can be useful if you have
12126 a mail back end that has gotten out of sync.
12131 @node Example Methods
12132 @subsection Example Methods
12134 Most select methods are pretty simple and self-explanatory:
12137 (nntp "news.funet.fi")
12140 Reading directly from the spool is even simpler:
12146 As you can see, the first element in a select method is the name of the
12147 back end, and the second is the @dfn{address}, or @dfn{name}, if you
12150 After these two elements, there may be an arbitrary number of
12151 @code{(@var{variable} @var{form})} pairs.
12153 To go back to the first example---imagine that you want to read from
12154 port 15 on that machine. This is what the select method should
12158 (nntp "news.funet.fi" (nntp-port-number 15))
12161 You should read the documentation to each back end to find out what
12162 variables are relevant, but here's an @code{nnmh} example:
12164 @code{nnmh} is a mail back end that reads a spool-like structure. Say
12165 you have two structures that you wish to access: One is your private
12166 mail spool, and the other is a public one. Here's the possible spec for
12170 (nnmh "private" (nnmh-directory "~/private/mail/"))
12173 (This server is then called @samp{private}, but you may have guessed
12176 Here's the method for a public spool:
12180 (nnmh-directory "/usr/information/spool/")
12181 (nnmh-get-new-mail nil))
12187 If you are behind a firewall and only have access to the @acronym{NNTP}
12188 server from the firewall machine, you can instruct Gnus to @code{rlogin}
12189 on the firewall machine and telnet from there to the @acronym{NNTP} server.
12190 Doing this can be rather fiddly, but your virtual server definition
12191 should probably look something like this:
12195 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
12196 (nntp-via-address "the.firewall.machine")
12197 (nntp-address "the.real.nntp.host")
12198 (nntp-end-of-line "\n"))
12201 If you want to use the wonderful @code{ssh} program to provide a
12202 compressed connection over the modem line, you could add the following
12203 configuration to the example above:
12206 (nntp-via-rlogin-command "ssh")
12209 See also @code{nntp-via-rlogin-command-switches}.
12211 If you're behind a firewall, but have direct access to the outside world
12212 through a wrapper command like "runsocks", you could open a socksified
12213 telnet connection to the news server as follows:
12217 (nntp-pre-command "runsocks")
12218 (nntp-open-connection-function nntp-open-via-telnet)
12219 (nntp-address "the.news.server")
12220 (nntp-end-of-line "\n"))
12223 This means that you have to have set up @code{ssh-agent} correctly to
12224 provide automatic authorization, of course. And to get a compressed
12225 connection, you have to have the @samp{Compression} option in the
12226 @code{ssh} @file{config} file.
12229 @node Creating a Virtual Server
12230 @subsection Creating a Virtual Server
12232 If you're saving lots of articles in the cache by using persistent
12233 articles, you may want to create a virtual server to read the cache.
12235 First you need to add a new server. The @kbd{a} command does that. It
12236 would probably be best to use @code{nnml} to read the cache. You
12237 could also use @code{nnspool} or @code{nnmh}, though.
12239 Type @kbd{a nnml RET cache RET}.
12241 You should now have a brand new @code{nnml} virtual server called
12242 @samp{cache}. You now need to edit it to have the right definitions.
12243 Type @kbd{e} to edit the server. You'll be entered into a buffer that
12244 will contain the following:
12254 (nnml-directory "~/News/cache/")
12255 (nnml-active-file "~/News/cache/active"))
12258 Type @kbd{C-c C-c} to return to the server buffer. If you now press
12259 @kbd{RET} over this virtual server, you should be entered into a browse
12260 buffer, and you should be able to enter any of the groups displayed.
12263 @node Server Variables
12264 @subsection Server Variables
12265 @cindex server variables
12266 @cindex server parameters
12268 One sticky point when defining variables (both on back ends and in Emacs
12269 in general) is that some variables are typically initialized from other
12270 variables when the definition of the variables is being loaded. If you
12271 change the ``base'' variable after the variables have been loaded, you
12272 won't change the ``derived'' variables.
12274 This typically affects directory and file variables. For instance,
12275 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
12276 directory variables are initialized from that variable, so
12277 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
12278 new virtual @code{nnml} server, it will @emph{not} suffice to set just
12279 @code{nnml-directory}---you have to explicitly set all the file
12280 variables to be what you want them to be. For a complete list of
12281 variables for each back end, see each back end's section later in this
12282 manual, but here's an example @code{nnml} definition:
12286 (nnml-directory "~/my-mail/")
12287 (nnml-active-file "~/my-mail/active")
12288 (nnml-newsgroups-file "~/my-mail/newsgroups"))
12291 Server variables are often called @dfn{server parameters}.
12293 @node Servers and Methods
12294 @subsection Servers and Methods
12296 Wherever you would normally use a select method
12297 (e.g. @code{gnus-secondary-select-method}, in the group select method,
12298 when browsing a foreign server) you can use a virtual server name
12299 instead. This could potentially save lots of typing. And it's nice all
12303 @node Unavailable Servers
12304 @subsection Unavailable Servers
12306 If a server seems to be unreachable, Gnus will mark that server as
12307 @code{denied}. That means that any subsequent attempt to make contact
12308 with that server will just be ignored. ``It can't be opened,'' Gnus
12309 will tell you, without making the least effort to see whether that is
12310 actually the case or not.
12312 That might seem quite naughty, but it does make sense most of the time.
12313 Let's say you have 10 groups subscribed to on server
12314 @samp{nephelococcygia.com}. This server is located somewhere quite far
12315 away from you and the machine is quite slow, so it takes 1 minute just
12316 to find out that it refuses connection to you today. If Gnus were to
12317 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
12318 attempt to do that. Once it has gotten a single ``connection refused'',
12319 it will regard that server as ``down''.
12321 So, what happens if the machine was only feeling unwell temporarily?
12322 How do you test to see whether the machine has come up again?
12324 You jump to the server buffer (@pxref{Server Buffer}) and poke it
12325 with the following commands:
12331 @findex gnus-server-open-server
12332 Try to establish connection to the server on the current line
12333 (@code{gnus-server-open-server}).
12337 @findex gnus-server-close-server
12338 Close the connection (if any) to the server
12339 (@code{gnus-server-close-server}).
12343 @findex gnus-server-deny-server
12344 Mark the current server as unreachable
12345 (@code{gnus-server-deny-server}).
12348 @kindex M-o (Server)
12349 @findex gnus-server-open-all-servers
12350 Open the connections to all servers in the buffer
12351 (@code{gnus-server-open-all-servers}).
12354 @kindex M-c (Server)
12355 @findex gnus-server-close-all-servers
12356 Close the connections to all servers in the buffer
12357 (@code{gnus-server-close-all-servers}).
12361 @findex gnus-server-remove-denials
12362 Remove all marks to whether Gnus was denied connection from any servers
12363 (@code{gnus-server-remove-denials}).
12367 @findex gnus-server-offline-server
12368 Set server status to offline (@code{gnus-server-offline-server}).
12374 @section Getting News
12375 @cindex reading news
12376 @cindex news back ends
12378 A newsreader is normally used for reading news. Gnus currently provides
12379 only two methods of getting news---it can read from an @acronym{NNTP} server,
12380 or it can read from a local spool.
12383 * NNTP:: Reading news from an @acronym{NNTP} server.
12384 * News Spool:: Reading news from the local spool.
12392 Subscribing to a foreign group from an @acronym{NNTP} server is rather easy.
12393 You just specify @code{nntp} as method and the address of the @acronym{NNTP}
12394 server as the, uhm, address.
12396 If the @acronym{NNTP} server is located at a non-standard port, setting the
12397 third element of the select method to this port number should allow you
12398 to connect to the right port. You'll have to edit the group info for
12399 that (@pxref{Foreign Groups}).
12401 The name of the foreign group can be the same as a native group. In
12402 fact, you can subscribe to the same group from as many different servers
12403 you feel like. There will be no name collisions.
12405 The following variables can be used to create a virtual @code{nntp}
12410 @item nntp-server-opened-hook
12411 @vindex nntp-server-opened-hook
12412 @cindex @sc{mode reader}
12414 @cindex authentification
12415 @cindex nntp authentification
12416 @findex nntp-send-authinfo
12417 @findex nntp-send-mode-reader
12418 is run after a connection has been made. It can be used to send
12419 commands to the @acronym{NNTP} server after it has been contacted. By
12420 default it sends the command @code{MODE READER} to the server with the
12421 @code{nntp-send-mode-reader} function. This function should always be
12422 present in this hook.
12424 @item nntp-authinfo-function
12425 @vindex nntp-authinfo-function
12426 @findex nntp-send-authinfo
12427 @vindex nntp-authinfo-file
12428 This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP}
12429 server. The default function is @code{nntp-send-authinfo}, which looks
12430 through your @file{~/.authinfo} (or whatever you've set the
12431 @code{nntp-authinfo-file} variable to) for applicable entries. If none
12432 are found, it will prompt you for a login name and a password. The
12433 format of the @file{~/.authinfo} file is (almost) the same as the
12434 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
12435 manual page, but here are the salient facts:
12439 The file contains one or more line, each of which define one server.
12442 Each line may contain an arbitrary number of token/value pairs.
12444 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
12445 @samp{default}. In addition Gnus introduces two new tokens, not present
12446 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
12447 @samp{force}. (This is the only way the @file{.authinfo} file format
12448 deviates from the @file{.netrc} file format.) @samp{port} is used to
12449 indicate what port on the server the credentials apply to and
12450 @samp{force} is explained below.
12454 Here's an example file:
12457 machine news.uio.no login larsi password geheimnis
12458 machine nntp.ifi.uio.no login larsi force yes
12461 The token/value pairs may appear in any order; @samp{machine} doesn't
12462 have to be first, for instance.
12464 In this example, both login name and password have been supplied for the
12465 former server, while the latter has only the login name listed, and the
12466 user will be prompted for the password. The latter also has the
12467 @samp{force} tag, which means that the authinfo will be sent to the
12468 @var{nntp} server upon connection; the default (i.e., when there is not
12469 @samp{force} tag) is to not send authinfo to the @var{nntp} server
12470 until the @var{nntp} server asks for it.
12472 You can also add @samp{default} lines that will apply to all servers
12473 that don't have matching @samp{machine} lines.
12479 This will force sending @samp{AUTHINFO} commands to all servers not
12480 previously mentioned.
12482 Remember to not leave the @file{~/.authinfo} file world-readable.
12484 @item nntp-server-action-alist
12485 @vindex nntp-server-action-alist
12486 This is a list of regexps to match on server types and actions to be
12487 taken when matches are made. For instance, if you want Gnus to beep
12488 every time you connect to innd, you could say something like:
12491 (setq nntp-server-action-alist
12492 '(("innd" (ding))))
12495 You probably don't want to do that, though.
12497 The default value is
12500 '(("nntpd 1\\.5\\.11t"
12501 (remove-hook 'nntp-server-opened-hook
12502 'nntp-send-mode-reader)))
12505 This ensures that Gnus doesn't send the @code{MODE READER} command to
12506 nntpd 1.5.11t, since that command chokes that server, I've been told.
12508 @item nntp-maximum-request
12509 @vindex nntp-maximum-request
12510 If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end
12511 will collect headers by sending a series of @code{head} commands. To
12512 speed things up, the back end sends lots of these commands without
12513 waiting for reply, and then reads all the replies. This is controlled
12514 by the @code{nntp-maximum-request} variable, and is 400 by default. If
12515 your network is buggy, you should set this to 1.
12517 @item nntp-connection-timeout
12518 @vindex nntp-connection-timeout
12519 If you have lots of foreign @code{nntp} groups that you connect to
12520 regularly, you're sure to have problems with @acronym{NNTP} servers not
12521 responding properly, or being too loaded to reply within reasonable
12522 time. This is can lead to awkward problems, which can be helped
12523 somewhat by setting @code{nntp-connection-timeout}. This is an integer
12524 that says how many seconds the @code{nntp} back end should wait for a
12525 connection before giving up. If it is @code{nil}, which is the default,
12526 no timeouts are done.
12528 @c @item nntp-command-timeout
12529 @c @vindex nntp-command-timeout
12530 @c @cindex PPP connections
12531 @c @cindex dynamic IP addresses
12532 @c If you're running Gnus on a machine that has a dynamically assigned
12533 @c address, Gnus may become confused. If the address of your machine
12534 @c changes after connecting to the @acronym{NNTP} server, Gnus will simply sit
12535 @c waiting forever for replies from the server. To help with this
12536 @c unfortunate problem, you can set this command to a number. Gnus will
12537 @c then, if it sits waiting for a reply from the server longer than that
12538 @c number of seconds, shut down the connection, start a new one, and resend
12539 @c the command. This should hopefully be transparent to the user. A
12540 @c likely number is 30 seconds.
12542 @c @item nntp-retry-on-break
12543 @c @vindex nntp-retry-on-break
12544 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
12545 @c hangs. This will have much the same effect as the command timeout
12546 @c described above.
12548 @item nntp-server-hook
12549 @vindex nntp-server-hook
12550 This hook is run as the last step when connecting to an @acronym{NNTP}
12553 @item nntp-buggy-select
12554 @vindex nntp-buggy-select
12555 Set this to non-@code{nil} if your select routine is buggy.
12557 @item nntp-nov-is-evil
12558 @vindex nntp-nov-is-evil
12559 If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this
12560 variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV}
12563 @item nntp-xover-commands
12564 @vindex nntp-xover-commands
12565 @cindex @acronym{NOV}
12567 List of strings used as commands to fetch @acronym{NOV} lines from a
12568 server. The default value of this variable is @code{("XOVER"
12572 @vindex nntp-nov-gap
12573 @code{nntp} normally sends just one big request for @acronym{NOV} lines to
12574 the server. The server responds with one huge list of lines. However,
12575 if you have read articles 2-5000 in the group, and only want to read
12576 article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV}
12577 lines that you will not need. This variable says how
12578 big a gap between two consecutive articles is allowed to be before the
12579 @code{XOVER} request is split into several request. Note that if your
12580 network is fast, setting this variable to a really small number means
12581 that fetching will probably be slower. If this variable is @code{nil},
12582 @code{nntp} will never split requests. The default is 5.
12584 @item nntp-prepare-server-hook
12585 @vindex nntp-prepare-server-hook
12586 A hook run before attempting to connect to an @acronym{NNTP} server.
12588 @item nntp-warn-about-losing-connection
12589 @vindex nntp-warn-about-losing-connection
12590 If this variable is non-@code{nil}, some noise will be made when a
12591 server closes connection.
12593 @item nntp-record-commands
12594 @vindex nntp-record-commands
12595 If non-@code{nil}, @code{nntp} will log all commands it sends to the
12596 @acronym{NNTP} server (along with a timestamp) in the @samp{*nntp-log*}
12597 buffer. This is useful if you are debugging a Gnus/@acronym{NNTP} connection
12598 that doesn't seem to work.
12600 @item nntp-open-connection-function
12601 @vindex nntp-open-connection-function
12602 It is possible to customize how the connection to the nntp server will
12603 be opened. If you specify an @code{nntp-open-connection-function}
12604 parameter, Gnus will use that function to establish the connection.
12605 Five pre-made functions are supplied. These functions can be grouped in
12606 two categories: direct connection functions (three pre-made), and
12607 indirect ones (two pre-made).
12609 @item nntp-prepare-post-hook
12610 @vindex nntp-prepare-post-hook
12611 A hook run just before posting an article. If there is no
12612 @code{Message-ID} header in the article and the news server provides the
12613 recommended ID, it will be added to the article before running this
12614 hook. It is useful to make @code{Cancel-Lock} headers even if you
12615 inhibit Gnus to add a @code{Message-ID} header, you could say:
12618 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
12621 Note that not all servers support the recommended ID. This works for
12622 INN versions 2.3.0 and later, for instance.
12624 @item nntp-read-timeout
12625 @vindex nntp-read-timeout
12626 How long nntp should wait between checking for the end of output.
12627 Shorter values mean quicker response, but is more CPU intensive. The
12628 default is 0.1 seconds. If you have a slow line to the server (and
12629 don't like to see Emacs eat your available CPU power), you might set
12632 @item nntp-list-options
12633 @vindex nntp-list-options
12634 List of newsgroup name used for a option of the LIST command to restrict
12635 the listing output to only the specified newsgroups. Each newsgroup name
12636 can be a shell-style wildcard, for instance, @dfn{fj.*}, @dfn{japan.*},
12637 etc. Fortunately, if the server can accept such a option, it will
12638 probably make gnus run faster. You may use it as a server variable as
12642 (setq gnus-select-method
12643 '(nntp "news.somewhere.edu"
12644 (nntp-list-options ("fj.*" "japan.*"))))
12647 @item nntp-options-subscribe
12648 @vindex nntp-options-subscribe
12649 Regexp matching the newsgroup names which will be subscribed
12650 unconditionally. Use @dfn{ } instead of @dfn{$} for a regexp string.
12651 It may be effective as well as @code{nntp-list-options} even though the
12652 server could not accept a shell-style wildcard as a option of the LIST
12653 command. You may use it as a server variable as follows:
12656 (setq gnus-select-method
12657 '(nntp "news.somewhere.edu"
12658 (nntp-options-subscribe "^fj\\.\\|^japan\\.")))
12661 @item nntp-options-not-subscribe
12662 @vindex nntp-options-not-subscribe
12663 Regexp matching the newsgroup names which will not be subscribed
12664 unconditionally. Use @dfn{ } instead of @dfn{$} for a regexp string.
12665 It may be effective as well as @code{nntp-list-options} even though the
12666 server could not accept a shell-style wildcard as a option of the LIST
12667 command. You may use it as a server variable as follows:
12670 (setq gnus-select-method
12671 '(nntp "news.somewhere.edu"
12672 (nntp-options-not-subscribe "\\.binaries\\.")))
12677 * Direct Functions:: Connecting directly to the server.
12678 * Indirect Functions:: Connecting indirectly to the server.
12679 * Common Variables:: Understood by several connection functions.
12683 @node Direct Functions
12684 @subsubsection Direct Functions
12685 @cindex direct connection functions
12687 These functions are called direct because they open a direct connection
12688 between your machine and the @acronym{NNTP} server. The behavior of these
12689 functions is also affected by commonly understood variables
12690 (@pxref{Common Variables}).
12693 @findex nntp-open-network-stream
12694 @item nntp-open-network-stream
12695 This is the default, and simply connects to some port or other on the
12698 @findex nntp-open-tls-stream
12699 @item nntp-open-tls-stream
12700 Opens a connection to a server over a @dfn{secure} channel. To use
12701 this you must have @uref{http://www.gnu.org/software/gnutls/, GNUTLS}
12702 installed. You then define a server as follows:
12705 ;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}}
12706 ;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.}
12708 (nntp "snews.bar.com"
12709 (nntp-open-connection-function nntp-open-tls-stream)
12710 (nntp-port-number )
12711 (nntp-address "snews.bar.com"))
12714 @findex nntp-open-ssl-stream
12715 @item nntp-open-ssl-stream
12716 Opens a connection to a server over a @dfn{secure} channel. To use
12717 this you must have @uref{http://www.openssl.org, OpenSSL} or
12718 @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay} installed. You
12719 then define a server as follows:
12722 ;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}}
12723 ;; @r{however, @samp{openssl s_client -port} doesn't like named ports.}
12725 (nntp "snews.bar.com"
12726 (nntp-open-connection-function nntp-open-ssl-stream)
12727 (nntp-port-number 563)
12728 (nntp-address "snews.bar.com"))
12731 @findex nntp-open-telnet-stream
12732 @item nntp-open-telnet-stream
12733 Opens a connection to an @acronym{NNTP} server by simply @samp{telnet}'ing
12734 it. You might wonder why this function exists, since we have the
12735 default @code{nntp-open-network-stream} which would do the job. (One
12736 of) the reason(s) is that if you are behind a firewall but have direct
12737 connections to the outside world thanks to a command wrapper like
12738 @code{runsocks}, you can use it like this:
12742 (nntp-pre-command "runsocks")
12743 (nntp-open-connection-function nntp-open-telnet-stream)
12744 (nntp-address "the.news.server"))
12747 With the default method, you would need to wrap your whole Emacs
12748 session, which is not a good idea.
12752 @node Indirect Functions
12753 @subsubsection Indirect Functions
12754 @cindex indirect connection functions
12756 These functions are called indirect because they connect to an
12757 intermediate host before actually connecting to the @acronym{NNTP} server.
12758 All of these functions and related variables are also said to belong to
12759 the ``via'' family of connection: they're all prefixed with ``via'' to make
12760 things cleaner. The behavior of these functions is also affected by
12761 commonly understood variables (@pxref{Common Variables}).
12764 @item nntp-open-via-rlogin-and-telnet
12765 @findex nntp-open-via-rlogin-and-telnet
12766 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
12767 to the real @acronym{NNTP} server from there. This is useful for instance if
12768 you need to connect to a firewall machine first.
12770 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
12773 @item nntp-via-rlogin-command
12774 @vindex nntp-via-rlogin-command
12775 Command used to log in on the intermediate host. The default is
12776 @samp{rsh}, but @samp{ssh} is a popular alternative.
12778 @item nntp-via-rlogin-command-switches
12779 @vindex nntp-via-rlogin-command-switches
12780 List of strings to be used as the switches to
12781 @code{nntp-via-rlogin-command}. The default is @code{nil}. If you use
12782 @samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to
12783 @samp{("-C")} in order to compress all data connections, otherwise set
12784 this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if
12785 the telnet command requires a pseudo-tty allocation on an intermediate
12789 @item nntp-open-via-telnet-and-telnet
12790 @findex nntp-open-via-telnet-and-telnet
12791 Does essentially the same, but uses @samp{telnet} instead of
12792 @samp{rlogin} to connect to the intermediate host.
12794 @code{nntp-open-via-telnet-and-telnet}-specific variables:
12797 @item nntp-via-telnet-command
12798 @vindex nntp-via-telnet-command
12799 Command used to @code{telnet} the intermediate host. The default is
12802 @item nntp-via-telnet-switches
12803 @vindex nntp-via-telnet-switches
12804 List of strings to be used as the switches to the
12805 @code{nntp-via-telnet-command} command. The default is @samp{("-8")}.
12807 @item nntp-via-user-password
12808 @vindex nntp-via-user-password
12809 Password to use when logging in on the intermediate host.
12811 @item nntp-via-envuser
12812 @vindex nntp-via-envuser
12813 If non-@code{nil}, the intermediate @code{telnet} session (client and
12814 server both) will support the @code{ENVIRON} option and not prompt for
12815 login name. This works for Solaris @code{telnet}, for instance.
12817 @item nntp-via-shell-prompt
12818 @vindex nntp-via-shell-prompt
12819 Regexp matching the shell prompt on the intermediate host. The default
12820 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
12827 Here are some additional variables that are understood by all the above
12832 @item nntp-via-user-name
12833 @vindex nntp-via-user-name
12834 User name to use when connecting to the intermediate host.
12836 @item nntp-via-address
12837 @vindex nntp-via-address
12838 Address of the intermediate host to connect to.
12843 @node Common Variables
12844 @subsubsection Common Variables
12846 The following variables affect the behavior of all, or several of the
12847 pre-made connection functions. When not specified, all functions are
12852 @item nntp-pre-command
12853 @vindex nntp-pre-command
12854 A command wrapper to use when connecting through a non native
12855 connection function (all except @code{nntp-open-network-stream},
12856 @code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}. This is
12857 where you would put a @samp{SOCKS} wrapper for instance.
12860 @vindex nntp-address
12861 The address of the @acronym{NNTP} server.
12863 @item nntp-port-number
12864 @vindex nntp-port-number
12865 Port number to connect to the @acronym{NNTP} server. The default is
12866 @samp{nntp}. If you use @acronym{NNTP} over
12867 @acronym{TLS}/@acronym{SSL}, you may want to use integer ports rather
12868 than named ports (i.e, use @samp{563} instead of @samp{snews} or
12869 @samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may
12870 not work with named ports.
12872 @item nntp-end-of-line
12873 @vindex nntp-end-of-line
12874 String to use as end-of-line marker when talking to the @acronym{NNTP}
12875 server. This is @samp{\r\n} by default, but should be @samp{\n} when
12876 using a non native connection function.
12878 @item nntp-telnet-command
12879 @vindex nntp-telnet-command
12880 Command to use when connecting to the @acronym{NNTP} server through
12881 @samp{telnet}. This is @emph{not} for an intermediate host. This is
12882 just for the real @acronym{NNTP} server. The default is
12885 @item nntp-telnet-switches
12886 @vindex nntp-telnet-switches
12887 A list of switches to pass to @code{nntp-telnet-command}. The default
12894 @subsection News Spool
12898 Subscribing to a foreign group from the local spool is extremely easy,
12899 and might be useful, for instance, to speed up reading groups that
12900 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
12903 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
12904 anything else) as the address.
12906 If you have access to a local spool, you should probably use that as the
12907 native select method (@pxref{Finding the News}). It is normally faster
12908 than using an @code{nntp} select method, but might not be. It depends.
12909 You just have to try to find out what's best at your site.
12913 @item nnspool-inews-program
12914 @vindex nnspool-inews-program
12915 Program used to post an article.
12917 @item nnspool-inews-switches
12918 @vindex nnspool-inews-switches
12919 Parameters given to the inews program when posting an article.
12921 @item nnspool-spool-directory
12922 @vindex nnspool-spool-directory
12923 Where @code{nnspool} looks for the articles. This is normally
12924 @file{/usr/spool/news/}.
12926 @item nnspool-nov-directory
12927 @vindex nnspool-nov-directory
12928 Where @code{nnspool} will look for @acronym{NOV} files. This is normally@*
12929 @file{/usr/spool/news/over.view/}.
12931 @item nnspool-lib-dir
12932 @vindex nnspool-lib-dir
12933 Where the news lib dir is (@file{/usr/lib/news/} by default).
12935 @item nnspool-active-file
12936 @vindex nnspool-active-file
12937 The name of the active file.
12939 @item nnspool-newsgroups-file
12940 @vindex nnspool-newsgroups-file
12941 The name of the group descriptions file.
12943 @item nnspool-history-file
12944 @vindex nnspool-history-file
12945 The name of the news history file.
12947 @item nnspool-active-times-file
12948 @vindex nnspool-active-times-file
12949 The name of the active date file.
12951 @item nnspool-nov-is-evil
12952 @vindex nnspool-nov-is-evil
12953 If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files
12956 @item nnspool-sift-nov-with-sed
12957 @vindex nnspool-sift-nov-with-sed
12959 If non-@code{nil}, which is the default, use @code{sed} to get the
12960 relevant portion from the overview file. If @code{nil},
12961 @code{nnspool} will load the entire file into a buffer and process it
12968 @section Getting Mail
12969 @cindex reading mail
12972 Reading mail with a newsreader---isn't that just plain WeIrD? But of
12976 * Mail in a Newsreader:: Important introductory notes.
12977 * Getting Started Reading Mail:: A simple cookbook example.
12978 * Splitting Mail:: How to create mail groups.
12979 * Mail Sources:: How to tell Gnus where to get mail from.
12980 * Mail Back End Variables:: Variables for customizing mail handling.
12981 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
12982 * Group Mail Splitting:: Use group customize to drive mail splitting.
12983 * Incorporating Old Mail:: What about the old mail you have?
12984 * Expiring Mail:: Getting rid of unwanted mail.
12985 * Washing Mail:: Removing cruft from the mail you get.
12986 * Duplicates:: Dealing with duplicated mail.
12987 * Not Reading Mail:: Using mail back ends for reading other files.
12988 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
12992 @node Mail in a Newsreader
12993 @subsection Mail in a Newsreader
12995 If you are used to traditional mail readers, but have decided to switch
12996 to reading mail with Gnus, you may find yourself experiencing something
12997 of a culture shock.
12999 Gnus does not behave like traditional mail readers. If you want to make
13000 it behave that way, you can, but it's an uphill battle.
13002 Gnus, by default, handles all its groups using the same approach. This
13003 approach is very newsreaderly---you enter a group, see the new/unread
13004 messages, and when you read the messages, they get marked as read, and
13005 you don't see them any more. (Unless you explicitly ask for them.)
13007 In particular, you do not do anything explicitly to delete messages.
13009 Does this mean that all the messages that have been marked as read are
13010 deleted? How awful!
13012 But, no, it means that old messages are @dfn{expired} according to some
13013 scheme or other. For news messages, the expire process is controlled by
13014 the news administrator; for mail, the expire process is controlled by
13015 you. The expire process for mail is covered in depth in @ref{Expiring
13018 What many Gnus users find, after using it a while for both news and
13019 mail, is that the transport mechanism has very little to do with how
13020 they want to treat a message.
13022 Many people subscribe to several mailing lists. These are transported
13023 via @acronym{SMTP}, and are therefore mail. But we might go for weeks without
13024 answering, or even reading these messages very carefully. We may not
13025 need to save them because if we should need to read one again, they are
13026 archived somewhere else.
13028 Some people have local news groups which have only a handful of readers.
13029 These are transported via @acronym{NNTP}, and are therefore news. But we may need
13030 to read and answer a large fraction of the messages very carefully in
13031 order to do our work. And there may not be an archive, so we may need
13032 to save the interesting messages the same way we would personal mail.
13034 The important distinction turns out to be not the transport mechanism,
13035 but other factors such as how interested we are in the subject matter,
13036 or how easy it is to retrieve the message if we need to read it again.
13038 Gnus provides many options for sorting mail into ``groups'' which behave
13039 like newsgroups, and for treating each group (whether mail or news)
13042 Some users never get comfortable using the Gnus (ahem) paradigm and wish
13043 that Gnus should grow up and be a male, er, mail reader. It is possible
13044 to whip Gnus into a more mailreaderly being, but, as said before, it's
13045 not easy. People who prefer proper mail readers should try @sc{vm}
13046 instead, which is an excellent, and proper, mail reader.
13048 I don't mean to scare anybody off, but I want to make it clear that you
13049 may be required to learn a new way of thinking about messages. After
13050 you've been subjected to The Gnus Way, you will come to love it. I can
13051 guarantee it. (At least the guy who sold me the Emacs Subliminal
13052 Brain-Washing Functions that I've put into Gnus did guarantee it. You
13053 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
13057 @node Getting Started Reading Mail
13058 @subsection Getting Started Reading Mail
13060 It's quite easy to use Gnus to read your new mail. You just plonk the
13061 mail back end of your choice into @code{gnus-secondary-select-methods},
13062 and things will happen automatically.
13064 For instance, if you want to use @code{nnml} (which is a ``one file per
13065 mail'' back end), you could put the following in your @file{~/.gnus.el} file:
13068 (setq gnus-secondary-select-methods '((nnml "")))
13071 Now, the next time you start Gnus, this back end will be queried for new
13072 articles, and it will move all the messages in your spool file to its
13073 directory, which is @file{~/Mail/} by default. The new group that will
13074 be created (@samp{mail.misc}) will be subscribed, and you can read it
13075 like any other group.
13077 You will probably want to split the mail into several groups, though:
13080 (setq nnmail-split-methods
13081 '(("junk" "^From:.*Lars Ingebrigtsen")
13082 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
13086 This will result in three new @code{nnml} mail groups being created:
13087 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
13088 mail that doesn't fit into the first two groups will be placed in the
13091 This should be sufficient for reading mail with Gnus. You might want to
13092 give the other sections in this part of the manual a perusal, though.
13093 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
13096 @node Splitting Mail
13097 @subsection Splitting Mail
13098 @cindex splitting mail
13099 @cindex mail splitting
13100 @cindex mail filtering (splitting)
13102 @vindex nnmail-split-methods
13103 The @code{nnmail-split-methods} variable says how the incoming mail is
13104 to be split into groups.
13107 (setq nnmail-split-methods
13108 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
13109 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
13110 ("mail.other" "")))
13113 This variable is a list of lists, where the first element of each of
13114 these lists is the name of the mail group (they do not have to be called
13115 something beginning with @samp{mail}, by the way), and the second
13116 element is a regular expression used on the header of each mail to
13117 determine if it belongs in this mail group. The first string may
13118 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
13119 insert sub-expressions from the matched text. For instance:
13122 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
13125 The second element can also be a function. In that case, it will be
13126 called narrowed to the headers with the first element of the rule as the
13127 argument. It should return a non-@code{nil} value if it thinks that the
13128 mail belongs in that group.
13130 The last of these groups should always be a general one, and the regular
13131 expression should @emph{always} be @samp{*} so that it matches any mails
13132 that haven't been matched by any of the other regexps. (These rules are
13133 processed from the beginning of the alist toward the end. The first
13134 rule to make a match will ``win'', unless you have crossposting enabled.
13135 In that case, all matching rules will ``win''.)
13137 If you like to tinker with this yourself, you can set this variable to a
13138 function of your choice. This function will be called without any
13139 arguments in a buffer narrowed to the headers of an incoming mail
13140 message. The function should return a list of group names that it
13141 thinks should carry this mail message.
13143 Note that the mail back ends are free to maul the poor, innocent,
13144 incoming headers all they want to. They all add @code{Lines} headers;
13145 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
13146 @code{From<SPACE>} line to something else.
13148 @vindex nnmail-crosspost
13149 The mail back ends all support cross-posting. If several regexps match,
13150 the mail will be ``cross-posted'' to all those groups.
13151 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
13152 that no articles are crossposted to the general (@samp{*}) group.
13154 @vindex nnmail-crosspost-link-function
13157 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
13158 the crossposted articles. However, not all file systems support hard
13159 links. If that's the case for you, set
13160 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
13161 variable is @code{add-name-to-file} by default.)
13163 @kindex M-x nnmail-split-history
13164 @findex nnmail-split-history
13165 If you wish to see where the previous mail split put the messages, you
13166 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
13167 where re-spooling messages would put the messages, you can use
13168 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
13171 @vindex nnmail-split-header-length-limit
13172 Header lines longer than the value of
13173 @code{nnmail-split-header-length-limit} are excluded from the split
13176 @vindex nnmail-mail-splitting-charset
13177 @vindex nnmail-mail-splitting-decodes
13178 By default the splitting codes @acronym{MIME} decodes headers so you
13179 can match on non-@acronym{ASCII} strings. The
13180 @code{nnmail-mail-splitting-charset} variable specifies the default
13181 charset for decoding. The behaviour can be turned off completely by
13182 binding @code{nnmail-mail-splitting-decodes} to @code{nil}, which is
13183 useful if you want to match articles based on the raw header data.
13185 @vindex nnmail-resplit-incoming
13186 By default, splitting is performed on all incoming messages. If you
13187 specify a @code{directory} entry for the variable @code{mail-sources}
13188 (@pxref{Mail Source Specifiers}), however, then splitting does
13189 @emph{not} happen by default. You can set the variable
13190 @code{nnmail-resplit-incoming} to a non-@code{nil} value to make
13191 splitting happen even in this case. (This variable has no effect on
13192 other kinds of entries.)
13194 Gnus gives you all the opportunity you could possibly want for shooting
13195 yourself in the foot. Let's say you create a group that will contain
13196 all the mail you get from your boss. And then you accidentally
13197 unsubscribe from the group. Gnus will still put all the mail from your
13198 boss in the unsubscribed group, and so, when your boss mails you ``Have
13199 that report ready by Monday or you're fired!'', you'll never see it and,
13200 come Tuesday, you'll still believe that you're gainfully employed while
13201 you really should be out collecting empty bottles to save up for next
13202 month's rent money.
13206 @subsection Mail Sources
13208 Mail can be gotten from many different sources---the mail spool, from
13209 a @acronym{POP} mail server, from a procmail directory, or from a
13210 maildir, for instance.
13213 * Mail Source Specifiers:: How to specify what a mail source is.
13214 * Mail Source Customization:: Some variables that influence things.
13215 * Fetching Mail:: Using the mail source specifiers.
13219 @node Mail Source Specifiers
13220 @subsubsection Mail Source Specifiers
13222 @cindex mail server
13225 @cindex mail source
13227 You tell Gnus how to fetch mail by setting @code{mail-sources}
13228 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
13233 (pop :server "pop3.mailserver.com" :user "myname")
13236 As can be observed, a mail source specifier is a list where the first
13237 element is a @dfn{mail source type}, followed by an arbitrary number of
13238 @dfn{keywords}. Keywords that are not explicitly specified are given
13241 The following mail source types are available:
13245 Get mail from a single file; typically from the mail spool.
13251 The file name. Defaults to the value of the @env{MAIL}
13252 environment variable or the value of @code{rmail-spool-directory}
13253 (usually something like @file{/usr/mail/spool/user-name}).
13257 Script run before/after fetching mail.
13260 An example file mail source:
13263 (file :path "/usr/spool/mail/user-name")
13266 Or using the default file name:
13272 If the mail spool file is not located on the local machine, it's best
13273 to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail.
13274 You can not use ange-ftp file names here---it has no way to lock the
13275 mail spool while moving the mail.
13277 If it's impossible to set up a proper server, you can use ssh instead.
13281 '((file :prescript "ssh host bin/getmail >%t")))
13284 The @samp{getmail} script would look something like the following:
13288 # getmail - move mail from spool to stdout
13291 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
13293 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
13296 Alter this script to fit find the @samp{movemail} you want to use.
13300 @vindex nnmail-scan-directory-mail-source-once
13301 Get mail from several files in a directory. This is typically used
13302 when you have procmail split the incoming mail into several files.
13303 That is, there is a one-to-one correspondence between files in that
13304 directory and groups, so that mail from the file @file{foo.bar.spool}
13305 will be put in the group @code{foo.bar}. (You can change the suffix
13306 to be used instead of @code{.spool}.) Setting
13307 @code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces
13308 Gnus to scan the mail source only once. This is particularly useful
13309 if you want to scan mail groups at a specified level.
13311 @vindex nnmail-resplit-incoming
13312 There is also the variable @code{nnmail-resplit-incoming}, if you set
13313 that to a non-@code{nil} value, then the normal splitting process is
13314 applied to all the files from the directory, @ref{Splitting Mail}.
13320 The name of the directory where the files are. There is no default
13324 Only files ending with this suffix are used. The default is
13328 Only files that have this predicate return non-@code{nil} are returned.
13329 The default is @code{identity}. This is used as an additional
13330 filter---only files that have the right suffix @emph{and} satisfy this
13331 predicate are considered.
13335 Script run before/after fetching mail.
13339 An example directory mail source:
13342 (directory :path "/home/user-name/procmail-dir/"
13347 Get mail from a @acronym{POP} server.
13353 The name of the @acronym{POP} server. The default is taken from the
13354 @env{MAILHOST} environment variable.
13357 The port number of the @acronym{POP} server. This can be a number (eg,
13358 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
13359 string, it should be a service name as listed in @file{/etc/services} on
13360 Unix systems. The default is @samp{"pop3"}. On some systems you might
13361 need to specify it as @samp{"pop-3"} instead.
13364 The user name to give to the @acronym{POP} server. The default is the login
13368 The password to give to the @acronym{POP} server. If not specified,
13369 the user is prompted.
13372 The program to use to fetch mail from the @acronym{POP} server. This
13373 should be a @code{format}-like string. Here's an example:
13376 fetchmail %u@@%s -P %p %t
13379 The valid format specifier characters are:
13383 The name of the file the mail is to be moved to. This must always be
13384 included in this string.
13387 The name of the server.
13390 The port number of the server.
13393 The user name to use.
13396 The password to use.
13399 The values used for these specs are taken from the values you give the
13400 corresponding keywords.
13403 A script to be run before fetching the mail. The syntax is the same as
13404 the @code{:program} keyword. This can also be a function to be run.
13407 A script to be run after fetching the mail. The syntax is the same as
13408 the @code{:program} keyword. This can also be a function to be run.
13411 The function to use to fetch mail from the @acronym{POP} server. The
13412 function is called with one parameter---the name of the file where the
13413 mail should be moved to.
13415 @item :authentication
13416 This can be either the symbol @code{password} or the symbol @code{apop}
13417 and says what authentication scheme to use. The default is
13421 What stream to use for connecting to the server, this can be the symbol
13422 @code{ssl}, the symbol @code{tls} or others. The default is @code{nil}
13423 and use insecure connections. Note that for SSL/TLS, you need external
13424 programs and libraries:
13428 @dfn{ssl:} Connect through SSL@. Requires OpenSSL (the program
13429 @samp{openssl}) or SSLeay (@samp{s_client}) as well as the external
13430 library @samp{ssl.el}.
13432 @dfn{starttls:} Connect via the STARTTLS extension (similar to SSL)@.
13433 Requires the external library @samp{starttls.el} and program
13438 Non-@code{nil} if mail is to be left on the server and UIDL used for
13439 message retrieval. The default is @code{nil}.
13443 If the @code{:program} and @code{:function} keywords aren't specified,
13444 @code{pop3-movemail} will be used.
13446 Here are some examples. Fetch from the default @acronym{POP} server,
13447 using the default user name, and default fetcher:
13453 Fetch from a named server with a named user and password:
13456 (pop :server "my.pop.server"
13457 :user "user-name" :password "secret")
13460 Use @samp{movemail} to move the mail:
13463 (pop :program "movemail po:%u %t %p")
13467 Get mail from a maildir. This is a type of mailbox that is supported by
13468 at least qmail and postfix, where each file in a special directory
13469 contains exactly one mail.
13475 The name of the directory where the mails are stored. The default is
13476 taken from the @env{MAILDIR} environment variable or
13479 The subdirectories of the Maildir. The default is
13480 @samp{("new" "cur")}.
13482 @c If you sometimes look at your mail through a pop3 daemon before fetching
13483 @c them with Gnus, you may also have to fetch your mails from the
13484 @c @code{cur} directory inside the maildir, like in the first example
13487 You can also get mails from remote hosts (because maildirs don't suffer
13488 from locking problems).
13492 Two example maildir mail sources:
13495 (maildir :path "/home/user-name/Maildir/"
13496 :subdirs ("cur" "new"))
13500 (maildir :path "/user@@remotehost.org:~/Maildir/"
13505 Get mail from a @acronym{IMAP} server. If you don't want to use
13506 @acronym{IMAP} as intended, as a network mail reading protocol (ie
13507 with nnimap), for some reason or other, Gnus let you treat it similar
13508 to a @acronym{POP} server and fetches articles from a given
13509 @acronym{IMAP} mailbox. @xref{IMAP}, for more information.
13511 Note that for the Kerberos, GSSAPI, @acronym{TLS}/@acronym{SSL} and STARTTLS support you
13512 may need external programs and libraries, @xref{IMAP}.
13518 The name of the @acronym{IMAP} server. The default is taken from the
13519 @env{MAILHOST} environment variable.
13522 The port number of the @acronym{IMAP} server. The default is @samp{143}, or
13523 @samp{993} for @acronym{TLS}/@acronym{SSL} connections.
13526 The user name to give to the @acronym{IMAP} server. The default is the login
13530 The password to give to the @acronym{IMAP} server. If not specified, the user is
13534 What stream to use for connecting to the server, this is one of the
13535 symbols in @code{imap-stream-alist}. Right now, this means
13536 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls},
13537 @samp{ssl}, @samp{shell} or the default @samp{network}.
13539 @item :authentication
13540 Which authenticator to use for authenticating to the server, this is
13541 one of the symbols in @code{imap-authenticator-alist}. Right now,
13542 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
13543 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
13546 When using the `shell' :stream, the contents of this variable is
13547 mapped into the @code{imap-shell-program} variable. This should be a
13548 @code{format}-like string (or list of strings). Here's an example:
13554 The valid format specifier characters are:
13558 The name of the server.
13561 User name from @code{imap-default-user}.
13564 The port number of the server.
13567 The values used for these specs are taken from the values you give the
13568 corresponding keywords.
13571 The name of the mailbox to get mail from. The default is @samp{INBOX}
13572 which normally is the mailbox which receive incoming mail.
13575 The predicate used to find articles to fetch. The default, @samp{UNSEEN
13576 UNDELETED}, is probably the best choice for most people, but if you
13577 sometimes peek in your mailbox with a @acronym{IMAP} client and mark some
13578 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
13579 Then all articles in the mailbox is fetched, no matter what. For a
13580 complete list of predicates, see RFC 2060 section 6.4.4.
13583 How to flag fetched articles on the server, the default @samp{\Deleted}
13584 will mark them as deleted, an alternative would be @samp{\Seen} which
13585 would simply mark them as read. These are the two most likely choices,
13586 but more flags are defined in RFC 2060 section 2.3.2.
13589 If non-@code{nil}, don't remove all articles marked as deleted in the
13590 mailbox after finishing the fetch.
13594 An example @acronym{IMAP} mail source:
13597 (imap :server "mail.mycorp.com"
13599 :fetchflag "\\Seen")
13603 Get mail from a webmail server, such as @uref{http://www.hotmail.com/},
13604 @uref{http://webmail.netscape.com/}, @uref{http://www.netaddress.com/},
13605 @uref{http://mail.yahoo.com/}.
13607 NOTE: Webmail largely depends on cookies. A "one-line-cookie" patch is
13608 required for url "4.0pre.46".
13610 WARNING: Mails may be lost. NO WARRANTY.
13616 The type of the webmail server. The default is @code{hotmail}. The
13617 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
13620 The user name to give to the webmail server. The default is the login
13624 The password to give to the webmail server. If not specified, the user is
13628 If non-@code{nil}, only fetch unread articles and don't move them to
13629 trash folder after finishing the fetch.
13633 An example webmail source:
13636 (webmail :subtype 'hotmail
13638 :password "secret")
13643 @item Common Keywords
13644 Common keywords can be used in any type of mail source.
13650 If non-@code{nil}, fetch the mail even when Gnus is unplugged. If you
13651 use directory source to get mail, you can specify it as in this
13656 '((directory :path "/home/pavel/.Spool/"
13661 Gnus will then fetch your mail even when you are unplugged. This is
13662 useful when you use local mail and news.
13667 @subsubsection Function Interface
13669 Some of the above keywords specify a Lisp function to be executed.
13670 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
13671 the value of the keyword while the function is executing. For example,
13672 consider the following mail-source setting:
13675 (setq mail-sources '((pop :user "jrl"
13676 :server "pophost" :function fetchfunc)))
13679 While the function @code{fetchfunc} is executing, the symbol @code{user}
13680 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
13681 @code{"pophost"}. The symbols @code{port}, @code{password},
13682 @code{program}, @code{prescript}, @code{postscript}, @code{function},
13683 and @code{authentication} are also bound (to their default values).
13685 See above for a list of keywords for each type of mail source.
13688 @node Mail Source Customization
13689 @subsubsection Mail Source Customization
13691 The following is a list of variables that influence how the mail is
13692 fetched. You would normally not need to set or change any of these
13696 @item mail-source-crash-box
13697 @vindex mail-source-crash-box
13698 File where mail will be stored while processing it. The default is@*
13699 @file{~/.emacs-mail-crash-box}.
13701 @item mail-source-delete-incoming
13702 @vindex mail-source-delete-incoming
13703 If non-@code{nil}, delete incoming files after handling them. If
13704 @code{t}, delete the files immediately, if @code{nil}, never delete any
13705 files. If a positive number, delete files older than number of days
13706 (This will only happen, when receiving new mail). You may also set
13707 @code{mail-source-delete-incoming} to @code{nil} and call
13708 @code{mail-source-delete-old-incoming} from a hook or interactively.
13710 @item mail-source-delete-old-incoming-confirm
13711 @vindex mail-source-delete-old-incoming-confirm
13712 If non-@code{nil}, ask for for confirmation before deleting old incoming
13713 files. This variable only applies when
13714 @code{mail-source-delete-incoming} is a positive number.
13716 @item mail-source-ignore-errors
13717 @vindex mail-source-ignore-errors
13718 If non-@code{nil}, ignore errors when reading mail from a mail source.
13720 @item mail-source-directory
13721 @vindex mail-source-directory
13722 Directory where files (if any) will be stored. The default is
13723 @file{~/Mail/}. At present, the only thing this is used for is to say
13724 where the incoming files will be stored if the previous variable is
13727 @item mail-source-incoming-file-prefix
13728 @vindex mail-source-incoming-file-prefix
13729 Prefix for file name for storing incoming mail. The default is
13730 @file{Incoming}, in which case files will end up with names like
13731 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
13732 relevant if @code{mail-source-delete-incoming} is @code{nil}.
13734 @item mail-source-default-file-modes
13735 @vindex mail-source-default-file-modes
13736 All new mail files will get this file mode. The default is 384.
13738 @item mail-source-movemail-program
13739 @vindex mail-source-movemail-program
13740 If non-@code{nil}, name of program for fetching new mail. If
13741 @code{nil}, @code{movemail} in @var{exec-directory}.
13746 @node Fetching Mail
13747 @subsubsection Fetching Mail
13749 @vindex mail-sources
13750 @vindex nnmail-spool-file
13751 The way to actually tell Gnus where to get new mail from is to set
13752 @code{mail-sources} to a list of mail source specifiers
13753 (@pxref{Mail Source Specifiers}).
13755 If this variable (and the obsolescent @code{nnmail-spool-file}) is
13756 @code{nil}, the mail back ends will never attempt to fetch mail by
13759 If you want to fetch mail both from your local spool as well as a
13760 @acronym{POP} mail server, you'd say something like:
13765 (pop :server "pop3.mail.server"
13766 :password "secret")))
13769 Or, if you don't want to use any of the keyword defaults:
13773 '((file :path "/var/spool/mail/user-name")
13774 (pop :server "pop3.mail.server"
13777 :password "secret")))
13781 When you use a mail back end, Gnus will slurp all your mail from your
13782 inbox and plonk it down in your home directory. Gnus doesn't move any
13783 mail if you're not using a mail back end---you have to do a lot of magic
13784 invocations first. At the time when you have finished drawing the
13785 pentagram, lightened the candles, and sacrificed the goat, you really
13786 shouldn't be too surprised when Gnus moves your mail.
13790 @node Mail Back End Variables
13791 @subsection Mail Back End Variables
13793 These variables are (for the most part) pertinent to all the various
13797 @vindex nnmail-read-incoming-hook
13798 @item nnmail-read-incoming-hook
13799 The mail back ends all call this hook after reading new mail. You can
13800 use this hook to notify any mail watch programs, if you want to.
13802 @vindex nnmail-split-hook
13803 @item nnmail-split-hook
13804 @findex gnus-article-decode-encoded-words
13805 @cindex RFC 1522 decoding
13806 @cindex RFC 2047 decoding
13807 Hook run in the buffer where the mail headers of each message is kept
13808 just before the splitting based on these headers is done. The hook is
13809 free to modify the buffer contents in any way it sees fit---the buffer
13810 is discarded after the splitting has been done, and no changes performed
13811 in the buffer will show up in any files.
13812 @code{gnus-article-decode-encoded-words} is one likely function to add
13815 @vindex nnmail-pre-get-new-mail-hook
13816 @vindex nnmail-post-get-new-mail-hook
13817 @item nnmail-pre-get-new-mail-hook
13818 @itemx nnmail-post-get-new-mail-hook
13819 These are two useful hooks executed when treating new incoming
13820 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
13821 starting to handle the new mail) and
13822 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
13823 is done). Here's and example of using these two hooks to change the
13824 default file modes the new mail files get:
13827 (add-hook 'nnmail-pre-get-new-mail-hook
13828 (lambda () (set-default-file-modes 511)))
13830 (add-hook 'nnmail-post-get-new-mail-hook
13831 (lambda () (set-default-file-modes 551)))
13834 @item nnmail-use-long-file-names
13835 @vindex nnmail-use-long-file-names
13836 If non-@code{nil}, the mail back ends will use long file and directory
13837 names. Groups like @samp{mail.misc} will end up in directories
13838 (assuming use of @code{nnml} back end) or files (assuming use of
13839 @code{nnfolder} back end) like @file{mail.misc}. If it is @code{nil},
13840 the same group will end up in @file{mail/misc}.
13842 @item nnmail-delete-file-function
13843 @vindex nnmail-delete-file-function
13844 @findex delete-file
13845 Function called to delete files. It is @code{delete-file} by default.
13847 @item nnmail-cache-accepted-message-ids
13848 @vindex nnmail-cache-accepted-message-ids
13849 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
13850 the back end (via @code{Gcc}, for instance) into the mail duplication
13851 discovery cache. The default is @code{nil}.
13853 @item nnmail-cache-ignore-groups
13854 @vindex nnmail-cache-ignore-groups
13855 This can be a regular expression or a list of regular expressions.
13856 Group names that match any of the regular expressions will never be
13857 recorded in the @code{Message-ID} cache.
13859 This can be useful, for example, when using Fancy Splitting
13860 (@pxref{Fancy Mail Splitting}) together with the function
13861 @code{nnmail-split-fancy-with-parent}.
13866 @node Fancy Mail Splitting
13867 @subsection Fancy Mail Splitting
13868 @cindex mail splitting
13869 @cindex fancy mail splitting
13871 @vindex nnmail-split-fancy
13872 @findex nnmail-split-fancy
13873 If the rather simple, standard method for specifying how to split mail
13874 doesn't allow you to do what you want, you can set
13875 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
13876 play with the @code{nnmail-split-fancy} variable.
13878 Let's look at an example value of this variable first:
13881 ;; @r{Messages from the mailer daemon are not crossposted to any of}
13882 ;; @r{the ordinary groups. Warnings are put in a separate group}
13883 ;; @r{from real errors.}
13884 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
13886 ;; @r{Non-error messages are crossposted to all relevant}
13887 ;; @r{groups, but we don't crosspost between the group for the}
13888 ;; @r{(ding) list and the group for other (ding) related mail.}
13889 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
13890 ("subject" "ding" "ding.misc"))
13891 ;; @r{Other mailing lists@dots{}}
13892 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
13893 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
13894 ;; @r{Both lists below have the same suffix, so prevent}
13895 ;; @r{cross-posting to mkpkg.list of messages posted only to}
13896 ;; @r{the bugs- list, but allow cross-posting when the}
13897 ;; @r{message was really cross-posted.}
13898 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
13899 (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
13900 ;; @r{People@dots{}}
13901 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
13902 ;; @r{Unmatched mail goes to the catch all group.}
13906 This variable has the format of a @dfn{split}. A split is a
13907 (possibly) recursive structure where each split may contain other
13908 splits. Here are the possible split syntaxes:
13913 If the split is a string, that will be taken as a group name. Normal
13914 regexp match expansion will be done. See below for examples.
13916 @item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split})
13917 If the split is a list, the first element of which is a string, then
13918 store the message as specified by @var{split}, if header @var{field}
13919 (a regexp) contains @var{value} (also a regexp). If @var{restrict}
13920 (yet another regexp) matches some string after @var{field} and before
13921 the end of the matched @var{value}, the @var{split} is ignored. If
13922 none of the @var{restrict} clauses match, @var{split} is processed.
13924 @item (| @var{split} @dots{})
13925 If the split is a list, and the first element is @code{|} (vertical
13926 bar), then process each @var{split} until one of them matches. A
13927 @var{split} is said to match if it will cause the mail message to be
13928 stored in one or more groups.
13930 @item (& @var{split} @dots{})
13931 If the split is a list, and the first element is @code{&}, then
13932 process all @var{split}s in the list.
13935 If the split is the symbol @code{junk}, then don't save (i.e., delete)
13936 this message. Use with extreme caution.
13938 @item (: @var{function} @var{arg1} @var{arg2} @dots{})
13939 If the split is a list, and the first element is @samp{:}, then the
13940 second element will be called as a function with @var{args} given as
13941 arguments. The function should return a @var{split}.
13944 For instance, the following function could be used to split based on the
13945 body of the messages:
13948 (defun split-on-body ()
13952 (goto-char (point-min))
13953 (when (re-search-forward "Some.*string" nil t)
13957 The buffer is narrowed to the message in question when @var{function}
13958 is run. That's why @code{(widen)} needs to be called after
13959 @code{save-excursion} and @code{save-restriction} in the example
13960 above. Also note that with the nnimap backend, message bodies will
13961 not be downloaded by default. You need to set
13962 @code{nnimap-split-download-body} to t to do that (@pxref{Splitting in
13965 @item (! @var{func} @var{split})
13966 If the split is a list, and the first element is @code{!}, then
13967 @var{split} will be processed, and @var{func} will be called as a
13968 function with the result of @var{split} as argument. @var{func}
13969 should return a split.
13972 If the split is @code{nil}, it is ignored.
13976 In these splits, @var{field} must match a complete field name.
13977 @var{value} must match a complete word according to the fundamental mode
13978 syntax table. You can use @code{.*} in the regexps to match partial
13979 field names or words. In other words, all @var{value}'s are wrapped in
13980 @samp{\<} and @samp{\>} pairs.
13982 @vindex nnmail-split-abbrev-alist
13983 @var{field} and @var{value} can also be Lisp symbols, in that case
13984 they are expanded as specified by the variable
13985 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells,
13986 where the @sc{car} of a cell contains the key, and the @sc{cdr}
13987 contains the associated value. Predefined entries in
13988 @code{nnmail-split-abbrev-alist} include:
13992 Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields.
13994 Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To},
13995 @samp{Resent-To} and @samp{Resent-Cc} fields.
13997 Is the union of the @code{from} and @code{to} entries.
14000 @vindex nnmail-split-fancy-syntax-table
14001 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
14002 when all this splitting is performed.
14004 If you want to have Gnus create groups dynamically based on some
14005 information in the headers (i.e., do @code{replace-match}-like
14006 substitutions in the group names), you can say things like:
14009 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
14012 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
14013 will be filed in @samp{mail.debian.foo}.
14015 If the string contains the element @samp{\&}, then the previously
14016 matched string will be substituted. Similarly, the elements @samp{\\1}
14017 up to @samp{\\9} will be substituted with the text matched by the
14018 groupings 1 through 9.
14020 @vindex nnmail-split-fancy-match-partial-words
14021 @code{nnmail-split-fancy-match-partial-words} controls whether partial
14022 words are matched during fancy splitting.
14024 Normally, regular expressions given in @code{nnmail-split-fancy} are
14025 implicitly surrounded by @code{\<...\>} markers, which are word
14026 delimiters. If this variable is true, they are not implicitly
14027 surrounded by anything.
14030 (any "joe" "joemail")
14033 In this example, messages sent from @samp{joedavis@@foo.org} will
14034 normally not be filed in @samp{joemail}. With
14035 @code{nnmail-split-fancy-match-partial-words} set to t, however, the
14036 match will happen. In effect, the requirement of a word boundary is
14037 removed and instead the match becomes more like a grep.
14039 @findex nnmail-split-fancy-with-parent
14040 @code{nnmail-split-fancy-with-parent} is a function which allows you to
14041 split followups into the same groups their parents are in. Sometimes
14042 you can't make splitting rules for all your mail. For example, your
14043 boss might send you personal mail regarding different projects you are
14044 working on, and as you can't tell your boss to put a distinguishing
14045 string into the subject line, you have to resort to manually moving the
14046 messages into the right group. With this function, you only have to do
14047 it once per thread.
14049 To use this feature, you have to set @code{nnmail-treat-duplicates}
14050 and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil}
14051 value. And then you can include @code{nnmail-split-fancy-with-parent}
14052 using the colon feature, like so:
14054 (setq nnmail-treat-duplicates 'warn ; @r{or @code{delete}}
14055 nnmail-cache-accepted-message-ids t
14057 '(| (: nnmail-split-fancy-with-parent)
14058 ;; @r{other splits go here}
14062 This feature works as follows: when @code{nnmail-treat-duplicates} is
14063 non-@code{nil}, Gnus records the message id of every message it sees
14064 in the file specified by the variable
14065 @code{nnmail-message-id-cache-file}, together with the group it is in
14066 (the group is omitted for non-mail messages). When mail splitting is
14067 invoked, the function @code{nnmail-split-fancy-with-parent} then looks
14068 at the References (and In-Reply-To) header of each message to split
14069 and searches the file specified by @code{nnmail-message-id-cache-file}
14070 for the message ids. When it has found a parent, it returns the
14071 corresponding group name unless the group name matches the regexp
14072 @code{nnmail-split-fancy-with-parent-ignore-groups}. It is
14073 recommended that you set @code{nnmail-message-id-cache-length} to a
14074 somewhat higher number than the default so that the message ids are
14075 still in the cache. (A value of 5000 appears to create a file some
14076 300 kBytes in size.)
14077 @vindex nnmail-cache-accepted-message-ids
14078 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
14079 also records the message ids of moved articles, so that the followup
14080 messages goes into the new group.
14082 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
14083 want certain groups to be recorded in the cache. For example, if all
14084 outgoing messages are written to an ``outgoing'' group, you could set
14085 @code{nnmail-cache-ignore-groups} to match that group name.
14086 Otherwise, answers to all your messages would end up in the
14087 ``outgoing'' group.
14090 @node Group Mail Splitting
14091 @subsection Group Mail Splitting
14092 @cindex mail splitting
14093 @cindex group mail splitting
14095 @findex gnus-group-split
14096 If you subscribe to dozens of mailing lists but you don't want to
14097 maintain mail splitting rules manually, group mail splitting is for you.
14098 You just have to set @code{to-list} and/or @code{to-address} in group
14099 parameters or group customization and set @code{nnmail-split-methods} to
14100 @code{gnus-group-split}. This splitting function will scan all groups
14101 for those parameters and split mail accordingly, i.e., messages posted
14102 from or to the addresses specified in the parameters @code{to-list} or
14103 @code{to-address} of a mail group will be stored in that group.
14105 Sometimes, mailing lists have multiple addresses, and you may want mail
14106 splitting to recognize them all: just set the @code{extra-aliases} group
14107 parameter to the list of additional addresses and it's done. If you'd
14108 rather use a regular expression, set @code{split-regexp}.
14110 All these parameters in a group will be used to create an
14111 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
14112 the @var{value} is a single regular expression that matches
14113 @code{to-list}, @code{to-address}, all of @code{extra-aliases} and all
14114 matches of @code{split-regexp}, and the @var{split} is the name of the
14115 group. @var{restrict}s are also supported: just set the
14116 @code{split-exclude} parameter to a list of regular expressions.
14118 If you can't get the right split to be generated using all these
14119 parameters, or you just need something fancier, you can set the
14120 parameter @code{split-spec} to an @code{nnmail-split-fancy} split. In
14121 this case, all other aforementioned parameters will be ignored by
14122 @code{gnus-group-split}. In particular, @code{split-spec} may be set to
14123 @code{nil}, in which case the group will be ignored by
14124 @code{gnus-group-split}.
14126 @vindex gnus-group-split-default-catch-all-group
14127 @code{gnus-group-split} will do cross-posting on all groups that match,
14128 by defining a single @code{&} fancy split containing one split for each
14129 group. If a message doesn't match any split, it will be stored in the
14130 group named in @code{gnus-group-split-default-catch-all-group}, unless
14131 some group has @code{split-spec} set to @code{catch-all}, in which case
14132 that group is used as the catch-all group. Even though this variable is
14133 often used just to name a group, it may also be set to an arbitrarily
14134 complex fancy split (after all, a group name is a fancy split), and this
14135 may be useful to split mail that doesn't go to any mailing list to
14136 personal mail folders. Note that this fancy split is added as the last
14137 element of a @code{|} split list that also contains a @code{&} split
14138 with the rules extracted from group parameters.
14140 It's time for an example. Assume the following group parameters have
14145 ((to-address . "bar@@femail.com")
14146 (split-regexp . ".*@@femail\\.com"))
14148 ((to-list . "foo@@nowhere.gov")
14149 (extra-aliases "foo@@localhost" "foo-redist@@home")
14150 (split-exclude "bugs-foo" "rambling-foo")
14151 (admin-address . "foo-request@@nowhere.gov"))
14153 ((split-spec . catch-all))
14156 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
14157 behave as if @code{nnmail-split-fancy} had been selected and variable
14158 @code{nnmail-split-fancy} had been set as follows:
14161 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
14162 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
14163 - "bugs-foo" - "rambling-foo" "mail.foo"))
14167 @findex gnus-group-split-fancy
14168 If you'd rather not use group splitting for all your mail groups, you
14169 may use it for only some of them, by using @code{nnmail-split-fancy}
14173 (: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all})
14176 @var{groups} may be a regular expression or a list of group names whose
14177 parameters will be scanned to generate the output split.
14178 @var{no-crosspost} can be used to disable cross-posting; in this case, a
14179 single @code{|} split will be output. @var{catch-all} is the fall back
14180 fancy split, used like @code{gnus-group-split-default-catch-all-group}.
14181 If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the
14182 empty string in any selected group, no catch-all split will be issued.
14183 Otherwise, if some group has @code{split-spec} set to @code{catch-all},
14184 this group will override the value of the @var{catch-all} argument.
14186 @findex gnus-group-split-setup
14187 Unfortunately, scanning all groups and their parameters can be quite
14188 slow, especially considering that it has to be done for every message.
14189 But don't despair! The function @code{gnus-group-split-setup} can be
14190 used to enable @code{gnus-group-split} in a much more efficient way. It
14191 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
14192 @code{nnmail-split-fancy} to the split produced by
14193 @code{gnus-group-split-fancy}. Thus, the group parameters are only
14194 scanned once, no matter how many messages are split.
14196 @findex gnus-group-split-update
14197 However, if you change group parameters, you'd have to update
14198 @code{nnmail-split-fancy} manually. You can do it by running
14199 @code{gnus-group-split-update}. If you'd rather have it updated
14200 automatically, just tell @code{gnus-group-split-setup} to do it for
14201 you. For example, add to your @file{~/.gnus.el}:
14204 (gnus-group-split-setup @var{auto-update} @var{catch-all})
14207 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
14208 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
14209 have to worry about updating @code{nnmail-split-fancy} again. If you
14210 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
14211 @code{gnus-group-split-default-catch-all-group} will be set to its
14214 @vindex gnus-group-split-updated-hook
14215 Because you may want to change @code{nnmail-split-fancy} after it is set
14216 by @code{gnus-group-split-update}, this function will run
14217 @code{gnus-group-split-updated-hook} just before finishing.
14219 @node Incorporating Old Mail
14220 @subsection Incorporating Old Mail
14221 @cindex incorporating old mail
14222 @cindex import old mail
14224 Most people have lots of old mail stored in various file formats. If
14225 you have set up Gnus to read mail using one of the spiffy Gnus mail
14226 back ends, you'll probably wish to have that old mail incorporated into
14229 Doing so can be quite easy.
14231 To take an example: You're reading mail using @code{nnml}
14232 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
14233 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
14234 file filled with important, but old, mail. You want to move it into
14235 your @code{nnml} groups.
14241 Go to the group buffer.
14244 Type @kbd{G f} and give the file name to the mbox file when prompted to create an
14245 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
14248 Type @kbd{SPACE} to enter the newly created group.
14251 Type @kbd{M P b} to process-mark all articles in this group's buffer
14252 (@pxref{Setting Process Marks}).
14255 Type @kbd{B r} to respool all the process-marked articles, and answer
14256 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
14259 All the mail messages in the mbox file will now also be spread out over
14260 all your @code{nnml} groups. Try entering them and check whether things
14261 have gone without a glitch. If things look ok, you may consider
14262 deleting the mbox file, but I wouldn't do that unless I was absolutely
14263 sure that all the mail has ended up where it should be.
14265 Respooling is also a handy thing to do if you're switching from one mail
14266 back end to another. Just respool all the mail in the old mail groups
14267 using the new mail back end.
14270 @node Expiring Mail
14271 @subsection Expiring Mail
14272 @cindex article expiry
14274 Traditional mail readers have a tendency to remove mail articles when
14275 you mark them as read, in some way. Gnus takes a fundamentally
14276 different approach to mail reading.
14278 Gnus basically considers mail just to be news that has been received in
14279 a rather peculiar manner. It does not think that it has the power to
14280 actually change the mail, or delete any mail messages. If you enter a
14281 mail group, and mark articles as ``read'', or kill them in some other
14282 fashion, the mail articles will still exist on the system. I repeat:
14283 Gnus will not delete your old, read mail. Unless you ask it to, of
14286 To make Gnus get rid of your unwanted mail, you have to mark the
14287 articles as @dfn{expirable}. (With the default key bindings, this means
14288 that you have to type @kbd{E}.) This does not mean that the articles
14289 will disappear right away, however. In general, a mail article will be
14290 deleted from your system if, 1) it is marked as expirable, AND 2) it is
14291 more than one week old. If you do not mark an article as expirable, it
14292 will remain on your system until hell freezes over. This bears
14293 repeating one more time, with some spurious capitalizations: IF you do
14294 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
14296 You do not have to mark articles as expirable by hand. Gnus provides
14297 two features, called ``auto-expire'' and ``total-expire'', that can help you
14298 with this. In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E}
14299 for you when you select an article. And ``total-expire'' means that Gnus
14300 considers all articles as expirable that are read. So, in addition to
14301 the articles marked @samp{E}, also the articles marked @samp{r},
14302 @samp{R}, @samp{O}, @samp{K}, @samp{Y} and so on are considered
14305 When should either auto-expire or total-expire be used? Most people
14306 who are subscribed to mailing lists split each list into its own group
14307 and then turn on auto-expire or total-expire for those groups.
14308 (@xref{Splitting Mail}, for more information on splitting each list
14309 into its own group.)
14311 Which one is better, auto-expire or total-expire? It's not easy to
14312 answer. Generally speaking, auto-expire is probably faster. Another
14313 advantage of auto-expire is that you get more marks to work with: for
14314 the articles that are supposed to stick around, you can still choose
14315 between tick and dormant and read marks. But with total-expire, you
14316 only have dormant and ticked to choose from. The advantage of
14317 total-expire is that it works well with adaptive scoring (@pxref{Adaptive
14318 Scoring}). Auto-expire works with normal scoring but not with adaptive
14321 @vindex gnus-auto-expirable-newsgroups
14322 Groups that match the regular expression
14323 @code{gnus-auto-expirable-newsgroups} will have all articles that you
14324 read marked as expirable automatically. All articles marked as
14325 expirable have an @samp{E} in the first column in the summary buffer.
14327 By default, if you have auto expiry switched on, Gnus will mark all the
14328 articles you read as expirable, no matter if they were read or unread
14329 before. To avoid having articles marked as read marked as expirable
14330 automatically, you can put something like the following in your
14331 @file{~/.gnus.el} file:
14333 @vindex gnus-mark-article-hook
14335 (remove-hook 'gnus-mark-article-hook
14336 'gnus-summary-mark-read-and-unread-as-read)
14337 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
14340 Note that making a group auto-expirable doesn't mean that all read
14341 articles are expired---only the articles marked as expirable
14342 will be expired. Also note that using the @kbd{d} command won't make
14343 articles expirable---only semi-automatic marking of articles as read will
14344 mark the articles as expirable in auto-expirable groups.
14346 Let's say you subscribe to a couple of mailing lists, and you want the
14347 articles you have read to disappear after a while:
14350 (setq gnus-auto-expirable-newsgroups
14351 "mail.nonsense-list\\|mail.nice-list")
14354 Another way to have auto-expiry happen is to have the element
14355 @code{auto-expire} in the group parameters of the group.
14357 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
14358 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
14359 don't really mix very well.
14361 @vindex nnmail-expiry-wait
14362 The @code{nnmail-expiry-wait} variable supplies the default time an
14363 expirable article has to live. Gnus starts counting days from when the
14364 message @emph{arrived}, not from when it was sent. The default is seven
14367 Gnus also supplies a function that lets you fine-tune how long articles
14368 are to live, based on what group they are in. Let's say you want to
14369 have one month expiry period in the @samp{mail.private} group, a one day
14370 expiry period in the @samp{mail.junk} group, and a six day expiry period
14373 @vindex nnmail-expiry-wait-function
14375 (setq nnmail-expiry-wait-function
14377 (cond ((string= group "mail.private")
14379 ((string= group "mail.junk")
14381 ((string= group "important")
14387 The group names this function is fed are ``unadorned'' group
14388 names---no @samp{nnml:} prefixes and the like.
14390 The @code{nnmail-expiry-wait} variable and
14391 @code{nnmail-expiry-wait-function} function can either be a number (not
14392 necessarily an integer) or one of the symbols @code{immediate} or
14395 You can also use the @code{expiry-wait} group parameter to selectively
14396 change the expiry period (@pxref{Group Parameters}).
14398 @vindex nnmail-expiry-target
14399 The normal action taken when expiring articles is to delete them.
14400 However, in some circumstances it might make more sense to move them
14401 to other groups instead of deleting them. The variable
14402 @code{nnmail-expiry-target} (and the @code{expiry-target} group
14403 parameter) controls this. The variable supplies a default value for
14404 all groups, which can be overridden for specific groups by the group
14405 parameter. default value is @code{delete}, but this can also be a
14406 string (which should be the name of the group the message should be
14407 moved to), or a function (which will be called in a buffer narrowed to
14408 the message in question, and with the name of the group being moved
14409 from as its parameter) which should return a target---either a group
14410 name or @code{delete}.
14412 Here's an example for specifying a group name:
14414 (setq nnmail-expiry-target "nnml:expired")
14417 @findex nnmail-fancy-expiry-target
14418 @vindex nnmail-fancy-expiry-targets
14419 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
14420 expire mail to groups according to the variable
14421 @code{nnmail-fancy-expiry-targets}. Here's an example:
14424 (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
14425 nnmail-fancy-expiry-targets
14426 '((to-from "boss" "nnfolder:Work")
14427 ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
14428 ("from" ".*" "nnfolder:Archive-%Y")))
14431 With this setup, any mail that has @code{IMPORTANT} in its Subject
14432 header and was sent in the year @code{YYYY} and month @code{MMM}, will
14433 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
14434 From or To header contains the string @code{boss}, it will get expired
14435 to @code{nnfolder:Work}. All other mail will get expired to
14436 @code{nnfolder:Archive-YYYY}.
14438 @vindex nnmail-keep-last-article
14439 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
14440 expire the final article in a mail newsgroup. This is to make life
14441 easier for procmail users.
14443 @vindex gnus-total-expirable-newsgroups
14444 By the way: That line up there, about Gnus never expiring non-expirable
14445 articles, is a lie. If you put @code{total-expire} in the group
14446 parameters, articles will not be marked as expirable, but all read
14447 articles will be put through the expiry process. Use with extreme
14448 caution. Even more dangerous is the
14449 @code{gnus-total-expirable-newsgroups} variable. All groups that match
14450 this regexp will have all read articles put through the expiry process,
14451 which means that @emph{all} old mail articles in the groups in question
14452 will be deleted after a while. Use with extreme caution, and don't come
14453 crying to me when you discover that the regexp you used matched the
14454 wrong group and all your important mail has disappeared. Be a
14455 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
14458 Most people make most of their mail groups total-expirable, though.
14460 @vindex gnus-inhibit-user-auto-expire
14461 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
14462 commands will not mark an article as expirable, even if the group has
14463 auto-expire turned on.
14467 @subsection Washing Mail
14468 @cindex mail washing
14469 @cindex list server brain damage
14470 @cindex incoming mail treatment
14472 Mailers and list servers are notorious for doing all sorts of really,
14473 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
14474 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
14475 end of all lines passing through our server, so let's do that!!!!1!''
14476 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
14477 considered to be self-evident were not discussed. So. Here we are.
14479 Case in point: The German version of Microsoft Exchange adds @samp{AW:
14480 } to the subjects of replies instead of @samp{Re: }. I could pretend to
14481 be shocked and dismayed by this, but I haven't got the energy. It is to
14484 Gnus provides a plethora of functions for washing articles while
14485 displaying them, but it might be nicer to do the filtering before
14486 storing the mail to disk. For that purpose, we have three hooks and
14487 various functions that can be put in these hooks.
14490 @item nnmail-prepare-incoming-hook
14491 @vindex nnmail-prepare-incoming-hook
14492 This hook is called before doing anything with the mail and is meant for
14493 grand, sweeping gestures. It is called in a buffer that contains all
14494 the new, incoming mail. Functions to be used include:
14497 @item nnheader-ms-strip-cr
14498 @findex nnheader-ms-strip-cr
14499 Remove trailing carriage returns from each line. This is default on
14500 Emacs running on MS machines.
14504 @item nnmail-prepare-incoming-header-hook
14505 @vindex nnmail-prepare-incoming-header-hook
14506 This hook is called narrowed to each header. It can be used when
14507 cleaning up the headers. Functions that can be used include:
14510 @item nnmail-remove-leading-whitespace
14511 @findex nnmail-remove-leading-whitespace
14512 Clear leading white space that ``helpful'' listservs have added to the
14513 headers to make them look nice. Aaah.
14515 (Note that this function works on both the header on the body of all
14516 messages, so it is a potentially dangerous function to use (if a body
14517 of a message contains something that looks like a header line). So
14518 rather than fix the bug, it is of course the right solution to make it
14519 into a feature by documenting it.)
14521 @item nnmail-remove-list-identifiers
14522 @findex nnmail-remove-list-identifiers
14523 Some list servers add an identifier---for example, @samp{(idm)}---to the
14524 beginning of all @code{Subject} headers. I'm sure that's nice for
14525 people who use stone age mail readers. This function will remove
14526 strings that match the @code{nnmail-list-identifiers} regexp, which can
14527 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
14530 For instance, if you want to remove the @samp{(idm)} and the
14531 @samp{nagnagnag} identifiers:
14534 (setq nnmail-list-identifiers
14535 '("(idm)" "nagnagnag"))
14538 This can also be done non-destructively with
14539 @code{gnus-list-identifiers}, @xref{Article Hiding}.
14541 @item nnmail-remove-tabs
14542 @findex nnmail-remove-tabs
14543 Translate all @samp{TAB} characters into @samp{SPACE} characters.
14545 @item nnmail-fix-eudora-headers
14546 @findex nnmail-fix-eudora-headers
14548 Eudora produces broken @code{References} headers, but OK
14549 @code{In-Reply-To} headers. This function will get rid of the
14550 @code{References} headers.
14554 @item nnmail-prepare-incoming-message-hook
14555 @vindex nnmail-prepare-incoming-message-hook
14556 This hook is called narrowed to each message. Functions to be used
14560 @item article-de-quoted-unreadable
14561 @findex article-de-quoted-unreadable
14562 Decode Quoted Readable encoding.
14569 @subsection Duplicates
14571 @vindex nnmail-treat-duplicates
14572 @vindex nnmail-message-id-cache-length
14573 @vindex nnmail-message-id-cache-file
14574 @cindex duplicate mails
14575 If you are a member of a couple of mailing lists, you will sometimes
14576 receive two copies of the same mail. This can be quite annoying, so
14577 @code{nnmail} checks for and treats any duplicates it might find. To do
14578 this, it keeps a cache of old @code{Message-ID}s---
14579 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
14580 default. The approximate maximum number of @code{Message-ID}s stored
14581 there is controlled by the @code{nnmail-message-id-cache-length}
14582 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
14583 stored.) If all this sounds scary to you, you can set
14584 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
14585 default), and @code{nnmail} won't delete duplicate mails. Instead it
14586 will insert a warning into the head of the mail saying that it thinks
14587 that this is a duplicate of a different message.
14589 This variable can also be a function. If that's the case, the function
14590 will be called from a buffer narrowed to the message in question with
14591 the @code{Message-ID} as a parameter. The function must return either
14592 @code{nil}, @code{warn}, or @code{delete}.
14594 You can turn this feature off completely by setting the variable to
14597 If you want all the duplicate mails to be put into a special
14598 @dfn{duplicates} group, you could do that using the normal mail split
14602 (setq nnmail-split-fancy
14603 '(| ;; @r{Messages duplicates go to a separate group.}
14604 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
14605 ;; @r{Message from daemons, postmaster, and the like to another.}
14606 (any mail "mail.misc")
14607 ;; @r{Other rules.}
14613 (setq nnmail-split-methods
14614 '(("duplicates" "^Gnus-Warning:.*duplicate")
14615 ;; @r{Other rules.}
14619 Here's a neat feature: If you know that the recipient reads her mail
14620 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
14621 @code{delete}, you can send her as many insults as you like, just by
14622 using a @code{Message-ID} of a mail that you know that she's already
14623 received. Think of all the fun! She'll never see any of it! Whee!
14626 @node Not Reading Mail
14627 @subsection Not Reading Mail
14629 If you start using any of the mail back ends, they have the annoying
14630 habit of assuming that you want to read mail with them. This might not
14631 be unreasonable, but it might not be what you want.
14633 If you set @code{mail-sources} and @code{nnmail-spool-file} to
14634 @code{nil}, none of the back ends will ever attempt to read incoming
14635 mail, which should help.
14637 @vindex nnbabyl-get-new-mail
14638 @vindex nnmbox-get-new-mail
14639 @vindex nnml-get-new-mail
14640 @vindex nnmh-get-new-mail
14641 @vindex nnfolder-get-new-mail
14642 This might be too much, if, for instance, you are reading mail quite
14643 happily with @code{nnml} and just want to peek at some old Rmail
14644 file you have stashed away with @code{nnbabyl}. All back ends have
14645 variables called back-end-@code{get-new-mail}. If you want to disable
14646 the @code{nnbabyl} mail reading, you edit the virtual server for the
14647 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
14649 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
14650 narrowed to the article to be saved before saving it when reading
14654 @node Choosing a Mail Back End
14655 @subsection Choosing a Mail Back End
14657 Gnus will read the mail spool when you activate a mail group. The mail
14658 file is first copied to your home directory. What happens after that
14659 depends on what format you want to store your mail in.
14661 There are six different mail back ends in the standard Gnus, and more
14662 back ends are available separately. The mail back end most people use
14663 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
14667 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
14668 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
14669 * Mail Spool:: Store your mail in a private spool?
14670 * MH Spool:: An mhspool-like back end.
14671 * Maildir:: Another one-file-per-message format.
14672 * Mail Folders:: Having one file for each group.
14673 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
14677 @node Unix Mail Box
14678 @subsubsection Unix Mail Box
14680 @cindex unix mail box
14682 @vindex nnmbox-active-file
14683 @vindex nnmbox-mbox-file
14684 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
14685 mail. @code{nnmbox} will add extra headers to each mail article to say
14686 which group it belongs in.
14688 Virtual server settings:
14691 @item nnmbox-mbox-file
14692 @vindex nnmbox-mbox-file
14693 The name of the mail box in the user's home directory. Default is
14696 @item nnmbox-active-file
14697 @vindex nnmbox-active-file
14698 The name of the active file for the mail box. Default is
14699 @file{~/.mbox-active}.
14701 @item nnmbox-get-new-mail
14702 @vindex nnmbox-get-new-mail
14703 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
14704 into groups. Default is @code{t}.
14709 @subsubsection Rmail Babyl
14713 @vindex nnbabyl-active-file
14714 @vindex nnbabyl-mbox-file
14715 The @dfn{nnbabyl} back end will use a Babyl mail box (aka. @dfn{Rmail
14716 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
14717 mail article to say which group it belongs in.
14719 Virtual server settings:
14722 @item nnbabyl-mbox-file
14723 @vindex nnbabyl-mbox-file
14724 The name of the Rmail mbox file. The default is @file{~/RMAIL}
14726 @item nnbabyl-active-file
14727 @vindex nnbabyl-active-file
14728 The name of the active file for the rmail box. The default is
14729 @file{~/.rmail-active}
14731 @item nnbabyl-get-new-mail
14732 @vindex nnbabyl-get-new-mail
14733 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
14739 @subsubsection Mail Spool
14741 @cindex mail @acronym{NOV} spool
14743 The @dfn{nnml} spool mail format isn't compatible with any other known
14744 format. It should be used with some caution.
14746 @vindex nnml-directory
14747 If you use this back end, Gnus will split all incoming mail into files,
14748 one file for each mail, and put the articles into the corresponding
14749 directories under the directory specified by the @code{nnml-directory}
14750 variable. The default value is @file{~/Mail/}.
14752 You do not have to create any directories beforehand; Gnus will take
14755 If you have a strict limit as to how many files you are allowed to store
14756 in your account, you should not use this back end. As each mail gets its
14757 own file, you might very well occupy thousands of inodes within a few
14758 weeks. If this is no problem for you, and it isn't a problem for you
14759 having your friendly systems administrator walking around, madly,
14760 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
14761 know that this is probably the fastest format to use. You do not have
14762 to trudge through a big mbox file just to read your new mail.
14764 @code{nnml} is probably the slowest back end when it comes to article
14765 splitting. It has to create lots of files, and it also generates
14766 @acronym{NOV} databases for the incoming mails. This makes it possibly the
14767 fastest back end when it comes to reading mail.
14769 @cindex self contained nnml servers
14771 When the marks file is used (which it is by default), @code{nnml}
14772 servers have the property that you may backup them using @code{tar} or
14773 similar, and later be able to restore them into Gnus (by adding the
14774 proper @code{nnml} server) and have all your marks be preserved. Marks
14775 for a group is usually stored in the @code{.marks} file (but see
14776 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
14777 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
14778 to restore the group (after restoring the backup into the nnml
14781 If for some reason you believe your @file{.marks} files are screwed
14782 up, you can just delete them all. Gnus will then correctly regenerate
14783 them next time it starts.
14785 Virtual server settings:
14788 @item nnml-directory
14789 @vindex nnml-directory
14790 All @code{nnml} directories will be placed under this directory. The
14791 default is the value of @code{message-directory} (whose default value
14794 @item nnml-active-file
14795 @vindex nnml-active-file
14796 The active file for the @code{nnml} server. The default is
14797 @file{~/Mail/active}.
14799 @item nnml-newsgroups-file
14800 @vindex nnml-newsgroups-file
14801 The @code{nnml} group descriptions file. @xref{Newsgroups File
14802 Format}. The default is @file{~/Mail/newsgroups}.
14804 @item nnml-get-new-mail
14805 @vindex nnml-get-new-mail
14806 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
14809 @item nnml-nov-is-evil
14810 @vindex nnml-nov-is-evil
14811 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
14812 default is @code{nil}.
14814 @item nnml-nov-file-name
14815 @vindex nnml-nov-file-name
14816 The name of the @acronym{NOV} files. The default is @file{.overview}.
14818 @item nnml-prepare-save-mail-hook
14819 @vindex nnml-prepare-save-mail-hook
14820 Hook run narrowed to an article before saving.
14822 @item nnml-marks-is-evil
14823 @vindex nnml-marks-is-evil
14824 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
14825 default is @code{nil}.
14827 @item nnml-marks-file-name
14828 @vindex nnml-marks-file-name
14829 The name of the @dfn{marks} files. The default is @file{.marks}.
14831 @item nnml-use-compressed-files
14832 @vindex nnml-use-compressed-files
14833 If non-@code{nil}, @code{nnml} will allow using compressed message
14838 @findex nnml-generate-nov-databases
14839 If your @code{nnml} groups and @acronym{NOV} files get totally out of whack,
14840 you can do a complete update by typing @kbd{M-x
14841 nnml-generate-nov-databases}. This command will trawl through the
14842 entire @code{nnml} hierarchy, looking at each and every article, so it
14843 might take a while to complete. A better interface to this
14844 functionality can be found in the server buffer (@pxref{Server
14849 @subsubsection MH Spool
14851 @cindex mh-e mail spool
14853 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
14854 @acronym{NOV} databases and it doesn't keep an active file or marks file.
14855 This makes @code{nnmh} a @emph{much} slower back end than @code{nnml},
14856 but it also makes it easier to write procmail scripts for.
14858 Virtual server settings:
14861 @item nnmh-directory
14862 @vindex nnmh-directory
14863 All @code{nnmh} directories will be located under this directory. The
14864 default is the value of @code{message-directory} (whose default is
14867 @item nnmh-get-new-mail
14868 @vindex nnmh-get-new-mail
14869 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
14873 @vindex nnmh-be-safe
14874 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
14875 sure that the articles in the folder are actually what Gnus thinks they
14876 are. It will check date stamps and stat everything in sight, so
14877 setting this to @code{t} will mean a serious slow-down. If you never
14878 use anything but Gnus to read the @code{nnmh} articles, you do not have
14879 to set this variable to @code{t}. The default is @code{nil}.
14884 @subsubsection Maildir
14888 @code{nnmaildir} stores mail in the maildir format, with each maildir
14889 corresponding to a group in Gnus. This format is documented here:
14890 @uref{http://cr.yp.to/proto/maildir.html} and here:
14891 @uref{http://www.qmail.org/man/man5/maildir.html}. nnmaildir also
14892 stores extra information in the @file{.nnmaildir/} directory within a
14895 Maildir format was designed to allow concurrent deliveries and
14896 reading, without needing locks. With other back ends, you would have
14897 your mail delivered to a spool of some kind, and then you would
14898 configure Gnus to split mail from that spool into your groups. You
14899 can still do that with nnmaildir, but the more common configuration is
14900 to have your mail delivered directly to the maildirs that appear as
14903 nnmaildir is designed to be perfectly reliable: @kbd{C-g} will never
14904 corrupt its data in memory, and @code{SIGKILL} will never corrupt its
14905 data in the filesystem.
14907 nnmaildir stores article marks and @acronym{NOV} data in each maildir. So you
14908 can copy a whole maildir from one Gnus setup to another, and you will
14911 Virtual server settings:
14915 For each of your nnmaildir servers (it's very unlikely that you'd need
14916 more than one), you need to create a directory and populate it with
14917 maildirs or symlinks to maildirs (and nothing else; do not choose a
14918 directory already used for other purposes). Each maildir will be
14919 represented in Gnus as a newsgroup on that server; the filename of the
14920 symlink will be the name of the group. Any filenames in the directory
14921 starting with @samp{.} are ignored. The directory is scanned when you
14922 first start Gnus, and each time you type @kbd{g} in the group buffer;
14923 if any maildirs have been removed or added, nnmaildir notices at these
14926 The value of the @code{directory} parameter should be a Lisp form
14927 which is processed by @code{eval} and @code{expand-file-name} to get
14928 the path of the directory for this server. The form is @code{eval}ed
14929 only when the server is opened; the resulting string is used until the
14930 server is closed. (If you don't know about forms and @code{eval},
14931 don't worry---a simple string will work.) This parameter is not
14932 optional; you must specify it. I don't recommend using
14933 @code{"~/Mail"} or a subdirectory of it; several other parts of Gnus
14934 use that directory by default for various things, and may get confused
14935 if nnmaildir uses it too. @code{"~/.nnmaildir"} is a typical value.
14937 @item target-prefix
14938 This should be a Lisp form which is processed by @code{eval} and
14939 @code{expand-file-name}. The form is @code{eval}ed only when the
14940 server is opened; the resulting string is used until the server is
14943 When you create a group on an nnmaildir server, the maildir is created
14944 with @code{target-prefix} prepended to its name, and a symlink
14945 pointing to that maildir is created, named with the plain group name.
14946 So if @code{directory} is @code{"~/.nnmaildir"} and
14947 @code{target-prefix} is @code{"../maildirs/"}, then when you create
14948 the group @code{foo}, nnmaildir will create
14949 @file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create
14950 @file{~/.nnmaildir/foo} as a symlink pointing to
14951 @file{../maildirs/foo}.
14953 You can set @code{target-prefix} to a string without any slashes to
14954 create both maildirs and symlinks in the same @code{directory}; in
14955 this case, any maildirs found in @code{directory} whose names start
14956 with @code{target-prefix} will not be listed as groups (but the
14957 symlinks pointing to them will be).
14959 As a special case, if @code{target-prefix} is @code{""} (the default),
14960 then when you create a group, the maildir will be created in
14961 @code{directory} without a corresponding symlink. Beware that you
14962 cannot use @code{gnus-group-delete-group} on such groups without the
14963 @code{force} argument.
14965 @item directory-files
14966 This should be a function with the same interface as
14967 @code{directory-files} (such as @code{directory-files} itself). It is
14968 used to scan the server's @code{directory} for maildirs. This
14969 parameter is optional; the default is
14970 @code{nnheader-directory-files-safe} if
14971 @code{nnheader-directory-files-is-safe} is @code{nil}, and
14972 @code{directory-files} otherwise.
14973 (@code{nnheader-directory-files-is-safe} is checked only once when the
14974 server is opened; if you want to check it each time the directory is
14975 scanned, you'll have to provide your own function that does that.)
14978 If non-@code{nil}, then after scanning for new mail in the group
14979 maildirs themselves as usual, this server will also incorporate mail
14980 the conventional Gnus way, from @code{mail-sources} according to
14981 @code{nnmail-split-methods} or @code{nnmail-split-fancy}. The default
14982 value is @code{nil}.
14984 Do @emph{not} use the same maildir both in @code{mail-sources} and as
14985 an nnmaildir group. The results might happen to be useful, but that
14986 would be by chance, not by design, and the results might be different
14987 in the future. If your split rules create new groups, remember to
14988 supply a @code{create-directory} server parameter.
14991 @subsubsection Group parameters
14993 nnmaildir uses several group parameters. It's safe to ignore all
14994 this; the default behavior for nnmaildir is the same as the default
14995 behavior for other mail back ends: articles are deleted after one week,
14996 etc. Except for the expiry parameters, all this functionality is
14997 unique to nnmaildir, so you can ignore it if you're just trying to
14998 duplicate the behavior you already have with another back end.
15000 If the value of any of these parameters is a vector, the first element
15001 is evaluated as a Lisp form and the result is used, rather than the
15002 original value. If the value is not a vector, the value itself is
15003 evaluated as a Lisp form. (This is why these parameters use names
15004 different from those of other, similar parameters supported by other
15005 back ends: they have different, though similar, meanings.) (For
15006 numbers, strings, @code{nil}, and @code{t}, you can ignore the
15007 @code{eval} business again; for other values, remember to use an extra
15008 quote and wrap the value in a vector when appropriate.)
15012 An integer specifying the minimum age, in seconds, of an article before
15013 it will be expired, or the symbol @code{never} to specify that
15014 articles should never be expired. If this parameter is not set,
15015 nnmaildir falls back to the usual
15016 @code{nnmail-expiry-wait}(@code{-function}) variables (overrideable by
15017 the @code{expiry-wait}(@code{-function}) group parameters. If you
15018 wanted a value of 3 days, you could use something like @code{[(* 3 24
15019 60 60)]}; nnmaildir will evaluate the form and use the result. An
15020 article's age is measured starting from the article file's
15021 modification time. Normally, this is the same as the article's
15022 delivery time, but editing an article makes it younger. Moving an
15023 article (other than via expiry) may also make an article younger.
15026 If this is set to a string such as a full Gnus group name, like
15028 "backend+server.address.string:group.name"
15030 and if it is not the name of the same group that the parameter belongs
15031 to, then articles will be moved to the specified group during expiry
15032 before being deleted. @emph{If this is set to an nnmaildir group, the
15033 article will be just as old in the destination group as it was in the
15034 source group.} So be careful with @code{expire-age} in the
15035 destination group. If this is set to the name of the same group that
15036 the parameter belongs to, then the article is not expired at all. If
15037 you use the vector form, the first element is evaluated once for each
15038 article. So that form can refer to
15039 @code{nnmaildir-article-file-name}, etc., to decide where to put the
15040 article. @emph{If this parameter is not set, nnmaildir does not fall
15041 back to the @code{expiry-target} group parameter or the
15042 @code{nnmail-expiry-target} variable.}
15045 If this is set to @code{t}, nnmaildir will treat the articles in this
15046 maildir as read-only. This means: articles are not renamed from
15047 @file{new/} into @file{cur/}; articles are only found in @file{new/},
15048 not @file{cur/}; articles are never deleted; articles cannot be
15049 edited. @file{new/} is expected to be a symlink to the @file{new/}
15050 directory of another maildir---e.g., a system-wide mailbox containing
15051 a mailing list of common interest. Everything in the maildir outside
15052 @file{new/} is @emph{not} treated as read-only, so for a shared
15053 mailbox, you do still need to set up your own maildir (or have write
15054 permission to the shared mailbox); your maildir just won't contain
15055 extra copies of the articles.
15057 @item directory-files
15058 A function with the same interface as @code{directory-files}. It is
15059 used to scan the directories in the maildir corresponding to this
15060 group to find articles. The default is the function specified by the
15061 server's @code{directory-files} parameter.
15063 @item distrust-Lines:
15064 If non-@code{nil}, nnmaildir will always count the lines of an
15065 article, rather than use the @code{Lines:} header field. If
15066 @code{nil}, the header field will be used if present.
15069 A list of mark symbols, such as
15070 @code{['(read expire)]}. Whenever Gnus asks nnmaildir for
15071 article marks, nnmaildir will say that all articles have these
15072 marks, regardless of whether the marks stored in the filesystem
15073 say so. This is a proof-of-concept feature that will probably be
15074 removed eventually; it ought to be done in Gnus proper, or
15075 abandoned if it's not worthwhile.
15078 A list of mark symbols, such as @code{['(tick expire)]}. Whenever
15079 Gnus asks nnmaildir for article marks, nnmaildir will say that no
15080 articles have these marks, regardless of whether the marks stored in
15081 the filesystem say so. @code{never-marks} overrides
15082 @code{always-marks}. This is a proof-of-concept feature that will
15083 probably be removed eventually; it ought to be done in Gnus proper, or
15084 abandoned if it's not worthwhile.
15086 @item nov-cache-size
15087 An integer specifying the size of the @acronym{NOV} memory cache. To speed
15088 things up, nnmaildir keeps @acronym{NOV} data in memory for a limited number of
15089 articles in each group. (This is probably not worthwhile, and will
15090 probably be removed in the future.) This parameter's value is noticed
15091 only the first time a group is seen after the server is opened---i.e.,
15092 when you first start Gnus, typically. The @acronym{NOV} cache is never resized
15093 until the server is closed and reopened. The default is an estimate
15094 of the number of articles that would be displayed in the summary
15095 buffer: a count of articles that are either marked with @code{tick} or
15096 not marked with @code{read}, plus a little extra.
15099 @subsubsection Article identification
15100 Articles are stored in the @file{cur/} subdirectory of each maildir.
15101 Each article file is named like @code{uniq:info}, where @code{uniq}
15102 contains no colons. nnmaildir ignores, but preserves, the
15103 @code{:info} part. (Other maildir readers typically use this part of
15104 the filename to store marks.) The @code{uniq} part uniquely
15105 identifies the article, and is used in various places in the
15106 @file{.nnmaildir/} subdirectory of the maildir to store information
15107 about the corresponding article. The full pathname of an article is
15108 available in the variable @code{nnmaildir-article-file-name} after you
15109 request the article in the summary buffer.
15111 @subsubsection NOV data
15112 An article identified by @code{uniq} has its @acronym{NOV} data (used to
15113 generate lines in the summary buffer) stored in
15114 @code{.nnmaildir/nov/uniq}. There is no
15115 @code{nnmaildir-generate-nov-databases} function. (There isn't much
15116 need for it---an article's @acronym{NOV} data is updated automatically when the
15117 article or @code{nnmail-extra-headers} has changed.) You can force
15118 nnmaildir to regenerate the @acronym{NOV} data for a single article simply by
15119 deleting the corresponding @acronym{NOV} file, but @emph{beware}: this will also
15120 cause nnmaildir to assign a new article number for this article, which
15121 may cause trouble with @code{seen} marks, the Agent, and the cache.
15123 @subsubsection Article marks
15124 An article identified by @code{uniq} is considered to have the mark
15125 @code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists.
15126 When Gnus asks nnmaildir for a group's marks, nnmaildir looks for such
15127 files and reports the set of marks it finds. When Gnus asks nnmaildir
15128 to store a new set of marks, nnmaildir creates and deletes the
15129 corresponding files as needed. (Actually, rather than create a new
15130 file for each mark, it just creates hard links to
15131 @file{.nnmaildir/markfile}, to save inodes.)
15133 You can invent new marks by creating a new directory in
15134 @file{.nnmaildir/marks/}. You can tar up a maildir and remove it from
15135 your server, untar it later, and keep your marks. You can add and
15136 remove marks yourself by creating and deleting mark files. If you do
15137 this while Gnus is running and your nnmaildir server is open, it's
15138 best to exit all summary buffers for nnmaildir groups and type @kbd{s}
15139 in the group buffer first, and to type @kbd{g} or @kbd{M-g} in the
15140 group buffer afterwards. Otherwise, Gnus might not pick up the
15141 changes, and might undo them.
15145 @subsubsection Mail Folders
15147 @cindex mbox folders
15148 @cindex mail folders
15150 @code{nnfolder} is a back end for storing each mail group in a separate
15151 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
15152 will add extra headers to keep track of article numbers and arrival
15155 @cindex self contained nnfolder servers
15157 When the marks file is used (which it is by default), @code{nnfolder}
15158 servers have the property that you may backup them using @code{tar} or
15159 similar, and later be able to restore them into Gnus (by adding the
15160 proper @code{nnfolder} server) and have all your marks be preserved.
15161 Marks for a group is usually stored in a file named as the mbox file
15162 with @code{.mrk} concatenated to it (but see
15163 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder} directory.
15164 Individual @code{nnfolder} groups are also possible to backup, use
15165 @kbd{G m} to restore the group (after restoring the backup into the
15166 @code{nnfolder} directory).
15168 Virtual server settings:
15171 @item nnfolder-directory
15172 @vindex nnfolder-directory
15173 All the @code{nnfolder} mail boxes will be stored under this directory.
15174 The default is the value of @code{message-directory} (whose default is
15177 @item nnfolder-active-file
15178 @vindex nnfolder-active-file
15179 The name of the active file. The default is @file{~/Mail/active}.
15181 @item nnfolder-newsgroups-file
15182 @vindex nnfolder-newsgroups-file
15183 The name of the group descriptions file. @xref{Newsgroups File
15184 Format}. The default is @file{~/Mail/newsgroups}
15186 @item nnfolder-get-new-mail
15187 @vindex nnfolder-get-new-mail
15188 If non-@code{nil}, @code{nnfolder} will read incoming mail. The default
15191 @item nnfolder-save-buffer-hook
15192 @vindex nnfolder-save-buffer-hook
15193 @cindex backup files
15194 Hook run before saving the folders. Note that Emacs does the normal
15195 backup renaming of files even with the @code{nnfolder} buffers. If you
15196 wish to switch this off, you could say something like the following in
15197 your @file{.emacs} file:
15200 (defun turn-off-backup ()
15201 (set (make-local-variable 'backup-inhibited) t))
15203 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
15206 @item nnfolder-delete-mail-hook
15207 @vindex nnfolder-delete-mail-hook
15208 Hook run in a buffer narrowed to the message that is to be deleted.
15209 This function can be used to copy the message to somewhere else, or to
15210 extract some information from it before removing it.
15212 @item nnfolder-nov-is-evil
15213 @vindex nnfolder-nov-is-evil
15214 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
15215 default is @code{nil}.
15217 @item nnfolder-nov-file-suffix
15218 @vindex nnfolder-nov-file-suffix
15219 The extension for @acronym{NOV} files. The default is @file{.nov}.
15221 @item nnfolder-nov-directory
15222 @vindex nnfolder-nov-directory
15223 The directory where the @acronym{NOV} files should be stored. If
15224 @code{nil}, @code{nnfolder-directory} is used.
15226 @item nnfolder-marks-is-evil
15227 @vindex nnfolder-marks-is-evil
15228 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15229 default is @code{nil}.
15231 @item nnfolder-marks-file-suffix
15232 @vindex nnfolder-marks-file-suffix
15233 The extension for @sc{marks} files. The default is @file{.mrk}.
15235 @item nnfolder-marks-directory
15236 @vindex nnfolder-marks-directory
15237 The directory where the @sc{marks} files should be stored. If
15238 @code{nil}, @code{nnfolder-directory} is used.
15243 @findex nnfolder-generate-active-file
15244 @kindex M-x nnfolder-generate-active-file
15245 If you have lots of @code{nnfolder}-like files you'd like to read with
15246 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
15247 command to make @code{nnfolder} aware of all likely files in
15248 @code{nnfolder-directory}. This only works if you use long file names,
15251 @node Comparing Mail Back Ends
15252 @subsubsection Comparing Mail Back Ends
15254 First, just for terminology, the @dfn{back end} is the common word for a
15255 low-level access method---a transport, if you will, by which something
15256 is acquired. The sense is that one's mail has to come from somewhere,
15257 and so selection of a suitable back end is required in order to get that
15258 mail within spitting distance of Gnus.
15260 The same concept exists for Usenet itself: Though access to articles is
15261 typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone
15262 in the world got at Usenet by running a reader on the machine where the
15263 articles lay (the machine which today we call an @acronym{NNTP} server), and
15264 access was by the reader stepping into the articles' directory spool
15265 area directly. One can still select between either the @code{nntp} or
15266 @code{nnspool} back ends, to select between these methods, if one happens
15267 actually to live on the server (or can see its spool directly, anyway,
15270 The goal in selecting a mail back end is to pick one which
15271 simultaneously represents a suitable way of dealing with the original
15272 format plus leaving mail in a form that is convenient to use in the
15273 future. Here are some high and low points on each:
15278 UNIX systems have historically had a single, very common, and well-
15279 defined format. All messages arrive in a single @dfn{spool file}, and
15280 they are delineated by a line whose regular expression matches
15281 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
15282 to make it clear in this instance that this is not the RFC-specified
15283 @samp{From:} header.) Because Emacs and therefore Gnus emanate
15284 historically from the Unix environment, it is simplest if one does not
15285 mess a great deal with the original mailbox format, so if one chooses
15286 this back end, Gnus' primary activity in getting mail from the real spool
15287 area to Gnus' preferred directory is simply to copy it, with no
15288 (appreciable) format change in the process. It is the ``dumbest'' way
15289 to move mail into availability in the Gnus environment. This makes it
15290 fast to move into place, but slow to parse, when Gnus has to look at
15295 Once upon a time, there was the DEC-10 and DEC-20, running operating
15296 systems called TOPS and related things, and the usual (only?) mail
15297 reading environment was a thing called Babyl. I don't know what format
15298 was used for mail landing on the system, but Babyl had its own internal
15299 format to which mail was converted, primarily involving creating a
15300 spool-file-like entity with a scheme for inserting Babyl-specific
15301 headers and status bits above the top of each message in the file.
15302 Rmail was Emacs' first mail reader, it was written by Richard Stallman,
15303 and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail
15304 to understand the mail files folks already had in existence. Gnus (and
15305 VM, for that matter) continue to support this format because it's
15306 perceived as having some good qualities in those mailer-specific
15307 headers/status bits stuff. Rmail itself still exists as well, of
15308 course, and is still maintained by Stallman.
15310 Both of the above forms leave your mail in a single file on your
15311 file system, and they must parse that entire file each time you take a
15316 @code{nnml} is the back end which smells the most as though you were
15317 actually operating with an @code{nnspool}-accessed Usenet system. (In
15318 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
15319 lo these years ago.) One's mail is taken from the original spool file,
15320 and is then cut up into individual message files, 1:1. It maintains a
15321 Usenet-style active file (analogous to what one finds in an INN- or
15322 CNews-based news system in (for instance) @file{/var/lib/news/active},
15323 or what is returned via the @samp{NNTP LIST} verb) and also creates
15324 @dfn{overview} files for efficient group entry, as has been defined for
15325 @acronym{NNTP} servers for some years now. It is slower in mail-splitting,
15326 due to the creation of lots of files, updates to the @code{nnml} active
15327 file, and additions to overview files on a per-message basis, but it is
15328 extremely fast on access because of what amounts to the indexing support
15329 provided by the active file and overviews.
15331 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
15332 resource which defines available places in the file system to put new
15333 files. Sysadmins take a dim view of heavy inode occupation within
15334 tight, shared file systems. But if you live on a personal machine where
15335 the file system is your own and space is not at a premium, @code{nnml}
15338 It is also problematic using this back end if you are living in a
15339 FAT16-based Windows world, since much space will be wasted on all these
15344 The Rand MH mail-reading system has been around UNIX systems for a very
15345 long time; it operates by splitting one's spool file of messages into
15346 individual files, but with little or no indexing support---@code{nnmh}
15347 is considered to be semantically equivalent to ``@code{nnml} without
15348 active file or overviews''. This is arguably the worst choice, because
15349 one gets the slowness of individual file creation married to the
15350 slowness of access parsing when learning what's new in one's groups.
15354 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
15355 method described above) on a per-group basis. That is, @code{nnmbox}
15356 itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a
15357 little bit of optimization to this so that each of one's mail groups has
15358 a Unix mail box file. It's faster than @code{nnmbox} because each group
15359 can be parsed separately, and still provides the simple Unix mail box
15360 format requiring minimal effort in moving the mail around. In addition,
15361 it maintains an ``active'' file making it much faster for Gnus to figure
15362 out how many messages there are in each separate group.
15364 If you have groups that are expected to have a massive amount of
15365 messages, @code{nnfolder} is not the best choice, but if you receive
15366 only a moderate amount of mail, @code{nnfolder} is probably the most
15367 friendly mail back end all over.
15371 For configuring expiry and other things, @code{nnmaildir} uses
15372 incompatible group parameters, slightly different from those of other
15375 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
15376 differences. Each message is stored in a separate file, but the
15377 filename is unrelated to the article number in Gnus. @code{nnmaildir}
15378 also stores the equivalent of @code{nnml}'s overview files in one file
15379 per article, so it uses about twice as many inodes as @code{nnml}. (Use
15380 @code{df -i} to see how plentiful your inode supply is.) If this slows
15381 you down or takes up very much space, consider switching to
15382 @uref{http://www.namesys.com/, ReiserFS} or another non-block-structured
15385 Since maildirs don't require locking for delivery, the maildirs you use
15386 as groups can also be the maildirs your mail is directly delivered to.
15387 This means you can skip Gnus' mail splitting if your mail is already
15388 organized into different mailboxes during delivery. A @code{directory}
15389 entry in @code{mail-sources} would have a similar effect, but would
15390 require one set of mailboxes for spooling deliveries (in mbox format,
15391 thus damaging message bodies), and another set to be used as groups (in
15392 whatever format you like). A maildir has a built-in spool, in the
15393 @code{new/} subdirectory. Beware that currently, mail moved from
15394 @code{new/} to @code{cur/} instead of via mail splitting will not
15395 undergo treatment such as duplicate checking.
15397 @code{nnmaildir} stores article marks for a given group in the
15398 corresponding maildir, in a way designed so that it's easy to manipulate
15399 them from outside Gnus. You can tar up a maildir, unpack it somewhere
15400 else, and still have your marks. @code{nnml} also stores marks, but
15401 it's not as easy to work with them from outside Gnus as with
15404 @code{nnmaildir} uses a significant amount of memory to speed things up.
15405 (It keeps in memory some of the things that @code{nnml} stores in files
15406 and that @code{nnmh} repeatedly parses out of message files.) If this
15407 is a problem for you, you can set the @code{nov-cache-size} group
15408 parameter to something small (0 would probably not work, but 1 probably
15409 would) to make it use less memory. This caching will probably be
15410 removed in the future.
15412 Startup is likely to be slower with @code{nnmaildir} than with other
15413 back ends. Everything else is likely to be faster, depending in part
15414 on your file system.
15416 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
15417 to write an @code{nnmaildir}-derived back end.
15422 @node Browsing the Web
15423 @section Browsing the Web
15425 @cindex browsing the web
15429 Web-based discussion forums are getting more and more popular. On many
15430 subjects, the web-based forums have become the most important forums,
15431 eclipsing the importance of mailing lists and news groups. The reason
15432 is easy to understand---they are friendly to new users; you just point
15433 and click, and there's the discussion. With mailing lists, you have to
15434 go through a cumbersome subscription procedure, and most people don't
15435 even know what a news group is.
15437 The problem with this scenario is that web browsers are not very good at
15438 being newsreaders. They do not keep track of what articles you've read;
15439 they do not allow you to score on subjects you're interested in; they do
15440 not allow off-line browsing; they require you to click around and drive
15441 you mad in the end.
15443 So---if web browsers suck at reading discussion forums, why not use Gnus
15446 Gnus has been getting a bit of a collection of back ends for providing
15447 interfaces to these sources.
15451 * Web Searches:: Creating groups from articles that match a string.
15452 * Slashdot:: Reading the Slashdot comments.
15453 * Ultimate:: The Ultimate Bulletin Board systems.
15454 * Web Archive:: Reading mailing list archived on web.
15455 * RSS:: Reading RDF site summary.
15456 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
15459 All the web sources require Emacs/w3 and the url library to work.
15461 The main caveat with all these web sources is that they probably won't
15462 work for a very long time. Gleaning information from the @acronym{HTML} data
15463 is guesswork at best, and when the layout is altered, the Gnus back end
15464 will fail. If you have reasonably new versions of these back ends,
15465 though, you should be ok.
15467 One thing all these Web methods have in common is that the Web sources
15468 are often down, unavailable or just plain too slow to be fun. In those
15469 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
15470 Unplugged}) handle downloading articles, and then you can read them at
15471 leisure from your local disk. No more World Wide Wait for you.
15473 @node Archiving Mail
15474 @subsection Archiving Mail
15475 @cindex archiving mail
15476 @cindex backup of mail
15478 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
15479 @code{nnmaildir}, now actually store the article marks with each group.
15480 For these servers, archiving and restoring a group while preserving
15481 marks is fairly simple.
15483 (Preserving the group level and group parameters as well still
15484 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
15487 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
15488 server, take a recursive copy of the server directory. There is no need
15489 to shut down Gnus, so archiving may be invoked by @code{cron} or
15490 similar. You restore the data by restoring the directory tree, and
15491 adding a server definition pointing to that directory in Gnus. The
15492 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
15493 might interfere with overwriting data, so you may want to shut down Gnus
15494 before you restore the data.
15496 It is also possible to archive individual @code{nnml},
15497 @code{nnfolder}, or @code{nnmaildir} groups, while preserving marks.
15498 For @code{nnml} or @code{nnmaildir}, you copy all files in the group's
15499 directory. For @code{nnfolder} you need to copy both the base folder
15500 file itself (@file{FOO}, say), and the marks file (@file{FOO.mrk} in
15501 this example). Restoring the group is done with @kbd{G m} from the Group
15502 buffer. The last step makes Gnus notice the new directory.
15503 @code{nnmaildir} notices the new directory automatically, so @kbd{G m}
15504 is unnecessary in that case.
15507 @subsection Web Searches
15512 @cindex Usenet searches
15513 @cindex searching the Usenet
15515 It's, like, too neat to search the Usenet for articles that match a
15516 string, but it, like, totally @emph{sucks}, like, totally, to use one of
15517 those, like, Web browsers, and you, like, have to, rilly, like, look at
15518 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
15519 searches without having to use a browser.
15521 The @code{nnweb} back end allows an easy interface to the mighty search
15522 engine. You create an @code{nnweb} group, enter a search pattern, and
15523 then enter the group and read the articles like you would any normal
15524 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
15525 Groups}) will do this in an easy-to-use fashion.
15527 @code{nnweb} groups don't really lend themselves to being solid
15528 groups---they have a very fleeting idea of article numbers. In fact,
15529 each time you enter an @code{nnweb} group (not even changing the search
15530 pattern), you are likely to get the articles ordered in a different
15531 manner. Not even using duplicate suppression (@pxref{Duplicate
15532 Suppression}) will help, since @code{nnweb} doesn't even know the
15533 @code{Message-ID} of the articles before reading them using some search
15534 engines (Google, for instance). The only possible way to keep track
15535 of which articles you've read is by scoring on the @code{Date}
15536 header---mark all articles posted before the last date you read the
15539 If the search engine changes its output substantially, @code{nnweb}
15540 won't be able to parse it and will fail. One could hardly fault the Web
15541 providers if they were to do this---their @emph{raison d'être} is to
15542 make money off of advertisements, not to provide services to the
15543 community. Since @code{nnweb} washes the ads off all the articles, one
15544 might think that the providers might be somewhat miffed. We'll see.
15546 You must have the @code{url} and @code{w3} package installed to be able
15547 to use @code{nnweb}.
15549 Virtual server variables:
15554 What search engine type is being used. The currently supported types
15555 are @code{google}, @code{dejanews}, and @code{gmane}. Note that
15556 @code{dejanews} is an alias to @code{google}.
15559 @vindex nnweb-search
15560 The search string to feed to the search engine.
15562 @item nnweb-max-hits
15563 @vindex nnweb-max-hits
15564 Advisory maximum number of hits per search to display. The default is
15567 @item nnweb-type-definition
15568 @vindex nnweb-type-definition
15569 Type-to-definition alist. This alist says what @code{nnweb} should do
15570 with the various search engine types. The following elements must be
15575 Function to decode the article and provide something that Gnus
15579 Function to create an article number to message header and URL alist.
15582 Function to send the search string to the search engine.
15585 The address the aforementioned function should send the search string
15589 Format string URL to fetch an article by @code{Message-ID}.
15596 @subsection Slashdot
15600 @uref{http://slashdot.org/, Slashdot} is a popular news site, with
15601 lively discussion following the news articles. @code{nnslashdot} will
15602 let you read this forum in a convenient manner.
15604 The easiest way to read this source is to put something like the
15605 following in your @file{~/.gnus.el} file:
15608 (setq gnus-secondary-select-methods
15609 '((nnslashdot "")))
15612 This will make Gnus query the @code{nnslashdot} back end for new comments
15613 and groups. The @kbd{F} command will subscribe each new news article as
15614 a new Gnus group, and you can read the comments by entering these
15615 groups. (Note that the default subscription method is to subscribe new
15616 groups as zombies. Other methods are available (@pxref{Subscription
15619 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
15620 command is the most handy tool (@pxref{Foreign Groups}).
15622 When following up to @code{nnslashdot} comments (or posting new
15623 comments), some light @acronym{HTML}izations will be performed. In
15624 particular, text quoted with @samp{> } will be quoted with
15625 @samp{blockquote} instead, and signatures will have @samp{br} added to
15626 the end of each line. Other than that, you can just write @acronym{HTML}
15627 directly into the message buffer. Note that Slashdot filters out some
15628 @acronym{HTML} forms.
15630 The following variables can be altered to change its behavior:
15633 @item nnslashdot-threaded
15634 Whether @code{nnslashdot} should display threaded groups or not. The
15635 default is @code{t}. To be able to display threads, @code{nnslashdot}
15636 has to retrieve absolutely all comments in a group upon entry. If a
15637 threaded display is not required, @code{nnslashdot} will only retrieve
15638 the comments that are actually wanted by the user. Threading is nicer,
15639 but much, much slower than unthreaded.
15641 @item nnslashdot-login-name
15642 @vindex nnslashdot-login-name
15643 The login name to use when posting.
15645 @item nnslashdot-password
15646 @vindex nnslashdot-password
15647 The password to use when posting.
15649 @item nnslashdot-directory
15650 @vindex nnslashdot-directory
15651 Where @code{nnslashdot} will store its files. The default is
15652 @file{~/News/slashdot/}.
15654 @item nnslashdot-active-url
15655 @vindex nnslashdot-active-url
15656 The @acronym{URL} format string that will be used to fetch the
15657 information on news articles and comments. The default is@*
15658 @samp{http://slashdot.org/search.pl?section=&min=%d}.
15660 @item nnslashdot-comments-url
15661 @vindex nnslashdot-comments-url
15662 The @acronym{URL} format string that will be used to fetch comments.
15664 @item nnslashdot-article-url
15665 @vindex nnslashdot-article-url
15666 The @acronym{URL} format string that will be used to fetch the news
15667 article. The default is
15668 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
15670 @item nnslashdot-threshold
15671 @vindex nnslashdot-threshold
15672 The score threshold. The default is -1.
15674 @item nnslashdot-group-number
15675 @vindex nnslashdot-group-number
15676 The number of old groups, in addition to the ten latest, to keep
15677 updated. The default is 0.
15684 @subsection Ultimate
15686 @cindex Ultimate Bulletin Board
15688 @uref{http://www.ultimatebb.com/, The Ultimate Bulletin Board} is
15689 probably the most popular Web bulletin board system used. It has a
15690 quite regular and nice interface, and it's possible to get the
15691 information Gnus needs to keep groups updated.
15693 The easiest way to get started with @code{nnultimate} is to say
15694 something like the following in the group buffer: @kbd{B nnultimate RET
15695 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @acronym{URL}
15696 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
15697 you're interested in; there's quite a list of them on the Ultimate web
15698 site.) Then subscribe to the groups you're interested in from the
15699 server buffer, and read them from the group buffer.
15701 The following @code{nnultimate} variables can be altered:
15704 @item nnultimate-directory
15705 @vindex nnultimate-directory
15706 The directory where @code{nnultimate} stores its files. The default is@*
15707 @file{~/News/ultimate/}.
15712 @subsection Web Archive
15714 @cindex Web Archive
15716 Some mailing lists only have archives on Web servers, such as
15717 @uref{http://www.egroups.com/} and
15718 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
15719 interface, and it's possible to get the information Gnus needs to keep
15722 @findex gnus-group-make-warchive-group
15723 The easiest way to get started with @code{nnwarchive} is to say
15724 something like the following in the group buffer: @kbd{M-x
15725 gnus-group-make-warchive-group RET @var{an_egroup} RET egroups RET
15726 www.egroups.com RET @var{your@@email.address} RET}. (Substitute the
15727 @var{an_egroup} with the mailing list you subscribed, the
15728 @var{your@@email.address} with your email address.), or to browse the
15729 back end by @kbd{B nnwarchive RET mail-archive RET}.
15731 The following @code{nnwarchive} variables can be altered:
15734 @item nnwarchive-directory
15735 @vindex nnwarchive-directory
15736 The directory where @code{nnwarchive} stores its files. The default is@*
15737 @file{~/News/warchive/}.
15739 @item nnwarchive-login
15740 @vindex nnwarchive-login
15741 The account name on the web server.
15743 @item nnwarchive-passwd
15744 @vindex nnwarchive-passwd
15745 The password for your account on the web server.
15753 Some web sites have an RDF Site Summary (@acronym{RSS}).
15754 @acronym{RSS} is a format for summarizing headlines from news related
15755 sites (such as BBC or CNN). But basically anything list-like can be
15756 presented as an @acronym{RSS} feed: weblogs, changelogs or recent
15757 changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}).
15759 @acronym{RSS} has a quite regular and nice interface, and it's
15760 possible to get the information Gnus needs to keep groups updated.
15762 Use @kbd{G R} from the summary buffer to subscribe to a feed---you
15763 will be prompted for the location of the feed.
15765 An easy way to get started with @code{nnrss} is to say something like
15766 the following in the group buffer: @kbd{B nnrss RET y}, then
15767 subscribe to groups.
15769 The following @code{nnrss} variables can be altered:
15772 @item nnrss-directory
15773 @vindex nnrss-directory
15774 The directory where @code{nnrss} stores its files. The default is
15775 @file{~/News/rss/}.
15777 @item nnrss-use-local
15778 @vindex nnrss-use-local
15779 @findex nnrss-generate-download-script
15780 If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read
15781 the feeds from local files in @code{nnrss-directory}. You can use
15782 the command @code{nnrss-generate-download-script} to generate a
15783 download script using @command{wget}.
15786 The following code may be helpful, if you want to show the description in
15787 the summary buffer.
15790 (add-to-list 'nnmail-extra-headers nnrss-description-field)
15791 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
15793 (defun gnus-user-format-function-X (header)
15795 (assq nnrss-description-field (mail-header-extra header))))
15796 (if descr (concat "\n\t" (cdr descr)) "")))
15799 The following code may be useful to open an nnrss url directly from the
15802 (require 'browse-url)
15804 (defun browse-nnrss-url( arg )
15806 (let ((url (assq nnrss-url-field
15809 (assq (gnus-summary-article-number)
15810 gnus-newsgroup-data))))))
15813 (browse-url (cdr url))
15814 (gnus-summary-mark-as-read-forward 1))
15815 (gnus-summary-scroll-up arg))))
15817 (eval-after-load "gnus"
15818 #'(define-key gnus-summary-mode-map
15819 (kbd "<RET>") 'browse-nnrss-url))
15820 (add-to-list 'nnmail-extra-headers nnrss-url-field)
15823 @node Customizing w3
15824 @subsection Customizing w3
15830 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
15831 pages. Emacs/w3 is documented in its own manual, but there are some
15832 things that may be more relevant for Gnus users.
15834 For instance, a common question is how to make Emacs/w3 follow links
15835 using the @code{browse-url} functions (which will call some external web
15836 browser like Netscape). Here's one way:
15839 (eval-after-load "w3"
15841 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
15842 (defun w3-fetch (&optional url target)
15843 (interactive (list (w3-read-url-with-default)))
15844 (if (eq major-mode 'gnus-article-mode)
15846 (w3-fetch-orig url target)))))
15849 Put that in your @file{.emacs} file, and hitting links in w3-rendered
15850 @acronym{HTML} in the Gnus article buffers will use @code{browse-url} to
15857 @cindex @acronym{IMAP}
15859 @acronym{IMAP} is a network protocol for reading mail (or news, or @dots{}),
15860 think of it as a modernized @acronym{NNTP}. Connecting to a @acronym{IMAP}
15861 server is much similar to connecting to a news server, you just
15862 specify the network address of the server.
15864 @acronym{IMAP} has two properties. First, @acronym{IMAP} can do
15865 everything that @acronym{POP} can, it can hence be viewed as a
15866 @acronym{POP++}. Secondly, @acronym{IMAP} is a mail storage protocol,
15867 similar to @acronym{NNTP} being a news storage protocol---however,
15868 @acronym{IMAP} offers more features than @acronym{NNTP} because news
15869 is more or less read-only whereas mail is read-write.
15871 If you want to use @acronym{IMAP} as a @acronym{POP++}, use an imap
15872 entry in @code{mail-sources}. With this, Gnus will fetch mails from
15873 the @acronym{IMAP} server and store them on the local disk. This is
15874 not the usage described in this section---@xref{Mail Sources}.
15876 If you want to use @acronym{IMAP} as a mail storage protocol, use an nnimap
15877 entry in @code{gnus-secondary-select-methods}. With this, Gnus will
15878 manipulate mails stored on the @acronym{IMAP} server. This is the kind of
15879 usage explained in this section.
15881 A server configuration in @file{~/.gnus.el} with a few @acronym{IMAP}
15882 servers might look something like the following. (Note that for
15883 @acronym{TLS}/@acronym{SSL}, you need external programs and libraries,
15887 (setq gnus-secondary-select-methods
15888 '((nnimap "simpleserver") ; @r{no special configuration}
15889 ; @r{perhaps a ssh port forwarded server:}
15891 (nnimap-address "localhost")
15892 (nnimap-server-port 1430))
15893 ; @r{a UW server running on localhost}
15895 (nnimap-server-port 143)
15896 (nnimap-address "localhost")
15897 (nnimap-list-pattern ("INBOX" "mail/*")))
15898 ; @r{anonymous public cyrus server:}
15899 (nnimap "cyrus.andrew.cmu.edu"
15900 (nnimap-authenticator anonymous)
15901 (nnimap-list-pattern "archive.*")
15902 (nnimap-stream network))
15903 ; @r{a ssl server on a non-standard port:}
15905 (nnimap-address "vic20.somewhere.com")
15906 (nnimap-server-port 9930)
15907 (nnimap-stream ssl))))
15910 After defining the new server, you can subscribe to groups on the
15911 server using normal Gnus commands such as @kbd{U} in the Group Buffer
15912 (@pxref{Subscription Commands}) or via the Server Buffer
15913 (@pxref{Server Buffer}).
15915 The following variables can be used to create a virtual @code{nnimap}
15920 @item nnimap-address
15921 @vindex nnimap-address
15923 The address of the remote @acronym{IMAP} server. Defaults to the virtual
15924 server name if not specified.
15926 @item nnimap-server-port
15927 @vindex nnimap-server-port
15928 Port on server to contact. Defaults to port 143, or 993 for @acronym{TLS}/@acronym{SSL}.
15930 Note that this should be an integer, example server specification:
15933 (nnimap "mail.server.com"
15934 (nnimap-server-port 4711))
15937 @item nnimap-list-pattern
15938 @vindex nnimap-list-pattern
15939 String or list of strings of mailboxes to limit available groups to.
15940 This is used when the server has very many mailboxes and you're only
15941 interested in a few---some servers export your home directory via
15942 @acronym{IMAP}, you'll probably want to limit the mailboxes to those in
15943 @file{~/Mail/*} then.
15945 The string can also be a cons of REFERENCE and the string as above, what
15946 REFERENCE is used for is server specific, but on the University of
15947 Washington server it's a directory that will be concatenated with the
15950 Example server specification:
15953 (nnimap "mail.server.com"
15954 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
15955 ("~friend/Mail/" . "list/*"))))
15958 @item nnimap-stream
15959 @vindex nnimap-stream
15960 The type of stream used to connect to your server. By default, nnimap
15961 will detect and automatically use all of the below, with the exception
15962 of @acronym{TLS}/@acronym{SSL}. (@acronym{IMAP} over
15963 @acronym{TLS}/@acronym{SSL} is being replaced by STARTTLS, which can
15964 be automatically detected, but it's not widely deployed yet.)
15966 Example server specification:
15969 (nnimap "mail.server.com"
15970 (nnimap-stream ssl))
15973 Please note that the value of @code{nnimap-stream} is a symbol!
15977 @dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5). Requires the
15978 @samp{gsasl} or @samp{imtest} program.
15980 @dfn{kerberos4:} Connect with Kerberos 4. Requires the @samp{imtest} program.
15982 @dfn{starttls:} Connect via the STARTTLS extension (similar to
15983 @acronym{TLS}/@acronym{SSL}). Requires the external library @samp{starttls.el} and program
15986 @dfn{tls:} Connect through @acronym{TLS}. Requires GNUTLS (the program
15987 @samp{gnutls-cli}).
15989 @dfn{ssl:} Connect through @acronym{SSL}. Requires OpenSSL (the program
15990 @samp{openssl}) or SSLeay (@samp{s_client}).
15992 @dfn{shell:} Use a shell command to start @acronym{IMAP} connection.
15994 @dfn{network:} Plain, TCP/IP network connection.
15997 @vindex imap-kerberos4-program
15998 The @samp{imtest} program is shipped with Cyrus IMAPD. If you're
15999 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
16000 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
16001 to make @code{imap.el} use a pty instead of a pipe when communicating
16002 with @samp{imtest}. You will then suffer from a line length
16003 restrictions on @acronym{IMAP} commands, which might make Gnus seem to hang
16004 indefinitely if you have many articles in a mailbox. The variable
16005 @code{imap-kerberos4-program} contain parameters to pass to the imtest
16008 For @acronym{TLS} connection, the @code{gnutls-cli} program from GNUTLS is
16009 needed. It is available from
16010 @uref{http://www.gnu.org/software/gnutls/}.
16012 @vindex imap-gssapi-program
16013 This parameter specifies a list of command lines that invoke a GSSAPI
16014 authenticated @acronym{IMAP} stream in a subshell. They are tried
16015 sequentially until a connection is made, or the list has been
16016 exhausted. By default, @samp{gsasl} from GNU SASL, available from
16017 @uref{http://www.gnu.org/software/gsasl/}, and the @samp{imtest}
16018 program from Cyrus IMAPD (see @code{imap-kerberos4-program}), are
16021 @vindex imap-ssl-program
16022 For @acronym{SSL} connections, the OpenSSL program is available from
16023 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
16024 and nnimap support it too---although the most recent versions of
16025 SSLeay, 0.9.x, are known to have serious bugs making it
16026 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
16027 work. The variable @code{imap-ssl-program} contain parameters to pass
16030 @vindex imap-shell-program
16031 @vindex imap-shell-host
16032 For @acronym{IMAP} connections using the @code{shell} stream, the variable
16033 @code{imap-shell-program} specify what program to call.
16035 @item nnimap-authenticator
16036 @vindex nnimap-authenticator
16038 The authenticator used to connect to the server. By default, nnimap
16039 will use the most secure authenticator your server is capable of.
16041 Example server specification:
16044 (nnimap "mail.server.com"
16045 (nnimap-authenticator anonymous))
16048 Please note that the value of @code{nnimap-authenticator} is a symbol!
16052 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Requires
16053 external program @code{gsasl} or @code{imtest}.
16055 @dfn{kerberos4:} Kerberos 4 authentication. Requires external program
16058 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Requires
16059 external library @code{digest-md5.el}.
16061 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
16063 @dfn{login:} Plain-text username/password via LOGIN.
16065 @dfn{anonymous:} Login as ``anonymous'', supplying your email address as password.
16068 @item nnimap-expunge-on-close
16070 @vindex nnimap-expunge-on-close
16071 Unlike Parmenides the @acronym{IMAP} designers have decided things that
16072 don't exist actually do exist. More specifically, @acronym{IMAP} has
16073 this concept of marking articles @code{Deleted} which doesn't actually
16074 delete them, and this (marking them @code{Deleted}, that is) is what
16075 nnimap does when you delete an article in Gnus (with @kbd{B DEL} or
16078 Since the articles aren't really removed when we mark them with the
16079 @code{Deleted} flag we'll need a way to actually delete them. Feel like
16080 running in circles yet?
16082 Traditionally, nnimap has removed all articles marked as @code{Deleted}
16083 when closing a mailbox but this is now configurable by this server
16086 The possible options are:
16091 The default behavior, delete all articles marked as ``Deleted'' when
16094 Never actually delete articles. Currently there is no way of showing
16095 the articles marked for deletion in nnimap, but other @acronym{IMAP} clients
16096 may allow you to do this. If you ever want to run the EXPUNGE command
16097 manually, @xref{Expunging mailboxes}.
16099 When closing mailboxes, nnimap will ask if you wish to expunge deleted
16104 @item nnimap-importantize-dormant
16105 @vindex nnimap-importantize-dormant
16107 If non-@code{nil} (the default), marks dormant articles as ticked (as
16108 well), for other @acronym{IMAP} clients. Within Gnus, dormant articles will
16109 naturally still (only) be marked as dormant. This is to make dormant
16110 articles stand out, just like ticked articles, in other @acronym{IMAP}
16111 clients. (In other words, Gnus has two ``Tick'' marks and @acronym{IMAP}
16114 Probably the only reason for frobing this would be if you're trying
16115 enable per-user persistent dormant flags, using something like:
16118 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
16119 (format "gnus-dormant-%s" (user-login-name)))
16120 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
16121 (format "KEYWORD gnus-dormant-%s" (user-login-name)))
16124 In this case, you would not want the per-user dormant flag showing up
16125 as ticked for other users.
16127 @item nnimap-expunge-search-string
16129 @vindex nnimap-expunge-search-string
16131 This variable contain the @acronym{IMAP} search command sent to server when
16132 searching for articles eligible for expiring. The default is
16133 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
16134 UID set and the second @code{%s} is replaced by a date.
16136 Probably the only useful value to change this to is
16137 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
16138 messages instead of the internal article date. See section 6.4.4 of
16139 RFC 2060 for more information on valid strings.
16141 @item nnimap-authinfo-file
16142 @vindex nnimap-authinfo-file
16144 A file containing credentials used to log in on servers. The format is
16145 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
16146 variable @code{nntp-authinfo-file} for exact syntax; also see
16149 @item nnimap-need-unselect-to-notice-new-mail
16150 @vindex nnimap-need-unselect-to-notice-new-mail
16152 Unselect mailboxes before looking for new mail in them. Some servers
16153 seem to need this under some circumstances; it was reported that
16159 * Splitting in IMAP:: Splitting mail with nnimap.
16160 * Expiring in IMAP:: Expiring mail with nnimap.
16161 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
16162 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
16163 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
16164 * Debugging IMAP:: What to do when things don't work.
16169 @node Splitting in IMAP
16170 @subsection Splitting in IMAP
16171 @cindex splitting imap mail
16173 Splitting is something Gnus users have loved and used for years, and now
16174 the rest of the world is catching up. Yeah, dream on, not many
16175 @acronym{IMAP} servers have server side splitting and those that have
16176 splitting seem to use some non-standard protocol. This means that
16177 @acronym{IMAP} support for Gnus has to do its own splitting.
16181 (Incidentally, people seem to have been dreaming on, and Sieve has
16182 gaining a market share and is supported by several IMAP servers.
16183 Fortunately, Gnus support it too, @xref{Sieve Commands}.)
16185 Here are the variables of interest:
16189 @item nnimap-split-crosspost
16190 @cindex splitting, crosspost
16192 @vindex nnimap-split-crosspost
16194 If non-@code{nil}, do crossposting if several split methods match the
16195 mail. If @code{nil}, the first match in @code{nnimap-split-rule}
16196 found will be used.
16198 Nnmail equivalent: @code{nnmail-crosspost}.
16200 @item nnimap-split-inbox
16201 @cindex splitting, inbox
16203 @vindex nnimap-split-inbox
16205 A string or a list of strings that gives the name(s) of @acronym{IMAP}
16206 mailboxes to split from. Defaults to @code{nil}, which means that
16207 splitting is disabled!
16210 (setq nnimap-split-inbox
16211 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
16214 No nnmail equivalent.
16216 @item nnimap-split-rule
16217 @cindex splitting, rules
16218 @vindex nnimap-split-rule
16220 New mail found in @code{nnimap-split-inbox} will be split according to
16223 This variable contains a list of lists, where the first element in the
16224 sublist gives the name of the @acronym{IMAP} mailbox to move articles
16225 matching the regexp in the second element in the sublist. Got that?
16226 Neither did I, we need examples.
16229 (setq nnimap-split-rule
16231 "^Sender: owner-nnimap@@vic20.globalcom.se")
16232 ("INBOX.junk" "^Subject:.*MAKE MONEY")
16233 ("INBOX.private" "")))
16236 This will put all articles from the nnimap mailing list into mailbox
16237 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
16238 into INBOX.junk and everything else in INBOX.private.
16240 The first string may contain @samp{\\1} forms, like the ones used by
16241 replace-match to insert sub-expressions from the matched text. For
16245 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
16248 The first element can also be the symbol @code{junk} to indicate that
16249 matching messages should simply be deleted. Use with care.
16251 The second element can also be a function. In that case, it will be
16252 called with the first element of the rule as the argument, in a buffer
16253 containing the headers of the article. It should return a
16254 non-@code{nil} value if it thinks that the mail belongs in that group.
16256 Nnmail users might recollect that the last regexp had to be empty to
16257 match all articles (like in the example above). This is not required in
16258 nnimap. Articles not matching any of the regexps will not be moved out
16259 of your inbox. (This might affect performance if you keep lots of
16260 unread articles in your inbox, since the splitting code would go over
16261 them every time you fetch new mail.)
16263 These rules are processed from the beginning of the alist toward the
16264 end. The first rule to make a match will ``win'', unless you have
16265 crossposting enabled. In that case, all matching rules will ``win''.
16267 This variable can also have a function as its value, the function will
16268 be called with the headers narrowed and should return a group where it
16269 thinks the article should be split to. See @code{nnimap-split-fancy}.
16271 The splitting code tries to create mailboxes if it needs to.
16273 To allow for different split rules on different virtual servers, and
16274 even different split rules in different inboxes on the same server,
16275 the syntax of this variable have been extended along the lines of:
16278 (setq nnimap-split-rule
16279 '(("my1server" (".*" (("ding" "ding@@gnus.org")
16280 ("junk" "From:.*Simon"))))
16281 ("my2server" ("INBOX" nnimap-split-fancy))
16282 ("my[34]server" (".*" (("private" "To:.*Simon")
16283 ("junk" my-junk-func))))))
16286 The virtual server name is in fact a regexp, so that the same rules
16287 may apply to several servers. In the example, the servers
16288 @code{my3server} and @code{my4server} both use the same rules.
16289 Similarly, the inbox string is also a regexp. The actual splitting
16290 rules are as before, either a function, or a list with group/regexp or
16291 group/function elements.
16293 Nnmail equivalent: @code{nnmail-split-methods}.
16295 @item nnimap-split-predicate
16297 @vindex nnimap-split-predicate
16299 Mail matching this predicate in @code{nnimap-split-inbox} will be
16300 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
16302 This might be useful if you use another @acronym{IMAP} client to read mail in
16303 your inbox but would like Gnus to split all articles in the inbox
16304 regardless of readedness. Then you might change this to
16307 @item nnimap-split-fancy
16308 @cindex splitting, fancy
16309 @findex nnimap-split-fancy
16310 @vindex nnimap-split-fancy
16312 It's possible to set @code{nnimap-split-rule} to
16313 @code{nnmail-split-fancy} if you want to use fancy
16314 splitting. @xref{Fancy Mail Splitting}.
16316 However, to be able to have different fancy split rules for nnmail and
16317 nnimap back ends you can set @code{nnimap-split-rule} to
16318 @code{nnimap-split-fancy} and define the nnimap specific fancy split
16319 rule in @code{nnimap-split-fancy}.
16324 (setq nnimap-split-rule 'nnimap-split-fancy
16325 nnimap-split-fancy ...)
16328 Nnmail equivalent: @code{nnmail-split-fancy}.
16330 @item nnimap-split-download-body
16331 @findex nnimap-split-download-body
16332 @vindex nnimap-split-download-body
16334 Set to non-@code{nil} to download entire articles during splitting.
16335 This is generally not required, and will slow things down
16336 considerably. You may need it if you want to use an advanced
16337 splitting function that analyses the body to split the article.
16341 @node Expiring in IMAP
16342 @subsection Expiring in IMAP
16343 @cindex expiring imap mail
16345 Even though @code{nnimap} is not a proper @code{nnmail} derived back
16346 end, it supports most features in regular expiring (@pxref{Expiring
16347 Mail}). Unlike splitting in @acronym{IMAP} (@pxref{Splitting in
16348 IMAP}) it does not clone the @code{nnmail} variables (i.e., creating
16349 @var{nnimap-expiry-wait}) but reuse the @code{nnmail} variables. What
16350 follows below are the variables used by the @code{nnimap} expiry
16353 A note on how the expire mark is stored on the @acronym{IMAP} server is
16354 appropriate here as well. The expire mark is translated into a
16355 @code{imap} client specific mark, @code{gnus-expire}, and stored on the
16356 message. This means that likely only Gnus will understand and treat
16357 the @code{gnus-expire} mark properly, although other clients may allow
16358 you to view client specific flags on the message. It also means that
16359 your server must support permanent storage of client specific flags on
16360 messages. Most do, fortunately.
16364 @item nnmail-expiry-wait
16365 @item nnmail-expiry-wait-function
16367 These variables are fully supported. The expire value can be a
16368 number, the symbol @code{immediate} or @code{never}.
16370 @item nnmail-expiry-target
16372 This variable is supported, and internally implemented by calling the
16373 @code{nnmail} functions that handle this. It contains an optimization
16374 that if the destination is a @acronym{IMAP} group on the same server, the
16375 article is copied instead of appended (that is, uploaded again).
16379 @node Editing IMAP ACLs
16380 @subsection Editing IMAP ACLs
16381 @cindex editing imap acls
16382 @cindex Access Control Lists
16383 @cindex Editing @acronym{IMAP} ACLs
16384 @kindex G l (Group)
16385 @findex gnus-group-nnimap-edit-acl
16387 ACL stands for Access Control List. ACLs are used in @acronym{IMAP} for
16388 limiting (or enabling) other users access to your mail boxes. Not all
16389 @acronym{IMAP} servers support this, this function will give an error if it
16392 To edit an ACL for a mailbox, type @kbd{G l}
16393 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with an ACL
16394 editing window with detailed instructions.
16396 Some possible uses:
16400 Giving ``anyone'' the ``lrs'' rights (lookup, read, keep seen/unseen flags)
16401 on your mailing list mailboxes enables other users on the same server to
16402 follow the list without subscribing to it.
16404 At least with the Cyrus server, you are required to give the user
16405 ``anyone'' posting ("p") capabilities to have ``plussing'' work (that is,
16406 mail sent to user+mailbox@@domain ending up in the @acronym{IMAP} mailbox
16410 @node Expunging mailboxes
16411 @subsection Expunging mailboxes
16415 @cindex manual expunging
16416 @kindex G x (Group)
16417 @findex gnus-group-nnimap-expunge
16419 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
16420 you may want the option of expunging all deleted articles in a mailbox
16421 manually. This is exactly what @kbd{G x} does.
16423 Currently there is no way of showing deleted articles, you can just
16426 @node A note on namespaces
16427 @subsection A note on namespaces
16428 @cindex IMAP namespace
16431 The @acronym{IMAP} protocol has a concept called namespaces, described
16432 by the following text in the RFC:
16435 5.1.2. Mailbox Namespace Naming Convention
16437 By convention, the first hierarchical element of any mailbox name
16438 which begins with "#" identifies the "namespace" of the remainder of
16439 the name. This makes it possible to disambiguate between different
16440 types of mailbox stores, each of which have their own namespaces.
16442 For example, implementations which offer access to USENET
16443 newsgroups MAY use the "#news" namespace to partition the USENET
16444 newsgroup namespace from that of other mailboxes. Thus, the
16445 comp.mail.misc newsgroup would have an mailbox name of
16446 "#news.comp.mail.misc", and the name "comp.mail.misc" could refer
16447 to a different object (e.g. a user's private mailbox).
16450 While there is nothing in this text that warrants concern for the
16451 @acronym{IMAP} implementation in Gnus, some servers use namespace
16452 prefixes in a way that does not work with how Gnus uses mailbox names.
16454 Specifically, University of Washington's @acronym{IMAP} server uses
16455 mailbox names like @code{#driver.mbx/read-mail} which are valid only
16456 in the @sc{create} and @sc{append} commands. After the mailbox is
16457 created (or a messages is appended to a mailbox), it must be accessed
16458 without the namespace prefix, i.e. @code{read-mail}. Since Gnus do
16459 not make it possible for the user to guarantee that user entered
16460 mailbox names will only be used with the CREATE and APPEND commands,
16461 you should simply not use the namespace prefixed mailbox names in
16464 See the UoW IMAPD documentation for the @code{#driver.*/} prefix
16465 for more information on how to use the prefixes. They are a power
16466 tool and should be used only if you are sure what the effects are.
16468 @node Debugging IMAP
16469 @subsection Debugging IMAP
16470 @cindex IMAP debugging
16471 @cindex protocol dump (IMAP)
16473 @acronym{IMAP} is a complex protocol, more so than @acronym{NNTP} or
16474 @acronym{POP3}. Implementation bugs are not unlikely, and we do our
16475 best to fix them right away. If you encounter odd behaviour, chances
16476 are that either the server or Gnus is buggy.
16478 If you are familiar with network protocols in general, you will
16479 probably be able to extract some clues from the protocol dump of the
16480 exchanges between Gnus and the server. Even if you are not familiar
16481 with network protocols, when you include the protocol dump in
16482 @acronym{IMAP}-related bug reports you are helping us with data
16483 critical to solving the problem. Therefore, we strongly encourage you
16484 to include the protocol dump when reporting IMAP bugs in Gnus.
16488 Because the protocol dump, when enabled, generates lots of data, it is
16489 disabled by default. You can enable it by setting @code{imap-log} as
16496 This instructs the @code{imap.el} package to log any exchanges with
16497 the server. The log is stored in the buffer @samp{*imap-log*}. Look
16498 for error messages, which sometimes are tagged with the keyword
16499 @code{BAD} - but when submitting a bug, make sure to include all the
16502 @node Other Sources
16503 @section Other Sources
16505 Gnus can do more than just read news or mail. The methods described
16506 below allow Gnus to view directories and files as if they were
16510 * Directory Groups:: You can read a directory as if it was a newsgroup.
16511 * Anything Groups:: Dired? Who needs dired?
16512 * Document Groups:: Single files can be the basis of a group.
16513 * SOUP:: Reading @sc{soup} packets ``offline''.
16514 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
16518 @node Directory Groups
16519 @subsection Directory Groups
16521 @cindex directory groups
16523 If you have a directory that has lots of articles in separate files in
16524 it, you might treat it as a newsgroup. The files have to have numerical
16527 This might be an opportune moment to mention @code{ange-ftp} (and its
16528 successor @code{efs}), that most wonderful of all wonderful Emacs
16529 packages. When I wrote @code{nndir}, I didn't think much about it---a
16530 back end to read directories. Big deal.
16532 @code{ange-ftp} changes that picture dramatically. For instance, if you
16533 enter the @code{ange-ftp} file name
16534 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
16535 @code{ange-ftp} or @code{efs} will actually allow you to read this
16536 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
16538 @code{nndir} will use @acronym{NOV} files if they are present.
16540 @code{nndir} is a ``read-only'' back end---you can't delete or expire
16541 articles with this method. You can use @code{nnmh} or @code{nnml} for
16542 whatever you use @code{nndir} for, so you could switch to any of those
16543 methods if you feel the need to have a non-read-only @code{nndir}.
16546 @node Anything Groups
16547 @subsection Anything Groups
16550 From the @code{nndir} back end (which reads a single spool-like
16551 directory), it's just a hop and a skip to @code{nneething}, which
16552 pretends that any arbitrary directory is a newsgroup. Strange, but
16555 When @code{nneething} is presented with a directory, it will scan this
16556 directory and assign article numbers to each file. When you enter such
16557 a group, @code{nneething} must create ``headers'' that Gnus can use.
16558 After all, Gnus is a newsreader, in case you're forgetting.
16559 @code{nneething} does this in a two-step process. First, it snoops each
16560 file in question. If the file looks like an article (i.e., the first
16561 few lines look like headers), it will use this as the head. If this is
16562 just some arbitrary file without a head (e.g. a C source file),
16563 @code{nneething} will cobble up a header out of thin air. It will use
16564 file ownership, name and date and do whatever it can with these
16567 All this should happen automatically for you, and you will be presented
16568 with something that looks very much like a newsgroup. Totally like a
16569 newsgroup, to be precise. If you select an article, it will be displayed
16570 in the article buffer, just as usual.
16572 If you select a line that represents a directory, Gnus will pop you into
16573 a new summary buffer for this @code{nneething} group. And so on. You can
16574 traverse the entire disk this way, if you feel like, but remember that
16575 Gnus is not dired, really, and does not intend to be, either.
16577 There are two overall modes to this action---ephemeral or solid. When
16578 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
16579 will not store information on what files you have read, and what files
16580 are new, and so on. If you create a solid @code{nneething} group the
16581 normal way with @kbd{G m}, Gnus will store a mapping table between
16582 article numbers and file names, and you can treat this group like any
16583 other groups. When you activate a solid @code{nneething} group, you will
16584 be told how many unread articles it contains, etc., etc.
16589 @item nneething-map-file-directory
16590 @vindex nneething-map-file-directory
16591 All the mapping files for solid @code{nneething} groups will be stored
16592 in this directory, which defaults to @file{~/.nneething/}.
16594 @item nneething-exclude-files
16595 @vindex nneething-exclude-files
16596 All files that match this regexp will be ignored. Nice to use to exclude
16597 auto-save files and the like, which is what it does by default.
16599 @item nneething-include-files
16600 @vindex nneething-include-files
16601 Regexp saying what files to include in the group. If this variable is
16602 non-@code{nil}, only files matching this regexp will be included.
16604 @item nneething-map-file
16605 @vindex nneething-map-file
16606 Name of the map files.
16610 @node Document Groups
16611 @subsection Document Groups
16613 @cindex documentation group
16616 @code{nndoc} is a cute little thing that will let you read a single file
16617 as a newsgroup. Several files types are supported:
16624 The Babyl (Rmail) mail box.
16629 The standard Unix mbox file.
16631 @cindex MMDF mail box
16633 The MMDF mail box format.
16636 Several news articles appended into a file.
16639 @cindex rnews batch files
16640 The rnews batch transport format.
16641 @cindex forwarded messages
16644 Forwarded articles.
16647 Netscape mail boxes.
16650 @acronym{MIME} multipart messages.
16652 @item standard-digest
16653 The standard (RFC 1153) digest format.
16656 A @acronym{MIME} digest of messages.
16658 @item lanl-gov-announce
16659 Announcement messages from LANL Gov Announce.
16661 @item rfc822-forward
16662 A message forwarded according to RFC822.
16665 The Outlook mail box.
16668 The Outlook Express dbx mail box.
16671 A bounce message from the Exim MTA.
16674 A message forwarded according to informal rules.
16677 An RFC934-forwarded message.
16683 A digest of Clarinet brief news items.
16686 Non-standard digest format---matches most things, but does it badly.
16692 You can also use the special ``file type'' @code{guess}, which means
16693 that @code{nndoc} will try to guess what file type it is looking at.
16694 @code{digest} means that @code{nndoc} should guess what digest type the
16697 @code{nndoc} will not try to change the file or insert any extra headers into
16698 it---it will simply, like, let you use the file as the basis for a
16699 group. And that's it.
16701 If you have some old archived articles that you want to insert into your
16702 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
16703 that. Say you have an old @file{RMAIL} file with mail that you now want
16704 to split into your new @code{nnml} groups. You look at that file using
16705 @code{nndoc} (using the @kbd{G f} command in the group buffer
16706 (@pxref{Foreign Groups})), set the process mark on all the articles in
16707 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
16708 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
16709 file is now also stored in lots of @code{nnml} directories, and you can
16710 delete that pesky @file{RMAIL} file. If you have the guts!
16712 Virtual server variables:
16715 @item nndoc-article-type
16716 @vindex nndoc-article-type
16717 This should be one of @code{mbox}, @code{babyl}, @code{digest},
16718 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
16719 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
16720 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
16721 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
16723 @item nndoc-post-type
16724 @vindex nndoc-post-type
16725 This variable says whether Gnus is to consider the group a news group or
16726 a mail group. There are two valid values: @code{mail} (the default)
16731 * Document Server Internals:: How to add your own document types.
16735 @node Document Server Internals
16736 @subsubsection Document Server Internals
16738 Adding new document types to be recognized by @code{nndoc} isn't
16739 difficult. You just have to whip up a definition of what the document
16740 looks like, write a predicate function to recognize that document type,
16741 and then hook into @code{nndoc}.
16743 First, here's an example document type definition:
16747 (article-begin . "^\^A\^A\^A\^A\n")
16748 (body-end . "^\^A\^A\^A\^A\n"))
16751 The definition is simply a unique @dfn{name} followed by a series of
16752 regexp pseudo-variable settings. Below are the possible
16753 variables---don't be daunted by the number of variables; most document
16754 types can be defined with very few settings:
16757 @item first-article
16758 If present, @code{nndoc} will skip past all text until it finds
16759 something that match this regexp. All text before this will be
16762 @item article-begin
16763 This setting has to be present in all document type definitions. It
16764 says what the beginning of each article looks like.
16766 @item head-begin-function
16767 If present, this should be a function that moves point to the head of
16770 @item nndoc-head-begin
16771 If present, this should be a regexp that matches the head of the
16774 @item nndoc-head-end
16775 This should match the end of the head of the article. It defaults to
16776 @samp{^$}---the empty line.
16778 @item body-begin-function
16779 If present, this function should move point to the beginning of the body
16783 This should match the beginning of the body of the article. It defaults
16786 @item body-end-function
16787 If present, this function should move point to the end of the body of
16791 If present, this should match the end of the body of the article.
16794 If present, this should match the end of the file. All text after this
16795 regexp will be totally ignored.
16799 So, using these variables @code{nndoc} is able to dissect a document
16800 file into a series of articles, each with a head and a body. However, a
16801 few more variables are needed since not all document types are all that
16802 news-like---variables needed to transform the head or the body into
16803 something that's palatable for Gnus:
16806 @item prepare-body-function
16807 If present, this function will be called when requesting an article. It
16808 will be called with point at the start of the body, and is useful if the
16809 document has encoded some parts of its contents.
16811 @item article-transform-function
16812 If present, this function is called when requesting an article. It's
16813 meant to be used for more wide-ranging transformation of both head and
16814 body of the article.
16816 @item generate-head-function
16817 If present, this function is called to generate a head that Gnus can
16818 understand. It is called with the article number as a parameter, and is
16819 expected to generate a nice head for the article in question. It is
16820 called when requesting the headers of all articles.
16824 Let's look at the most complicated example I can come up with---standard
16829 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
16830 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
16831 (prepare-body-function . nndoc-unquote-dashes)
16832 (body-end-function . nndoc-digest-body-end)
16833 (head-end . "^ ?$")
16834 (body-begin . "^ ?\n")
16835 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
16836 (subtype digest guess))
16839 We see that all text before a 70-width line of dashes is ignored; all
16840 text after a line that starts with that @samp{^End of} is also ignored;
16841 each article begins with a 30-width line of dashes; the line separating
16842 the head from the body may contain a single space; and that the body is
16843 run through @code{nndoc-unquote-dashes} before being delivered.
16845 To hook your own document definition into @code{nndoc}, use the
16846 @code{nndoc-add-type} function. It takes two parameters---the first
16847 is the definition itself and the second (optional) parameter says
16848 where in the document type definition alist to put this definition.
16849 The alist is traversed sequentially, and
16850 @code{nndoc-@var{type}-type-p} is called for a given type @var{type}.
16851 So @code{nndoc-mmdf-type-p} is called to see whether a document is of
16852 @code{mmdf} type, and so on. These type predicates should return
16853 @code{nil} if the document is not of the correct type; @code{t} if it
16854 is of the correct type; and a number if the document might be of the
16855 correct type. A high number means high probability; a low number
16856 means low probability with @samp{0} being the lowest valid number.
16864 In the PC world people often talk about ``offline'' newsreaders. These
16865 are thingies that are combined reader/news transport monstrosities.
16866 With built-in modem programs. Yecchh!
16868 Of course, us Unix Weenie types of human beans use things like
16869 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
16870 transport things like Ghod intended. And then we just use normal
16873 However, it can sometimes be convenient to do something that's a bit
16874 easier on the brain if you have a very slow modem, and you're not really
16875 that interested in doing things properly.
16877 A file format called @sc{soup} has been developed for transporting news
16878 and mail from servers to home machines and back again. It can be a bit
16881 First some terminology:
16886 This is the machine that is connected to the outside world and where you
16887 get news and/or mail from.
16890 This is the machine that you want to do the actual reading and responding
16891 on. It is typically not connected to the rest of the world in any way.
16894 Something that contains messages and/or commands. There are two kinds
16898 @item message packets
16899 These are packets made at the server, and typically contain lots of
16900 messages for you to read. These are called @file{SoupoutX.tgz} by
16901 default, where @var{x} is a number.
16903 @item response packets
16904 These are packets made at the home machine, and typically contains
16905 replies that you've written. These are called @file{SoupinX.tgz} by
16906 default, where @var{x} is a number.
16916 You log in on the server and create a @sc{soup} packet. You can either
16917 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
16918 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
16919 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
16922 You transfer the packet home. Rail, boat, car or modem will do fine.
16925 You put the packet in your home directory.
16928 You fire up Gnus on your home machine using the @code{nnsoup} back end as
16929 the native or secondary server.
16932 You read articles and mail and answer and followup to the things you
16933 want (@pxref{SOUP Replies}).
16936 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
16940 You transfer this packet to the server.
16943 You use Gnus to mail this packet out with the @kbd{G s s} command.
16946 You then repeat until you die.
16950 So you basically have a bipartite system---you use @code{nnsoup} for
16951 reading and Gnus for packing/sending these @sc{soup} packets.
16954 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
16955 * SOUP Groups:: A back end for reading @sc{soup} packets.
16956 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
16960 @node SOUP Commands
16961 @subsubsection SOUP Commands
16963 These are commands for creating and manipulating @sc{soup} packets.
16967 @kindex G s b (Group)
16968 @findex gnus-group-brew-soup
16969 Pack all unread articles in the current group
16970 (@code{gnus-group-brew-soup}). This command understands the
16971 process/prefix convention.
16974 @kindex G s w (Group)
16975 @findex gnus-soup-save-areas
16976 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
16979 @kindex G s s (Group)
16980 @findex gnus-soup-send-replies
16981 Send all replies from the replies packet
16982 (@code{gnus-soup-send-replies}).
16985 @kindex G s p (Group)
16986 @findex gnus-soup-pack-packet
16987 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
16990 @kindex G s r (Group)
16991 @findex nnsoup-pack-replies
16992 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
16995 @kindex O s (Summary)
16996 @findex gnus-soup-add-article
16997 This summary-mode command adds the current article to a @sc{soup} packet
16998 (@code{gnus-soup-add-article}). It understands the process/prefix
16999 convention (@pxref{Process/Prefix}).
17004 There are a few variables to customize where Gnus will put all these
17009 @item gnus-soup-directory
17010 @vindex gnus-soup-directory
17011 Directory where Gnus will save intermediate files while composing
17012 @sc{soup} packets. The default is @file{~/SoupBrew/}.
17014 @item gnus-soup-replies-directory
17015 @vindex gnus-soup-replies-directory
17016 This is what Gnus will use as a temporary directory while sending our
17017 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
17019 @item gnus-soup-prefix-file
17020 @vindex gnus-soup-prefix-file
17021 Name of the file where Gnus stores the last used prefix. The default is
17022 @samp{gnus-prefix}.
17024 @item gnus-soup-packer
17025 @vindex gnus-soup-packer
17026 A format string command for packing a @sc{soup} packet. The default is
17027 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
17029 @item gnus-soup-unpacker
17030 @vindex gnus-soup-unpacker
17031 Format string command for unpacking a @sc{soup} packet. The default is
17032 @samp{gunzip -c %s | tar xvf -}.
17034 @item gnus-soup-packet-directory
17035 @vindex gnus-soup-packet-directory
17036 Where Gnus will look for reply packets. The default is @file{~/}.
17038 @item gnus-soup-packet-regexp
17039 @vindex gnus-soup-packet-regexp
17040 Regular expression matching @sc{soup} reply packets in
17041 @code{gnus-soup-packet-directory}.
17047 @subsubsection SOUP Groups
17050 @code{nnsoup} is the back end for reading @sc{soup} packets. It will
17051 read incoming packets, unpack them, and put them in a directory where
17052 you can read them at leisure.
17054 These are the variables you can use to customize its behavior:
17058 @item nnsoup-tmp-directory
17059 @vindex nnsoup-tmp-directory
17060 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
17061 directory. (@file{/tmp/} by default.)
17063 @item nnsoup-directory
17064 @vindex nnsoup-directory
17065 @code{nnsoup} then moves each message and index file to this directory.
17066 The default is @file{~/SOUP/}.
17068 @item nnsoup-replies-directory
17069 @vindex nnsoup-replies-directory
17070 All replies will be stored in this directory before being packed into a
17071 reply packet. The default is @file{~/SOUP/replies/}.
17073 @item nnsoup-replies-format-type
17074 @vindex nnsoup-replies-format-type
17075 The @sc{soup} format of the replies packets. The default is @samp{?n}
17076 (rnews), and I don't think you should touch that variable. I probably
17077 shouldn't even have documented it. Drats! Too late!
17079 @item nnsoup-replies-index-type
17080 @vindex nnsoup-replies-index-type
17081 The index type of the replies packet. The default is @samp{?n}, which
17082 means ``none''. Don't fiddle with this one either!
17084 @item nnsoup-active-file
17085 @vindex nnsoup-active-file
17086 Where @code{nnsoup} stores lots of information. This is not an ``active
17087 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
17088 this file or mess it up in any way, you're dead. The default is
17089 @file{~/SOUP/active}.
17091 @item nnsoup-packer
17092 @vindex nnsoup-packer
17093 Format string command for packing a reply @sc{soup} packet. The default
17094 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
17096 @item nnsoup-unpacker
17097 @vindex nnsoup-unpacker
17098 Format string command for unpacking incoming @sc{soup} packets. The
17099 default is @samp{gunzip -c %s | tar xvf -}.
17101 @item nnsoup-packet-directory
17102 @vindex nnsoup-packet-directory
17103 Where @code{nnsoup} will look for incoming packets. The default is
17106 @item nnsoup-packet-regexp
17107 @vindex nnsoup-packet-regexp
17108 Regular expression matching incoming @sc{soup} packets. The default is
17111 @item nnsoup-always-save
17112 @vindex nnsoup-always-save
17113 If non-@code{nil}, save the replies buffer after each posted message.
17119 @subsubsection SOUP Replies
17121 Just using @code{nnsoup} won't mean that your postings and mailings end
17122 up in @sc{soup} reply packets automagically. You have to work a bit
17123 more for that to happen.
17125 @findex nnsoup-set-variables
17126 The @code{nnsoup-set-variables} command will set the appropriate
17127 variables to ensure that all your followups and replies end up in the
17130 In specific, this is what it does:
17133 (setq message-send-news-function 'nnsoup-request-post)
17134 (setq message-send-mail-function 'nnsoup-request-mail)
17137 And that's it, really. If you only want news to go into the @sc{soup}
17138 system you just use the first line. If you only want mail to be
17139 @sc{soup}ed you use the second.
17142 @node Mail-To-News Gateways
17143 @subsection Mail-To-News Gateways
17144 @cindex mail-to-news gateways
17147 If your local @code{nntp} server doesn't allow posting, for some reason
17148 or other, you can post using one of the numerous mail-to-news gateways.
17149 The @code{nngateway} back end provides the interface.
17151 Note that you can't read anything from this back end---it can only be
17157 @item nngateway-address
17158 @vindex nngateway-address
17159 This is the address of the mail-to-news gateway.
17161 @item nngateway-header-transformation
17162 @vindex nngateway-header-transformation
17163 News headers often have to be transformed in some odd way or other
17164 for the mail-to-news gateway to accept it. This variable says what
17165 transformation should be called, and defaults to
17166 @code{nngateway-simple-header-transformation}. The function is called
17167 narrowed to the headers to be transformed and with one parameter---the
17170 This default function just inserts a new @code{To} header based on the
17171 @code{Newsgroups} header and the gateway address.
17172 For instance, an article with this @code{Newsgroups} header:
17175 Newsgroups: alt.religion.emacs
17178 will get this @code{To} header inserted:
17181 To: alt-religion-emacs@@GATEWAY
17184 The following pre-defined functions exist:
17186 @findex nngateway-simple-header-transformation
17189 @item nngateway-simple-header-transformation
17190 Creates a @code{To} header that looks like
17191 @var{newsgroup}@@@code{nngateway-address}.
17193 @findex nngateway-mail2news-header-transformation
17195 @item nngateway-mail2news-header-transformation
17196 Creates a @code{To} header that looks like
17197 @code{nngateway-address}.
17205 (setq gnus-post-method
17207 "mail2news@@replay.com"
17208 (nngateway-header-transformation
17209 nngateway-mail2news-header-transformation)))
17212 So, to use this, simply say something like:
17215 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
17220 @node Combined Groups
17221 @section Combined Groups
17223 Gnus allows combining a mixture of all the other group types into bigger
17227 * Virtual Groups:: Combining articles from many groups.
17228 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
17232 @node Virtual Groups
17233 @subsection Virtual Groups
17235 @cindex virtual groups
17236 @cindex merging groups
17238 An @dfn{nnvirtual group} is really nothing more than a collection of
17241 For instance, if you are tired of reading many small groups, you can
17242 put them all in one big group, and then grow tired of reading one
17243 big, unwieldy group. The joys of computing!
17245 You specify @code{nnvirtual} as the method. The address should be a
17246 regexp to match component groups.
17248 All marks in the virtual group will stick to the articles in the
17249 component groups. So if you tick an article in a virtual group, the
17250 article will also be ticked in the component group from whence it
17251 came. (And vice versa---marks from the component groups will also be
17252 shown in the virtual group.). To create an empty virtual group, run
17253 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
17254 and edit the method regexp with @kbd{M-e}
17255 (@code{gnus-group-edit-group-method})
17257 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
17258 newsgroups into one, big, happy newsgroup:
17261 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
17264 The component groups can be native or foreign; everything should work
17265 smoothly, but if your computer explodes, it was probably my fault.
17267 Collecting the same group from several servers might actually be a good
17268 idea if users have set the Distribution header to limit distribution.
17269 If you would like to read @samp{soc.motss} both from a server in Japan
17270 and a server in Norway, you could use the following as the group regexp:
17273 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
17276 (Remember, though, that if you're creating the group with @kbd{G m}, you
17277 shouldn't double the backslashes, and you should leave off the quote
17278 characters at the beginning and the end of the string.)
17280 This should work kinda smoothly---all articles from both groups should
17281 end up in this one, and there should be no duplicates. Threading (and
17282 the rest) will still work as usual, but there might be problems with the
17283 sequence of articles. Sorting on date might be an option here
17284 (@pxref{Selecting a Group}).
17286 One limitation, however---all groups included in a virtual
17287 group have to be alive (i.e., subscribed or unsubscribed). Killed or
17288 zombie groups can't be component groups for @code{nnvirtual} groups.
17290 @vindex nnvirtual-always-rescan
17291 If the @code{nnvirtual-always-rescan} is non-@code{nil},
17292 @code{nnvirtual} will always scan groups for unread articles when
17293 entering a virtual group. If this variable is @code{nil} (which is the
17294 default) and you read articles in a component group after the virtual
17295 group has been activated, the read articles from the component group
17296 will show up when you enter the virtual group. You'll also see this
17297 effect if you have two virtual groups that have a component group in
17298 common. If that's the case, you should set this variable to @code{t}.
17299 Or you can just tap @code{M-g} on the virtual group every time before
17300 you enter it---it'll have much the same effect.
17302 @code{nnvirtual} can have both mail and news groups as component groups.
17303 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
17304 has to ask the back end of the component group the article comes from
17305 whether it is a news or mail back end. However, when you do a @kbd{^},
17306 there is typically no sure way for the component back end to know this,
17307 and in that case @code{nnvirtual} tells Gnus that the article came from a
17308 not-news back end. (Just to be on the safe side.)
17310 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
17311 line from the article you respond to in these cases.
17313 @code{nnvirtual} groups do not inherit anything but articles and marks
17314 from component groups---group parameters, for instance, are not
17318 @node Kibozed Groups
17319 @subsection Kibozed Groups
17323 @dfn{Kibozing} is defined by the @acronym{OED} as ``grepping through
17324 (parts of) the news feed''. @code{nnkiboze} is a back end that will
17325 do this for you. Oh joy! Now you can grind any @acronym{NNTP} server
17326 down to a halt with useless requests! Oh happiness!
17328 @kindex G k (Group)
17329 To create a kibozed group, use the @kbd{G k} command in the group
17332 The address field of the @code{nnkiboze} method is, as with
17333 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
17334 @code{nnkiboze} group. That's where most similarities between
17335 @code{nnkiboze} and @code{nnvirtual} end.
17337 In addition to this regexp detailing component groups, an
17338 @code{nnkiboze} group must have a score file to say what articles are
17339 to be included in the group (@pxref{Scoring}).
17341 @kindex M-x nnkiboze-generate-groups
17342 @findex nnkiboze-generate-groups
17343 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
17344 @code{nnkiboze} groups you want to have. This command will take time.
17345 Lots of time. Oodles and oodles of time. Gnus has to fetch the
17346 headers from all the articles in all the component groups and run them
17347 through the scoring process to determine if there are any articles in
17348 the groups that are to be part of the @code{nnkiboze} groups.
17350 Please limit the number of component groups by using restrictive
17351 regexps. Otherwise your sysadmin may become annoyed with you, and the
17352 @acronym{NNTP} site may throw you off and never let you back in again.
17353 Stranger things have happened.
17355 @code{nnkiboze} component groups do not have to be alive---they can be dead,
17356 and they can be foreign. No restrictions.
17358 @vindex nnkiboze-directory
17359 The generation of an @code{nnkiboze} group means writing two files in
17360 @code{nnkiboze-directory}, which is @file{~/News/kiboze/} by default.
17361 One contains the @acronym{NOV} header lines for all the articles in
17362 the group, and the other is an additional @file{.newsrc} file to store
17363 information on what groups have been searched through to find
17364 component articles.
17366 Articles marked as read in the @code{nnkiboze} group will have
17367 their @acronym{NOV} lines removed from the @acronym{NOV} file.
17370 @node Gnus Unplugged
17371 @section Gnus Unplugged
17376 @cindex Gnus unplugged
17378 In olden times (ca. February '88), people used to run their newsreaders
17379 on big machines with permanent connections to the net. News transport
17380 was dealt with by news servers, and all the newsreaders had to do was to
17381 read news. Believe it or not.
17383 Nowadays most people read news and mail at home, and use some sort of
17384 modem to connect to the net. To avoid running up huge phone bills, it
17385 would be nice to have a way to slurp down all the news and mail, hang up
17386 the phone, read for several hours, and then upload any responses you
17387 have to make. And then you repeat the procedure.
17389 Of course, you can use news servers for doing this as well. I've used
17390 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
17391 for some years, but doing that's a bore. Moving the news server
17392 functionality up to the newsreader makes sense if you're the only person
17393 reading news on a machine.
17395 Setting up Gnus as an ``offline'' newsreader is quite simple. In
17396 fact, you don't even have to configure anything.
17398 Of course, to use it as such, you have to learn a few new commands.
17401 * Agent Basics:: How it all is supposed to work.
17402 * Agent Categories:: How to tell the Gnus Agent what to download.
17403 * Agent Commands:: New commands for all the buffers.
17404 * Agent Visuals:: Ways that the agent may effect your summary buffer.
17405 * Agent as Cache:: The Agent is a big cache too.
17406 * Agent Expiry:: How to make old articles go away.
17407 * Agent Regeneration:: How to recover from lost connections and other accidents.
17408 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
17409 * Outgoing Messages:: What happens when you post/mail something?
17410 * Agent Variables:: Customizing is fun.
17411 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
17412 * Batching Agents:: How to fetch news from a @code{cron} job.
17413 * Agent Caveats:: What you think it'll do and what it does.
17418 @subsection Agent Basics
17420 First, let's get some terminology out of the way.
17422 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
17423 connection to the net (and notified the Agent that this is the case).
17424 When the connection to the net is up again (and Gnus knows this), the
17425 Agent is @dfn{plugged}.
17427 The @dfn{local} machine is the one you're running on, and which isn't
17428 connected to the net continuously.
17430 @dfn{Downloading} means fetching things from the net to your local
17431 machine. @dfn{Uploading} is doing the opposite.
17433 You know that Gnus gives you all the opportunity you'd ever want for
17434 shooting yourself in the foot. Some people call it flexibility. Gnus
17435 is also customizable to a great extent, which means that the user has a
17436 say on how Gnus behaves. Other newsreaders might unconditionally shoot
17437 you in your foot, but with Gnus, you have a choice!
17439 Gnus is never really in plugged or unplugged state. Rather, it applies
17440 that state to each server individually. This means that some servers
17441 can be plugged while others can be unplugged. Additionally, some
17442 servers can be ignored by the Agent altogether (which means that
17443 they're kinda like plugged always).
17445 So when you unplug the Agent and then wonder why is Gnus opening a
17446 connection to the Net, the next step to do is to look whether all
17447 servers are agentized. If there is an unagentized server, you found
17450 Another thing is the @dfn{offline} state. Sometimes, servers aren't
17451 reachable. When Gnus notices this, it asks you whether you want the
17452 server to be switched to offline state. If you say yes, then the
17453 server will behave somewhat as if it was unplugged, except that Gnus
17454 will ask you whether you want to switch it back online again.
17456 Let's take a typical Gnus session using the Agent.
17461 @findex gnus-unplugged
17462 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
17463 Agent in a disconnected state. You can read all the news that you have
17464 already fetched while in this mode.
17467 You then decide to see whether any new news has arrived. You connect
17468 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
17469 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
17470 as usual. To check for new mail in unplugged mode (@pxref{Mail
17471 Source Specifiers}).
17474 You can then read the new news immediately, or you can download the
17475 news onto your local machine. If you want to do the latter, you press
17476 @kbd{g} to check if there are any new news and then @kbd{J s} to fetch
17477 all the eligible articles in all the groups. (To let Gnus know which
17478 articles you want to download, @pxref{Agent Categories}).
17481 After fetching the articles, you press @kbd{J j} to make Gnus become
17482 unplugged again, and you shut down the PPP thing (or whatever). And
17483 then you read the news offline.
17486 And then you go to step 2.
17489 Here are some things you should do the first time (or so) that you use
17495 Decide which servers should be covered by the Agent. If you have a mail
17496 back end, it would probably be nonsensical to have it covered by the
17497 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
17498 @kbd{J a} on the server (or servers) that you wish to have covered by the
17499 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
17500 added servers you do not wish to have covered by the Agent. By default,
17501 all @code{nntp} and @code{nnimap} servers in @code{gnus-select-method} and
17502 @code{gnus-secondary-select-methods} are agentized.
17505 Decide on download policy. It's fairly simple once you decide whether
17506 you are going to use agent categories, topic parameters, and/or group
17507 parameters to implement your policy. If you're new to gnus, it
17508 is probably best to start with a category, @xref{Agent Categories}.
17510 Both topic parameters (@pxref{Topic Parameters}) and agent categories
17511 (@pxref{Agent Categories}) provide for setting a policy that applies
17512 to multiple groups. Which you use is entirely up to you. Topic
17513 parameters do override categories so, if you mix the two, you'll have
17514 to take that into account. If you have a few groups that deviate from
17515 your policy, you can use group parameters (@pxref{Group Parameters}) to
17519 Uhm@dots{} that's it.
17523 @node Agent Categories
17524 @subsection Agent Categories
17526 One of the main reasons to integrate the news transport layer into the
17527 newsreader is to allow greater control over what articles to download.
17528 There's not much point in downloading huge amounts of articles, just to
17529 find out that you're not interested in reading any of them. It's better
17530 to be somewhat more conservative in choosing what to download, and then
17531 mark the articles for downloading manually if it should turn out that
17532 you're interested in the articles anyway.
17534 One of the more effective methods for controlling what is to be
17535 downloaded is to create a @dfn{category} and then assign some (or all)
17536 groups to this category. Groups that do not belong in any other
17537 category belong to the @code{default} category. Gnus has its own
17538 buffer for creating and managing categories.
17540 If you prefer, you can also use group parameters (@pxref{Group
17541 Parameters}) and topic parameters (@pxref{Topic Parameters}) for an
17542 alternative approach to controlling the agent. The only real
17543 difference is that categories are specific to the agent (so there is
17544 less to learn) while group and topic parameters include the kitchen
17547 Since you can set agent parameters in several different places we have
17548 a rule to decide which source to believe. This rule specifies that
17549 the parameter sources are checked in the following order: group
17550 parameters, topic parameters, agent category, and finally customizable
17551 variables. So you can mix all of these sources to produce a wide range
17552 of behavior, just don't blame me if you don't remember where you put
17556 * Category Syntax:: What a category looks like.
17557 * Category Buffer:: A buffer for maintaining categories.
17558 * Category Variables:: Customize'r'Us.
17562 @node Category Syntax
17563 @subsubsection Category Syntax
17565 A category consists of a name, the list of groups belonging to the
17566 category, and a number of optional parameters that override the
17567 customizable variables. The complete list of agent parameters are
17570 @cindex Agent Parameters
17572 @item gnus-agent-cat-name
17573 The name of the category.
17575 @item gnus-agent-cat-groups
17576 The list of groups that are in this category.
17578 @item gnus-agent-cat-predicate
17579 A predicate which (generally) gives a rough outline of which articles
17580 are eligible for downloading; and
17582 @item gnus-agent-cat-score-file
17583 a score rule which (generally) gives you a finer granularity when
17584 deciding what articles to download. (Note that this @dfn{download
17585 score} is not necessarily related to normal scores.)
17587 @item gnus-agent-cat-enable-expiration
17588 a boolean indicating whether the agent should expire old articles in
17589 this group. Most groups should be expired to conserve disk space. In
17590 fact, its probably safe to say that the gnus.* hierarchy contains the
17591 only groups that should not be expired.
17593 @item gnus-agent-cat-days-until-old
17594 an integer indicating the number of days that the agent should wait
17595 before deciding that a read article is safe to expire.
17597 @item gnus-agent-cat-low-score
17598 an integer that overrides the value of @code{gnus-agent-low-score}.
17600 @item gnus-agent-cat-high-score
17601 an integer that overrides the value of @code{gnus-agent-high-score}.
17603 @item gnus-agent-cat-length-when-short
17604 an integer that overrides the value of
17605 @code{gnus-agent-short-article}.
17607 @item gnus-agent-cat-length-when-long
17608 an integer that overrides the value of @code{gnus-agent-long-article}.
17610 @item gnus-agent-cat-disable-undownloaded-faces
17611 a symbol indicating whether the summary buffer should @emph{not} display
17612 undownloaded articles using the gnus-summary-*-undownloaded-face
17613 faces. The symbol nil will enable the use of undownloaded faces while
17614 all other symbols disable them.
17617 The name of a category can not be changed once the category has been
17620 Each category maintains a list of groups that are exclusive members of
17621 that category. The exclusivity rule is automatically enforced, add a
17622 group to a new category and it is automatically removed from its old
17625 A predicate in its simplest form can be a single predicate such as
17626 @code{true} or @code{false}. These two will download every available
17627 article or nothing respectively. In the case of these two special
17628 predicates an additional score rule is superfluous.
17630 Predicates of @code{high} or @code{low} download articles in respect of
17631 their scores in relationship to @code{gnus-agent-high-score} and
17632 @code{gnus-agent-low-score} as described below.
17634 To gain even finer control of what is to be regarded eligible for
17635 download a predicate can consist of a number of predicates with logical
17636 operators sprinkled in between.
17638 Perhaps some examples are in order.
17640 Here's a simple predicate. (It's the default predicate, in fact, used
17641 for all groups that don't belong to any other category.)
17647 Quite simple, eh? This predicate is true if and only if the article is
17648 short (for some value of ``short'').
17650 Here's a more complex predicate:
17659 This means that an article should be downloaded if it has a high score,
17660 or if the score is not low and the article is not long. You get the
17663 The available logical operators are @code{or}, @code{and} and
17664 @code{not}. (If you prefer, you can use the more ``C''-ish operators
17665 @samp{|}, @code{&} and @code{!} instead.)
17667 The following predicates are pre-defined, but if none of these fit what
17668 you want to do, you can write your own.
17670 When evaluating each of these predicates, the named constant will be
17671 bound to the value determined by calling
17672 @code{gnus-agent-find-parameter} on the appropriate parameter. For
17673 example, gnus-agent-short-article will be bound to
17674 @code{(gnus-agent-find-parameter group 'agent-short-article)}. This
17675 means that you can specify a predicate in your category then tune that
17676 predicate to individual groups.
17680 True iff the article is shorter than @code{gnus-agent-short-article}
17681 lines; default 100.
17684 True iff the article is longer than @code{gnus-agent-long-article}
17685 lines; default 200.
17688 True iff the article has a download score less than
17689 @code{gnus-agent-low-score}; default 0.
17692 True iff the article has a download score greater than
17693 @code{gnus-agent-high-score}; default 0.
17696 True iff the Gnus Agent guesses that the article is spam. The
17697 heuristics may change over time, but at present it just computes a
17698 checksum and sees whether articles match.
17707 If you want to create your own predicate function, here's what you have
17708 to know: The functions are called with no parameters, but the
17709 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
17712 For example, you could decide that you don't want to download articles
17713 that were posted more than a certain number of days ago (e.g. posted
17714 more than @code{gnus-agent-expire-days} ago) you might write a function
17715 something along the lines of the following:
17718 (defun my-article-old-p ()
17719 "Say whether an article is old."
17720 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
17721 (- (time-to-days (current-time)) gnus-agent-expire-days)))
17724 with the predicate then defined as:
17727 (not my-article-old-p)
17730 or you could append your predicate to the predefined
17731 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
17735 (require 'gnus-agent)
17736 (setq gnus-category-predicate-alist
17737 (append gnus-category-predicate-alist
17738 '((old . my-article-old-p))))
17741 and simply specify your predicate as:
17747 If/when using something like the above, be aware that there are many
17748 misconfigured systems/mailers out there and so an article's date is not
17749 always a reliable indication of when it was posted. Hell, some people
17750 just don't give a damn.
17752 The above predicates apply to @emph{all} the groups which belong to the
17753 category. However, if you wish to have a specific predicate for an
17754 individual group within a category, or you're just too lazy to set up a
17755 new category, you can enter a group's individual predicate in its group
17756 parameters like so:
17759 (agent-predicate . short)
17762 This is the group/topic parameter equivalent of the agent category default.
17763 Note that when specifying a single word predicate like this, the
17764 @code{agent-predicate} specification must be in dotted pair notation.
17766 The equivalent of the longer example from above would be:
17769 (agent-predicate or high (and (not low) (not long)))
17772 The outer parenthesis required in the category specification are not
17773 entered here as, not being in dotted pair notation, the value of the
17774 predicate is assumed to be a list.
17777 Now, the syntax of the download score is the same as the syntax of
17778 normal score files, except that all elements that require actually
17779 seeing the article itself are verboten. This means that only the
17780 following headers can be scored on: @code{Subject}, @code{From},
17781 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
17782 @code{Lines}, and @code{Xref}.
17784 As with predicates, the specification of the @code{download score rule}
17785 to use in respect of a group can be in either the category definition if
17786 it's to be applicable to all groups in therein, or a group's parameters
17787 if it's to be specific to that group.
17789 In both of these places the @code{download score rule} can take one of
17796 This has the same syntax as a normal Gnus score file except only a
17797 subset of scoring keywords are available as mentioned above.
17803 Category specification
17807 ("Lars Ingebrigtsen" 1000000 nil s))
17813 Group/Topic Parameter specification
17816 (agent-score ("from"
17817 ("Lars Ingebrigtsen" 1000000 nil s))
17822 Again, note the omission of the outermost parenthesis here.
17828 These score files must @emph{only} contain the permitted scoring
17829 keywords stated above.
17835 Category specification
17838 ("~/News/agent.SCORE")
17844 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
17848 Group Parameter specification
17851 (agent-score "~/News/agent.SCORE")
17854 Additional score files can be specified as above. Need I say anything
17859 Use @code{normal} score files
17861 If you don't want to maintain two sets of scoring rules for a group, and
17862 your desired @code{downloading} criteria for a group are the same as your
17863 @code{reading} criteria then you can tell the agent to refer to your
17864 @code{normal} score files when deciding what to download.
17866 These directives in either the category definition or a group's
17867 parameters will cause the agent to read in all the applicable score
17868 files for a group, @emph{filtering out} those sections that do not
17869 relate to one of the permitted subset of scoring keywords.
17873 Category Specification
17880 Group Parameter specification
17883 (agent-score . file)
17888 @node Category Buffer
17889 @subsubsection Category Buffer
17891 You'd normally do all category maintenance from the category buffer.
17892 When you enter it for the first time (with the @kbd{J c} command from
17893 the group buffer), you'll only see the @code{default} category.
17895 The following commands are available in this buffer:
17899 @kindex q (Category)
17900 @findex gnus-category-exit
17901 Return to the group buffer (@code{gnus-category-exit}).
17904 @kindex e (Category)
17905 @findex gnus-category-customize-category
17906 Use a customization buffer to set all of the selected category's
17907 parameters at one time (@code{gnus-category-customize-category}).
17910 @kindex k (Category)
17911 @findex gnus-category-kill
17912 Kill the current category (@code{gnus-category-kill}).
17915 @kindex c (Category)
17916 @findex gnus-category-copy
17917 Copy the current category (@code{gnus-category-copy}).
17920 @kindex a (Category)
17921 @findex gnus-category-add
17922 Add a new category (@code{gnus-category-add}).
17925 @kindex p (Category)
17926 @findex gnus-category-edit-predicate
17927 Edit the predicate of the current category
17928 (@code{gnus-category-edit-predicate}).
17931 @kindex g (Category)
17932 @findex gnus-category-edit-groups
17933 Edit the list of groups belonging to the current category
17934 (@code{gnus-category-edit-groups}).
17937 @kindex s (Category)
17938 @findex gnus-category-edit-score
17939 Edit the download score rule of the current category
17940 (@code{gnus-category-edit-score}).
17943 @kindex l (Category)
17944 @findex gnus-category-list
17945 List all the categories (@code{gnus-category-list}).
17949 @node Category Variables
17950 @subsubsection Category Variables
17953 @item gnus-category-mode-hook
17954 @vindex gnus-category-mode-hook
17955 Hook run in category buffers.
17957 @item gnus-category-line-format
17958 @vindex gnus-category-line-format
17959 Format of the lines in the category buffer (@pxref{Formatting
17960 Variables}). Valid elements are:
17964 The name of the category.
17967 The number of groups in the category.
17970 @item gnus-category-mode-line-format
17971 @vindex gnus-category-mode-line-format
17972 Format of the category mode line (@pxref{Mode Line Formatting}).
17974 @item gnus-agent-short-article
17975 @vindex gnus-agent-short-article
17976 Articles that have fewer lines than this are short. Default 100.
17978 @item gnus-agent-long-article
17979 @vindex gnus-agent-long-article
17980 Articles that have more lines than this are long. Default 200.
17982 @item gnus-agent-low-score
17983 @vindex gnus-agent-low-score
17984 Articles that have a score lower than this have a low score. Default
17987 @item gnus-agent-high-score
17988 @vindex gnus-agent-high-score
17989 Articles that have a score higher than this have a high score. Default
17992 @item gnus-agent-expire-days
17993 @vindex gnus-agent-expire-days
17994 The number of days that a @samp{read} article must stay in the agent's
17995 local disk before becoming eligible for expiration (While the name is
17996 the same, this doesn't mean expiring the article on the server. It
17997 just means deleting the local copy of the article). What is also
17998 important to understand is that the counter starts with the time the
17999 article was written to the local disk and not the time the article was
18003 @item gnus-agent-enable-expiration
18004 @vindex gnus-agent-enable-expiration
18005 Determines whether articles in a group are, by default, expired or
18006 retained indefinitely. The default is @code{ENABLE} which means that
18007 you'll have to disable expiration when desired. On the other hand,
18008 you could set this to @code{DISABLE}. In that case, you would then
18009 have to enable expiration in selected groups.
18014 @node Agent Commands
18015 @subsection Agent Commands
18016 @findex gnus-agent-toggle-plugged
18017 @kindex J j (Agent)
18019 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
18020 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
18021 toggles the plugged/unplugged state of the Gnus Agent.
18025 * Group Agent Commands:: Configure groups and fetch their contents.
18026 * Summary Agent Commands:: Manually select then fetch specific articles.
18027 * Server Agent Commands:: Select the servers that are supported by the agent.
18033 @node Group Agent Commands
18034 @subsubsection Group Agent Commands
18038 @kindex J u (Agent Group)
18039 @findex gnus-agent-fetch-groups
18040 Fetch all eligible articles in the current group
18041 (@code{gnus-agent-fetch-groups}).
18044 @kindex J c (Agent Group)
18045 @findex gnus-enter-category-buffer
18046 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
18049 @kindex J s (Agent Group)
18050 @findex gnus-agent-fetch-session
18051 Fetch all eligible articles in all groups
18052 (@code{gnus-agent-fetch-session}).
18055 @kindex J S (Agent Group)
18056 @findex gnus-group-send-queue
18057 Send all sendable messages in the queue group
18058 (@code{gnus-group-send-queue}). @xref{Drafts}.
18061 @kindex J a (Agent Group)
18062 @findex gnus-agent-add-group
18063 Add the current group to an Agent category
18064 (@code{gnus-agent-add-group}). This command understands the
18065 process/prefix convention (@pxref{Process/Prefix}).
18068 @kindex J r (Agent Group)
18069 @findex gnus-agent-remove-group
18070 Remove the current group from its category, if any
18071 (@code{gnus-agent-remove-group}). This command understands the
18072 process/prefix convention (@pxref{Process/Prefix}).
18075 @kindex J Y (Agent Group)
18076 @findex gnus-agent-synchronize-flags
18077 Synchronize flags changed while unplugged with remote server, if any.
18083 @node Summary Agent Commands
18084 @subsubsection Summary Agent Commands
18088 @kindex J # (Agent Summary)
18089 @findex gnus-agent-mark-article
18090 Mark the article for downloading (@code{gnus-agent-mark-article}).
18093 @kindex J M-# (Agent Summary)
18094 @findex gnus-agent-unmark-article
18095 Remove the downloading mark from the article
18096 (@code{gnus-agent-unmark-article}).
18100 @kindex @@ (Agent Summary)
18101 @findex gnus-agent-toggle-mark
18102 Toggle whether to download the article
18103 (@code{gnus-agent-toggle-mark}). The download mark is @samp{%} by
18107 @kindex J c (Agent Summary)
18108 @findex gnus-agent-catchup
18109 Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable.
18112 @kindex J S (Agent Summary)
18113 @findex gnus-agent-fetch-group
18114 Download all eligible (@pxref{Agent Categories}) articles in this group.
18115 (@code{gnus-agent-fetch-group}).
18118 @kindex J s (Agent Summary)
18119 @findex gnus-agent-fetch-series
18120 Download all processable articles in this group.
18121 (@code{gnus-agent-fetch-series}).
18124 @kindex J u (Agent Summary)
18125 @findex gnus-agent-summary-fetch-group
18126 Download all downloadable articles in the current group
18127 (@code{gnus-agent-summary-fetch-group}).
18132 @node Server Agent Commands
18133 @subsubsection Server Agent Commands
18137 @kindex J a (Agent Server)
18138 @findex gnus-agent-add-server
18139 Add the current server to the list of servers covered by the Gnus Agent
18140 (@code{gnus-agent-add-server}).
18143 @kindex J r (Agent Server)
18144 @findex gnus-agent-remove-server
18145 Remove the current server from the list of servers covered by the Gnus
18146 Agent (@code{gnus-agent-remove-server}).
18151 @node Agent Visuals
18152 @subsection Agent Visuals
18154 If you open a summary while unplugged and, Gnus knows from the group's
18155 active range that there are more articles than the headers currently
18156 stored in the Agent, you may see some articles whose subject looks
18157 something like @samp{[Undownloaded article #####]}. These are
18158 placeholders for the missing headers. Aside from setting a mark,
18159 there is not much that can be done with one of these placeholders.
18160 When Gnus finally gets a chance to fetch the group's headers, the
18161 placeholders will automatically be replaced by the actual headers.
18162 You can configure the summary buffer's maneuvering to skip over the
18163 placeholders if you care (See @code{gnus-auto-goto-ignores}).
18165 While it may be obvious to all, the only headers and articles
18166 available while unplugged are those headers and articles that were
18167 fetched into the Agent while previously plugged. To put it another
18168 way, "If you forget to fetch something while plugged, you might have a
18169 less than satisfying unplugged session". For this reason, the Agent
18170 adds two visual effects to your summary buffer. These effects display
18171 the download status of each article so that you always know which
18172 articles will be available when unplugged.
18174 The first visual effect is the @samp{%O} spec. If you customize
18175 @code{gnus-summary-line-format} to include this specifier, you will add
18176 a single character field that indicates an article's download status.
18177 Articles that have been fetched into either the Agent or the Cache,
18178 will display @code{gnus-downloaded-mark} (defaults to @samp{+}). All
18179 other articles will display @code{gnus-undownloaded-mark} (defaults to
18180 @samp{-}). If you open a group that has not been agentized, a space
18181 (@samp{ }) will be displayed.
18183 The second visual effect are the undownloaded faces. The faces, there
18184 are three indicating the article's score (low, normal, high), seem to
18185 result in a love/hate response from many Gnus users. The problem is
18186 that the face selection is controlled by a list of condition tests and
18187 face names (See @code{gnus-summary-highlight}). Each condition is
18188 tested in the order in which it appears in the list so early
18189 conditions have precedence over later conditions. All of this means
18190 that, if you tick an undownloaded article, the article will continue
18191 to be displayed in the undownloaded face rather than the ticked face.
18193 If you use the Agent as a cache (to avoid downloading the same article
18194 each time you visit it or to minimize your connection time), the
18195 undownloaded face will probably seem like a good idea. The reason
18196 being that you do all of our work (marking, reading, deleting) with
18197 downloaded articles so the normal faces always appear.
18199 For occasional Agent users, the undownloaded faces may appear to be an
18200 absolutely horrible idea. The issue being that, since most of their
18201 articles have not been fetched into the Agent, most of the normal
18202 faces will be obscured by the undownloaded faces. If this is your
18203 situation, you have two choices available. First, you can completely
18204 disable the undownload faces by customizing
18205 @code{gnus-summary-highlight} to delete the three cons-cells that
18206 refer to the @code{gnus-summary-*-undownloaded-face} faces. Second, if
18207 you prefer to take a more fine-grained approach, you may set the
18208 @code{agent-disable-undownloaded-faces} group parameter to t. This
18209 parameter, like all other agent parameters, may be set on an Agent
18210 Category (@pxref{Agent Categories}), a Group Topic (@pxref{Topic
18211 Parameters}), or an individual group (@pxref{Group Parameters}).
18213 @node Agent as Cache
18214 @subsection Agent as Cache
18216 When Gnus is plugged, it is not efficient to download headers or
18217 articles from the server again, if they are already stored in the
18218 Agent. So, Gnus normally only downloads headers once, and stores them
18219 in the Agent. These headers are later used when generating the summary
18220 buffer, regardless of whether you are plugged or unplugged. Articles
18221 are not cached in the Agent by default though (that would potentially
18222 consume lots of disk space), but if you have already downloaded an
18223 article into the Agent, Gnus will not download the article from the
18224 server again but use the locally stored copy instead.
18226 If you so desire, you can configure the agent (see @code{gnus-agent-cache}
18227 @pxref{Agent Variables}) to always download headers and articles while
18228 plugged. Gnus will almost certainly be slower, but it will be kept
18229 synchronized with the server. That last point probably won't make any
18230 sense if you are using a nntp or nnimap back end.
18233 @subsection Agent Expiry
18235 @vindex gnus-agent-expire-days
18236 @findex gnus-agent-expire
18237 @kindex M-x gnus-agent-expire
18238 @kindex M-x gnus-agent-expire-group
18239 @findex gnus-agent-expire-group
18240 @cindex agent expiry
18241 @cindex Gnus agent expiry
18244 The Agent back end, @code{nnagent}, doesn't handle expiry. Well, at
18245 least it doesn't handle it like other back ends. Instead, there are
18246 special @code{gnus-agent-expire} and @code{gnus-agent-expire-group}
18247 commands that will expire all read articles that are older than
18248 @code{gnus-agent-expire-days} days. They can be run whenever you feel
18249 that you're running out of space. Neither are particularly fast or
18250 efficient, and it's not a particularly good idea to interrupt them (with
18251 @kbd{C-g} or anything else) once you've started one of them.
18253 Note that other functions, e.g. @code{gnus-request-expire-articles},
18254 might run @code{gnus-agent-expire} for you to keep the agent
18255 synchronized with the group.
18257 The agent parameter @code{agent-enable-expiration} may be used to
18258 prevent expiration in selected groups.
18260 @vindex gnus-agent-expire-all
18261 If @code{gnus-agent-expire-all} is non-@code{nil}, the agent
18262 expiration commands will expire all articles---unread, read, ticked
18263 and dormant. If @code{nil} (which is the default), only read articles
18264 are eligible for expiry, and unread, ticked and dormant articles will
18265 be kept indefinitely.
18267 If you find that some articles eligible for expiry are never expired,
18268 perhaps some Gnus Agent files are corrupted. There's are special
18269 commands, @code{gnus-agent-regenerate} and
18270 @code{gnus-agent-regenerate-group}, to fix possible problems.
18272 @node Agent Regeneration
18273 @subsection Agent Regeneration
18275 @cindex agent regeneration
18276 @cindex Gnus agent regeneration
18277 @cindex regeneration
18279 The local data structures used by @code{nnagent} may become corrupted
18280 due to certain exceptional conditions. When this happens,
18281 @code{nnagent} functionality may degrade or even fail. The solution
18282 to this problem is to repair the local data structures by removing all
18283 internal inconsistencies.
18285 For example, if your connection to your server is lost while
18286 downloaded articles into the agent, the local data structures will not
18287 know about articles successfully downloaded prior to the connection
18288 failure. Running @code{gnus-agent-regenerate} or
18289 @code{gnus-agent-regenerate-group} will update the data structures
18290 such that you don't need to download these articles a second time.
18292 @findex gnus-agent-regenerate
18293 @kindex M-x gnus-agent-regenerate
18294 The command @code{gnus-agent-regenerate} will perform
18295 @code{gnus-agent-regenerate-group} on every agentized group. While
18296 you can run @code{gnus-agent-regenerate} in any buffer, it is strongly
18297 recommended that you first close all summary buffers.
18299 @findex gnus-agent-regenerate-group
18300 @kindex M-x gnus-agent-regenerate-group
18301 The command @code{gnus-agent-regenerate-group} uses the local copies
18302 of individual articles to repair the local @acronym{NOV}(header) database. It
18303 then updates the internal data structures that document which articles
18304 are stored locally. An optional argument will mark articles in the
18307 @node Agent and IMAP
18308 @subsection Agent and IMAP
18310 The Agent works with any Gnus back end, including nnimap. However,
18311 since there are some conceptual differences between @acronym{NNTP} and
18312 @acronym{IMAP}, this section (should) provide you with some information to
18313 make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client.
18315 The first thing to keep in mind is that all flags (read, ticked, etc)
18316 are kept on the @acronym{IMAP} server, rather than in @file{.newsrc} as is the
18317 case for nntp. Thus Gnus need to remember flag changes when
18318 disconnected, and synchronize these flags when you plug back in.
18320 Gnus keeps track of flag changes when reading nnimap groups under the
18321 Agent. When you plug back in, Gnus will check if you have any changed
18322 any flags and ask if you wish to synchronize these with the server.
18323 The behavior is customizable by @code{gnus-agent-synchronize-flags}.
18325 @vindex gnus-agent-synchronize-flags
18326 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
18327 never automatically synchronize flags. If it is @code{ask}, which is
18328 the default, the Agent will check if you made any changes and if so
18329 ask if you wish to synchronize these when you re-connect. If it has
18330 any other value, all flags will be synchronized automatically.
18332 If you do not wish to synchronize flags automatically when you
18333 re-connect, you can do it manually with the
18334 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
18335 in the group buffer.
18337 Some things are currently not implemented in the Agent that you'd might
18338 expect from a disconnected @acronym{IMAP} client, including:
18343 Copying/moving articles into nnimap groups when unplugged.
18346 Creating/deleting nnimap groups when unplugged.
18350 Technical note: the synchronization algorithm does not work by ``pushing''
18351 all local flags to the server, but rather incrementally update the
18352 server view of flags by changing only those flags that were changed by
18353 the user. Thus, if you set one flag on an article, quit the group and
18354 re-select the group and remove the flag; the flag will be set and
18355 removed from the server when you ``synchronize''. The queued flag
18356 operations can be found in the per-server @code{flags} file in the Agent
18357 directory. It's emptied when you synchronize flags.
18360 @node Outgoing Messages
18361 @subsection Outgoing Messages
18363 When Gnus is unplugged, all outgoing messages (both mail and news) are
18364 stored in the draft group ``queue'' (@pxref{Drafts}). You can view
18365 them there after posting, and edit them at will.
18367 When Gnus is plugged again, you can send the messages either from the
18368 draft group with the special commands available there, or you can use
18369 the @kbd{J S} command in the group buffer to send all the sendable
18370 messages in the draft group.
18374 @node Agent Variables
18375 @subsection Agent Variables
18378 @item gnus-agent-directory
18379 @vindex gnus-agent-directory
18380 Where the Gnus Agent will store its files. The default is
18381 @file{~/News/agent/}.
18383 @item gnus-agent-handle-level
18384 @vindex gnus-agent-handle-level
18385 Groups on levels (@pxref{Group Levels}) higher than this variable will
18386 be ignored by the Agent. The default is @code{gnus-level-subscribed},
18387 which means that only subscribed group will be considered by the Agent
18390 @item gnus-agent-plugged-hook
18391 @vindex gnus-agent-plugged-hook
18392 Hook run when connecting to the network.
18394 @item gnus-agent-unplugged-hook
18395 @vindex gnus-agent-unplugged-hook
18396 Hook run when disconnecting from the network.
18398 @item gnus-agent-fetched-hook
18399 @vindex gnus-agent-fetched-hook
18400 Hook run when finished fetching articles.
18402 @item gnus-agent-cache
18403 @vindex gnus-agent-cache
18404 Variable to control whether use the locally stored @acronym{NOV} and
18405 articles when plugged, e.g. essentially using the Agent as a cache.
18406 The default is non-@code{nil}, which means to use the Agent as a cache.
18408 @item gnus-agent-go-online
18409 @vindex gnus-agent-go-online
18410 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
18411 automatically switch offline servers into online status. If it is
18412 @code{ask}, the default, the Agent will ask if you wish to switch
18413 offline servers into online status when you re-connect. If it has any
18414 other value, all offline servers will be automatically switched into
18417 @item gnus-agent-mark-unread-after-downloaded
18418 @vindex gnus-agent-mark-unread-after-downloaded
18419 If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil},
18420 mark articles as unread after downloading. This is usually a safe
18421 thing to do as the newly downloaded article has obviously not been
18422 read. The default is t.
18424 @item gnus-agent-consider-all-articles
18425 @vindex gnus-agent-consider-all-articles
18426 If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the
18427 agent will let the agent predicate decide whether articles need to be
18428 downloaded or not, for all articles. When @code{nil}, the default,
18429 the agent will only let the predicate decide whether unread articles
18430 are downloaded or not. If you enable this, you may also want to look
18431 into the agent expiry settings (@pxref{Category Variables}), so that
18432 the agent doesn't download articles which the agent will later expire,
18433 over and over again.
18435 @item gnus-agent-max-fetch-size
18436 @vindex gnus-agent-max-fetch-size
18437 The agent fetches articles into a temporary buffer prior to parsing
18438 them into individual files. To avoid exceeding the max. buffer size,
18439 the agent alternates between fetching and parsing until all articles
18440 have been fetched. @code{gnus-agent-max-fetch-size} provides a size
18441 limit to control how often the cycling occurs. A large value improves
18442 performance. A small value minimizes the time lost should the
18443 connection be lost while fetching (You may need to run
18444 @code{gnus-agent-regenerate-group} to update the group's state.
18445 However, all articles parsed prior to loosing the connection will be
18446 available while unplugged). The default is 10M so it is unusual to
18449 @item gnus-server-unopen-status
18450 @vindex gnus-server-unopen-status
18451 Perhaps not an Agent variable, but closely related to the Agent, this
18452 variable says what will happen if Gnus cannot open a server. If the
18453 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
18454 whether to deny the server or whether to unplug the agent. If the
18455 Agent is disabled, Gnus always simply deny the server. Other choices
18456 for this variable include @code{denied} and @code{offline} the latter
18457 is only valid if the Agent is used.
18459 @item gnus-auto-goto-ignores
18460 @vindex gnus-auto-goto-ignores
18461 Another variable that isn't an Agent variable, yet so closely related
18462 that most will look for it here, this variable tells the summary
18463 buffer how to maneuver around undownloaded (only headers stored in the
18464 agent) and unfetched (neither article nor headers stored) articles.
18466 The legal values are @code{nil} (maneuver to any article),
18467 @code{undownloaded} (maneuvering while unplugged ignores articles that
18468 have not been fetched), @code{always-undownloaded} (maneuvering always
18469 ignores articles that have not been fetched), @code{unfetched}
18470 (maneuvering ignores articles whose headers have not been fetched).
18475 @node Example Setup
18476 @subsection Example Setup
18478 If you don't want to read this manual, and you have a fairly standard
18479 setup, you may be able to use something like the following as your
18480 @file{~/.gnus.el} file to get started.
18483 ;;; @r{Define how Gnus is to fetch news. We do this over @acronym{NNTP}}
18484 ;;; @r{from your ISP's server.}
18485 (setq gnus-select-method '(nntp "news.your-isp.com"))
18487 ;;; @r{Define how Gnus is to read your mail. We read mail from}
18488 ;;; @r{your ISP's @acronym{POP} server.}
18489 (setq mail-sources '((pop :server "pop.your-isp.com")))
18491 ;;; @r{Say how Gnus is to store the mail. We use nnml groups.}
18492 (setq gnus-secondary-select-methods '((nnml "")))
18494 ;;; @r{Make Gnus into an offline newsreader.}
18495 ;;; (gnus-agentize) ; @r{The obsolete setting.}
18496 ;;; (setq gnus-agent t) ; @r{Now the default.}
18499 That should be it, basically. Put that in your @file{~/.gnus.el} file,
18500 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
18503 If this is the first time you've run Gnus, you will be subscribed
18504 automatically to a few default newsgroups. You'll probably want to
18505 subscribe to more groups, and to do that, you have to query the
18506 @acronym{NNTP} server for a complete list of groups with the @kbd{A A}
18507 command. This usually takes quite a while, but you only have to do it
18510 After reading and parsing a while, you'll be presented with a list of
18511 groups. Subscribe to the ones you want to read with the @kbd{u}
18512 command. @kbd{l} to make all the killed groups disappear after you've
18513 subscribe to all the groups you want to read. (@kbd{A k} will bring
18514 back all the killed groups.)
18516 You can now read the groups at once, or you can download the articles
18517 with the @kbd{J s} command. And then read the rest of this manual to
18518 find out which of the other gazillion things you want to customize.
18521 @node Batching Agents
18522 @subsection Batching Agents
18523 @findex gnus-agent-batch
18525 Having the Gnus Agent fetch articles (and post whatever messages you've
18526 written) is quite easy once you've gotten things set up properly. The
18527 following shell script will do everything that is necessary:
18529 You can run a complete batch command from the command line with the
18530 following incantation:
18534 emacs -batch -l ~/.emacs -f -l ~/.gnus.el gnus-agent-batch >/dev/null 2>&1
18538 @node Agent Caveats
18539 @subsection Agent Caveats
18541 The Gnus Agent doesn't seem to work like most other offline
18542 newsreaders. Here are some common questions that some imaginary people
18546 @item If I read an article while plugged, do they get entered into the Agent?
18548 @strong{No}. If you want this behaviour, add
18549 @code{gnus-agent-fetch-selected-article} to
18550 @code{gnus-select-article-hook}.
18552 @item If I read an article while plugged, and the article already exists in
18553 the Agent, will it get downloaded once more?
18555 @strong{No}, unless @code{gnus-agent-cache} is @code{nil}.
18559 In short, when Gnus is unplugged, it only looks into the locally stored
18560 articles; when it's plugged, it talks to your ISP and may also use the
18561 locally stored articles.
18568 Other people use @dfn{kill files}, but we here at Gnus Towers like
18569 scoring better than killing, so we'd rather switch than fight. They do
18570 something completely different as well, so sit up straight and pay
18573 @vindex gnus-summary-mark-below
18574 All articles have a default score (@code{gnus-summary-default-score}),
18575 which is 0 by default. This score may be raised or lowered either
18576 interactively or by score files. Articles that have a score lower than
18577 @code{gnus-summary-mark-below} are marked as read.
18579 Gnus will read any @dfn{score files} that apply to the current group
18580 before generating the summary buffer.
18582 There are several commands in the summary buffer that insert score
18583 entries based on the current article. You can, for instance, ask Gnus to
18584 lower or increase the score of all articles with a certain subject.
18586 There are two sorts of scoring entries: Permanent and temporary.
18587 Temporary score entries are self-expiring entries. Any entries that are
18588 temporary and have not been used for, say, a week, will be removed
18589 silently to help keep the sizes of the score files down.
18592 * Summary Score Commands:: Adding score entries for the current group.
18593 * Group Score Commands:: General score commands.
18594 * Score Variables:: Customize your scoring. (My, what terminology).
18595 * Score File Format:: What a score file may contain.
18596 * Score File Editing:: You can edit score files by hand as well.
18597 * Adaptive Scoring:: Big Sister Gnus knows what you read.
18598 * Home Score File:: How to say where new score entries are to go.
18599 * Followups To Yourself:: Having Gnus notice when people answer you.
18600 * Scoring On Other Headers:: Scoring on non-standard headers.
18601 * Scoring Tips:: How to score effectively.
18602 * Reverse Scoring:: That problem child of old is not problem.
18603 * Global Score Files:: Earth-spanning, ear-splitting score files.
18604 * Kill Files:: They are still here, but they can be ignored.
18605 * Converting Kill Files:: Translating kill files to score files.
18606 * GroupLens:: Getting predictions on what you like to read.
18607 * Advanced Scoring:: Using logical expressions to build score rules.
18608 * Score Decays:: It can be useful to let scores wither away.
18612 @node Summary Score Commands
18613 @section Summary Score Commands
18614 @cindex score commands
18616 The score commands that alter score entries do not actually modify real
18617 score files. That would be too inefficient. Gnus maintains a cache of
18618 previously loaded score files, one of which is considered the
18619 @dfn{current score file alist}. The score commands simply insert
18620 entries into this list, and upon group exit, this list is saved.
18622 The current score file is by default the group's local score file, even
18623 if no such score file actually exists. To insert score commands into
18624 some other score file (e.g. @file{all.SCORE}), you must first make this
18625 score file the current one.
18627 General score commands that don't actually change the score file:
18632 @kindex V s (Summary)
18633 @findex gnus-summary-set-score
18634 Set the score of the current article (@code{gnus-summary-set-score}).
18637 @kindex V S (Summary)
18638 @findex gnus-summary-current-score
18639 Display the score of the current article
18640 (@code{gnus-summary-current-score}).
18643 @kindex V t (Summary)
18644 @findex gnus-score-find-trace
18645 Display all score rules that have been used on the current article
18646 (@code{gnus-score-find-trace}). In the @code{*Score Trace*} buffer, you
18647 can use @kbd{q} to quit. @kbd{e} edits the corresponding score file.
18648 When point is on a string within the match element, @kbd{e} will try to
18649 bring you to this string in the score file.
18652 @kindex V w (Summary)
18653 @findex gnus-score-find-favourite-words
18654 List words used in scoring (@code{gnus-score-find-favourite-words}).
18657 @kindex V R (Summary)
18658 @findex gnus-summary-rescore
18659 Run the current summary through the scoring process
18660 (@code{gnus-summary-rescore}). This might be useful if you're playing
18661 around with your score files behind Gnus' back and want to see the
18662 effect you're having.
18665 @kindex V c (Summary)
18666 @findex gnus-score-change-score-file
18667 Make a different score file the current
18668 (@code{gnus-score-change-score-file}).
18671 @kindex V e (Summary)
18672 @findex gnus-score-edit-current-scores
18673 Edit the current score file (@code{gnus-score-edit-current-scores}).
18674 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
18678 @kindex V f (Summary)
18679 @findex gnus-score-edit-file
18680 Edit a score file and make this score file the current one
18681 (@code{gnus-score-edit-file}).
18684 @kindex V F (Summary)
18685 @findex gnus-score-flush-cache
18686 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
18687 after editing score files.
18690 @kindex V C (Summary)
18691 @findex gnus-score-customize
18692 Customize a score file in a visually pleasing manner
18693 (@code{gnus-score-customize}).
18697 The rest of these commands modify the local score file.
18702 @kindex V m (Summary)
18703 @findex gnus-score-set-mark-below
18704 Prompt for a score, and mark all articles with a score below this as
18705 read (@code{gnus-score-set-mark-below}).
18708 @kindex V x (Summary)
18709 @findex gnus-score-set-expunge-below
18710 Prompt for a score, and add a score rule to the current score file to
18711 expunge all articles below this score
18712 (@code{gnus-score-set-expunge-below}).
18715 The keystrokes for actually making score entries follow a very regular
18716 pattern, so there's no need to list all the commands. (Hundreds of
18719 @findex gnus-summary-increase-score
18720 @findex gnus-summary-lower-score
18724 The first key is either @kbd{I} (upper case i) for increasing the score
18725 or @kbd{L} for lowering the score.
18727 The second key says what header you want to score on. The following
18728 keys are available:
18732 Score on the author name.
18735 Score on the subject line.
18738 Score on the @code{Xref} line---i.e., the cross-posting line.
18741 Score on the @code{References} line.
18747 Score on the number of lines.
18750 Score on the @code{Message-ID} header.
18753 Score on an ``extra'' header, that is, one of those in gnus-extra-headers,
18754 if your @acronym{NNTP} server tracks additional header data in overviews.
18757 Score on followups---this matches the author name, and adds scores to
18758 the followups to this author. (Using this key leads to the creation of
18759 @file{ADAPT} files.)
18768 Score on thread. (Using this key leads to the creation of @file{ADAPT}
18774 The third key is the match type. Which match types are valid depends on
18775 what headers you are scoring on.
18787 Substring matching.
18790 Fuzzy matching (@pxref{Fuzzy Matching}).
18819 Greater than number.
18824 The fourth and usually final key says whether this is a temporary (i.e.,
18825 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
18826 or whether it is to be done immediately, without adding to the score
18831 Temporary score entry.
18834 Permanent score entry.
18837 Immediately scoring.
18841 If you are scoring on `e' (extra) headers, you will then be prompted for
18842 the header name on which you wish to score. This must be a header named
18843 in gnus-extra-headers, and @samp{TAB} completion is available.
18847 So, let's say you want to increase the score on the current author with
18848 exact matching permanently: @kbd{I a e p}. If you want to lower the
18849 score based on the subject line, using substring matching, and make a
18850 temporary score entry: @kbd{L s s t}. Pretty easy.
18852 To make things a bit more complicated, there are shortcuts. If you use
18853 a capital letter on either the second or third keys, Gnus will use
18854 defaults for the remaining one or two keystrokes. The defaults are
18855 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
18856 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
18858 These functions take both the numerical prefix and the symbolic prefix
18859 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
18860 (or increase) the score of the article. A symbolic prefix of @code{a}
18861 says to use the @file{all.SCORE} file for the command instead of the
18862 current score file.
18864 @vindex gnus-score-mimic-keymap
18865 The @code{gnus-score-mimic-keymap} says whether these commands will
18866 pretend they are keymaps or not.
18869 @node Group Score Commands
18870 @section Group Score Commands
18871 @cindex group score commands
18873 There aren't many of these as yet, I'm afraid.
18878 @kindex W f (Group)
18879 @findex gnus-score-flush-cache
18880 Gnus maintains a cache of score alists to avoid having to reload them
18881 all the time. This command will flush the cache
18882 (@code{gnus-score-flush-cache}).
18886 You can do scoring from the command line by saying something like:
18888 @findex gnus-batch-score
18889 @cindex batch scoring
18891 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
18895 @node Score Variables
18896 @section Score Variables
18897 @cindex score variables
18901 @item gnus-use-scoring
18902 @vindex gnus-use-scoring
18903 If @code{nil}, Gnus will not check for score files, and will not, in
18904 general, do any score-related work. This is @code{t} by default.
18906 @item gnus-kill-killed
18907 @vindex gnus-kill-killed
18908 If this variable is @code{nil}, Gnus will never apply score files to
18909 articles that have already been through the kill process. While this
18910 may save you lots of time, it also means that if you apply a kill file
18911 to a group, and then change the kill file and want to run it over you
18912 group again to kill more articles, it won't work. You have to set this
18913 variable to @code{t} to do that. (It is @code{t} by default.)
18915 @item gnus-kill-files-directory
18916 @vindex gnus-kill-files-directory
18917 All kill and score files will be stored in this directory, which is
18918 initialized from the @env{SAVEDIR} environment variable by default.
18919 This is @file{~/News/} by default.
18921 @item gnus-score-file-suffix
18922 @vindex gnus-score-file-suffix
18923 Suffix to add to the group name to arrive at the score file name
18924 (@file{SCORE} by default.)
18926 @item gnus-score-uncacheable-files
18927 @vindex gnus-score-uncacheable-files
18928 @cindex score cache
18929 All score files are normally cached to avoid excessive re-loading of
18930 score files. However, if this might make your Emacs grow big and
18931 bloated, so this regexp can be used to weed out score files unlikely
18932 to be needed again. It would be a bad idea to deny caching of
18933 @file{all.SCORE}, while it might be a good idea to not cache
18934 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
18935 variable is @samp{ADAPT$} by default, so no adaptive score files will
18938 @item gnus-save-score
18939 @vindex gnus-save-score
18940 If you have really complicated score files, and do lots of batch
18941 scoring, then you might set this variable to @code{t}. This will make
18942 Gnus save the scores into the @file{.newsrc.eld} file.
18944 If you do not set this to @code{t}, then manual scores (like those set
18945 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
18946 across group visits.
18948 @item gnus-score-interactive-default-score
18949 @vindex gnus-score-interactive-default-score
18950 Score used by all the interactive raise/lower commands to raise/lower
18951 score with. Default is 1000, which may seem excessive, but this is to
18952 ensure that the adaptive scoring scheme gets enough room to play with.
18953 We don't want the small changes from the adaptive scoring to overwrite
18954 manually entered data.
18956 @item gnus-summary-default-score
18957 @vindex gnus-summary-default-score
18958 Default score of an article, which is 0 by default.
18960 @item gnus-summary-expunge-below
18961 @vindex gnus-summary-expunge-below
18962 Don't display the summary lines of articles that have scores lower than
18963 this variable. This is @code{nil} by default, which means that no
18964 articles will be hidden. This variable is local to the summary buffers,
18965 and has to be set from @code{gnus-summary-mode-hook}.
18967 @item gnus-score-over-mark
18968 @vindex gnus-score-over-mark
18969 Mark (in the third column) used for articles with a score over the
18970 default. Default is @samp{+}.
18972 @item gnus-score-below-mark
18973 @vindex gnus-score-below-mark
18974 Mark (in the third column) used for articles with a score below the
18975 default. Default is @samp{-}.
18977 @item gnus-score-find-score-files-function
18978 @vindex gnus-score-find-score-files-function
18979 Function used to find score files for the current group. This function
18980 is called with the name of the group as the argument.
18982 Predefined functions available are:
18985 @item gnus-score-find-single
18986 @findex gnus-score-find-single
18987 Only apply the group's own score file.
18989 @item gnus-score-find-bnews
18990 @findex gnus-score-find-bnews
18991 Apply all score files that match, using bnews syntax. This is the
18992 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
18993 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
18994 @file{gnu.all.SCORE} would all apply. In short, the instances of
18995 @samp{all} in the score file names are translated into @samp{.*}, and
18996 then a regexp match is done.
18998 This means that if you have some score entries that you want to apply to
18999 all groups, then you put those entries in the @file{all.SCORE} file.
19001 The score files are applied in a semi-random order, although Gnus will
19002 try to apply the more general score files before the more specific score
19003 files. It does this by looking at the number of elements in the score
19004 file names---discarding the @samp{all} elements.
19006 @item gnus-score-find-hierarchical
19007 @findex gnus-score-find-hierarchical
19008 Apply all score files from all the parent groups. This means that you
19009 can't have score files like @file{all.SCORE}, but you can have
19010 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
19014 This variable can also be a list of functions. In that case, all
19015 these functions will be called with the group name as argument, and
19016 all the returned lists of score files will be applied. These
19017 functions can also return lists of lists of score alists directly. In
19018 that case, the functions that return these non-file score alists
19019 should probably be placed before the ``real'' score file functions, to
19020 ensure that the last score file returned is the local score file.
19023 For example, to do hierarchical scoring but use a non-server-specific
19024 overall score file, you could use the value
19026 (list (lambda (group) ("all.SCORE"))
19027 'gnus-score-find-hierarchical)
19030 @item gnus-score-expiry-days
19031 @vindex gnus-score-expiry-days
19032 This variable says how many days should pass before an unused score file
19033 entry is expired. If this variable is @code{nil}, no score file entries
19034 are expired. It's 7 by default.
19036 @item gnus-update-score-entry-dates
19037 @vindex gnus-update-score-entry-dates
19038 If this variable is non-@code{nil}, temporary score entries that have
19039 been triggered (matched) will have their dates updated. (This is how Gnus
19040 controls expiry---all non-matched-entries will become too old while
19041 matched entries will stay fresh and young.) However, if you set this
19042 variable to @code{nil}, even matched entries will grow old and will
19043 have to face that oh-so grim reaper.
19045 @item gnus-score-after-write-file-function
19046 @vindex gnus-score-after-write-file-function
19047 Function called with the name of the score file just written.
19049 @item gnus-score-thread-simplify
19050 @vindex gnus-score-thread-simplify
19051 If this variable is non-@code{nil}, article subjects will be
19052 simplified for subject scoring purposes in the same manner as with
19053 threading---according to the current value of
19054 @code{gnus-simplify-subject-functions}. If the scoring entry uses
19055 @code{substring} or @code{exact} matching, the match will also be
19056 simplified in this manner.
19061 @node Score File Format
19062 @section Score File Format
19063 @cindex score file format
19065 A score file is an @code{emacs-lisp} file that normally contains just a
19066 single form. Casual users are not expected to edit these files;
19067 everything can be changed from the summary buffer.
19069 Anyway, if you'd like to dig into it yourself, here's an example:
19073 ("Lars Ingebrigtsen" -10000)
19075 ("larsi\\|lmi" -50000 nil R))
19077 ("Ding is Badd" nil 728373))
19079 ("alt.politics" -1000 728372 s))
19084 (mark-and-expunge -10)
19088 (files "/hom/larsi/News/gnu.SCORE")
19089 (exclude-files "all.SCORE")
19090 (local (gnus-newsgroup-auto-expire t)
19091 (gnus-summary-make-false-root empty))
19095 This example demonstrates most score file elements. @xref{Advanced
19096 Scoring}, for a different approach.
19098 Even though this looks much like Lisp code, nothing here is actually
19099 @code{eval}ed. The Lisp reader is used to read this form, though, so it
19100 has to be valid syntactically, if not semantically.
19102 Six keys are supported by this alist:
19107 If the key is a string, it is the name of the header to perform the
19108 match on. Scoring can only be performed on these eight headers:
19109 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
19110 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
19111 these headers, there are three strings to tell Gnus to fetch the entire
19112 article and do the match on larger parts of the article: @code{Body}
19113 will perform the match on the body of the article, @code{Head} will
19114 perform the match on the head of the article, and @code{All} will
19115 perform the match on the entire article. Note that using any of these
19116 last three keys will slow down group entry @emph{considerably}. The
19117 final ``header'' you can score on is @code{Followup}. These score
19118 entries will result in new score entries being added for all follow-ups
19119 to articles that matches these score entries.
19121 Following this key is an arbitrary number of score entries, where each
19122 score entry has one to four elements.
19126 The first element is the @dfn{match element}. On most headers this will
19127 be a string, but on the Lines and Chars headers, this must be an
19131 If the second element is present, it should be a number---the @dfn{score
19132 element}. This number should be an integer in the neginf to posinf
19133 interval. This number is added to the score of the article if the match
19134 is successful. If this element is not present, the
19135 @code{gnus-score-interactive-default-score} number will be used
19136 instead. This is 1000 by default.
19139 If the third element is present, it should be a number---the @dfn{date
19140 element}. This date says when the last time this score entry matched,
19141 which provides a mechanism for expiring the score entries. It this
19142 element is not present, the score entry is permanent. The date is
19143 represented by the number of days since December 31, 1 BCE.
19146 If the fourth element is present, it should be a symbol---the @dfn{type
19147 element}. This element specifies what function should be used to see
19148 whether this score entry matches the article. What match types that can
19149 be used depends on what header you wish to perform the match on.
19152 @item From, Subject, References, Xref, Message-ID
19153 For most header types, there are the @code{r} and @code{R} (regexp), as
19154 well as @code{s} and @code{S} (substring) types, and @code{e} and
19155 @code{E} (exact match), and @code{w} (word match) types. If this
19156 element is not present, Gnus will assume that substring matching should
19157 be used. @code{R}, @code{S}, and @code{E} differ from the others in
19158 that the matches will be done in a case-sensitive manner. All these
19159 one-letter types are really just abbreviations for the @code{regexp},
19160 @code{string}, @code{exact}, and @code{word} types, which you can use
19161 instead, if you feel like.
19164 Just as for the standard string overview headers, if you are using
19165 gnus-extra-headers, you can score on these headers' values. In this
19166 case, there is a 5th element in the score entry, being the name of the
19167 header to be scored. The following entry is useful in your
19168 @file{all.SCORE} file in case of spam attacks from a single origin
19169 host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in
19173 ("111.222.333.444" -1000 nil s
19174 "NNTP-Posting-Host")
19178 These two headers use different match types: @code{<}, @code{>},
19179 @code{=}, @code{>=} and @code{<=}.
19181 These predicates are true if
19184 (PREDICATE HEADER MATCH)
19187 evaluates to non-@code{nil}. For instance, the advanced match
19188 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
19195 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
19196 the match, we get the score added if the article has less than 4 lines.
19197 (It's easy to get confused and think it's the other way around. But
19198 it's not. I think.)
19200 When matching on @code{Lines}, be careful because some back ends (like
19201 @code{nndir}) do not generate @code{Lines} header, so every article ends
19202 up being marked as having 0 lines. This can lead to strange results if
19203 you happen to lower score of the articles with few lines.
19206 For the Date header we have three kinda silly match types:
19207 @code{before}, @code{at} and @code{after}. I can't really imagine this
19208 ever being useful, but, like, it would feel kinda silly not to provide
19209 this function. Just in case. You never know. Better safe than sorry.
19210 Once burnt, twice shy. Don't judge a book by its cover. Never not have
19211 sex on a first date. (I have been told that at least one person, and I
19212 quote, ``found this function indispensable'', however.)
19216 A more useful match type is @code{regexp}. With it, you can match the
19217 date string using a regular expression. The date is normalized to
19218 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
19219 you want to match all articles that have been posted on April 1st in
19220 every year, you could use @samp{....0401.........} as a match string,
19221 for instance. (Note that the date is kept in its original time zone, so
19222 this will match articles that were posted when it was April 1st where
19223 the article was posted from. Time zones are such wholesome fun for the
19226 @item Head, Body, All
19227 These three match keys use the same match types as the @code{From} (etc)
19231 This match key is somewhat special, in that it will match the
19232 @code{From} header, and affect the score of not only the matching
19233 articles, but also all followups to the matching articles. This allows
19234 you e.g. increase the score of followups to your own articles, or
19235 decrease the score of followups to the articles of some known
19236 trouble-maker. Uses the same match types as the @code{From} header
19237 uses. (Using this match key will lead to creation of @file{ADAPT}
19241 This match key works along the same lines as the @code{Followup} match
19242 key. If you say that you want to score on a (sub-)thread started by an
19243 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
19244 match. This will add a new @samp{thread} match for each article that
19245 has @var{x} in its @code{References} header. (These new @samp{thread}
19246 matches will use the @code{Message-ID}s of these matching articles.)
19247 This will ensure that you can raise/lower the score of an entire thread,
19248 even though some articles in the thread may not have complete
19249 @code{References} headers. Note that using this may lead to
19250 undeterministic scores of the articles in the thread. (Using this match
19251 key will lead to creation of @file{ADAPT} files.)
19255 @cindex score file atoms
19257 The value of this entry should be a number. Any articles with a score
19258 lower than this number will be marked as read.
19261 The value of this entry should be a number. Any articles with a score
19262 lower than this number will be removed from the summary buffer.
19264 @item mark-and-expunge
19265 The value of this entry should be a number. Any articles with a score
19266 lower than this number will be marked as read and removed from the
19269 @item thread-mark-and-expunge
19270 The value of this entry should be a number. All articles that belong to
19271 a thread that has a total score below this number will be marked as read
19272 and removed from the summary buffer. @code{gnus-thread-score-function}
19273 says how to compute the total score for a thread.
19276 The value of this entry should be any number of file names. These files
19277 are assumed to be score files as well, and will be loaded the same way
19280 @item exclude-files
19281 The clue of this entry should be any number of files. These files will
19282 not be loaded, even though they would normally be so, for some reason or
19286 The value of this entry will be @code{eval}el. This element will be
19287 ignored when handling global score files.
19290 Read-only score files will not be updated or saved. Global score files
19291 should feature this atom (@pxref{Global Score Files}). (Note:
19292 @dfn{Global} here really means @dfn{global}; not your personal
19293 apply-to-all-groups score files.)
19296 The value of this entry should be a number. Articles that do not have
19297 parents will get this number added to their scores. Imagine you follow
19298 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
19299 will only follow a few of the threads, also want to see any new threads.
19301 You can do this with the following two score file entries:
19305 (mark-and-expunge -100)
19308 When you enter the group the first time, you will only see the new
19309 threads. You then raise the score of the threads that you find
19310 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
19311 rest. Next time you enter the group, you will see new articles in the
19312 interesting threads, plus any new threads.
19314 I.e.---the orphan score atom is for high-volume groups where a few
19315 interesting threads which can't be found automatically by ordinary
19316 scoring rules exist.
19319 This entry controls the adaptive scoring. If it is @code{t}, the
19320 default adaptive scoring rules will be used. If it is @code{ignore}, no
19321 adaptive scoring will be performed on this group. If it is a list, this
19322 list will be used as the adaptive scoring rules. If it isn't present,
19323 or is something other than @code{t} or @code{ignore}, the default
19324 adaptive scoring rules will be used. If you want to use adaptive
19325 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
19326 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
19327 not want adaptive scoring. If you only want adaptive scoring in a few
19328 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
19329 insert @code{(adapt t)} in the score files of the groups where you want
19333 All adaptive score entries will go to the file named by this entry. It
19334 will also be applied when entering the group. This atom might be handy
19335 if you want to adapt on several groups at once, using the same adaptive
19336 file for a number of groups.
19339 @cindex local variables
19340 The value of this entry should be a list of @code{(@var{var}
19341 @var{value})} pairs. Each @var{var} will be made buffer-local to the
19342 current summary buffer, and set to the value specified. This is a
19343 convenient, if somewhat strange, way of setting variables in some
19344 groups if you don't like hooks much. Note that the @var{value} won't
19349 @node Score File Editing
19350 @section Score File Editing
19352 You normally enter all scoring commands from the summary buffer, but you
19353 might feel the urge to edit them by hand as well, so we've supplied you
19354 with a mode for that.
19356 It's simply a slightly customized @code{emacs-lisp} mode, with these
19357 additional commands:
19362 @kindex C-c C-c (Score)
19363 @findex gnus-score-edit-done
19364 Save the changes you have made and return to the summary buffer
19365 (@code{gnus-score-edit-done}).
19368 @kindex C-c C-d (Score)
19369 @findex gnus-score-edit-insert-date
19370 Insert the current date in numerical format
19371 (@code{gnus-score-edit-insert-date}). This is really the day number, if
19372 you were wondering.
19375 @kindex C-c C-p (Score)
19376 @findex gnus-score-pretty-print
19377 The adaptive score files are saved in an unformatted fashion. If you
19378 intend to read one of these files, you want to @dfn{pretty print} it
19379 first. This command (@code{gnus-score-pretty-print}) does that for
19384 Type @kbd{M-x gnus-score-mode} to use this mode.
19386 @vindex gnus-score-mode-hook
19387 @code{gnus-score-menu-hook} is run in score mode buffers.
19389 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
19390 e} to begin editing score files.
19393 @node Adaptive Scoring
19394 @section Adaptive Scoring
19395 @cindex adaptive scoring
19397 If all this scoring is getting you down, Gnus has a way of making it all
19398 happen automatically---as if by magic. Or rather, as if by artificial
19399 stupidity, to be precise.
19401 @vindex gnus-use-adaptive-scoring
19402 When you read an article, or mark an article as read, or kill an
19403 article, you leave marks behind. On exit from the group, Gnus can sniff
19404 these marks and add score elements depending on what marks it finds.
19405 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
19406 @code{t} or @code{(line)}. If you want score adaptively on separate
19407 words appearing in the subjects, you should set this variable to
19408 @code{(word)}. If you want to use both adaptive methods, set this
19409 variable to @code{(word line)}.
19411 @vindex gnus-default-adaptive-score-alist
19412 To give you complete control over the scoring process, you can customize
19413 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
19414 might look something like this:
19417 (setq gnus-default-adaptive-score-alist
19418 '((gnus-unread-mark)
19419 (gnus-ticked-mark (from 4))
19420 (gnus-dormant-mark (from 5))
19421 (gnus-del-mark (from -4) (subject -1))
19422 (gnus-read-mark (from 4) (subject 2))
19423 (gnus-expirable-mark (from -1) (subject -1))
19424 (gnus-killed-mark (from -1) (subject -3))
19425 (gnus-kill-file-mark)
19426 (gnus-ancient-mark)
19427 (gnus-low-score-mark)
19428 (gnus-catchup-mark (from -1) (subject -1))))
19431 As you see, each element in this alist has a mark as a key (either a
19432 variable name or a ``real'' mark---a character). Following this key is
19433 a arbitrary number of header/score pairs. If there are no header/score
19434 pairs following the key, no adaptive scoring will be done on articles
19435 that have that key as the article mark. For instance, articles with
19436 @code{gnus-unread-mark} in the example above will not get adaptive score
19439 Each article can have only one mark, so just a single of these rules
19440 will be applied to each article.
19442 To take @code{gnus-del-mark} as an example---this alist says that all
19443 articles that have that mark (i.e., are marked with @samp{e}) will have a
19444 score entry added to lower based on the @code{From} header by -4, and
19445 lowered by @code{Subject} by -1. Change this to fit your prejudices.
19447 If you have marked 10 articles with the same subject with
19448 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
19449 That means that that subject will get a score of ten times -1, which
19450 should be, unless I'm much mistaken, -10.
19452 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
19453 the read articles will be marked with the @samp{E} mark. This'll
19454 probably make adaptive scoring slightly impossible, so auto-expiring and
19455 adaptive scoring doesn't really mix very well.
19457 The headers you can score on are @code{from}, @code{subject},
19458 @code{message-id}, @code{references}, @code{xref}, @code{lines},
19459 @code{chars} and @code{date}. In addition, you can score on
19460 @code{followup}, which will create an adaptive score entry that matches
19461 on the @code{References} header using the @code{Message-ID} of the
19462 current article, thereby matching the following thread.
19464 If you use this scheme, you should set the score file atom @code{mark}
19465 to something small---like -300, perhaps, to avoid having small random
19466 changes result in articles getting marked as read.
19468 After using adaptive scoring for a week or so, Gnus should start to
19469 become properly trained and enhance the authors you like best, and kill
19470 the authors you like least, without you having to say so explicitly.
19472 You can control what groups the adaptive scoring is to be performed on
19473 by using the score files (@pxref{Score File Format}). This will also
19474 let you use different rules in different groups.
19476 @vindex gnus-adaptive-file-suffix
19477 The adaptive score entries will be put into a file where the name is the
19478 group name with @code{gnus-adaptive-file-suffix} appended. The default
19481 @vindex gnus-score-exact-adapt-limit
19482 When doing adaptive scoring, substring or fuzzy matching would probably
19483 give you the best results in most cases. However, if the header one
19484 matches is short, the possibility for false positives is great, so if
19485 the length of the match is less than
19486 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
19487 this variable is @code{nil}, exact matching will always be used to avoid
19490 @vindex gnus-default-adaptive-word-score-alist
19491 As mentioned above, you can adapt either on individual words or entire
19492 headers. If you adapt on words, the
19493 @code{gnus-default-adaptive-word-score-alist} variable says what score
19494 each instance of a word should add given a mark.
19497 (setq gnus-default-adaptive-word-score-alist
19498 `((,gnus-read-mark . 30)
19499 (,gnus-catchup-mark . -10)
19500 (,gnus-killed-mark . -20)
19501 (,gnus-del-mark . -15)))
19504 This is the default value. If you have adaption on words enabled, every
19505 word that appears in subjects of articles marked with
19506 @code{gnus-read-mark} will result in a score rule that increase the
19507 score with 30 points.
19509 @vindex gnus-default-ignored-adaptive-words
19510 @vindex gnus-ignored-adaptive-words
19511 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
19512 will be ignored. If you wish to add more words to be ignored, use the
19513 @code{gnus-ignored-adaptive-words} list instead.
19515 @vindex gnus-adaptive-word-length-limit
19516 Some may feel that short words shouldn't count when doing adaptive
19517 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
19518 an integer. Words shorter than this number will be ignored. This
19519 variable defaults to @code{nil}.
19521 @vindex gnus-adaptive-word-syntax-table
19522 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
19523 syntax table in effect. It is similar to the standard syntax table, but
19524 it considers numbers to be non-word-constituent characters.
19526 @vindex gnus-adaptive-word-minimum
19527 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
19528 word scoring process will never bring down the score of an article to
19529 below this number. The default is @code{nil}.
19531 @vindex gnus-adaptive-word-no-group-words
19532 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
19533 won't adaptively word score any of the words in the group name. Useful
19534 for groups like @samp{comp.editors.emacs}, where most of the subject
19535 lines contain the word @samp{emacs}.
19537 After using this scheme for a while, it might be nice to write a
19538 @code{gnus-psychoanalyze-user} command to go through the rules and see
19539 what words you like and what words you don't like. Or perhaps not.
19541 Note that the adaptive word scoring thing is highly experimental and is
19542 likely to change in the future. Initial impressions seem to indicate
19543 that it's totally useless as it stands. Some more work (involving more
19544 rigorous statistical methods) will have to be done to make this useful.
19547 @node Home Score File
19548 @section Home Score File
19550 The score file where new score file entries will go is called the
19551 @dfn{home score file}. This is normally (and by default) the score file
19552 for the group itself. For instance, the home score file for
19553 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
19555 However, this may not be what you want. It is often convenient to share
19556 a common home score file among many groups---all @samp{emacs} groups
19557 could perhaps use the same home score file.
19559 @vindex gnus-home-score-file
19560 The variable that controls this is @code{gnus-home-score-file}. It can
19565 A string. Then this file will be used as the home score file for all
19569 A function. The result of this function will be used as the home score
19570 file. The function will be called with the name of the group as the
19574 A list. The elements in this list can be:
19578 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
19579 group name, the @var{file-name} will be used as the home score file.
19582 A function. If the function returns non-@code{nil}, the result will
19583 be used as the home score file.
19586 A string. Use the string as the home score file.
19589 The list will be traversed from the beginning towards the end looking
19594 So, if you want to use just a single score file, you could say:
19597 (setq gnus-home-score-file
19598 "my-total-score-file.SCORE")
19601 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
19602 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
19604 @findex gnus-hierarchial-home-score-file
19606 (setq gnus-home-score-file
19607 'gnus-hierarchial-home-score-file)
19610 This is a ready-made function provided for your convenience.
19611 Other functions include
19614 @item gnus-current-home-score-file
19615 @findex gnus-current-home-score-file
19616 Return the ``current'' regular score file. This will make scoring
19617 commands add entry to the ``innermost'' matching score file.
19621 If you want to have one score file for the @samp{emacs} groups and
19622 another for the @samp{comp} groups, while letting all other groups use
19623 their own home score files:
19626 (setq gnus-home-score-file
19627 ;; @r{All groups that match the regexp @code{"\\.emacs"}}
19628 '(("\\.emacs" "emacs.SCORE")
19629 ;; @r{All the comp groups in one score file}
19630 ("^comp" "comp.SCORE")))
19633 @vindex gnus-home-adapt-file
19634 @code{gnus-home-adapt-file} works exactly the same way as
19635 @code{gnus-home-score-file}, but says what the home adaptive score file
19636 is instead. All new adaptive file entries will go into the file
19637 specified by this variable, and the same syntax is allowed.
19639 In addition to using @code{gnus-home-score-file} and
19640 @code{gnus-home-adapt-file}, you can also use group parameters
19641 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
19642 Parameters}) to achieve much the same. Group and topic parameters take
19643 precedence over this variable.
19646 @node Followups To Yourself
19647 @section Followups To Yourself
19649 Gnus offers two commands for picking out the @code{Message-ID} header in
19650 the current buffer. Gnus will then add a score rule that scores using
19651 this @code{Message-ID} on the @code{References} header of other
19652 articles. This will, in effect, increase the score of all articles that
19653 respond to the article in the current buffer. Quite useful if you want
19654 to easily note when people answer what you've said.
19658 @item gnus-score-followup-article
19659 @findex gnus-score-followup-article
19660 This will add a score to articles that directly follow up your own
19663 @item gnus-score-followup-thread
19664 @findex gnus-score-followup-thread
19665 This will add a score to all articles that appear in a thread ``below''
19669 @vindex message-sent-hook
19670 These two functions are both primarily meant to be used in hooks like
19671 @code{message-sent-hook}, like this:
19673 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
19677 If you look closely at your own @code{Message-ID}, you'll notice that
19678 the first two or three characters are always the same. Here's two of
19682 <x6u3u47icf.fsf@@eyesore.no>
19683 <x6sp9o7ibw.fsf@@eyesore.no>
19686 So ``my'' ident on this machine is @samp{x6}. This can be
19687 exploited---the following rule will raise the score on all followups to
19692 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
19696 Whether it's the first two or first three characters that are ``yours''
19697 is system-dependent.
19700 @node Scoring On Other Headers
19701 @section Scoring On Other Headers
19702 @cindex scoring on other headers
19704 Gnus is quite fast when scoring the ``traditional''
19705 headers---@samp{From}, @samp{Subject} and so on. However, scoring
19706 other headers requires writing a @code{head} scoring rule, which means
19707 that Gnus has to request every single article from the back end to find
19708 matches. This takes a long time in big groups.
19710 Now, there's not much you can do about this for news groups, but for
19711 mail groups, you have greater control. In @ref{To From Newsgroups},
19712 it's explained in greater detail what this mechanism does, but here's
19713 a cookbook example for @code{nnml} on how to allow scoring on the
19714 @samp{To} and @samp{Cc} headers.
19716 Put the following in your @file{~/.gnus.el} file.
19719 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
19720 nnmail-extra-headers gnus-extra-headers)
19723 Restart Gnus and rebuild your @code{nnml} overview files with the
19724 @kbd{M-x nnml-generate-nov-databases} command. This will take a long
19725 time if you have much mail.
19727 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
19728 so: @kbd{I e s p To RET <your name> RET}.
19734 @section Scoring Tips
19735 @cindex scoring tips
19741 @cindex scoring crossposts
19742 If you want to lower the score of crossposts, the line to match on is
19743 the @code{Xref} header.
19745 ("xref" (" talk.politics.misc:" -1000))
19748 @item Multiple crossposts
19749 If you want to lower the score of articles that have been crossposted to
19750 more than, say, 3 groups:
19753 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
19757 @item Matching on the body
19758 This is generally not a very good idea---it takes a very long time.
19759 Gnus actually has to fetch each individual article from the server. But
19760 you might want to anyway, I guess. Even though there are three match
19761 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
19762 and stick with it in each score file. If you use any two, each article
19763 will be fetched @emph{twice}. If you want to match a bit on the
19764 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
19767 @item Marking as read
19768 You will probably want to mark articles that have scores below a certain
19769 number as read. This is most easily achieved by putting the following
19770 in your @file{all.SCORE} file:
19774 You may also consider doing something similar with @code{expunge}.
19776 @item Negated character classes
19777 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
19778 That will match newlines, which might lead to, well, The Unknown. Say
19779 @code{[^abcd\n]*} instead.
19783 @node Reverse Scoring
19784 @section Reverse Scoring
19785 @cindex reverse scoring
19787 If you want to keep just articles that have @samp{Sex with Emacs} in the
19788 subject header, and expunge all other articles, you could put something
19789 like this in your score file:
19793 ("Sex with Emacs" 2))
19798 So, you raise all articles that match @samp{Sex with Emacs} and mark the
19799 rest as read, and expunge them to boot.
19802 @node Global Score Files
19803 @section Global Score Files
19804 @cindex global score files
19806 Sure, other newsreaders have ``global kill files''. These are usually
19807 nothing more than a single kill file that applies to all groups, stored
19808 in the user's home directory. Bah! Puny, weak newsreaders!
19810 What I'm talking about here are Global Score Files. Score files from
19811 all over the world, from users everywhere, uniting all nations in one
19812 big, happy score file union! Ange-score! New and untested!
19814 @vindex gnus-global-score-files
19815 All you have to do to use other people's score files is to set the
19816 @code{gnus-global-score-files} variable. One entry for each score file,
19817 or each score file directory. Gnus will decide by itself what score
19818 files are applicable to which group.
19820 To use the score file
19821 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
19822 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
19826 (setq gnus-global-score-files
19827 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
19828 "/ftp@@ftp.some-where:/pub/score/"))
19831 @findex gnus-score-search-global-directories
19833 Simple, eh? Directory names must end with a @samp{/}. These
19834 directories are typically scanned only once during each Gnus session.
19835 If you feel the need to manually re-scan the remote directories, you can
19836 use the @code{gnus-score-search-global-directories} command.
19838 Note that, at present, using this option will slow down group entry
19839 somewhat. (That is---a lot.)
19841 If you want to start maintaining score files for other people to use,
19842 just put your score file up for anonymous ftp and announce it to the
19843 world. Become a retro-moderator! Participate in the retro-moderator
19844 wars sure to ensue, where retro-moderators battle it out for the
19845 sympathy of the people, luring them to use their score files on false
19846 premises! Yay! The net is saved!
19848 Here are some tips for the would-be retro-moderator, off the top of my
19854 Articles heavily crossposted are probably junk.
19856 To lower a single inappropriate article, lower by @code{Message-ID}.
19858 Particularly brilliant authors can be raised on a permanent basis.
19860 Authors that repeatedly post off-charter for the group can safely be
19861 lowered out of existence.
19863 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
19864 articles completely.
19867 Use expiring score entries to keep the size of the file down. You
19868 should probably have a long expiry period, though, as some sites keep
19869 old articles for a long time.
19872 @dots{} I wonder whether other newsreaders will support global score files
19873 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
19874 Wave, xrn and 1stReader are bound to implement scoring. Should we start
19875 holding our breath yet?
19879 @section Kill Files
19882 Gnus still supports those pesky old kill files. In fact, the kill file
19883 entries can now be expiring, which is something I wrote before Daniel
19884 Quinlan thought of doing score files, so I've left the code in there.
19886 In short, kill processing is a lot slower (and I do mean @emph{a lot})
19887 than score processing, so it might be a good idea to rewrite your kill
19888 files into score files.
19890 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
19891 forms into this file, which means that you can use kill files as some
19892 sort of primitive hook function to be run on group entry, even though
19893 that isn't a very good idea.
19895 Normal kill files look like this:
19898 (gnus-kill "From" "Lars Ingebrigtsen")
19899 (gnus-kill "Subject" "ding")
19903 This will mark every article written by me as read, and remove the
19904 marked articles from the summary buffer. Very useful, you'll agree.
19906 Other programs use a totally different kill file syntax. If Gnus
19907 encounters what looks like a @code{rn} kill file, it will take a stab at
19910 Two summary functions for editing a @sc{gnus} kill file:
19915 @kindex M-k (Summary)
19916 @findex gnus-summary-edit-local-kill
19917 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
19920 @kindex M-K (Summary)
19921 @findex gnus-summary-edit-global-kill
19922 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
19925 Two group mode functions for editing the kill files:
19930 @kindex M-k (Group)
19931 @findex gnus-group-edit-local-kill
19932 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
19935 @kindex M-K (Group)
19936 @findex gnus-group-edit-global-kill
19937 Edit the general kill file (@code{gnus-group-edit-global-kill}).
19940 Kill file variables:
19943 @item gnus-kill-file-name
19944 @vindex gnus-kill-file-name
19945 A kill file for the group @samp{soc.motss} is normally called
19946 @file{soc.motss.KILL}. The suffix appended to the group name to get
19947 this file name is detailed by the @code{gnus-kill-file-name} variable.
19948 The ``global'' kill file (not in the score file sense of ``global'', of
19949 course) is just called @file{KILL}.
19951 @vindex gnus-kill-save-kill-file
19952 @item gnus-kill-save-kill-file
19953 If this variable is non-@code{nil}, Gnus will save the
19954 kill file after processing, which is necessary if you use expiring
19957 @item gnus-apply-kill-hook
19958 @vindex gnus-apply-kill-hook
19959 @findex gnus-apply-kill-file-unless-scored
19960 @findex gnus-apply-kill-file
19961 A hook called to apply kill files to a group. It is
19962 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
19963 kill file if you have a score file for the same group, you can set this
19964 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
19965 kill files to be processed, you should set this variable to @code{nil}.
19967 @item gnus-kill-file-mode-hook
19968 @vindex gnus-kill-file-mode-hook
19969 A hook called in kill-file mode buffers.
19974 @node Converting Kill Files
19975 @section Converting Kill Files
19977 @cindex converting kill files
19979 If you have loads of old kill files, you may want to convert them into
19980 score files. If they are ``regular'', you can use
19981 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
19984 The kill to score conversion package isn't included in Gnus by default.
19985 You can fetch it from
19986 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
19988 If your old kill files are very complex---if they contain more
19989 non-@code{gnus-kill} forms than not, you'll have to convert them by
19990 hand. Or just let them be as they are. Gnus will still use them as
19998 @sc{Note:} Unfortunately the GroupLens system seems to have shut down,
19999 so this section is mostly of historical interest.
20001 @uref{http://www.cs.umn.edu/Research/GroupLens/, GroupLens} is a
20002 collaborative filtering system that helps you work together with other
20003 people to find the quality news articles out of the huge volume of
20004 news articles generated every day.
20006 To accomplish this the GroupLens system combines your opinions about
20007 articles you have already read with the opinions of others who have done
20008 likewise and gives you a personalized prediction for each unread news
20009 article. Think of GroupLens as a matchmaker. GroupLens watches how you
20010 rate articles, and finds other people that rate articles the same way.
20011 Once it has found some people you agree with it tells you, in the form
20012 of a prediction, what they thought of the article. You can use this
20013 prediction to help you decide whether or not you want to read the
20017 * Using GroupLens:: How to make Gnus use GroupLens.
20018 * Rating Articles:: Letting GroupLens know how you rate articles.
20019 * Displaying Predictions:: Displaying predictions given by GroupLens.
20020 * GroupLens Variables:: Customizing GroupLens.
20024 @node Using GroupLens
20025 @subsection Using GroupLens
20027 To use GroupLens you must register a pseudonym with your local
20028 @uref{http://www.cs.umn.edu/Research/GroupLens/bbb.html, Better Bit
20029 Bureau (BBB)} is the only better bit in town at the moment.
20031 Once you have registered you'll need to set a couple of variables.
20035 @item gnus-use-grouplens
20036 @vindex gnus-use-grouplens
20037 Setting this variable to a non-@code{nil} value will make Gnus hook into
20038 all the relevant GroupLens functions.
20040 @item grouplens-pseudonym
20041 @vindex grouplens-pseudonym
20042 This variable should be set to the pseudonym you got when registering
20043 with the Better Bit Bureau.
20045 @item grouplens-newsgroups
20046 @vindex grouplens-newsgroups
20047 A list of groups that you want to get GroupLens predictions for.
20051 That's the minimum of what you need to get up and running with GroupLens.
20052 Once you've registered, GroupLens will start giving you scores for
20053 articles based on the average of what other people think. But, to get
20054 the real benefit of GroupLens you need to start rating articles
20055 yourself. Then the scores GroupLens gives you will be personalized for
20056 you, based on how the people you usually agree with have already rated.
20059 @node Rating Articles
20060 @subsection Rating Articles
20062 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
20063 Where 1 means something like this article is a waste of bandwidth and 5
20064 means that the article was really good. The basic question to ask
20065 yourself is, ``on a scale from 1 to 5 would I like to see more articles
20068 There are four ways to enter a rating for an article in GroupLens.
20073 @kindex r (GroupLens)
20074 @findex bbb-summary-rate-article
20075 This function will prompt you for a rating on a scale of one to five.
20078 @kindex k (GroupLens)
20079 @findex grouplens-score-thread
20080 This function will prompt you for a rating, and rate all the articles in
20081 the thread. This is really useful for some of those long running giant
20082 threads in rec.humor.
20086 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
20087 the score of the article you're reading.
20092 @kindex n (GroupLens)
20093 @findex grouplens-next-unread-article
20094 Rate the article and go to the next unread article.
20097 @kindex , (GroupLens)
20098 @findex grouplens-best-unread-article
20099 Rate the article and go to the next unread article with the highest score.
20103 If you want to give the current article a score of 4 and then go to the
20104 next article, just type @kbd{4 n}.
20107 @node Displaying Predictions
20108 @subsection Displaying Predictions
20110 GroupLens makes a prediction for you about how much you will like a
20111 news article. The predictions from GroupLens are on a scale from 1 to
20112 5, where 1 is the worst and 5 is the best. You can use the predictions
20113 from GroupLens in one of three ways controlled by the variable
20114 @code{gnus-grouplens-override-scoring}.
20116 @vindex gnus-grouplens-override-scoring
20117 There are three ways to display predictions in grouplens. You may
20118 choose to have the GroupLens scores contribute to, or override the
20119 regular Gnus scoring mechanism. override is the default; however, some
20120 people prefer to see the Gnus scores plus the grouplens scores. To get
20121 the separate scoring behavior you need to set
20122 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
20123 GroupLens predictions combined with the grouplens scores set it to
20124 @code{'override} and to combine the scores set
20125 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
20126 the combine option you will also want to set the values for
20127 @code{grouplens-prediction-offset} and
20128 @code{grouplens-score-scale-factor}.
20130 @vindex grouplens-prediction-display
20131 In either case, GroupLens gives you a few choices for how you would like
20132 to see your predictions displayed. The display of predictions is
20133 controlled by the @code{grouplens-prediction-display} variable.
20135 The following are valid values for that variable.
20138 @item prediction-spot
20139 The higher the prediction, the further to the right an @samp{*} is
20142 @item confidence-interval
20143 A numeric confidence interval.
20145 @item prediction-bar
20146 The higher the prediction, the longer the bar.
20148 @item confidence-bar
20149 Numerical confidence.
20151 @item confidence-spot
20152 The spot gets bigger with more confidence.
20154 @item prediction-num
20155 Plain-old numeric value.
20157 @item confidence-plus-minus
20158 Prediction +/- confidence.
20163 @node GroupLens Variables
20164 @subsection GroupLens Variables
20168 @item gnus-summary-grouplens-line-format
20169 The summary line format used in GroupLens-enhanced summary buffers. It
20170 accepts the same specs as the normal summary line format (@pxref{Summary
20171 Buffer Lines}). The default is @samp{%U%R%z%l%I%(%[%4L: %-23,23n%]%)
20174 @item grouplens-bbb-host
20175 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
20178 @item grouplens-bbb-port
20179 Port of the host running the bbbd server. The default is 9000.
20181 @item grouplens-score-offset
20182 Offset the prediction by this value. In other words, subtract the
20183 prediction value by this number to arrive at the effective score. The
20186 @item grouplens-score-scale-factor
20187 This variable allows the user to magnify the effect of GroupLens scores.
20188 The scale factor is applied after the offset. The default is 1.
20193 @node Advanced Scoring
20194 @section Advanced Scoring
20196 Scoring on Subjects and From headers is nice enough, but what if you're
20197 really interested in what a person has to say only when she's talking
20198 about a particular subject? Or what if you really don't want to
20199 read what person A has to say when she's following up to person B, but
20200 want to read what she says when she's following up to person C?
20202 By using advanced scoring rules you may create arbitrarily complex
20206 * Advanced Scoring Syntax:: A definition.
20207 * Advanced Scoring Examples:: What they look like.
20208 * Advanced Scoring Tips:: Getting the most out of it.
20212 @node Advanced Scoring Syntax
20213 @subsection Advanced Scoring Syntax
20215 Ordinary scoring rules have a string as the first element in the rule.
20216 Advanced scoring rules have a list as the first element. The second
20217 element is the score to be applied if the first element evaluated to a
20218 non-@code{nil} value.
20220 These lists may consist of three logical operators, one redirection
20221 operator, and various match operators.
20228 This logical operator will evaluate each of its arguments until it finds
20229 one that evaluates to @code{false}, and then it'll stop. If all arguments
20230 evaluate to @code{true} values, then this operator will return
20235 This logical operator will evaluate each of its arguments until it finds
20236 one that evaluates to @code{true}. If no arguments are @code{true},
20237 then this operator will return @code{false}.
20242 This logical operator only takes a single argument. It returns the
20243 logical negation of the value of its argument.
20247 There is an @dfn{indirection operator} that will make its arguments
20248 apply to the ancestors of the current article being scored. For
20249 instance, @code{1-} will make score rules apply to the parent of the
20250 current article. @code{2-} will make score rules apply to the
20251 grandparent of the current article. Alternatively, you can write
20252 @code{^^}, where the number of @code{^}s (carets) says how far back into
20253 the ancestry you want to go.
20255 Finally, we have the match operators. These are the ones that do the
20256 real work. Match operators are header name strings followed by a match
20257 and a match type. A typical match operator looks like @samp{("from"
20258 "Lars Ingebrigtsen" s)}. The header names are the same as when using
20259 simple scoring, and the match types are also the same.
20262 @node Advanced Scoring Examples
20263 @subsection Advanced Scoring Examples
20265 Please note that the following examples are score file rules. To
20266 make a complete score file from them, surround them with another pair
20269 Let's say you want to increase the score of articles written by Lars
20270 when he's talking about Gnus:
20275 ("from" "Lars Ingebrigtsen")
20276 ("subject" "Gnus"))
20283 When he writes long articles, he sometimes has something nice to say:
20287 ("from" "Lars Ingebrigtsen")
20294 However, when he responds to things written by Reig Eigil Logge, you
20295 really don't want to read what he's written:
20299 ("from" "Lars Ingebrigtsen")
20300 (1- ("from" "Reig Eigir Logge")))
20304 Everybody that follows up Redmondo when he writes about disappearing
20305 socks should have their scores raised, but only when they talk about
20306 white socks. However, when Lars talks about socks, it's usually not
20313 ("from" "redmondo@@.*no" r)
20314 ("body" "disappearing.*socks" t)))
20315 (! ("from" "Lars Ingebrigtsen"))
20316 ("body" "white.*socks"))
20320 The possibilities are endless.
20323 @node Advanced Scoring Tips
20324 @subsection Advanced Scoring Tips
20326 The @code{&} and @code{|} logical operators do short-circuit logic.
20327 That is, they stop processing their arguments when it's clear what the
20328 result of the operation will be. For instance, if one of the arguments
20329 of an @code{&} evaluates to @code{false}, there's no point in evaluating
20330 the rest of the arguments. This means that you should put slow matches
20331 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
20332 @samp{subject}) first.
20334 The indirection arguments (@code{1-} and so on) will make their
20335 arguments work on previous generations of the thread. If you say
20346 Then that means "score on the from header of the grandparent of the
20347 current article". An indirection is quite fast, but it's better to say:
20353 ("subject" "Gnus")))
20360 (1- ("from" "Lars"))
20361 (1- ("subject" "Gnus")))
20366 @section Score Decays
20367 @cindex score decays
20370 You may find that your scores have a tendency to grow without
20371 bounds, especially if you're using adaptive scoring. If scores get too
20372 big, they lose all meaning---they simply max out and it's difficult to
20373 use them in any sensible way.
20375 @vindex gnus-decay-scores
20376 @findex gnus-decay-score
20377 @vindex gnus-decay-score-function
20378 Gnus provides a mechanism for decaying scores to help with this problem.
20379 When score files are loaded and @code{gnus-decay-scores} is
20380 non-@code{nil}, Gnus will run the score files through the decaying
20381 mechanism thereby lowering the scores of all non-permanent score rules.
20382 The decay itself if performed by the @code{gnus-decay-score-function}
20383 function, which is @code{gnus-decay-score} by default. Here's the
20384 definition of that function:
20387 (defun gnus-decay-score (score)
20388 "Decay SCORE according to `gnus-score-decay-constant'
20389 and `gnus-score-decay-scale'."
20391 (* (if (< score 0) -1 1)
20393 (max gnus-score-decay-constant
20395 gnus-score-decay-scale)))))))
20396 (if (and (featurep 'xemacs)
20397 ;; XEmacs' floor can handle only the floating point
20398 ;; number below the half of the maximum integer.
20399 (> (abs n) (lsh -1 -2)))
20401 (car (split-string (number-to-string n) "\\.")))
20405 @vindex gnus-score-decay-scale
20406 @vindex gnus-score-decay-constant
20407 @code{gnus-score-decay-constant} is 3 by default and
20408 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
20412 Scores between -3 and 3 will be set to 0 when this function is called.
20415 Scores with magnitudes between 3 and 60 will be shrunk by 3.
20418 Scores with magnitudes greater than 60 will be shrunk by 5% of the
20422 If you don't like this decay function, write your own. It is called
20423 with the score to be decayed as its only parameter, and it should return
20424 the new score, which should be an integer.
20426 Gnus will try to decay scores once a day. If you haven't run Gnus for
20427 four days, Gnus will decay the scores four times, for instance.
20432 @include message.texi
20433 @chapter Emacs MIME
20434 @include emacs-mime.texi
20436 @include sieve.texi
20438 @c @include pgg.texi
20446 * Process/Prefix:: A convention used by many treatment commands.
20447 * Interactive:: Making Gnus ask you many questions.
20448 * Symbolic Prefixes:: How to supply some Gnus functions with options.
20449 * Formatting Variables:: You can specify what buffers should look like.
20450 * Window Layout:: Configuring the Gnus buffer windows.
20451 * Faces and Fonts:: How to change how faces look.
20452 * Compilation:: How to speed Gnus up.
20453 * Mode Lines:: Displaying information in the mode lines.
20454 * Highlighting and Menus:: Making buffers look all nice and cozy.
20455 * Buttons:: Get tendinitis in ten easy steps!
20456 * Daemons:: Gnus can do things behind your back.
20457 * NoCeM:: How to avoid spam and other fatty foods.
20458 * Undo:: Some actions can be undone.
20459 * Predicate Specifiers:: Specifying predicates.
20460 * Moderation:: What to do if you're a moderator.
20461 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
20462 * Fuzzy Matching:: What's the big fuzz?
20463 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
20464 * Various Various:: Things that are really various.
20468 @node Process/Prefix
20469 @section Process/Prefix
20470 @cindex process/prefix convention
20472 Many functions, among them functions for moving, decoding and saving
20473 articles, use what is known as the @dfn{Process/Prefix convention}.
20475 This is a method for figuring out what articles the user wants the
20476 command to be performed on.
20480 If the numeric prefix is N, perform the operation on the next N
20481 articles, starting with the current one. If the numeric prefix is
20482 negative, perform the operation on the previous N articles, starting
20483 with the current one.
20485 @vindex transient-mark-mode
20486 If @code{transient-mark-mode} in non-@code{nil} and the region is
20487 active, all articles in the region will be worked upon.
20489 If there is no numeric prefix, but some articles are marked with the
20490 process mark, perform the operation on the articles marked with
20493 If there is neither a numeric prefix nor any articles marked with the
20494 process mark, just perform the operation on the current article.
20496 Quite simple, really, but it needs to be made clear so that surprises
20499 Commands that react to the process mark will push the current list of
20500 process marked articles onto a stack and will then clear all process
20501 marked articles. You can restore the previous configuration with the
20502 @kbd{M P y} command (@pxref{Setting Process Marks}).
20504 @vindex gnus-summary-goto-unread
20505 One thing that seems to shock & horrify lots of people is that, for
20506 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
20507 Since each @kbd{d} (which marks the current article as read) by default
20508 goes to the next unread article after marking, this means that @kbd{3 d}
20509 will mark the next three unread articles as read, no matter what the
20510 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
20511 @code{nil} for a more straightforward action.
20513 Many commands do not use the process/prefix convention. All commands
20514 that do explicitly say so in this manual. To apply the process/prefix
20515 convention to commands that do not use it, you can use the @kbd{M-&}
20516 command. For instance, to mark all the articles in the group as
20517 expirable, you could say @kbd{M P b M-& E}.
20521 @section Interactive
20522 @cindex interaction
20526 @item gnus-novice-user
20527 @vindex gnus-novice-user
20528 If this variable is non-@code{nil}, you are either a newcomer to the
20529 World of Usenet, or you are very cautious, which is a nice thing to be,
20530 really. You will be given questions of the type ``Are you sure you want
20531 to do this?'' before doing anything dangerous. This is @code{t} by
20534 @item gnus-expert-user
20535 @vindex gnus-expert-user
20536 If this variable is non-@code{nil}, you will seldom be asked any
20537 questions by Gnus. It will simply assume you know what you're doing, no
20538 matter how strange.
20540 @item gnus-interactive-catchup
20541 @vindex gnus-interactive-catchup
20542 Require confirmation before catching up a group if non-@code{nil}. It
20543 is @code{t} by default.
20545 @item gnus-interactive-exit
20546 @vindex gnus-interactive-exit
20547 Require confirmation before exiting Gnus. This variable is @code{t} by
20552 @node Symbolic Prefixes
20553 @section Symbolic Prefixes
20554 @cindex symbolic prefixes
20556 Quite a lot of Emacs commands react to the (numeric) prefix. For
20557 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
20558 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
20559 rule of 900 to the current article.
20561 This is all nice and well, but what if you want to give a command some
20562 additional information? Well, what most commands do is interpret the
20563 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
20564 doesn't want a backup file to be created when saving the current buffer,
20565 for instance. But what if you want to save without making a backup
20566 file, and you want Emacs to flash lights and play a nice tune at the
20567 same time? You can't, and you're probably perfectly happy that way.
20569 @kindex M-i (Summary)
20570 @findex gnus-symbolic-argument
20571 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
20572 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
20573 character typed in is the value. You can stack as many @kbd{M-i}
20574 prefixes as you want. @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
20575 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b C-M-u} means
20576 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
20577 @code{b}''. You get the drift.
20579 Typing in symbolic prefixes to commands that don't accept them doesn't
20580 hurt, but it doesn't do any good either. Currently not many Gnus
20581 functions make use of the symbolic prefix.
20583 If you're interested in how Gnus implements this, @pxref{Extended
20587 @node Formatting Variables
20588 @section Formatting Variables
20589 @cindex formatting variables
20591 Throughout this manual you've probably noticed lots of variables called
20592 things like @code{gnus-group-line-format} and
20593 @code{gnus-summary-mode-line-format}. These control how Gnus is to
20594 output lines in the various buffers. There's quite a lot of them.
20595 Fortunately, they all use the same syntax, so there's not that much to
20598 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
20599 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
20600 lots of percentages everywhere.
20603 * Formatting Basics:: A formatting variable is basically a format string.
20604 * Mode Line Formatting:: Some rules about mode line formatting variables.
20605 * Advanced Formatting:: Modifying output in various ways.
20606 * User-Defined Specs:: Having Gnus call your own functions.
20607 * Formatting Fonts:: Making the formatting look colorful and nice.
20608 * Positioning Point:: Moving point to a position after an operation.
20609 * Tabulation:: Tabulating your output.
20610 * Wide Characters:: Dealing with wide characters.
20613 Currently Gnus uses the following formatting variables:
20614 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
20615 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
20616 @code{gnus-group-mode-line-format},
20617 @code{gnus-summary-mode-line-format},
20618 @code{gnus-article-mode-line-format},
20619 @code{gnus-server-mode-line-format}, and
20620 @code{gnus-summary-pick-line-format}.
20622 All these format variables can also be arbitrary elisp forms. In that
20623 case, they will be @code{eval}ed to insert the required lines.
20625 @kindex M-x gnus-update-format
20626 @findex gnus-update-format
20627 Gnus includes a command to help you while creating your own format
20628 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
20629 update the spec in question and pop you to a buffer where you can
20630 examine the resulting Lisp code to be run to generate the line.
20634 @node Formatting Basics
20635 @subsection Formatting Basics
20637 Each @samp{%} element will be replaced by some string or other when the
20638 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
20639 spec, and pad with spaces to get a 5-character field''.
20641 As with normal C and Emacs Lisp formatting strings, the numerical
20642 modifier between the @samp{%} and the formatting type character will
20643 @dfn{pad} the output so that it is always at least that long.
20644 @samp{%5y} will make the field always (at least) five characters wide by
20645 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
20648 You may also wish to limit the length of the field to protect against
20649 particularly wide values. For that you can say @samp{%4,6y}, which
20650 means that the field will never be more than 6 characters wide and never
20651 less than 4 characters wide.
20653 Also Gnus supports some extended format specifications, such as
20654 @samp{%&user-date;}.
20657 @node Mode Line Formatting
20658 @subsection Mode Line Formatting
20660 Mode line formatting variables (e.g.,
20661 @code{gnus-summary-mode-line-format}) follow the same rules as other,
20662 buffer line oriented formatting variables (@pxref{Formatting Basics})
20663 with the following two differences:
20668 There must be no newline (@samp{\n}) at the end.
20671 The special @samp{%%b} spec can be used to display the buffer name.
20672 Well, it's no spec at all, really---@samp{%%} is just a way to quote
20673 @samp{%} to allow it to pass through the formatting machinery unmangled,
20674 so that Emacs receives @samp{%b}, which is something the Emacs mode line
20675 display interprets to mean ``show the buffer name''. For a full list of
20676 mode line specs Emacs understands, see the documentation of the
20677 @code{mode-line-format} variable.
20682 @node Advanced Formatting
20683 @subsection Advanced Formatting
20685 It is frequently useful to post-process the fields in some way.
20686 Padding, limiting, cutting off parts and suppressing certain values can
20687 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
20688 look like @samp{%~(cut 3)~(ignore "0")y}.
20690 These are the valid modifiers:
20695 Pad the field to the left with spaces until it reaches the required
20699 Pad the field to the right with spaces until it reaches the required
20704 Cut off characters from the left until it reaches the specified length.
20707 Cut off characters from the right until it reaches the specified
20712 Cut off the specified number of characters from the left.
20715 Cut off the specified number of characters from the right.
20718 Return an empty string if the field is equal to the specified value.
20721 Use the specified form as the field value when the @samp{@@} spec is
20727 "~(form (current-time-string))@@"
20732 Let's take an example. The @samp{%o} spec in the summary mode lines
20733 will return a date in compact ISO8601 format---@samp{19960809T230410}.
20734 This is quite a mouthful, so we want to shave off the century number and
20735 the time, leaving us with a six-character date. That would be
20736 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
20737 maxing, and we need the padding to ensure that the date is never less
20738 than 6 characters to make it look nice in columns.)
20740 Ignoring is done first; then cutting; then maxing; and then as the very
20741 last operation, padding.
20743 @vindex gnus-compile-user-specs
20744 If @code{gnus-compile-user-specs} is set to @code{nil} (@code{t} by
20745 default) with your strong personality, and use a lots of these advanced
20746 thingies, you'll find that Gnus gets quite slow. This can be helped
20747 enormously by running @kbd{M-x gnus-compile} when you are satisfied with
20748 the look of your lines.
20749 @xref{Compilation}.
20752 @node User-Defined Specs
20753 @subsection User-Defined Specs
20755 All the specs allow for inserting user defined specifiers---@samp{u}.
20756 The next character in the format string should be a letter. Gnus
20757 will call the function @code{gnus-user-format-function-}@samp{X}, where
20758 @samp{X} is the letter following @samp{%u}. The function will be passed
20759 a single parameter---what the parameter means depends on what buffer
20760 it's being called from. The function should return a string, which will
20761 be inserted into the buffer just like information from any other
20762 specifier. This function may also be called with dummy values, so it
20763 should protect against that.
20765 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
20766 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
20768 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
20769 much the same without defining new functions. Here's an example:
20770 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
20771 given here will be evaluated to yield the current line number, and then
20775 @node Formatting Fonts
20776 @subsection Formatting Fonts
20778 There are specs for highlighting, and these are shared by all the format
20779 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
20780 the special @code{mouse-face} property set, which means that it will be
20781 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
20784 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
20785 normal faces set using @code{gnus-face-0}, which is @code{bold} by
20786 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
20787 and so on. Create as many faces as you wish. The same goes for the
20788 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
20789 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
20791 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
20792 special @code{balloon-help} property set to
20793 @code{gnus-balloon-face-0}. If you say @samp{%1<<}, you'll get
20794 @code{gnus-balloon-face-1} and so on. The @code{gnus-balloon-face-*}
20795 variables should be either strings or symbols naming functions that
20796 return a string. When the mouse passes over text with this property
20797 set, a balloon window will appear and display the string. Please
20798 refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual},
20799 (in GNU Emacs) or the doc string of @code{balloon-help-mode} (in
20800 XEmacs) for more information on this. (For technical reasons, the
20801 guillemets have been approximated as @samp{<<} and @samp{>>} in this
20804 Here's an alternative recipe for the group buffer:
20807 ;; @r{Create three face types.}
20808 (setq gnus-face-1 'bold)
20809 (setq gnus-face-3 'italic)
20811 ;; @r{We want the article count to be in}
20812 ;; @r{a bold and green face. So we create}
20813 ;; @r{a new face called @code{my-green-bold}.}
20814 (copy-face 'bold 'my-green-bold)
20815 ;; @r{Set the color.}
20816 (set-face-foreground 'my-green-bold "ForestGreen")
20817 (setq gnus-face-2 'my-green-bold)
20819 ;; @r{Set the new & fancy format.}
20820 (setq gnus-group-line-format
20821 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
20824 I'm sure you'll be able to use this scheme to create totally unreadable
20825 and extremely vulgar displays. Have fun!
20827 Note that the @samp{%(} specs (and friends) do not make any sense on the
20828 mode-line variables.
20830 @node Positioning Point
20831 @subsection Positioning Point
20833 Gnus usually moves point to a pre-defined place on each line in most
20834 buffers. By default, point move to the first colon character on the
20835 line. You can customize this behaviour in three different ways.
20837 You can move the colon character to somewhere else on the line.
20839 @findex gnus-goto-colon
20840 You can redefine the function that moves the point to the colon. The
20841 function is called @code{gnus-goto-colon}.
20843 But perhaps the most convenient way to deal with this, if you don't want
20844 to have a colon in your line, is to use the @samp{%*} specifier. If you
20845 put a @samp{%*} somewhere in your format line definition, Gnus will
20850 @subsection Tabulation
20852 You can usually line up your displays by padding and cutting your
20853 strings. However, when combining various strings of different size, it
20854 can often be more convenient to just output the strings, and then worry
20855 about lining up the following text afterwards.
20857 To do that, Gnus supplies tabulator specs---@samp{%=}. There are two
20858 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
20860 @samp{%50=} will insert space characters to pad the line up to column
20861 50. If the text is already past column 50, nothing will be inserted.
20862 This is the soft tabulator.
20864 @samp{%-50=} will insert space characters to pad the line up to column
20865 50. If the text is already past column 50, the excess text past column
20866 50 will be removed. This is the hard tabulator.
20869 @node Wide Characters
20870 @subsection Wide Characters
20872 Fixed width fonts in most countries have characters of the same width.
20873 Some countries, however, use Latin characters mixed with wider
20874 characters---most notable East Asian countries.
20876 The problem is that when formatting, Gnus assumes that if a string is 10
20877 characters wide, it'll be 10 Latin characters wide on the screen. In
20878 these countries, that's not true.
20880 @vindex gnus-use-correct-string-widths
20881 To help fix this, you can set @code{gnus-use-correct-string-widths} to
20882 @code{t}. This makes buffer generation slower, but the results will be
20883 prettier. The default value under XEmacs is @code{t} but @code{nil}
20887 @node Window Layout
20888 @section Window Layout
20889 @cindex window layout
20891 No, there's nothing here about X, so be quiet.
20893 @vindex gnus-use-full-window
20894 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
20895 other windows and occupy the entire Emacs screen by itself. It is
20896 @code{t} by default.
20898 Setting this variable to @code{nil} kinda works, but there are
20899 glitches. Use at your own peril.
20901 @vindex gnus-buffer-configuration
20902 @code{gnus-buffer-configuration} describes how much space each Gnus
20903 buffer should be given. Here's an excerpt of this variable:
20906 ((group (vertical 1.0 (group 1.0 point)
20907 (if gnus-carpal (group-carpal 4))))
20908 (article (vertical 1.0 (summary 0.25 point)
20912 This is an alist. The @dfn{key} is a symbol that names some action or
20913 other. For instance, when displaying the group buffer, the window
20914 configuration function will use @code{group} as the key. A full list of
20915 possible names is listed below.
20917 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
20918 should occupy. To take the @code{article} split as an example -
20921 (article (vertical 1.0 (summary 0.25 point)
20925 This @dfn{split} says that the summary buffer should occupy 25% of upper
20926 half of the screen, and that it is placed over the article buffer. As
20927 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
20928 reaching for that calculator there). However, the special number
20929 @code{1.0} is used to signal that this buffer should soak up all the
20930 rest of the space available after the rest of the buffers have taken
20931 whatever they need. There should be only one buffer with the @code{1.0}
20932 size spec per split.
20934 Point will be put in the buffer that has the optional third element
20935 @code{point}. In a @code{frame} split, the last subsplit having a leaf
20936 split where the tag @code{frame-focus} is a member (i.e. is the third or
20937 fourth element in the list, depending on whether the @code{point} tag is
20938 present) gets focus.
20940 Here's a more complicated example:
20943 (article (vertical 1.0 (group 4)
20944 (summary 0.25 point)
20945 (if gnus-carpal (summary-carpal 4))
20949 If the size spec is an integer instead of a floating point number,
20950 then that number will be used to say how many lines a buffer should
20951 occupy, not a percentage.
20953 If the @dfn{split} looks like something that can be @code{eval}ed (to be
20954 precise---if the @code{car} of the split is a function or a subr), this
20955 split will be @code{eval}ed. If the result is non-@code{nil}, it will
20956 be used as a split. This means that there will be three buffers if
20957 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
20960 Not complicated enough for you? Well, try this on for size:
20963 (article (horizontal 1.0
20968 (summary 0.25 point)
20973 Whoops. Two buffers with the mystery 100% tag. And what's that
20974 @code{horizontal} thingie?
20976 If the first element in one of the split is @code{horizontal}, Gnus will
20977 split the window horizontally, giving you two windows side-by-side.
20978 Inside each of these strips you may carry on all you like in the normal
20979 fashion. The number following @code{horizontal} says what percentage of
20980 the screen is to be given to this strip.
20982 For each split, there @emph{must} be one element that has the 100% tag.
20983 The splitting is never accurate, and this buffer will eat any leftover
20984 lines from the splits.
20986 To be slightly more formal, here's a definition of what a valid split
20991 split = frame | horizontal | vertical | buffer | form
20992 frame = "(frame " size *split ")"
20993 horizontal = "(horizontal " size *split ")"
20994 vertical = "(vertical " size *split ")"
20995 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
20996 size = number | frame-params
20997 buf-name = group | article | summary ...
21001 The limitations are that the @code{frame} split can only appear as the
21002 top-level split. @var{form} should be an Emacs Lisp form that should
21003 return a valid split. We see that each split is fully recursive, and
21004 may contain any number of @code{vertical} and @code{horizontal} splits.
21006 @vindex gnus-window-min-width
21007 @vindex gnus-window-min-height
21008 @cindex window height
21009 @cindex window width
21010 Finding the right sizes can be a bit complicated. No window may be less
21011 than @code{gnus-window-min-height} (default 1) characters high, and all
21012 windows must be at least @code{gnus-window-min-width} (default 1)
21013 characters wide. Gnus will try to enforce this before applying the
21014 splits. If you want to use the normal Emacs window width/height limit,
21015 you can just set these two variables to @code{nil}.
21017 If you're not familiar with Emacs terminology, @code{horizontal} and
21018 @code{vertical} splits may work the opposite way of what you'd expect.
21019 Windows inside a @code{horizontal} split are shown side-by-side, and
21020 windows within a @code{vertical} split are shown above each other.
21022 @findex gnus-configure-frame
21023 If you want to experiment with window placement, a good tip is to call
21024 @code{gnus-configure-frame} directly with a split. This is the function
21025 that does all the real work when splitting buffers. Below is a pretty
21026 nonsensical configuration with 5 windows; two for the group buffer and
21027 three for the article buffer. (I said it was nonsensical.) If you
21028 @code{eval} the statement below, you can get an idea of how that would
21029 look straight away, without going through the normal Gnus channels.
21030 Play with it until you're satisfied, and then use
21031 @code{gnus-add-configuration} to add your new creation to the buffer
21032 configuration list.
21035 (gnus-configure-frame
21039 (article 0.3 point))
21047 You might want to have several frames as well. No prob---just use the
21048 @code{frame} split:
21051 (gnus-configure-frame
21054 (summary 0.25 point frame-focus)
21056 (vertical ((height . 5) (width . 15)
21057 (user-position . t)
21058 (left . -1) (top . 1))
21063 This split will result in the familiar summary/article window
21064 configuration in the first (or ``main'') frame, while a small additional
21065 frame will be created where picons will be shown. As you can see,
21066 instead of the normal @code{1.0} top-level spec, each additional split
21067 should have a frame parameter alist as the size spec.
21068 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
21069 Reference Manual}. Under XEmacs, a frame property list will be
21070 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
21072 The list of all possible keys for @code{gnus-buffer-configuration} can
21073 be found in its default value.
21075 Note that the @code{message} key is used for both
21076 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
21077 it is desirable to distinguish between the two, something like this
21081 (message (horizontal 1.0
21082 (vertical 1.0 (message 1.0 point))
21084 (if (buffer-live-p gnus-summary-buffer)
21089 One common desire for a multiple frame split is to have a separate frame
21090 for composing mail and news while leaving the original frame intact. To
21091 accomplish that, something like the following can be done:
21096 (if (not (buffer-live-p gnus-summary-buffer))
21097 (car (cdr (assoc 'group gnus-buffer-configuration)))
21098 (car (cdr (assoc 'summary gnus-buffer-configuration))))
21099 (vertical ((user-position . t) (top . 1) (left . 1)
21100 (name . "Message"))
21101 (message 1.0 point))))
21104 @findex gnus-add-configuration
21105 Since the @code{gnus-buffer-configuration} variable is so long and
21106 complicated, there's a function you can use to ease changing the config
21107 of a single setting: @code{gnus-add-configuration}. If, for instance,
21108 you want to change the @code{article} setting, you could say:
21111 (gnus-add-configuration
21112 '(article (vertical 1.0
21114 (summary .25 point)
21118 You'd typically stick these @code{gnus-add-configuration} calls in your
21119 @file{~/.gnus.el} file or in some startup hook---they should be run after
21120 Gnus has been loaded.
21122 @vindex gnus-always-force-window-configuration
21123 If all windows mentioned in the configuration are already visible, Gnus
21124 won't change the window configuration. If you always want to force the
21125 ``right'' window configuration, you can set
21126 @code{gnus-always-force-window-configuration} to non-@code{nil}.
21128 If you're using tree displays (@pxref{Tree Display}), and the tree
21129 window is displayed vertically next to another window, you may also want
21130 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
21133 @subsection Example Window Configurations
21137 Narrow left hand side occupied by group buffer. Right hand side split
21138 between summary buffer (top one-sixth) and article buffer (bottom).
21153 (gnus-add-configuration
21156 (vertical 25 (group 1.0))
21158 (summary 0.16 point)
21161 (gnus-add-configuration
21164 (vertical 25 (group 1.0))
21165 (vertical 1.0 (summary 1.0 point)))))
21171 @node Faces and Fonts
21172 @section Faces and Fonts
21177 Fiddling with fonts and faces used to be very difficult, but these days
21178 it is very simple. You simply say @kbd{M-x customize-face}, pick out
21179 the face you want to alter, and alter it via the standard Customize
21184 @section Compilation
21185 @cindex compilation
21186 @cindex byte-compilation
21188 @findex gnus-compile
21190 Remember all those line format specification variables?
21191 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
21192 on. By default, T-gnus will use the byte-compiled codes of these
21193 variables and we can keep a slow-down to a minimum. However, if you set
21194 @code{gnus-compile-user-specs} to @code{nil} (@code{t} by default),
21195 unfortunately, changing them will mean a quite significant slow-down.
21196 (The default values of these variables have byte-compiled functions
21197 associated with them, while the user-generated versions do not, of
21200 To help with this, you can run @kbd{M-x gnus-compile} after you've
21201 fiddled around with the variables and feel that you're (kind of)
21202 satisfied. This will result in the new specs being byte-compiled, and
21203 you'll get top speed again. Note that T-gnus will not save these
21204 compiled specs in the @file{.newsrc.eld} file.
21207 @item gnus-compile-user-specs
21208 @vindex gnus-compile-user-specs
21209 If it is non-nil, the user-defined format specs will be byte-compiled
21210 automatically. The default value of this variable is @code{t}. It has
21211 an effect on the values of @code{gnus-*-line-format-spec}.
21216 @section Mode Lines
21219 @vindex gnus-updated-mode-lines
21220 @code{gnus-updated-mode-lines} says what buffers should keep their mode
21221 lines updated. It is a list of symbols. Supported symbols include
21222 @code{group}, @code{article}, @code{summary}, @code{server},
21223 @code{browse}, and @code{tree}. If the corresponding symbol is present,
21224 Gnus will keep that mode line updated with information that may be
21225 pertinent. If this variable is @code{nil}, screen refresh may be
21228 @cindex display-time
21230 @vindex gnus-mode-non-string-length
21231 By default, Gnus displays information on the current article in the mode
21232 lines of the summary and article buffers. The information Gnus wishes
21233 to display (e.g. the subject of the article) is often longer than the
21234 mode lines, and therefore have to be cut off at some point. The
21235 @code{gnus-mode-non-string-length} variable says how long the other
21236 elements on the line is (i.e., the non-info part). If you put
21237 additional elements on the mode line (e.g. a clock), you should modify
21240 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
21242 (add-hook 'display-time-hook
21243 (lambda () (setq gnus-mode-non-string-length
21245 (if line-number-mode 5 0)
21246 (if column-number-mode 4 0)
21247 (length display-time-string)))))
21250 If this variable is @code{nil} (which is the default), the mode line
21251 strings won't be chopped off, and they won't be padded either. Note
21252 that the default is unlikely to be desirable, as even the percentage
21253 complete in the buffer may be crowded off the mode line; the user should
21254 configure this variable appropriately for her configuration.
21257 @node Highlighting and Menus
21258 @section Highlighting and Menus
21260 @cindex highlighting
21263 @vindex gnus-visual
21264 The @code{gnus-visual} variable controls most of the Gnus-prettifying
21265 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
21266 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
21269 This variable can be a list of visual properties that are enabled. The
21270 following elements are valid, and are all included by default:
21273 @item group-highlight
21274 Do highlights in the group buffer.
21275 @item summary-highlight
21276 Do highlights in the summary buffer.
21277 @item article-highlight
21278 Do highlights in the article buffer.
21280 Turn on highlighting in all buffers.
21282 Create menus in the group buffer.
21284 Create menus in the summary buffers.
21286 Create menus in the article buffer.
21288 Create menus in the browse buffer.
21290 Create menus in the server buffer.
21292 Create menus in the score buffers.
21294 Create menus in all buffers.
21297 So if you only want highlighting in the article buffer and menus in all
21298 buffers, you could say something like:
21301 (setq gnus-visual '(article-highlight menu))
21304 If you want highlighting only and no menus whatsoever, you'd say:
21307 (setq gnus-visual '(highlight))
21310 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
21311 in all Gnus buffers.
21313 Other general variables that influence the look of all buffers include:
21316 @item gnus-mouse-face
21317 @vindex gnus-mouse-face
21318 This is the face (i.e., font) used for mouse highlighting in Gnus. No
21319 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
21323 There are hooks associated with the creation of all the different menus:
21327 @item gnus-article-menu-hook
21328 @vindex gnus-article-menu-hook
21329 Hook called after creating the article mode menu.
21331 @item gnus-group-menu-hook
21332 @vindex gnus-group-menu-hook
21333 Hook called after creating the group mode menu.
21335 @item gnus-summary-menu-hook
21336 @vindex gnus-summary-menu-hook
21337 Hook called after creating the summary mode menu.
21339 @item gnus-server-menu-hook
21340 @vindex gnus-server-menu-hook
21341 Hook called after creating the server mode menu.
21343 @item gnus-browse-menu-hook
21344 @vindex gnus-browse-menu-hook
21345 Hook called after creating the browse mode menu.
21347 @item gnus-score-menu-hook
21348 @vindex gnus-score-menu-hook
21349 Hook called after creating the score mode menu.
21360 Those new-fangled @dfn{mouse} contraptions is very popular with the
21361 young, hep kids who don't want to learn the proper way to do things
21362 these days. Why, I remember way back in the summer of '89, when I was
21363 using Emacs on a Tops 20 system. Three hundred users on one single
21364 machine, and every user was running Simula compilers. Bah!
21368 @vindex gnus-carpal
21369 Well, you can make Gnus display bufferfuls of buttons you can click to
21370 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
21371 really. Tell the chiropractor I sent you.
21376 @item gnus-carpal-mode-hook
21377 @vindex gnus-carpal-mode-hook
21378 Hook run in all carpal mode buffers.
21380 @item gnus-carpal-button-face
21381 @vindex gnus-carpal-button-face
21382 Face used on buttons.
21384 @item gnus-carpal-header-face
21385 @vindex gnus-carpal-header-face
21386 Face used on carpal buffer headers.
21388 @item gnus-carpal-group-buffer-buttons
21389 @vindex gnus-carpal-group-buffer-buttons
21390 Buttons in the group buffer.
21392 @item gnus-carpal-summary-buffer-buttons
21393 @vindex gnus-carpal-summary-buffer-buttons
21394 Buttons in the summary buffer.
21396 @item gnus-carpal-server-buffer-buttons
21397 @vindex gnus-carpal-server-buffer-buttons
21398 Buttons in the server buffer.
21400 @item gnus-carpal-browse-buffer-buttons
21401 @vindex gnus-carpal-browse-buffer-buttons
21402 Buttons in the browse buffer.
21405 All the @code{buttons} variables are lists. The elements in these list
21406 are either cons cells where the @code{car} contains a text to be displayed and
21407 the @code{cdr} contains a function symbol, or a simple string.
21415 Gnus, being larger than any program ever written (allegedly), does lots
21416 of strange stuff that you may wish to have done while you're not
21417 present. For instance, you may want it to check for new mail once in a
21418 while. Or you may want it to close down all connections to all servers
21419 when you leave Emacs idle. And stuff like that.
21421 Gnus will let you do stuff like that by defining various
21422 @dfn{handlers}. Each handler consists of three elements: A
21423 @var{function}, a @var{time}, and an @var{idle} parameter.
21425 Here's an example of a handler that closes connections when Emacs has
21426 been idle for thirty minutes:
21429 (gnus-demon-close-connections nil 30)
21432 Here's a handler that scans for @acronym{PGP} headers every hour when
21436 (gnus-demon-scan-pgp 60 t)
21439 This @var{time} parameter and that @var{idle} parameter work together
21440 in a strange, but wonderful fashion. Basically, if @var{idle} is
21441 @code{nil}, then the function will be called every @var{time} minutes.
21443 If @var{idle} is @code{t}, then the function will be called after
21444 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
21445 the function will never be called. But once Emacs goes idle, the
21446 function will be called every @var{time} minutes.
21448 If @var{idle} is a number and @var{time} is a number, the function will
21449 be called every @var{time} minutes only when Emacs has been idle for
21450 @var{idle} minutes.
21452 If @var{idle} is a number and @var{time} is @code{nil}, the function
21453 will be called once every time Emacs has been idle for @var{idle}
21456 And if @var{time} is a string, it should look like @samp{07:31}, and
21457 the function will then be called once every day somewhere near that
21458 time. Modified by the @var{idle} parameter, of course.
21460 @vindex gnus-demon-timestep
21461 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
21462 seconds. This is 60 by default. If you change that variable,
21463 all the timings in the handlers will be affected.)
21465 So, if you want to add a handler, you could put something like this in
21466 your @file{~/.gnus.el} file:
21468 @findex gnus-demon-add-handler
21470 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
21473 @findex gnus-demon-add-nocem
21474 @findex gnus-demon-add-scanmail
21475 @findex gnus-demon-add-rescan
21476 @findex gnus-demon-add-scan-timestamps
21477 @findex gnus-demon-add-disconnection
21478 Some ready-made functions to do this have been created:
21479 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
21480 @code{gnus-demon-add-nntp-close-connection},
21481 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
21482 @code{gnus-demon-add-scanmail}. Just put those functions in your
21483 @file{~/.gnus.el} if you want those abilities.
21485 @findex gnus-demon-init
21486 @findex gnus-demon-cancel
21487 @vindex gnus-demon-handlers
21488 If you add handlers to @code{gnus-demon-handlers} directly, you should
21489 run @code{gnus-demon-init} to make the changes take hold. To cancel all
21490 daemons, you can use the @code{gnus-demon-cancel} function.
21492 Note that adding daemons can be pretty naughty if you over do it. Adding
21493 functions that scan all news and mail from all servers every two seconds
21494 is a sure-fire way of getting booted off any respectable system. So
21503 @dfn{Spamming} is posting the same article lots and lots of times.
21504 Spamming is bad. Spamming is evil.
21506 Spamming is usually canceled within a day or so by various anti-spamming
21507 agencies. These agencies usually also send out @dfn{NoCeM} messages.
21508 NoCeM is pronounced ``no see-'em'', and means what the name
21509 implies---these are messages that make the offending articles, like, go
21512 What use are these NoCeM messages if the articles are canceled anyway?
21513 Some sites do not honor cancel messages and some sites just honor cancels
21514 from a select few people. Then you may wish to make use of the NoCeM
21515 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
21517 Gnus can read and parse the messages in this group automatically, and
21518 this will make spam disappear.
21520 There are some variables to customize, of course:
21523 @item gnus-use-nocem
21524 @vindex gnus-use-nocem
21525 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
21528 @item gnus-nocem-groups
21529 @vindex gnus-nocem-groups
21530 Gnus will look for NoCeM messages in the groups in this list. The
21533 ("news.lists.filters" "news.admin.net-abuse.bulletins"
21534 "alt.nocem.misc" "news.admin.net-abuse.announce")
21537 @item gnus-nocem-issuers
21538 @vindex gnus-nocem-issuers
21539 There are many people issuing NoCeM messages. This list says what
21540 people you want to listen to. The default is
21542 ("Automoose-1" "clewis@@ferret.ocunix.on.ca"
21543 "cosmo.roadkill" "SpamHippo" "hweede@@snafu.de")
21545 fine, upstanding citizens all of them.
21547 Known despammers that you can put in this list are listed at@*
21548 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
21550 You do not have to heed NoCeM messages from all these people---just the
21551 ones you want to listen to. You also don't have to accept all NoCeM
21552 messages from the people you like. Each NoCeM message has a @dfn{type}
21553 header that gives the message a (more or less, usually less) rigorous
21554 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
21555 @samp{binary}, and @samp{troll}. To specify this, you have to use
21556 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
21557 Each condition is either a string (which is a regexp that matches types
21558 you want to use) or a list on the form @code{(not @var{string})}, where
21559 @var{string} is a regexp that matches types you don't want to use.
21561 For instance, if you want all NoCeM messages from Chris Lewis except his
21562 @samp{troll} messages, you'd say:
21565 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
21568 On the other hand, if you just want nothing but his @samp{spam} and
21569 @samp{spew} messages, you'd say:
21572 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
21575 The specs are applied left-to-right.
21578 @item gnus-nocem-verifyer
21579 @vindex gnus-nocem-verifyer
21581 This should be a function for verifying that the NoCeM issuer is who she
21582 says she is. The default is @code{mc-verify}, which is a Mailcrypt
21583 function. If this is too slow and you don't care for verification
21584 (which may be dangerous), you can set this variable to @code{nil}.
21586 If you want signed NoCeM messages to be verified and unsigned messages
21587 not to be verified (but used anyway), you could do something like:
21590 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
21592 (defun my-gnus-mc-verify ()
21600 This might be dangerous, though.
21602 @item gnus-nocem-directory
21603 @vindex gnus-nocem-directory
21604 This is where Gnus will store its NoCeM cache files. The default is@*
21605 @file{~/News/NoCeM/}.
21607 @item gnus-nocem-expiry-wait
21608 @vindex gnus-nocem-expiry-wait
21609 The number of days before removing old NoCeM entries from the cache.
21610 The default is 15. If you make it shorter Gnus will be faster, but you
21611 might then see old spam.
21613 @item gnus-nocem-check-from
21614 @vindex gnus-nocem-check-from
21615 Non-@code{nil} means check for valid issuers in message bodies.
21616 Otherwise don't bother fetching articles unless their author matches a
21617 valid issuer; that is much faster if you are selective about the
21620 @item gnus-nocem-check-article-limit
21621 @vindex gnus-nocem-check-article-limit
21622 If non-@code{nil}, the maximum number of articles to check in any NoCeM
21623 group. NoCeM groups can be huge and very slow to process.
21627 Using NoCeM could potentially be a memory hog. If you have many living
21628 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
21629 big. If this is a problem, you should kill off all (or most) of your
21630 unsubscribed groups (@pxref{Subscription Commands}).
21637 It is very useful to be able to undo actions one has done. In normal
21638 Emacs buffers, it's easy enough---you just push the @code{undo} button.
21639 In Gnus buffers, however, it isn't that simple.
21641 The things Gnus displays in its buffer is of no value whatsoever to
21642 Gnus---it's all just data designed to look nice to the user.
21643 Killing a group in the group buffer with @kbd{C-k} makes the line
21644 disappear, but that's just a side-effect of the real action---the
21645 removal of the group in question from the internal Gnus structures.
21646 Undoing something like that can't be done by the normal Emacs
21647 @code{undo} function.
21649 Gnus tries to remedy this somewhat by keeping track of what the user
21650 does and coming up with actions that would reverse the actions the user
21651 takes. When the user then presses the @code{undo} key, Gnus will run
21652 the code to reverse the previous action, or the previous actions.
21653 However, not all actions are easily reversible, so Gnus currently offers
21654 a few key functions to be undoable. These include killing groups,
21655 yanking groups, and changing the list of read articles of groups.
21656 That's it, really. More functions may be added in the future, but each
21657 added function means an increase in data to be stored, so Gnus will
21658 never be totally undoable.
21660 @findex gnus-undo-mode
21661 @vindex gnus-use-undo
21663 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
21664 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
21665 default. The @kbd{C-M-_} key performs the @code{gnus-undo}
21666 command, which should feel kinda like the normal Emacs @code{undo}
21670 @node Predicate Specifiers
21671 @section Predicate Specifiers
21672 @cindex predicate specifiers
21674 Some Gnus variables are @dfn{predicate specifiers}. This is a special
21675 form that allows flexible specification of predicates without having
21676 to type all that much.
21678 These specifiers are lists consisting of functions, symbols and lists.
21683 (or gnus-article-unseen-p
21684 gnus-article-unread-p)
21687 The available symbols are @code{or}, @code{and} and @code{not}. The
21688 functions all take one parameter.
21690 @findex gnus-make-predicate
21691 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
21692 to create a function that can be called. This input parameter to this
21693 function will be passed along to all the functions in the predicate
21698 @section Moderation
21701 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
21702 It is not included in the standard Gnus package. Write a mail to
21703 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
21706 The moderation package is implemented as a minor mode for summary
21710 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
21713 in your @file{~/.gnus.el} file.
21715 If you are the moderator of @samp{rec.zoofle}, this is how it's
21720 You split your incoming mail by matching on
21721 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
21722 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
21725 You enter that group once in a while and post articles using the @kbd{e}
21726 (edit-and-post) or @kbd{s} (just send unedited) commands.
21729 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
21730 articles that weren't approved by you, you can cancel them with the
21734 To use moderation mode in these two groups, say:
21737 (setq gnus-moderated-list
21738 "^nnml:rec.zoofle$\\|^rec.zoofle$")
21742 @node Image Enhancements
21743 @section Image Enhancements
21745 XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't
21746 support images yet.}, is able to display pictures and stuff, so Gnus has
21747 taken advantage of that.
21750 * X-Face:: Display a funky, teensy black-and-white image.
21751 * Face:: Display a funkier, teensier colored image.
21752 * Smileys:: Show all those happy faces the way they were meant to be shown.
21753 * Picons:: How to display pictures of what you're reading.
21754 * XVarious:: Other XEmacsy Gnusey variables.
21762 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
21763 depth) image that's supposed to represent the author of the message.
21764 It seems to be supported by an ever-growing number of mail and news
21768 @findex gnus-article-display-x-face
21769 @vindex gnus-article-x-face-command
21770 @vindex gnus-article-x-face-too-ugly
21778 Decoding an @code{X-Face} header either requires an Emacs that has
21779 @samp{compface} support (which most XEmacs versions has), or that you
21780 have @samp{compface} installed on your system. If either is true,
21781 Gnus will default to displaying @code{X-Face} headers.
21783 The variable that controls this is the
21784 @code{gnus-article-x-face-command} variable. If this variable is a
21785 string, this string will be executed in a sub-shell. If it is a
21786 function, this function will be called with the face as the argument.
21787 If the @code{gnus-article-x-face-too-ugly} (which is a regexp) matches
21788 the @code{From} header, the face will not be shown.
21790 The default action under Emacs 20 is to fork off the @code{display}
21791 program@footnote{@code{display} is from the ImageMagick package. For
21792 the @code{uncompface} and @code{icontopbm} programs look for a package
21793 like @code{compface} or @code{faces-xface} on a GNU/Linux system.} to
21796 Under XEmacs or Emacs 21+ with suitable image support, the default
21797 action is to display the face before the @code{From} header. (It's
21798 nicer if XEmacs has been compiled with @code{X-Face} support---that
21799 will make display somewhat faster. If there's no native @code{X-Face}
21800 support, Gnus will try to convert the @code{X-Face} header using
21801 external programs from the @code{pbmplus} package and
21802 friends.@footnote{On a GNU/Linux system look for packages with names
21803 like @code{netpbm}, @code{libgr-progs} and @code{compface}.})
21805 (Note: @code{x-face} is used in the variable/function names, not
21808 Gnus provides a few convenience functions and variables to allow
21809 easier insertion of X-Face headers in outgoing messages.
21811 @findex gnus-random-x-face
21812 @vindex gnus-convert-pbm-to-x-face-command
21813 @vindex gnus-x-face-directory
21814 @code{gnus-random-x-face} goes through all the @samp{pbm} files in
21815 @code{gnus-x-face-directory} and picks one at random, and then
21816 converts it to the X-Face format by using the
21817 @code{gnus-convert-pbm-to-x-face-command} shell command. The
21818 @samp{pbm} files should be 48x48 pixels big. It returns the X-Face
21819 header data as a string.
21821 @findex gnus-insert-random-x-face-header
21822 @code{gnus-insert-random-x-face-header} calls
21823 @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the
21824 randomly generated data.
21826 @findex gnus-x-face-from-file
21827 @vindex gnus-convert-image-to-x-face-command
21828 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
21829 converts the file to X-Face format by using the
21830 @code{gnus-convert-image-to-x-face-command} shell command.
21832 Here's how you would typically use the first function. Put something
21833 like the following in your @file{~/.gnus.el} file:
21836 (setq message-required-news-headers
21837 (nconc message-required-news-headers
21838 (list '(X-Face . gnus-random-x-face))))
21841 Using the last function would be something like this:
21844 (setq message-required-news-headers
21845 (nconc message-required-news-headers
21846 (list '(X-Face . (lambda ()
21847 (gnus-x-face-from-file
21848 "~/My-face.gif"))))))
21856 @c #### FIXME: faces and x-faces'implementations should really be harmonized.
21858 @code{Face} headers are essentially a funkier version of @code{X-Face}
21859 ones. They describe a 48x48 pixel colored image that's supposed to
21860 represent the author of the message.
21863 @findex gnus-article-display-face
21864 The contents of a @code{Face} header must be a base64 encoded PNG image.
21865 See @uref{http://quimby.gnus.org/circus/face/} for the precise
21868 Gnus provides a few convenience functions and variables to allow
21869 easier insertion of Face headers in outgoing messages.
21871 @findex gnus-convert-png-to-face
21872 @code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than
21873 726 bytes long, and converts it to a face.
21875 @findex gnus-face-from-file
21876 @vindex gnus-convert-image-to-face-command
21877 @code{gnus-face-from-file} takes a JPEG file as the parameter, and then
21878 converts the file to Face format by using the
21879 @code{gnus-convert-image-to-face-command} shell command.
21881 Here's how you would typically use this function. Put something like the
21882 following in your @file{~/.gnus.el} file:
21885 (setq message-required-news-headers
21886 (nconc message-required-news-headers
21887 (list '(Face . (lambda ()
21888 (gnus-face-from-file "~/face.jpg"))))))
21893 @subsection Smileys
21898 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
21903 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
21904 currently the only package that uses Smiley, it is documented here.
21906 In short---to use Smiley in Gnus, put the following in your
21907 @file{~/.gnus.el} file:
21910 (setq gnus-treat-display-smileys t)
21913 Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and
21914 the like---to pictures and displays those instead of the text smiley
21915 faces. The conversion is controlled by a list of regexps that matches
21916 text and maps that to file names.
21918 @vindex smiley-regexp-alist
21919 The alist used is specified by the @code{smiley-regexp-alist}
21920 variable. The first item in each element is the regexp to be matched;
21921 the second element is the regexp match group that is to be replaced by
21922 the picture; and the third element is the name of the file to be
21925 The following variables customize where Smiley will look for these
21930 @item smiley-data-directory
21931 @vindex smiley-data-directory
21932 Where Smiley will look for smiley faces files.
21934 @item gnus-smiley-file-types
21935 @vindex gnus-smiley-file-types
21936 List of suffixes on smiley file names to try.
21950 So@dots{} You want to slow down your news reader even more! This is a
21951 good way to do so. It's also a great way to impress people staring
21952 over your shoulder as you read news.
21954 What are Picons? To quote directly from the Picons Web site:
21963 @dfn{Picons} is short for ``personal icons''. They're small,
21964 constrained images used to represent users and domains on the net,
21965 organized into databases so that the appropriate image for a given
21966 e-mail address can be found. Besides users and domains, there are picon
21967 databases for Usenet newsgroups and weather forecasts. The picons are
21968 in either monochrome @code{XBM} format or color @code{XPM} and
21969 @code{GIF} formats.
21972 @vindex gnus-picon-databases
21973 For instructions on obtaining and installing the picons databases,
21974 point your Web browser at
21975 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.
21977 If you are using Debian GNU/Linux, saying @samp{apt-get install
21978 picons.*} will install the picons where Gnus can find them.
21980 To enable displaying picons, simply make sure that
21981 @code{gnus-picon-databases} points to the directory containing the
21984 The following variables offer control over where things are located.
21988 @item gnus-picon-databases
21989 @vindex gnus-picon-databases
21990 The location of the picons database. This is a list of directories
21991 containing the @file{news}, @file{domains}, @file{users} (and so on)
21992 subdirectories. Defaults to @code{("/usr/lib/picon"
21993 "/usr/local/faces")}.
21995 @item gnus-picon-news-directories
21996 @vindex gnus-picon-news-directories
21997 List of subdirectories to search in @code{gnus-picon-databases} for
21998 newsgroups faces. @code{("news")} is the default.
22000 @item gnus-picon-user-directories
22001 @vindex gnus-picon-user-directories
22002 List of subdirectories to search in @code{gnus-picon-databases} for user
22003 faces. @code{("users" "usenix" "local" "misc")} is the default.
22005 @item gnus-picon-domain-directories
22006 @vindex gnus-picon-domain-directories
22007 List of subdirectories to search in @code{gnus-picon-databases} for
22008 domain name faces. Defaults to @code{("domains")}. Some people may
22009 want to add @samp{"unknown"} to this list.
22011 @item gnus-picon-file-types
22012 @vindex gnus-picon-file-types
22013 Ordered list of suffixes on picon file names to try. Defaults to
22014 @code{("xpm" "gif" "xbm")} minus those not built-in your Emacs.
22020 @subsection Various XEmacs Variables
22023 @item gnus-xmas-glyph-directory
22024 @vindex gnus-xmas-glyph-directory
22025 This is where Gnus will look for pictures. Gnus will normally
22026 auto-detect this directory, but you may set it manually if you have an
22027 unusual directory structure.
22029 @item gnus-xmas-logo-color-alist
22030 @vindex gnus-xmas-logo-color-alist
22031 This is an alist where the key is a type symbol and the values are the
22032 foreground and background color of the splash page glyph.
22034 @item gnus-xmas-logo-color-style
22035 @vindex gnus-xmas-logo-color-style
22036 This is the key used to look up the color in the alist described above.
22037 Valid values include @code{flame}, @code{pine}, @code{moss},
22038 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
22039 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
22041 @item gnus-xmas-modeline-glyph
22042 @vindex gnus-xmas-modeline-glyph
22043 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
22048 @subsubsection Toolbar
22052 @item gnus-use-toolbar
22053 @vindex gnus-use-toolbar
22054 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
22055 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
22056 @code{right-toolbar}, or @code{left-toolbar}.
22058 @item gnus-group-toolbar
22059 @vindex gnus-group-toolbar
22060 The toolbar in the group buffer.
22062 @item gnus-summary-toolbar
22063 @vindex gnus-summary-toolbar
22064 The toolbar in the summary buffer.
22066 @item gnus-summary-mail-toolbar
22067 @vindex gnus-summary-mail-toolbar
22068 The toolbar in the summary buffer of mail groups.
22079 @node Fuzzy Matching
22080 @section Fuzzy Matching
22081 @cindex fuzzy matching
22083 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
22084 things like scoring, thread gathering and thread comparison.
22086 As opposed to regular expression matching, fuzzy matching is very fuzzy.
22087 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
22088 means, and the implementation has changed over time.
22090 Basically, it tries to remove all noise from lines before comparing.
22091 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
22092 out of the strings before comparing the results. This often leads to
22093 adequate results---even when faced with strings generated by text
22094 manglers masquerading as newsreaders.
22097 @node Thwarting Email Spam
22098 @section Thwarting Email Spam
22102 @cindex unsolicited commercial email
22104 In these last days of the Usenet, commercial vultures are hanging about
22105 and grepping through news like crazy to find email addresses they can
22106 foist off their scams and products to. As a reaction to this, many
22107 people have started putting nonsense addresses into their @code{From}
22108 lines. I think this is counterproductive---it makes it difficult for
22109 people to send you legitimate mail in response to things you write, as
22110 well as making it difficult to see who wrote what. This rewriting may
22111 perhaps be a bigger menace than the unsolicited commercial email itself
22114 The biggest problem I have with email spam is that it comes in under
22115 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
22116 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
22117 mail group, only to find two pyramid schemes, seven advertisements
22118 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
22119 and one mail asking me to repent and find some god.
22121 This is annoying. Here's what you can do about it.
22124 * The problem of spam:: Some background, and some solutions
22125 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
22126 * SpamAssassin:: How to use external anti-spam tools.
22127 * Hashcash:: Reduce spam by burning CPU time.
22128 * Filtering Spam Using The Spam ELisp Package::
22129 * Filtering Spam Using Statistics with spam-stat::
22132 @node The problem of spam
22133 @subsection The problem of spam
22135 @cindex spam filtering approaches
22136 @cindex filtering approaches, spam
22138 @cindex unsolicited commercial email
22140 First, some background on spam.
22142 If you have access to e-mail, you are familiar with spam (technically
22143 termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it exists
22144 because e-mail delivery is very cheap compared to paper mail, so only
22145 a very small percentage of people need to respond to an UCE to make it
22146 worthwhile to the advertiser. Ironically, one of the most common
22147 spams is the one offering a database of e-mail addresses for further
22148 spamming. Senders of spam are usually called @emph{spammers}, but terms like
22149 @emph{vermin}, @emph{scum}, and @emph{morons} are in common use as well.
22151 Spam comes from a wide variety of sources. It is simply impossible to
22152 dispose of all spam without discarding useful messages. A good
22153 example is the TMDA system, which requires senders
22154 unknown to you to confirm themselves as legitimate senders before
22155 their e-mail can reach you. Without getting into the technical side
22156 of TMDA, a downside is clearly that e-mail from legitimate sources may
22157 be discarded if those sources can't or won't confirm themselves
22158 through the TMDA system. Another problem with TMDA is that it
22159 requires its users to have a basic understanding of e-mail delivery
22162 The simplest approach to filtering spam is filtering. If you get 200
22163 spam messages per day from @samp{random-address@@vmadmin.com}, you
22164 block @samp{vmadmin.com}. If you get 200 messages about
22165 @samp{VIAGRA}, you discard all messages with @samp{VIAGRA} in the
22166 message. This, unfortunately, is a great way to discard legitimate
22167 e-mail. For instance, the very informative and useful RISKS digest
22168 has been blocked by overzealous mail filters because it
22169 @strong{contained} words that were common in spam messages.
22170 Nevertheless, in isolated cases, with great care, direct filtering of
22171 mail can be useful.
22173 Another approach to filtering e-mail is the distributed spam
22174 processing, for instance DCC implements such a system. In essence,
22175 @var{N} systems around the world agree that a machine @var{X} in
22176 China, Ghana, or California is sending out spam e-mail, and these
22177 @var{N} systems enter @var{X} or the spam e-mail from @var{X} into
22178 a database. The criteria for spam detection vary---it may be the
22179 number of messages sent, the content of the messages, and so on. When
22180 a user of the distributed processing system wants to find out if a
22181 message is spam, he consults one of those @var{N} systems.
22183 Distributed spam processing works very well against spammers that send
22184 a large number of messages at once, but it requires the user to set up
22185 fairly complicated checks. There are commercial and free distributed
22186 spam processing systems. Distributed spam processing has its risks as
22187 well. For instance legitimate e-mail senders have been accused of
22188 sending spam, and their web sites have been shut down for some time
22189 because of the incident.
22191 The statistical approach to spam filtering is also popular. It is
22192 based on a statistical analysis of previous spam messages. Usually
22193 the analysis is a simple word frequency count, with perhaps pairs of
22194 words or 3-word combinations thrown into the mix. Statistical
22195 analysis of spam works very well in most of the cases, but it can
22196 classify legitimate e-mail as spam in some cases. It takes time to
22197 run the analysis, the full message must be analyzed, and the user has
22198 to store the database of spam analyses.
22200 @node Anti-Spam Basics
22201 @subsection Anti-Spam Basics
22205 @cindex unsolicited commercial email
22207 One way of dealing with spam is having Gnus split out all spam into a
22208 @samp{spam} mail group (@pxref{Splitting Mail}).
22210 First, pick one (1) valid mail address that you can be reached at, and
22211 put it in your @code{From} header of all your news articles. (I've
22212 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
22213 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
22214 sysadmin whether your sendmail installation accepts keywords in the local
22215 part of the mail address.)
22218 (setq message-default-news-headers
22219 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
22222 Then put the following split rule in @code{nnmail-split-fancy}
22223 (@pxref{Fancy Mail Splitting}):
22227 (to "larsi@@trym.ifi.uio.no"
22228 (| ("subject" "re:.*" "misc")
22229 ("references" ".*@@.*" "misc")
22234 This says that all mail to this address is suspect, but if it has a
22235 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
22236 header, it's probably ok. All the rest goes to the @samp{spam} group.
22237 (This idea probably comes from Tim Pierce.)
22239 In addition, many mail spammers talk directly to your @acronym{SMTP} server
22240 and do not include your email address explicitly in the @code{To}
22241 header. Why they do this is unknown---perhaps it's to thwart this
22242 thwarting scheme? In any case, this is trivial to deal with---you just
22243 put anything not addressed to you in the @samp{spam} group by ending
22244 your fancy split rule in this way:
22249 (to "larsi" "misc")
22253 In my experience, this will sort virtually everything into the right
22254 group. You still have to check the @samp{spam} group from time to time to
22255 check for legitimate mail, though. If you feel like being a good net
22256 citizen, you can even send off complaints to the proper authorities on
22257 each unsolicited commercial email---at your leisure.
22259 This works for me. It allows people an easy way to contact me (they can
22260 just press @kbd{r} in the usual way), and I'm not bothered at all with
22261 spam. It's a win-win situation. Forging @code{From} headers to point
22262 to non-existent domains is yucky, in my opinion.
22267 @subsection SpamAssassin, Vipul's Razor, DCC, etc
22268 @cindex SpamAssassin
22269 @cindex Vipul's Razor
22272 The days where the hints in the previous section was sufficient in
22273 avoiding spam are coming to an end. There are many tools out there
22274 that claim to reduce the amount of spam you get. This section could
22275 easily become outdated fast, as new products replace old, but
22276 fortunately most of these tools seem to have similar interfaces. Even
22277 though this section will use SpamAssassin as an example, it should be
22278 easy to adapt it to most other tools.
22280 If the tool you are using is not installed on the mail server, you
22281 need to invoke it yourself. Ideas on how to use the
22282 @code{:postscript} mail source parameter (@pxref{Mail Source
22283 Specifiers}) follow.
22287 '((file :prescript "formail -bs spamassassin < /var/mail/%u")
22291 "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
22294 Once you manage to process your incoming spool somehow, thus making
22295 the mail contain e.g.@: a header indicating it is spam, you are ready to
22296 filter it out. Using normal split methods (@pxref{Splitting Mail}):
22299 (setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES")
22303 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
22306 (setq nnmail-split-methods 'nnmail-split-fancy
22307 nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
22311 Some people might not like the idea of piping the mail through various
22312 programs using a @code{:prescript} (if some program is buggy, you
22313 might lose all mail). If you are one of them, another solution is to
22314 call the external tools during splitting. Example fancy split method:
22317 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
22319 (defun kevin-spamassassin ()
22323 (if (eq 1 (call-process-region (point-min) (point-max)
22324 "spamc" nil nil nil "-c"))
22328 Note that with the nnimap backend, message bodies will not be
22329 downloaded by default. You need to set
22330 @code{nnimap-split-download-body} to t to do that (@pxref{Splitting in
22333 That is about it. As some spam is likely to get through anyway, you
22334 might want to have a nifty function to call when you happen to read
22335 spam. And here is the nifty function:
22338 (defun my-gnus-raze-spam ()
22339 "Submit SPAM to Vipul's Razor, then mark it as expirable."
22341 (gnus-summary-show-raw-article)
22342 (gnus-summary-save-in-pipe "razor-report -f -d")
22343 (gnus-summary-mark-as-expirable 1))
22347 @subsection Hashcash
22350 A novel technique to fight spam is to require senders to do something
22351 costly for each message they send. This has the obvious drawback that
22352 you cannot rely on everyone in the world using this technique,
22353 since it is not part of the Internet standards, but it may be useful
22354 in smaller communities.
22356 While the tools in the previous section work well in practice, they
22357 work only because the tools are constantly maintained and updated as
22358 new form of spam appears. This means that a small percentage of spam
22359 will always get through. It also means that somewhere, someone needs
22360 to read lots of spam to update these tools. Hashcash avoids that, but
22361 instead requires that everyone you communicate with supports the
22362 scheme. You can view the two approaches as pragmatic vs dogmatic.
22363 The approaches have their own advantages and disadvantages, but as
22364 often in the real world, a combination of them is stronger than either
22365 one of them separately.
22368 The ``something costly'' is to burn CPU time, more specifically to
22369 compute a hash collision up to a certain number of bits. The
22370 resulting hashcash cookie is inserted in a @samp{X-Hashcash:}
22371 header. For more details, and for the external application
22372 @code{hashcash} you need to install to use this feature, see
22373 @uref{http://www.cypherspace.org/~adam/hashcash/}. Even more
22374 information can be found at @uref{http://www.camram.org/}.
22376 If you wish to call hashcash for each message you send, say something
22380 (require 'hashcash)
22381 (add-hook 'message-send-hook 'mail-add-payment)
22384 The @file{hashcash.el} library can be found in the Gnus development
22385 contrib directory or at
22386 @uref{http://users.actrix.gen.nz/mycroft/hashcash.el}.
22388 You will need to set up some additional variables as well:
22392 @item hashcash-default-payment
22393 @vindex hashcash-default-payment
22394 This variable indicates the default number of bits the hash collision
22395 should consist of. By default this is 0, meaning nothing will be
22396 done. Suggested useful values include 17 to 29.
22398 @item hashcash-payment-alist
22399 @vindex hashcash-payment-alist
22400 Some receivers may require you to spend burn more CPU time than the
22401 default. This variable contains a list of @samp{(@var{addr}
22402 @var{amount})} cells, where @var{addr} is the receiver (email address
22403 or newsgroup) and @var{amount} is the number of bits in the collision
22404 that is needed. It can also contain @samp{(@var{addr} @var{string}
22405 @var{amount})} cells, where the @var{string} is the string to use
22406 (normally the email address or newsgroup name is used).
22410 Where the @code{hashcash} binary is installed.
22414 Currently there is no built in functionality in Gnus to verify
22415 hashcash cookies, it is expected that this is performed by your hand
22416 customized mail filtering scripts. Improvements in this area would be
22417 a useful contribution, however.
22419 @node Filtering Spam Using The Spam ELisp Package
22420 @subsection Filtering Spam Using The Spam ELisp Package
22421 @cindex spam filtering
22424 The idea behind @file{spam.el} is to have a control center for spam detection
22425 and filtering in Gnus. To that end, @file{spam.el} does two things: it
22426 filters incoming mail, and it analyzes mail known to be spam or ham.
22427 @dfn{Ham} is the name used throughout @file{spam.el} to indicate
22430 First of all, you @strong{must} run the function
22431 @code{spam-initialize} to autoload @code{spam.el} and to install the
22432 @code{spam.el} hooks. There is one exception: if you use the
22433 @code{spam-use-stat} (@pxref{spam-stat spam filtering}) setting, you
22434 should turn it on before @code{spam-initialize}:
22437 (setq spam-use-stat t) ;; if needed
22441 So, what happens when you load @file{spam.el}?
22443 You get the following keyboard commands:
22453 @findex gnus-summary-mark-as-spam
22454 @code{gnus-summary-mark-as-spam}.
22456 Mark current article as spam, showing it with the @samp{$} mark.
22457 Whenever you see a spam article, make sure to mark its summary line
22458 with @kbd{M-d} before leaving the group. This is done automatically
22459 for unread articles in @emph{spam} groups.
22465 @findex spam-bogofilter-score
22466 @code{spam-bogofilter-score}.
22468 You must have Bogofilter installed for that command to work properly.
22474 Also, when you load @file{spam.el}, you will be able to customize its
22475 variables. Try @code{customize-group} on the @samp{spam} variable
22478 @vindex gnus-spam-process-newsgroups
22479 The concepts of ham processors and spam processors are very important.
22480 Ham processors and spam processors for a group can be set with the
22481 @code{spam-process} group parameter, or the
22482 @code{gnus-spam-process-newsgroups} variable. Ham processors take
22483 mail known to be non-spam (@emph{ham}) and process it in some way so
22484 that later similar mail will also be considered non-spam. Spam
22485 processors take mail known to be spam and process it so similar spam
22486 will be detected later.
22488 @vindex gnus-spam-newsgroup-contents
22489 Gnus learns from the spam you get. You have to collect your spam in
22490 one or more spam groups, and set or customize the variable
22491 @code{spam-junk-mailgroups} as appropriate. You can also declare
22492 groups to contain spam by setting their group parameter
22493 @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or
22494 by customizing the corresponding variable
22495 @code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group
22496 parameter and the @code{gnus-spam-newsgroup-contents} variable can
22497 also be used to declare groups as @emph{ham} groups if you set their
22498 classification to @code{gnus-group-spam-classification-ham}. If
22499 groups are not classified by means of @code{spam-junk-mailgroups},
22500 @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are
22501 considered @emph{unclassified}. All groups are unclassified by
22504 @vindex gnus-spam-mark
22506 In spam groups, all messages are considered to be spam by default:
22507 they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the
22508 group. If you have seen a message, had it marked as spam, then
22509 unmarked it, it won't be marked as spam when you enter the group
22510 thereafter. You can disable that behavior, so all unread messages
22511 will get the @samp{$} mark, if you set the
22512 @code{spam-mark-only-unseen-as-spam} parameter to @code{nil}. You
22513 should remove the @samp{$} mark when you are in the group summary
22514 buffer for every message that is not spam after all. To remove the
22515 @samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or
22516 @kbd{d} for declaring it read the non-spam way. When you leave a
22517 group, all spam-marked (@samp{$}) articles are sent to a spam
22518 processor which will study them as spam samples.
22520 Messages may also be deleted in various other ways, and unless
22521 @code{ham-marks} group parameter gets overridden below, marks @samp{R}
22522 and @samp{r} for default read or explicit delete, marks @samp{X} and
22523 @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for
22524 low scores, are all considered to be associated with articles which
22525 are not spam. This assumption might be false, in particular if you
22526 use kill files or score files as means for detecting genuine spam, you
22527 should then adjust the @code{ham-marks} group parameter.
22530 You can customize this group or topic parameter to be the list of
22531 marks you want to consider ham. By default, the list contains the
22532 deleted, read, killed, kill-filed, and low-score marks.
22536 You can customize this group or topic parameter to be the list of
22537 marks you want to consider spam. By default, the list contains only
22541 When you leave @emph{any} group, regardless of its
22542 @code{spam-contents} classification, all spam-marked articles are sent
22543 to a spam processor, which will study these as spam samples. If you
22544 explicit kill a lot, you might sometimes end up with articles marked
22545 @samp{K} which you never saw, and which might accidentally contain
22546 spam. Best is to make sure that real spam is marked with @samp{$},
22549 @vindex gnus-ham-process-destinations
22550 When you leave a @emph{spam} group, all spam-marked articles are
22551 marked as expired after processing with the spam processor. This is
22552 not done for @emph{unclassified} or @emph{ham} groups. Also, any
22553 @strong{ham} articles in a spam group will be moved to a location
22554 determined by either the @code{ham-process-destination} group
22555 parameter or a match in the @code{gnus-ham-process-destinations}
22556 variable, which is a list of regular expressions matched with group
22557 names (it's easiest to customize this variable with
22558 @code{customize-variable gnus-ham-process-destinations}). Each
22559 newsgroup specification has the format (REGEXP PROCESSOR) in a
22560 standard Lisp list, if you prefer to customize the variable manually.
22561 The ultimate location is a group name. If the
22562 @code{ham-process-destination} parameter is not set, ham articles are
22563 left in place. If the
22564 @code{spam-mark-ham-unread-before-move-from-spam-group} parameter is
22565 set, the ham articles are marked as unread before being moved.
22567 When you leave a @emph{ham} group, all ham-marked articles are sent to
22568 a ham processor, which will study these as non-spam samples.
22570 @vindex spam-process-ham-in-spam-groups
22571 By default the variable @code{spam-process-ham-in-spam-groups} is
22572 @code{nil}. Set it to @code{t} if you want ham found in spam groups
22573 to be processed. Normally this is not done, you are expected instead
22574 to send your ham to a ham group and process it there.
22576 @vindex spam-process-ham-in-nonham-groups
22577 By default the variable @code{spam-process-ham-in-nonham-groups} is
22578 @code{nil}. Set it to @code{t} if you want ham found in non-ham (spam
22579 or unclassified) groups to be processed. Normally this is not done,
22580 you are expected instead to send your ham to a ham group and process
22583 @vindex gnus-spam-process-destinations
22584 When you leave a @emph{ham} or @emph{unclassified} group, all
22585 @strong{spam} articles are moved to a location determined by either
22586 the @code{spam-process-destination} group parameter or a match in the
22587 @code{gnus-spam-process-destinations} variable, which is a list of
22588 regular expressions matched with group names (it's easiest to
22589 customize this variable with @code{customize-variable
22590 gnus-spam-process-destinations}). Each newsgroup specification has
22591 the repeated format (REGEXP PROCESSOR) and they are all in a standard
22592 Lisp list, if you prefer to customize the variable manually. The
22593 ultimate location is a group name. If the
22594 @code{spam-process-destination} parameter is not set, the spam
22595 articles are only expired.
22597 To use the @file{spam.el} facilities for incoming mail filtering, you
22598 must add the following to your fancy split list
22599 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}:
22605 Note that the fancy split may be called @code{nnmail-split-fancy} or
22606 @code{nnimap-split-fancy}, depending on whether you use the nnmail or
22607 nnimap back ends to retrieve your mail.
22609 The @code{spam-split} function will process incoming mail and send the
22610 mail considered to be spam into the group name given by the variable
22611 @code{spam-split-group}. By default that group name is @samp{spam},
22612 but you can customize @code{spam-split-group}. Make sure the contents
22613 of @code{spam-split-group} are an @emph{unqualified} group name, for
22614 instance in an @code{nnimap} server @samp{your-server} the value
22615 @samp{spam} will turn out to be @samp{nnimap+your-server:spam}. The
22616 value @samp{nnimap+server:spam}, therefore, is wrong and will
22617 actually give you the group
22618 @samp{nnimap+your-server:nnimap+server:spam} which may or may not
22619 work depending on your server's tolerance for strange group names.
22621 You can also give @code{spam-split} a parameter,
22622 e.g. @samp{'spam-use-regex-headers} or @samp{"maybe-spam"}. Why is
22625 Take these split rules (with @code{spam-use-regex-headers} and
22626 @code{spam-use-blackholes} set):
22629 nnimap-split-fancy '(|
22630 (any "ding" "ding")
22636 Now, the problem is that you want all ding messages to make it to the
22637 ding folder. But that will let obvious spam (for example, spam
22638 detected by SpamAssassin, and @code{spam-use-regex-headers}) through,
22639 when it's sent to the ding list. On the other hand, some messages to
22640 the ding list are from a mail server in the blackhole list, so the
22641 invocation of @code{spam-split} can't be before the ding rule.
22643 You can let SpamAssassin headers supersede ding rules, but all other
22644 @code{spam-split} rules (including a second invocation of the
22645 regex-headers check) will be after the ding rule:
22648 nnimap-split-fancy '(|
22649 ;;; all spam detected by spam-use-regex-headers goes to "regex-spam"
22650 (: spam-split "regex-spam" 'spam-use-regex-headers)
22651 (any "ding" "ding")
22652 ;;; all other spam detected by spam-split goes to spam-split-group
22658 Basically, this lets you invoke specific @code{spam-split} checks
22659 depending on your particular needs, and to target the results of those
22660 checks to a particular spam group. You don't have to throw all mail
22661 into all the spam tests. Another reason why this is nice is that
22662 messages to mailing lists you have rules for don't have to have
22663 resource-intensive blackhole checks performed on them. You could also
22664 specify different spam checks for your nnmail split vs. your nnimap
22667 You still have to have specific checks such as
22668 @code{spam-use-regex-headers} set to @code{t}, even if you specifically
22669 invoke @code{spam-split} with the check. The reason is that when
22670 loading @file{spam.el}, some conditional loading is done depending on
22671 what @code{spam-use-xyz} variables you have set.
22673 @emph{Note for IMAP users}
22675 The boolean variable @code{nnimap-split-download-body} needs to be
22676 set, if you want to split based on the whole message instead of just
22677 the headers. By default, the nnimap back end will only retrieve the
22678 message headers. If you use @code{spam-check-bogofilter},
22679 @code{spam-check-ifile}, or @code{spam-check-stat} (the splitters that
22680 can benefit from the full message body), you should set this variable.
22681 It is not set by default because it will slow @acronym{IMAP} down, and
22682 that is not an appropriate decision to make on behalf of the user.
22684 @xref{Splitting in IMAP}.
22686 @emph{TODO: Currently, spam.el only supports insertion of articles
22687 into a back end. There is no way to tell spam.el that an article is no
22688 longer spam or ham.}
22690 @emph{TODO: spam.el needs to provide a uniform way of training all the
22691 statistical databases. Some have that functionality built-in, others
22694 The following are the methods you can use to control the behavior of
22695 @code{spam-split} and their corresponding spam and ham processors:
22698 * Blacklists and Whitelists::
22699 * BBDB Whitelists::
22700 * Gmane Spam Reporting::
22701 * Anti-spam Hashcash Payments::
22703 * Regular Expressions Header Matching::
22705 * ifile spam filtering::
22706 * spam-stat spam filtering::
22708 * Extending the spam elisp package::
22711 @node Blacklists and Whitelists
22712 @subsubsection Blacklists and Whitelists
22713 @cindex spam filtering
22714 @cindex whitelists, spam filtering
22715 @cindex blacklists, spam filtering
22718 @defvar spam-use-blacklist
22720 Set this variable to @code{t} if you want to use blacklists when
22721 splitting incoming mail. Messages whose senders are in the blacklist
22722 will be sent to the @code{spam-split-group}. This is an explicit
22723 filter, meaning that it acts only on mail senders @emph{declared} to
22728 @defvar spam-use-whitelist
22730 Set this variable to @code{t} if you want to use whitelists when
22731 splitting incoming mail. Messages whose senders are not in the
22732 whitelist will be sent to the next spam-split rule. This is an
22733 explicit filter, meaning that unless someone is in the whitelist, their
22734 messages are not assumed to be spam or ham.
22738 @defvar spam-use-whitelist-exclusive
22740 Set this variable to @code{t} if you want to use whitelists as an
22741 implicit filter, meaning that every message will be considered spam
22742 unless the sender is in the whitelist. Use with care.
22746 @defvar gnus-group-spam-exit-processor-blacklist
22748 Add this symbol to a group's @code{spam-process} parameter by
22749 customizing the group parameters or the
22750 @code{gnus-spam-process-newsgroups} variable. When this symbol is
22751 added to a group's @code{spam-process} parameter, the senders of
22752 spam-marked articles will be added to the blacklist.
22756 @defvar gnus-group-ham-exit-processor-whitelist
22758 Add this symbol to a group's @code{spam-process} parameter by
22759 customizing the group parameters or the
22760 @code{gnus-spam-process-newsgroups} variable. When this symbol is
22761 added to a group's @code{spam-process} parameter, the senders of
22762 ham-marked articles in @emph{ham} groups will be added to the
22763 whitelist. Note that this ham processor has no effect in @emph{spam}
22764 or @emph{unclassified} groups.
22768 Blacklists are lists of regular expressions matching addresses you
22769 consider to be spam senders. For instance, to block mail from any
22770 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
22771 blacklist. You start out with an empty blacklist. Blacklist entries
22772 use the Emacs regular expression syntax.
22774 Conversely, whitelists tell Gnus what addresses are considered
22775 legitimate. All messages from whitelisted addresses are considered
22776 non-spam. Also see @ref{BBDB Whitelists}. Whitelist entries use the
22777 Emacs regular expression syntax.
22779 The blacklist and whitelist file locations can be customized with the
22780 @code{spam-directory} variable (@file{~/News/spam} by default), or
22781 the @code{spam-whitelist} and @code{spam-blacklist} variables
22782 directly. The whitelist and blacklist files will by default be in the
22783 @code{spam-directory} directory, named @file{whitelist} and
22784 @file{blacklist} respectively.
22786 @node BBDB Whitelists
22787 @subsubsection BBDB Whitelists
22788 @cindex spam filtering
22789 @cindex BBDB whitelists, spam filtering
22790 @cindex BBDB, spam filtering
22793 @defvar spam-use-BBDB
22795 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
22796 Whitelists}), but uses the BBDB as the source of whitelisted
22797 addresses, without regular expressions. You must have the BBDB loaded
22798 for @code{spam-use-BBDB} to work properly. Messages whose senders are
22799 not in the BBDB will be sent to the next spam-split rule. This is an
22800 explicit filter, meaning that unless someone is in the BBDB, their
22801 messages are not assumed to be spam or ham.
22805 @defvar spam-use-BBDB-exclusive
22807 Set this variable to @code{t} if you want to use the BBDB as an
22808 implicit filter, meaning that every message will be considered spam
22809 unless the sender is in the BBDB. Use with care. Only sender
22810 addresses in the BBDB will be allowed through; all others will be
22811 classified as spammers.
22815 @defvar gnus-group-ham-exit-processor-BBDB
22817 Add this symbol to a group's @code{spam-process} parameter by
22818 customizing the group parameters or the
22819 @code{gnus-spam-process-newsgroups} variable. When this symbol is
22820 added to a group's @code{spam-process} parameter, the senders of
22821 ham-marked articles in @emph{ham} groups will be added to the
22822 BBDB. Note that this ham processor has no effect in @emph{spam}
22823 or @emph{unclassified} groups.
22827 @node Gmane Spam Reporting
22828 @subsubsection Gmane Spam Reporting
22829 @cindex spam reporting
22830 @cindex Gmane, spam reporting
22831 @cindex Gmane, spam reporting
22834 @defvar gnus-group-spam-exit-processor-report-gmane
22836 Add this symbol to a group's @code{spam-process} parameter by
22837 customizing the group parameters or the
22838 @code{gnus-spam-process-newsgroups} variable. When this symbol is
22839 added to a group's @code{spam-process} parameter, the spam-marked
22840 articles groups will be reported to the Gmane administrators via a
22843 Gmane can be found at @uref{http://gmane.org}.
22847 @defvar spam-report-gmane-use-article-number
22849 This variable is @code{t} by default. Set it to @code{nil} if you are
22850 running your own news server, for instance, and the local article
22851 numbers don't correspond to the Gmane article numbers. When
22852 @code{spam-report-gmane-use-article-number} is @code{nil},
22853 @code{spam-report.el} will use the @code{X-Report-Spam} header that
22858 @node Anti-spam Hashcash Payments
22859 @subsubsection Anti-spam Hashcash Payments
22860 @cindex spam filtering
22861 @cindex hashcash, spam filtering
22864 @defvar spam-use-hashcash
22866 Similar to @code{spam-use-whitelist} (@pxref{Blacklists and
22867 Whitelists}), but uses hashcash tokens for whitelisting messages
22868 instead of the sender address. You must have the @code{hashcash.el}
22869 package loaded for @code{spam-use-hashcash} to work properly.
22870 Messages without a hashcash payment token will be sent to the next
22871 spam-split rule. This is an explicit filter, meaning that unless a
22872 hashcash token is found, the messages are not assumed to be spam or
22878 @subsubsection Blackholes
22879 @cindex spam filtering
22880 @cindex blackholes, spam filtering
22883 @defvar spam-use-blackholes
22885 This option is disabled by default. You can let Gnus consult the
22886 blackhole-type distributed spam processing systems (DCC, for instance)
22887 when you set this option. The variable @code{spam-blackhole-servers}
22888 holds the list of blackhole servers Gnus will consult. The current
22889 list is fairly comprehensive, but make sure to let us know if it
22890 contains outdated servers.
22892 The blackhole check uses the @code{dig.el} package, but you can tell
22893 @file{spam.el} to use @code{dns.el} instead for better performance if
22894 you set @code{spam-use-dig} to @code{nil}. It is not recommended at
22895 this time to set @code{spam-use-dig} to @code{nil} despite the
22896 possible performance improvements, because some users may be unable to
22897 use it, but you can try it and see if it works for you.
22901 @defvar spam-blackhole-servers
22903 The list of servers to consult for blackhole checks.
22907 @defvar spam-blackhole-good-server-regex
22909 A regular expression for IPs that should not be checked against the
22910 blackhole server list. When set to @code{nil}, it has no effect.
22914 @defvar spam-use-dig
22916 Use the @code{dig.el} package instead of the @code{dns.el} package.
22917 The default setting of @code{t} is recommended.
22921 Blackhole checks are done only on incoming mail. There is no spam or
22922 ham processor for blackholes.
22924 @node Regular Expressions Header Matching
22925 @subsubsection Regular Expressions Header Matching
22926 @cindex spam filtering
22927 @cindex regular expressions header matching, spam filtering
22930 @defvar spam-use-regex-headers
22932 This option is disabled by default. You can let Gnus check the
22933 message headers against lists of regular expressions when you set this
22934 option. The variables @code{spam-regex-headers-spam} and
22935 @code{spam-regex-headers-ham} hold the list of regular expressions.
22936 Gnus will check against the message headers to determine if the
22937 message is spam or ham, respectively.
22941 @defvar spam-regex-headers-spam
22943 The list of regular expressions that, when matched in the headers of
22944 the message, positively identify it as spam.
22948 @defvar spam-regex-headers-ham
22950 The list of regular expressions that, when matched in the headers of
22951 the message, positively identify it as ham.
22955 Regular expression header checks are done only on incoming mail.
22956 There is no specific spam or ham processor for regular expressions.
22959 @subsubsection Bogofilter
22960 @cindex spam filtering
22961 @cindex bogofilter, spam filtering
22964 @defvar spam-use-bogofilter
22966 Set this variable if you want @code{spam-split} to use Eric Raymond's
22969 With a minimum of care for associating the @samp{$} mark for spam
22970 articles only, Bogofilter training all gets fairly automatic. You
22971 should do this until you get a few hundreds of articles in each
22972 category, spam or not. The command @kbd{S t} in summary mode, either
22973 for debugging or for curiosity, shows the @emph{spamicity} score of
22974 the current article (between 0.0 and 1.0).
22976 Bogofilter determines if a message is spam based on a specific
22977 threshold. That threshold can be customized, consult the Bogofilter
22980 If the @code{bogofilter} executable is not in your path, Bogofilter
22981 processing will be turned off.
22983 You should not enable this if you use @code{spam-use-bogofilter-headers}.
22987 @defvar spam-use-bogofilter-headers
22989 Set this variable if you want @code{spam-split} to use Eric Raymond's
22990 speedy Bogofilter, looking only at the message headers. It works
22991 similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header
22992 must be in the message already. Normally you would do this with a
22993 procmail recipe or something similar; consult the Bogofilter
22994 installation documents for details.
22996 You should not enable this if you use @code{spam-use-bogofilter}.
23000 @defvar gnus-group-spam-exit-processor-bogofilter
23001 Add this symbol to a group's @code{spam-process} parameter by
23002 customizing the group parameters or the
23003 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23004 added to a group's @code{spam-process} parameter, spam-marked articles
23005 will be added to the Bogofilter spam database.
23008 @defvar gnus-group-ham-exit-processor-bogofilter
23009 Add this symbol to a group's @code{spam-process} parameter by
23010 customizing the group parameters or the
23011 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23012 added to a group's @code{spam-process} parameter, the ham-marked
23013 articles in @emph{ham} groups will be added to the Bogofilter database
23014 of non-spam messages. Note that this ham processor has no effect in
23015 @emph{spam} or @emph{unclassified} groups.
23018 @defvar spam-bogofilter-database-directory
23020 This is the directory where Bogofilter will store its databases. It
23021 is not specified by default, so Bogofilter will use its own default
23022 database directory.
23026 The Bogofilter mail classifier is similar to @command{ifile} in intent and
23027 purpose. A ham and a spam processor are provided, plus the
23028 @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers}
23029 variables to indicate to spam-split that Bogofilter should either be
23030 used, or has already been used on the article. The 0.9.2.1 version of
23031 Bogofilter was used to test this functionality.
23033 @node ifile spam filtering
23034 @subsubsection ifile spam filtering
23035 @cindex spam filtering
23036 @cindex ifile, spam filtering
23039 @defvar spam-use-ifile
23041 Enable this variable if you want @code{spam-split} to use @command{ifile}, a
23042 statistical analyzer similar to Bogofilter.
23046 @defvar spam-ifile-all-categories
23048 Enable this variable if you want @code{spam-use-ifile} to give you all
23049 the ifile categories, not just spam/non-spam. If you use this, make
23050 sure you train ifile as described in its documentation.
23054 @defvar spam-ifile-spam-category
23056 This is the category of spam messages as far as ifile is concerned.
23057 The actual string used is irrelevant, but you probably want to leave
23058 the default value of @samp{spam}.
23061 @defvar spam-ifile-database-path
23063 This is the filename for the ifile database. It is not specified by
23064 default, so ifile will use its own default database name.
23068 The ifile mail classifier is similar to Bogofilter in intent and
23069 purpose. A ham and a spam processor are provided, plus the
23070 @code{spam-use-ifile} variable to indicate to spam-split that ifile
23071 should be used. The 1.2.1 version of ifile was used to test this
23074 @node spam-stat spam filtering
23075 @subsubsection spam-stat spam filtering
23076 @cindex spam filtering
23077 @cindex spam-stat, spam filtering
23081 @xref{Filtering Spam Using Statistics with spam-stat}.
23083 @defvar spam-use-stat
23085 Enable this variable if you want @code{spam-split} to use
23086 spam-stat.el, an Emacs Lisp statistical analyzer.
23090 @defvar gnus-group-spam-exit-processor-stat
23091 Add this symbol to a group's @code{spam-process} parameter by
23092 customizing the group parameters or the
23093 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23094 added to a group's @code{spam-process} parameter, the spam-marked
23095 articles will be added to the spam-stat database of spam messages.
23098 @defvar gnus-group-ham-exit-processor-stat
23099 Add this symbol to a group's @code{spam-process} parameter by
23100 customizing the group parameters or the
23101 @code{gnus-spam-process-newsgroups} variable. When this symbol is
23102 added to a group's @code{spam-process} parameter, the ham-marked
23103 articles in @emph{ham} groups will be added to the spam-stat database
23104 of non-spam messages. Note that this ham processor has no effect in
23105 @emph{spam} or @emph{unclassified} groups.
23108 This enables @file{spam.el} to cooperate with @file{spam-stat.el}.
23109 @file{spam-stat.el} provides an internal (Lisp-only) spam database,
23110 which unlike ifile or Bogofilter does not require external programs.
23111 A spam and a ham processor, and the @code{spam-use-stat} variable for
23112 @code{spam-split} are provided.
23115 @subsubsection Using SpamOracle with Gnus
23116 @cindex spam filtering
23120 An easy way to filter out spam is to use SpamOracle. SpamOracle is an
23121 statistical mail filtering tool written by Xavier Leroy and needs to be
23122 installed separately.
23124 There are several ways to use SpamOracle with Gnus. In all cases, your
23125 mail is piped through SpamOracle in its @emph{mark} mode. SpamOracle will
23126 then enter an @samp{X-Spam} header indicating whether it regards the
23127 mail as a spam mail or not.
23129 One possibility is to run SpamOracle as a @code{:prescript} from the
23130 @xref{Mail Source Specifiers}, (@pxref{SpamAssassin}). This method has
23131 the advantage that the user can see the @emph{X-Spam} headers.
23133 The easiest method is to make @file{spam.el} (@pxref{Filtering Spam
23134 Using The Spam ELisp Package}) call SpamOracle.
23136 @vindex spam-use-spamoracle
23137 To enable SpamOracle usage by @file{spam.el}, set the variable
23138 @code{spam-use-spamoracle} to @code{t} and configure the
23139 @code{nnmail-split-fancy} or @code{nnimap-split-fancy} as described in
23140 the section @xref{Filtering Spam Using The Spam ELisp Package}. In
23141 this example the @samp{INBOX} of an nnimap server is filtered using
23142 SpamOracle. Mails recognized as spam mails will be moved to
23143 @code{spam-split-group}, @samp{Junk} in this case. Ham messages stay
23147 (setq spam-use-spamoracle t
23148 spam-split-group "Junk"
23149 nnimap-split-inbox '("INBOX")
23150 nnimap-split-rule 'nnimap-split-fancy
23151 nnimap-split-fancy '(| (: spam-split) "INBOX"))
23154 @defvar spam-use-spamoracle
23155 Set to @code{t} if you want Gnus to enable spam filtering using
23159 @defvar spam-spamoracle-binary
23160 Gnus uses the SpamOracle binary called @file{spamoracle} found in the
23161 user's PATH. Using the variable @code{spam-spamoracle-binary}, this
23165 @defvar spam-spamoracle-database
23166 By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to
23167 store its analyses. This is controlled by the variable
23168 @code{spam-spamoracle-database} which defaults to @code{nil}. That means
23169 the default SpamOracle database will be used. In case you want your
23170 database to live somewhere special, set
23171 @code{spam-spamoracle-database} to this path.
23174 SpamOracle employs a statistical algorithm to determine whether a
23175 message is spam or ham. In order to get good results, meaning few
23176 false hits or misses, SpamOracle needs training. SpamOracle learns the
23177 characteristics of your spam mails. Using the @emph{add} mode
23178 (training mode) one has to feed good (ham) and spam mails to
23179 SpamOracle. This can be done by pressing @kbd{|} in the Summary buffer
23180 and pipe the mail to a SpamOracle process or using @file{spam.el}'s
23181 spam- and ham-processors, which is much more convenient. For a
23182 detailed description of spam- and ham-processors, @xref{Filtering Spam
23183 Using The Spam ELisp Package}.
23185 @defvar gnus-group-spam-exit-processor-spamoracle
23186 Add this symbol to a group's @code{spam-process} parameter by
23187 customizing the group parameter or the
23188 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
23189 to a group's @code{spam-process} parameter, spam-marked articles will be
23190 sent to SpamOracle as spam samples.
23193 @defvar gnus-group-ham-exit-processor-spamoracle
23194 Add this symbol to a group's @code{spam-process} parameter by
23195 customizing the group parameter or the
23196 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
23197 to a grup's @code{spam-process} parameter, the ham-marked articles in
23198 @emph{ham} groups will be sent to the SpamOracle as samples of ham
23199 messages. Note that this ham processor has no effect in @emph{spam} or
23200 @emph{unclassified} groups.
23203 @emph{Example:} These are the Group Parameters of an group that has been
23204 classified as a ham group, meaning that it should only contain ham
23207 ((spam-contents gnus-group-spam-classification-ham)
23209 (gnus-group-spam-exit-processor-spamoracle)))
23211 For this group the @code{gnus-group-spam-exit-processor-spamoracle} is
23212 installed. If the group contains spam message (e.g. because SpamOracle
23213 has not had enough sample messages yet) and the user marks some
23214 messages as spam messages, these messages will be processed by
23215 @code{gnus-group-spam-exit-processor-spamoracle}. This processor sends
23216 the messages to SpamOracle as new samples for spam.
23218 @node Extending the spam elisp package
23219 @subsubsection Extending the spam elisp package
23220 @cindex spam filtering
23221 @cindex spam elisp package, extending
23222 @cindex extending the spam elisp package
23224 Say you want to add a new back end called blackbox. For filtering
23225 incoming mail, provide the following:
23233 (defvar spam-use-blackbox nil
23234 "True if blackbox should be used.")
23239 (spam-use-blackbox . spam-check-blackbox)
23241 to @code{spam-list-of-checks}.
23246 Write the @code{spam-check-blackbox} function. It should return
23247 @samp{nil} or @code{spam-split-group}. See the existing
23248 @code{spam-check-*} functions for examples of what you can do.
23250 Make sure to add @code{spam-use-blackbox} to
23251 @code{spam-list-of-statistical-checks} if Blackbox is a statistical
23252 mail analyzer that needs the full message body to operate.
23256 For processing spam and ham messages, provide the following:
23263 Note you don't have to provide a spam or a ham processor. Only
23264 provide them if Blackbox supports spam or ham processing.
23267 (defvar gnus-group-spam-exit-processor-blackbox "blackbox"
23268 "The Blackbox summary exit spam processor.
23269 Only applicable to spam groups.")
23271 (defvar gnus-group-ham-exit-processor-blackbox "blackbox"
23272 "The whitelist summary exit ham processor.
23273 Only applicable to non-spam (unclassified and ham) groups.")
23281 (defun spam-blackbox-register-spam-routine ()
23282 (spam-generic-register-routine
23283 ;; @r{the spam function}
23285 (let ((from (spam-fetch-field-from-fast article)))
23286 (when (stringp from)
23287 (blackbox-do-something-with-this-spammer from))))
23288 ;; @r{the ham function}
23291 (defun spam-blackbox-register-ham-routine ()
23292 (spam-generic-register-routine
23293 ;; @r{the spam function}
23295 ;; @r{the ham function}
23297 (let ((from (spam-fetch-field-from-fast article)))
23298 (when (stringp from)
23299 (blackbox-do-something-with-this-ham-sender from))))))
23302 Write the @code{blackbox-do-something-with-this-ham-sender} and
23303 @code{blackbox-do-something-with-this-spammer} functions. You can add
23304 more complex code than fetching the message sender, but keep in mind
23305 that retrieving the whole message takes significantly longer than the
23306 sender through @code{spam-fetch-field-from-fast}, because the message
23307 senders are kept in memory by Gnus.
23312 @node Filtering Spam Using Statistics with spam-stat
23313 @subsection Filtering Spam Using Statistics with spam-stat
23314 @cindex Paul Graham
23315 @cindex Graham, Paul
23316 @cindex naive Bayesian spam filtering
23317 @cindex Bayesian spam filtering, naive
23318 @cindex spam filtering, naive Bayesian
23320 Paul Graham has written an excellent essay about spam filtering using
23321 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
23322 Spam}. In it he describes the inherent deficiency of rule-based
23323 filtering as used by SpamAssassin, for example: Somebody has to write
23324 the rules, and everybody else has to install these rules. You are
23325 always late. It would be much better, he argues, to filter mail based
23326 on whether it somehow resembles spam or non-spam. One way to measure
23327 this is word distribution. He then goes on to describe a solution
23328 that checks whether a new mail resembles any of your other spam mails
23331 The basic idea is this: Create a two collections of your mail, one
23332 with spam, one with non-spam. Count how often each word appears in
23333 either collection, weight this by the total number of mails in the
23334 collections, and store this information in a dictionary. For every
23335 word in a new mail, determine its probability to belong to a spam or a
23336 non-spam mail. Use the 15 most conspicuous words, compute the total
23337 probability of the mail being spam. If this probability is higher
23338 than a certain threshold, the mail is considered to be spam.
23340 Gnus supports this kind of filtering. But it needs some setting up.
23341 First, you need two collections of your mail, one with spam, one with
23342 non-spam. Then you need to create a dictionary using these two
23343 collections, and save it. And last but not least, you need to use
23344 this dictionary in your fancy mail splitting rules.
23347 * Creating a spam-stat dictionary::
23348 * Splitting mail using spam-stat::
23349 * Low-level interface to the spam-stat dictionary::
23352 @node Creating a spam-stat dictionary
23353 @subsubsection Creating a spam-stat dictionary
23355 Before you can begin to filter spam based on statistics, you must
23356 create these statistics based on two mail collections, one with spam,
23357 one with non-spam. These statistics are then stored in a dictionary
23358 for later use. In order for these statistics to be meaningful, you
23359 need several hundred emails in both collections.
23361 Gnus currently supports only the nnml back end for automated dictionary
23362 creation. The nnml back end stores all mails in a directory, one file
23363 per mail. Use the following:
23365 @defun spam-stat-process-spam-directory
23366 Create spam statistics for every file in this directory. Every file
23367 is treated as one spam mail.
23370 @defun spam-stat-process-non-spam-directory
23371 Create non-spam statistics for every file in this directory. Every
23372 file is treated as one non-spam mail.
23375 Usually you would call @code{spam-stat-process-spam-directory} on a
23376 directory such as @file{~/Mail/mail/spam} (this usually corresponds
23377 the the group @samp{nnml:mail.spam}), and you would call
23378 @code{spam-stat-process-non-spam-directory} on a directory such as
23379 @file{~/Mail/mail/misc} (this usually corresponds the the group
23380 @samp{nnml:mail.misc}).
23382 When you are using @acronym{IMAP}, you won't have the mails available
23383 locally, so that will not work. One solution is to use the Gnus Agent
23384 to cache the articles. Then you can use directories such as
23385 @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for
23386 @code{spam-stat-process-spam-directory}. @xref{Agent as Cache}.
23389 This variable holds the hash-table with all the statistics---the
23390 dictionary we have been talking about. For every word in either
23391 collection, this hash-table stores a vector describing how often the
23392 word appeared in spam and often it appeared in non-spam mails.
23395 If you want to regenerate the statistics from scratch, you need to
23396 reset the dictionary.
23398 @defun spam-stat-reset
23399 Reset the @code{spam-stat} hash-table, deleting all the statistics.
23402 When you are done, you must save the dictionary. The dictionary may
23403 be rather large. If you will not update the dictionary incrementally
23404 (instead, you will recreate it once a month, for example), then you
23405 can reduce the size of the dictionary by deleting all words that did
23406 not appear often enough or that do not clearly belong to only spam or
23407 only non-spam mails.
23409 @defun spam-stat-reduce-size
23410 Reduce the size of the dictionary. Use this only if you do not want
23411 to update the dictionary incrementally.
23414 @defun spam-stat-save
23415 Save the dictionary.
23418 @defvar spam-stat-file
23419 The filename used to store the dictionary. This defaults to
23420 @file{~/.spam-stat.el}.
23423 @node Splitting mail using spam-stat
23424 @subsubsection Splitting mail using spam-stat
23426 In order to use @code{spam-stat} to split your mail, you need to add the
23427 following to your @file{~/.gnus.el} file:
23430 (require 'spam-stat)
23434 This will load the necessary Gnus code, and the dictionary you
23437 Next, you need to adapt your fancy splitting rules: You need to
23438 determine how to use @code{spam-stat}. The following examples are for
23439 the nnml back end. Using the nnimap back end works just as well. Just
23440 use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}.
23442 In the simplest case, you only have two groups, @samp{mail.misc} and
23443 @samp{mail.spam}. The following expression says that mail is either
23444 spam or it should go into @samp{mail.misc}. If it is spam, then
23445 @code{spam-stat-split-fancy} will return @samp{mail.spam}.
23448 (setq nnmail-split-fancy
23449 `(| (: spam-stat-split-fancy)
23453 @defvar spam-stat-split-fancy-spam-group
23454 The group to use for spam. Default is @samp{mail.spam}.
23457 If you also filter mail with specific subjects into other groups, use
23458 the following expression. Only mails not matching the regular
23459 expression are considered potential spam.
23462 (setq nnmail-split-fancy
23463 `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
23464 (: spam-stat-split-fancy)
23468 If you want to filter for spam first, then you must be careful when
23469 creating the dictionary. Note that @code{spam-stat-split-fancy} must
23470 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
23471 non-spam, therefore both should be in your collection of non-spam
23472 mails, when creating the dictionary!
23475 (setq nnmail-split-fancy
23476 `(| (: spam-stat-split-fancy)
23477 ("Subject" "\\bspam-stat\\b" "mail.emacs")
23481 You can combine this with traditional filtering. Here, we move all
23482 HTML-only mails into the @samp{mail.spam.filtered} group. Note that since
23483 @code{spam-stat-split-fancy} will never see them, the mails in
23484 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
23485 nor in your collection of non-spam mails, when creating the
23489 (setq nnmail-split-fancy
23490 `(| ("Content-Type" "text/html" "mail.spam.filtered")
23491 (: spam-stat-split-fancy)
23492 ("Subject" "\\bspam-stat\\b" "mail.emacs")
23497 @node Low-level interface to the spam-stat dictionary
23498 @subsubsection Low-level interface to the spam-stat dictionary
23500 The main interface to using @code{spam-stat}, are the following functions:
23502 @defun spam-stat-buffer-is-spam
23503 Called in a buffer, that buffer is considered to be a new spam mail.
23504 Use this for new mail that has not been processed before.
23507 @defun spam-stat-buffer-is-no-spam
23508 Called in a buffer, that buffer is considered to be a new non-spam
23509 mail. Use this for new mail that has not been processed before.
23512 @defun spam-stat-buffer-change-to-spam
23513 Called in a buffer, that buffer is no longer considered to be normal
23514 mail but spam. Use this to change the status of a mail that has
23515 already been processed as non-spam.
23518 @defun spam-stat-buffer-change-to-non-spam
23519 Called in a buffer, that buffer is no longer considered to be spam but
23520 normal mail. Use this to change the status of a mail that has already
23521 been processed as spam.
23524 @defun spam-stat-save
23525 Save the hash table to the file. The filename used is stored in the
23526 variable @code{spam-stat-file}.
23529 @defun spam-stat-load
23530 Load the hash table from a file. The filename used is stored in the
23531 variable @code{spam-stat-file}.
23534 @defun spam-stat-score-word
23535 Return the spam score for a word.
23538 @defun spam-stat-score-buffer
23539 Return the spam score for a buffer.
23542 @defun spam-stat-split-fancy
23543 Use this function for fancy mail splitting. Add the rule @samp{(:
23544 spam-stat-split-fancy)} to @code{nnmail-split-fancy}
23547 Make sure you load the dictionary before using it. This requires the
23548 following in your @file{~/.gnus.el} file:
23551 (require 'spam-stat)
23555 Typical test will involve calls to the following functions:
23558 Reset: (setq spam-stat (make-hash-table :test 'equal))
23559 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
23560 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
23561 Save table: (spam-stat-save)
23562 File size: (nth 7 (file-attributes spam-stat-file))
23563 Number of words: (hash-table-count spam-stat)
23564 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
23565 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
23566 Reduce table size: (spam-stat-reduce-size)
23567 Save table: (spam-stat-save)
23568 File size: (nth 7 (file-attributes spam-stat-file))
23569 Number of words: (hash-table-count spam-stat)
23570 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
23571 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
23574 Here is how you would create your dictionary:
23577 Reset: (setq spam-stat (make-hash-table :test 'equal))
23578 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
23579 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
23580 Repeat for any other non-spam group you need...
23581 Reduce table size: (spam-stat-reduce-size)
23582 Save table: (spam-stat-save)
23585 @node Various Various
23586 @section Various Various
23592 @item gnus-home-directory
23593 @vindex gnus-home-directory
23594 All Gnus file and directory variables will be initialized from this
23595 variable, which defaults to @file{~/}.
23597 @item gnus-directory
23598 @vindex gnus-directory
23599 Most Gnus storage file and directory variables will be initialized from
23600 this variable, which defaults to the @env{SAVEDIR} environment
23601 variable, or @file{~/News/} if that variable isn't set.
23603 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
23604 This means that other directory variables that are initialized from this
23605 variable won't be set properly if you set this variable in
23606 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
23608 @item gnus-default-directory
23609 @vindex gnus-default-directory
23610 Not related to the above variable at all---this variable says what the
23611 default directory of all Gnus buffers should be. If you issue commands
23612 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
23613 default directory. If this variable is @code{nil} (which is the
23614 default), the default directory will be the default directory of the
23615 buffer you were in when you started Gnus.
23618 @vindex gnus-verbose
23619 This variable is an integer between zero and ten. The higher the value,
23620 the more messages will be displayed. If this variable is zero, Gnus
23621 will never flash any messages, if it is seven (which is the default),
23622 most important messages will be shown, and if it is ten, Gnus won't ever
23623 shut up, but will flash so many messages it will make your head swim.
23625 @item gnus-verbose-backends
23626 @vindex gnus-verbose-backends
23627 This variable works the same way as @code{gnus-verbose}, but it applies
23628 to the Gnus back ends instead of Gnus proper.
23630 @item nnheader-max-head-length
23631 @vindex nnheader-max-head-length
23632 When the back ends read straight heads of articles, they all try to read
23633 as little as possible. This variable (default 4096) specifies
23634 the absolute max length the back ends will try to read before giving up
23635 on finding a separator line between the head and the body. If this
23636 variable is @code{nil}, there is no upper read bound. If it is
23637 @code{t}, the back ends won't try to read the articles piece by piece,
23638 but read the entire articles. This makes sense with some versions of
23639 @code{ange-ftp} or @code{efs}.
23641 @item nnheader-head-chop-length
23642 @vindex nnheader-head-chop-length
23643 This variable (default 2048) says how big a piece of each article to
23644 read when doing the operation described above.
23646 @item nnheader-file-name-translation-alist
23647 @vindex nnheader-file-name-translation-alist
23649 @cindex invalid characters in file names
23650 @cindex characters in file names
23651 This is an alist that says how to translate characters in file names.
23652 For instance, if @samp{:} is invalid as a file character in file names
23653 on your system (you OS/2 user you), you could say something like:
23657 (setq nnheader-file-name-translation-alist
23662 In fact, this is the default value for this variable on OS/2 and MS
23663 Windows (phooey) systems.
23665 @item gnus-hidden-properties
23666 @vindex gnus-hidden-properties
23667 This is a list of properties to use to hide ``invisible'' text. It is
23668 @code{(invisible t intangible t)} by default on most systems, which
23669 makes invisible text invisible and intangible.
23671 @item gnus-parse-headers-hook
23672 @vindex gnus-parse-headers-hook
23673 A hook called before parsing headers. It can be used, for instance, to
23674 gather statistics on the headers fetched, or perhaps you'd like to prune
23675 some headers. I don't see why you'd want that, though.
23677 @item gnus-shell-command-separator
23678 @vindex gnus-shell-command-separator
23679 String used to separate two shell commands. The default is @samp{;}.
23681 @item gnus-invalid-group-regexp
23682 @vindex gnus-invalid-group-regexp
23684 Regexp to match ``invalid'' group names when querying user for a group
23685 name. The default value catches some @strong{really} invalid group
23686 names who could possibly mess up Gnus internally (like allowing
23687 @samp{:} in a group name, which is normally used to delimit method and
23690 @acronym{IMAP} users might want to allow @samp{/} in group names though.
23698 Well, that's the manual---you can get on with your life now. Keep in
23699 touch. Say hello to your cats from me.
23701 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
23703 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
23709 Not because of victories @*
23712 but for the common sunshine,@*
23714 the largess of the spring.
23718 but for the day's work done@*
23719 as well as I was able;@*
23720 not for a seat upon the dais@*
23721 but at the common table.@*
23726 @chapter Appendices
23729 * XEmacs:: Requirements for installing under XEmacs.
23730 * History:: How Gnus got where it is today.
23731 * On Writing Manuals:: Why this is not a beginner's guide.
23732 * Terminology:: We use really difficult, like, words here.
23733 * Customization:: Tailoring Gnus to your needs.
23734 * Troubleshooting:: What you might try if things do not work.
23735 * Gnus Reference Guide:: Rilly, rilly technical stuff.
23736 * Emacs for Heathens:: A short introduction to Emacsian terms.
23737 * Frequently Asked Questions:: The Gnus FAQ
23744 @cindex installing under XEmacs
23746 XEmacs is distributed as a collection of packages. You should install
23747 whatever packages the Gnus XEmacs package requires. The current
23748 requirements are @samp{gnus}, @samp{w3}, @samp{mh-e},
23749 @samp{mailcrypt}, @samp{rmail}, @samp{eterm}, @samp{mail-lib},
23750 @samp{xemacs-base}, @samp{sh-script} and @samp{fsf-compat}. The
23751 @samp{misc-games} package is required for Morse decoding.
23758 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
23759 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
23761 If you want to investigate the person responsible for this outrage,
23762 you can point your (feh!) web browser to
23763 @uref{http://quimby.gnus.org/}. This is also the primary
23764 distribution point for the new and spiffy versions of Gnus, and is
23765 known as The Site That Destroys Newsrcs And Drives People Mad.
23767 During the first extended alpha period of development, the new Gnus was
23768 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
23769 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
23770 (Besides, the ``Gnus'' in this abbreviation should probably be
23771 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
23772 appropriate name, don't you think?)
23774 In any case, after spending all that energy on coming up with a new and
23775 spunky name, we decided that the name was @emph{too} spunky, so we
23776 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
23777 ``@sc{gnus}''. New vs. old.
23780 * Gnus Versions:: What Gnus versions have been released.
23781 * Other Gnus Versions:: Other Gnus versions that also have been released.
23782 * Why?:: What's the point of Gnus?
23783 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
23784 * Conformity:: Gnus tries to conform to all standards.
23785 * Emacsen:: Gnus can be run on a few modern Emacsen.
23786 * Gnus Development:: How Gnus is developed.
23787 * Contributors:: Oodles of people.
23788 * New Features:: Pointers to some of the new stuff in Gnus.
23792 @node Gnus Versions
23793 @subsection Gnus Versions
23795 @cindex September Gnus
23797 @cindex Quassia Gnus
23798 @cindex Pterodactyl Gnus
23801 @cindex Gnus versions
23803 The first ``proper'' release of Gnus 5 was done in November 1995 when it
23804 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
23805 plus 15 Gnus 5.0 releases).
23807 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
23808 releases)) was released under the name ``Gnus 5.2'' (40 releases).
23810 On July 28th 1996 work on Red Gnus was begun, and it was released on
23811 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
23813 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
23814 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
23816 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
23817 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
23820 On the 26th of October 2000, Oort Gnus was begun.
23822 If you happen upon a version of Gnus that has a prefixed name --
23823 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
23824 ``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic. Don't let it know
23825 that you're frightened. Back away. Slowly. Whatever you do, don't
23826 run. Walk away, calmly, until you're out of its reach. Find a proper
23827 released version of Gnus and snuggle up to that instead.
23830 @node Other Gnus Versions
23831 @subsection Other Gnus Versions
23834 In addition to the versions of Gnus which have had their releases
23835 coordinated by Lars, one major development has been Semi-gnus from
23836 Japan. It's based on a library called @acronym{SEMI}, which provides
23837 @acronym{MIME} capabilities.
23839 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
23840 Collectively, they are called ``Semi-gnus'', and different strains are
23841 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
23842 @acronym{MIME} and multilingualization things, especially important for
23849 What's the point of Gnus?
23851 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
23852 newsreader, that lets you do anything you can think of. That was my
23853 original motivation, but while working on Gnus, it has become clear to
23854 me that this generation of newsreaders really belong in the stone age.
23855 Newsreaders haven't developed much since the infancy of the net. If the
23856 volume continues to rise with the current rate of increase, all current
23857 newsreaders will be pretty much useless. How do you deal with
23858 newsgroups that have thousands of new articles each day? How do you
23859 keep track of millions of people who post?
23861 Gnus offers no real solutions to these questions, but I would very much
23862 like to see Gnus being used as a testing ground for new methods of
23863 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
23864 to separate the newsreader from the back ends, Gnus now offers a simple
23865 interface for anybody who wants to write new back ends for fetching mail
23866 and news from different sources. I have added hooks for customizations
23867 everywhere I could imagine it being useful. By doing so, I'm inviting
23868 every one of you to explore and invent.
23870 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
23871 @kbd{C-u 100 M-x all-hail-xemacs}.
23874 @node Compatibility
23875 @subsection Compatibility
23877 @cindex compatibility
23878 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
23879 bindings have been kept. More key bindings have been added, of course,
23880 but only in one or two obscure cases have old bindings been changed.
23885 @center In a cloud bones of steel.
23889 All commands have kept their names. Some internal functions have changed
23892 The @code{gnus-uu} package has changed drastically. @xref{Decoding
23895 One major compatibility question is the presence of several summary
23896 buffers. All variables relevant while reading a group are
23897 buffer-local to the summary buffer they belong in. Although many
23898 important variables have their values copied into their global
23899 counterparts whenever a command is executed in the summary buffer, this
23900 change might lead to incorrect values being used unless you are careful.
23902 All code that relies on knowledge of @sc{gnus} internals will probably
23903 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
23904 changing it in any way, as a matter of fact) is strictly verboten. Gnus
23905 maintains a hash table that points to the entries in this alist (which
23906 speeds up many functions), and changing the alist directly will lead to
23910 @cindex highlighting
23911 Old hilit19 code does not work at all. In fact, you should probably
23912 remove all hilit code from all Gnus hooks
23913 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
23914 Gnus provides various integrated functions for highlighting. These are
23915 faster and more accurate. To make life easier for everybody, Gnus will
23916 by default remove all hilit calls from all hilit hooks. Uncleanliness!
23919 Packages like @code{expire-kill} will no longer work. As a matter of
23920 fact, you should probably remove all old @sc{gnus} packages (and other
23921 code) when you start using Gnus. More likely than not, Gnus already
23922 does what you have written code to make @sc{gnus} do. (Snicker.)
23924 Even though old methods of doing things are still supported, only the
23925 new methods are documented in this manual. If you detect a new method of
23926 doing something while reading this manual, that does not mean you have
23927 to stop doing it the old way.
23929 Gnus understands all @sc{gnus} startup files.
23931 @kindex M-x gnus-bug
23933 @cindex reporting bugs
23935 Overall, a casual user who hasn't written much code that depends on
23936 @sc{gnus} internals should suffer no problems. If problems occur,
23937 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
23939 @vindex gnus-bug-create-help-buffer
23940 If you are in the habit of sending bug reports @emph{very} often, you
23941 may find the helpful help buffer annoying after a while. If so, set
23942 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
23947 @subsection Conformity
23949 No rebels without a clue here, ma'am. We conform to all standards known
23950 to (wo)man. Except for those standards and/or conventions we disagree
23958 There are no known breaches of this standard.
23962 There are no known breaches of this standard, either.
23964 @item Son-of-RFC 1036
23965 @cindex Son-of-RFC 1036
23966 We do have some breaches to this one.
23972 These are considered to be ``vanity headers'', while I consider them
23973 to be consumer information. After seeing so many badly formatted
23974 articles coming from @code{tin} and @code{Netscape} I know not to use
23975 either of those for posting articles. I would not have known that if
23976 it wasn't for the @code{X-Newsreader} header.
23981 USEFOR is an IETF working group writing a successor to RFC 1036, based
23982 on Son-of-RFC 1036. They have produced a number of drafts proposing
23983 various changes to the format of news articles. The Gnus towers will
23984 look into implementing the changes when the draft is accepted as an RFC.
23986 @item MIME - RFC 2045-2049 etc
23987 @cindex @acronym{MIME}
23988 All the various @acronym{MIME} RFCs are supported.
23990 @item Disposition Notifications - RFC 2298
23991 Message Mode is able to request notifications from the receiver.
23993 @item PGP - RFC 1991 and RFC 2440
23996 RFC 1991 is the original @acronym{PGP} message specification,
23997 published as an informational RFC. RFC 2440 was the follow-up, now
23998 called Open PGP, and put on the Standards Track. Both document a
23999 non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both
24000 encoding (signing and encryption) and decoding (verification and
24003 @item PGP/MIME - RFC 2015/3156
24004 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
24005 1991) describes the @acronym{MIME}-wrapping around the RF 1991/2440 format.
24006 Gnus supports both encoding and decoding.
24008 @item S/MIME - RFC 2633
24009 RFC 2633 describes the @acronym{S/MIME} format.
24011 @item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
24012 RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060
24013 (@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5
24014 authentication for @acronym{IMAP}. RFC 2086 describes access control
24015 lists (ACLs) for @acronym{IMAP}. RFC 2359 describes a @acronym{IMAP}
24016 protocol enhancement. RFC 2595 describes the proper @acronym{TLS}
24017 integration (STARTTLS) with @acronym{IMAP}. RFC 1731 describes the
24018 GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}.
24022 If you ever notice Gnus acting non-compliant with regards to the texts
24023 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
24028 @subsection Emacsen
24034 Gnus should work on:
24042 XEmacs 21.1.1 and up.
24046 This Gnus version will absolutely not work on any Emacsen older than
24047 that. Not reliably, at least. Older versions of Gnus may work on older
24048 Emacs versions. However, T-gnus does support ``Mule 2.3 based on Emacs
24049 19.34'' and possibly the versions of XEmacs prior to 21.1.1, e.g. 20.4.
24050 See the file ``README'' in the T-gnus distribution for more details.
24052 There are some vague differences between Gnus on the various
24053 platforms---XEmacs features more graphics (a logo and a toolbar)---but
24054 other than that, things should look pretty much the same under all
24058 @node Gnus Development
24059 @subsection Gnus Development
24061 Gnus is developed in a two-phased cycle. The first phase involves much
24062 discussion on the @samp{ding@@gnus.org} mailing list, where people
24063 propose changes and new features, post patches and new back ends. This
24064 phase is called the @dfn{alpha} phase, since the Gnusae released in this
24065 phase are @dfn{alpha releases}, or (perhaps more commonly in other
24066 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
24067 unstable and should not be used by casual users. Gnus alpha releases
24068 have names like ``Red Gnus'' and ``Quassia Gnus''.
24070 After futzing around for 50-100 alpha releases, Gnus is declared
24071 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
24072 and is called things like ``Gnus 5.6.32'' instead. Normal people are
24073 supposed to be able to use these, and these are mostly discussed on the
24074 @samp{gnu.emacs.gnus} newsgroup.
24077 @vindex mail-source-delete-incoming
24078 Some variable defaults differ between alpha Gnusae and released Gnusae.
24079 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
24080 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
24081 lossage of mail if an alpha release hiccups while handling the mail.
24083 The division of discussion between the ding mailing list and the Gnus
24084 newsgroup is not purely based on publicity concerns. It's true that
24085 having people write about the horrible things that an alpha Gnus release
24086 can do (sometimes) in a public forum may scare people off, but more
24087 importantly, talking about new experimental features that have been
24088 introduced may confuse casual users. New features are frequently
24089 introduced, fiddled with, and judged to be found wanting, and then
24090 either discarded or totally rewritten. People reading the mailing list
24091 usually keep up with these rapid changes, while people on the newsgroup
24092 can't be assumed to do so.
24097 @subsection Contributors
24098 @cindex contributors
24100 The new Gnus version couldn't have been done without the help of all the
24101 people on the (ding) mailing list. Every day for over a year I have
24102 gotten billions of nice bug reports from them, filling me with joy,
24103 every single one of them. Smooches. The people on the list have been
24104 tried beyond endurance, what with my ``oh, that's a neat idea <type
24105 type>, yup, I'll release it right away <ship off> no wait, that doesn't
24106 work at all <type type>, yup, I'll ship that one off right away <ship
24107 off> no, wait, that absolutely does not work'' policy for releases.
24108 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
24109 ``worser''? ``much worser''? ``worsest''?)
24111 I would like to take this opportunity to thank the Academy for@dots{} oops,
24117 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
24120 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
24121 nnwarchive and many, many other things connected with @acronym{MIME} and
24122 other types of en/decoding, as well as general bug fixing, new
24123 functionality and stuff.
24126 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
24127 well as numerous other things).
24130 Luis Fernandes---design and graphics.
24133 Joe Reiss---creator of the smiley faces.
24136 Justin Sheehy---the @acronym{FAQ} maintainer.
24139 Erik Naggum---help, ideas, support, code and stuff.
24142 Wes Hardaker---@file{gnus-picon.el} and the manual section on
24143 @dfn{picons} (@pxref{Picons}).
24146 Kim-Minh Kaplan---further work on the picon code.
24149 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
24150 (@pxref{GroupLens}).
24153 Sudish Joseph---innumerable bug fixes.
24156 Ilja Weis---@file{gnus-topic.el}.
24159 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
24162 Vladimir Alexiev---the refcard and reference booklets.
24165 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
24166 distribution by Felix Lee and JWZ.
24169 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
24172 Peter Mutsaers---orphan article scoring code.
24175 Ken Raeburn---POP mail support.
24178 Hallvard B Furuseth---various bits and pieces, especially dealing with
24182 Brian Edmonds---@file{gnus-bbdb.el}.
24185 David Moore---rewrite of @file{nnvirtual.el} and many other things.
24188 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
24191 François Pinard---many, many interesting and thorough bug reports, as
24192 well as autoconf support.
24196 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
24197 Borges, and Jost Krieger proof-reading parts of the manual.
24199 The following people have contributed many patches and suggestions:
24214 Jason L. Tibbitts, III,
24216 Katsumi Yamaoka, @c Yamaoka
24220 Also thanks to the following for patches and stuff:
24230 Alexei V. Barantsev,
24245 Massimo Campostrini,
24250 Jae-you Chung, @c ?
24251 James H. Cloos, Jr.,
24255 Andrew J. Cosgriff,
24258 Geoffrey T. Dairiki,
24264 Michael Welsh Duggan,
24269 Enami Tsugutomo, @c Enami
24273 Nelson Jose dos Santos Ferreira,
24281 Arne Georg Gleditsch,
24283 Michelangelo Grigni,
24287 Kenichi Handa, @c Handa
24289 Yoshiki Hayashi, @c Hayashi
24291 Hisashige Kenji, @c Hisashige
24298 François Felix Ingrand,
24299 Tatsuya Ichikawa, @c Ichikawa
24300 Ishikawa Ichiro, @c Ishikawa
24302 Iwamuro Motonori, @c Iwamuro
24312 Peter Skov Knudsen,
24313 Shuhei Kobayashi, @c Kobayashi
24315 Koseki Yoshinori, @c Koseki
24316 Thor Kristoffersen,
24319 Seokchan Lee, @c Lee
24337 Morioka Tomohiko, @c Morioka
24338 Erik Toubro Nielsen,
24345 Masaharu Onishi, @c Onishi
24350 Jens-Ulrik Holger Petersen,
24354 John McClary Prevost,
24360 Lars Balker Rasmussen,
24365 Christian von Roques,
24368 Wolfgang Rupprecht,
24375 Philippe Schnoebelen,
24377 Randal L. Schwartz,
24391 Kiyokazu Suto, @c Suto
24396 Tozawa Akihiko, @c Tozawa
24416 For a full overview of what each person has done, the ChangeLogs
24417 included in the Gnus alpha distributions should give ample reading
24418 (550kB and counting).
24420 Apologies to everybody that I've forgotten, of which there are many, I'm
24423 Gee, that's quite a list of people. I guess that must mean that there
24424 actually are people who are using Gnus. Who'd'a thunk it!
24428 @subsection New Features
24429 @cindex new features
24432 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
24433 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
24434 * Red Gnus:: Third time best---Gnus 5.4/5.5.
24435 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
24436 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
24437 * Oort Gnus:: It's big. It's far out. Gnus 5.10.
24440 These lists are, of course, just @emph{short} overviews of the
24441 @emph{most} important new features. No, really. There are tons more.
24442 Yes, we have feeping creaturism in full effect.
24445 @subsubsection (ding) Gnus
24447 New features in Gnus 5.0/5.1:
24452 The look of all buffers can be changed by setting format-like variables
24453 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
24456 Local spool and several @acronym{NNTP} servers can be used at once
24457 (@pxref{Select Methods}).
24460 You can combine groups into virtual groups (@pxref{Virtual Groups}).
24463 You can read a number of different mail formats (@pxref{Getting Mail}).
24464 All the mail back ends implement a convenient mail expiry scheme
24465 (@pxref{Expiring Mail}).
24468 Gnus can use various strategies for gathering threads that have lost
24469 their roots (thereby gathering loose sub-threads into one thread) or it
24470 can go back and retrieve enough headers to build a complete thread
24471 (@pxref{Customizing Threading}).
24474 Killed groups can be displayed in the group buffer, and you can read
24475 them as well (@pxref{Listing Groups}).
24478 Gnus can do partial group updates---you do not have to retrieve the
24479 entire active file just to check for new articles in a few groups
24480 (@pxref{The Active File}).
24483 Gnus implements a sliding scale of subscribedness to groups
24484 (@pxref{Group Levels}).
24487 You can score articles according to any number of criteria
24488 (@pxref{Scoring}). You can even get Gnus to find out how to score
24489 articles for you (@pxref{Adaptive Scoring}).
24492 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
24493 manner, so it should be difficult to lose much data on what you have
24494 read if your machine should go down (@pxref{Auto Save}).
24497 Gnus now has its own startup file (@file{~/.gnus.el}) to avoid
24498 cluttering up the @file{.emacs} file.
24501 You can set the process mark on both groups and articles and perform
24502 operations on all the marked items (@pxref{Process/Prefix}).
24505 You can grep through a subset of groups and create a group from the
24506 results (@pxref{Kibozed Groups}).
24509 You can list subsets of groups according to, well, anything
24510 (@pxref{Listing Groups}).
24513 You can browse foreign servers and subscribe to groups from those
24514 servers (@pxref{Browse Foreign Server}).
24517 Gnus can fetch articles, asynchronously, on a second connection to the
24518 server (@pxref{Asynchronous Fetching}).
24521 You can cache articles locally (@pxref{Article Caching}).
24524 The uudecode functions have been expanded and generalized
24525 (@pxref{Decoding Articles}).
24528 You can still post uuencoded articles, which was a little-known feature
24529 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
24532 Fetching parents (and other articles) now actually works without
24533 glitches (@pxref{Finding the Parent}).
24536 Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}).
24539 Digests (and other files) can be used as the basis for groups
24540 (@pxref{Document Groups}).
24543 Articles can be highlighted and customized (@pxref{Customizing
24547 URLs and other external references can be buttonized (@pxref{Article
24551 You can do lots of strange stuff with the Gnus window & frame
24552 configuration (@pxref{Window Layout}).
24555 You can click on buttons instead of using the keyboard
24561 @node September Gnus
24562 @subsubsection September Gnus
24566 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
24570 New features in Gnus 5.2/5.3:
24575 A new message composition mode is used. All old customization variables
24576 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
24580 Gnus is now able to generate @dfn{sparse} threads---threads where
24581 missing articles are represented by empty nodes (@pxref{Customizing
24585 (setq gnus-build-sparse-threads 'some)
24589 Outgoing articles are stored on a special archive server
24590 (@pxref{Archived Messages}).
24593 Partial thread regeneration now happens when articles are
24597 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
24600 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
24603 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
24606 (setq gnus-use-trees t)
24610 An @code{nn}-like pick-and-read minor mode is available for the summary
24611 buffers (@pxref{Pick and Read}).
24614 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
24618 In binary groups you can use a special binary minor mode (@pxref{Binary
24622 Groups can be grouped in a folding topic hierarchy (@pxref{Group
24626 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
24630 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
24633 Groups can now have a score, and bubbling based on entry frequency
24634 is possible (@pxref{Group Score}).
24637 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
24641 Groups can be process-marked, and commands can be performed on
24642 groups of groups (@pxref{Marking Groups}).
24645 Caching is possible in virtual groups.
24648 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
24649 news batches, ClariNet briefs collections, and just about everything
24650 else (@pxref{Document Groups}).
24653 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets
24657 The Gnus cache is much faster.
24660 Groups can be sorted according to many criteria (@pxref{Sorting
24664 New group parameters have been introduced to set list-addresses and
24665 expiry times (@pxref{Group Parameters}).
24668 All formatting specs allow specifying faces to be used
24669 (@pxref{Formatting Fonts}).
24672 There are several more commands for setting/removing/acting on process
24673 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
24676 The summary buffer can be limited to show parts of the available
24677 articles based on a wide range of criteria. These commands have been
24678 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
24681 Articles can be made persistent with the @kbd{*} command
24682 (@pxref{Persistent Articles}).
24685 All functions for hiding article elements are now toggles.
24688 Article headers can be buttonized (@pxref{Article Washing}).
24691 All mail back ends support fetching articles by @code{Message-ID}.
24694 Duplicate mail can now be treated properly (@pxref{Duplicates}).
24697 All summary mode commands are available directly from the article
24698 buffer (@pxref{Article Keymap}).
24701 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
24705 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
24708 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
24713 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
24716 (setq gnus-use-nocem t)
24720 Groups can be made permanently visible (@pxref{Listing Groups}).
24723 (setq gnus-permanently-visible-groups "^nnml:")
24727 Many new hooks have been introduced to make customizing easier.
24730 Gnus respects the @code{Mail-Copies-To} header.
24733 Threads can be gathered by looking at the @code{References} header
24734 (@pxref{Customizing Threading}).
24737 (setq gnus-summary-thread-gathering-function
24738 'gnus-gather-threads-by-references)
24742 Read articles can be stored in a special backlog buffer to avoid
24743 refetching (@pxref{Article Backlog}).
24746 (setq gnus-keep-backlog 50)
24750 A clean copy of the current article is always stored in a separate
24751 buffer to allow easier treatment.
24754 Gnus can suggest where to save articles (@pxref{Saving Articles}).
24757 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
24761 (setq gnus-prompt-before-saving t)
24765 @code{gnus-uu} can view decoded files asynchronously while fetching
24766 articles (@pxref{Other Decode Variables}).
24769 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
24773 Filling in the article buffer now works properly on cited text
24774 (@pxref{Article Washing}).
24777 Hiding cited text adds buttons to toggle hiding, and how much
24778 cited text to hide is now customizable (@pxref{Article Hiding}).
24781 (setq gnus-cited-lines-visible 2)
24785 Boring headers can be hidden (@pxref{Article Hiding}).
24788 Default scoring values can now be set from the menu bar.
24791 Further syntax checking of outgoing articles have been added.
24797 @subsubsection Red Gnus
24799 New features in Gnus 5.4/5.5:
24803 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
24810 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
24813 Article prefetching functionality has been moved up into
24814 Gnus (@pxref{Asynchronous Fetching}).
24817 Scoring can now be performed with logical operators like @code{and},
24818 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
24822 Article washing status can be displayed in the
24823 article mode line (@pxref{Misc Article}).
24826 @file{gnus.el} has been split into many smaller files.
24829 Suppression of duplicate articles based on Message-ID can be done
24830 (@pxref{Duplicate Suppression}).
24833 (setq gnus-suppress-duplicates t)
24837 New variables for specifying what score and adapt files are to be
24838 considered home score and adapt files (@pxref{Home Score File}) have
24842 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
24843 Server Internals}).
24846 Groups can inherit group parameters from parent topics (@pxref{Topic
24850 Article editing has been revamped and is now actually usable.
24853 Signatures can be recognized in more intelligent fashions
24854 (@pxref{Article Signature}).
24857 Summary pick mode has been made to look more @code{nn}-like. Line
24858 numbers are displayed and the @kbd{.} command can be used to pick
24859 articles (@code{Pick and Read}).
24862 Commands for moving the @file{.newsrc.eld} from one server to
24863 another have been added (@pxref{Changing Servers}).
24866 There's a way now to specify that ``uninteresting'' fields be suppressed
24867 when generating lines in buffers (@pxref{Advanced Formatting}).
24870 Several commands in the group buffer can be undone with @kbd{C-M-_}
24874 Scoring can be done on words using the new score type @code{w}
24875 (@pxref{Score File Format}).
24878 Adaptive scoring can be done on a Subject word-by-word basis
24879 (@pxref{Adaptive Scoring}).
24882 (setq gnus-use-adaptive-scoring '(word))
24886 Scores can be decayed (@pxref{Score Decays}).
24889 (setq gnus-decay-scores t)
24893 Scoring can be performed using a regexp on the Date header. The Date is
24894 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
24897 A new command has been added to remove all data on articles from
24898 the native server (@pxref{Changing Servers}).
24901 A new command for reading collections of documents
24902 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
24903 (@pxref{Really Various Summary Commands}).
24906 Process mark sets can be pushed and popped (@pxref{Setting Process
24910 A new mail-to-news back end makes it possible to post even when the @acronym{NNTP}
24911 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
24914 A new back end for reading searches from Web search engines
24915 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
24916 (@pxref{Web Searches}).
24919 Groups inside topics can now be sorted using the standard sorting
24920 functions, and each topic can be sorted independently (@pxref{Topic
24924 Subsets of the groups can be sorted independently (@code{Sorting
24928 Cached articles can be pulled into the groups (@pxref{Summary Generation
24932 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
24937 Score files are now applied in a more reliable order (@pxref{Score
24941 Reports on where mail messages end up can be generated (@pxref{Splitting
24945 More hooks and functions have been added to remove junk from incoming
24946 mail before saving the mail (@pxref{Washing Mail}).
24949 Emphasized text can be properly fontisized:
24955 @subsubsection Quassia Gnus
24957 New features in Gnus 5.6:
24962 New functionality for using Gnus as an offline newsreader has been
24963 added. A plethora of new commands and modes have been added.
24964 @xref{Gnus Unplugged}, for the full story.
24967 The @code{nndraft} back end has returned, but works differently than
24968 before. All Message buffers are now also articles in the @code{nndraft}
24969 group, which is created automatically.
24972 @code{gnus-alter-header-function} can now be used to alter header
24976 @code{gnus-summary-goto-article} now accept Message-ID's.
24979 A new Message command for deleting text in the body of a message
24980 outside the region: @kbd{C-c C-v}.
24983 You can now post to component group in @code{nnvirtual} groups with
24987 @code{nntp-rlogin-program}---new variable to ease customization.
24990 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
24991 re-highlighting of the article buffer.
24994 New element in @code{gnus-boring-article-headers}---@code{long-to}.
24997 @kbd{M-i} symbolic prefix command. @xref{Symbolic Prefixes}, for
25001 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
25002 @kbd{a} to add the score rule to the @file{all.SCORE} file.
25005 @code{gnus-simplify-subject-functions} variable to allow greater
25006 control over simplification.
25009 @kbd{A T}---new command for fetching the current thread.
25012 @kbd{/ T}---new command for including the current thread in the
25016 @kbd{M-RET} is a new Message command for breaking cited text.
25019 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
25022 The @code{custom-face-lookup} function has been removed.
25023 If you used this function in your initialization files, you must
25024 rewrite them to use @code{face-spec-set} instead.
25027 Canceling now uses the current select method. Symbolic prefix
25028 @kbd{a} forces normal posting method.
25031 New command to translate M******** sm*rtq**t*s into proper
25035 For easier debugging of @code{nntp}, you can set
25036 @code{nntp-record-commands} to a non-@code{nil} value.
25039 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
25040 controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers.
25043 A command for editing group parameters from the summary buffer
25047 A history of where mails have been split is available.
25050 A new article date command has been added---@code{article-date-iso8601}.
25053 Subjects can be simplified when threading by setting
25054 @code{gnus-score-thread-simplify}.
25057 A new function for citing in Message has been
25058 added---@code{message-cite-original-without-signature}.
25061 @code{article-strip-all-blank-lines}---new article command.
25064 A new Message command to kill to the end of the article has
25068 A minimum adaptive score can be specified by using the
25069 @code{gnus-adaptive-word-minimum} variable.
25072 The ``lapsed date'' article header can be kept continually
25073 updated by the @code{gnus-start-date-timer} command.
25076 Web listserv archives can be read with the @code{nnlistserv} back end.
25079 Old dejanews archives can now be read by @code{nnweb}.
25083 @node Pterodactyl Gnus
25084 @subsubsection Pterodactyl Gnus
25086 New features in Gnus 5.8:
25091 The mail-fetching functions have changed. See the manual for the
25092 many details. In particular, all procmail fetching variables are gone.
25094 If you used procmail like in
25097 (setq nnmail-use-procmail t)
25098 (setq nnmail-spool-file 'procmail)
25099 (setq nnmail-procmail-directory "~/mail/incoming/")
25100 (setq nnmail-procmail-suffix "\\.in")
25103 this now has changed to
25107 '((directory :path "~/mail/incoming/"
25111 @xref{Mail Source Specifiers}.
25114 Gnus is now a @acronym{MIME}-capable reader. This affects many parts of
25115 Gnus, and adds a slew of new commands. See the manual for details.
25118 Gnus has also been multilingualized. This also affects too
25119 many parts of Gnus to summarize here, and adds many new variables.
25122 @code{gnus-auto-select-first} can now be a function to be
25123 called to position point.
25126 The user can now decide which extra headers should be included in
25127 summary buffers and @acronym{NOV} files.
25130 @code{gnus-article-display-hook} has been removed. Instead, a number
25131 of variables starting with @code{gnus-treat-} have been added.
25134 The Gnus posting styles have been redone again and now works in a
25135 subtly different manner.
25138 New web-based back ends have been added: @code{nnslashdot},
25139 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
25140 again, to keep up with ever-changing layouts.
25143 Gnus can now read @acronym{IMAP} mail via @code{nnimap}.
25148 @subsubsection Oort Gnus
25151 New features in Gnus 5.10:
25156 The revised Gnus @acronym{FAQ} is included in the manual,
25157 @xref{Frequently Asked Questions}.
25160 Upgrading from previous (stable) version if you have used Oort.
25162 If you have tried Oort (the unstable Gnus branch leading to this
25163 release) but went back to a stable version, be careful when upgrading to
25164 this version. In particular, you will probably want to remove all
25165 @file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are
25166 read from your @file{.newsrc.eld} instead of from the
25167 @file{.marks}/@file{.mrk} file where this release store flags. See a
25168 later entry for more information about marks. Note that downgrading
25169 isn't save in general.
25174 More buttons for URLs, mail addresses, Message-IDs, Info links, man
25175 pages and Emacs or Gnus related references. @xref{Article Buttons}. The
25176 variables @code{gnus-button-@var{*}-level} can be used to control the
25177 appearance of all article buttons. @xref{Article Button Levels}.
25182 @code{gnus-dired-minor-mode} installs key bindings in dired buffers to send
25183 a file as an attachment (@kbd{C-c C-a}), open a file using the appropriate
25184 mailcap entry (@kbd{C-c C-l}), and print a file using the mailcap entry
25185 (@kbd{C-c P}). It is enabled with
25187 (add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode)
25191 Gnus can display RSS newsfeeds as a newsgroup. @xref{RSS}.
25194 Single-part yenc encoded attachments can be decoded.
25199 The picons code has been reimplemented to work in GNU Emacs---some of
25200 the previous options have been removed or renamed.
25202 Picons are small ``personal icons'' representing users, domain and
25203 newsgroups, which can be displayed in the Article buffer.
25207 If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a
25208 boundary line is drawn at the end of the headers.
25211 Retrieval of charters and control messages
25213 There are new commands for fetching newsgroup charters (@kbd{H c}) and
25214 control messages (@kbd{H C}).
25219 You can delay the sending of a message with @kbd{C-c C-j} in the Message
25220 buffer. The messages are delivered at specified time. This is useful
25221 for sending yourself reminders. @xref{Delayed Articles}.
25224 If @code{auto-compression-mode} is enabled, attachments are automatically
25225 decompressed when activated.
25228 If the new option @code{nnml-use-compressed-files} is non-@code{nil},
25229 the nnml back end allows compressed message files.
25232 Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}.
25235 The Summary Buffer uses an arrow in the fringe to indicate the current
25236 article. Use @code{(setq gnus-summary-display-arrow nil)} to disable it.
25239 Warn about email replies to news
25241 Do you often find yourself replying to news by email by mistake? Then
25242 the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for
25246 If the new option @code{gnus-summary-display-while-building} is
25247 non-@code{nil}, the summary buffer is shown and updated as it's being
25251 The new @code{recent} mark @samp{.} indicates newly arrived messages (as
25252 opposed to old but unread messages).
25255 The new option @code{gnus-gcc-mark-as-read} automatically marks
25256 Gcc articles as read.
25259 The nndoc back end now supports mailman digests and exim bounces.
25262 Gnus supports RFC 2369 mailing list headers, and adds a number of
25263 related commands in mailing list groups. @xref{Mailing List}.
25266 The Date header can be displayed in a format that can be read aloud
25267 in English. @xref{Article Date}.
25270 The envelope sender address can be customized when using Sendmail.
25271 @xref{Mail Variables, Mail Variables,, message, Message Manual}.
25274 diffs are automatically highlighted in groups matching
25275 @code{mm-uu-diff-groups-regexp}
25278 @acronym{TLS} wrapper shipped with Gnus
25280 @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and
25281 @acronym{NNTP} via @file{tls.el} and GNUTLS. The old
25282 @acronym{TLS}/@acronym{SSL} support via (external third party)
25283 @file{ssl.el} and OpenSSL still works.
25286 New @file{make.bat} for compiling and installing Gnus under MS Windows
25288 Use @file{make.bat} if you want to install Gnus under MS Windows, the
25289 first argument to the batch-program should be the directory where
25290 @file{xemacs.exe} respectively @file{emacs.exe} is located, iff you want
25291 to install Gnus after compiling it, give @file{make.bat} @code{/copy} as
25292 the second parameter.
25294 @file{make.bat} has been rewritten from scratch, it now features
25295 automatic recognition of XEmacs and GNU Emacs, generates
25296 @file{gnus-load.el}, checks if errors occur while compilation and
25297 generation of info files and reports them at the end of the build
25298 process. It now uses @code{makeinfo} if it is available and falls
25299 back to @file{infohack.el} otherwise. @file{make.bat} should now
25300 install all files which are necessary to run Gnus and be generally a
25301 complete replacement for the @code{configure; make; make install}
25302 cycle used under Unix systems.
25304 The new @file{make.bat} makes @file{make-x.bat} superfluous, so it has
25308 Support for non-@acronym{ASCII} domain names
25310 Message supports non-@acronym{ASCII} domain names in From:, To: and
25311 Cc: and will query you whether to perform encoding when you try to
25312 send a message. The variable @code{message-use-idna} controls this.
25313 Gnus will also decode non-@acronym{ASCII} domain names in From:, To:
25314 and Cc: when you view a message. The variable @code{gnus-use-idna}
25318 Better handling of Microsoft citation styles
25320 Gnus now tries to recognize the mangled header block that some Microsoft
25321 mailers use to indicate that the rest of the message is a citation, even
25322 though it is not quoted in any way. The variable
25323 @code{gnus-cite-unsightly-citation-regexp} matches the start of these
25327 @code{gnus-article-skip-boring}
25329 If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will
25330 not scroll down to show you a page that contains only boring text,
25331 which by default means cited text and signature. You can customize
25332 what is skippable using @code{gnus-article-boring-faces}.
25334 This feature is especially useful if you read many articles that
25335 consist of a little new content at the top with a long, untrimmed
25336 message cited below.
25339 The format spec @code{%C} for positioning point has changed to @code{%*}.
25342 The new variable @code{gnus-parameters} can be used to set group parameters.
25344 Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored
25345 the parameters in @file{~/.newsrc.eld}, but via this variable you can
25346 enjoy the powers of customize, and simplified backups since you set the
25347 variable in @file{~/.emacs} instead of @file{~/.newsrc.eld}. The
25348 variable maps regular expressions matching group names to group
25351 (setq gnus-parameters
25353 (gnus-show-threads nil)
25354 (gnus-use-scoring nil))
25355 ("^nnimap:\\(foo.bar\\)$"
25356 (to-group . "\\1"))))
25360 Smileys (@samp{:-)}, @samp{;-)} etc) are now iconized for Emacs too.
25362 Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.emacs} to
25366 Gnus no longer generate the Sender: header automatically.
25368 Earlier it was generated iff the user configurable email address was
25369 different from the Gnus guessed default user address. As the guessing
25370 algorithm is rarely correct these days, and (more controversially) the
25371 only use of the Sender: header was to check if you are entitled to
25372 cancel/supersede news (which is now solved by Cancel Locks instead,
25373 see another entry), generation of the header has been disabled by
25374 default. See the variables @code{message-required-headers},
25375 @code{message-required-news-headers}, and
25376 @code{message-required-mail-headers}.
25379 Features from third party @file{message-utils.el} added to @file{message.el}.
25381 Message now asks if you wish to remove @samp{(was: <old subject>)} from
25382 subject lines (see @code{message-subject-trailing-was-query}). @kbd{C-c
25383 M-m} and @kbd{C-c M-f} inserts markers indicating included text.
25384 @kbd{C-c C-f a} adds a X-No-Archive: header. @kbd{C-c C-f x} inserts
25385 appropriate headers and a note in the body for cross-postings and
25386 followups (see the variables @code{message-cross-post-@var{*}}).
25389 References and X-Draft-Headers are no longer generated when you start
25390 composing messages and @code{message-generate-headers-first} is
25394 Improved anti-spam features.
25396 Gnus is now able to take out spam from your mail and news streams
25397 using a wide variety of programs and filter rules. Among the supported
25398 methods are RBL blocklists, bogofilter and white/blacklists. Hooks
25399 for easy use of external packages such as SpamAssassin and Hashcash
25400 are also new. @xref{Thwarting Email Spam}.
25403 Easy inclusion of X-Faces headers.
25406 Face headers handling.
25409 In the summary buffer, the new command @kbd{/ N} inserts new messages
25410 and @kbd{/ o} inserts old messages.
25413 Gnus decodes morse encoded messages if you press @kbd{W m}.
25416 Unread count correct in nnimap groups.
25418 The estimated number of unread articles in the group buffer should now
25419 be correct for nnimap groups. This is achieved by calling
25420 @code{nnimap-fixup-unread-after-getting-new-news} from the
25421 @code{gnus-setup-news-hook} (called on startup) and
25422 @code{gnus-after-getting-new-news-hook}. (called after getting new
25423 mail). If you have modified those variables from the default, you may
25424 want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If
25425 you were happy with the estimate and want to save some (minimal) time
25426 when getting new mail, remove the function.
25429 Group Carbon Copy (GCC) quoting
25431 To support groups that contains SPC and other weird characters, groups
25432 are quoted before they are placed in the Gcc: header. This means
25433 variables such as @code{gnus-message-archive-group} should no longer
25434 contain quote characters to make groups containing SPC work. Also, if
25435 you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc
25436 into two groups) you must change it to return the list
25437 @code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted
25438 incorrectly. Note that returning the string @samp{nnml:foo, nnml:bar}
25439 was incorrect earlier, it just didn't generate any problems since it
25440 was inserted directly.
25443 @file{~/News/overview/} not used.
25445 As a result of the following change, the @file{~/News/overview/}
25446 directory is not used any more. You can safely delete the entire
25452 The Gnus Agent has seen a major updated and is now enabled by default,
25453 and all nntp and nnimap servers from @code{gnus-select-method} and
25454 @code{gnus-secondary-select-method} are agentized by default. Earlier
25455 only the server in @code{gnus-select-method} was agentized by the
25456 default, and the agent was disabled by default. When the agent is
25457 enabled, headers are now also retrieved from the Agent cache instead
25458 of the back ends when possible. Earlier this only happened in the
25459 unplugged state. You can enroll or remove servers with @kbd{J a} and
25460 @kbd{J r} in the server buffer. Gnus will not download articles into
25461 the Agent cache, unless you instruct it to do so, though, by using
25462 @kbd{J u} or @kbd{J s} from the Group buffer. You revert to the old
25463 behaviour of having the Agent disabled with @code{(setq gnus-agent
25464 nil)}. Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el}
25465 is not needed any more.
25468 @code{gnus-summary-line-format}
25470 The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%)
25471 %s\n}. Moreover @code{gnus-extra-headers},
25472 @code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses}
25473 changed their default so that the users name will be replaced by the
25474 recipient's name or the group name posting to for @acronym{NNTP}
25478 @file{deuglify.el} (@code{gnus-article-outlook-deuglify-article})
25480 A new file from Raymond Scholz @email{rscholz@@zonix.de} for deuglifying
25481 broken Outlook (Express) articles.
25484 @code{(require 'gnus-load)}
25486 If you use a stand-alone Gnus distribution, you'd better add
25487 @code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus
25488 lisp directory into load-path.
25490 File @file{gnus-load.el} contains autoload commands, functions and variables,
25491 some of which may not be included in distributions of Emacsen.
25494 @code{gnus-slave-unplugged}
25496 A new command which starts Gnus offline in slave mode.
25499 @code{message-insinuate-rmail}
25501 Adding @code{(message-insinuate-rmail)} and @code{(setq
25502 mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to
25503 compose, reply and forward messages in message-mode, where you can
25504 enjoy the power of @acronym{MML}.
25507 @code{message-minibuffer-local-map}
25509 The line below enables BBDB in resending a message:
25511 (define-key message-minibuffer-local-map [(tab)]
25512 'bbdb-complete-name)
25516 Externalizing and deleting of attachments.
25518 If @code{gnus-gcc-externalize-attachments} or
25519 @code{message-fcc-externalize-attachments} is non-@code{nil}, attach
25520 local files as external parts.
25522 The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o}
25523 on @acronym{MIME} buttons) saves a part and replaces the part with an
25524 external one. @code{gnus-mime-delete-part} (bound to @kbd{d} on
25525 @acronym{MIME} buttons) removes a part. It works only on back ends
25526 that support editing.
25529 @code{gnus-default-charset}
25531 The default value is determined from the
25532 @code{current-language-environment} variable, instead of
25533 @code{iso-8859-1}. Also the @samp{.*} item in
25534 @code{gnus-group-charset-alist} is removed.
25537 @code{gnus-posting-styles}
25539 Add a new format of match like
25541 ((header "to" "larsi.*org")
25542 (Organization "Somewhere, Inc."))
25544 The old format like the lines below is obsolete, but still accepted.
25546 (header "to" "larsi.*org"
25547 (Organization "Somewhere, Inc."))
25551 @code{message-ignored-news-headers} and @code{message-ignored-mail-headers}
25553 @samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been
25554 added into these two variables. If you customized those, perhaps you
25555 need add those two headers too.
25558 Gnus reads the @acronym{NOV} and articles in the Agent if plugged.
25560 If one reads an article while plugged, and the article already exists
25561 in the Agent, it won't get downloaded once more. @code{(setq
25562 gnus-agent-cache nil)} reverts to the old behavior.
25565 Gnus supports the ``format=flowed'' (RFC 2646) parameter. On
25566 composing messages, it is enabled by @code{use-hard-newlines}.
25567 Decoding format=flowed was present but not documented in earlier
25571 Gnus supports the generation of RFC 2298 Disposition Notification requests.
25573 This is invoked with the @kbd{C-c M-n} key binding from message mode.
25576 Gnus supports Maildir groups.
25578 Gnus includes a new back end @file{nnmaildir.el}. @xref{Maildir}.
25581 Printing capabilities are enhanced.
25583 Gnus supports Muttprint natively with @kbd{O P} from the Summary and
25584 Article buffers. Also, each individual @acronym{MIME} part can be
25585 printed using @kbd{p} on the @acronym{MIME} button.
25588 Message supports the Importance: (RFC 2156) header.
25590 In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through
25594 Gnus supports Cancel Locks in News.
25596 This means a header @samp{Cancel-Lock} is inserted in news posting. It is
25597 used to determine if you wrote an article or not (for canceling and
25598 superseding). Gnus generates a random password string the first time
25599 you post a message, and saves it in your @file{~/.emacs} using the Custom
25600 system. While the variable is called @code{canlock-password}, it is not
25601 security sensitive data. Publishing your canlock string on the web
25602 will not allow anyone to be able to anything she could not already do.
25603 The behaviour can be changed by customizing @code{message-insert-canlock}.
25606 Gnus supports server-side mail filtering using Sieve.
25608 Sieve rules can be added as Group Parameters for groups, and the
25609 complete Sieve script is generated using @kbd{D g} from the Group
25610 buffer, and then uploaded to the server using @kbd{C-c C-l} in the
25611 generated Sieve buffer. @xref{Sieve Commands}, and the new Sieve
25612 manual @ref{Top, , Top, sieve, Emacs Sieve}.
25615 Extended format specs.
25617 Format spec @samp{%&user-date;} is added into
25618 @code{gnus-summary-line-format-alist}. Also, user defined extended
25619 format specs are supported. The extended format specs look like
25620 @samp{%u&foo;}, which invokes function
25621 @code{gnus-user-format-function-@var{foo}}. Because @samp{&} is used as the
25622 escape character, old user defined format @samp{%u&} is no longer supported.
25625 @kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten.
25627 It was aliased to @kbd{Y c}
25628 (@code{gnus-summary-insert-cached-articles}). The new function filters
25629 out other articles.
25631 @item Some limiting commands accept a @kbd{C-u} prefix to negate the match.
25633 If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/
25634 s}, @kbd{/ a}, and @kbd{/ x}
25635 (@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the
25636 result will be to display all articles that do not match the expression.
25639 Group names are treated as UTF-8 by default.
25641 This is supposedly what USEFOR wanted to migrate to. See
25642 @code{gnus-group-name-charset-group-alist} and
25643 @code{gnus-group-name-charset-method-alist} for customization.
25646 The nnml and nnfolder back ends store marks for each groups.
25648 This makes it possible to take backup of nnml/nnfolder servers/groups
25649 separately of @file{~/.newsrc.eld}, while preserving marks. It also
25650 makes it possible to share articles and marks between users (without
25651 sharing the @file{~/.newsrc.eld} file) within e.g. a department. It
25652 works by storing the marks stored in @file{~/.newsrc.eld} in a per-group
25653 file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for
25654 nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to
25655 another machine, Gnus will automatically use the @file{.marks} or
25656 @file{.mrk} file instead of the information in @file{~/.newsrc.eld}.
25657 The new server variables @code{nnml-marks-is-evil} and
25658 @code{nnfolder-marks-is-evil} can be used to disable this feature.
25661 The menu bar item (in Group and Summary buffer) named ``Misc'' has
25662 been renamed to ``Gnus''.
25665 The menu bar item (in Message mode) named ``@acronym{MML}'' has been
25666 renamed to ``Attachments''. Note that this menu also contains security
25667 related stuff, like signing and encryption (@pxref{Security, Security,,
25668 message, Message Manual}).
25671 @code{gnus-group-charset-alist} and
25672 @code{gnus-group-ignored-charsets-alist}.
25674 The regexps in these variables are compared with full group names
25675 instead of real group names in 5.8. Users who customize these
25676 variables should change those regexps accordingly. For example:
25678 ("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr)
25682 Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC
25683 2015/3156) and @acronym{S/MIME} (RFC 2630-2633).
25685 It needs an external @acronym{S/MIME} and OpenPGP implementation, but no
25686 additional Lisp libraries. This add several menu items to the
25687 Attachments menu, and @kbd{C-c RET} key bindings, when composing
25688 messages. This also obsoletes @code{gnus-article-hide-pgp-hook}.
25691 Gnus inlines external parts (message/external).
25694 @acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c
25697 This change was made to avoid conflict with the standard binding of
25698 @code{back-to-indentation}, which is also useful in message mode.
25701 The default for @code{message-forward-show-mml} changed to symbol @code{best}.
25703 The behaviour for the @code{best} value is to show @acronym{MML} (i.e.,
25704 convert to @acronym{MIME}) when appropriate. @acronym{MML} will not be
25705 used when forwarding signed or encrypted messages, as the conversion
25706 invalidate the digital signature.
25713 @section The Manual
25717 This manual was generated from a TeXinfo file and then run through
25718 either @code{texi2dvi}
25720 or my own home-brewed TeXinfo to \LaTeX\ transformer,
25721 and then run through @code{latex} and @code{dvips}
25723 to get what you hold in your hands now.
25725 The following conventions have been used:
25730 This is a @samp{string}
25733 This is a @kbd{keystroke}
25736 This is a @file{file}
25739 This is a @code{symbol}
25743 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
25747 (setq flargnoze "yes")
25750 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
25753 (setq flumphel 'yes)
25756 @samp{yes} and @code{yes} are two @emph{very} different things---don't
25757 ever get them confused.
25761 Of course, everything in this manual is of vital interest, so you should
25762 read it all. Several times. However, if you feel like skimming the
25763 manual, look for that gnu head you should see in the margin over
25764 there---it means that what's being discussed is of more importance than
25765 the rest of the stuff. (On the other hand, if everything is infinitely
25766 important, how can anything be more important than that? Just one more
25767 of the mysteries of this world, I guess.)
25773 @node On Writing Manuals
25774 @section On Writing Manuals
25776 I guess most manuals are written after-the-fact; documenting a program
25777 that's already there. This is not how this manual is written. When
25778 implementing something, I write the manual entry for that something
25779 straight away. I then see that it's difficult to explain the
25780 functionality, so I write how it's supposed to be, and then I change the
25781 implementation. Writing the documentation and writing the code goes
25784 This, of course, means that this manual has no, or little, flow. It
25785 documents absolutely everything in Gnus, but often not where you're
25786 looking for it. It is a reference manual, and not a guide to how to get
25789 That would be a totally different book, that should be written using the
25790 reference manual as source material. It would look quite differently.
25795 @section Terminology
25797 @cindex terminology
25802 This is what you are supposed to use this thing for---reading news.
25803 News is generally fetched from a nearby @acronym{NNTP} server, and is
25804 generally publicly available to everybody. If you post news, the entire
25805 world is likely to read just what you have written, and they'll all
25806 snigger mischievously. Behind your back.
25810 Everything that's delivered to you personally is mail. Some news/mail
25811 readers (like Gnus) blur the distinction between mail and news, but
25812 there is a difference. Mail is private. News is public. Mailing is
25813 not posting, and replying is not following up.
25817 Send a mail to the person who has written what you are reading.
25821 Post an article to the current newsgroup responding to the article you
25826 Gnus considers mail and news to be mostly the same, really. The only
25827 difference is how to access the actual articles. News articles are
25828 commonly fetched via the protocol @acronym{NNTP}, whereas mail
25829 messages could be read from a file on the local disk. The internal
25830 architecture of Gnus thus comprises a ``front end'' and a number of
25831 ``back ends''. Internally, when you enter a group (by hitting
25832 @key{RET}, say), you thereby invoke a function in the front end in
25833 Gnus. The front end then ``talks'' to a back end and says things like
25834 ``Give me the list of articles in the foo group'' or ``Show me article
25837 So a back end mainly defines either a protocol (the @code{nntp} back
25838 end accesses news via @acronym{NNTP}, the @code{nnimap} back end
25839 accesses mail via @acronym{IMAP}) or a file format and directory
25840 layout (the @code{nnspool} back end accesses news via the common
25841 ``spool directory'' format, the @code{nnml} back end access mail via a
25842 file format and directory layout that's quite similar).
25844 Gnus does not handle the underlying media, so to speak---this is all
25845 done by the back ends. A back end is a collection of functions to
25846 access the articles.
25848 However, sometimes the term ``back end'' is also used where ``server''
25849 would have been more appropriate. And then there is the term ``select
25850 method'' which can mean either. The Gnus terminology can be quite
25855 Gnus will always use one method (and back end) as the @dfn{native}, or
25856 default, way of getting news.
25860 You can also have any number of foreign groups active at the same time.
25861 These are groups that use non-native non-secondary back ends for getting
25866 Secondary back ends are somewhere half-way between being native and being
25867 foreign, but they mostly act like they are native.
25871 A message that has been posted as news.
25874 @cindex mail message
25875 A message that has been mailed.
25879 A mail message or news article
25883 The top part of a message, where administrative information (etc.) is
25888 The rest of an article. Everything not in the head is in the
25893 A line from the head of an article.
25897 A collection of such lines, or a collection of heads. Or even a
25898 collection of @acronym{NOV} lines.
25900 @item @acronym{NOV}
25901 @cindex @acronym{NOV}
25902 When Gnus enters a group, it asks the back end for the headers of all
25903 unread articles in the group. Most servers support the News OverView
25904 format, which is more compact and much faster to read and parse than the
25905 normal @sc{head} format.
25909 Each group is subscribed at some @dfn{level} or other (1-9). The ones
25910 that have a lower level are ``more'' subscribed than the groups with a
25911 higher level. In fact, groups on levels 1-5 are considered
25912 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
25913 are @dfn{killed}. Commands for listing groups and scanning for new
25914 articles will all use the numeric prefix as @dfn{working level}.
25916 @item killed groups
25917 @cindex killed groups
25918 No information on killed groups is stored or updated, which makes killed
25919 groups much easier to handle than subscribed groups.
25921 @item zombie groups
25922 @cindex zombie groups
25923 Just like killed groups, only slightly less dead.
25926 @cindex active file
25927 The news server has to keep track of what articles it carries, and what
25928 groups exist. All this information in stored in the active file, which
25929 is rather large, as you might surmise.
25932 @cindex bogus groups
25933 A group that exists in the @file{.newsrc} file, but isn't known to the
25934 server (i.e., it isn't in the active file), is a @emph{bogus group}.
25935 This means that the group probably doesn't exist (any more).
25938 @cindex activating groups
25939 The act of asking the server for info on a group and computing the
25940 number of unread articles is called @dfn{activating the group}.
25941 Un-activated groups are listed with @samp{*} in the group buffer.
25945 A machine one can connect to and get news (or mail) from.
25947 @item select method
25948 @cindex select method
25949 A structure that specifies the back end, the server and the virtual
25952 @item virtual server
25953 @cindex virtual server
25954 A named select method. Since a select method defines all there is to
25955 know about connecting to a (physical) server, taking the thing as a
25956 whole is a virtual server.
25960 Taking a buffer and running it through a filter of some sort. The
25961 result will (more often than not) be cleaner and more pleasing than the
25964 @item ephemeral groups
25965 @cindex ephemeral groups
25966 @cindex temporary groups
25967 Most groups store data on what articles you have read. @dfn{Ephemeral}
25968 groups are groups that will have no data stored---when you exit the
25969 group, it'll disappear into the aether.
25972 @cindex solid groups
25973 This is the opposite of ephemeral groups. All groups listed in the
25974 group buffer are solid groups.
25976 @item sparse articles
25977 @cindex sparse articles
25978 These are article placeholders shown in the summary buffer when
25979 @code{gnus-build-sparse-threads} has been switched on.
25983 To put responses to articles directly after the articles they respond
25984 to---in a hierarchical fashion.
25988 @cindex thread root
25989 The first article in a thread is the root. It is the ancestor of all
25990 articles in the thread.
25994 An article that has responses.
25998 An article that responds to a different article---its parent.
26002 A collection of messages in one file. The most common digest format is
26003 specified by RFC 1153.
26006 @cindex splitting, terminolgy
26007 @cindex mail sorting
26008 @cindex mail filtering (splitting)
26009 The action of sorting your emails according to certain rules. Sometimes
26010 incorrectly called mail filtering.
26016 @node Customization
26017 @section Customization
26018 @cindex general customization
26020 All variables are properly documented elsewhere in this manual. This
26021 section is designed to give general pointers on how to customize Gnus
26022 for some quite common situations.
26025 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
26026 * Slow Terminal Connection:: You run a remote Emacs.
26027 * Little Disk Space:: You feel that having large setup files is icky.
26028 * Slow Machine:: You feel like buying a faster machine.
26032 @node Slow/Expensive Connection
26033 @subsection Slow/Expensive NNTP Connection
26035 If you run Emacs on a machine locally, and get your news from a machine
26036 over some very thin strings, you want to cut down on the amount of data
26037 Gnus has to get from the @acronym{NNTP} server.
26041 @item gnus-read-active-file
26042 Set this to @code{nil}, which will inhibit Gnus from requesting the
26043 entire active file from the server. This file is often v. large. You
26044 also have to set @code{gnus-check-new-newsgroups} and
26045 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
26046 doesn't suddenly decide to fetch the active file anyway.
26048 @item gnus-nov-is-evil
26049 This one has to be @code{nil}. If not, grabbing article headers from
26050 the @acronym{NNTP} server will not be very fast. Not all @acronym{NNTP} servers
26051 support @sc{xover}; Gnus will detect this by itself.
26055 @node Slow Terminal Connection
26056 @subsection Slow Terminal Connection
26058 Let's say you use your home computer for dialing up the system that runs
26059 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
26060 possible) the amount of data sent over the wires.
26064 @item gnus-auto-center-summary
26065 Set this to @code{nil} to inhibit Gnus from re-centering the summary
26066 buffer all the time. If it is @code{vertical}, do only vertical
26067 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
26068 horizontal and vertical recentering.
26070 @item gnus-visible-headers
26071 Cut down on the headers included in the articles to the
26072 minimum. You can, in fact, make do without them altogether---most of the
26073 useful data is in the summary buffer, anyway. Set this variable to
26074 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
26076 Set this hook to all the available hiding commands:
26078 (setq gnus-treat-hide-headers 'head
26079 gnus-treat-hide-signature t
26080 gnus-treat-hide-citation t)
26083 @item gnus-use-full-window
26084 By setting this to @code{nil}, you can make all the windows smaller.
26085 While this doesn't really cut down much generally, it means that you
26086 have to see smaller portions of articles before deciding that you didn't
26087 want to read them anyway.
26089 @item gnus-thread-hide-subtree
26090 If this is non-@code{nil}, all threads in the summary buffer will be
26094 @item gnus-updated-mode-lines
26095 If this is @code{nil}, Gnus will not put information in the buffer mode
26096 lines, which might save some time.
26100 @node Little Disk Space
26101 @subsection Little Disk Space
26104 The startup files can get rather large, so you may want to cut their
26105 sizes a bit if you are running out of space.
26109 @item gnus-save-newsrc-file
26110 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
26111 only save @file{.newsrc.eld}. This means that you will not be able to
26112 use any other newsreaders than Gnus. This variable is @code{t} by
26115 @item gnus-read-newsrc-file
26116 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
26117 only read @file{.newsrc.eld}. This means that you will not be able to
26118 use any other newsreaders than Gnus. This variable is @code{t} by
26121 @item gnus-save-killed-list
26122 If this is @code{nil}, Gnus will not save the list of dead groups. You
26123 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
26124 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
26125 variable to @code{nil}. This variable is @code{t} by default.
26131 @subsection Slow Machine
26132 @cindex slow machine
26134 If you have a slow machine, or are just really impatient, there are a
26135 few things you can do to make Gnus run faster.
26137 Set @code{gnus-check-new-newsgroups} and
26138 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
26140 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
26141 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
26142 summary buffer faster.
26146 @node Troubleshooting
26147 @section Troubleshooting
26148 @cindex troubleshooting
26150 Gnus works @emph{so} well straight out of the box---I can't imagine any
26158 Make sure your computer is switched on.
26161 Make sure that you really load the current Gnus version. If you have
26162 been running @sc{gnus}, you need to exit Emacs and start it up again before
26166 Try doing an @kbd{M-x gnus-version}. If you get something that looks
26167 like @samp{T-gnus 6.16.* (based on Gnus v5.10.*; for SEMI 1.1*, FLIM
26168 1.1*)} you have the right files loaded. Otherwise you have some old
26169 @file{.el} files lying around. Delete these.
26172 Read the help group (@kbd{G h} in the group buffer) for a
26173 @acronym{FAQ} and a how-to.
26176 @vindex max-lisp-eval-depth
26177 Gnus works on many recursive structures, and in some extreme (and very
26178 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
26179 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
26180 something like that.
26183 If all else fails, report the problem as a bug.
26186 @cindex reporting bugs
26188 @kindex M-x gnus-bug
26190 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
26191 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
26192 me the backtrace. I will fix bugs, but I can only fix them if you send
26193 me a precise description as to how to reproduce the bug.
26195 You really can never be too detailed in a bug report. Always use the
26196 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
26197 a 10Kb mail each time you use it, and even if you have sent me your
26198 environment 500 times before. I don't care. I want the full info each
26201 It is also important to remember that I have no memory whatsoever. If
26202 you send a bug report, and I send you a reply, and then you just send
26203 back ``No, it's not! Moron!'', I will have no idea what you are
26204 insulting me about. Always over-explain everything. It's much easier
26205 for all of us---if I don't have all the information I need, I will just
26206 mail you and ask for more info, and everything takes more time.
26208 If the problem you're seeing is very visual, and you can't quite explain
26209 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
26210 it somewhere it can be reached, and include the URL of the picture in
26214 If you would like to contribute a patch to fix bugs or make
26215 improvements, please produce the patch using @samp{diff -u}.
26218 If you want to debug your problem further before reporting, possibly
26219 in order to solve the problem yourself and send a patch, you can use
26220 edebug. Debugging Lisp code is documented in the Elisp manual
26221 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
26222 Lisp Reference Manual}). To get you started with edebug, consider if
26223 you discover some weird behaviour when pressing @kbd{c}, the first
26224 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
26225 the documentation buffer that leads you to the function definition,
26226 then press @kbd{M-x edebug-defun RET} with point inside that function,
26227 return to Gnus and press @kbd{c} to invoke the code. You will be
26228 placed in the lisp buffer and can single step using @kbd{SPC} and
26229 evaluate expressions using @kbd{M-:} or inspect variables using
26230 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
26231 @kbd{c} or @kbd{g}.
26236 Sometimes, a problem do not directly generate an elisp error but
26237 manifests itself by causing Gnus to be very slow. In these cases, you
26238 can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are
26239 slow, and then try to analyze the backtrace (repeating the procedure
26240 helps isolating the real problem areas).
26242 A fancier approach is to use the elisp profiler, ELP. The profiler is
26243 (or should be) fully documented elsewhere, but to get you started
26244 there are a few steps that need to be followed. First, instrument the
26245 part of Gnus you are interested in for profiling, e.g. @kbd{M-x
26246 elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package
26247 RET message}. Then perform the operation that is slow and press
26248 @kbd{M-x elp-results}. You will then see which operations that takes
26249 time, and can debug them further. If the entire operation takes much
26250 longer than the time spent in the slowest function in the profiler
26251 output, you probably profiled the wrong part of Gnus. To reset
26252 profiling statistics, use @kbd{M-x elp-reset-all}. @kbd{M-x
26253 elp-restore-all} is supposed to remove profiling, but given the
26254 complexities and dynamic code generation in Gnus, it might not always
26257 @cindex gnu.emacs.gnus
26258 @cindex ding mailing list
26259 If you just need help, you are better off asking on
26260 @samp{gnu.emacs.gnus}. I'm not very helpful. You can also ask on
26261 @email{ding@@gnus.org, the ding mailing list}. Write to
26262 @email{ding-request@@gnus.org} to subscribe.
26266 @node Gnus Reference Guide
26267 @section Gnus Reference Guide
26269 It is my hope that other people will figure out smart stuff that Gnus
26270 can do, and that other people will write those smart things as well. To
26271 facilitate that I thought it would be a good idea to describe the inner
26272 workings of Gnus. And some of the not-so-inner workings, while I'm at
26275 You can never expect the internals of a program not to change, but I
26276 will be defining (in some details) the interface between Gnus and its
26277 back ends (this is written in stone), the format of the score files
26278 (ditto), data structures (some are less likely to change than others)
26279 and general methods of operation.
26282 * Gnus Utility Functions:: Common functions and variable to use.
26283 * Back End Interface:: How Gnus communicates with the servers.
26284 * Score File Syntax:: A BNF definition of the score file standard.
26285 * Headers:: How Gnus stores headers internally.
26286 * Ranges:: A handy format for storing mucho numbers.
26287 * Group Info:: The group info format.
26288 * Extended Interactive:: Symbolic prefixes and stuff.
26289 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
26290 * Various File Formats:: Formats of files that Gnus use.
26294 @node Gnus Utility Functions
26295 @subsection Gnus Utility Functions
26296 @cindex Gnus utility functions
26297 @cindex utility functions
26299 @cindex internal variables
26301 When writing small functions to be run from hooks (and stuff), it's
26302 vital to have access to the Gnus internal functions and variables.
26303 Below is a list of the most common ones.
26307 @item gnus-newsgroup-name
26308 @vindex gnus-newsgroup-name
26309 This variable holds the name of the current newsgroup.
26311 @item gnus-find-method-for-group
26312 @findex gnus-find-method-for-group
26313 A function that returns the select method for @var{group}.
26315 @item gnus-group-real-name
26316 @findex gnus-group-real-name
26317 Takes a full (prefixed) Gnus group name, and returns the unprefixed
26320 @item gnus-group-prefixed-name
26321 @findex gnus-group-prefixed-name
26322 Takes an unprefixed group name and a select method, and returns the full
26323 (prefixed) Gnus group name.
26325 @item gnus-get-info
26326 @findex gnus-get-info
26327 Returns the group info list for @var{group}.
26329 @item gnus-group-unread
26330 @findex gnus-group-unread
26331 The number of unread articles in @var{group}, or @code{t} if that is
26335 @findex gnus-active
26336 The active entry for @var{group}.
26338 @item gnus-set-active
26339 @findex gnus-set-active
26340 Set the active entry for @var{group}.
26342 @item gnus-add-current-to-buffer-list
26343 @findex gnus-add-current-to-buffer-list
26344 Adds the current buffer to the list of buffers to be killed on Gnus
26347 @item gnus-continuum-version
26348 @findex gnus-continuum-version
26349 Takes a Gnus version string as a parameter and returns a floating point
26350 number. Earlier versions will always get a lower number than later
26353 @item gnus-group-read-only-p
26354 @findex gnus-group-read-only-p
26355 Says whether @var{group} is read-only or not.
26357 @item gnus-news-group-p
26358 @findex gnus-news-group-p
26359 Says whether @var{group} came from a news back end.
26361 @item gnus-ephemeral-group-p
26362 @findex gnus-ephemeral-group-p
26363 Says whether @var{group} is ephemeral or not.
26365 @item gnus-server-to-method
26366 @findex gnus-server-to-method
26367 Returns the select method corresponding to @var{server}.
26369 @item gnus-server-equal
26370 @findex gnus-server-equal
26371 Says whether two virtual servers are equal.
26373 @item gnus-group-native-p
26374 @findex gnus-group-native-p
26375 Says whether @var{group} is native or not.
26377 @item gnus-group-secondary-p
26378 @findex gnus-group-secondary-p
26379 Says whether @var{group} is secondary or not.
26381 @item gnus-group-foreign-p
26382 @findex gnus-group-foreign-p
26383 Says whether @var{group} is foreign or not.
26385 @item gnus-group-find-parameter
26386 @findex gnus-group-find-parameter
26387 Returns the parameter list of @var{group}. If given a second parameter,
26388 returns the value of that parameter for @var{group}.
26390 @item gnus-group-set-parameter
26391 @findex gnus-group-set-parameter
26392 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
26394 @item gnus-narrow-to-body
26395 @findex gnus-narrow-to-body
26396 Narrows the current buffer to the body of the article.
26398 @item gnus-check-backend-function
26399 @findex gnus-check-backend-function
26400 Takes two parameters, @var{function} and @var{group}. If the back end
26401 @var{group} comes from supports @var{function}, return non-@code{nil}.
26404 (gnus-check-backend-function "request-scan" "nnml:misc")
26408 @item gnus-read-method
26409 @findex gnus-read-method
26410 Prompts the user for a select method.
26415 @node Back End Interface
26416 @subsection Back End Interface
26418 Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual
26419 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
26420 server is a @dfn{back end} and some @dfn{back end variables}. As examples
26421 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
26422 examples of the latter we have @code{nntp-port-number} and
26423 @code{nnmbox-directory}.
26425 When Gnus asks for information from a back end---say @code{nntp}---on
26426 something, it will normally include a virtual server name in the
26427 function parameters. (If not, the back end should use the ``current''
26428 virtual server.) For instance, @code{nntp-request-list} takes a virtual
26429 server as its only (optional) parameter. If this virtual server hasn't
26430 been opened, the function should fail.
26432 Note that a virtual server name has no relation to some physical server
26433 name. Take this example:
26437 (nntp-address "ifi.uio.no")
26438 (nntp-port-number 4324))
26441 Here the virtual server name is @samp{odd-one} while the name of
26442 the physical server is @samp{ifi.uio.no}.
26444 The back ends should be able to switch between several virtual servers.
26445 The standard back ends implement this by keeping an alist of virtual
26446 server environments that they pull down/push up when needed.
26448 There are two groups of interface functions: @dfn{required functions},
26449 which must be present, and @dfn{optional functions}, which Gnus will
26450 always check for presence before attempting to call 'em.
26452 All these functions are expected to return data in the buffer
26453 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
26454 unfortunately named, but we'll have to live with it. When I talk about
26455 @dfn{resulting data}, I always refer to the data in that buffer. When I
26456 talk about @dfn{return value}, I talk about the function value returned by
26457 the function call. Functions that fail should return @code{nil} as the
26460 Some back ends could be said to be @dfn{server-forming} back ends, and
26461 some might be said not to be. The latter are back ends that generally
26462 only operate on one group at a time, and have no concept of ``server''
26463 ---they have a group, and they deliver info on that group and nothing
26466 Gnus identifies each message by way of group name and article number. A
26467 few remarks about these article numbers might be useful. First of all,
26468 the numbers are positive integers. Secondly, it is normally not
26469 possible for later articles to ``re-use'' older article numbers without
26470 confusing Gnus. That is, if a group has ever contained a message
26471 numbered 42, then no other message may get that number, or Gnus will get
26472 mightily confused.@footnote{See the function
26473 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
26474 Third, article numbers must be assigned in order of arrival in the
26475 group; this is not necessarily the same as the date of the message.
26477 The previous paragraph already mentions all the ``hard'' restrictions that
26478 article numbers must fulfill. But it seems that it might be useful to
26479 assign @emph{consecutive} article numbers, for Gnus gets quite confused
26480 if there are holes in the article numbering sequence. However, due to
26481 the ``no-reuse'' restriction, holes cannot be avoided altogether. It's
26482 also useful for the article numbers to start at 1 to avoid running out
26483 of numbers as long as possible.
26485 Note that by convention, back ends are named @code{nnsomething}, but
26486 Gnus also comes with some @code{nnnotbackends}, such as
26487 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
26489 In the examples and definitions I will refer to the imaginary back end
26492 @cindex @code{nnchoke}
26495 * Required Back End Functions:: Functions that must be implemented.
26496 * Optional Back End Functions:: Functions that need not be implemented.
26497 * Error Messaging:: How to get messages and report errors.
26498 * Writing New Back Ends:: Extending old back ends.
26499 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
26500 * Mail-like Back Ends:: Some tips on mail back ends.
26504 @node Required Back End Functions
26505 @subsubsection Required Back End Functions
26509 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
26511 @var{articles} is either a range of article numbers or a list of
26512 @code{Message-ID}s. Current back ends do not fully support either---only
26513 sequences (lists) of article numbers, and most back ends do not support
26514 retrieval of @code{Message-ID}s. But they should try for both.
26516 The result data should either be HEADs or @acronym{NOV} lines, and the result
26517 value should either be @code{headers} or @code{nov} to reflect this.
26518 This might later be expanded to @code{various}, which will be a mixture
26519 of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus.
26521 If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra
26522 headers'', in some meaning of the word. This is generally done by
26523 fetching (at most) @var{fetch-old} extra headers less than the smallest
26524 article number in @code{articles}, and filling the gaps as well. The
26525 presence of this parameter can be ignored if the back end finds it
26526 cumbersome to follow the request. If this is non-@code{nil} and not a
26527 number, do maximum fetches.
26529 Here's an example HEAD:
26532 221 1056 Article retrieved.
26533 Path: ifi.uio.no!sturles
26534 From: sturles@@ifi.uio.no (Sturle Sunde)
26535 Newsgroups: ifi.discussion
26536 Subject: Re: Something very droll
26537 Date: 27 Oct 1994 14:02:57 +0100
26538 Organization: Dept. of Informatics, University of Oslo, Norway
26540 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
26541 References: <38jdmq$4qu@@visbur.ifi.uio.no>
26542 NNTP-Posting-Host: holmenkollen.ifi.uio.no
26546 So a @code{headers} return value would imply that there's a number of
26547 these in the data buffer.
26549 Here's a BNF definition of such a buffer:
26553 head = error / valid-head
26554 error-message = [ "4" / "5" ] 2number " " <error message> eol
26555 valid-head = valid-message *header "." eol
26556 valid-message = "221 " <number> " Article retrieved." eol
26557 header = <text> eol
26561 (The version of BNF used here is the one used in RFC822.)
26563 If the return value is @code{nov}, the data buffer should contain
26564 @dfn{network overview database} lines. These are basically fields
26568 nov-buffer = *nov-line
26569 nov-line = field 7*8[ <TAB> field ] eol
26570 field = <text except TAB>
26573 For a closer look at what should be in those fields,
26577 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
26579 @var{server} is here the virtual server name. @var{definitions} is a
26580 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
26582 If the server can't be opened, no error should be signaled. The back end
26583 may then choose to refuse further attempts at connecting to this
26584 server. In fact, it should do so.
26586 If the server is opened already, this function should return a
26587 non-@code{nil} value. There should be no data returned.
26590 @item (nnchoke-close-server &optional SERVER)
26592 Close connection to @var{server} and free all resources connected
26593 to it. Return @code{nil} if the server couldn't be closed for some
26596 There should be no data returned.
26599 @item (nnchoke-request-close)
26601 Close connection to all servers and free all resources that the back end
26602 have reserved. All buffers that have been created by that back end
26603 should be killed. (Not the @code{nntp-server-buffer}, though.) This
26604 function is generally only called when Gnus is shutting down.
26606 There should be no data returned.
26609 @item (nnchoke-server-opened &optional SERVER)
26611 If @var{server} is the current virtual server, and the connection to the
26612 physical server is alive, then this function should return a
26613 non-@code{nil} value. This function should under no circumstances
26614 attempt to reconnect to a server we have lost connection to.
26616 There should be no data returned.
26619 @item (nnchoke-status-message &optional SERVER)
26621 This function should return the last error message from @var{server}.
26623 There should be no data returned.
26626 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
26628 The result data from this function should be the article specified by
26629 @var{article}. This might either be a @code{Message-ID} or a number.
26630 It is optional whether to implement retrieval by @code{Message-ID}, but
26631 it would be nice if that were possible.
26633 If @var{to-buffer} is non-@code{nil}, the result data should be returned
26634 in this buffer instead of the normal data buffer. This is to make it
26635 possible to avoid copying large amounts of data from one buffer to
26636 another, while Gnus mainly requests articles to be inserted directly
26637 into its article buffer.
26639 If it is at all possible, this function should return a cons cell where
26640 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
26641 the article number. This will enable Gnus to find out what the real
26642 group and article numbers are when fetching articles by
26643 @code{Message-ID}. If this isn't possible, @code{t} should be returned
26644 on successful article retrieval.
26647 @item (nnchoke-request-group GROUP &optional SERVER FAST)
26649 Get data on @var{group}. This function also has the side effect of
26650 making @var{group} the current group.
26652 If @var{fast}, don't bother to return useful data, just make @var{group}
26655 Here's an example of some result data and a definition of the same:
26658 211 56 1000 1059 ifi.discussion
26661 The first number is the status, which should be 211. Next is the
26662 total number of articles in the group, the lowest article number, the
26663 highest article number, and finally the group name. Note that the total
26664 number of articles may be less than one might think while just
26665 considering the highest and lowest article numbers, but some articles
26666 may have been canceled. Gnus just discards the total-number, so
26667 whether one should take the bother to generate it properly (if that is a
26668 problem) is left as an exercise to the reader. If the group contains no
26669 articles, the lowest article number should be reported as 1 and the
26673 group-status = [ error / info ] eol
26674 error = [ "4" / "5" ] 2<number> " " <Error message>
26675 info = "211 " 3* [ <number> " " ] <string>
26679 @item (nnchoke-close-group GROUP &optional SERVER)
26681 Close @var{group} and free any resources connected to it. This will be
26682 a no-op on most back ends.
26684 There should be no data returned.
26687 @item (nnchoke-request-list &optional SERVER)
26689 Return a list of all groups available on @var{server}. And that means
26692 Here's an example from a server that only carries two groups:
26695 ifi.test 0000002200 0000002000 y
26696 ifi.discussion 3324 3300 n
26699 On each line we have a group name, then the highest article number in
26700 that group, the lowest article number, and finally a flag. If the group
26701 contains no articles, the lowest article number should be reported as 1
26702 and the highest as 0.
26705 active-file = *active-line
26706 active-line = name " " <number> " " <number> " " flags eol
26708 flags = "n" / "y" / "m" / "x" / "j" / "=" name
26711 The flag says whether the group is read-only (@samp{n}), is moderated
26712 (@samp{m}), is dead (@samp{x}), is aliased to some other group
26713 (@samp{=other-group}) or none of the above (@samp{y}).
26716 @item (nnchoke-request-post &optional SERVER)
26718 This function should post the current buffer. It might return whether
26719 the posting was successful or not, but that's not required. If, for
26720 instance, the posting is done asynchronously, it has generally not been
26721 completed by the time this function concludes. In that case, this
26722 function should set up some kind of sentinel to beep the user loud and
26723 clear if the posting could not be completed.
26725 There should be no result data from this function.
26730 @node Optional Back End Functions
26731 @subsubsection Optional Back End Functions
26735 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
26737 @var{groups} is a list of groups, and this function should request data
26738 on all those groups. How it does it is of no concern to Gnus, but it
26739 should attempt to do this in a speedy fashion.
26741 The return value of this function can be either @code{active} or
26742 @code{group}, which says what the format of the result data is. The
26743 former is in the same format as the data from
26744 @code{nnchoke-request-list}, while the latter is a buffer full of lines
26745 in the same format as @code{nnchoke-request-group} gives.
26748 group-buffer = *active-line / *group-status
26752 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
26754 A Gnus group info (@pxref{Group Info}) is handed to the back end for
26755 alterations. This comes in handy if the back end really carries all
26756 the information (as is the case with virtual and imap groups). This
26757 function should destructively alter the info to suit its needs, and
26758 should return a non-@code{nil} value.
26760 There should be no result data from this function.
26763 @item (nnchoke-request-type GROUP &optional ARTICLE)
26765 When the user issues commands for ``sending news'' (@kbd{F} in the
26766 summary buffer, for instance), Gnus has to know whether the article the
26767 user is following up on is news or mail. This function should return
26768 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
26769 is mail and @code{unknown} if the type can't be decided. (The
26770 @var{article} parameter is necessary in @code{nnvirtual} groups which
26771 might very well combine mail groups and news groups.) Both @var{group}
26772 and @var{article} may be @code{nil}.
26774 There should be no result data from this function.
26777 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
26779 Set/remove/add marks on articles. Normally Gnus handles the article
26780 marks (such as read, ticked, expired etc) internally, and store them in
26781 @file{~/.newsrc.eld}. Some back ends (such as @acronym{IMAP}) however carry
26782 all information about the articles on the server, so Gnus need to
26783 propagate the mark information to the server.
26785 @var{action} is a list of mark setting requests, having this format:
26788 (RANGE ACTION MARK)
26791 @var{range} is a range of articles you wish to update marks on.
26792 @var{action} is @code{add} or @code{del}, used to add marks or remove
26793 marks (preserving all marks not mentioned). @var{mark} is a list of
26794 marks; where each mark is a symbol. Currently used marks are
26795 @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed},
26796 @code{dormant}, @code{save}, @code{download}, @code{unsend},
26797 @code{forward} and @code{recent}, but your back end should, if
26798 possible, not limit itself to these.
26800 Given contradictory actions, the last action in the list should be the
26801 effective one. That is, if your action contains a request to add the
26802 @code{tick} mark on article 1 and, later in the list, a request to
26803 remove the mark on the same article, the mark should in fact be removed.
26805 An example action list:
26808 (((5 12 30) 'del '(tick))
26809 ((10 . 90) 'add '(read expire))
26810 ((92 94) 'del '(read)))
26813 The function should return a range of articles it wasn't able to set the
26814 mark on (currently not used for anything).
26816 There should be no result data from this function.
26818 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
26820 If the user tries to set a mark that the back end doesn't like, this
26821 function may change the mark. Gnus will use whatever this function
26822 returns as the mark for @var{article} instead of the original
26823 @var{mark}. If the back end doesn't care, it must return the original
26824 @var{mark}, and not @code{nil} or any other type of garbage.
26826 The only use for this I can see is what @code{nnvirtual} does with
26827 it---if a component group is auto-expirable, marking an article as read
26828 in the virtual group should result in the article being marked as
26831 There should be no result data from this function.
26834 @item (nnchoke-request-scan &optional GROUP SERVER)
26836 This function may be called at any time (by Gnus or anything else) to
26837 request that the back end check for incoming articles, in one way or
26838 another. A mail back end will typically read the spool file or query
26839 the @acronym{POP} server when this function is invoked. The
26840 @var{group} doesn't have to be heeded---if the back end decides that
26841 it is too much work just scanning for a single group, it may do a
26842 total scan of all groups. It would be nice, however, to keep things
26843 local if that's practical.
26845 There should be no result data from this function.
26848 @item (nnchoke-request-group-description GROUP &optional SERVER)
26850 The result data from this function should be a description of
26854 description-line = name <TAB> description eol
26856 description = <text>
26859 @item (nnchoke-request-list-newsgroups &optional SERVER)
26861 The result data from this function should be the description of all
26862 groups available on the server.
26865 description-buffer = *description-line
26869 @item (nnchoke-request-newgroups DATE &optional SERVER)
26871 The result data from this function should be all groups that were
26872 created after @samp{date}, which is in normal human-readable date format
26873 (i.e., the date format used in mail and news headers, and returned by
26874 the function @code{message-make-date} by default). The data should be
26875 in the active buffer format.
26877 It is okay for this function to return ``too many'' groups; some back ends
26878 might find it cheaper to return the full list of groups, rather than
26879 just the new groups. But don't do this for back ends with many groups.
26880 Normally, if the user creates the groups herself, there won't be too
26881 many groups, so @code{nnml} and the like are probably safe. But for
26882 back ends like @code{nntp}, where the groups have been created by the
26883 server, it is quite likely that there can be many groups.
26886 @item (nnchoke-request-create-group GROUP &optional SERVER)
26888 This function should create an empty group with name @var{group}.
26890 There should be no return data.
26893 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
26895 This function should run the expiry process on all articles in the
26896 @var{articles} range (which is currently a simple list of article
26897 numbers.) It is left up to the back end to decide how old articles
26898 should be before they are removed by this function. If @var{force} is
26899 non-@code{nil}, all @var{articles} should be deleted, no matter how new
26902 This function should return a list of articles that it did not/was not
26905 There should be no result data returned.
26908 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST)
26910 This function should move @var{article} (which is a number) from
26911 @var{group} by calling @var{accept-form}.
26913 This function should ready the article in question for moving by
26914 removing any header lines it has added to the article, and generally
26915 should ``tidy up'' the article. Then it should @code{eval}
26916 @var{accept-form} in the buffer where the ``tidy'' article is. This
26917 will do the actual copying. If this @code{eval} returns a
26918 non-@code{nil} value, the article should be removed.
26920 If @var{last} is @code{nil}, that means that there is a high likelihood
26921 that there will be more requests issued shortly, so that allows some
26924 The function should return a cons where the @code{car} is the group name and
26925 the @code{cdr} is the article number that the article was entered as.
26927 The group should exist before the back end is asked to accept the
26928 article for that group.
26930 There should be no data returned.
26933 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
26935 This function takes the current buffer and inserts it into @var{group}.
26936 If @var{last} in @code{nil}, that means that there will be more calls to
26937 this function in short order.
26939 The function should return a cons where the @code{car} is the group name and
26940 the @code{cdr} is the article number that the article was entered as.
26942 There should be no data returned.
26945 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
26947 This function should remove @var{article} (which is a number) from
26948 @var{group} and insert @var{buffer} there instead.
26950 There should be no data returned.
26953 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
26955 This function should delete @var{group}. If @var{force}, it should
26956 really delete all the articles in the group, and then delete the group
26957 itself. (If there is such a thing as ``the group itself''.)
26959 There should be no data returned.
26962 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
26964 This function should rename @var{group} into @var{new-name}. All
26965 articles in @var{group} should move to @var{new-name}.
26967 There should be no data returned.
26972 @node Error Messaging
26973 @subsubsection Error Messaging
26975 @findex nnheader-report
26976 @findex nnheader-get-report
26977 The back ends should use the function @code{nnheader-report} to report
26978 error conditions---they should not raise errors when they aren't able to
26979 perform a request. The first argument to this function is the back end
26980 symbol, and the rest are interpreted as arguments to @code{format} if
26981 there are multiple of them, or just a string if there is one of them.
26982 This function must always returns @code{nil}.
26985 (nnheader-report 'nnchoke "You did something totally bogus")
26987 (nnheader-report 'nnchoke "Could not request group %s" group)
26990 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
26991 @code{nil} back from a server, and this function returns the most
26992 recently reported message for the back end in question. This function
26993 takes one argument---the server symbol.
26995 Internally, these functions access @var{back-end}@code{-status-string},
26996 so the @code{nnchoke} back end will have its error message stored in
26997 @code{nnchoke-status-string}.
27000 @node Writing New Back Ends
27001 @subsubsection Writing New Back Ends
27003 Many back ends are quite similar. @code{nnml} is just like
27004 @code{nnspool}, but it allows you to edit the articles on the server.
27005 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
27006 and it doesn't maintain overview databases. @code{nndir} is just like
27007 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
27010 It would make sense if it were possible to ``inherit'' functions from
27011 back ends when writing new back ends. And, indeed, you can do that if you
27012 want to. (You don't have to if you don't want to, of course.)
27014 All the back ends declare their public variables and functions by using a
27015 package called @code{nnoo}.
27017 To inherit functions from other back ends (and allow other back ends to
27018 inherit functions from the current back end), you should use the
27024 This macro declares the first parameter to be a child of the subsequent
27025 parameters. For instance:
27028 (nnoo-declare nndir
27032 @code{nndir} has declared here that it intends to inherit functions from
27033 both @code{nnml} and @code{nnmh}.
27036 This macro is equivalent to @code{defvar}, but registers the variable as
27037 a public server variable. Most state-oriented variables should be
27038 declared with @code{defvoo} instead of @code{defvar}.
27040 In addition to the normal @code{defvar} parameters, it takes a list of
27041 variables in the parent back ends to map the variable to when executing
27042 a function in those back ends.
27045 (defvoo nndir-directory nil
27046 "Where nndir will look for groups."
27047 nnml-current-directory nnmh-current-directory)
27050 This means that @code{nnml-current-directory} will be set to
27051 @code{nndir-directory} when an @code{nnml} function is called on behalf
27052 of @code{nndir}. (The same with @code{nnmh}.)
27054 @item nnoo-define-basics
27055 This macro defines some common functions that almost all back ends should
27059 (nnoo-define-basics nndir)
27063 This macro is just like @code{defun} and takes the same parameters. In
27064 addition to doing the normal @code{defun} things, it registers the
27065 function as being public so that other back ends can inherit it.
27067 @item nnoo-map-functions
27068 This macro allows mapping of functions from the current back end to
27069 functions from the parent back ends.
27072 (nnoo-map-functions nndir
27073 (nnml-retrieve-headers 0 nndir-current-group 0 0)
27074 (nnmh-request-article 0 nndir-current-group 0 0))
27077 This means that when @code{nndir-retrieve-headers} is called, the first,
27078 third, and fourth parameters will be passed on to
27079 @code{nnml-retrieve-headers}, while the second parameter is set to the
27080 value of @code{nndir-current-group}.
27083 This macro allows importing functions from back ends. It should be the
27084 last thing in the source file, since it will only define functions that
27085 haven't already been defined.
27091 nnmh-request-newgroups)
27095 This means that calls to @code{nndir-request-list} should just be passed
27096 on to @code{nnmh-request-list}, while all public functions from
27097 @code{nnml} that haven't been defined in @code{nndir} yet should be
27102 Below is a slightly shortened version of the @code{nndir} back end.
27105 ;;; @r{nndir.el --- single directory newsgroup access for Gnus}
27106 ;; @r{Copyright (C) 1995,96 Free Software Foundation, Inc.}
27110 (require 'nnheader)
27114 (eval-when-compile (require 'cl))
27116 (nnoo-declare nndir
27119 (defvoo nndir-directory nil
27120 "Where nndir will look for groups."
27121 nnml-current-directory nnmh-current-directory)
27123 (defvoo nndir-nov-is-evil nil
27124 "*Non-nil means that nndir will never retrieve NOV headers."
27127 (defvoo nndir-current-group ""
27129 nnml-current-group nnmh-current-group)
27130 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
27131 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
27133 (defvoo nndir-status-string "" nil nnmh-status-string)
27134 (defconst nndir-version "nndir 1.0")
27136 ;;; @r{Interface functions.}
27138 (nnoo-define-basics nndir)
27140 (deffoo nndir-open-server (server &optional defs)
27141 (setq nndir-directory
27142 (or (cadr (assq 'nndir-directory defs))
27144 (unless (assq 'nndir-directory defs)
27145 (push `(nndir-directory ,server) defs))
27146 (push `(nndir-current-group
27147 ,(file-name-nondirectory
27148 (directory-file-name nndir-directory)))
27150 (push `(nndir-top-directory
27151 ,(file-name-directory (directory-file-name nndir-directory)))
27153 (nnoo-change-server 'nndir server defs))
27155 (nnoo-map-functions nndir
27156 (nnml-retrieve-headers 0 nndir-current-group 0 0)
27157 (nnmh-request-article 0 nndir-current-group 0 0)
27158 (nnmh-request-group nndir-current-group 0 0)
27159 (nnmh-close-group nndir-current-group 0))
27163 nnmh-status-message
27165 nnmh-request-newgroups))
27171 @node Hooking New Back Ends Into Gnus
27172 @subsubsection Hooking New Back Ends Into Gnus
27174 @vindex gnus-valid-select-methods
27175 @findex gnus-declare-backend
27176 Having Gnus start using your new back end is rather easy---you just
27177 declare it with the @code{gnus-declare-backend} functions. This will
27178 enter the back end into the @code{gnus-valid-select-methods} variable.
27180 @code{gnus-declare-backend} takes two parameters---the back end name and
27181 an arbitrary number of @dfn{abilities}.
27186 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
27189 The above line would then go in the @file{nnchoke.el} file.
27191 The abilities can be:
27195 This is a mailish back end---followups should (probably) go via mail.
27197 This is a newsish back end---followups should (probably) go via news.
27199 This back end supports both mail and news.
27201 This is neither a post nor mail back end---it's something completely
27204 It supports respooling---or rather, it is able to modify its source
27205 articles and groups.
27207 The name of the server should be in the virtual server name. This is
27208 true for almost all back ends.
27209 @item prompt-address
27210 The user should be prompted for an address when doing commands like
27211 @kbd{B} in the group buffer. This is true for back ends like
27212 @code{nntp}, but not @code{nnmbox}, for instance.
27216 @node Mail-like Back Ends
27217 @subsubsection Mail-like Back Ends
27219 One of the things that separate the mail back ends from the rest of the
27220 back ends is the heavy dependence by most of the mail back ends on
27221 common functions in @file{nnmail.el}. For instance, here's the
27222 definition of @code{nnml-request-scan}:
27225 (deffoo nnml-request-scan (&optional group server)
27226 (setq nnml-article-file-alist nil)
27227 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
27230 It simply calls @code{nnmail-get-new-mail} with a few parameters,
27231 and @code{nnmail} takes care of all the moving and splitting of the
27234 This function takes four parameters.
27238 This should be a symbol to designate which back end is responsible for
27241 @item exit-function
27242 This function should be called after the splitting has been performed.
27244 @item temp-directory
27245 Where the temporary files should be stored.
27248 This optional argument should be a group name if the splitting is to be
27249 performed for one group only.
27252 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
27253 save each article. @var{back-end}@code{-active-number} will be called to
27254 find the article number assigned to this article.
27256 The function also uses the following variables:
27257 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
27258 this back end); and @var{back-end}@code{-group-alist} and
27259 @var{back-end}@code{-active-file} to generate the new active file.
27260 @var{back-end}@code{-group-alist} should be a group-active alist, like
27264 (("a-group" (1 . 10))
27265 ("some-group" (34 . 39)))
27269 @node Score File Syntax
27270 @subsection Score File Syntax
27272 Score files are meant to be easily parseable, but yet extremely
27273 mallable. It was decided that something that had the same read syntax
27274 as an Emacs Lisp list would fit that spec.
27276 Here's a typical score file:
27280 ("win95" -10000 nil s)
27287 BNF definition of a score file:
27290 score-file = "" / "(" *element ")"
27291 element = rule / atom
27292 rule = string-rule / number-rule / date-rule
27293 string-rule = "(" quote string-header quote space *string-match ")"
27294 number-rule = "(" quote number-header quote space *number-match ")"
27295 date-rule = "(" quote date-header quote space *date-match ")"
27297 string-header = "subject" / "from" / "references" / "message-id" /
27298 "xref" / "body" / "head" / "all" / "followup"
27299 number-header = "lines" / "chars"
27300 date-header = "date"
27301 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
27302 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
27303 score = "nil" / <integer>
27304 date = "nil" / <natural number>
27305 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
27306 "r" / "regex" / "R" / "Regex" /
27307 "e" / "exact" / "E" / "Exact" /
27308 "f" / "fuzzy" / "F" / "Fuzzy"
27309 number-match = "(" <integer> [ "" / [ space score [ "" /
27310 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
27311 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
27312 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
27313 space date [ "" / [ space date-match-t ] ] ] ] ")"
27314 date-match-t = "nil" / "at" / "before" / "after"
27315 atom = "(" [ required-atom / optional-atom ] ")"
27316 required-atom = mark / expunge / mark-and-expunge / files /
27317 exclude-files / read-only / touched
27318 optional-atom = adapt / local / eval
27319 mark = "mark" space nil-or-number
27320 nil-or-number = "nil" / <integer>
27321 expunge = "expunge" space nil-or-number
27322 mark-and-expunge = "mark-and-expunge" space nil-or-number
27323 files = "files" *[ space <string> ]
27324 exclude-files = "exclude-files" *[ space <string> ]
27325 read-only = "read-only" [ space "nil" / space "t" ]
27326 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
27327 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
27328 local = "local" *[ space "(" <string> space <form> ")" ]
27329 eval = "eval" space <form>
27330 space = *[ " " / <TAB> / <NEWLINE> ]
27333 Any unrecognized elements in a score file should be ignored, but not
27336 As you can see, white space is needed, but the type and amount of white
27337 space is irrelevant. This means that formatting of the score file is
27338 left up to the programmer---if it's simpler to just spew it all out on
27339 one looong line, then that's ok.
27341 The meaning of the various atoms are explained elsewhere in this
27342 manual (@pxref{Score File Format}).
27346 @subsection Headers
27348 Internally Gnus uses a format for storing article headers that
27349 corresponds to the @acronym{NOV} format in a mysterious fashion. One could
27350 almost suspect that the author looked at the @acronym{NOV} specification and
27351 just shamelessly @emph{stole} the entire thing, and one would be right.
27353 @dfn{Header} is a severely overloaded term. ``Header'' is used in
27354 RFC 1036 to talk about lines in the head of an article (e.g.,
27355 @code{From}). It is used by many people as a synonym for
27356 ``head''---``the header and the body''. (That should be avoided, in my
27357 opinion.) And Gnus uses a format internally that it calls ``header'',
27358 which is what I'm talking about here. This is a 9-element vector,
27359 basically, with each header (ouch) having one slot.
27361 These slots are, in order: @code{number}, @code{subject}, @code{from},
27362 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
27363 @code{xref}, and @code{extra}. There are macros for accessing and
27364 setting these slots---they all have predictable names beginning with
27365 @code{mail-header-} and @code{mail-header-set-}, respectively.
27367 All these slots contain strings, except the @code{extra} slot, which
27368 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
27374 @sc{gnus} introduced a concept that I found so useful that I've started
27375 using it a lot and have elaborated on it greatly.
27377 The question is simple: If you have a large amount of objects that are
27378 identified by numbers (say, articles, to take a @emph{wild} example)
27379 that you want to qualify as being ``included'', a normal sequence isn't
27380 very useful. (A 200,000 length sequence is a bit long-winded.)
27382 The solution is as simple as the question: You just collapse the
27386 (1 2 3 4 5 6 10 11 12)
27389 is transformed into
27392 ((1 . 6) (10 . 12))
27395 To avoid having those nasty @samp{(13 . 13)} elements to denote a
27396 lonesome object, a @samp{13} is a valid element:
27399 ((1 . 6) 7 (10 . 12))
27402 This means that comparing two ranges to find out whether they are equal
27403 is slightly tricky:
27406 ((1 . 5) 7 8 (10 . 12))
27412 ((1 . 5) (7 . 8) (10 . 12))
27415 are equal. In fact, any non-descending list is a range:
27421 is a perfectly valid range, although a pretty long-winded one. This is
27428 and is equal to the previous range.
27430 Here's a BNF definition of ranges. Of course, one must remember the
27431 semantic requirement that the numbers are non-descending. (Any number
27432 of repetition of the same number is allowed, but apt to disappear in
27436 range = simple-range / normal-range
27437 simple-range = "(" number " . " number ")"
27438 normal-range = "(" start-contents ")"
27439 contents = "" / simple-range *[ " " contents ] /
27440 number *[ " " contents ]
27443 Gnus currently uses ranges to keep track of read articles and article
27444 marks. I plan on implementing a number of range operators in C if The
27445 Powers That Be are willing to let me. (I haven't asked yet, because I
27446 need to do some more thinking on what operators I need to make life
27447 totally range-based without ever having to convert back to normal
27452 @subsection Group Info
27454 Gnus stores all permanent info on groups in a @dfn{group info} list.
27455 This list is from three to six elements (or more) long and exhaustively
27456 describes the group.
27458 Here are two example group infos; one is a very simple group while the
27459 second is a more complex one:
27462 ("no.group" 5 ((1 . 54324)))
27464 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
27465 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
27467 ((auto-expire . t) (to-address . "ding@@gnus.org")))
27470 The first element is the @dfn{group name}---as Gnus knows the group,
27471 anyway. The second element is the @dfn{subscription level}, which
27472 normally is a small integer. (It can also be the @dfn{rank}, which is a
27473 cons cell where the @code{car} is the level and the @code{cdr} is the
27474 score.) The third element is a list of ranges of read articles. The
27475 fourth element is a list of lists of article marks of various kinds.
27476 The fifth element is the select method (or virtual server, if you like).
27477 The sixth element is a list of @dfn{group parameters}, which is what
27478 this section is about.
27480 Any of the last three elements may be missing if they are not required.
27481 In fact, the vast majority of groups will normally only have the first
27482 three elements, which saves quite a lot of cons cells.
27484 Here's a BNF definition of the group info format:
27487 info = "(" group space ralevel space read
27488 [ "" / [ space marks-list [ "" / [ space method [ "" /
27489 space parameters ] ] ] ] ] ")"
27490 group = quote <string> quote
27491 ralevel = rank / level
27492 level = <integer in the range of 1 to inf>
27493 rank = "(" level "." score ")"
27494 score = <integer in the range of 1 to inf>
27496 marks-lists = nil / "(" *marks ")"
27497 marks = "(" <string> range ")"
27498 method = "(" <string> *elisp-forms ")"
27499 parameters = "(" *elisp-forms ")"
27502 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
27503 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
27506 If you have a Gnus info and want to access the elements, Gnus offers a
27507 series of macros for getting/setting these elements.
27510 @item gnus-info-group
27511 @itemx gnus-info-set-group
27512 @findex gnus-info-group
27513 @findex gnus-info-set-group
27514 Get/set the group name.
27516 @item gnus-info-rank
27517 @itemx gnus-info-set-rank
27518 @findex gnus-info-rank
27519 @findex gnus-info-set-rank
27520 Get/set the group rank (@pxref{Group Score}).
27522 @item gnus-info-level
27523 @itemx gnus-info-set-level
27524 @findex gnus-info-level
27525 @findex gnus-info-set-level
27526 Get/set the group level.
27528 @item gnus-info-score
27529 @itemx gnus-info-set-score
27530 @findex gnus-info-score
27531 @findex gnus-info-set-score
27532 Get/set the group score (@pxref{Group Score}).
27534 @item gnus-info-read
27535 @itemx gnus-info-set-read
27536 @findex gnus-info-read
27537 @findex gnus-info-set-read
27538 Get/set the ranges of read articles.
27540 @item gnus-info-marks
27541 @itemx gnus-info-set-marks
27542 @findex gnus-info-marks
27543 @findex gnus-info-set-marks
27544 Get/set the lists of ranges of marked articles.
27546 @item gnus-info-method
27547 @itemx gnus-info-set-method
27548 @findex gnus-info-method
27549 @findex gnus-info-set-method
27550 Get/set the group select method.
27552 @item gnus-info-params
27553 @itemx gnus-info-set-params
27554 @findex gnus-info-params
27555 @findex gnus-info-set-params
27556 Get/set the group parameters.
27559 All the getter functions take one parameter---the info list. The setter
27560 functions take two parameters---the info list and the new value.
27562 The last three elements in the group info aren't mandatory, so it may be
27563 necessary to extend the group info before setting the element. If this
27564 is necessary, you can just pass on a non-@code{nil} third parameter to
27565 the three final setter functions to have this happen automatically.
27568 @node Extended Interactive
27569 @subsection Extended Interactive
27570 @cindex interactive
27571 @findex gnus-interactive
27573 Gnus extends the standard Emacs @code{interactive} specification
27574 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
27575 Prefixes}). Here's an example of how this is used:
27578 (defun gnus-summary-increase-score (&optional score symp)
27579 (interactive (gnus-interactive "P\ny"))
27584 The best thing to do would have been to implement
27585 @code{gnus-interactive} as a macro which would have returned an
27586 @code{interactive} form, but this isn't possible since Emacs checks
27587 whether a function is interactive or not by simply doing an @code{assq}
27588 on the lambda form. So, instead we have @code{gnus-interactive}
27589 function that takes a string and returns values that are usable to
27590 @code{interactive}.
27592 This function accepts (almost) all normal @code{interactive} specs, but
27597 @vindex gnus-current-prefix-symbol
27598 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
27602 @vindex gnus-current-prefix-symbols
27603 A list of the current symbolic prefixes---the
27604 @code{gnus-current-prefix-symbol} variable.
27607 The current article number---the @code{gnus-summary-article-number}
27611 The current article header---the @code{gnus-summary-article-header}
27615 The current group name---the @code{gnus-group-group-name}
27621 @node Emacs/XEmacs Code
27622 @subsection Emacs/XEmacs Code
27626 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
27627 platforms must be the primary one. I chose Emacs. Not because I don't
27628 like XEmacs or Mule, but because it comes first alphabetically.
27630 This means that Gnus will byte-compile under Emacs with nary a warning,
27631 while XEmacs will pump out gigabytes of warnings while byte-compiling.
27632 As I use byte-compilation warnings to help me root out trivial errors in
27633 Gnus, that's very useful.
27635 I've also consistently used Emacs function interfaces, but have used
27636 Gnusey aliases for the functions. To take an example: Emacs defines a
27637 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
27638 function. I then define a function called @code{gnus-run-at-time} that
27639 takes the same parameters as the Emacs @code{run-at-time}. When running
27640 Gnus under Emacs, the former function is just an alias for the latter.
27641 However, when running under XEmacs, the former is an alias for the
27642 following function:
27645 (defun gnus-xmas-run-at-time (time repeat function &rest args)
27649 (,function ,@@args))
27653 This sort of thing has been done for bunches of functions. Gnus does
27654 not redefine any native Emacs functions while running under XEmacs---it
27655 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
27658 In the cases where the XEmacs function interface was obviously cleaner,
27659 I used it instead. For example @code{gnus-region-active-p} is an alias
27660 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
27662 Of course, I could have chosen XEmacs as my native platform and done
27663 mapping functions the other way around. But I didn't. The performance
27664 hit these indirections impose on Gnus under XEmacs should be slight.
27667 @node Various File Formats
27668 @subsection Various File Formats
27671 * Active File Format:: Information on articles and groups available.
27672 * Newsgroups File Format:: Group descriptions.
27676 @node Active File Format
27677 @subsubsection Active File Format
27679 The active file lists all groups available on the server in
27680 question. It also lists the highest and lowest current article numbers
27683 Here's an excerpt from a typical active file:
27686 soc.motss 296030 293865 y
27687 alt.binaries.pictures.fractals 3922 3913 n
27688 comp.sources.unix 1605 1593 m
27689 comp.binaries.ibm.pc 5097 5089 y
27690 no.general 1000 900 y
27693 Here's a pseudo-BNF definition of this file:
27696 active = *group-line
27697 group-line = group spc high-number spc low-number spc flag <NEWLINE>
27698 group = <non-white-space string>
27700 high-number = <non-negative integer>
27701 low-number = <positive integer>
27702 flag = "y" / "n" / "m" / "j" / "x" / "=" group
27705 For a full description of this file, see the manual pages for
27706 @samp{innd}, in particular @samp{active(5)}.
27709 @node Newsgroups File Format
27710 @subsubsection Newsgroups File Format
27712 The newsgroups file lists groups along with their descriptions. Not all
27713 groups on the server have to be listed, and not all groups in the file
27714 have to exist on the server. The file is meant purely as information to
27717 The format is quite simple; a group name, a tab, and the description.
27718 Here's the definition:
27722 line = group tab description <NEWLINE>
27723 group = <non-white-space string>
27725 description = <string>
27730 @node Emacs for Heathens
27731 @section Emacs for Heathens
27733 Believe it or not, but some people who use Gnus haven't really used
27734 Emacs much before they embarked on their journey on the Gnus Love Boat.
27735 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
27736 region'', and ``set @code{gnus-flargblossen} to an alist where the key
27737 is a regexp that is used for matching on the group name'' are magical
27738 phrases with little or no meaning, then this appendix is for you. If
27739 you are already familiar with Emacs, just ignore this and go fondle your
27743 * Keystrokes:: Entering text and executing commands.
27744 * Emacs Lisp:: The built-in Emacs programming language.
27749 @subsection Keystrokes
27753 Q: What is an experienced Emacs user?
27756 A: A person who wishes that the terminal had pedals.
27759 Yes, when you use Emacs, you are apt to use the control key, the shift
27760 key and the meta key a lot. This is very annoying to some people
27761 (notably @code{vi}le users), and the rest of us just love the hell out
27762 of it. Just give up and submit. Emacs really does stand for
27763 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
27764 may have heard from other disreputable sources (like the Emacs author).
27766 The shift keys are normally located near your pinky fingers, and are
27767 normally used to get capital letters and stuff. You probably use it all
27768 the time. The control key is normally marked ``CTRL'' or something like
27769 that. The meta key is, funnily enough, never marked as such on any
27770 keyboard. The one I'm currently at has a key that's marked ``Alt'',
27771 which is the meta key on this keyboard. It's usually located somewhere
27772 to the left hand side of the keyboard, usually on the bottom row.
27774 Now, us Emacs people don't say ``press the meta-control-m key'',
27775 because that's just too inconvenient. We say ``press the @kbd{C-M-m}
27776 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
27777 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
27778 down the control key, and hold it down while you press @kbd{k}''.
27779 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
27780 the control key and then press @kbd{k}''. Simple, ay?
27782 This is somewhat complicated by the fact that not all keyboards have a
27783 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
27784 means ``press escape, release escape, press @kbd{k}''. That's much more
27785 work than if you have a meta key, so if that's the case, I respectfully
27786 suggest you get a real keyboard with a meta key. You can't live without
27792 @subsection Emacs Lisp
27794 Emacs is the King of Editors because it's really a Lisp interpreter.
27795 Each and every key you tap runs some Emacs Lisp code snippet, and since
27796 Emacs Lisp is an interpreted language, that means that you can configure
27797 any key to run any arbitrary code. You just, like, do it.
27799 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
27800 functions. (These are byte-compiled for speed, but it's still
27801 interpreted.) If you decide that you don't like the way Gnus does
27802 certain things, it's trivial to have it do something a different way.
27803 (Well, at least if you know how to write Lisp code.) However, that's
27804 beyond the scope of this manual, so we are simply going to talk about
27805 some common constructs that you normally use in your @file{.emacs} file
27808 If you want to set the variable @code{gnus-florgbnize} to four (4), you
27809 write the following:
27812 (setq gnus-florgbnize 4)
27815 This function (really ``special form'') @code{setq} is the one that can
27816 set a variable to some value. This is really all you need to know. Now
27817 you can go and fill your @file{.emacs} file with lots of these to change
27820 If you have put that thing in your @file{.emacs} file, it will be read
27821 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
27822 start Emacs. If you want to change the variable right away, simply say
27823 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
27824 previous ``form'', which is a simple @code{setq} statement here.
27826 Go ahead---just try it, if you're located at your Emacs. After you
27827 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
27828 is the return value of the form you @code{eval}ed.
27832 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
27836 (setq gnus-read-active-file 'some)
27839 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
27840 @samp{nntp.ifi.uio.no}'', that means:
27843 (setq gnus-nntp-server "nntp.ifi.uio.no")
27846 So be careful not to mix up strings (the latter) with symbols (the
27847 former). The manual is unambiguous, but it can be confusing.
27850 @include gnus-faq.texi
27870 @c Local Variables:
27872 @c coding: iso-8859-1