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}{Oort Gnus v0.14}
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{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''}
57 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
58 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
59 \newcommand{\gnuskey}[1]{`\gnustt{#1}'}
60 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
61 \newcommand{\gnusdfn}[1]{\textit{#1}}
62 \newcommand{\gnusi}[1]{\textit{#1}}
63 \newcommand{\gnusstrong}[1]{\textbf{#1}}
64 \newcommand{\gnusemph}[1]{\textit{#1}}
65 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
66 \newcommand{\gnussc}[1]{\textsc{#1}}
67 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
68 \newcommand{\gnusversion}[1]{{\small\textit{#1}}}
69 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
70 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
71 \newcommand{\gnusacronym}[1]{\textit{#1}}
72 \newcommand{\gnusemail}[1]{\textit{#1}}
74 \newcommand{\gnusbullet}{{${\bullet}$}}
75 \newcommand{\gnusdollar}{\$}
76 \newcommand{\gnusampersand}{\&}
77 \newcommand{\gnuspercent}{\%}
78 \newcommand{\gnushash}{\#}
79 \newcommand{\gnushat}{\symbol{"5E}}
80 \newcommand{\gnusunderline}{\symbol{"5F}}
81 \newcommand{\gnusnot}{$\neg$}
82 \newcommand{\gnustilde}{\symbol{"7E}}
83 \newcommand{\gnusless}{{$<$}}
84 \newcommand{\gnusgreater}{{$>$}}
85 \newcommand{\gnusbraceleft}{{$>$}}
86 \newcommand{\gnusbraceright}{{$>$}}
88 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}}
89 \newcommand{\gnusinteresting}{
90 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
93 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
95 \newcommand{\gnuspagechapter}[1]{
102 \newcommand{\gnuschapter}[2]{
104 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
106 \renewcommand{\gnussectionname}{}
107 \renewcommand{\gnuschaptername}{#2}
108 \thispagestyle{empty}
110 \begin{picture}(500,500)(0,0)
111 \put(480,350){\makebox(0,0)[tr]{#1}}
112 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
117 \newcommand{\gnusfigure}[3]{
119 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
126 \newcommand{\gnusicon}[1]{
127 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}}
130 \newcommand{\gnuspicon}[1]{
131 \margindex{\epsfig{figure=#1,width=2cm}}
134 \newcommand{\gnusxface}[2]{
135 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
138 \newcommand{\gnussmiley}[2]{
139 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
142 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
144 \newcommand{\gnussection}[1]{
145 \renewcommand{\gnussectionname}{#1}
149 \newenvironment{codelist}%
154 \newenvironment{kbdlist}%
160 \newenvironment{dfnlist}%
165 \newenvironment{stronglist}%
170 \newenvironment{samplist}%
175 \newenvironment{varlist}%
180 \newenvironment{emphlist}%
185 \newlength\gnusheadtextwidth
186 \setlength{\gnusheadtextwidth}{\headtextwidth}
187 \addtolength{\gnusheadtextwidth}{1cm}
189 \newpagestyle{gnuspreamble}%
194 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
198 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
207 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
209 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
214 \newpagestyle{gnusindex}%
219 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
223 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
231 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
233 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
243 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
247 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
255 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
257 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
262 \pagenumbering{roman}
263 \pagestyle{gnuspreamble}
273 %\addtolength{\oddsidemargin}{-5cm}
274 %\addtolength{\evensidemargin}{-5cm}
276 \addtolength{\textheight}{2cm}
278 \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\
281 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm}
284 \gnusauthor{by Lars Magne Ingebrigtsen}
291 \thispagestyle{empty}
293 Copyright \copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001,
295 Free Software Foundation, Inc.
298 Permission is granted to copy, distribute and/or modify this document
299 under the terms of the GNU Free Documentation License, Version 1.1 or
300 any later version published by the Free Software Foundation; with no
301 Invariant Sections, with the Front-Cover texts being ``A GNU
302 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
303 license is included in the section entitled ``GNU Free Documentation
304 License'' in the Emacs manual.
306 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
307 this GNU Manual, like GNU software. Copies published by the Free
308 Software Foundation raise funds for GNU development.''
310 This document is part of a collection distributed under the GNU Free
311 Documentation License. If you want to distribute this document
312 separately from the collection, you can do so by adding a copy of the
313 license to the document, as described in section 6 of the license.
321 This file documents Gnus, the GNU Emacs newsreader.
323 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
324 Free Software Foundation, Inc.
326 Permission is granted to copy, distribute and/or modify this document
327 under the terms of the GNU Free Documentation License, Version 1.1 or
328 any later version published by the Free Software Foundation; with the
329 Invariant Sections being none, with the Front-Cover texts being ``A GNU
330 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
331 license is included in the section entitled ``GNU Free Documentation
332 License'' in the Emacs manual.
334 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
335 this GNU Manual, like GNU software. Copies published by the Free
336 Software Foundation raise funds for GNU development.''
338 This document is part of a collection distributed under the GNU Free
339 Documentation License. If you want to distribute this document
340 separately from the collection, you can do so by adding a copy of the
341 license to the document, as described in section 6 of the license.
349 @author by Lars Magne Ingebrigtsen
352 @vskip 0pt plus 1filll
353 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001,
355 Free Software Foundation, Inc.
357 Permission is granted to copy, distribute and/or modify this document
358 under the terms of the GNU Free Documentation License, Version 1.1 or
359 any later version published by the Free Software Foundation; with no
360 Invariant Sections, with the Front-Cover texts being ``A GNU
361 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
362 license is included in the section entitled ``GNU Free Documentation
363 License'' in the Emacs manual.
365 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
366 this GNU Manual, like GNU software. Copies published by the Free
367 Software Foundation raise funds for GNU development.''
369 This document is part of a collection distributed under the GNU Free
370 Documentation License. If you want to distribute this document
371 separately from the collection, you can do so by adding a copy of the
372 license to the document, as described in section 6 of the license.
381 @top The Gnus Newsreader
385 You can read news (and mail) from within Emacs by using Gnus. The news
386 can be gotten by any nefarious means you can think of---@sc{nntp}, local
387 spool or your mbox file. All at the same time, if you want to push your
390 This manual corresponds to Oort Gnus v0.14.
401 Gnus is the advanced, self-documenting, customizable, extensible
402 unreal-time newsreader for GNU Emacs.
404 Oops. That sounds oddly familiar, so let's start over again to avoid
405 being accused of plagiarism:
407 Gnus is a message-reading laboratory. It will let you look at just
408 about anything as if it were a newsgroup. You can read mail with it,
409 you can browse directories with it, you can @code{ftp} with it---you
410 can even read news with it!
412 Gnus tries to empower people who read news the same way Emacs empowers
413 people who edit text. Gnus sets no limits to what the user should be
414 allowed to do. Users are encouraged to extend Gnus to make it behave
415 like they want it to behave. A program should not control people;
416 people should be empowered to do what they want by using (or abusing)
422 * Starting Up:: Finding news can be a pain.
423 * Group Buffer:: Selecting, subscribing and killing groups.
424 * Summary Buffer:: Reading, saving and posting articles.
425 * Article Buffer:: Displaying and handling articles.
426 * Composing Messages:: Information on sending mail and news.
427 * Select Methods:: Gnus reads all messages from various select methods.
428 * Scoring:: Assigning values to articles.
429 * Various:: General purpose settings.
430 * The End:: Farewell and goodbye.
431 * Appendices:: Terminology, Emacs intro, FAQ, History, Internals.
432 * Index:: Variable, function and concept index.
433 * Key Index:: Key Index.
435 Other related manuals
437 * Message:(message). Composing messages.
438 * Emacs-MIME:(emacs-mime). Composing messages; MIME-specific parts.
439 * Sieve:(sieve). Managing Sieve scripts in Emacs.
440 * PGG:(pgg). PGP/MIME with Gnus.
443 --- The Detailed Node Listing ---
447 * Finding the News:: Choosing a method for getting news.
448 * The First Time:: What does Gnus do the first time you start it?
449 * The Server is Down:: How can I read my mail then?
450 * Slave Gnusae:: You can have more than one Gnus active at a time.
451 * Fetching a Group:: Starting Gnus just to read a group.
452 * New Groups:: What is Gnus supposed to do with new groups?
453 * Changing Servers:: You may want to move from one server to another.
454 * Startup Files:: Those pesky startup files---@file{.newsrc}.
455 * Auto Save:: Recovering from a crash.
456 * The Active File:: Reading the active file over a slow line Takes Time.
457 * Startup Variables:: Other variables you might change.
461 * Checking New Groups:: Determining what groups are new.
462 * Subscription Methods:: What Gnus should do with new groups.
463 * Filtering New Groups:: Making Gnus ignore certain new groups.
467 * Group Buffer Format:: Information listed and how you can change it.
468 * Group Maneuvering:: Commands for moving in the group buffer.
469 * Selecting a Group:: Actually reading news.
470 * Subscription Commands:: Unsubscribing, killing, subscribing.
471 * Group Data:: Changing the info for a group.
472 * Group Levels:: Levels? What are those, then?
473 * Group Score:: A mechanism for finding out what groups you like.
474 * Marking Groups:: You can mark groups for later processing.
475 * Foreign Groups:: Creating and editing groups.
476 * Group Parameters:: Each group may have different parameters set.
477 * Listing Groups:: Gnus can list various subsets of the groups.
478 * Sorting Groups:: Re-arrange the group order.
479 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
480 * Browse Foreign Server:: You can browse a server. See what it has to offer.
481 * Exiting Gnus:: Stop reading news and get some work done.
482 * Group Topics:: A folding group mode divided into topics.
483 * Misc Group Stuff:: Other stuff that you can to do.
487 * Group Line Specification:: Deciding how the group buffer is to look.
488 * Group Modeline Specification:: The group buffer modeline.
489 * Group Highlighting:: Having nice colors in the group buffer.
493 * Topic Commands:: Interactive E-Z commands.
494 * Topic Variables:: How to customize the topics the Lisp Way.
495 * Topic Sorting:: Sorting each topic individually.
496 * Topic Topology:: A map of the world.
497 * Topic Parameters:: Parameters that apply to all groups in a topic.
501 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
502 * Group Information:: Information and help on groups and Gnus.
503 * Group Timestamp:: Making Gnus keep track of when you last read a group.
504 * File Commands:: Reading and writing the Gnus files.
505 * Sieve Commands:: Managing Sieve scripts.
509 * Summary Buffer Format:: Deciding how the summary buffer is to look.
510 * Summary Maneuvering:: Moving around the summary buffer.
511 * Choosing Articles:: Reading articles.
512 * Paging the Article:: Scrolling the current article.
513 * Reply Followup and Post:: Posting articles.
514 * Delayed Articles:: Send articles at a later time.
515 * Marking Articles:: Marking articles as read, expirable, etc.
516 * Limiting:: You can limit the summary buffer.
517 * Threading:: How threads are made.
518 * Sorting the Summary Buffer:: How articles and threads are sorted.
519 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
520 * Article Caching:: You may store articles in a cache.
521 * Persistent Articles:: Making articles expiry-resistant.
522 * Article Backlog:: Having already read articles hang around.
523 * Saving Articles:: Ways of customizing article saving.
524 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
525 * Article Treatment:: The article buffer can be mangled at will.
526 * MIME Commands:: Doing MIMEy things with the articles.
527 * Charsets:: Character set issues.
528 * Article Commands:: Doing various things with the article buffer.
529 * Summary Sorting:: Sorting the summary buffer in various ways.
530 * Finding the Parent:: No child support? Get the parent.
531 * Alternative Approaches:: Reading using non-default summaries.
532 * Tree Display:: A more visual display of threads.
533 * Mail Group Commands:: Some commands can only be used in mail groups.
534 * Various Summary Stuff:: What didn't fit anywhere else.
535 * Exiting the Summary Buffer:: Returning to the Group buffer,
536 or reselecting the current group.
537 * Crosspost Handling:: How crossposted articles are dealt with.
538 * Duplicate Suppression:: An alternative when crosspost handling fails.
539 * Security:: Decrypt and Verify.
540 * Mailing List:: Mailing list minor mode.
542 Summary Buffer Format
544 * Summary Buffer Lines:: You can specify how summary lines should look.
545 * To From Newsgroups:: How to not display your own name.
546 * Summary Buffer Mode Line:: You can say how the mode line should look.
547 * Summary Highlighting:: Making the summary buffer all pretty and nice.
551 * Choosing Commands:: Commands for choosing articles.
552 * Choosing Variables:: Variables that influence these commands.
554 Reply, Followup and Post
556 * Summary Mail Commands:: Sending mail.
557 * Summary Post Commands:: Sending news.
558 * Summary Message Commands:: Other Message-related commands.
559 * Canceling and Superseding::
563 * Unread Articles:: Marks for unread articles.
564 * Read Articles:: Marks for read articles.
565 * Other Marks:: Marks that do not affect readedness.
567 * Generic Marking Commands::
568 * Setting Process Marks::
572 * Setting Marks:: How to set and remove marks.
573 * Generic Marking Commands:: How to customize the marking.
574 * Setting Process Marks:: How to mark articles for later processing.
578 * Customizing Threading:: Variables you can change to affect the threading.
579 * Thread Commands:: Thread based commands in the summary buffer.
581 Customizing Threading
583 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
584 * Filling In Threads:: Making the threads displayed look fuller.
585 * More Threading:: Even more variables for fiddling with threads.
586 * Low-Level Threading:: You thought it was over... but you were wrong!
590 * Uuencoded Articles:: Uudecode articles.
591 * Shell Archives:: Unshar articles.
592 * PostScript Files:: Split PostScript.
593 * Other Files:: Plain save and binhex.
594 * Decoding Variables:: Variables for a happy decoding.
595 * Viewing Files:: You want to look at the result of the decoding?
599 * Rule Variables:: Variables that say how a file is to be viewed.
600 * Other Decode Variables:: Other decode variables.
601 * Uuencoding and Posting:: Variables for customizing uuencoding.
605 * Article Highlighting:: You want to make the article look like fruit salad.
606 * Article Fontisizing:: Making emphasized text look nice.
607 * Article Hiding:: You also want to make certain info go away.
608 * Article Washing:: Lots of way-neat functions to make life better.
609 * Article Header:: Doing various header transformations.
610 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
611 * Article Date:: Grumble, UT!
612 * Article Display:: Display various stuff---X-Face, Picons, Smileys
613 * Article Signature:: What is a signature?
614 * Article Miscellania:: Various other stuff.
616 Alternative Approaches
618 * Pick and Read:: First mark articles and then read them.
619 * Binary Groups:: Auto-decode all articles.
621 Various Summary Stuff
623 * Summary Group Information:: Information oriented commands.
624 * Searching for Articles:: Multiple article commands.
625 * Summary Generation Commands::
626 * Really Various Summary Commands:: Those pesky non-conformant commands.
630 * Hiding Headers:: Deciding what headers should be displayed.
631 * Using MIME:: Pushing articles through @sc{mime} before reading them.
632 * Customizing Articles:: Tailoring the look of the articles.
633 * Article Keymap:: Keystrokes available in the article buffer.
634 * Misc Article:: Other stuff.
638 * Mail:: Mailing and replying.
639 * Posting Server:: What server should you post and mail via?
640 * Mail and Post:: Mailing and posting at the same time.
641 * Archived Messages:: Where Gnus stores the messages you've sent.
642 * Posting Styles:: An easier way to specify who you are.
643 * Drafts:: Postponing messages and rejected messages.
644 * Rejected Articles:: What happens if the server doesn't like your article?
645 * Signing and encrypting:: How to compose secure messages.
649 * Server Buffer:: Making and editing virtual servers.
650 * Getting News:: Reading USENET news with Gnus.
651 * Getting Mail:: Reading your personal mail with Gnus.
652 * Browsing the Web:: Getting messages from a plethora of Web sources.
653 * IMAP:: Using Gnus as a @sc{imap} client.
654 * Other Sources:: Reading directories, files, SOUP packets.
655 * Combined Groups:: Combining groups into one group.
656 * Gnus Unplugged:: Reading news and mail offline.
660 * Server Buffer Format:: You can customize the look of this buffer.
661 * Server Commands:: Commands to manipulate servers.
662 * Example Methods:: Examples server specifications.
663 * Creating a Virtual Server:: An example session.
664 * Server Variables:: Which variables to set.
665 * Servers and Methods:: You can use server names as select methods.
666 * Unavailable Servers:: Some servers you try to contact may be down.
670 * NNTP:: Reading news from an @sc{nntp} server.
671 * News Spool:: Reading news from the local spool.
675 * Direct Functions:: Connecting directly to the server.
676 * Indirect Functions:: Connecting indirectly to the server.
677 * Common Variables:: Understood by several connection functions.
681 * Mail in a Newsreader:: Important introductory notes.
682 * Getting Started Reading Mail:: A simple cookbook example.
683 * Splitting Mail:: How to create mail groups.
684 * Mail Sources:: How to tell Gnus where to get mail from.
685 * Mail Back End Variables:: Variables for customizing mail handling.
686 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
687 * Group Mail Splitting:: Use group customize to drive mail splitting.
688 * Incorporating Old Mail:: What about the old mail you have?
689 * Expiring Mail:: Getting rid of unwanted mail.
690 * Washing Mail:: Removing gruft from the mail you get.
691 * Duplicates:: Dealing with duplicated mail.
692 * Not Reading Mail:: Using mail back ends for reading other files.
693 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
697 * Mail Source Specifiers:: How to specify what a mail source is.
698 * Mail Source Customization:: Some variables that influence things.
699 * Fetching Mail:: Using the mail source specifiers.
701 Choosing a Mail Back End
703 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
704 * Rmail Babyl:: Emacs programs use the rmail babyl format.
705 * Mail Spool:: Store your mail in a private spool?
706 * MH Spool:: An mhspool-like back end.
707 * Mail Folders:: Having one file for each group.
708 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
713 * Web Searches:: Creating groups from articles that match a string.
714 * Slashdot:: Reading the Slashdot comments.
715 * Ultimate:: The Ultimate Bulletin Board systems.
716 * Web Archive:: Reading mailing list archived on web.
717 * RSS:: Reading RDF site summary.
718 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
722 * Splitting in IMAP:: Splitting mail with nnimap.
723 * Expiring in IMAP:: Expiring mail with nnimap.
724 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
725 * Expunging mailboxes:: Equivalent of a "compress mailbox" button.
726 * A note on namespaces:: How to (not) use IMAP namespace in Gnus.
730 * Directory Groups:: You can read a directory as if it was a newsgroup.
731 * Anything Groups:: Dired? Who needs dired?
732 * Document Groups:: Single files can be the basis of a group.
733 * SOUP:: Reading @sc{soup} packets ``offline''.
734 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
738 * Document Server Internals:: How to add your own document types.
742 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
743 * SOUP Groups:: A back end for reading @sc{soup} packets.
744 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
748 * Virtual Groups:: Combining articles from many groups.
749 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
753 * Agent Basics:: How it all is supposed to work.
754 * Agent Categories:: How to tell the Gnus Agent what to download.
755 * Agent Commands:: New commands for all the buffers.
756 * Agent as Cache:: The Agent is a big cache too.
757 * Agent Expiry:: How to make old articles go away.
758 * Agent Regeneration:: How to recover from lost connections and other accidents.
759 * Agent and IMAP:: How to use the Agent with IMAP.
760 * Outgoing Messages:: What happens when you post/mail something?
761 * Agent Variables:: Customizing is fun.
762 * Example Setup:: An example @file{.gnus.el} file for offline people.
763 * Batching Agents:: How to fetch news from a @code{cron} job.
764 * Agent Caveats:: What you think it'll do and what it does.
768 * Category Syntax:: What a category looks like.
769 * Category Buffer:: A buffer for maintaining categories.
770 * Category Variables:: Customize'r'Us.
774 * Group Agent Commands:: Configure groups and fetch their contents.
775 * Summary Agent Commands:: Manually select then fetch specific articles.
776 * Server Agent Commands:: Select the servers that are supported by the agent.
780 * Summary Score Commands:: Adding score entries for the current group.
781 * Group Score Commands:: General score commands.
782 * Score Variables:: Customize your scoring. (My, what terminology).
783 * Score File Format:: What a score file may contain.
784 * Score File Editing:: You can edit score files by hand as well.
785 * Adaptive Scoring:: Big Sister Gnus knows what you read.
786 * Home Score File:: How to say where new score entries are to go.
787 * Followups To Yourself:: Having Gnus notice when people answer you.
788 * Scoring On Other Headers:: Scoring on non-standard headers.
789 * Scoring Tips:: How to score effectively.
790 * Reverse Scoring:: That problem child of old is not problem.
791 * Global Score Files:: Earth-spanning, ear-splitting score files.
792 * Kill Files:: They are still here, but they can be ignored.
793 * Converting Kill Files:: Translating kill files to score files.
794 * GroupLens:: Getting predictions on what you like to read.
795 * Advanced Scoring:: Using logical expressions to build score rules.
796 * Score Decays:: It can be useful to let scores wither away.
800 * Using GroupLens:: How to make Gnus use GroupLens.
801 * Rating Articles:: Letting GroupLens know how you rate articles.
802 * Displaying Predictions:: Displaying predictions given by GroupLens.
803 * GroupLens Variables:: Customizing GroupLens.
807 * Advanced Scoring Syntax:: A definition.
808 * Advanced Scoring Examples:: What they look like.
809 * Advanced Scoring Tips:: Getting the most out of it.
813 * Process/Prefix:: A convention used by many treatment commands.
814 * Interactive:: Making Gnus ask you many questions.
815 * Symbolic Prefixes:: How to supply some Gnus functions with options.
816 * Formatting Variables:: You can specify what buffers should look like.
817 * Window Layout:: Configuring the Gnus buffer windows.
818 * Faces and Fonts:: How to change how faces look.
819 * Compilation:: How to speed Gnus up.
820 * Mode Lines:: Displaying information in the mode lines.
821 * Highlighting and Menus:: Making buffers look all nice and cozy.
822 * Buttons:: Get tendinitis in ten easy steps!
823 * Daemons:: Gnus can do things behind your back.
824 * NoCeM:: How to avoid spam and other fatty foods.
825 * Undo:: Some actions can be undone.
826 * Predicate Specifiers:: Specifying predicates.
827 * Moderation:: What to do if you're a moderator.
828 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
829 * Fuzzy Matching:: What's the big fuzz?
830 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
831 * Various Various:: Things that are really various.
835 * Formatting Basics:: A formatting variable is basically a format string.
836 * Mode Line Formatting:: Some rules about mode line formatting variables.
837 * Advanced Formatting:: Modifying output in various ways.
838 * User-Defined Specs:: Having Gnus call your own functions.
839 * Formatting Fonts:: Making the formatting look colorful and nice.
840 * Positioning Point:: Moving point to a position after an operation.
841 * Tabulation:: Tabulating your output.
842 * Wide Characters:: Dealing with wide characters.
846 * Picons:: How to display pictures of what you're reading.
847 * Smileys:: Show all those happy faces the way they were meant to be shown.
848 * X-Face:: Display a funky, teensy black-and-white image.
849 * XVarious:: Other XEmacsy Gnusey variables.
853 * The problem of spam:: Some background, and some solutions
854 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
855 * SpamAssassin:: How to use external anti-spam tools.
856 * Hashcash:: Reduce spam by burning CPU time.
857 * Filtering Spam Using The Spam ELisp Package::
858 * Filtering Spam Using Statistics with spam-stat::
862 * XEmacs:: Requirements for installing under XEmacs.
863 * History:: How Gnus got where it is today.
864 * On Writing Manuals:: Why this is not a beginner's guide.
865 * Terminology:: We use really difficult, like, words here.
866 * Customization:: Tailoring Gnus to your needs.
867 * Troubleshooting:: What you might try if things do not work.
868 * Gnus Reference Guide:: Rilly, rilly technical stuff.
869 * Emacs for Heathens:: A short introduction to Emacsian terms.
870 * Frequently Asked Questions::
874 * Gnus Versions:: What Gnus versions have been released.
875 * Other Gnus Versions:: Other Gnus versions that also have been released.
876 * Why?:: What's the point of Gnus?
877 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
878 * Conformity:: Gnus tries to conform to all standards.
879 * Emacsen:: Gnus can be run on a few modern Emacsen.
880 * Gnus Development:: How Gnus is developed.
881 * Contributors:: Oodles of people.
882 * New Features:: Pointers to some of the new stuff in Gnus.
886 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
887 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
888 * Red Gnus:: Third time best---Gnus 5.4/5.5.
889 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
890 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
894 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
895 * Slow Terminal Connection:: You run a remote Emacs.
896 * Little Disk Space:: You feel that having large setup files is icky.
897 * Slow Machine:: You feel like buying a faster machine.
901 * Gnus Utility Functions:: Common functions and variable to use.
902 * Back End Interface:: How Gnus communicates with the servers.
903 * Score File Syntax:: A BNF definition of the score file standard.
904 * Headers:: How Gnus stores headers internally.
905 * Ranges:: A handy format for storing mucho numbers.
906 * Group Info:: The group info format.
907 * Extended Interactive:: Symbolic prefixes and stuff.
908 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
909 * Various File Formats:: Formats of files that Gnus use.
913 * Required Back End Functions:: Functions that must be implemented.
914 * Optional Back End Functions:: Functions that need not be implemented.
915 * Error Messaging:: How to get messages and report errors.
916 * Writing New Back Ends:: Extending old back ends.
917 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
918 * Mail-like Back Ends:: Some tips on mail back ends.
922 * Active File Format:: Information on articles and groups available.
923 * Newsgroups File Format:: Group descriptions.
927 * Keystrokes:: Entering text and executing commands.
928 * Emacs Lisp:: The built-in Emacs programming language.
934 @chapter Starting Gnus
939 If your system administrator has set things up properly, starting Gnus
940 and reading news is extremely easy---you just type @kbd{M-x gnus} in
943 @findex gnus-other-frame
944 @kindex M-x gnus-other-frame
945 If you want to start Gnus in a different frame, you can use the command
946 @kbd{M-x gnus-other-frame} instead.
948 If things do not go smoothly at startup, you have to twiddle some
949 variables in your @file{~/.gnus} file. This file is similar to
950 @file{~/.emacs}, but is read when gnus starts.
952 If you puzzle at any terms used in this manual, please refer to the
953 terminology section (@pxref{Terminology}).
956 * Finding the News:: Choosing a method for getting news.
957 * The First Time:: What does Gnus do the first time you start it?
958 * The Server is Down:: How can I read my mail then?
959 * Slave Gnusae:: You can have more than one Gnus active at a time.
960 * Fetching a Group:: Starting Gnus just to read a group.
961 * New Groups:: What is Gnus supposed to do with new groups?
962 * Changing Servers:: You may want to move from one server to another.
963 * Startup Files:: Those pesky startup files---@file{.newsrc}.
964 * Auto Save:: Recovering from a crash.
965 * The Active File:: Reading the active file over a slow line Takes Time.
966 * Startup Variables:: Other variables you might change.
970 @node Finding the News
971 @section Finding the News
974 @vindex gnus-select-method
976 The @code{gnus-select-method} variable says where Gnus should look for
977 news. This variable should be a list where the first element says
978 @dfn{how} and the second element says @dfn{where}. This method is your
979 native method. All groups not fetched with this method are
982 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
983 you want to get your daily dosage of news from, you'd say:
986 (setq gnus-select-method '(nntp "news.somewhere.edu"))
989 If you want to read directly from the local spool, say:
992 (setq gnus-select-method '(nnspool ""))
995 If you can use a local spool, you probably should, as it will almost
996 certainly be much faster. But do not use the local spool if your
997 server is running Leafnode; in this case, use @code{(nntp "localhost")}.
999 @vindex gnus-nntpserver-file
1001 @cindex @sc{nntp} server
1002 If this variable is not set, Gnus will take a look at the
1003 @code{NNTPSERVER} environment variable. If that variable isn't set,
1004 Gnus will see whether @code{gnus-nntpserver-file}
1005 (@file{/etc/nntpserver} by default) has any opinions on the matter. If
1006 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server. That's a long shot, though.
1008 @vindex gnus-nntp-server
1009 If @code{gnus-nntp-server} is set, this variable will override
1010 @code{gnus-select-method}. You should therefore set
1011 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1013 @vindex gnus-secondary-servers
1014 @vindex gnus-nntp-server
1015 You can also make Gnus prompt you interactively for the name of an
1016 @sc{nntp} server. If you give a non-numerical prefix to @code{gnus}
1017 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
1018 in the @code{gnus-secondary-servers} list (if any). You can also just
1019 type in the name of any server you feel like visiting. (Note that this
1020 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1021 gnus} later in the same Emacs session, Gnus will contact the same
1024 @findex gnus-group-browse-foreign-server
1026 However, if you use one @sc{nntp} server regularly and are just
1027 interested in a couple of groups from a different server, you would be
1028 better served by using the @kbd{B} command in the group buffer. It will
1029 let you have a look at what groups are available, and you can subscribe
1030 to any of the groups you want to. This also makes @file{.newsrc}
1031 maintenance much tidier. @xref{Foreign Groups}.
1033 @vindex gnus-secondary-select-methods
1035 A slightly different approach to foreign groups is to set the
1036 @code{gnus-secondary-select-methods} variable. The select methods
1037 listed in this variable are in many ways just as native as the
1038 @code{gnus-select-method} server. They will also be queried for active
1039 files during startup (if that's required), and new newsgroups that
1040 appear on these servers will be subscribed (or not) just as native
1043 For instance, if you use the @code{nnmbox} back end to read your mail,
1044 you would typically set this variable to
1047 (setq gnus-secondary-select-methods '((nnmbox "")))
1051 @node The First Time
1052 @section The First Time
1053 @cindex first time usage
1055 If no startup files exist, Gnus will try to determine what groups should
1056 be subscribed by default.
1058 @vindex gnus-default-subscribed-newsgroups
1059 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
1060 will subscribe you to just those groups in that list, leaving the rest
1061 killed. Your system administrator should have set this variable to
1064 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
1065 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1066 here as @dfn{whatever Lars thinks you should read}.)
1068 You'll also be subscribed to the Gnus documentation group, which should
1069 help you with most common problems.
1071 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
1072 use the normal functions for handling new groups, and not do anything
1076 @node The Server is Down
1077 @section The Server is Down
1078 @cindex server errors
1080 If the default server is down, Gnus will understandably have some
1081 problems starting. However, if you have some mail groups in addition to
1082 the news groups, you may want to start Gnus anyway.
1084 Gnus, being the trusting sort of program, will ask whether to proceed
1085 without a native select method if that server can't be contacted. This
1086 will happen whether the server doesn't actually exist (i.e., you have
1087 given the wrong address) or the server has just momentarily taken ill
1088 for some reason or other. If you decide to continue and have no foreign
1089 groups, you'll find it difficult to actually do anything in the group
1090 buffer. But, hey, that's your problem. Blllrph!
1092 @findex gnus-no-server
1093 @kindex M-x gnus-no-server
1095 If you know that the server is definitely down, or you just want to read
1096 your mail without bothering with the server at all, you can use the
1097 @code{gnus-no-server} command to start Gnus. That might come in handy
1098 if you're in a hurry as well. This command will not attempt to contact
1099 your primary server---instead, it will just activate all groups on level
1100 1 and 2. (You should preferably keep no native groups on those two
1101 levels.) Also @pxref{Group Levels}.
1105 @section Slave Gnusae
1108 You might want to run more than one Emacs with more than one Gnus at the
1109 same time. If you are using different @file{.newsrc} files (e.g., if you
1110 are using the two different Gnusae to read from two different servers),
1111 that is no problem whatsoever. You just do it.
1113 The problem appears when you want to run two Gnusae that use the same
1114 @file{.newsrc} file.
1116 To work around that problem some, we here at the Think-Tank at the Gnus
1117 Towers have come up with a new concept: @dfn{Masters} and
1118 @dfn{slaves}. (We have applied for a patent on this concept, and have
1119 taken out a copyright on those words. If you wish to use those words in
1120 conjunction with each other, you have to send $1 per usage instance to
1121 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1122 Applications}) will be much more expensive, of course.)
1125 Anyway, you start one Gnus up the normal way with @kbd{M-x gnus} (or
1126 however you do it). Each subsequent slave Gnusae should be started with
1127 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1128 files, but instead save @dfn{slave files} that contain information only
1129 on what groups have been read in the slave session. When a master Gnus
1130 starts, it will read (and delete) these slave files, incorporating all
1131 information from them. (The slave files will be read in the sequence
1132 they were created, so the latest changes will have precedence.)
1134 Information from the slave files has, of course, precedence over the
1135 information in the normal (i.e., master) @file{.newsrc} file.
1137 If the @file{.newsrc*} files have not been saved in the master when the
1138 slave starts, you may be prompted as to whether to read an auto-save
1139 file. If you answer "yes", the unsaved changes to the master will be
1140 incorporated into the slave. If you answer "no", the slave may see some
1141 messages as unread that have been read in the master.
1143 @node Fetching a Group
1144 @section Fetching a Group
1145 @cindex fetching a group
1147 @findex gnus-fetch-group
1148 It is sometimes convenient to be able to just say ``I want to read this
1149 group and I don't care whether Gnus has been started or not''. This is
1150 perhaps more useful for people who write code than for users, but the
1151 command @code{gnus-fetch-group} provides this functionality in any case.
1152 It takes the group name as a parameter.
1158 @cindex subscription
1160 @vindex gnus-check-new-newsgroups
1161 If you are satisfied that you really never want to see any new groups,
1162 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1163 also save you some time at startup. Even if this variable is
1164 @code{nil}, you can always subscribe to the new groups just by pressing
1165 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1166 is @code{ask-server} by default. If you set this variable to
1167 @code{always}, then Gnus will query the back ends for new groups even
1168 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1171 * Checking New Groups:: Determining what groups are new.
1172 * Subscription Methods:: What Gnus should do with new groups.
1173 * Filtering New Groups:: Making Gnus ignore certain new groups.
1177 @node Checking New Groups
1178 @subsection Checking New Groups
1180 Gnus normally determines whether a group is new or not by comparing the
1181 list of groups from the active file(s) with the lists of subscribed and
1182 dead groups. This isn't a particularly fast method. If
1183 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
1184 server for new groups since the last time. This is both faster and
1185 cheaper. This also means that you can get rid of the list of killed
1186 groups altogether, so you may set @code{gnus-save-killed-list} to
1187 @code{nil}, which will save time both at startup, at exit, and all over.
1188 Saves disk space, too. Why isn't this the default, then?
1189 Unfortunately, not all servers support this command.
1191 I bet I know what you're thinking now: How do I find out whether my
1192 server supports @code{ask-server}? No? Good, because I don't have a
1193 fail-safe answer. I would suggest just setting this variable to
1194 @code{ask-server} and see whether any new groups appear within the next
1195 few days. If any do, then it works. If none do, then it doesn't
1196 work. I could write a function to make Gnus guess whether the server
1197 supports @code{ask-server}, but it would just be a guess. So I won't.
1198 You could @code{telnet} to the server and say @code{HELP} and see
1199 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1200 it does, then it might work. (But there are servers that lists
1201 @samp{NEWGROUPS} without supporting the function properly.)
1203 This variable can also be a list of select methods. If so, Gnus will
1204 issue an @code{ask-server} command to each of the select methods, and
1205 subscribe them (or not) using the normal methods. This might be handy
1206 if you are monitoring a few servers for new groups. A side effect is
1207 that startup will take much longer, so you can meditate while waiting.
1208 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1211 @node Subscription Methods
1212 @subsection Subscription Methods
1214 @vindex gnus-subscribe-newsgroup-method
1215 What Gnus does when it encounters a new group is determined by the
1216 @code{gnus-subscribe-newsgroup-method} variable.
1218 This variable should contain a function. This function will be called
1219 with the name of the new group as the only parameter.
1221 Some handy pre-fab functions are:
1225 @item gnus-subscribe-zombies
1226 @vindex gnus-subscribe-zombies
1227 Make all new groups zombies. This is the default. You can browse the
1228 zombies later (with @kbd{A z}) and either kill them all off properly
1229 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1231 @item gnus-subscribe-randomly
1232 @vindex gnus-subscribe-randomly
1233 Subscribe all new groups in arbitrary order. This really means that all
1234 new groups will be added at ``the top'' of the group buffer.
1236 @item gnus-subscribe-alphabetically
1237 @vindex gnus-subscribe-alphabetically
1238 Subscribe all new groups in alphabetical order.
1240 @item gnus-subscribe-hierarchically
1241 @vindex gnus-subscribe-hierarchically
1242 Subscribe all new groups hierarchically. The difference between this
1243 function and @code{gnus-subscribe-alphabetically} is slight.
1244 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1245 alphabetical fashion, while this function will enter groups into its
1246 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1247 @samp{comp} hierarchy, this function will not mess that configuration
1248 up. Or something like that.
1250 @item gnus-subscribe-interactively
1251 @vindex gnus-subscribe-interactively
1252 Subscribe new groups interactively. This means that Gnus will ask
1253 you about @strong{all} new groups. The groups you choose to subscribe
1254 to will be subscribed hierarchically.
1256 @item gnus-subscribe-killed
1257 @vindex gnus-subscribe-killed
1258 Kill all new groups.
1260 @item gnus-subscribe-topics
1261 @vindex gnus-subscribe-topics
1262 Put the groups into the topic that has a matching @code{subscribe} topic
1263 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1264 topic parameter that looks like
1270 will mean that all groups that match that regex will be subscribed under
1273 If no topics match the groups, the groups will be subscribed in the
1278 @vindex gnus-subscribe-hierarchical-interactive
1279 A closely related variable is
1280 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1281 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
1282 hierarchical fashion whether to subscribe to new groups or not. Gnus
1283 will ask you for each sub-hierarchy whether you want to descend the
1286 One common mistake is to set the variable a few paragraphs above
1287 (@code{gnus-subscribe-newsgroup-method}) to
1288 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1289 will not work. This is ga-ga. So don't do it.
1292 @node Filtering New Groups
1293 @subsection Filtering New Groups
1295 A nice and portable way to control which new newsgroups should be
1296 subscribed (or ignored) is to put an @dfn{options} line at the start of
1297 the @file{.newsrc} file. Here's an example:
1300 options -n !alt.all !rec.all sci.all
1303 @vindex gnus-subscribe-options-newsgroup-method
1304 This line obviously belongs to a serious-minded intellectual scientific
1305 person (or she may just be plain old boring), because it says that all
1306 groups that have names beginning with @samp{alt} and @samp{rec} should
1307 be ignored, and all groups with names beginning with @samp{sci} should
1308 be subscribed. Gnus will not use the normal subscription method for
1309 subscribing these groups.
1310 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1311 variable defaults to @code{gnus-subscribe-alphabetically}.
1313 @vindex gnus-options-not-subscribe
1314 @vindex gnus-options-subscribe
1315 If you don't want to mess with your @file{.newsrc} file, you can just
1316 set the two variables @code{gnus-options-subscribe} and
1317 @code{gnus-options-not-subscribe}. These two variables do exactly the
1318 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1319 and if the new group matches the former, it will be unconditionally
1320 subscribed, and if it matches the latter, it will be ignored.
1322 @vindex gnus-auto-subscribed-groups
1323 Yet another variable that meddles here is
1324 @code{gnus-auto-subscribed-groups}. It works exactly like
1325 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
1326 thought it would be nice to have two of these. This variable is more
1327 meant for setting some ground rules, while the other variable is used
1328 more for user fiddling. By default this variable makes all new groups
1329 that come from mail back ends (@code{nnml}, @code{nnbabyl},
1330 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir})
1331 subscribed. If you don't like that, just set this variable to
1334 New groups that match this regexp are subscribed using
1335 @code{gnus-subscribe-options-newsgroup-method}.
1338 @node Changing Servers
1339 @section Changing Servers
1340 @cindex changing servers
1342 Sometimes it is necessary to move from one @sc{nntp} server to another.
1343 This happens very rarely, but perhaps you change jobs, or one server is
1344 very flaky and you want to use another.
1346 Changing the server is pretty easy, right? You just change
1347 @code{gnus-select-method} to point to the new server?
1351 Article numbers are not (in any way) kept synchronized between different
1352 @sc{nntp} servers, and the only way Gnus keeps track of what articles
1353 you have read is by keeping track of article numbers. So when you
1354 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1357 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1358 file from one server to another. They all have one thing in
1359 common---they take a looong time to run. You don't want to use these
1360 functions more than absolutely necessary.
1362 @kindex M-x gnus-change-server
1363 @findex gnus-change-server
1364 If you have access to both servers, Gnus can request the headers for all
1365 the articles you have read and compare @code{Message-ID}s and map the
1366 article numbers of the read articles and article marks. The @kbd{M-x
1367 gnus-change-server} command will do this for all your native groups. It
1368 will prompt for the method you want to move to.
1370 @kindex M-x gnus-group-move-group-to-server
1371 @findex gnus-group-move-group-to-server
1372 You can also move individual groups with the @kbd{M-x
1373 gnus-group-move-group-to-server} command. This is useful if you want to
1374 move a (foreign) group from one server to another.
1376 @kindex M-x gnus-group-clear-data-on-native-groups
1377 @findex gnus-group-clear-data-on-native-groups
1378 If you don't have access to both the old and new server, all your marks
1379 and read ranges have become worthless. You can use the @kbd{M-x
1380 gnus-group-clear-data-on-native-groups} command to clear out all data
1381 that you have on your native groups. Use with caution.
1383 @kindex M-x gnus-group-clear-data
1384 @findex gnus-group-clear-data
1385 Clear the data from the current group only---nix out marks and the
1386 list of read articles (@code{gnus-group-clear-data}).
1388 After changing servers, you @strong{must} move the cache hierarchy away,
1389 since the cached articles will have wrong article numbers, which will
1390 affect which articles Gnus thinks are read.
1391 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1392 to have it done automatically; for @code{gnus-group-clear-data}, you
1393 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1394 cache for all groups).
1398 @section Startup Files
1399 @cindex startup files
1404 Now, you all know about the @file{.newsrc} file. All subscription
1405 information is traditionally stored in this file.
1407 Things got a bit more complicated with @sc{gnus}. In addition to
1408 keeping the @file{.newsrc} file updated, it also used a file called
1409 @file{.newsrc.el} for storing all the information that didn't fit into
1410 the @file{.newsrc} file. (Actually, it also duplicated everything in
1411 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1412 files was the most recently saved, which enabled people to swap between
1413 @sc{gnus} and other newsreaders.
1415 That was kinda silly, so Gnus went one better: In addition to the
1416 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1417 @file{.newsrc.eld}. It will read whichever of these files that are most
1418 recent, but it will never write a @file{.newsrc.el} file. You should
1419 never delete the @file{.newsrc.eld} file---it contains much information
1420 not stored in the @file{.newsrc} file.
1422 @vindex gnus-save-newsrc-file
1423 @vindex gnus-read-newsrc-file
1424 You can turn off writing the @file{.newsrc} file by setting
1425 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1426 the file and save some space, as well as exiting from Gnus faster.
1427 However, this will make it impossible to use other newsreaders than
1428 Gnus. But hey, who would want to, right? Similarly, setting
1429 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
1430 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1431 convenient if you have a tendency to use Netscape once in a while.
1433 @vindex gnus-save-killed-list
1434 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1435 will not save the list of killed groups to the startup file. This will
1436 save both time (when starting and quitting) and space (on disk). It
1437 will also mean that Gnus has no record of what groups are new or old,
1438 so the automatic new groups subscription methods become meaningless.
1439 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1440 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1441 Groups}). This variable can also be a regular expression. If that's
1442 the case, remove all groups that do not match this regexp before
1443 saving. This can be useful in certain obscure situations that involve
1444 several servers where not all servers support @code{ask-server}.
1446 @vindex gnus-startup-file
1447 The @code{gnus-startup-file} variable says where the startup files are.
1448 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1449 file being whatever that one is, with a @samp{.eld} appended.
1451 @vindex gnus-save-newsrc-hook
1452 @vindex gnus-save-quick-newsrc-hook
1453 @vindex gnus-save-standard-newsrc-hook
1454 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1455 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1456 saving the @file{.newsrc.eld} file, and
1457 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1458 @file{.newsrc} file. The latter two are commonly used to turn version
1459 control on or off. Version control is on by default when saving the
1460 startup files. If you want to turn backup creation off, say something like:
1463 (defun turn-off-backup ()
1464 (set (make-local-variable 'backup-inhibited) t))
1466 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1467 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1470 @vindex gnus-init-file
1471 @vindex gnus-site-init-file
1472 When Gnus starts, it will read the @code{gnus-site-init-file}
1473 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1474 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1475 and can be used to avoid cluttering your @file{~/.emacs} and
1476 @file{site-init} files with Gnus stuff. Gnus will also check for files
1477 with the same names as these, but with @file{.elc} and @file{.el}
1478 suffixes. In other words, if you have set @code{gnus-init-file} to
1479 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1480 and finally @file{~/.gnus} (in this order).
1486 @cindex dribble file
1489 Whenever you do something that changes the Gnus data (reading articles,
1490 catching up, killing/subscribing groups), the change is added to a
1491 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1492 Emacs way. If your Emacs should crash before you have saved the
1493 @file{.newsrc} files, all changes you have made can be recovered from
1496 If Gnus detects this file at startup, it will ask the user whether to
1497 read it. The auto save file is deleted whenever the real startup file is
1500 @vindex gnus-use-dribble-file
1501 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
1502 maintain a dribble buffer. The default is @code{t}.
1504 @vindex gnus-dribble-directory
1505 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1506 this variable is @code{nil}, which it is by default, Gnus will dribble
1507 into the directory where the @file{.newsrc} file is located. (This is
1508 normally the user's home directory.) The dribble file will get the same
1509 file permissions as the @file{.newsrc} file.
1511 @vindex gnus-always-read-dribble-file
1512 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1513 read the dribble file on startup without querying the user.
1516 @node The Active File
1517 @section The Active File
1519 @cindex ignored groups
1521 When Gnus starts, or indeed whenever it tries to determine whether new
1522 articles have arrived, it reads the active file. This is a very large
1523 file that lists all the active groups and articles on the server.
1525 @vindex gnus-ignored-newsgroups
1526 Before examining the active file, Gnus deletes all lines that match the
1527 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1528 any groups with bogus names, but you can use this variable to make Gnus
1529 ignore hierarchies you aren't ever interested in. However, this is not
1530 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1531 Groups} for an overview of other variables that can be used instead.
1534 @c @code{nil} by default, and will slow down active file handling somewhat
1535 @c if you set it to anything else.
1537 @vindex gnus-read-active-file
1539 The active file can be rather Huge, so if you have a slow network, you
1540 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
1541 reading the active file. This variable is @code{some} by default.
1543 Gnus will try to make do by getting information just on the groups that
1544 you actually subscribe to.
1546 Note that if you subscribe to lots and lots of groups, setting this
1547 variable to @code{nil} will probably make Gnus slower, not faster. At
1548 present, having this variable @code{nil} will slow Gnus down
1549 considerably, unless you read news over a 2400 baud modem.
1551 This variable can also have the value @code{some}. Gnus will then
1552 attempt to read active info only on the subscribed groups. On some
1553 servers this is quite fast (on sparkling, brand new INN servers that
1554 support the @code{LIST ACTIVE group} command), on others this isn't fast
1555 at all. In any case, @code{some} should be faster than @code{nil}, and
1556 is certainly faster than @code{t} over slow lines.
1558 Some news servers (old versions of Leafnode and old versions of INN, for
1559 instance) do not support the @code{LIST ACTIVE group}. For these
1560 servers, @code{nil} is probably the most efficient value for this
1563 If this variable is @code{nil}, Gnus will ask for group info in total
1564 lock-step, which isn't very fast. If it is @code{some} and you use an
1565 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
1566 read all the replies in one swoop. This will normally result in better
1567 performance, but if the server does not support the aforementioned
1568 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1570 If you think that starting up Gnus takes too long, try all the three
1571 different values for this variable and see what works best for you.
1573 In any case, if you use @code{some} or @code{nil}, you should definitely
1574 kill all groups that you aren't interested in to speed things up.
1576 Note that this variable also affects active file retrieval from
1577 secondary select methods.
1580 @node Startup Variables
1581 @section Startup Variables
1585 @item gnus-load-hook
1586 @vindex gnus-load-hook
1587 A hook run while Gnus is being loaded. Note that this hook will
1588 normally be run just once in each Emacs session, no matter how many
1589 times you start Gnus.
1591 @item gnus-before-startup-hook
1592 @vindex gnus-before-startup-hook
1593 A hook run after starting up Gnus successfully.
1595 @item gnus-startup-hook
1596 @vindex gnus-startup-hook
1597 A hook run as the very last thing after starting up Gnus
1599 @item gnus-started-hook
1600 @vindex gnus-started-hook
1601 A hook that is run as the very last thing after starting up Gnus
1604 @item gnus-setup-news-hook
1605 @vindex gnus-setup-news-hook
1606 A hook that is run after reading the @file{.newsrc} file(s), but before
1607 generating the group buffer.
1609 @item gnus-check-bogus-newsgroups
1610 @vindex gnus-check-bogus-newsgroups
1611 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1612 startup. A @dfn{bogus group} is a group that you have in your
1613 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1614 bogus groups can take quite a while, so to save time and resources it's
1615 best to leave this option off, and do the checking for bogus groups once
1616 in a while from the group buffer instead (@pxref{Group Maintenance}).
1618 @item gnus-inhibit-startup-message
1619 @vindex gnus-inhibit-startup-message
1620 If non-@code{nil}, the startup message won't be displayed. That way,
1621 your boss might not notice as easily that you are reading news instead
1622 of doing your job. Note that this variable is used before
1623 @file{.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1625 @item gnus-no-groups-message
1626 @vindex gnus-no-groups-message
1627 Message displayed by Gnus when no groups are available.
1629 @item gnus-play-startup-jingle
1630 @vindex gnus-play-startup-jingle
1631 If non-@code{nil}, play the Gnus jingle at startup.
1633 @item gnus-startup-jingle
1634 @vindex gnus-startup-jingle
1635 Jingle to be played if the above variable is non-@code{nil}. The
1636 default is @samp{Tuxedomoon.Jingle4.au}.
1642 @chapter Group Buffer
1643 @cindex group buffer
1645 @c Alex Schroeder suggests to rearrange this as follows:
1647 @c <kensanata> ok, just save it for reference. I'll go to bed in a minute.
1648 @c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1649 @c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1650 @c 7. Group Score, 8. Group Buffer Format
1651 @c <kensanata> Group Levels should have more information on levels 5 to 9. I
1652 @c suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1653 @c <kensanata> First, "Gnus considers groups... (default 9)."
1654 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1655 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1656 @c <kensanata> Then expand the next paragraph or add some more to it.
1657 @c This short one sentence explains levels 1 and 2, therefore I understand
1658 @c that I should keep important news at 3 and boring news at 4.
1659 @c Say so! Then go on to explain why I should bother with levels 6 to 9.
1660 @c Maybe keep those that you don't want to read temporarily at 6,
1661 @c those that you never want to read at 8, those that offend your
1662 @c human rights at 9...
1665 The @dfn{group buffer} lists all (or parts) of the available groups. It
1666 is the first buffer shown when Gnus starts, and will never be killed as
1667 long as Gnus is active.
1671 \gnusfigure{The Group Buffer}{320}{
1672 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1673 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1674 \put(120,38){\vector(1,2){10}}
1675 \put(40,60){\makebox(0,0)[r]{Mode line}}
1676 \put(40,58){\vector(1,0){30}}
1677 \put(200,28){\makebox(0,0)[t]{Native select method}}
1678 \put(200,26){\vector(-1,2){15}}
1684 * Group Buffer Format:: Information listed and how you can change it.
1685 * Group Maneuvering:: Commands for moving in the group buffer.
1686 * Selecting a Group:: Actually reading news.
1687 * Subscription Commands:: Unsubscribing, killing, subscribing.
1688 * Group Data:: Changing the info for a group.
1689 * Group Levels:: Levels? What are those, then?
1690 * Group Score:: A mechanism for finding out what groups you like.
1691 * Marking Groups:: You can mark groups for later processing.
1692 * Foreign Groups:: Creating and editing groups.
1693 * Group Parameters:: Each group may have different parameters set.
1694 * Listing Groups:: Gnus can list various subsets of the groups.
1695 * Sorting Groups:: Re-arrange the group order.
1696 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1697 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1698 * Exiting Gnus:: Stop reading news and get some work done.
1699 * Group Topics:: A folding group mode divided into topics.
1700 * Misc Group Stuff:: Other stuff that you can to do.
1704 @node Group Buffer Format
1705 @section Group Buffer Format
1708 * Group Line Specification:: Deciding how the group buffer is to look.
1709 * Group Modeline Specification:: The group buffer modeline.
1710 * Group Highlighting:: Having nice colors in the group buffer.
1714 @node Group Line Specification
1715 @subsection Group Line Specification
1716 @cindex group buffer format
1718 The default format of the group buffer is nice and dull, but you can
1719 make it as exciting and ugly as you feel like.
1721 Here's a couple of example group lines:
1724 25: news.announce.newusers
1725 * 0: alt.fan.andrea-dworkin
1730 You can see that there are 25 unread articles in
1731 @samp{news.announce.newusers}. There are no unread articles, but some
1732 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1733 asterisk at the beginning of the line?).
1735 @vindex gnus-group-line-format
1736 You can change that format to whatever you want by fiddling with the
1737 @code{gnus-group-line-format} variable. This variable works along the
1738 lines of a @code{format} specification, which is pretty much the same as
1739 a @code{printf} specifications, for those of you who use (feh!) C.
1740 @xref{Formatting Variables}.
1742 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1744 There should always be a colon on the line; the cursor always moves to
1745 the colon after performing an operation. @xref{Positioning
1746 Point}. Nothing else is required---not even the group name. All
1747 displayed text is just window dressing, and is never examined by Gnus.
1748 Gnus stores all real information it needs using text properties.
1750 (Note that if you make a really strange, wonderful, spreadsheet-like
1751 layout, everybody will believe you are hard at work with the accounting
1752 instead of wasting time reading news.)
1754 Here's a list of all available format characters:
1759 An asterisk if the group only has marked articles.
1762 Whether the group is subscribed.
1765 Level of subscribedness.
1768 Number of unread articles.
1771 Number of dormant articles.
1774 Number of ticked articles.
1777 Number of read articles.
1780 Number of unseen articles.
1783 Estimated total number of articles. (This is really @var{max-number}
1784 minus @var{min-number} plus 1.)
1786 Gnus uses this estimation because the @sc{nntp} protocol provides
1787 efficient access to @var{max-number} and @var{min-number} but getting
1788 the true unread message count is not possible efficiently. For
1789 hysterical raisins, even the mail back ends, where the true number of
1790 unread messages might be available efficiently, use the same limited
1791 interface. To remove this restriction from Gnus means that the back
1792 end interface has to be changed, which is not an easy job. If you
1793 want to work on this, please contact the Gnus mailing list.
1796 Number of unread, unticked, non-dormant articles.
1799 Number of ticked and dormant articles.
1808 Group comment (@pxref{Group Parameters}) or group name if there is no
1809 comment element in the group parameters.
1812 Newsgroup description.
1815 @samp{m} if moderated.
1818 @samp{(m)} if moderated.
1824 If the summary buffer for the group is open or not.
1830 A string that looks like @samp{<%s:%n>} if a foreign select method is
1834 Indentation based on the level of the topic (@pxref{Group Topics}).
1837 @vindex gnus-group-uncollapsed-levels
1838 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1839 variable says how many levels to leave at the end of the group name.
1840 The default is 1---this will mean that group names like
1841 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1844 @vindex gnus-new-mail-mark
1846 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1850 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1853 A string that says when you last read the group (@pxref{Group
1857 User defined specifier. The next character in the format string should
1858 be a letter. Gnus will call the function
1859 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1860 following @samp{%u}. The function will be passed a single dummy
1861 parameter as argument. The function should return a string, which will
1862 be inserted into the buffer just like information from any other
1867 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1868 if no info is available---for instance, if it is a non-activated foreign
1869 group, or a bogus native group.
1872 @node Group Modeline Specification
1873 @subsection Group Modeline Specification
1874 @cindex group modeline
1876 @vindex gnus-group-mode-line-format
1877 The mode line can be changed by setting
1878 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1879 doesn't understand that many format specifiers:
1883 The native news server.
1885 The native select method.
1889 @node Group Highlighting
1890 @subsection Group Highlighting
1891 @cindex highlighting
1892 @cindex group highlighting
1894 @vindex gnus-group-highlight
1895 Highlighting in the group buffer is controlled by the
1896 @code{gnus-group-highlight} variable. This is an alist with elements
1897 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1898 something non-@code{nil}, the @var{face} will be used on the line.
1900 Here's an example value for this variable that might look nice if the
1904 (cond (window-system
1905 (setq custom-background-mode 'light)
1906 (defface my-group-face-1
1907 '((t (:foreground "Red" :bold t))) "First group face")
1908 (defface my-group-face-2
1909 '((t (:foreground "DarkSeaGreen4" :bold t))) "Second group face")
1910 (defface my-group-face-3
1911 '((t (:foreground "Green4" :bold t))) "Third group face")
1912 (defface my-group-face-4
1913 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1914 (defface my-group-face-5
1915 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1917 (setq gnus-group-highlight
1918 '(((> unread 200) . my-group-face-1)
1919 ((and (< level 3) (zerop unread)) . my-group-face-2)
1920 ((< level 3) . my-group-face-3)
1921 ((zerop unread) . my-group-face-4)
1922 (t . my-group-face-5)))
1925 Also @pxref{Faces and Fonts}.
1927 Variables that are dynamically bound when the forms are evaluated
1934 The number of unread articles in the group.
1938 Whether the group is a mail group.
1940 The level of the group.
1942 The score of the group.
1944 The number of ticked articles in the group.
1946 The total number of articles in the group. Or rather, MAX-NUMBER minus
1947 MIN-NUMBER plus one.
1949 When using the topic minor mode, this variable is bound to the current
1950 topic being inserted.
1953 When the forms are @code{eval}ed, point is at the beginning of the line
1954 of the group in question, so you can use many of the normal Gnus
1955 functions for snarfing info on the group.
1957 @vindex gnus-group-update-hook
1958 @findex gnus-group-highlight-line
1959 @code{gnus-group-update-hook} is called when a group line is changed.
1960 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1961 calls @code{gnus-group-highlight-line} by default.
1964 @node Group Maneuvering
1965 @section Group Maneuvering
1966 @cindex group movement
1968 All movement commands understand the numeric prefix and will behave as
1969 expected, hopefully.
1975 @findex gnus-group-next-unread-group
1976 Go to the next group that has unread articles
1977 (@code{gnus-group-next-unread-group}).
1983 @findex gnus-group-prev-unread-group
1984 Go to the previous group that has unread articles
1985 (@code{gnus-group-prev-unread-group}).
1989 @findex gnus-group-next-group
1990 Go to the next group (@code{gnus-group-next-group}).
1994 @findex gnus-group-prev-group
1995 Go to the previous group (@code{gnus-group-prev-group}).
1999 @findex gnus-group-next-unread-group-same-level
2000 Go to the next unread group on the same (or lower) level
2001 (@code{gnus-group-next-unread-group-same-level}).
2005 @findex gnus-group-prev-unread-group-same-level
2006 Go to the previous unread group on the same (or lower) level
2007 (@code{gnus-group-prev-unread-group-same-level}).
2010 Three commands for jumping to groups:
2016 @findex gnus-group-jump-to-group
2017 Jump to a group (and make it visible if it isn't already)
2018 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
2023 @findex gnus-group-best-unread-group
2024 Jump to the unread group with the lowest level
2025 (@code{gnus-group-best-unread-group}).
2029 @findex gnus-group-first-unread-group
2030 Jump to the first group with unread articles
2031 (@code{gnus-group-first-unread-group}).
2034 @vindex gnus-group-goto-unread
2035 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2036 commands will move to the next group, not the next unread group. Even
2037 the commands that say they move to the next unread group. The default
2041 @node Selecting a Group
2042 @section Selecting a Group
2043 @cindex group selection
2048 @kindex SPACE (Group)
2049 @findex gnus-group-read-group
2050 Select the current group, switch to the summary buffer and display the
2051 first unread article (@code{gnus-group-read-group}). If there are no
2052 unread articles in the group, or if you give a non-numerical prefix to
2053 this command, Gnus will offer to fetch all the old articles in this
2054 group from the server. If you give a numerical prefix @var{N}, @var{N}
2055 determines the number of articles Gnus will fetch. If @var{N} is
2056 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
2057 negative, Gnus fetches the @code{abs(@var{N})} oldest articles.
2059 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2060 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2061 - 4 2 SPC} fetches the 42 oldest ones.
2063 When you are in the group (in the Summary buffer), you can type
2064 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2069 @findex gnus-group-select-group
2070 Select the current group and switch to the summary buffer
2071 (@code{gnus-group-select-group}). Takes the same arguments as
2072 @code{gnus-group-read-group}---the only difference is that this command
2073 does not display the first unread article automatically upon group
2077 @kindex M-RET (Group)
2078 @findex gnus-group-quick-select-group
2079 This does the same as the command above, but tries to do it with the
2080 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
2081 scoring/killing will be performed, there will be no highlights and no
2082 expunging. This might be useful if you're in a real hurry and have to
2083 enter some humongous group. If you give a 0 prefix to this command
2084 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
2085 which is useful if you want to toggle threading before generating the
2086 summary buffer (@pxref{Summary Generation Commands}).
2089 @kindex M-SPACE (Group)
2090 @findex gnus-group-visible-select-group
2091 This is yet one more command that does the same as the @kbd{RET}
2092 command, but this one does it without expunging and hiding dormants
2093 (@code{gnus-group-visible-select-group}).
2096 @kindex C-M-RET (Group)
2097 @findex gnus-group-select-group-ephemerally
2098 Finally, this command selects the current group ephemerally without
2099 doing any processing of its contents
2100 (@code{gnus-group-select-group-ephemerally}). Even threading has been
2101 turned off. Everything you do in the group after selecting it in this
2102 manner will have no permanent effects.
2106 @vindex gnus-large-newsgroup
2107 The @code{gnus-large-newsgroup} variable says what Gnus should consider
2108 to be a big group. This is 200 by default. If the group has more
2109 (unread and/or ticked) articles than this, Gnus will query the user
2110 before entering the group. The user can then specify how many articles
2111 should be fetched from the server. If the user specifies a negative
2112 number (@code{-n}), the @code{n} oldest articles will be fetched. If it
2113 is positive, the @code{n} articles that have arrived most recently will
2116 @vindex gnus-select-group-hook
2117 @vindex gnus-auto-select-first
2118 @vindex gnus-auto-select-subject
2119 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2120 automatically when entering a group with the @kbd{SPACE} command.
2121 Which article this is is controlled by the
2122 @code{gnus-auto-select-subject} variable. Valid values for this
2128 Place point on the subject line of the first unread article.
2131 Place point on the subject line of the first article.
2134 Place point on the subject line of the first unseen article.
2136 @item unseen-or-unread
2137 Place point on the subject line of the first unseen article, and if
2138 there is no such article, place point on the subject line of the first
2142 Place point on the subject line of the highest-scored unread article.
2146 This variable can also be a function. In that case, that function
2147 will be called to place point on a subject line.
2149 If you want to prevent automatic selection in some group (say, in a
2150 binary group with Huge articles) you can set the
2151 @code{gnus-auto-select-first} variable to @code{nil} in
2152 @code{gnus-select-group-hook}, which is called when a group is
2156 @node Subscription Commands
2157 @section Subscription Commands
2158 @cindex subscription
2166 @findex gnus-group-unsubscribe-current-group
2167 @c @icon{gnus-group-unsubscribe}
2168 Toggle subscription to the current group
2169 (@code{gnus-group-unsubscribe-current-group}).
2175 @findex gnus-group-unsubscribe-group
2176 Prompt for a group to subscribe, and then subscribe it. If it was
2177 subscribed already, unsubscribe it instead
2178 (@code{gnus-group-unsubscribe-group}).
2184 @findex gnus-group-kill-group
2185 @c @icon{gnus-group-kill-group}
2186 Kill the current group (@code{gnus-group-kill-group}).
2192 @findex gnus-group-yank-group
2193 Yank the last killed group (@code{gnus-group-yank-group}).
2196 @kindex C-x C-t (Group)
2197 @findex gnus-group-transpose-groups
2198 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2199 really a subscription command, but you can use it instead of a
2200 kill-and-yank sequence sometimes.
2206 @findex gnus-group-kill-region
2207 Kill all groups in the region (@code{gnus-group-kill-region}).
2211 @findex gnus-group-kill-all-zombies
2212 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2215 @kindex S C-k (Group)
2216 @findex gnus-group-kill-level
2217 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2218 These groups can't be yanked back after killing, so this command should
2219 be used with some caution. The only time where this command comes in
2220 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2221 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2222 kill off all unsubscribed groups that do not have message numbers in the
2223 @file{.newsrc} file.
2227 Also @pxref{Group Levels}.
2237 @findex gnus-group-catchup-current
2238 @vindex gnus-group-catchup-group-hook
2239 @c @icon{gnus-group-catchup-current}
2240 Mark all unticked articles in this group as read
2241 (@code{gnus-group-catchup-current}).
2242 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2247 @findex gnus-group-catchup-current-all
2248 Mark all articles in this group, even the ticked ones, as read
2249 (@code{gnus-group-catchup-current-all}).
2253 @findex gnus-group-clear-data
2254 Clear the data from the current group---nix out marks and the list of
2255 read articles (@code{gnus-group-clear-data}).
2257 @item M-x gnus-group-clear-data-on-native-groups
2258 @kindex M-x gnus-group-clear-data-on-native-groups
2259 @findex gnus-group-clear-data-on-native-groups
2260 If you have switched from one @sc{nntp} server to another, all your marks
2261 and read ranges have become worthless. You can use this command to
2262 clear out all data that you have on your native groups. Use with
2269 @section Group Levels
2273 All groups have a level of @dfn{subscribedness}. For instance, if a
2274 group is on level 2, it is more subscribed than a group on level 5. You
2275 can ask Gnus to just list groups on a given level or lower
2276 (@pxref{Listing Groups}), or to just check for new articles in groups on
2277 a given level or lower (@pxref{Scanning New Messages}).
2279 Remember: The higher the level of the group, the less important it is.
2285 @findex gnus-group-set-current-level
2286 Set the level of the current group. If a numeric prefix is given, the
2287 next @var{n} groups will have their levels set. The user will be
2288 prompted for a level.
2291 @vindex gnus-level-killed
2292 @vindex gnus-level-zombie
2293 @vindex gnus-level-unsubscribed
2294 @vindex gnus-level-subscribed
2295 Gnus considers groups from levels 1 to
2296 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2297 @code{gnus-level-subscribed} (exclusive) and
2298 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2299 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2300 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2301 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2302 same, but zombie and killed groups have no information on what articles
2303 you have read, etc, stored. This distinction between dead and living
2304 groups isn't done because it is nice or clever, it is done purely for
2305 reasons of efficiency.
2307 It is recommended that you keep all your mail groups (if any) on quite
2308 low levels (e.g. 1 or 2).
2310 Maybe the following description of the default behavior of Gnus helps to
2311 understand what these levels are all about. By default, Gnus shows you
2312 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2313 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2314 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2315 groups are hidden, in a way.
2317 Zombie and killed groups are similar to unsubscribed groups in that they
2318 are hidden by default. But they are different from subscribed and
2319 unsubscribed groups in that Gnus doesn't ask the news server for
2320 information (number of messages, number of unread messages) on zombie
2321 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2322 aren't interested in. If most groups are killed, Gnus is faster.
2324 Why does Gnus distinguish between zombie and killed groups? Well, when
2325 a new group arrives on the server, Gnus by default makes it a zombie
2326 group. This means that you are normally not bothered with new groups,
2327 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2328 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2329 list of killed groups.)
2331 If you want to play with the level variables, you should show some care.
2332 Set them once, and don't touch them ever again. Better yet, don't touch
2333 them at all unless you know exactly what you're doing.
2335 @vindex gnus-level-default-unsubscribed
2336 @vindex gnus-level-default-subscribed
2337 Two closely related variables are @code{gnus-level-default-subscribed}
2338 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2339 which are the levels that new groups will be put on if they are
2340 (un)subscribed. These two variables should, of course, be inside the
2341 relevant valid ranges.
2343 @vindex gnus-keep-same-level
2344 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2345 will only move to groups of the same level (or lower). In
2346 particular, going from the last article in one group to the next group
2347 will go to the next group of the same level (or lower). This might be
2348 handy if you want to read the most important groups before you read the
2351 If this variable is @code{best}, Gnus will make the next newsgroup the
2352 one with the best level.
2354 @vindex gnus-group-default-list-level
2355 All groups with a level less than or equal to
2356 @code{gnus-group-default-list-level} will be listed in the group buffer
2359 @vindex gnus-group-list-inactive-groups
2360 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2361 groups will be listed along with the unread groups. This variable is
2362 @code{t} by default. If it is @code{nil}, inactive groups won't be
2365 @vindex gnus-group-use-permanent-levels
2366 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2367 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2368 use this level as the ``work'' level.
2370 @vindex gnus-activate-level
2371 Gnus will normally just activate (i. e., query the server about) groups
2372 on level @code{gnus-activate-level} or less. If you don't want to
2373 activate unsubscribed groups, for instance, you might set this variable
2374 to 5. The default is 6.
2378 @section Group Score
2383 You would normally keep important groups on high levels, but that scheme
2384 is somewhat restrictive. Don't you wish you could have Gnus sort the
2385 group buffer according to how often you read groups, perhaps? Within
2388 This is what @dfn{group score} is for. You can have Gnus assign a score
2389 to each group through the mechanism described below. You can then sort
2390 the group buffer based on this score. Alternatively, you can sort on
2391 score and then level. (Taken together, the level and the score is
2392 called the @dfn{rank} of the group. A group that is on level 4 and has
2393 a score of 1 has a higher rank than a group on level 5 that has a score
2394 of 300. (The level is the most significant part and the score is the
2395 least significant part.))
2397 @findex gnus-summary-bubble-group
2398 If you want groups you read often to get higher scores than groups you
2399 read seldom you can add the @code{gnus-summary-bubble-group} function to
2400 the @code{gnus-summary-exit-hook} hook. This will result (after
2401 sorting) in a bubbling sort of action. If you want to see that in
2402 action after each summary exit, you can add
2403 @code{gnus-group-sort-groups-by-rank} or
2404 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2405 slow things down somewhat.
2408 @node Marking Groups
2409 @section Marking Groups
2410 @cindex marking groups
2412 If you want to perform some command on several groups, and they appear
2413 subsequently in the group buffer, you would normally just give a
2414 numerical prefix to the command. Most group commands will then do your
2415 bidding on those groups.
2417 However, if the groups are not in sequential order, you can still
2418 perform a command on several groups. You simply mark the groups first
2419 with the process mark and then execute the command.
2427 @findex gnus-group-mark-group
2428 Set the mark on the current group (@code{gnus-group-mark-group}).
2434 @findex gnus-group-unmark-group
2435 Remove the mark from the current group
2436 (@code{gnus-group-unmark-group}).
2440 @findex gnus-group-unmark-all-groups
2441 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2445 @findex gnus-group-mark-region
2446 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2450 @findex gnus-group-mark-buffer
2451 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2455 @findex gnus-group-mark-regexp
2456 Mark all groups that match some regular expression
2457 (@code{gnus-group-mark-regexp}).
2460 Also @pxref{Process/Prefix}.
2462 @findex gnus-group-universal-argument
2463 If you want to execute some command on all groups that have been marked
2464 with the process mark, you can use the @kbd{M-&}
2465 (@code{gnus-group-universal-argument}) command. It will prompt you for
2466 the command to be executed.
2469 @node Foreign Groups
2470 @section Foreign Groups
2471 @cindex foreign groups
2473 Below are some group mode commands for making and editing general foreign
2474 groups, as well as commands to ease the creation of a few
2475 special-purpose groups. All these commands insert the newly created
2476 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2483 @findex gnus-group-make-group
2484 @cindex making groups
2485 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2486 for a name, a method and possibly an @dfn{address}. For an easier way
2487 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
2491 @findex gnus-group-rename-group
2492 @cindex renaming groups
2493 Rename the current group to something else
2494 (@code{gnus-group-rename-group}). This is valid only on some
2495 groups---mail groups mostly. This command might very well be quite slow
2501 @findex gnus-group-customize
2502 Customize the group parameters (@code{gnus-group-customize}).
2506 @findex gnus-group-edit-group-method
2507 @cindex renaming groups
2508 Enter a buffer where you can edit the select method of the current
2509 group (@code{gnus-group-edit-group-method}).
2513 @findex gnus-group-edit-group-parameters
2514 Enter a buffer where you can edit the group parameters
2515 (@code{gnus-group-edit-group-parameters}).
2519 @findex gnus-group-edit-group
2520 Enter a buffer where you can edit the group info
2521 (@code{gnus-group-edit-group}).
2525 @findex gnus-group-make-directory-group
2527 Make a directory group (@pxref{Directory Groups}). You will be prompted
2528 for a directory name (@code{gnus-group-make-directory-group}).
2533 @findex gnus-group-make-help-group
2534 Make the Gnus help group (@code{gnus-group-make-help-group}).
2538 @cindex (ding) archive
2539 @cindex archive group
2540 @findex gnus-group-make-archive-group
2541 @vindex gnus-group-archive-directory
2542 @vindex gnus-group-recent-archive-directory
2543 Make a Gnus archive group (@code{gnus-group-make-archive-group}). By
2544 default a group pointing to the most recent articles will be created
2545 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2546 group will be created from @code{gnus-group-archive-directory}.
2550 @findex gnus-group-make-kiboze-group
2552 Make a kiboze group. You will be prompted for a name, for a regexp to
2553 match groups to be ``included'' in the kiboze group, and a series of
2554 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2555 @xref{Kibozed Groups}.
2559 @findex gnus-group-enter-directory
2561 Read an arbitrary directory as if it were a newsgroup with the
2562 @code{nneething} back end (@code{gnus-group-enter-directory}).
2563 @xref{Anything Groups}.
2567 @findex gnus-group-make-doc-group
2568 @cindex ClariNet Briefs
2570 Make a group based on some file or other
2571 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2572 command, you will be prompted for a file name and a file type.
2573 Currently supported types are @code{mbox}, @code{babyl},
2574 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2575 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2576 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2577 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}. If
2578 you run this command without a prefix, Gnus will guess at the file
2579 type. @xref{Document Groups}.
2583 @vindex gnus-useful-groups
2584 @findex gnus-group-make-useful-group
2585 Create one of the groups mentioned in @code{gnus-useful-groups}
2586 (@code{gnus-group-make-useful-group}).
2590 @findex gnus-group-make-web-group
2594 Make an ephemeral group based on a web search
2595 (@code{gnus-group-make-web-group}). If you give a prefix to this
2596 command, make a solid group instead. You will be prompted for the
2597 search engine type and the search string. Valid search engine types
2598 include @code{google}, @code{dejanews}, and @code{gmane}.
2599 @xref{Web Searches}.
2601 If you use the @code{google} search engine, you can limit the search
2602 to a particular group by using a match string like
2603 @samp{shaving group:alt.sysadmin.recovery}.
2606 @kindex G DEL (Group)
2607 @findex gnus-group-delete-group
2608 This function will delete the current group
2609 (@code{gnus-group-delete-group}). If given a prefix, this function will
2610 actually delete all the articles in the group, and forcibly remove the
2611 group itself from the face of the Earth. Use a prefix only if you are
2612 absolutely sure of what you are doing. This command can't be used on
2613 read-only groups (like @code{nntp} group), though.
2617 @findex gnus-group-make-empty-virtual
2618 Make a new, fresh, empty @code{nnvirtual} group
2619 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2623 @findex gnus-group-add-to-virtual
2624 Add the current group to an @code{nnvirtual} group
2625 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2628 @xref{Select Methods}, for more information on the various select
2631 @vindex gnus-activate-foreign-newsgroups
2632 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2633 Gnus will check all foreign groups with this level or lower at startup.
2634 This might take quite a while, especially if you subscribe to lots of
2635 groups from different @sc{nntp} servers. Also @pxref{Group Levels};
2636 @code{gnus-activate-level} also affects activation of foreign
2640 @node Group Parameters
2641 @section Group Parameters
2642 @cindex group parameters
2644 The group parameters store information local to a particular group.
2645 Here's an example group parameter list:
2648 ((to-address . "ding@@gnus.org")
2652 We see that each element consists of a "dotted pair"---the thing before
2653 the dot is the key, while the thing after the dot is the value. All the
2654 parameters have this form @emph{except} local variable specs, which are
2655 not dotted pairs, but proper lists.
2657 Some parameters have correspondant customizable variables, each of which
2658 is an alist of regexps and values.
2660 The following group parameters can be used:
2665 Address used by when doing followups and new posts.
2668 (to-address . "some@@where.com")
2671 This is primarily useful in mail groups that represent closed mailing
2672 lists---mailing lists where it's expected that everybody that writes to
2673 the mailing list is subscribed to it. Since using this parameter
2674 ensures that the mail only goes to the mailing list itself, it means
2675 that members won't receive two copies of your followups.
2677 Using @code{to-address} will actually work whether the group is foreign
2678 or not. Let's say there's a group on the server that is called
2679 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2680 the articles from a mail-to-news gateway. Posting directly to this
2681 group is therefore impossible---you have to send mail to the mailing
2682 list address instead.
2684 See also @code{gnus-parameter-to-address-alist}.
2688 Address used when doing @kbd{a} in that group.
2691 (to-list . "some@@where.com")
2694 It is totally ignored
2695 when doing a followup---except that if it is present in a news group,
2696 you'll get mail group semantics when doing @kbd{f}.
2698 If you do an @kbd{a} command in a mail group and you have neither a
2699 @code{to-list} group parameter nor a @code{to-address} group parameter,
2700 then a @code{to-list} group parameter will be added automatically upon
2701 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2702 @vindex gnus-add-to-list
2704 If you do an @kbd{a} command in a mail group and you don't have a
2705 @code{to-list} group parameter, one will be added automatically upon
2706 sending the message.
2708 @findex gnus-mailing-list-mode
2709 @cindex Mail List Groups
2710 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2711 entering summary buffer.
2713 See also @code{gnus-parameter-to-list-alist}.
2718 If this parameter is set to @code{t}, Gnus will consider the
2719 to-address and to-list parameters for this group as addresses of
2720 mailing lists you are subscribed to. Giving Gnus this information is
2721 (only) a first step in getting it to generate correct Mail-Followup-To
2722 headers for your posts to these lists. Look here @pxref{(message)Mailing
2723 Lists} for a complete treatment of available MFT support.
2725 See also @code{gnus-find-subscribed-addresses}, the function that
2726 directly uses this group parameter.
2730 If the group parameter list has the element @code{(visible . t)},
2731 that group will always be visible in the Group buffer, regardless
2732 of whether it has any unread articles.
2734 @item broken-reply-to
2735 @cindex broken-reply-to
2736 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2737 headers in this group are to be ignored. This can be useful if you're
2738 reading a mailing list group where the listserv has inserted
2739 @code{Reply-To} headers that point back to the listserv itself. This is
2740 broken behavior. So there!
2744 Elements like @code{(to-group . "some.group.name")} means that all
2745 posts in that group will be sent to @code{some.group.name}.
2749 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2750 will treat all responses as if they were responses to news articles.
2751 This can be useful if you have a mail group that's really a mirror of a
2756 If @code{(gcc-self . t)} is present in the group parameter list, newly
2757 composed messages will be @code{Gcc}'d to the current group. If
2758 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2759 generated, if @code{(gcc-self . "string")} is present, this string will
2760 be inserted literally as a @code{gcc} header. This parameter takes
2761 precedence over any default @code{Gcc} rules as described later
2762 (@pxref{Archived Messages}). CAVEAT:: It yields an error putting
2763 @code{(gcc-self . t)} in groups of a @code{nntp} server or so, because
2764 a @code{nntp} server doesn't accept articles.
2768 If the group parameter has an element that looks like @code{(auto-expire
2769 . t)}, all articles read will be marked as expirable. For an
2770 alternative approach, @pxref{Expiring Mail}.
2772 See also @code{gnus-auto-expirable-newsgroups}.
2775 @cindex total-expire
2776 If the group parameter has an element that looks like
2777 @code{(total-expire . t)}, all read articles will be put through the
2778 expiry process, even if they are not marked as expirable. Use with
2779 caution. Unread, ticked and dormant articles are not eligible for
2782 See also @code{gnus-total-expirable-newsgroups}.
2786 @vindex nnmail-expiry-wait-function
2787 If the group parameter has an element that looks like
2788 @code{(expiry-wait . 10)}, this value will override any
2789 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2790 (@pxref{Expiring Mail}) when expiring expirable messages. The value
2791 can either be a number of days (not necessarily an integer) or the
2792 symbols @code{never} or @code{immediate}.
2795 @cindex score file group parameter
2796 Elements that look like @code{(score-file . "file")} will make
2797 @file{file} into the current score file for the group in question. All
2798 interactive score entries will be put into this file.
2801 @cindex adapt file group parameter
2802 Elements that look like @code{(adapt-file . "file")} will make
2803 @file{file} into the current adaptive file for the group in question.
2804 All adaptive score entries will be put into this file.
2807 @cindex admin-address
2808 When unsubscribing from a mailing list you should never send the
2809 unsubscription notice to the mailing list itself. Instead, you'd send
2810 messages to the administrative address. This parameter allows you to
2811 put the admin address somewhere convenient.
2815 Elements that look like @code{(display . MODE)} say which articles to
2816 display on entering the group. Valid values are:
2820 Display all articles, both read and unread.
2823 Display the last INTEGER articles in the group. This is the same as
2824 entering the group with C-u INTEGER.
2827 Display the default visible articles, which normally includes unread and
2831 Display articles that satisfy a predicate.
2833 Here are some examples:
2837 Display only unread articles.
2840 Display everything except expirable articles.
2842 @item [and (not reply) (not expire)]
2843 Display everything except expirable and articles you've already
2847 The available operators are @code{not}, @code{and} and @code{or}.
2848 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2849 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2850 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2851 @code{cache}, @code{forward}, @code{unseen} and @code{recent}.
2855 The @code{display} parameter works by limiting the summary buffer to
2856 the subset specified. You can pop the limit by using the @kbd{/ w}
2857 command (@pxref{Limiting}).
2861 Elements that look like @code{(comment . "This is a comment")} are
2862 arbitrary comments on the group. You can display comments in the
2863 group line (@pxref{Group Line Specification}).
2867 Elements that look like @code{(charset . iso-8859-1)} will make
2868 @code{iso-8859-1} the default charset; that is, the charset that will be
2869 used for all articles that do not specify a charset.
2871 See also @code{gnus-group-charset-alist}.
2873 @item ignored-charsets
2874 @cindex ignored-charset
2875 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
2876 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2877 default charset will be used for decoding articles.
2879 See also @code{gnus-group-ignored-charsets-alist}.
2882 @cindex posting-style
2883 You can store additional posting style information for this group
2884 here (@pxref{Posting Styles}). The format is that of an entry in the
2885 @code{gnus-posting-styles} alist, except that there's no regexp matching
2886 the group name (of course). Style elements in this group parameter will
2887 take precedence over the ones found in @code{gnus-posting-styles}.
2889 For instance, if you want a funky name and signature in this group only,
2890 instead of hacking @code{gnus-posting-styles}, you could put something
2891 like this in the group parameters:
2896 ("X-My-Header" "Funky Value")
2897 (signature "Funky Signature"))
2902 If it is set, the value is used as the method for posting message
2903 instead of @code{gnus-post-method}.
2907 An item like @code{(banner . "regex")} causes any part of an article
2908 that matches the regular expression "regex" to be stripped. Instead of
2909 "regex", you can also use the symbol @code{signature} which strips the
2910 last signature or any of the elements of the alist
2911 @code{gnus-article-banner-alist}.
2915 This parameter contains a Sieve test that should match incoming mail
2916 that should be placed in this group. From this group parameter, a
2917 Sieve @samp{IF} control structure is generated, having the test as the
2918 condition and @samp{fileinto "group.name";} as the body.
2920 For example, if the INBOX.list.sieve group has the @code{(sieve
2921 address "sender" "sieve-admin@@extundo.com")} group parameter, when
2922 translating the group parameter into a Sieve script (@pxref{Sieve
2923 Commands}) the following Sieve code is generated:
2926 if address \"sender\" \"sieve-admin@@extundo.com\" @{
2927 fileinto \"INBOX.list.sieve\";
2931 The Sieve language is described in RFC 3028. @xref{Top, , Top, sieve,
2934 @item (@var{variable} @var{form})
2935 You can use the group parameters to set variables local to the group you
2936 are entering. If you want to turn threading off in @samp{news.answers},
2937 you could put @code{(gnus-show-threads nil)} in the group parameters of
2938 that group. @code{gnus-show-threads} will be made into a local variable
2939 in the summary buffer you enter, and the form @code{nil} will be
2940 @code{eval}ed there.
2942 @vindex gnus-list-identifiers
2943 A use for this feature, is to remove a mailing list identifier tag in
2944 the subject fields of articles. E.g. if the news group
2945 @samp{nntp+news.gnus.org:gmane.text.docbook.apps} has the tag
2946 @samp{DOC-BOOK-APPS:} in the subject of all articles, this tag can be
2947 removed from the article subjects in the summary buffer for the group by
2948 putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")} into the group
2949 parameters for the group.
2952 This can also be used as a group-specific hook function, if you'd like.
2953 If you want to hear a beep when you enter a group, you could put
2954 something like @code{(dummy-variable (ding))} in the parameters of that
2955 group. @code{dummy-variable} will be set to the result of the
2956 @code{(ding)} form, but who cares?
2960 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
2961 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
2962 presents you with a Customize-like interface. The latter helps avoid
2963 silly Lisp errors.) You might also be interested in reading about topic
2964 parameters (@pxref{Topic Parameters}).
2966 @vindex gnus-parameters
2967 Group parameters can be set via the @code{gnus-parameters} variable too.
2968 But some variables, such as @code{visible}, have no effect. For
2972 (setq gnus-parameters
2974 (gnus-show-threads nil)
2975 (gnus-use-scoring nil)
2976 (gnus-summary-line-format
2977 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
2981 ("^nnimap:\\(foo.bar\\)$"
2985 (gnus-use-scoring t))
2989 (broken-reply-to . t))))
2992 String value of parameters will be subjected to regexp substitution, as
2993 the @code{to-group} example shows.
2996 @node Listing Groups
2997 @section Listing Groups
2998 @cindex group listing
3000 These commands all list various slices of the groups available.
3008 @findex gnus-group-list-groups
3009 List all groups that have unread articles
3010 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
3011 command will list only groups of level ARG and lower. By default, it
3012 only lists groups of level five (i. e.,
3013 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3020 @findex gnus-group-list-all-groups
3021 List all groups, whether they have unread articles or not
3022 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
3023 this command will list only groups of level ARG and lower. By default,
3024 it lists groups of level seven or lower (i.e., just subscribed and
3025 unsubscribed groups).
3029 @findex gnus-group-list-level
3030 List all unread groups on a specific level
3031 (@code{gnus-group-list-level}). If given a prefix, also list the groups
3032 with no unread articles.
3036 @findex gnus-group-list-killed
3037 List all killed groups (@code{gnus-group-list-killed}). If given a
3038 prefix argument, really list all groups that are available, but aren't
3039 currently (un)subscribed. This could entail reading the active file
3044 @findex gnus-group-list-zombies
3045 List all zombie groups (@code{gnus-group-list-zombies}).
3049 @findex gnus-group-list-matching
3050 List all unread, subscribed groups with names that match a regexp
3051 (@code{gnus-group-list-matching}).
3055 @findex gnus-group-list-all-matching
3056 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3060 @findex gnus-group-list-active
3061 List absolutely all groups in the active file(s) of the
3062 server(s) you are connected to (@code{gnus-group-list-active}). This
3063 might very well take quite a while. It might actually be a better idea
3064 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3065 thing to match on. Also note that this command may list groups that
3066 don't exist (yet)---these will be listed as if they were killed groups.
3067 Take the output with some grains of salt.
3071 @findex gnus-group-apropos
3072 List all groups that have names that match a regexp
3073 (@code{gnus-group-apropos}).
3077 @findex gnus-group-description-apropos
3078 List all groups that have names or descriptions that match a regexp
3079 (@code{gnus-group-description-apropos}).
3083 @findex gnus-group-list-cached
3084 List all groups with cached articles (@code{gnus-group-list-cached}).
3088 @findex gnus-group-list-dormant
3089 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3093 @findex gnus-group-list-limit
3094 List groups limited within the current selection
3095 (@code{gnus-group-list-limit}).
3099 @findex gnus-group-list-flush
3100 Flush groups from the current selection (@code{gnus-group-list-flush}).
3104 @findex gnus-group-list-plus
3105 List groups plus the current selection (@code{gnus-group-list-plus}).
3109 @vindex gnus-permanently-visible-groups
3110 @cindex visible group parameter
3111 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3112 always be shown, whether they have unread articles or not. You can also
3113 add the @code{visible} element to the group parameters in question to
3114 get the same effect.
3116 @vindex gnus-list-groups-with-ticked-articles
3117 Groups that have just ticked articles in it are normally listed in the
3118 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
3119 @code{nil}, these groups will be treated just like totally empty
3120 groups. It is @code{t} by default.
3123 @node Sorting Groups
3124 @section Sorting Groups
3125 @cindex sorting groups
3127 @kindex C-c C-s (Group)
3128 @findex gnus-group-sort-groups
3129 @vindex gnus-group-sort-function
3130 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3131 group buffer according to the function(s) given by the
3132 @code{gnus-group-sort-function} variable. Available sorting functions
3137 @item gnus-group-sort-by-alphabet
3138 @findex gnus-group-sort-by-alphabet
3139 Sort the group names alphabetically. This is the default.
3141 @item gnus-group-sort-by-real-name
3142 @findex gnus-group-sort-by-real-name
3143 Sort the group alphabetically on the real (unprefixed) group names.
3145 @item gnus-group-sort-by-level
3146 @findex gnus-group-sort-by-level
3147 Sort by group level.
3149 @item gnus-group-sort-by-score
3150 @findex gnus-group-sort-by-score
3151 Sort by group score. @xref{Group Score}.
3153 @item gnus-group-sort-by-rank
3154 @findex gnus-group-sort-by-rank
3155 Sort by group score and then the group level. The level and the score
3156 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3158 @item gnus-group-sort-by-unread
3159 @findex gnus-group-sort-by-unread
3160 Sort by number of unread articles.
3162 @item gnus-group-sort-by-method
3163 @findex gnus-group-sort-by-method
3164 Sort alphabetically on the select method.
3166 @item gnus-group-sort-by-server
3167 @findex gnus-group-sort-by-server
3168 Sort alphabetically on the Gnus server name.
3173 @code{gnus-group-sort-function} can also be a list of sorting
3174 functions. In that case, the most significant sort key function must be
3178 There are also a number of commands for sorting directly according to
3179 some sorting criteria:
3183 @kindex G S a (Group)
3184 @findex gnus-group-sort-groups-by-alphabet
3185 Sort the group buffer alphabetically by group name
3186 (@code{gnus-group-sort-groups-by-alphabet}).
3189 @kindex G S u (Group)
3190 @findex gnus-group-sort-groups-by-unread
3191 Sort the group buffer by the number of unread articles
3192 (@code{gnus-group-sort-groups-by-unread}).
3195 @kindex G S l (Group)
3196 @findex gnus-group-sort-groups-by-level
3197 Sort the group buffer by group level
3198 (@code{gnus-group-sort-groups-by-level}).
3201 @kindex G S v (Group)
3202 @findex gnus-group-sort-groups-by-score
3203 Sort the group buffer by group score
3204 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3207 @kindex G S r (Group)
3208 @findex gnus-group-sort-groups-by-rank
3209 Sort the group buffer by group rank
3210 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3213 @kindex G S m (Group)
3214 @findex gnus-group-sort-groups-by-method
3215 Sort the group buffer alphabetically by back end name
3216 (@code{gnus-group-sort-groups-by-method}).
3219 @kindex G S n (Group)
3220 @findex gnus-group-sort-groups-by-real-name
3221 Sort the group buffer alphabetically by real (unprefixed) group name
3222 (@code{gnus-group-sort-groups-by-real-name}).
3226 All the commands below obey the process/prefix convention
3227 (@pxref{Process/Prefix}).
3229 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3230 commands will sort in reverse order.
3232 You can also sort a subset of the groups:
3236 @kindex G P a (Group)
3237 @findex gnus-group-sort-selected-groups-by-alphabet
3238 Sort the groups alphabetically by group name
3239 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3242 @kindex G P u (Group)
3243 @findex gnus-group-sort-selected-groups-by-unread
3244 Sort the groups by the number of unread articles
3245 (@code{gnus-group-sort-selected-groups-by-unread}).
3248 @kindex G P l (Group)
3249 @findex gnus-group-sort-selected-groups-by-level
3250 Sort the groups by group level
3251 (@code{gnus-group-sort-selected-groups-by-level}).
3254 @kindex G P v (Group)
3255 @findex gnus-group-sort-selected-groups-by-score
3256 Sort the groups by group score
3257 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3260 @kindex G P r (Group)
3261 @findex gnus-group-sort-selected-groups-by-rank
3262 Sort the groups by group rank
3263 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3266 @kindex G P m (Group)
3267 @findex gnus-group-sort-selected-groups-by-method
3268 Sort the groups alphabetically by back end name
3269 (@code{gnus-group-sort-selected-groups-by-method}).
3272 @kindex G P n (Group)
3273 @findex gnus-group-sort-selected-groups-by-real-name
3274 Sort the groups alphabetically by real (unprefixed) group name
3275 (@code{gnus-group-sort-selected-groups-by-real-name}).
3278 @kindex G P s (Group)
3279 @findex gnus-group-sort-selected-groups
3280 Sort the groups according to @code{gnus-group-sort-function}.
3284 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3288 @node Group Maintenance
3289 @section Group Maintenance
3290 @cindex bogus groups
3295 @findex gnus-group-check-bogus-groups
3296 Find bogus groups and delete them
3297 (@code{gnus-group-check-bogus-groups}).
3301 @findex gnus-group-find-new-groups
3302 Find new groups and process them (@code{gnus-group-find-new-groups}).
3303 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3304 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3305 to query the server for new groups, and subscribe the new groups as
3309 @kindex C-c C-x (Group)
3310 @findex gnus-group-expire-articles
3311 Run all expirable articles in the current group through the expiry
3312 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3313 all expirable articles in the group that have been around for a while.
3314 (@pxref{Expiring Mail}).
3317 @kindex C-c C-M-x (Group)
3318 @findex gnus-group-expire-all-groups
3319 Run all expirable articles in all groups through the expiry process
3320 (@code{gnus-group-expire-all-groups}).
3325 @node Browse Foreign Server
3326 @section Browse Foreign Server
3327 @cindex foreign servers
3328 @cindex browsing servers
3333 @findex gnus-group-browse-foreign-server
3334 You will be queried for a select method and a server name. Gnus will
3335 then attempt to contact this server and let you browse the groups there
3336 (@code{gnus-group-browse-foreign-server}).
3339 @findex gnus-browse-mode
3340 A new buffer with a list of available groups will appear. This buffer
3341 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3342 a lot) like a normal group buffer.
3344 Here's a list of keystrokes available in the browse mode:
3349 @findex gnus-group-next-group
3350 Go to the next group (@code{gnus-group-next-group}).
3354 @findex gnus-group-prev-group
3355 Go to the previous group (@code{gnus-group-prev-group}).
3358 @kindex SPACE (Browse)
3359 @findex gnus-browse-read-group
3360 Enter the current group and display the first article
3361 (@code{gnus-browse-read-group}).
3364 @kindex RET (Browse)
3365 @findex gnus-browse-select-group
3366 Enter the current group (@code{gnus-browse-select-group}).
3370 @findex gnus-browse-unsubscribe-current-group
3371 Unsubscribe to the current group, or, as will be the case here,
3372 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3378 @findex gnus-browse-exit
3379 Exit browse mode (@code{gnus-browse-exit}).
3383 @findex gnus-browse-describe-group
3384 Describe the current group (@code{gnus-browse-describe-group}).
3388 @findex gnus-browse-describe-briefly
3389 Describe browse mode briefly (well, there's not much to describe, is
3390 there) (@code{gnus-browse-describe-briefly}).
3395 @section Exiting Gnus
3396 @cindex exiting Gnus
3398 Yes, Gnus is ex(c)iting.
3403 @findex gnus-group-suspend
3404 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
3405 but it kills all buffers except the Group buffer. I'm not sure why this
3406 is a gain, but then who am I to judge?
3410 @findex gnus-group-exit
3411 @c @icon{gnus-group-exit}
3412 Quit Gnus (@code{gnus-group-exit}).
3416 @findex gnus-group-quit
3417 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3418 The dribble file will be saved, though (@pxref{Auto Save}).
3421 @vindex gnus-exit-gnus-hook
3422 @vindex gnus-suspend-gnus-hook
3423 @vindex gnus-after-exiting-gnus-hook
3424 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
3425 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
3426 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3431 If you wish to completely unload Gnus and all its adherents, you can use
3432 the @code{gnus-unload} command. This command is also very handy when
3433 trying to customize meta-variables.
3438 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3439 numbly heavy and herself fall into a hazy trance as the boy sitting
3440 behind her drew repeated lines with his pencil across the back of her
3446 @section Group Topics
3449 If you read lots and lots of groups, it might be convenient to group
3450 them hierarchically according to topics. You put your Emacs groups over
3451 here, your sex groups over there, and the rest (what, two groups or so?)
3452 you put in some misc section that you never bother with anyway. You can
3453 even group the Emacs sex groups as a sub-topic to either the Emacs
3454 groups or the sex groups---or both! Go wild!
3458 \gnusfigure{Group Topics}{400}{
3459 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3470 2: alt.religion.emacs
3473 0: comp.talk.emacs.recovery
3475 8: comp.binaries.fractals
3476 13: comp.sources.unix
3479 @findex gnus-topic-mode
3481 To get this @emph{fab} functionality you simply turn on (ooh!) the
3482 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3483 is a toggling command.)
3485 Go ahead, just try it. I'll still be here when you get back. La de
3486 dum... Nice tune, that... la la la... What, you're back? Yes, and
3487 now press @kbd{l}. There. All your groups are now listed under
3488 @samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and
3491 If you want this permanently enabled, you should add that minor mode to
3492 the hook for the group mode. Put the following line in your
3493 @file{~/.gnus} file:
3496 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3500 * Topic Commands:: Interactive E-Z commands.
3501 * Topic Variables:: How to customize the topics the Lisp Way.
3502 * Topic Sorting:: Sorting each topic individually.
3503 * Topic Topology:: A map of the world.
3504 * Topic Parameters:: Parameters that apply to all groups in a topic.
3508 @node Topic Commands
3509 @subsection Topic Commands
3510 @cindex topic commands
3512 When the topic minor mode is turned on, a new @kbd{T} submap will be
3513 available. In addition, a few of the standard keys change their
3514 definitions slightly.
3516 In general, the following kinds of operations are possible on topics.
3517 First of all, you want to create topics. Secondly, you want to put
3518 groups in topics and to move them around until you have an order you
3519 like. The third kind of operation is to show/hide parts of the whole
3520 shebang. You might want to hide a topic including its subtopics and
3521 groups, to get a better overview of the other groups.
3523 Here is a list of the basic keys that you might need to set up topics
3530 @findex gnus-topic-create-topic
3531 Prompt for a new topic name and create it
3532 (@code{gnus-topic-create-topic}).
3536 @kindex T TAB (Topic)
3538 @findex gnus-topic-indent
3539 ``Indent'' the current topic so that it becomes a sub-topic of the
3540 previous topic (@code{gnus-topic-indent}). If given a prefix,
3541 ``un-indent'' the topic instead.
3544 @kindex M-TAB (Topic)
3545 @findex gnus-topic-unindent
3546 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3547 parent of its current parent (@code{gnus-topic-unindent}).
3551 The following two keys can be used to move groups and topics around.
3552 They work like the well-known cut and paste. @kbd{C-k} is like cut and
3553 @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms
3554 kill and yank rather than cut and paste.
3560 @findex gnus-topic-kill-group
3561 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3562 topic will be removed along with the topic.
3566 @findex gnus-topic-yank-group
3567 Yank the previously killed group or topic
3568 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3571 So, to move a topic to the beginning of the list of topics, just hit
3572 @kbd{C-k} on it. This is like the `cut' part of cut and paste. Then,
3573 move the cursor to the beginning of the buffer (just below the `Gnus'
3574 topic) and hit @kbd{C-y}. This is like the `paste' part of cut and
3575 paste. Like I said -- E-Z.
3577 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So
3578 you can move topics around as well as groups.
3582 After setting up the topics the way you like them, you might wish to
3583 hide a topic, or to show it again. That's why we have the following
3590 @findex gnus-topic-select-group
3592 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3593 When you perform this command on a group, you'll enter the group, as
3594 usual. When done on a topic line, the topic will be folded (if it was
3595 visible) or unfolded (if it was folded already). So it's basically a
3596 toggling command on topics. In addition, if you give a numerical
3597 prefix, group on that level (and lower) will be displayed.
3601 Now for a list of other commands, in no particular order.
3607 @findex gnus-topic-move-group
3608 Move the current group to some other topic
3609 (@code{gnus-topic-move-group}). This command uses the process/prefix
3610 convention (@pxref{Process/Prefix}).
3614 @findex gnus-topic-jump-to-topic
3615 Go to a topic (@code{gnus-topic-jump-to-topic}).
3619 @findex gnus-topic-copy-group
3620 Copy the current group to some other topic
3621 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3622 convention (@pxref{Process/Prefix}).
3626 @findex gnus-topic-hide-topic
3627 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3628 a prefix, hide the topic permanently.
3632 @findex gnus-topic-show-topic
3633 Show the current topic (@code{gnus-topic-show-topic}). If given
3634 a prefix, show the topic permanently.
3638 @findex gnus-topic-remove-group
3639 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3640 This command is mainly useful if you have the same group in several
3641 topics and wish to remove it from one of the topics. You may also
3642 remove a group from all topics, but in that case, Gnus will add it to
3643 the root topic the next time you start Gnus. In fact, all new groups
3644 (which, naturally, don't belong to any topic) will show up in the root
3647 This command uses the process/prefix convention
3648 (@pxref{Process/Prefix}).
3652 @findex gnus-topic-move-matching
3653 Move all groups that match some regular expression to a topic
3654 (@code{gnus-topic-move-matching}).
3658 @findex gnus-topic-copy-matching
3659 Copy all groups that match some regular expression to a topic
3660 (@code{gnus-topic-copy-matching}).
3664 @findex gnus-topic-toggle-display-empty-topics
3665 Toggle hiding empty topics
3666 (@code{gnus-topic-toggle-display-empty-topics}).
3670 @findex gnus-topic-mark-topic
3671 Mark all groups in the current topic with the process mark
3672 (@code{gnus-topic-mark-topic}).
3675 @kindex T M-# (Topic)
3676 @findex gnus-topic-unmark-topic
3677 Remove the process mark from all groups in the current topic
3678 (@code{gnus-topic-unmark-topic}).
3681 @kindex C-c C-x (Topic)
3682 @findex gnus-topic-expire-articles
3683 Run all expirable articles in the current group or topic through the
3684 expiry process (if any)
3685 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3689 @findex gnus-topic-rename
3690 Rename a topic (@code{gnus-topic-rename}).
3693 @kindex T DEL (Topic)
3694 @findex gnus-topic-delete
3695 Delete an empty topic (@code{gnus-topic-delete}).
3699 @findex gnus-topic-list-active
3700 List all groups that Gnus knows about in a topics-ified way
3701 (@code{gnus-topic-list-active}).
3704 @kindex T M-n (Topic)
3705 @findex gnus-topic-goto-next-topic
3706 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3709 @kindex T M-p (Topic)
3710 @findex gnus-topic-goto-previous-topic
3711 Go to the next topic (@code{gnus-topic-goto-previous-topic}).
3715 @findex gnus-topic-edit-parameters
3716 @cindex group parameters
3717 @cindex topic parameters
3719 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3720 @xref{Topic Parameters}.
3725 @node Topic Variables
3726 @subsection Topic Variables
3727 @cindex topic variables
3729 The previous section told you how to tell Gnus which topics to display.
3730 This section explains how to tell Gnus what to display about each topic.
3732 @vindex gnus-topic-line-format
3733 The topic lines themselves are created according to the
3734 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3747 Number of groups in the topic.
3749 Number of unread articles in the topic.
3751 Number of unread articles in the topic and all its subtopics.
3754 @vindex gnus-topic-indent-level
3755 Each sub-topic (and the groups in the sub-topics) will be indented with
3756 @code{gnus-topic-indent-level} times the topic level number of spaces.
3759 @vindex gnus-topic-mode-hook
3760 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3762 @vindex gnus-topic-display-empty-topics
3763 The @code{gnus-topic-display-empty-topics} says whether to display even
3764 topics that have no unread articles in them. The default is @code{t}.
3768 @subsection Topic Sorting
3769 @cindex topic sorting
3771 You can sort the groups in each topic individually with the following
3777 @kindex T S a (Topic)
3778 @findex gnus-topic-sort-groups-by-alphabet
3779 Sort the current topic alphabetically by group name
3780 (@code{gnus-topic-sort-groups-by-alphabet}).
3783 @kindex T S u (Topic)
3784 @findex gnus-topic-sort-groups-by-unread
3785 Sort the current topic by the number of unread articles
3786 (@code{gnus-topic-sort-groups-by-unread}).
3789 @kindex T S l (Topic)
3790 @findex gnus-topic-sort-groups-by-level
3791 Sort the current topic by group level
3792 (@code{gnus-topic-sort-groups-by-level}).
3795 @kindex T S v (Topic)
3796 @findex gnus-topic-sort-groups-by-score
3797 Sort the current topic by group score
3798 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
3801 @kindex T S r (Topic)
3802 @findex gnus-topic-sort-groups-by-rank
3803 Sort the current topic by group rank
3804 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
3807 @kindex T S m (Topic)
3808 @findex gnus-topic-sort-groups-by-method
3809 Sort the current topic alphabetically by back end name
3810 (@code{gnus-topic-sort-groups-by-method}).
3813 @kindex T S e (Topic)
3814 @findex gnus-topic-sort-groups-by-server
3815 Sort the current topic alphabetically by server name
3816 (@code{gnus-topic-sort-groups-by-server}).
3820 @findex gnus-topic-sort-groups
3821 Sort the current topic according to the function(s) given by the
3822 @code{gnus-group-sort-function} variable
3823 (@code{gnus-topic-sort-groups}).
3827 When given a prefix argument, all these commands will sort in reverse
3828 order. @xref{Sorting Groups}, for more information about group
3832 @node Topic Topology
3833 @subsection Topic Topology
3834 @cindex topic topology
3837 So, let's have a look at an example group buffer:
3843 2: alt.religion.emacs
3846 0: comp.talk.emacs.recovery
3848 8: comp.binaries.fractals
3849 13: comp.sources.unix
3852 So, here we have one top-level topic (@samp{Gnus}), two topics under
3853 that, and one sub-topic under one of the sub-topics. (There is always
3854 just one (1) top-level topic). This topology can be expressed as
3859 (("Emacs -- I wuw it!" visible)
3860 (("Naughty Emacs" visible)))
3864 @vindex gnus-topic-topology
3865 This is in fact how the variable @code{gnus-topic-topology} would look
3866 for the display above. That variable is saved in the @file{.newsrc.eld}
3867 file, and shouldn't be messed with manually---unless you really want
3868 to. Since this variable is read from the @file{.newsrc.eld} file,
3869 setting it in any other startup files will have no effect.
3871 This topology shows what topics are sub-topics of what topics (right),
3872 and which topics are visible. Two settings are currently
3873 allowed---@code{visible} and @code{invisible}.
3876 @node Topic Parameters
3877 @subsection Topic Parameters
3878 @cindex topic parameters
3880 All groups in a topic will inherit group parameters from the parent (and
3881 ancestor) topic parameters. All valid group parameters are valid topic
3882 parameters (@pxref{Group Parameters}).
3884 In addition, the following parameters are only valid as topic
3889 When subscribing new groups by topic (@pxref{Subscription Methods}), the
3890 @code{subscribe} topic parameter says what groups go in what topic. Its
3891 value should be a regexp to match the groups that should go in that
3894 @item subscribe-level
3895 When subscribing new groups by topic (see the @code{subscribe} parameter),
3896 the group will be subscribed with the level specified in the
3897 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
3901 Group parameters (of course) override topic parameters, and topic
3902 parameters in sub-topics override topic parameters in super-topics. You
3903 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
3904 verb, although you may feel free to disagree with me here.)
3910 2: alt.religion.emacs
3914 0: comp.talk.emacs.recovery
3916 8: comp.binaries.fractals
3917 13: comp.sources.unix
3921 The @samp{Emacs} topic has the topic parameter @code{(score-file
3922 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
3923 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
3924 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
3925 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
3926 . "religion.SCORE")}.
3928 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
3929 will get the @file{relief.SCORE} home score file. If you enter the same
3930 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
3931 score file. If you enter the group @samp{alt.religion.emacs}, you'll
3932 get the @file{religion.SCORE} home score file.
3934 This seems rather simple and self-evident, doesn't it? Well, yes. But
3935 there are some problems, especially with the @code{total-expiry}
3936 parameter. Say you have a mail group in two topics; one with
3937 @code{total-expiry} and one without. What happens when you do @kbd{M-x
3938 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
3939 of these topics you mean to expire articles from, so anything may
3940 happen. In fact, I hereby declare that it is @dfn{undefined} what
3941 happens. You just have to be careful if you do stuff like that.
3944 @node Misc Group Stuff
3945 @section Misc Group Stuff
3948 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
3949 * Group Information:: Information and help on groups and Gnus.
3950 * Group Timestamp:: Making Gnus keep track of when you last read a group.
3951 * File Commands:: Reading and writing the Gnus files.
3952 * Sieve Commands:: Managing Sieve scripts.
3959 @findex gnus-group-enter-server-mode
3960 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3961 @xref{Server Buffer}.
3965 @findex gnus-group-post-news
3966 Start composing a message (a news by default)
3967 (@code{gnus-group-post-news}). If given a prefix, post to the group
3968 under the point. If the prefix is 1, prompt for a group to post to.
3969 Contrary to what the name of this function suggests, the prepared
3970 article might be a mail instead of a news, if a mail group is specified
3971 with the prefix argument. @xref{Composing Messages}.
3975 @findex gnus-group-mail
3976 Mail a message somewhere (@code{gnus-group-mail}). If given a prefix,
3977 use the posting style of the group under the point. If the prefix is 1,
3978 prompt for a group name to find the posting style.
3979 @xref{Composing Messages}.
3983 @findex gnus-group-news
3984 Start composing a news (@code{gnus-group-news}). If given a prefix,
3985 post to the group under the point. If the prefix is 1, prompt
3986 for group to post to. @xref{Composing Messages}.
3988 This function actually prepares a news even when using mail groups.
3989 This is useful for "posting" messages to mail groups without actually
3990 sending them over the network: they're just saved directly to the group
3991 in question. The corresponding back end must have a request-post method
3992 for this to work though.
3996 Variables for the group buffer:
4000 @item gnus-group-mode-hook
4001 @vindex gnus-group-mode-hook
4002 is called after the group buffer has been
4005 @item gnus-group-prepare-hook
4006 @vindex gnus-group-prepare-hook
4007 is called after the group buffer is
4008 generated. It may be used to modify the buffer in some strange,
4011 @item gnus-group-prepared-hook
4012 @vindex gnus-group-prepare-hook
4013 is called as the very last thing after the group buffer has been
4014 generated. It may be used to move point around, for instance.
4016 @item gnus-permanently-visible-groups
4017 @vindex gnus-permanently-visible-groups
4018 Groups matching this regexp will always be listed in the group buffer,
4019 whether they are empty or not.
4021 @item gnus-group-name-charset-method-alist
4022 @vindex gnus-group-name-charset-method-alist
4023 An alist of method and the charset for group names. It is used to show
4024 non-ASCII group names.
4028 (setq gnus-group-name-charset-method-alist
4029 '(((nntp "news.com.cn") . cn-gb-2312)))
4032 @item gnus-group-name-charset-group-alist
4033 @cindex UTF-8 group names
4034 @vindex gnus-group-name-charset-group-alist
4035 An alist of regexp of group name and the charset for group names. It
4036 is used to show non-ASCII group names. @code{((".*" utf-8))} is the
4037 default value if UTF-8 is supported, otherwise the default is
4042 (setq gnus-group-name-charset-group-alist
4043 '(("\\.com\\.cn:" . cn-gb-2312)))
4048 @node Scanning New Messages
4049 @subsection Scanning New Messages
4050 @cindex new messages
4051 @cindex scanning new news
4057 @findex gnus-group-get-new-news
4058 @c @icon{gnus-group-get-new-news}
4059 Check the server(s) for new articles. If the numerical prefix is used,
4060 this command will check only groups of level @var{arg} and lower
4061 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
4062 command will force a total re-reading of the active file(s) from the
4067 @findex gnus-group-get-new-news-this-group
4068 @vindex gnus-goto-next-group-when-activating
4069 @c @icon{gnus-group-get-new-news-this-group}
4070 Check whether new articles have arrived in the current group
4071 (@code{gnus-group-get-new-news-this-group}).
4072 @code{gnus-goto-next-group-when-activating} says whether this command is
4073 to move point to the next group or not. It is @code{t} by default.
4075 @findex gnus-activate-all-groups
4076 @cindex activating groups
4078 @kindex C-c M-g (Group)
4079 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4084 @findex gnus-group-restart
4085 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
4086 file(s), closes the connection to all servers, clears up all run-time
4087 Gnus variables, and then starts Gnus all over again.
4091 @vindex gnus-get-new-news-hook
4092 @code{gnus-get-new-news-hook} is run just before checking for new news.
4094 @vindex gnus-after-getting-new-news-hook
4095 @code{gnus-after-getting-new-news-hook} is run after checking for new
4099 @node Group Information
4100 @subsection Group Information
4101 @cindex group information
4102 @cindex information on groups
4109 @findex gnus-group-fetch-faq
4110 @vindex gnus-group-faq-directory
4113 Try to fetch the FAQ for the current group
4114 (@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from
4115 @code{gnus-group-faq-directory}, which is usually a directory on a
4116 remote machine. This variable can also be a list of directories. In
4117 that case, giving a prefix to this command will allow you to choose
4118 between the various sites. @code{ange-ftp} (or @code{efs}) will be used
4119 for fetching the file.
4121 If fetching from the first site is unsuccessful, Gnus will attempt to go
4122 through @code{gnus-group-faq-directory} and try to open them one by one.
4126 @findex gnus-group-fetch-charter
4127 @vindex gnus-group-charter-alist
4129 Try to open the charter for the current group in a web browser
4130 (@code{gnus-group-fetch-charter}). Query for a group if given a
4133 Gnus will use @code{gnus-group-charter-alist} to find the location of
4134 the charter. If no location is known, Gnus will fetch the control
4135 messages for the group, which in some cases includes the charter.
4139 @findex gnus-group-fetch-control
4140 @vindex gnus-group-fetch-control-use-browse-url
4141 @cindex control message
4142 Fetch the control messages for the group from the archive at
4143 @code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a
4144 group if given a prefix argument.
4146 If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
4147 Gnus will open the control messages in a browser using
4148 @code{browse-url}. Otherwise they are fetched using @code{ange-ftp}
4149 and displayed in an ephemeral group.
4151 Note that the control messages are compressed. To use this command
4152 you need to turn on @code{auto-compression-mode}
4153 (@pxref{(emacs)Compressed Files}).
4157 @c @icon{gnus-group-describe-group}
4159 @kindex C-c C-d (Group)
4160 @cindex describing groups
4161 @cindex group description
4162 @findex gnus-group-describe-group
4163 Describe the current group (@code{gnus-group-describe-group}). If given
4164 a prefix, force Gnus to re-read the description from the server.
4168 @findex gnus-group-describe-all-groups
4169 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
4170 prefix, force Gnus to re-read the description file from the server.
4177 @findex gnus-version
4178 Display current Gnus version numbers (@code{gnus-version}).
4182 @findex gnus-group-describe-briefly
4183 Give a very short help message (@code{gnus-group-describe-briefly}).
4186 @kindex C-c C-i (Group)
4189 @findex gnus-info-find-node
4190 Go to the Gnus info node (@code{gnus-info-find-node}).
4194 @node Group Timestamp
4195 @subsection Group Timestamp
4197 @cindex group timestamps
4199 It can be convenient to let Gnus keep track of when you last read a
4200 group. To set the ball rolling, you should add
4201 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4204 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4207 After doing this, each time you enter a group, it'll be recorded.
4209 This information can be displayed in various ways---the easiest is to
4210 use the @samp{%d} spec in the group line format:
4213 (setq gnus-group-line-format
4214 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4217 This will result in lines looking like:
4220 * 0: mail.ding 19961002T012943
4221 0: custom 19961002T012713
4224 As you can see, the date is displayed in compact ISO 8601 format. This
4225 may be a bit too much, so to just display the date, you could say
4229 (setq gnus-group-line-format
4230 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4233 If you would like greater control of the time format, you can use a
4234 user-defined format spec. Something like the following should do the
4238 (setq gnus-group-line-format
4239 "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4240 (defun gnus-user-format-function-d (headers)
4241 (let ((time (gnus-group-timestamp gnus-tmp-group)))
4243 (format-time-string "%b %d %H:%M" time)
4249 @subsection File Commands
4250 @cindex file commands
4256 @findex gnus-group-read-init-file
4257 @vindex gnus-init-file
4258 @cindex reading init file
4259 Re-read the init file (@code{gnus-init-file}, which defaults to
4260 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
4264 @findex gnus-group-save-newsrc
4265 @cindex saving .newsrc
4266 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4267 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
4268 file(s) whether Gnus thinks it is necessary or not.
4271 @c @kindex Z (Group)
4272 @c @findex gnus-group-clear-dribble
4273 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4278 @node Sieve Commands
4279 @subsection Sieve Commands
4280 @cindex group sieve commands
4282 Sieve is a server-side mail filtering language. In Gnus you can use
4283 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4284 sieve rules that should apply to each group. Gnus provides two
4285 commands to translate all these group parameters into a proper Sieve
4286 script that can be transfered to the server somehow.
4288 @vindex gnus-sieve-file
4289 @vindex gnus-sieve-region-start
4290 @vindex gnus-sieve-region-end
4291 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4292 default @file{~/.sieve}). The Sieve code that Gnus generate is placed
4293 between two delimiters, @code{gnus-sieve-region-start} and
4294 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4295 outside these delimiters that will not be removed the next time you
4296 regenerate the Sieve script.
4298 @vindex gnus-sieve-crosspost
4299 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4300 is generated. If it is non-@code{nil} (the default) articles is
4301 placed in all groups that have matching rules, otherwise the article
4302 is only placed in the group with the first matching rule. For
4303 example, the group parameter @samp{(sieve address "sender"
4304 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4305 code if @code{gnus-sieve-crosspost} is @code{nil}. (When
4306 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
4307 except that the line containing the call to @code{stop} is removed.)
4310 if address "sender" "owner-ding@@hpc.uh.edu" @{
4311 fileinto "INBOX.ding";
4316 @xref{Top, ,Top, sieve, Emacs Sieve}.
4322 @findex gnus-sieve-generate
4323 @vindex gnus-sieve-file
4324 @cindex generating sieve script
4325 Regenerate a Sieve script from the @code{sieve} group parameters and
4326 put you into the @code{gnus-sieve-file} without saving it.
4330 @findex gnus-sieve-update
4331 @vindex gnus-sieve-file
4332 @cindex updating sieve script
4333 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4334 @code{sieve} group parameters, save the file and upload it to the
4335 server using the @code{sieveshell} program.
4340 @node Summary Buffer
4341 @chapter Summary Buffer
4342 @cindex summary buffer
4344 A line for each article is displayed in the summary buffer. You can
4345 move around, read articles, post articles and reply to articles.
4347 The most common way to a summary buffer is to select a group from the
4348 group buffer (@pxref{Selecting a Group}).
4350 You can have as many summary buffers open as you wish.
4353 * Summary Buffer Format:: Deciding how the summary buffer is to look.
4354 * Summary Maneuvering:: Moving around the summary buffer.
4355 * Choosing Articles:: Reading articles.
4356 * Paging the Article:: Scrolling the current article.
4357 * Reply Followup and Post:: Posting articles.
4358 * Delayed Articles:: Send articles at a later time.
4359 * Marking Articles:: Marking articles as read, expirable, etc.
4360 * Limiting:: You can limit the summary buffer.
4361 * Threading:: How threads are made.
4362 * Sorting the Summary Buffer:: How articles and threads are sorted.
4363 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
4364 * Article Caching:: You may store articles in a cache.
4365 * Persistent Articles:: Making articles expiry-resistant.
4366 * Article Backlog:: Having already read articles hang around.
4367 * Saving Articles:: Ways of customizing article saving.
4368 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
4369 * Article Treatment:: The article buffer can be mangled at will.
4370 * MIME Commands:: Doing MIMEy things with the articles.
4371 * Charsets:: Character set issues.
4372 * Article Commands:: Doing various things with the article buffer.
4373 * Summary Sorting:: Sorting the summary buffer in various ways.
4374 * Finding the Parent:: No child support? Get the parent.
4375 * Alternative Approaches:: Reading using non-default summaries.
4376 * Tree Display:: A more visual display of threads.
4377 * Mail Group Commands:: Some commands can only be used in mail groups.
4378 * Various Summary Stuff:: What didn't fit anywhere else.
4379 * Exiting the Summary Buffer:: Returning to the Group buffer,
4380 or reselecting the current group.
4381 * Crosspost Handling:: How crossposted articles are dealt with.
4382 * Duplicate Suppression:: An alternative when crosspost handling fails.
4383 * Security:: Decrypt and Verify.
4384 * Mailing List:: Mailing list minor mode.
4388 @node Summary Buffer Format
4389 @section Summary Buffer Format
4390 @cindex summary buffer format
4394 \gnusfigure{The Summary Buffer}{180}{
4395 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4396 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4402 * Summary Buffer Lines:: You can specify how summary lines should look.
4403 * To From Newsgroups:: How to not display your own name.
4404 * Summary Buffer Mode Line:: You can say how the mode line should look.
4405 * Summary Highlighting:: Making the summary buffer all pretty and nice.
4408 @findex mail-extract-address-components
4409 @findex gnus-extract-address-components
4410 @vindex gnus-extract-address-components
4411 Gnus will use the value of the @code{gnus-extract-address-components}
4412 variable as a function for getting the name and address parts of a
4413 @code{From} header. Two pre-defined functions exist:
4414 @code{gnus-extract-address-components}, which is the default, quite
4415 fast, and too simplistic solution; and
4416 @code{mail-extract-address-components}, which works very nicely, but is
4417 slower. The default function will return the wrong answer in 5% of the
4418 cases. If this is unacceptable to you, use the other function instead:
4421 (setq gnus-extract-address-components
4422 'mail-extract-address-components)
4425 @vindex gnus-summary-same-subject
4426 @code{gnus-summary-same-subject} is a string indicating that the current
4427 article has the same subject as the previous. This string will be used
4428 with those specs that require it. The default is @code{""}.
4431 @node Summary Buffer Lines
4432 @subsection Summary Buffer Lines
4434 @vindex gnus-summary-line-format
4435 You can change the format of the lines in the summary buffer by changing
4436 the @code{gnus-summary-line-format} variable. It works along the same
4437 lines as a normal @code{format} string, with some extensions
4438 (@pxref{Formatting Variables}).
4440 There should always be a colon or a point position marker on the line;
4441 the cursor always moves to the point position marker or the colon after
4442 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
4443 possible to change this. Just write a new function
4444 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4445 @xref{Positioning Point}.
4447 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4449 The following format specification characters and extended format
4450 specification(s) are understood:
4456 Subject string. List identifiers stripped,
4457 @code{gnus-list-identifies}. @xref{Article Hiding}.
4459 Subject if the article is the root of the thread or the previous article
4460 had a different subject, @code{gnus-summary-same-subject} otherwise.
4461 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4463 Full @code{From} header.
4465 The name (from the @code{From} header).
4467 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4470 The name (from the @code{From} header). This differs from the @code{n}
4471 spec in that it uses the function designated by the
4472 @code{gnus-extract-address-components} variable, which is slower, but
4473 may be more thorough.
4475 The address (from the @code{From} header). This works the same way as
4478 Number of lines in the article.
4480 Number of characters in the article. This specifier is not supported
4481 in some methods (like nnfolder).
4483 Pretty-printed version of the number of characters in the article;
4484 for example, @samp{1.2k} or @samp{0.4M}.
4486 Indentation based on thread level (@pxref{Customizing Threading}).
4488 A complex trn-style thread tree, showing response-connecting trace
4489 lines. A thread could be drawn like this:
4502 You can customize the appearance with the following options. Note
4503 that it is possible to make the thread display look really neat by
4504 replacing the default ASCII characters with graphic line-drawing
4507 @item gnus-sum-thread-tree-root
4508 @vindex gnus-sum-thread-tree-root
4509 Used for the root of a thread. If @code{nil}, use subject
4510 instead. The default is @samp{> }.
4512 @item gnus-sum-thread-tree-single-indent
4513 @vindex gnus-sum-thread-tree-single-indent
4514 Used for a thread with just one message. If @code{nil}, use subject
4515 instead. The default is @samp{}.
4517 @item gnus-sum-thread-tree-vertical
4518 @vindex gnus-sum-thread-tree-vertical
4519 Used for drawing a vertical line. The default is @samp{| }.
4521 @item gnus-sum-thread-tree-indent
4522 @vindex gnus-sum-thread-tree-indent
4523 Used for indenting. The default is @samp{ }.
4525 @item gnus-sum-thread-tree-leaf-with-other
4526 @vindex gnus-sum-thread-tree-leaf-with-other
4527 Used for a leaf with brothers. The default is @samp{+-> }.
4529 @item gnus-sum-thread-tree-single-leaf
4530 @vindex gnus-sum-thread-tree-single-leaf
4531 Used for a leaf without brothers. The default is @samp{\-> }
4536 Nothing if the article is a root and lots of spaces if it isn't (it
4537 pushes everything after it off the screen).
4539 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4540 for adopted articles (@pxref{Customizing Threading}).
4542 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4543 for adopted articles.
4545 One space for each thread level.
4547 Twenty minus thread level spaces.
4549 Unread. @xref{Read Articles}.
4552 This misleadingly named specifier is the @dfn{secondary mark}. This
4553 mark will say whether the article has been replied to, has been cached,
4554 or has been saved. @xref{Other Marks}.
4557 Score as a number (@pxref{Scoring}).
4559 @vindex gnus-summary-zcore-fuzz
4560 Zcore, @samp{+} if above the default level and @samp{-} if below the
4561 default level. If the difference between
4562 @code{gnus-summary-default-score} and the score is less than
4563 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4571 The @code{Date} in @code{DD-MMM} format.
4573 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4579 Number of articles in the current sub-thread. Using this spec will slow
4580 down summary buffer generation somewhat.
4582 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4583 article has any children.
4589 Age sensitive date format. Various date format is defined in
4590 @code{gnus-user-date-format-alist}.
4592 User defined specifier. The next character in the format string should
4593 be a letter. Gnus will call the function
4594 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
4595 following @samp{%u}. The function will be passed the current header as
4596 argument. The function should return a string, which will be inserted
4597 into the summary just like information from any other summary specifier.
4600 Text between @samp{%(} and @samp{%)} will be highlighted with
4601 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4602 There can only be one such area.
4604 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4605 have to be handled with care. For reasons of efficiency, Gnus will
4606 compute what column these characters will end up in, and ``hard-code''
4607 that. This means that it is invalid to have these specs after a
4608 variable-length spec. Well, you might not be arrested, but your summary
4609 buffer will look strange, which is bad enough.
4611 The smart choice is to have these specs as far to the left as possible.
4612 (Isn't that the case with everything, though? But I digress.)
4614 This restriction may disappear in later versions of Gnus.
4617 @node To From Newsgroups
4618 @subsection To From Newsgroups
4622 In some groups (particularly in archive groups), the @code{From} header
4623 isn't very interesting, since all the articles there are written by
4624 you. To display the information in the @code{To} or @code{Newsgroups}
4625 headers instead, you need to decide three things: What information to
4626 gather; where to display it; and when to display it.
4630 @vindex gnus-extra-headers
4631 The reading of extra header information is controlled by the
4632 @code{gnus-extra-headers}. This is a list of header symbols. For
4636 (setq gnus-extra-headers
4637 '(To Newsgroups X-Newsreader))
4640 This will result in Gnus trying to obtain these three headers, and
4641 storing it in header structures for later easy retrieval.
4644 @findex gnus-extra-header
4645 The value of these extra headers can be accessed via the
4646 @code{gnus-extra-header} function. Here's a format line spec that will
4647 access the @code{X-Newsreader} header:
4650 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4654 @vindex gnus-ignored-from-addresses
4655 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4656 summary line spec returns the @code{To}, @code{Newsreader} or
4657 @code{From} header. If this regexp matches the contents of the
4658 @code{From} header, the value of the @code{To} or @code{Newsreader}
4659 headers are used instead.
4663 @vindex nnmail-extra-headers
4664 A related variable is @code{nnmail-extra-headers}, which controls when
4665 to include extra headers when generating overview (@sc{nov}) files. If
4666 you have old overview files, you should regenerate them after changing
4667 this variable, by entering the server buffer using `^', and then `g' on
4668 the appropriate mail server (e.g. nnml) to cause regeneration.
4670 @vindex gnus-summary-line-format
4671 You also have to instruct Gnus to display the data by changing the
4672 @code{%n} spec to the @code{%f} spec in the
4673 @code{gnus-summary-line-format} variable.
4675 In summary, you'd typically put something like the following in
4679 (setq gnus-extra-headers
4681 (setq nnmail-extra-headers gnus-extra-headers)
4682 (setq gnus-summary-line-format
4683 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
4684 (setq gnus-ignored-from-addresses
4688 (The values listed above are the default values in Gnus. Alter them
4691 A note for news server administrators, or for users who wish to try to
4692 convince their news server administrator to provide some additional
4695 The above is mostly useful for mail groups, where you have control over
4696 the @sc{nov} files that are created. However, if you can persuade your
4697 nntp admin to add (in the usual implementation, notably INN):
4703 to the end of her @file{overview.fmt} file, then you can use that just
4704 as you would the extra headers from the mail groups.
4707 @node Summary Buffer Mode Line
4708 @subsection Summary Buffer Mode Line
4710 @vindex gnus-summary-mode-line-format
4711 You can also change the format of the summary mode bar (@pxref{Mode Line
4712 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
4713 like. The default is @samp{Gnus: %%b [%A] %Z}.
4715 Here are the elements you can play with:
4721 Unprefixed group name.
4723 Current article number.
4725 Current article score.
4729 Number of unread articles in this group.
4731 Number of unread articles in this group that aren't displayed in the
4734 A string with the number of unread and unselected articles represented
4735 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4736 articles, and just as @samp{<%U more>} if there are just unread articles
4737 and no unselected ones.
4739 Shortish group name. For instance, @samp{rec.arts.anime} will be
4740 shortened to @samp{r.a.anime}.
4742 Subject of the current article.
4744 User-defined spec (@pxref{User-Defined Specs}).
4746 Name of the current score file (@pxref{Scoring}).
4748 Number of dormant articles (@pxref{Unread Articles}).
4750 Number of ticked articles (@pxref{Unread Articles}).
4752 Number of articles that have been marked as read in this session.
4754 Number of articles expunged by the score files.
4758 @node Summary Highlighting
4759 @subsection Summary Highlighting
4763 @item gnus-visual-mark-article-hook
4764 @vindex gnus-visual-mark-article-hook
4765 This hook is run after selecting an article. It is meant to be used for
4766 highlighting the article in some way. It is not run if
4767 @code{gnus-visual} is @code{nil}.
4769 @item gnus-summary-update-hook
4770 @vindex gnus-summary-update-hook
4771 This hook is called when a summary line is changed. It is not run if
4772 @code{gnus-visual} is @code{nil}.
4774 @item gnus-summary-selected-face
4775 @vindex gnus-summary-selected-face
4776 This is the face (or @dfn{font} as some people call it) used to
4777 highlight the current article in the summary buffer.
4779 @item gnus-summary-highlight
4780 @vindex gnus-summary-highlight
4781 Summary lines are highlighted according to this variable, which is a
4782 list where the elements are of the format @code{(@var{form}
4783 . @var{face})}. If you would, for instance, like ticked articles to be
4784 italic and high-scored articles to be bold, you could set this variable
4787 (((eq mark gnus-ticked-mark) . italic)
4788 ((> score default) . bold))
4790 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4791 @var{face} will be applied to the line.
4795 @node Summary Maneuvering
4796 @section Summary Maneuvering
4797 @cindex summary movement
4799 All the straight movement commands understand the numeric prefix and
4800 behave pretty much as you'd expect.
4802 None of these commands select articles.
4807 @kindex M-n (Summary)
4808 @kindex G M-n (Summary)
4809 @findex gnus-summary-next-unread-subject
4810 Go to the next summary line of an unread article
4811 (@code{gnus-summary-next-unread-subject}).
4815 @kindex M-p (Summary)
4816 @kindex G M-p (Summary)
4817 @findex gnus-summary-prev-unread-subject
4818 Go to the previous summary line of an unread article
4819 (@code{gnus-summary-prev-unread-subject}).
4822 @kindex G g (Summary)
4823 @findex gnus-summary-goto-subject
4824 Ask for an article number and then go to the summary line of that article
4825 without displaying the article (@code{gnus-summary-goto-subject}).
4828 If Gnus asks you to press a key to confirm going to the next group, you
4829 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4830 buffer, searching for the next group to read without actually returning
4831 to the group buffer.
4833 Variables related to summary movement:
4837 @vindex gnus-auto-select-next
4838 @item gnus-auto-select-next
4839 If you issue one of the movement commands (like @kbd{n}) and there are
4840 no more unread articles after the current one, Gnus will offer to go to
4841 the next group. If this variable is @code{t} and the next group is
4842 empty, Gnus will exit summary mode and return to the group buffer. If
4843 this variable is neither @code{t} nor @code{nil}, Gnus will select the
4844 next group with unread articles. As a special case, if this variable
4845 is @code{quietly}, Gnus will select the next group without asking for
4846 confirmation. If this variable is @code{almost-quietly}, the same
4847 will happen only if you are located on the last article in the group.
4848 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
4849 command will go to the next group without confirmation. Also
4850 @pxref{Group Levels}.
4852 @item gnus-auto-select-same
4853 @vindex gnus-auto-select-same
4854 If non-@code{nil}, all the movement commands will try to go to the next
4855 article with the same subject as the current. (@dfn{Same} here might
4856 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
4857 for details (@pxref{Customizing Threading}).) If there are no more
4858 articles with the same subject, go to the first unread article.
4860 This variable is not particularly useful if you use a threaded display.
4862 @item gnus-summary-check-current
4863 @vindex gnus-summary-check-current
4864 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4865 to the next (or previous) article if the current article is unread.
4866 Instead, they will choose the current article.
4868 @item gnus-auto-center-summary
4869 @vindex gnus-auto-center-summary
4870 If non-@code{nil}, Gnus will keep the point in the summary buffer
4871 centered at all times. This makes things quite tidy, but if you have a
4872 slow network connection, or simply do not like this un-Emacsism, you can
4873 set this variable to @code{nil} to get the normal Emacs scrolling
4874 action. This will also inhibit horizontal re-centering of the summary
4875 buffer, which might make it more inconvenient to read extremely long
4878 This variable can also be a number. In that case, center the window at
4879 the given number of lines from the top.
4884 @node Choosing Articles
4885 @section Choosing Articles
4886 @cindex selecting articles
4889 * Choosing Commands:: Commands for choosing articles.
4890 * Choosing Variables:: Variables that influence these commands.
4894 @node Choosing Commands
4895 @subsection Choosing Commands
4897 None of the following movement commands understand the numeric prefix,
4898 and they all select and display an article.
4900 If you want to fetch new articles or redisplay the group, see
4901 @ref{Exiting the Summary Buffer}.
4905 @kindex SPACE (Summary)
4906 @findex gnus-summary-next-page
4907 Select the current article, or, if that one's read already, the next
4908 unread article (@code{gnus-summary-next-page}).
4913 @kindex G n (Summary)
4914 @findex gnus-summary-next-unread-article
4915 @c @icon{gnus-summary-next-unread}
4916 Go to next unread article (@code{gnus-summary-next-unread-article}).
4921 @findex gnus-summary-prev-unread-article
4922 @c @icon{gnus-summary-prev-unread}
4923 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
4928 @kindex G N (Summary)
4929 @findex gnus-summary-next-article
4930 Go to the next article (@code{gnus-summary-next-article}).
4935 @kindex G P (Summary)
4936 @findex gnus-summary-prev-article
4937 Go to the previous article (@code{gnus-summary-prev-article}).
4940 @kindex G C-n (Summary)
4941 @findex gnus-summary-next-same-subject
4942 Go to the next article with the same subject
4943 (@code{gnus-summary-next-same-subject}).
4946 @kindex G C-p (Summary)
4947 @findex gnus-summary-prev-same-subject
4948 Go to the previous article with the same subject
4949 (@code{gnus-summary-prev-same-subject}).
4953 @kindex G f (Summary)
4955 @findex gnus-summary-first-unread-article
4956 Go to the first unread article
4957 (@code{gnus-summary-first-unread-article}).
4961 @kindex G b (Summary)
4963 @findex gnus-summary-best-unread-article
4964 Go to the unread article with the highest score
4965 (@code{gnus-summary-best-unread-article}). If given a prefix argument,
4966 go to the first unread article that has a score over the default score.
4971 @kindex G l (Summary)
4972 @findex gnus-summary-goto-last-article
4973 Go to the previous article read (@code{gnus-summary-goto-last-article}).
4976 @kindex G o (Summary)
4977 @findex gnus-summary-pop-article
4979 @cindex article history
4980 Pop an article off the summary history and go to this article
4981 (@code{gnus-summary-pop-article}). This command differs from the
4982 command above in that you can pop as many previous articles off the
4983 history as you like, while @kbd{l} toggles the two last read articles.
4984 For a somewhat related issue (if you use these commands a lot),
4985 @pxref{Article Backlog}.
4990 @kindex G j (Summary)
4991 @findex gnus-summary-goto-article
4992 Ask for an article number or @code{Message-ID}, and then go to that
4993 article (@code{gnus-summary-goto-article}).
4998 @node Choosing Variables
4999 @subsection Choosing Variables
5001 Some variables relevant for moving and selecting articles:
5004 @item gnus-auto-extend-newsgroup
5005 @vindex gnus-auto-extend-newsgroup
5006 All the movement commands will try to go to the previous (or next)
5007 article, even if that article isn't displayed in the Summary buffer if
5008 this variable is non-@code{nil}. Gnus will then fetch the article from
5009 the server and display it in the article buffer.
5011 @item gnus-select-article-hook
5012 @vindex gnus-select-article-hook
5013 This hook is called whenever an article is selected. By default it
5014 exposes any threads hidden under the selected article. If you would
5015 like each article to be saved in the Agent as you read it, putting
5016 @code{gnus-agent-fetch-selected-article} on this hook will do so.
5018 @item gnus-mark-article-hook
5019 @vindex gnus-mark-article-hook
5020 @findex gnus-summary-mark-unread-as-read
5021 @findex gnus-summary-mark-read-and-unread-as-read
5022 @findex gnus-unread-mark
5023 This hook is called whenever an article is selected. It is intended to
5024 be used for marking articles as read. The default value is
5025 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
5026 mark of almost any article you read to @code{gnus-unread-mark}. The
5027 only articles not affected by this function are ticked, dormant, and
5028 expirable articles. If you'd instead like to just have unread articles
5029 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
5030 instead. It will leave marks like @code{gnus-low-score-mark},
5031 @code{gnus-del-mark} (and so on) alone.
5036 @node Paging the Article
5037 @section Scrolling the Article
5038 @cindex article scrolling
5043 @kindex SPACE (Summary)
5044 @findex gnus-summary-next-page
5045 Pressing @kbd{SPACE} will scroll the current article forward one page,
5046 or, if you have come to the end of the current article, will choose the
5047 next article (@code{gnus-summary-next-page}).
5050 @kindex DEL (Summary)
5051 @findex gnus-summary-prev-page
5052 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5055 @kindex RET (Summary)
5056 @findex gnus-summary-scroll-up
5057 Scroll the current article one line forward
5058 (@code{gnus-summary-scroll-up}).
5061 @kindex M-RET (Summary)
5062 @findex gnus-summary-scroll-down
5063 Scroll the current article one line backward
5064 (@code{gnus-summary-scroll-down}).
5068 @kindex A g (Summary)
5070 @findex gnus-summary-show-article
5071 @vindex gnus-summary-show-article-charset-alist
5072 (Re)fetch the current article (@code{gnus-summary-show-article}). If
5073 given a prefix, fetch the current article, but don't run any of the
5074 article treatment functions. This will give you a ``raw'' article, just
5075 the way it came from the server.
5077 If given a numerical prefix, you can do semi-manual charset stuff.
5078 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5079 encoded in the @code{cn-gb-2312} charset. If you have
5082 (setq gnus-summary-show-article-charset-alist
5087 then you can say @kbd{C-u 1 g} to get the same effect.
5092 @kindex A < (Summary)
5093 @findex gnus-summary-beginning-of-article
5094 Scroll to the beginning of the article
5095 (@code{gnus-summary-beginning-of-article}).
5100 @kindex A > (Summary)
5101 @findex gnus-summary-end-of-article
5102 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5106 @kindex A s (Summary)
5108 @findex gnus-summary-isearch-article
5109 Perform an isearch in the article buffer
5110 (@code{gnus-summary-isearch-article}).
5114 @findex gnus-summary-select-article-buffer
5115 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5120 @node Reply Followup and Post
5121 @section Reply, Followup and Post
5124 * Summary Mail Commands:: Sending mail.
5125 * Summary Post Commands:: Sending news.
5126 * Summary Message Commands:: Other Message-related commands.
5127 * Canceling and Superseding::
5131 @node Summary Mail Commands
5132 @subsection Summary Mail Commands
5134 @cindex composing mail
5136 Commands for composing a mail message:
5142 @kindex S r (Summary)
5144 @findex gnus-summary-reply
5145 @c @icon{gnus-summary-mail-reply}
5146 @c @icon{gnus-summary-reply}
5147 Mail a reply to the author of the current article
5148 (@code{gnus-summary-reply}).
5153 @kindex S R (Summary)
5154 @findex gnus-summary-reply-with-original
5155 @c @icon{gnus-summary-reply-with-original}
5156 Mail a reply to the author of the current article and include the
5157 original message (@code{gnus-summary-reply-with-original}). This
5158 command uses the process/prefix convention.
5161 @kindex S w (Summary)
5162 @findex gnus-summary-wide-reply
5163 Mail a wide reply to the author of the current article
5164 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
5165 goes out to all people listed in the @code{To}, @code{From} (or
5166 @code{Reply-to}) and @code{Cc} headers.
5169 @kindex S W (Summary)
5170 @findex gnus-summary-wide-reply-with-original
5171 Mail a wide reply to the current article and include the original
5172 message (@code{gnus-summary-wide-reply-with-original}). This command uses
5173 the process/prefix convention.
5176 @kindex S v (Summary)
5177 @findex gnus-summary-very-wide-reply
5178 Mail a very wide reply to the author of the current article
5179 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
5180 that goes out to all people listed in the @code{To}, @code{From} (or
5181 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5182 articles. This command uses the process/prefix convention.
5185 @kindex S V (Summary)
5186 @findex gnus-summary-very-wide-reply-with-original
5187 Mail a very wide reply to the author of the current article and include the
5188 original message (@code{gnus-summary-very-wide-reply-with-original}). This
5189 command uses the process/prefix convention.
5192 @kindex S B r (Summary)
5193 @findex gnus-summary-reply-broken-reply-to
5194 Mail a reply to the author of the current article but ignore the
5195 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5198 @kindex S B R (Summary)
5199 @findex gnus-summary-reply-broken-reply-to-with-original
5200 Mail a reply to the author of the current article and include the
5201 original message but ignore the @code{Reply-To} field
5202 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5206 @kindex S o m (Summary)
5207 @kindex C-c C-f (Summary)
5208 @findex gnus-summary-mail-forward
5209 @c @icon{gnus-summary-mail-forward}
5210 Forward the current article to some other person
5211 (@code{gnus-summary-mail-forward}). If no prefix is given, the message
5212 is forwarded according to the value of (@code{message-forward-as-mime})
5213 and (@code{message-forward-show-mml}); if the prefix is 1, decode the
5214 message and forward directly inline; if the prefix is 2, forward message
5215 as an rfc822 @sc{mime} section; if the prefix is 3, decode message and
5216 forward as an rfc822 @sc{mime} section; if the prefix is 4, forward message
5217 directly inline; otherwise, the message is forwarded as no prefix given
5218 but use the flipped value of (@code{message-forward-as-mime}). By
5219 default, the message is decoded and forwarded as an rfc822 @sc{mime}
5225 @kindex S m (Summary)
5226 @findex gnus-summary-mail-other-window
5227 @c @icon{gnus-summary-mail-originate}
5228 Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use
5229 the posting style of the current group. If given a prefix, disable that.
5230 If the prefix is 1, prompt for a group name to find the posting style.
5235 @kindex S i (Summary)
5236 @findex gnus-summary-news-other-window
5237 Prepare a news (@code{gnus-summary-news-other-window}). By default,
5238 post to the current group. If given a prefix, disable that. If the
5239 prefix is 1, prompt for a group to post to.
5241 This function actually prepares a news even when using mail groups.
5242 This is useful for "posting" messages to mail groups without actually
5243 sending them over the network: they're just saved directly to the group
5244 in question. The corresponding back end must have a request-post method
5245 for this to work though.
5248 @kindex S D b (Summary)
5249 @findex gnus-summary-resend-bounced-mail
5250 @cindex bouncing mail
5251 If you have sent a mail, but the mail was bounced back to you for some
5252 reason (wrong address, transient failure), you can use this command to
5253 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
5254 will be popped into a mail buffer where you can edit the headers before
5255 sending the mail off again. If you give a prefix to this command, and
5256 the bounced mail is a reply to some other mail, Gnus will try to fetch
5257 that mail and display it for easy perusal of its headers. This might
5258 very well fail, though.
5261 @kindex S D r (Summary)
5262 @findex gnus-summary-resend-message
5263 Not to be confused with the previous command,
5264 @code{gnus-summary-resend-message} will prompt you for an address to
5265 send the current message off to, and then send it to that place. The
5266 headers of the message won't be altered---but lots of headers that say
5267 @code{Resent-To}, @code{Resent-From} and so on will be added. This
5268 means that you actually send a mail to someone that has a @code{To}
5269 header that (probably) points to yourself. This will confuse people.
5270 So, natcherly you'll only do that if you're really eVIl.
5272 This command is mainly used if you have several accounts and want to
5273 ship a mail to a different account of yours. (If you're both
5274 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5275 to the @code{root} account, you may want to resend it to
5276 @code{postmaster}. Ordnung muss sein!
5278 This command understands the process/prefix convention
5279 (@pxref{Process/Prefix}).
5282 @kindex S O m (Summary)
5283 @findex gnus-uu-digest-mail-forward
5284 Digest the current series (@pxref{Decoding Articles}) and forward the
5285 result using mail (@code{gnus-uu-digest-mail-forward}). This command
5286 uses the process/prefix convention (@pxref{Process/Prefix}).
5289 @kindex S M-c (Summary)
5290 @findex gnus-summary-mail-crosspost-complaint
5291 @cindex crossposting
5292 @cindex excessive crossposting
5293 Send a complaint about excessive crossposting to the author of the
5294 current article (@code{gnus-summary-mail-crosspost-complaint}).
5296 @findex gnus-crosspost-complaint
5297 This command is provided as a way to fight back against the current
5298 crossposting pandemic that's sweeping Usenet. It will compose a reply
5299 using the @code{gnus-crosspost-complaint} variable as a preamble. This
5300 command understands the process/prefix convention
5301 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5305 Also @xref{Header Commands, ,Header Commands, message, The Message
5306 Manual}, for more information.
5309 @node Summary Post Commands
5310 @subsection Summary Post Commands
5312 @cindex composing news
5314 Commands for posting a news article:
5320 @kindex S p (Summary)
5321 @findex gnus-summary-post-news
5322 @c @icon{gnus-summary-post-news}
5323 Prepare for posting an article (@code{gnus-summary-post-news}). By
5324 default, post to the current group. If given a prefix, disable that.
5325 If the prefix is 1, prompt for another group instead.
5330 @kindex S f (Summary)
5331 @findex gnus-summary-followup
5332 @c @icon{gnus-summary-followup}
5333 Post a followup to the current article (@code{gnus-summary-followup}).
5337 @kindex S F (Summary)
5339 @c @icon{gnus-summary-followup-with-original}
5340 @findex gnus-summary-followup-with-original
5341 Post a followup to the current article and include the original message
5342 (@code{gnus-summary-followup-with-original}). This command uses the
5343 process/prefix convention.
5346 @kindex S n (Summary)
5347 @findex gnus-summary-followup-to-mail
5348 Post a followup to the current article via news, even if you got the
5349 message through mail (@code{gnus-summary-followup-to-mail}).
5352 @kindex S N (Summary)
5353 @findex gnus-summary-followup-to-mail-with-original
5354 Post a followup to the current article via news, even if you got the
5355 message through mail and include the original message
5356 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
5357 the process/prefix convention.
5360 @kindex S o p (Summary)
5361 @findex gnus-summary-post-forward
5362 Forward the current article to a newsgroup
5363 (@code{gnus-summary-post-forward}).
5364 If no prefix is given, the message is forwarded according to the value
5365 of (@code{message-forward-as-mime}) and
5366 (@code{message-forward-show-mml}); if the prefix is 1, decode the
5367 message and forward directly inline; if the prefix is 2, forward message
5368 as an rfc822 @sc{mime} section; if the prefix is 3, decode message and
5369 forward as an rfc822 @sc{mime} section; if the prefix is 4, forward message
5370 directly inline; otherwise, the message is forwarded as no prefix given
5371 but use the flipped value of (@code{message-forward-as-mime}). By
5372 default, the message is decoded and forwarded as an rfc822 @sc{mime} section.
5375 @kindex S O p (Summary)
5376 @findex gnus-uu-digest-post-forward
5378 @cindex making digests
5379 Digest the current series and forward the result to a newsgroup
5380 (@code{gnus-uu-digest-mail-forward}). This command uses the
5381 process/prefix convention.
5384 @kindex S u (Summary)
5385 @findex gnus-uu-post-news
5386 @c @icon{gnus-uu-post-news}
5387 Uuencode a file, split it into parts, and post it as a series
5388 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
5391 Also @xref{Header Commands, ,Header Commands, message, The Message
5392 Manual}, for more information.
5395 @node Summary Message Commands
5396 @subsection Summary Message Commands
5400 @kindex S y (Summary)
5401 @findex gnus-summary-yank-message
5402 Yank the current article into an already existing Message composition
5403 buffer (@code{gnus-summary-yank-message}). This command prompts for
5404 what message buffer you want to yank into, and understands the
5405 process/prefix convention (@pxref{Process/Prefix}).
5410 @node Canceling and Superseding
5411 @subsection Canceling Articles
5412 @cindex canceling articles
5413 @cindex superseding articles
5415 Have you ever written something, and then decided that you really,
5416 really, really wish you hadn't posted that?
5418 Well, you can't cancel mail, but you can cancel posts.
5420 @findex gnus-summary-cancel-article
5422 @c @icon{gnus-summary-cancel-article}
5423 Find the article you wish to cancel (you can only cancel your own
5424 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
5425 c} (@code{gnus-summary-cancel-article}). Your article will be
5426 canceled---machines all over the world will be deleting your article.
5427 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5429 Be aware, however, that not all sites honor cancels, so your article may
5430 live on here and there, while most sites will delete the article in
5433 Gnus will use the ``current'' select method when canceling. If you
5434 want to use the standard posting method, use the @samp{a} symbolic
5435 prefix (@pxref{Symbolic Prefixes}).
5437 If you discover that you have made some mistakes and want to do some
5438 corrections, you can post a @dfn{superseding} article that will replace
5439 your original article.
5441 @findex gnus-summary-supersede-article
5443 Go to the original article and press @kbd{S s}
5444 (@code{gnus-summary-supersede-article}). You will be put in a buffer
5445 where you can edit the article all you want before sending it off the
5448 The same goes for superseding as for canceling, only more so: Some
5449 sites do not honor superseding. On those sites, it will appear that you
5450 have posted almost the same article twice.
5452 If you have just posted the article, and change your mind right away,
5453 there is a trick you can use to cancel/supersede the article without
5454 waiting for the article to appear on your site first. You simply return
5455 to the post buffer (which is called @code{*sent ...*}). There you will
5456 find the article you just posted, with all the headers intact. Change
5457 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5458 header by substituting one of those words for the word
5459 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
5460 you would do normally. The previous article will be
5461 canceled/superseded.
5463 Just remember, kids: There is no 'c' in 'supersede'.
5465 @node Delayed Articles
5466 @section Delayed Articles
5467 @cindex delayed sending
5468 @cindex send delayed
5470 Sometimes, you might wish to delay the sending of a message. For
5471 example, you might wish to arrange for a message to turn up just in time
5472 to remind your about the birthday of your Significant Other. For this,
5473 there is the @code{gnus-delay} package. Setup is simple:
5476 (gnus-delay-initialize)
5479 @findex gnus-delay-article
5480 Normally, to send a message you use the @kbd{C-c C-c} command from
5481 Message mode. To delay a message, use @kbd{C-c C-j}
5482 (@code{gnus-delay-article}) instead. This will ask you for how long the
5483 message should be delayed. Possible answers are:
5487 A time span. Consists of an integer and a letter. For example,
5488 @code{42d} means to delay for 42 days. Available letters are @code{m}
5489 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5490 (months) and @code{Y} (years).
5493 A specific date. Looks like @code{YYYYY-MM-DD}. The message will be
5494 delayed until that day, at a specific time (eight o'clock by default).
5495 See also @code{gnus-delay-default-hour}.
5498 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
5499 stuff. The deadline will be at that time today, except if that time has
5500 already passed, then it's at the given time tomorrow. So if it's ten
5501 o'clock in the morning and you specify @code{11:15}, then the deadline
5502 is one hour and fifteen minutes hence. But if you specify @code{9:20},
5503 that means a time tomorrow.
5506 The action of the @code{gnus-delay-article} command is influenced by a
5507 couple of variables:
5510 @item gnus-delay-default-hour
5511 @vindex gnus-delay-default-hour
5512 When you specify a specific date, the message will be due on that hour
5513 on the given date. Possible values are integers 0 through 23.
5515 @item gnus-delay-default-delay
5516 @vindex gnus-delay-default-delay
5517 This is a string and gives the default delay. It can be of any of the
5518 formats described above.
5520 @item gnus-delay-group
5521 @vindex gnus-delay-group
5522 Delayed articles will be kept in this group on the drafts server until
5523 they are due. You probably don't need to change this. The default
5524 value is @code{"delayed"}.
5526 @item gnus-delay-header
5527 @vindex gnus-delay-header
5528 The deadline for each article will be stored in a header. This variable
5529 is a string and gives the header name. You probably don't need to
5530 change this. The default value is @code{"X-Gnus-Delayed"}.
5533 The way delaying works is like this: when you use the
5534 @code{gnus-delay-article} command, you give a certain delay. Gnus
5535 calculates the deadline of the message and stores it in the
5536 @code{X-Gnus-Delayed} header and puts the message in the
5537 @code{nndraft:delayed} group.
5539 @findex gnus-delay-send-queue
5540 And whenever you get new news, Gnus looks through the group for articles
5541 which are due and sends them. It uses the @code{gnus-delay-send-queue}
5542 function for this. By default, this function is added to the hook
5543 @code{gnus-get-new-news-hook}. But of course, you can change this.
5544 Maybe you want to use the demon to send drafts? Just tell the demon to
5545 execute the @code{gnus-delay-send-queue} function.
5548 @item gnus-delay-initialize
5549 @findex gnus-delay-initialize
5550 By default, this function installs @code{gnus-delay-send-queue} in
5551 @code{gnus-get-new-news-hook}. But it accepts the optional second
5552 argument @code{no-check}. If it is non-@code{nil},
5553 @code{gnus-get-new-news-hook} is not changed. The optional first
5554 argument is ignored.
5556 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5557 Presumably, you want to use the demon for sending due delayed articles.
5558 Just don't forget to set that up :-)
5562 @node Marking Articles
5563 @section Marking Articles
5564 @cindex article marking
5565 @cindex article ticking
5568 There are several marks you can set on an article.
5570 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5571 neologism ohoy!) of the article. Alphabetic marks generally mean
5572 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5574 In addition, you also have marks that do not affect readedness.
5577 * Unread Articles:: Marks for unread articles.
5578 * Read Articles:: Marks for read articles.
5579 * Other Marks:: Marks that do not affect readedness.
5583 There's a plethora of commands for manipulating these marks:
5587 * Setting Marks:: How to set and remove marks.
5588 * Generic Marking Commands:: How to customize the marking.
5589 * Setting Process Marks:: How to mark articles for later processing.
5593 @node Unread Articles
5594 @subsection Unread Articles
5596 The following marks mark articles as (kinda) unread, in one form or
5601 @vindex gnus-ticked-mark
5602 Marked as ticked (@code{gnus-ticked-mark}).
5604 @dfn{Ticked articles} are articles that will remain visible always. If
5605 you see an article that you find interesting, or you want to put off
5606 reading it, or replying to it, until sometime later, you'd typically
5607 tick it. However, articles can be expired (from news servers by the
5608 news server software, Gnus itself never expires ticked messages), so if
5609 you want to keep an article forever, you'll have to make it persistent
5610 (@pxref{Persistent Articles}).
5613 @vindex gnus-dormant-mark
5614 Marked as dormant (@code{gnus-dormant-mark}).
5616 @dfn{Dormant articles} will only appear in the summary buffer if there
5617 are followups to it. If you want to see them even if they don't have
5618 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
5619 Otherwise (except for the visibility issue), they are just like ticked
5623 @vindex gnus-unread-mark
5624 Marked as unread (@code{gnus-unread-mark}).
5626 @dfn{Unread articles} are articles that haven't been read at all yet.
5631 @subsection Read Articles
5632 @cindex expirable mark
5634 All the following marks mark articles as read.
5639 @vindex gnus-del-mark
5640 These are articles that the user has marked as read with the @kbd{d}
5641 command manually, more or less (@code{gnus-del-mark}).
5644 @vindex gnus-read-mark
5645 Articles that have actually been read (@code{gnus-read-mark}).
5648 @vindex gnus-ancient-mark
5649 Articles that were marked as read in previous sessions and are now
5650 @dfn{old} (@code{gnus-ancient-mark}).
5653 @vindex gnus-killed-mark
5654 Marked as killed (@code{gnus-killed-mark}).
5657 @vindex gnus-kill-file-mark
5658 Marked as killed by kill files (@code{gnus-kill-file-mark}).
5661 @vindex gnus-low-score-mark
5662 Marked as read by having too low a score (@code{gnus-low-score-mark}).
5665 @vindex gnus-catchup-mark
5666 Marked as read by a catchup (@code{gnus-catchup-mark}).
5669 @vindex gnus-canceled-mark
5670 Canceled article (@code{gnus-canceled-mark})
5673 @vindex gnus-souped-mark
5674 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
5677 @vindex gnus-sparse-mark
5678 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
5682 @vindex gnus-duplicate-mark
5683 Article marked as read by duplicate suppression
5684 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
5688 All these marks just mean that the article is marked as read, really.
5689 They are interpreted differently when doing adaptive scoring, though.
5691 One more special mark, though:
5695 @vindex gnus-expirable-mark
5696 Marked as expirable (@code{gnus-expirable-mark}).
5698 Marking articles as @dfn{expirable} (or have them marked as such
5699 automatically) doesn't make much sense in normal groups---a user doesn't
5700 control expiring of news articles, but in mail groups, for instance,
5701 articles marked as @dfn{expirable} can be deleted by Gnus at
5707 @subsection Other Marks
5708 @cindex process mark
5711 There are some marks that have nothing to do with whether the article is
5717 You can set a bookmark in the current article. Say you are reading a
5718 long thesis on cats' urinary tracts, and have to go home for dinner
5719 before you've finished reading the thesis. You can then set a bookmark
5720 in the article, and Gnus will jump to this bookmark the next time it
5721 encounters the article. @xref{Setting Marks}.
5724 @vindex gnus-replied-mark
5725 All articles that you have replied to or made a followup to (i.e., have
5726 answered) will be marked with an @samp{A} in the second column
5727 (@code{gnus-replied-mark}).
5730 @vindex gnus-forwarded-mark
5731 All articles that you have forwarded will be marked with an @samp{F} in
5732 the second column (@code{gnus-forwarded-mark}).
5735 @vindex gnus-cached-mark
5736 Articles stored in the article cache will be marked with an @samp{*} in
5737 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
5740 @vindex gnus-saved-mark
5741 Articles ``saved'' (in some manner or other; not necessarily
5742 religiously) are marked with an @samp{S} in the second column
5743 (@code{gnus-saved-mark}).
5746 @vindex gnus-recent-mark
5747 Articles that according to the server haven't been shown to the user
5748 before are marked with a @samp{N} in the second column
5749 (@code{gnus-recent-mark}). Note that not all servers support this
5750 mark, in which case it simply never appears. Compare with
5751 @code{gnus-unseen-mark}.
5754 @vindex gnus-unseen-mark
5755 Articles that haven't been seen before in Gnus by the user are marked
5756 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
5757 Compare with @code{gnus-recent-mark}.
5760 @vindex gnus-downloaded-mark
5761 When using the Gnus agent @pxref{Agent Basics}, articles may be
5762 downloaded for unplugged (offline) viewing. If you are using the
5763 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
5764 (The variable @code{gnus-downloaded-mark} controls which character to
5768 @vindex gnus-undownloaded-mark
5769 When using the Gnus agent @pxref{Agent Basics}, some articles might
5770 not have been downloaded. Such articles cannot be viewed while you
5771 are unplugged (offline). If you are using the @samp{%O} spec, these
5772 articles get the @samp{-} mark in that spec. (The variable
5773 @code{gnus-undownloaded-mark} controls which character to use.)
5776 @vindex gnus-downloadable-mark
5777 The Gnus agent @pxref{Agent Basics} downloads some articles
5778 automatically, but it is also possible to explicitly mark articles for
5779 download, even if they would not be downloaded automatically. Such
5780 explicitly-marked articles get the @samp{%} mark in the first column.
5781 (The variable @code{gnus-downloadable-mark} controls which character to
5785 @vindex gnus-not-empty-thread-mark
5786 @vindex gnus-empty-thread-mark
5787 If the @samp{%e} spec is used, the presence of threads or not will be
5788 marked with @code{gnus-not-empty-thread-mark} and
5789 @code{gnus-empty-thread-mark} in the third column, respectively.
5792 @vindex gnus-process-mark
5793 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
5794 variety of commands react to the presence of the process mark. For
5795 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5796 all articles that have been marked with the process mark. Articles
5797 marked with the process mark have a @samp{#} in the second column.
5801 You might have noticed that most of these ``non-readedness'' marks
5802 appear in the second column by default. So if you have a cached, saved,
5803 replied article that you have process-marked, what will that look like?
5805 Nothing much. The precedence rules go as follows: process -> cache ->
5806 replied -> saved. So if the article is in the cache and is replied,
5807 you'll only see the cache mark and not the replied mark.
5811 @subsection Setting Marks
5812 @cindex setting marks
5814 All the marking commands understand the numeric prefix.
5819 @kindex M c (Summary)
5820 @kindex M-u (Summary)
5821 @findex gnus-summary-clear-mark-forward
5822 @cindex mark as unread
5823 Clear all readedness-marks from the current article
5824 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
5830 @kindex M t (Summary)
5831 @findex gnus-summary-tick-article-forward
5832 Tick the current article (@code{gnus-summary-tick-article-forward}).
5833 @xref{Article Caching}.
5838 @kindex M ? (Summary)
5839 @findex gnus-summary-mark-as-dormant
5840 Mark the current article as dormant
5841 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
5845 @kindex M d (Summary)
5847 @findex gnus-summary-mark-as-read-forward
5848 Mark the current article as read
5849 (@code{gnus-summary-mark-as-read-forward}).
5853 @findex gnus-summary-mark-as-read-backward
5854 Mark the current article as read and move point to the previous line
5855 (@code{gnus-summary-mark-as-read-backward}).
5860 @kindex M k (Summary)
5861 @findex gnus-summary-kill-same-subject-and-select
5862 Mark all articles that have the same subject as the current one as read,
5863 and then select the next unread article
5864 (@code{gnus-summary-kill-same-subject-and-select}).
5868 @kindex M K (Summary)
5869 @kindex C-k (Summary)
5870 @findex gnus-summary-kill-same-subject
5871 Mark all articles that have the same subject as the current one as read
5872 (@code{gnus-summary-kill-same-subject}).
5875 @kindex M C (Summary)
5876 @findex gnus-summary-catchup
5877 @c @icon{gnus-summary-catchup}
5878 Mark all unread articles as read (@code{gnus-summary-catchup}).
5881 @kindex M C-c (Summary)
5882 @findex gnus-summary-catchup-all
5883 Mark all articles in the group as read---even the ticked and dormant
5884 articles (@code{gnus-summary-catchup-all}).
5887 @kindex M H (Summary)
5888 @findex gnus-summary-catchup-to-here
5889 Catchup the current group to point (before the point)
5890 (@code{gnus-summary-catchup-to-here}).
5893 @kindex M h (Summary)
5894 @findex gnus-summary-catchup-from-here
5895 Catchup the current group from point (after the point)
5896 (@code{gnus-summary-catchup-from-here}).
5899 @kindex C-w (Summary)
5900 @findex gnus-summary-mark-region-as-read
5901 Mark all articles between point and mark as read
5902 (@code{gnus-summary-mark-region-as-read}).
5905 @kindex M V k (Summary)
5906 @findex gnus-summary-kill-below
5907 Kill all articles with scores below the default score (or below the
5908 numeric prefix) (@code{gnus-summary-kill-below}).
5912 @kindex M e (Summary)
5914 @findex gnus-summary-mark-as-expirable
5915 Mark the current article as expirable
5916 (@code{gnus-summary-mark-as-expirable}).
5919 @kindex M b (Summary)
5920 @findex gnus-summary-set-bookmark
5921 Set a bookmark in the current article
5922 (@code{gnus-summary-set-bookmark}).
5925 @kindex M B (Summary)
5926 @findex gnus-summary-remove-bookmark
5927 Remove the bookmark from the current article
5928 (@code{gnus-summary-remove-bookmark}).
5931 @kindex M V c (Summary)
5932 @findex gnus-summary-clear-above
5933 Clear all marks from articles with scores over the default score (or
5934 over the numeric prefix) (@code{gnus-summary-clear-above}).
5937 @kindex M V u (Summary)
5938 @findex gnus-summary-tick-above
5939 Tick all articles with scores over the default score (or over the
5940 numeric prefix) (@code{gnus-summary-tick-above}).
5943 @kindex M V m (Summary)
5944 @findex gnus-summary-mark-above
5945 Prompt for a mark, and mark all articles with scores over the default
5946 score (or over the numeric prefix) with this mark
5947 (@code{gnus-summary-clear-above}).
5950 @vindex gnus-summary-goto-unread
5951 The @code{gnus-summary-goto-unread} variable controls what action should
5952 be taken after setting a mark. If non-@code{nil}, point will move to
5953 the next/previous unread article. If @code{nil}, point will just move
5954 one line up or down. As a special case, if this variable is
5955 @code{never}, all the marking commands as well as other commands (like
5956 @kbd{SPACE}) will move to the next article, whether it is unread or not.
5957 The default is @code{t}.
5960 @node Generic Marking Commands
5961 @subsection Generic Marking Commands
5963 Some people would like the command that ticks an article (@kbd{!}) go to
5964 the next article. Others would like it to go to the next unread
5965 article. Yet others would like it to stay on the current article. And
5966 even though I haven't heard of anybody wanting it to go to the
5967 previous (unread) article, I'm sure there are people that want that as
5970 Multiply these five behaviors with five different marking commands, and
5971 you get a potentially complex set of variable to control what each
5974 To sidestep that mess, Gnus provides commands that do all these
5975 different things. They can be found on the @kbd{M M} map in the summary
5976 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
5977 to list in this manual.
5979 While you can use these commands directly, most users would prefer
5980 altering the summary mode keymap. For instance, if you would like the
5981 @kbd{!} command to go to the next article instead of the next unread
5982 article, you could say something like:
5985 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
5986 (defun my-alter-summary-map ()
5987 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
5993 (defun my-alter-summary-map ()
5994 (local-set-key "!" "MM!n"))
5998 @node Setting Process Marks
5999 @subsection Setting Process Marks
6000 @cindex setting process marks
6002 Process marks are displayed as @code{#} in the summary buffer, and are
6003 used for marking articles in such a way that other commands will
6004 process these articles. For instance, if you process mark four
6005 articles and then use the @kbd{*} command, Gnus will enter these four
6006 commands into the cache. For more information,
6007 @pxref{Process/Prefix}.
6014 @kindex M P p (Summary)
6015 @findex gnus-summary-mark-as-processable
6016 Mark the current article with the process mark
6017 (@code{gnus-summary-mark-as-processable}).
6018 @findex gnus-summary-unmark-as-processable
6022 @kindex M P u (Summary)
6023 @kindex M-# (Summary)
6024 Remove the process mark, if any, from the current article
6025 (@code{gnus-summary-unmark-as-processable}).
6028 @kindex M P U (Summary)
6029 @findex gnus-summary-unmark-all-processable
6030 Remove the process mark from all articles
6031 (@code{gnus-summary-unmark-all-processable}).
6034 @kindex M P i (Summary)
6035 @findex gnus-uu-invert-processable
6036 Invert the list of process marked articles
6037 (@code{gnus-uu-invert-processable}).
6040 @kindex M P R (Summary)
6041 @findex gnus-uu-mark-by-regexp
6042 Mark articles that have a @code{Subject} header that matches a regular
6043 expression (@code{gnus-uu-mark-by-regexp}).
6046 @kindex M P G (Summary)
6047 @findex gnus-uu-unmark-by-regexp
6048 Unmark articles that have a @code{Subject} header that matches a regular
6049 expression (@code{gnus-uu-unmark-by-regexp}).
6052 @kindex M P r (Summary)
6053 @findex gnus-uu-mark-region
6054 Mark articles in region (@code{gnus-uu-mark-region}).
6058 @findex gnus-uu-unmark-region
6059 Unmark articles in region (@code{gnus-uu-unmark-region}).
6062 @kindex M P t (Summary)
6063 @findex gnus-uu-mark-thread
6064 Mark all articles in the current (sub)thread
6065 (@code{gnus-uu-mark-thread}).
6068 @kindex M P T (Summary)
6069 @findex gnus-uu-unmark-thread
6070 Unmark all articles in the current (sub)thread
6071 (@code{gnus-uu-unmark-thread}).
6074 @kindex M P v (Summary)
6075 @findex gnus-uu-mark-over
6076 Mark all articles that have a score above the prefix argument
6077 (@code{gnus-uu-mark-over}).
6080 @kindex M P s (Summary)
6081 @findex gnus-uu-mark-series
6082 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6085 @kindex M P S (Summary)
6086 @findex gnus-uu-mark-sparse
6087 Mark all series that have already had some articles marked
6088 (@code{gnus-uu-mark-sparse}).
6091 @kindex M P a (Summary)
6092 @findex gnus-uu-mark-all
6093 Mark all articles in series order (@code{gnus-uu-mark-series}).
6096 @kindex M P b (Summary)
6097 @findex gnus-uu-mark-buffer
6098 Mark all articles in the buffer in the order they appear
6099 (@code{gnus-uu-mark-buffer}).
6102 @kindex M P k (Summary)
6103 @findex gnus-summary-kill-process-mark
6104 Push the current process mark set onto the stack and unmark all articles
6105 (@code{gnus-summary-kill-process-mark}).
6108 @kindex M P y (Summary)
6109 @findex gnus-summary-yank-process-mark
6110 Pop the previous process mark set from the stack and restore it
6111 (@code{gnus-summary-yank-process-mark}).
6114 @kindex M P w (Summary)
6115 @findex gnus-summary-save-process-mark
6116 Push the current process mark set onto the stack
6117 (@code{gnus-summary-save-process-mark}).
6121 Also see the @kbd{&} command in @pxref{Searching for Articles} for how to
6122 set process marks based on article body contents.
6129 It can be convenient to limit the summary buffer to just show some
6130 subset of the articles currently in the group. The effect most limit
6131 commands have is to remove a few (or many) articles from the summary
6134 All limiting commands work on subsets of the articles already fetched
6135 from the servers. None of these commands query the server for
6136 additional articles.
6142 @kindex / / (Summary)
6143 @findex gnus-summary-limit-to-subject
6144 Limit the summary buffer to articles that match some subject
6145 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
6149 @kindex / a (Summary)
6150 @findex gnus-summary-limit-to-author
6151 Limit the summary buffer to articles that match some author
6152 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
6156 @kindex / x (Summary)
6157 @findex gnus-summary-limit-to-extra
6158 Limit the summary buffer to articles that match one of the ``extra''
6159 headers (@pxref{To From Newsgroups})
6160 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
6165 @kindex / u (Summary)
6167 @findex gnus-summary-limit-to-unread
6168 Limit the summary buffer to articles not marked as read
6169 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
6170 buffer to articles strictly unread. This means that ticked and
6171 dormant articles will also be excluded.
6174 @kindex / m (Summary)
6175 @findex gnus-summary-limit-to-marks
6176 Ask for a mark and then limit to all articles that have been marked
6177 with that mark (@code{gnus-summary-limit-to-marks}).
6180 @kindex / t (Summary)
6181 @findex gnus-summary-limit-to-age
6182 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
6183 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
6184 articles younger than that number of days.
6187 @kindex / n (Summary)
6188 @findex gnus-summary-limit-to-articles
6189 Limit the summary buffer to the current article
6190 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
6191 convention (@pxref{Process/Prefix}).
6194 @kindex / w (Summary)
6195 @findex gnus-summary-pop-limit
6196 Pop the previous limit off the stack and restore it
6197 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
6201 @kindex / . (Summary)
6202 @findex gnus-summary-limit-to-unseen
6203 Limit the summary buffer to the unseen articles
6204 (@code{gnus-summary-limit-to-unseen}).
6207 @kindex / v (Summary)
6208 @findex gnus-summary-limit-to-score
6209 Limit the summary buffer to articles that have a score at or above some
6210 score (@code{gnus-summary-limit-to-score}).
6213 @kindex / p (Summary)
6214 @findex gnus-summary-limit-to-display-predicate
6215 Limit the summary buffer to articles that satisfy the @code{display}
6216 group parameter predicate
6217 (@code{gnus-summary-limit-to-display-predicate}). See @pxref{Group
6218 Parameters} for more on this predicate.
6222 @kindex M S (Summary)
6223 @kindex / E (Summary)
6224 @findex gnus-summary-limit-include-expunged
6225 Include all expunged articles in the limit
6226 (@code{gnus-summary-limit-include-expunged}).
6229 @kindex / D (Summary)
6230 @findex gnus-summary-limit-include-dormant
6231 Include all dormant articles in the limit
6232 (@code{gnus-summary-limit-include-dormant}).
6235 @kindex / * (Summary)
6236 @findex gnus-summary-limit-include-cached
6237 Include all cached articles in the limit
6238 (@code{gnus-summary-limit-include-cached}).
6241 @kindex / d (Summary)
6242 @findex gnus-summary-limit-exclude-dormant
6243 Exclude all dormant articles from the limit
6244 (@code{gnus-summary-limit-exclude-dormant}).
6247 @kindex / M (Summary)
6248 @findex gnus-summary-limit-exclude-marks
6249 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
6252 @kindex / T (Summary)
6253 @findex gnus-summary-limit-include-thread
6254 Include all the articles in the current thread in the limit.
6257 @kindex / c (Summary)
6258 @findex gnus-summary-limit-exclude-childless-dormant
6259 Exclude all dormant articles that have no children from the limit
6260 (@code{gnus-summary-limit-exclude-childless-dormant}).
6263 @kindex / C (Summary)
6264 @findex gnus-summary-limit-mark-excluded-as-read
6265 Mark all excluded unread articles as read
6266 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
6267 also mark excluded ticked and dormant articles as read.
6270 @kindex / N (Summary)
6271 @findex gnus-summary-insert-new-articles
6272 Insert all new articles in the summary buffer. It scans for new emails
6273 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
6276 @kindex / o (Summary)
6277 @findex gnus-summary-insert-old-articles
6278 Insert all old articles in the summary buffer. If given a numbered
6279 prefix, fetch this number of articles.
6287 @cindex article threading
6289 Gnus threads articles by default. @dfn{To thread} is to put responses
6290 to articles directly after the articles they respond to---in a
6291 hierarchical fashion.
6293 Threading is done by looking at the @code{References} headers of the
6294 articles. In a perfect world, this would be enough to build pretty
6295 trees, but unfortunately, the @code{References} header is often broken
6296 or simply missing. Weird news propagation exacerbates the problem,
6297 so one has to employ other heuristics to get pleasing results. A
6298 plethora of approaches exists, as detailed in horrible detail in
6299 @pxref{Customizing Threading}.
6301 First, a quick overview of the concepts:
6305 The top-most article in a thread; the first article in the thread.
6308 A tree-like article structure.
6311 A small(er) section of this tree-like structure.
6314 Threads often lose their roots due to article expiry, or due to the root
6315 already having been read in a previous session, and not displayed in the
6316 summary buffer. We then typically have many sub-threads that really
6317 belong to one thread, but are without connecting roots. These are
6318 called loose threads.
6320 @item thread gathering
6321 An attempt to gather loose threads into bigger threads.
6323 @item sparse threads
6324 A thread where the missing articles have been ``guessed'' at, and are
6325 displayed as empty lines in the summary buffer.
6331 * Customizing Threading:: Variables you can change to affect the threading.
6332 * Thread Commands:: Thread based commands in the summary buffer.
6336 @node Customizing Threading
6337 @subsection Customizing Threading
6338 @cindex customizing threading
6341 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
6342 * Filling In Threads:: Making the threads displayed look fuller.
6343 * More Threading:: Even more variables for fiddling with threads.
6344 * Low-Level Threading:: You thought it was over... but you were wrong!
6349 @subsubsection Loose Threads
6352 @cindex loose threads
6355 @item gnus-summary-make-false-root
6356 @vindex gnus-summary-make-false-root
6357 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
6358 and create a dummy root at the top. (Wait a minute. Root at the top?
6359 Yup.) Loose subtrees occur when the real root has expired, or you've
6360 read or killed the root in a previous session.
6362 When there is no real root of a thread, Gnus will have to fudge
6363 something. This variable says what fudging method Gnus should use.
6364 There are four possible values:
6368 \gnusfigure{The Summary Buffer}{390}{
6369 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6370 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6371 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6372 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6377 @cindex adopting articles
6382 Gnus will make the first of the orphaned articles the parent. This
6383 parent will adopt all the other articles. The adopted articles will be
6384 marked as such by pointy brackets (@samp{<>}) instead of the standard
6385 square brackets (@samp{[]}). This is the default method.
6388 @vindex gnus-summary-dummy-line-format
6389 @vindex gnus-summary-make-false-root-always
6390 Gnus will create a dummy summary line that will pretend to be the
6391 parent. This dummy line does not correspond to any real article, so
6392 selecting it will just select the first real article after the dummy
6393 article. @code{gnus-summary-dummy-line-format} is used to specify the
6394 format of the dummy roots. It accepts only one format spec: @samp{S},
6395 which is the subject of the article. @xref{Formatting Variables}.
6396 If you want all threads to have a dummy root, even the non-gathered
6397 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
6400 Gnus won't actually make any article the parent, but simply leave the
6401 subject field of all orphans except the first empty. (Actually, it will
6402 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6406 Don't make any article parent at all. Just gather the threads and
6407 display them after one another.
6410 Don't gather loose threads.
6413 @item gnus-summary-gather-subject-limit
6414 @vindex gnus-summary-gather-subject-limit
6415 Loose threads are gathered by comparing subjects of articles. If this
6416 variable is @code{nil}, Gnus requires an exact match between the
6417 subjects of the loose threads before gathering them into one big
6418 super-thread. This might be too strict a requirement, what with the
6419 presence of stupid newsreaders that chop off long subject lines. If
6420 you think so, set this variable to, say, 20 to require that only the
6421 first 20 characters of the subjects have to match. If you set this
6422 variable to a really low number, you'll find that Gnus will gather
6423 everything in sight into one thread, which isn't very helpful.
6425 @cindex fuzzy article gathering
6426 If you set this variable to the special value @code{fuzzy}, Gnus will
6427 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6430 @item gnus-simplify-subject-fuzzy-regexp
6431 @vindex gnus-simplify-subject-fuzzy-regexp
6432 This can either be a regular expression or list of regular expressions
6433 that match strings that will be removed from subjects if fuzzy subject
6434 simplification is used.
6436 @item gnus-simplify-ignored-prefixes
6437 @vindex gnus-simplify-ignored-prefixes
6438 If you set @code{gnus-summary-gather-subject-limit} to something as low
6439 as 10, you might consider setting this variable to something sensible:
6441 @c Written by Michael Ernst <mernst@cs.rice.edu>
6443 (setq gnus-simplify-ignored-prefixes
6449 "wanted" "followup" "summary\\( of\\)?"
6450 "help" "query" "problem" "question"
6451 "answer" "reference" "announce"
6452 "How can I" "How to" "Comparison of"
6457 (mapconcat 'identity
6458 '("for" "for reference" "with" "about")
6460 "\\)?\\]?:?[ \t]*"))
6463 All words that match this regexp will be removed before comparing two
6466 @item gnus-simplify-subject-functions
6467 @vindex gnus-simplify-subject-functions
6468 If non-@code{nil}, this variable overrides
6469 @code{gnus-summary-gather-subject-limit}. This variable should be a
6470 list of functions to apply to the @code{Subject} string iteratively to
6471 arrive at the simplified version of the string.
6473 Useful functions to put in this list include:
6476 @item gnus-simplify-subject-re
6477 @findex gnus-simplify-subject-re
6478 Strip the leading @samp{Re:}.
6480 @item gnus-simplify-subject-fuzzy
6481 @findex gnus-simplify-subject-fuzzy
6484 @item gnus-simplify-whitespace
6485 @findex gnus-simplify-whitespace
6486 Remove excessive whitespace.
6488 @item gnus-simplify-all-whitespace
6489 @findex gnus-simplify-all-whitespace
6490 Remove all whitespace.
6493 You may also write your own functions, of course.
6496 @item gnus-summary-gather-exclude-subject
6497 @vindex gnus-summary-gather-exclude-subject
6498 Since loose thread gathering is done on subjects only, that might lead
6499 to many false hits, especially with certain common subjects like
6500 @samp{} and @samp{(none)}. To make the situation slightly better,
6501 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6502 what subjects should be excluded from the gathering process.@*
6503 The default is @samp{^ *$\\|^(none)$}.
6505 @item gnus-summary-thread-gathering-function
6506 @vindex gnus-summary-thread-gathering-function
6507 Gnus gathers threads by looking at @code{Subject} headers. This means
6508 that totally unrelated articles may end up in the same ``thread'', which
6509 is confusing. An alternate approach is to look at all the
6510 @code{Message-ID}s in all the @code{References} headers to find matches.
6511 This will ensure that no gathered threads ever include unrelated
6512 articles, but it also means that people who have posted with broken
6513 newsreaders won't be gathered properly. The choice is yours---plague or
6517 @item gnus-gather-threads-by-subject
6518 @findex gnus-gather-threads-by-subject
6519 This function is the default gathering function and looks at
6520 @code{Subject}s exclusively.
6522 @item gnus-gather-threads-by-references
6523 @findex gnus-gather-threads-by-references
6524 This function looks at @code{References} headers exclusively.
6527 If you want to test gathering by @code{References}, you could say
6531 (setq gnus-summary-thread-gathering-function
6532 'gnus-gather-threads-by-references)
6538 @node Filling In Threads
6539 @subsubsection Filling In Threads
6542 @item gnus-fetch-old-headers
6543 @vindex gnus-fetch-old-headers
6544 If non-@code{nil}, Gnus will attempt to build old threads by fetching
6545 more old headers---headers to articles marked as read. If you
6546 would like to display as few summary lines as possible, but still
6547 connect as many loose threads as possible, you should set this variable
6548 to @code{some} or a number. If you set it to a number, no more than
6549 that number of extra old headers will be fetched. In either case,
6550 fetching old headers only works if the back end you are using carries
6551 overview files---this would normally be @code{nntp}, @code{nnspool},
6552 @code{nnml}, and @code{nnmaildir}. Also remember that if the root of
6553 the thread has been expired by the server, there's not much Gnus can do
6556 This variable can also be set to @code{invisible}. This won't have any
6557 visible effects, but is useful if you use the @kbd{A T} command a lot
6558 (@pxref{Finding the Parent}).
6560 @item gnus-build-sparse-threads
6561 @vindex gnus-build-sparse-threads
6562 Fetching old headers can be slow. A low-rent similar effect can be
6563 gotten by setting this variable to @code{some}. Gnus will then look at
6564 the complete @code{References} headers of all articles and try to string
6565 together articles that belong in the same thread. This will leave
6566 @dfn{gaps} in the threading display where Gnus guesses that an article
6567 is missing from the thread. (These gaps appear like normal summary
6568 lines. If you select a gap, Gnus will try to fetch the article in
6569 question.) If this variable is @code{t}, Gnus will display all these
6570 ``gaps'' without regard for whether they are useful for completing the
6571 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
6572 off sparse leaf nodes that don't lead anywhere. This variable is
6573 @code{nil} by default.
6575 @item gnus-read-all-available-headers
6576 @vindex gnus-read-all-available-headers
6577 This is a rather obscure variable that few will find useful. It's
6578 intended for those non-news newsgroups where the back end has to fetch
6579 quite a lot to present the summary buffer, and where it's impossible to
6580 go back to parents of articles. This is mostly the case in the
6581 web-based groups, like the @code{nnultimate} groups.
6583 If you don't use those, then it's safe to leave this as the default
6584 @code{nil}. If you want to use this variable, it should be a regexp
6585 that matches the group name, or @code{t} for all groups.
6590 @node More Threading
6591 @subsubsection More Threading
6594 @item gnus-show-threads
6595 @vindex gnus-show-threads
6596 If this variable is @code{nil}, no threading will be done, and all of
6597 the rest of the variables here will have no effect. Turning threading
6598 off will speed group selection up a bit, but it is sure to make reading
6599 slower and more awkward.
6601 @item gnus-thread-hide-subtree
6602 @vindex gnus-thread-hide-subtree
6603 If non-@code{nil}, all threads will be hidden when the summary buffer is
6606 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
6607 Available predicates are @code{gnus-article-unread-p} and
6608 @code{gnus-article-unseen-p}).
6613 (setq gnus-thread-hide-subtree
6614 '(or gnus-article-unread-p
6615 gnus-article-unseen-p))
6618 (It's a pretty nonsensical example, since all unseen articles are also
6619 unread, but you get my drift.)
6622 @item gnus-thread-expunge-below
6623 @vindex gnus-thread-expunge-below
6624 All threads that have a total score (as defined by
6625 @code{gnus-thread-score-function}) less than this number will be
6626 expunged. This variable is @code{nil} by default, which means that no
6627 threads are expunged.
6629 @item gnus-thread-hide-killed
6630 @vindex gnus-thread-hide-killed
6631 if you kill a thread and this variable is non-@code{nil}, the subtree
6634 @item gnus-thread-ignore-subject
6635 @vindex gnus-thread-ignore-subject
6636 Sometimes somebody changes the subject in the middle of a thread. If
6637 this variable is non-@code{nil}, which is the default, the subject
6638 change is ignored. If it is @code{nil}, a change in the subject will
6639 result in a new thread.
6641 @item gnus-thread-indent-level
6642 @vindex gnus-thread-indent-level
6643 This is a number that says how much each sub-thread should be indented.
6646 @item gnus-sort-gathered-threads-function
6647 @vindex gnus-sort-gathered-threads-function
6648 Sometimes, particularly with mailing lists, the order in which mails
6649 arrive locally is not necessarily the same as the order in which they
6650 arrived on the mailing list. Consequently, when sorting sub-threads
6651 using the default @code{gnus-thread-sort-by-number}, responses can end
6652 up appearing before the article to which they are responding to.
6653 Setting this variable to an alternate value
6654 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
6655 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
6656 more logical sub-thread ordering in such instances.
6661 @node Low-Level Threading
6662 @subsubsection Low-Level Threading
6666 @item gnus-parse-headers-hook
6667 @vindex gnus-parse-headers-hook
6668 Hook run before parsing any headers.
6670 @item gnus-alter-header-function
6671 @vindex gnus-alter-header-function
6672 If non-@code{nil}, this function will be called to allow alteration of
6673 article header structures. The function is called with one parameter,
6674 the article header vector, which it may alter in any way. For instance,
6675 if you have a mail-to-news gateway which alters the @code{Message-ID}s
6676 in systematic ways (by adding prefixes and such), you can use this
6677 variable to un-scramble the @code{Message-ID}s so that they are more
6678 meaningful. Here's one example:
6681 (setq gnus-alter-header-function 'my-alter-message-id)
6683 (defun my-alter-message-id (header)
6684 (let ((id (mail-header-id header)))
6686 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
6688 (concat (match-string 1 id) "@@" (match-string 2 id))
6695 @node Thread Commands
6696 @subsection Thread Commands
6697 @cindex thread commands
6703 @kindex T k (Summary)
6704 @kindex C-M-k (Summary)
6705 @findex gnus-summary-kill-thread
6706 Mark all articles in the current (sub-)thread as read
6707 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
6708 remove all marks instead. If the prefix argument is negative, tick
6713 @kindex T l (Summary)
6714 @kindex C-M-l (Summary)
6715 @findex gnus-summary-lower-thread
6716 Lower the score of the current (sub-)thread
6717 (@code{gnus-summary-lower-thread}).
6720 @kindex T i (Summary)
6721 @findex gnus-summary-raise-thread
6722 Increase the score of the current (sub-)thread
6723 (@code{gnus-summary-raise-thread}).
6726 @kindex T # (Summary)
6727 @findex gnus-uu-mark-thread
6728 Set the process mark on the current (sub-)thread
6729 (@code{gnus-uu-mark-thread}).
6732 @kindex T M-# (Summary)
6733 @findex gnus-uu-unmark-thread
6734 Remove the process mark from the current (sub-)thread
6735 (@code{gnus-uu-unmark-thread}).
6738 @kindex T T (Summary)
6739 @findex gnus-summary-toggle-threads
6740 Toggle threading (@code{gnus-summary-toggle-threads}).
6743 @kindex T s (Summary)
6744 @findex gnus-summary-show-thread
6745 Expose the (sub-)thread hidden under the current article, if any
6746 (@code{gnus-summary-show-thread}).
6749 @kindex T h (Summary)
6750 @findex gnus-summary-hide-thread
6751 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
6754 @kindex T S (Summary)
6755 @findex gnus-summary-show-all-threads
6756 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
6759 @kindex T H (Summary)
6760 @findex gnus-summary-hide-all-threads
6761 Hide all threads (@code{gnus-summary-hide-all-threads}).
6764 @kindex T t (Summary)
6765 @findex gnus-summary-rethread-current
6766 Re-thread the current article's thread
6767 (@code{gnus-summary-rethread-current}). This works even when the
6768 summary buffer is otherwise unthreaded.
6771 @kindex T ^ (Summary)
6772 @findex gnus-summary-reparent-thread
6773 Make the current article the child of the marked (or previous) article
6774 (@code{gnus-summary-reparent-thread}).
6778 The following commands are thread movement commands. They all
6779 understand the numeric prefix.
6784 @kindex T n (Summary)
6786 @kindex C-M-n (Summary)
6788 @kindex M-down (Summary)
6789 @findex gnus-summary-next-thread
6790 Go to the next thread (@code{gnus-summary-next-thread}).
6793 @kindex T p (Summary)
6795 @kindex C-M-p (Summary)
6797 @kindex M-up (Summary)
6798 @findex gnus-summary-prev-thread
6799 Go to the previous thread (@code{gnus-summary-prev-thread}).
6802 @kindex T d (Summary)
6803 @findex gnus-summary-down-thread
6804 Descend the thread (@code{gnus-summary-down-thread}).
6807 @kindex T u (Summary)
6808 @findex gnus-summary-up-thread
6809 Ascend the thread (@code{gnus-summary-up-thread}).
6812 @kindex T o (Summary)
6813 @findex gnus-summary-top-thread
6814 Go to the top of the thread (@code{gnus-summary-top-thread}).
6817 @vindex gnus-thread-operation-ignore-subject
6818 If you ignore subject while threading, you'll naturally end up with
6819 threads that have several different subjects in them. If you then issue
6820 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
6821 wish to kill the entire thread, but just those parts of the thread that
6822 have the same subject as the current article. If you like this idea,
6823 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
6824 is non-@code{nil} (which it is by default), subjects will be ignored
6825 when doing thread commands. If this variable is @code{nil}, articles in
6826 the same thread with different subjects will not be included in the
6827 operation in question. If this variable is @code{fuzzy}, only articles
6828 that have subjects fuzzily equal will be included (@pxref{Fuzzy
6832 @node Sorting the Summary Buffer
6833 @section Sorting the Summary Buffer
6835 @findex gnus-thread-sort-by-total-score
6836 @findex gnus-thread-sort-by-date
6837 @findex gnus-thread-sort-by-score
6838 @findex gnus-thread-sort-by-subject
6839 @findex gnus-thread-sort-by-author
6840 @findex gnus-thread-sort-by-number
6841 @findex gnus-thread-sort-by-random
6842 @vindex gnus-thread-sort-functions
6843 @findex gnus-thread-sort-by-most-recent-thread
6844 If you are using a threaded summary display, you can sort the threads by
6845 setting @code{gnus-thread-sort-functions}, which can be either a single
6846 function, a list of functions, or a list containing functions and
6847 @code{(not some-function)} elements.
6849 By default, sorting is done on article numbers. Ready-made sorting
6850 predicate functions include @code{gnus-thread-sort-by-number},
6851 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
6852 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score},
6853 @code{gnus-thread-sort-by-most-recent-number},
6854 @code{gnus-thread-sort-by-most-recent-date},
6855 @code{gnus-thread-sort-by-random} and
6856 @code{gnus-thread-sort-by-total-score}.
6858 Each function takes two threads and returns non-@code{nil} if the first
6859 thread should be sorted before the other. Note that sorting really is
6860 normally done by looking only at the roots of each thread.
6862 If you use more than one function, the primary sort key should be the
6863 last function in the list. You should probably always include
6864 @code{gnus-thread-sort-by-number} in the list of sorting
6865 functions---preferably first. This will ensure that threads that are
6866 equal with respect to the other sort criteria will be displayed in
6867 ascending article order.
6869 If you would like to sort by reverse score, then by subject, and finally
6870 by number, you could do something like:
6873 (setq gnus-thread-sort-functions
6874 '(gnus-thread-sort-by-number
6875 gnus-thread-sort-by-subject
6876 (not gnus-thread-sort-by-total-score)))
6879 The threads that have highest score will be displayed first in the
6880 summary buffer. When threads have the same score, they will be sorted
6881 alphabetically. The threads that have the same score and the same
6882 subject will be sorted by number, which is (normally) the sequence in
6883 which the articles arrived.
6885 If you want to sort by score and then reverse arrival order, you could
6889 (setq gnus-thread-sort-functions
6891 (not (gnus-thread-sort-by-number t1 t2)))
6892 gnus-thread-sort-by-score))
6895 @vindex gnus-thread-score-function
6896 The function in the @code{gnus-thread-score-function} variable (default
6897 @code{+}) is used for calculating the total score of a thread. Useful
6898 functions might be @code{max}, @code{min}, or squared means, or whatever
6901 @findex gnus-article-sort-functions
6902 @findex gnus-article-sort-by-date
6903 @findex gnus-article-sort-by-score
6904 @findex gnus-article-sort-by-subject
6905 @findex gnus-article-sort-by-author
6906 @findex gnus-article-sort-by-random
6907 @findex gnus-article-sort-by-number
6908 If you are using an unthreaded display for some strange reason or
6909 other, you have to fiddle with the @code{gnus-article-sort-functions}
6910 variable. It is very similar to the
6911 @code{gnus-thread-sort-functions}, except that it uses slightly
6912 different functions for article comparison. Available sorting
6913 predicate functions are @code{gnus-article-sort-by-number},
6914 @code{gnus-article-sort-by-author},
6915 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
6916 @code{gnus-article-sort-by-random}, and
6917 @code{gnus-article-sort-by-score}.
6919 If you want to sort an unthreaded summary display by subject, you could
6923 (setq gnus-article-sort-functions
6924 '(gnus-article-sort-by-number
6925 gnus-article-sort-by-subject))
6930 @node Asynchronous Fetching
6931 @section Asynchronous Article Fetching
6932 @cindex asynchronous article fetching
6933 @cindex article pre-fetch
6936 If you read your news from an @sc{nntp} server that's far away, the
6937 network latencies may make reading articles a chore. You have to wait
6938 for a while after pressing @kbd{n} to go to the next article before the
6939 article appears. Why can't Gnus just go ahead and fetch the article
6940 while you are reading the previous one? Why not, indeed.
6942 First, some caveats. There are some pitfalls to using asynchronous
6943 article fetching, especially the way Gnus does it.
6945 Let's say you are reading article 1, which is short, and article 2 is
6946 quite long, and you are not interested in reading that. Gnus does not
6947 know this, so it goes ahead and fetches article 2. You decide to read
6948 article 3, but since Gnus is in the process of fetching article 2, the
6949 connection is blocked.
6951 To avoid these situations, Gnus will open two (count 'em two)
6952 connections to the server. Some people may think this isn't a very nice
6953 thing to do, but I don't see any real alternatives. Setting up that
6954 extra connection takes some time, so Gnus startup will be slower.
6956 Gnus will fetch more articles than you will read. This will mean that
6957 the link between your machine and the @sc{nntp} server will become more
6958 loaded than if you didn't use article pre-fetch. The server itself will
6959 also become more loaded---both with the extra article requests, and the
6962 Ok, so now you know that you shouldn't really use this thing... unless
6965 @vindex gnus-asynchronous
6966 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
6967 happen automatically.
6969 @vindex gnus-use-article-prefetch
6970 You can control how many articles are to be pre-fetched by setting
6971 @code{gnus-use-article-prefetch}. This is 30 by default, which means
6972 that when you read an article in the group, the back end will pre-fetch
6973 the next 30 articles. If this variable is @code{t}, the back end will
6974 pre-fetch all the articles it can without bound. If it is
6975 @code{nil}, no pre-fetching will be done.
6977 @vindex gnus-async-prefetch-article-p
6978 @findex gnus-async-read-p
6979 There are probably some articles that you don't want to pre-fetch---read
6980 articles, for instance. The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched. This function should
6981 return non-@code{nil} when the article in question is to be
6982 pre-fetched. The default is @code{gnus-async-read-p}, which returns
6983 @code{nil} on read articles. The function is called with an article
6984 data structure as the only parameter.
6986 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
6989 (defun my-async-short-unread-p (data)
6990 "Return non-nil for short, unread articles."
6991 (and (gnus-data-unread-p data)
6992 (< (mail-header-lines (gnus-data-header data))
6995 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
6998 These functions will be called many, many times, so they should
6999 preferably be short and sweet to avoid slowing down Gnus too much.
7000 It's probably a good idea to byte-compile things like this.
7002 @vindex gnus-prefetched-article-deletion-strategy
7003 Articles have to be removed from the asynch buffer sooner or later. The
7004 @code{gnus-prefetched-article-deletion-strategy} says when to remove
7005 articles. This is a list that may contain the following elements:
7009 Remove articles when they are read.
7012 Remove articles when exiting the group.
7015 The default value is @code{(read exit)}.
7017 @c @vindex gnus-use-header-prefetch
7018 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
7019 @c from the next group.
7022 @node Article Caching
7023 @section Article Caching
7024 @cindex article caching
7027 If you have an @emph{extremely} slow @sc{nntp} connection, you may
7028 consider turning article caching on. Each article will then be stored
7029 locally under your home directory. As you may surmise, this could
7030 potentially use @emph{huge} amounts of disk space, as well as eat up all
7031 your inodes so fast it will make your head swim. In vodka.
7033 Used carefully, though, it could be just an easier way to save articles.
7035 @vindex gnus-use-long-file-name
7036 @vindex gnus-cache-directory
7037 @vindex gnus-use-cache
7038 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
7039 all articles ticked or marked as dormant will then be copied
7040 over to your local cache (@code{gnus-cache-directory}). Whether this
7041 cache is flat or hierarchical is controlled by the
7042 @code{gnus-use-long-file-name} variable, as usual.
7044 When re-selecting a ticked or dormant article, it will be fetched from the
7045 cache instead of from the server. As articles in your cache will never
7046 expire, this might serve as a method of saving articles while still
7047 keeping them where they belong. Just mark all articles you want to save
7048 as dormant, and don't worry.
7050 When an article is marked as read, is it removed from the cache.
7052 @vindex gnus-cache-remove-articles
7053 @vindex gnus-cache-enter-articles
7054 The entering/removal of articles from the cache is controlled by the
7055 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
7056 variables. Both are lists of symbols. The first is @code{(ticked
7057 dormant)} by default, meaning that ticked and dormant articles will be
7058 put in the cache. The latter is @code{(read)} by default, meaning that
7059 articles marked as read are removed from the cache. Possibly
7060 symbols in these two lists are @code{ticked}, @code{dormant},
7061 @code{unread} and @code{read}.
7063 @findex gnus-jog-cache
7064 So where does the massive article-fetching and storing come into the
7065 picture? The @code{gnus-jog-cache} command will go through all
7066 subscribed newsgroups, request all unread articles, score them, and
7067 store them in the cache. You should only ever, ever ever ever, use this
7068 command if 1) your connection to the @sc{nntp} server is really, really,
7069 really slow and 2) you have a really, really, really huge disk.
7070 Seriously. One way to cut down on the number of articles downloaded is
7071 to score unwanted articles down and have them marked as read. They will
7072 not then be downloaded by this command.
7074 @vindex gnus-uncacheable-groups
7075 @vindex gnus-cacheable-groups
7076 It is likely that you do not want caching on all groups. For instance,
7077 if your @code{nnml} mail is located under your home directory, it makes no
7078 sense to cache it somewhere else under your home directory. Unless you
7079 feel that it's neat to use twice as much space.
7081 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7082 regexp of groups to cache, @samp{^nntp} for instance, or set the
7083 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7084 Both variables are @code{nil} by default. If a group matches both
7085 variables, the group is not cached.
7087 @findex gnus-cache-generate-nov-databases
7088 @findex gnus-cache-generate-active
7089 @vindex gnus-cache-active-file
7090 The cache stores information on what articles it contains in its active
7091 file (@code{gnus-cache-active-file}). If this file (or any other parts
7092 of the cache) becomes all messed up for some reason or other, Gnus
7093 offers two functions that will try to set things right. @kbd{M-x
7094 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
7095 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7098 @findex gnus-cache-move-cache
7099 @code{gnus-cache-move-cache} will move your whole
7100 @code{gnus-cache-directory} to some other location. You get asked to
7101 where, isn't that cool?
7103 @node Persistent Articles
7104 @section Persistent Articles
7105 @cindex persistent articles
7107 Closely related to article caching, we have @dfn{persistent articles}.
7108 In fact, it's just a different way of looking at caching, and much more
7109 useful in my opinion.
7111 Say you're reading a newsgroup, and you happen on to some valuable gem
7112 that you want to keep and treasure forever. You'd normally just save it
7113 (using one of the many saving commands) in some file. The problem with
7114 that is that it's just, well, yucky. Ideally you'd prefer just having
7115 the article remain in the group where you found it forever; untouched by
7116 the expiry going on at the news server.
7118 This is what a @dfn{persistent article} is---an article that just won't
7119 be deleted. It's implemented using the normal cache functions, but
7120 you use two explicit commands for managing persistent articles:
7126 @findex gnus-cache-enter-article
7127 Make the current article persistent (@code{gnus-cache-enter-article}).
7130 @kindex M-* (Summary)
7131 @findex gnus-cache-remove-article
7132 Remove the current article from the persistent articles
7133 (@code{gnus-cache-remove-article}). This will normally delete the
7137 Both these commands understand the process/prefix convention.
7139 To avoid having all ticked articles (and stuff) entered into the cache,
7140 you should set @code{gnus-use-cache} to @code{passive} if you're just
7141 interested in persistent articles:
7144 (setq gnus-use-cache 'passive)
7148 @node Article Backlog
7149 @section Article Backlog
7151 @cindex article backlog
7153 If you have a slow connection, but the idea of using caching seems
7154 unappealing to you (and it is, really), you can help the situation some
7155 by switching on the @dfn{backlog}. This is where Gnus will buffer
7156 already read articles so that it doesn't have to re-fetch articles
7157 you've already read. This only helps if you are in the habit of
7158 re-selecting articles you've recently read, of course. If you never do
7159 that, turning the backlog on will slow Gnus down a little bit, and
7160 increase memory usage some.
7162 @vindex gnus-keep-backlog
7163 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
7164 at most @var{n} old articles in a buffer for later re-fetching. If this
7165 variable is non-@code{nil} and is not a number, Gnus will store
7166 @emph{all} read articles, which means that your Emacs will grow without
7167 bound before exploding and taking your machine down with you. I put
7168 that in there just to keep y'all on your toes.
7170 The default value is 20.
7173 @node Saving Articles
7174 @section Saving Articles
7175 @cindex saving articles
7177 Gnus can save articles in a number of ways. Below is the documentation
7178 for saving articles in a fairly straight-forward fashion (i.e., little
7179 processing of the article is done before it is saved). For a different
7180 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7181 (@pxref{Decoding Articles}).
7183 For the commands listed here, the target is a file. If you want to
7184 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7185 command (@pxref{Mail Group Commands}).
7187 @vindex gnus-save-all-headers
7188 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
7189 unwanted headers before saving the article.
7191 @vindex gnus-saved-headers
7192 If the preceding variable is @code{nil}, all headers that match the
7193 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7194 deleted before saving.
7200 @kindex O o (Summary)
7202 @findex gnus-summary-save-article
7203 @c @icon{gnus-summary-save-article}
7204 Save the current article using the default article saver
7205 (@code{gnus-summary-save-article}).
7208 @kindex O m (Summary)
7209 @findex gnus-summary-save-article-mail
7210 Save the current article in mail format
7211 (@code{gnus-summary-save-article-mail}).
7214 @kindex O r (Summary)
7215 @findex gnus-summary-save-article-rmail
7216 Save the current article in rmail format
7217 (@code{gnus-summary-save-article-rmail}).
7220 @kindex O f (Summary)
7221 @findex gnus-summary-save-article-file
7222 @c @icon{gnus-summary-save-article-file}
7223 Save the current article in plain file format
7224 (@code{gnus-summary-save-article-file}).
7227 @kindex O F (Summary)
7228 @findex gnus-summary-write-article-file
7229 Write the current article in plain file format, overwriting any previous
7230 file contents (@code{gnus-summary-write-article-file}).
7233 @kindex O b (Summary)
7234 @findex gnus-summary-save-article-body-file
7235 Save the current article body in plain file format
7236 (@code{gnus-summary-save-article-body-file}).
7239 @kindex O h (Summary)
7240 @findex gnus-summary-save-article-folder
7241 Save the current article in mh folder format
7242 (@code{gnus-summary-save-article-folder}).
7245 @kindex O v (Summary)
7246 @findex gnus-summary-save-article-vm
7247 Save the current article in a VM folder
7248 (@code{gnus-summary-save-article-vm}).
7252 @kindex O p (Summary)
7254 @findex gnus-summary-pipe-output
7255 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
7256 the current article to a process (@code{gnus-summary-pipe-output}).
7257 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7258 complete headers in the piped output.
7261 @kindex O P (Summary)
7262 @findex gnus-summary-muttprint
7263 @vindex gnus-summary-muttprint-program
7264 Save the current article into muttprint. That is, print it using the
7265 external program Muttprint (see
7266 @uref{http://muttprint.sourceforge.net/}). The program name and
7267 options to use is controlled by the variable
7268 @code{gnus-summary-muttprint-program}. (@code{gnus-summary-muttprint}).
7272 @vindex gnus-prompt-before-saving
7273 All these commands use the process/prefix convention
7274 (@pxref{Process/Prefix}). If you save bunches of articles using these
7275 functions, you might get tired of being prompted for files to save each
7276 and every article in. The prompting action is controlled by
7277 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7278 default, giving you that excessive prompting action you know and
7279 loathe. If you set this variable to @code{t} instead, you'll be prompted
7280 just once for each series of articles you save. If you like to really
7281 have Gnus do all your thinking for you, you can even set this variable
7282 to @code{nil}, which means that you will never be prompted for files to
7283 save articles in. Gnus will simply save all the articles in the default
7287 @vindex gnus-default-article-saver
7288 You can customize the @code{gnus-default-article-saver} variable to make
7289 Gnus do what you want it to. You can use any of the six ready-made
7290 functions below, or you can create your own.
7294 @item gnus-summary-save-in-rmail
7295 @findex gnus-summary-save-in-rmail
7296 @vindex gnus-rmail-save-name
7297 @findex gnus-plain-save-name
7298 This is the default format, @dfn{babyl}. Uses the function in the
7299 @code{gnus-rmail-save-name} variable to get a file name to save the
7300 article in. The default is @code{gnus-plain-save-name}.
7302 @item gnus-summary-save-in-mail
7303 @findex gnus-summary-save-in-mail
7304 @vindex gnus-mail-save-name
7305 Save in a Unix mail (mbox) file. Uses the function in the
7306 @code{gnus-mail-save-name} variable to get a file name to save the
7307 article in. The default is @code{gnus-plain-save-name}.
7309 @item gnus-summary-save-in-file
7310 @findex gnus-summary-save-in-file
7311 @vindex gnus-file-save-name
7312 @findex gnus-numeric-save-name
7313 Append the article straight to an ordinary file. Uses the function in
7314 the @code{gnus-file-save-name} variable to get a file name to save the
7315 article in. The default is @code{gnus-numeric-save-name}.
7317 @item gnus-summary-write-to-file
7318 @findex gnus-summary-write-to-file
7319 Write the article straight to an ordinary file. The file is
7320 overwritten if it exists. Uses the function in the
7321 @code{gnus-file-save-name} variable to get a file name to save the
7322 article in. The default is @code{gnus-numeric-save-name}.
7324 @item gnus-summary-save-body-in-file
7325 @findex gnus-summary-save-body-in-file
7326 Append the article body to an ordinary file. Uses the function in the
7327 @code{gnus-file-save-name} variable to get a file name to save the
7328 article in. The default is @code{gnus-numeric-save-name}.
7330 @item gnus-summary-save-in-folder
7331 @findex gnus-summary-save-in-folder
7332 @findex gnus-folder-save-name
7333 @findex gnus-Folder-save-name
7334 @vindex gnus-folder-save-name
7337 Save the article to an MH folder using @code{rcvstore} from the MH
7338 library. Uses the function in the @code{gnus-folder-save-name} variable
7339 to get a file name to save the article in. The default is
7340 @code{gnus-folder-save-name}, but you can also use
7341 @code{gnus-Folder-save-name}, which creates capitalized names.
7343 @item gnus-summary-save-in-vm
7344 @findex gnus-summary-save-in-vm
7345 Save the article in a VM folder. You have to have the VM mail
7346 reader to use this setting.
7349 @vindex gnus-article-save-directory
7350 All of these functions, except for the last one, will save the article
7351 in the @code{gnus-article-save-directory}, which is initialized from the
7352 @code{SAVEDIR} environment variable. This is @file{~/News/} by
7355 As you can see above, the functions use different functions to find a
7356 suitable name of a file to save the article in. Below is a list of
7357 available functions that generate names:
7361 @item gnus-Numeric-save-name
7362 @findex gnus-Numeric-save-name
7363 File names like @file{~/News/Alt.andrea-dworkin/45}.
7365 @item gnus-numeric-save-name
7366 @findex gnus-numeric-save-name
7367 File names like @file{~/News/alt.andrea-dworkin/45}.
7369 @item gnus-Plain-save-name
7370 @findex gnus-Plain-save-name
7371 File names like @file{~/News/Alt.andrea-dworkin}.
7373 @item gnus-plain-save-name
7374 @findex gnus-plain-save-name
7375 File names like @file{~/News/alt.andrea-dworkin}.
7377 @item gnus-sender-save-name
7378 @findex gnus-sender-save-name
7379 File names like @file{~/News/larsi}.
7382 @vindex gnus-split-methods
7383 You can have Gnus suggest where to save articles by plonking a regexp into
7384 the @code{gnus-split-methods} alist. For instance, if you would like to
7385 save articles related to Gnus in the file @file{gnus-stuff}, and articles
7386 related to VM in @code{vm-stuff}, you could set this variable to something
7390 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
7391 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
7392 (my-choosing-function "../other-dir/my-stuff")
7393 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
7396 We see that this is a list where each element is a list that has two
7397 elements---the @dfn{match} and the @dfn{file}. The match can either be
7398 a string (in which case it is used as a regexp to match on the article
7399 head); it can be a symbol (which will be called as a function with the
7400 group name as a parameter); or it can be a list (which will be
7401 @code{eval}ed). If any of these actions have a non-@code{nil} result,
7402 the @dfn{file} will be used as a default prompt. In addition, the
7403 result of the operation itself will be used if the function or form
7404 called returns a string or a list of strings.
7406 You basically end up with a list of file names that might be used when
7407 saving the current article. (All ``matches'' will be used.) You will
7408 then be prompted for what you really want to use as a name, with file
7409 name completion over the results from applying this variable.
7411 This variable is @code{((gnus-article-archive-name))} by default, which
7412 means that Gnus will look at the articles it saves for an
7413 @code{Archive-name} line and use that as a suggestion for the file
7416 Here's an example function to clean up file names somewhat. If you have
7417 lots of mail groups called things like
7418 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
7419 these group names before creating the file name to save to. The
7420 following will do just that:
7423 (defun my-save-name (group)
7424 (when (string-match "^nnml:mail." group)
7425 (substring group (match-end 0))))
7427 (setq gnus-split-methods
7428 '((gnus-article-archive-name)
7433 @vindex gnus-use-long-file-name
7434 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
7435 @code{nil}, all the preceding functions will replace all periods
7436 (@samp{.}) in the group names with slashes (@samp{/})---which means that
7437 the functions will generate hierarchies of directories instead of having
7438 all the files in the top level directory
7439 (@file{~/News/alt/andrea-dworkin} instead of
7440 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
7441 on most systems. However, for historical reasons, this is @code{nil} on
7442 Xenix and usg-unix-v machines by default.
7444 This function also affects kill and score file names. If this variable
7445 is a list, and the list contains the element @code{not-score}, long file
7446 names will not be used for score files, if it contains the element
7447 @code{not-save}, long file names will not be used for saving, and if it
7448 contains the element @code{not-kill}, long file names will not be used
7451 If you'd like to save articles in a hierarchy that looks something like
7455 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
7456 (setq gnus-default-article-saver
7457 'gnus-summary-save-in-file) ; no encoding
7460 Then just save with @kbd{o}. You'd then read this hierarchy with
7461 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
7462 the top level directory as the argument (@file{~/News/}). Then just walk
7463 around to the groups/directories with @code{nneething}.
7466 @node Decoding Articles
7467 @section Decoding Articles
7468 @cindex decoding articles
7470 Sometime users post articles (or series of articles) that have been
7471 encoded in some way or other. Gnus can decode them for you.
7474 * Uuencoded Articles:: Uudecode articles.
7475 * Shell Archives:: Unshar articles.
7476 * PostScript Files:: Split PostScript.
7477 * Other Files:: Plain save and binhex.
7478 * Decoding Variables:: Variables for a happy decoding.
7479 * Viewing Files:: You want to look at the result of the decoding?
7483 @cindex article series
7484 All these functions use the process/prefix convention
7485 (@pxref{Process/Prefix}) for finding out what articles to work on, with
7486 the extension that a ``single article'' means ``a single series''. Gnus
7487 can find out by itself what articles belong to a series, decode all the
7488 articles and unpack/view/save the resulting file(s).
7490 Gnus guesses what articles are in the series according to the following
7491 simplish rule: The subjects must be (nearly) identical, except for the
7492 last two numbers of the line. (Spaces are largely ignored, however.)
7494 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
7495 will find all the articles that match the regexp @samp{^cat.gif
7496 ([0-9]+/[0-9]+).*$}.
7498 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
7499 series}, will not be properly recognized by any of the automatic viewing
7500 commands, and you have to mark the articles manually with @kbd{#}.
7503 @node Uuencoded Articles
7504 @subsection Uuencoded Articles
7506 @cindex uuencoded articles
7511 @kindex X u (Summary)
7512 @findex gnus-uu-decode-uu
7513 @c @icon{gnus-uu-decode-uu}
7514 Uudecodes the current series (@code{gnus-uu-decode-uu}).
7517 @kindex X U (Summary)
7518 @findex gnus-uu-decode-uu-and-save
7519 Uudecodes and saves the current series
7520 (@code{gnus-uu-decode-uu-and-save}).
7523 @kindex X v u (Summary)
7524 @findex gnus-uu-decode-uu-view
7525 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
7528 @kindex X v U (Summary)
7529 @findex gnus-uu-decode-uu-and-save-view
7530 Uudecodes, views and saves the current series
7531 (@code{gnus-uu-decode-uu-and-save-view}).
7535 Remember that these all react to the presence of articles marked with
7536 the process mark. If, for instance, you'd like to decode and save an
7537 entire newsgroup, you'd typically do @kbd{M P a}
7538 (@code{gnus-uu-mark-all}) and then @kbd{X U}
7539 (@code{gnus-uu-decode-uu-and-save}).
7541 All this is very much different from how @code{gnus-uu} worked with
7542 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
7543 the sun. This version of @code{gnus-uu} generally assumes that you mark
7544 articles in some way (@pxref{Setting Process Marks}) and then press
7547 @vindex gnus-uu-notify-files
7548 Note: When trying to decode articles that have names matching
7549 @code{gnus-uu-notify-files}, which is hard-coded to
7550 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
7551 automatically post an article on @samp{comp.unix.wizards} saying that
7552 you have just viewed the file in question. This feature can't be turned
7556 @node Shell Archives
7557 @subsection Shell Archives
7559 @cindex shell archives
7560 @cindex shared articles
7562 Shell archives (``shar files'') used to be a popular way to distribute
7563 sources, but it isn't used all that much today. In any case, we have
7564 some commands to deal with these:
7569 @kindex X s (Summary)
7570 @findex gnus-uu-decode-unshar
7571 Unshars the current series (@code{gnus-uu-decode-unshar}).
7574 @kindex X S (Summary)
7575 @findex gnus-uu-decode-unshar-and-save
7576 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
7579 @kindex X v s (Summary)
7580 @findex gnus-uu-decode-unshar-view
7581 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
7584 @kindex X v S (Summary)
7585 @findex gnus-uu-decode-unshar-and-save-view
7586 Unshars, views and saves the current series
7587 (@code{gnus-uu-decode-unshar-and-save-view}).
7591 @node PostScript Files
7592 @subsection PostScript Files
7598 @kindex X p (Summary)
7599 @findex gnus-uu-decode-postscript
7600 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
7603 @kindex X P (Summary)
7604 @findex gnus-uu-decode-postscript-and-save
7605 Unpack and save the current PostScript series
7606 (@code{gnus-uu-decode-postscript-and-save}).
7609 @kindex X v p (Summary)
7610 @findex gnus-uu-decode-postscript-view
7611 View the current PostScript series
7612 (@code{gnus-uu-decode-postscript-view}).
7615 @kindex X v P (Summary)
7616 @findex gnus-uu-decode-postscript-and-save-view
7617 View and save the current PostScript series
7618 (@code{gnus-uu-decode-postscript-and-save-view}).
7623 @subsection Other Files
7627 @kindex X o (Summary)
7628 @findex gnus-uu-decode-save
7629 Save the current series
7630 (@code{gnus-uu-decode-save}).
7633 @kindex X b (Summary)
7634 @findex gnus-uu-decode-binhex
7635 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
7636 doesn't really work yet.
7640 @node Decoding Variables
7641 @subsection Decoding Variables
7643 Adjective, not verb.
7646 * Rule Variables:: Variables that say how a file is to be viewed.
7647 * Other Decode Variables:: Other decode variables.
7648 * Uuencoding and Posting:: Variables for customizing uuencoding.
7652 @node Rule Variables
7653 @subsubsection Rule Variables
7654 @cindex rule variables
7656 Gnus uses @dfn{rule variables} to decide how to view a file. All these
7657 variables are of the form
7660 (list '(regexp1 command2)
7667 @item gnus-uu-user-view-rules
7668 @vindex gnus-uu-user-view-rules
7670 This variable is consulted first when viewing files. If you wish to use,
7671 for instance, @code{sox} to convert an @samp{.au} sound file, you could
7674 (setq gnus-uu-user-view-rules
7675 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
7678 @item gnus-uu-user-view-rules-end
7679 @vindex gnus-uu-user-view-rules-end
7680 This variable is consulted if Gnus couldn't make any matches from the
7681 user and default view rules.
7683 @item gnus-uu-user-archive-rules
7684 @vindex gnus-uu-user-archive-rules
7685 This variable can be used to say what commands should be used to unpack
7690 @node Other Decode Variables
7691 @subsubsection Other Decode Variables
7694 @vindex gnus-uu-grabbed-file-functions
7696 @item gnus-uu-grabbed-file-functions
7697 All functions in this list will be called right after each file has been
7698 successfully decoded---so that you can move or view files right away,
7699 and don't have to wait for all files to be decoded before you can do
7700 anything. Ready-made functions you can put in this list are:
7704 @item gnus-uu-grab-view
7705 @findex gnus-uu-grab-view
7708 @item gnus-uu-grab-move
7709 @findex gnus-uu-grab-move
7710 Move the file (if you're using a saving function.)
7713 @item gnus-uu-be-dangerous
7714 @vindex gnus-uu-be-dangerous
7715 Specifies what to do if unusual situations arise during decoding. If
7716 @code{nil}, be as conservative as possible. If @code{t}, ignore things
7717 that didn't work, and overwrite existing files. Otherwise, ask each
7720 @item gnus-uu-ignore-files-by-name
7721 @vindex gnus-uu-ignore-files-by-name
7722 Files with name matching this regular expression won't be viewed.
7724 @item gnus-uu-ignore-files-by-type
7725 @vindex gnus-uu-ignore-files-by-type
7726 Files with a @sc{mime} type matching this variable won't be viewed.
7727 Note that Gnus tries to guess what type the file is based on the name.
7728 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
7731 @item gnus-uu-tmp-dir
7732 @vindex gnus-uu-tmp-dir
7733 Where @code{gnus-uu} does its work.
7735 @item gnus-uu-do-not-unpack-archives
7736 @vindex gnus-uu-do-not-unpack-archives
7737 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
7738 looking for files to display.
7740 @item gnus-uu-view-and-save
7741 @vindex gnus-uu-view-and-save
7742 Non-@code{nil} means that the user will always be asked to save a file
7745 @item gnus-uu-ignore-default-view-rules
7746 @vindex gnus-uu-ignore-default-view-rules
7747 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
7750 @item gnus-uu-ignore-default-archive-rules
7751 @vindex gnus-uu-ignore-default-archive-rules
7752 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
7755 @item gnus-uu-kill-carriage-return
7756 @vindex gnus-uu-kill-carriage-return
7757 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
7760 @item gnus-uu-unmark-articles-not-decoded
7761 @vindex gnus-uu-unmark-articles-not-decoded
7762 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
7763 decoded articles as unread.
7765 @item gnus-uu-correct-stripped-uucode
7766 @vindex gnus-uu-correct-stripped-uucode
7767 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
7768 uuencoded files that have had trailing spaces deleted.
7770 @item gnus-uu-pre-uudecode-hook
7771 @vindex gnus-uu-pre-uudecode-hook
7772 Hook run before sending a message to @code{uudecode}.
7774 @item gnus-uu-view-with-metamail
7775 @vindex gnus-uu-view-with-metamail
7777 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
7778 commands defined by the rule variables and just fudge a @sc{mime}
7779 content type based on the file name. The result will be fed to
7780 @code{metamail} for viewing.
7782 @item gnus-uu-save-in-digest
7783 @vindex gnus-uu-save-in-digest
7784 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
7785 decoding, will save in digests. If this variable is @code{nil},
7786 @code{gnus-uu} will just save everything in a file without any
7787 embellishments. The digesting almost conforms to RFC 1153---no easy way
7788 to specify any meaningful volume and issue numbers were found, so I
7789 simply dropped them.
7794 @node Uuencoding and Posting
7795 @subsubsection Uuencoding and Posting
7799 @item gnus-uu-post-include-before-composing
7800 @vindex gnus-uu-post-include-before-composing
7801 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
7802 before you compose the article. If this variable is @code{t}, you can
7803 either include an encoded file with @kbd{C-c C-i} or have one included
7804 for you when you post the article.
7806 @item gnus-uu-post-length
7807 @vindex gnus-uu-post-length
7808 Maximum length of an article. The encoded file will be split into how
7809 many articles it takes to post the entire file.
7811 @item gnus-uu-post-threaded
7812 @vindex gnus-uu-post-threaded
7813 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
7814 thread. This may not be smart, as no other decoder I have seen is able
7815 to follow threads when collecting uuencoded articles. (Well, I have
7816 seen one package that does that---@code{gnus-uu}, but somehow, I don't
7817 think that counts...) Default is @code{nil}.
7819 @item gnus-uu-post-separate-description
7820 @vindex gnus-uu-post-separate-description
7821 Non-@code{nil} means that the description will be posted in a separate
7822 article. The first article will typically be numbered (0/x). If this
7823 variable is @code{nil}, the description the user enters will be included
7824 at the beginning of the first article, which will be numbered (1/x).
7825 Default is @code{t}.
7831 @subsection Viewing Files
7832 @cindex viewing files
7833 @cindex pseudo-articles
7835 After decoding, if the file is some sort of archive, Gnus will attempt
7836 to unpack the archive and see if any of the files in the archive can be
7837 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
7838 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
7839 uncompress and de-tar the main file, and then view the two pictures.
7840 This unpacking process is recursive, so if the archive contains archives
7841 of archives, it'll all be unpacked.
7843 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
7844 extracted file into the summary buffer. If you go to these
7845 ``articles'', you will be prompted for a command to run (usually Gnus
7846 will make a suggestion), and then the command will be run.
7848 @vindex gnus-view-pseudo-asynchronously
7849 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
7850 until the viewing is done before proceeding.
7852 @vindex gnus-view-pseudos
7853 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
7854 the pseudo-articles into the summary buffer, but view them
7855 immediately. If this variable is @code{not-confirm}, the user won't even
7856 be asked for a confirmation before viewing is done.
7858 @vindex gnus-view-pseudos-separately
7859 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
7860 pseudo-article will be created for each file to be viewed. If
7861 @code{nil}, all files that use the same viewing command will be given as
7862 a list of parameters to that command.
7864 @vindex gnus-insert-pseudo-articles
7865 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
7866 pseudo-articles when decoding. It is @code{t} by default.
7868 So; there you are, reading your @emph{pseudo-articles} in your
7869 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
7870 Why isn't anything real anymore? How did we get here?
7873 @node Article Treatment
7874 @section Article Treatment
7876 Reading through this huge manual, you may have quite forgotten that the
7877 object of newsreaders is to actually, like, read what people have
7878 written. Reading articles. Unfortunately, people are quite bad at
7879 writing, so there are tons of functions and variables to make reading
7880 these articles easier.
7883 * Article Highlighting:: You want to make the article look like fruit salad.
7884 * Article Fontisizing:: Making emphasized text look nice.
7885 * Article Hiding:: You also want to make certain info go away.
7886 * Article Washing:: Lots of way-neat functions to make life better.
7887 * Article Header:: Doing various header transformations.
7888 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
7889 * Article Date:: Grumble, UT!
7890 * Article Display:: Display various stuff---X-Face, Picons, Smileys
7891 * Article Signature:: What is a signature?
7892 * Article Miscellania:: Various other stuff.
7896 @node Article Highlighting
7897 @subsection Article Highlighting
7898 @cindex highlighting
7900 Not only do you want your article buffer to look like fruit salad, but
7901 you want it to look like technicolor fruit salad.
7906 @kindex W H a (Summary)
7907 @findex gnus-article-highlight
7908 @findex gnus-article-maybe-highlight
7909 Do much highlighting of the current article
7910 (@code{gnus-article-highlight}). This function highlights header, cited
7911 text, the signature, and adds buttons to the body and the head.
7914 @kindex W H h (Summary)
7915 @findex gnus-article-highlight-headers
7916 @vindex gnus-header-face-alist
7917 Highlight the headers (@code{gnus-article-highlight-headers}). The
7918 highlighting will be done according to the @code{gnus-header-face-alist}
7919 variable, which is a list where each element has the form
7920 @code{(@var{regexp} @var{name} @var{content})}.
7921 @var{regexp} is a regular expression for matching the
7922 header, @var{name} is the face used for highlighting the header name
7923 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
7924 the header value. The first match made will be used. Note that
7925 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
7928 @kindex W H c (Summary)
7929 @findex gnus-article-highlight-citation
7930 Highlight cited text (@code{gnus-article-highlight-citation}).
7932 Some variables to customize the citation highlights:
7935 @vindex gnus-cite-parse-max-size
7937 @item gnus-cite-parse-max-size
7938 If the article size if bigger than this variable (which is 25000 by
7939 default), no citation highlighting will be performed.
7941 @item gnus-cite-max-prefix
7942 @vindex gnus-cite-max-prefix
7943 Maximum possible length for a citation prefix (default 20).
7945 @item gnus-cite-face-list
7946 @vindex gnus-cite-face-list
7947 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
7948 When there are citations from multiple articles in the same message,
7949 Gnus will try to give each citation from each article its own face.
7950 This should make it easier to see who wrote what.
7952 @item gnus-supercite-regexp
7953 @vindex gnus-supercite-regexp
7954 Regexp matching normal Supercite attribution lines.
7956 @item gnus-supercite-secondary-regexp
7957 @vindex gnus-supercite-secondary-regexp
7958 Regexp matching mangled Supercite attribution lines.
7960 @item gnus-cite-minimum-match-count
7961 @vindex gnus-cite-minimum-match-count
7962 Minimum number of identical prefixes we have to see before we believe
7963 that it's a citation.
7965 @item gnus-cite-attribution-prefix
7966 @vindex gnus-cite-attribution-prefix
7967 Regexp matching the beginning of an attribution line.
7969 @item gnus-cite-attribution-suffix
7970 @vindex gnus-cite-attribution-suffix
7971 Regexp matching the end of an attribution line.
7973 @item gnus-cite-attribution-face
7974 @vindex gnus-cite-attribution-face
7975 Face used for attribution lines. It is merged with the face for the
7976 cited text belonging to the attribution.
7982 @kindex W H s (Summary)
7983 @vindex gnus-signature-separator
7984 @vindex gnus-signature-face
7985 @findex gnus-article-highlight-signature
7986 Highlight the signature (@code{gnus-article-highlight-signature}).
7987 Everything after @code{gnus-signature-separator} (@pxref{Article
7988 Signature}) in an article will be considered a signature and will be
7989 highlighted with @code{gnus-signature-face}, which is @code{italic} by
7994 @xref{Customizing Articles}, for how to highlight articles automatically.
7997 @node Article Fontisizing
7998 @subsection Article Fontisizing
8000 @cindex article emphasis
8002 @findex gnus-article-emphasize
8003 @kindex W e (Summary)
8004 People commonly add emphasis to words in news articles by writing things
8005 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
8006 this look nicer by running the article through the @kbd{W e}
8007 (@code{gnus-article-emphasize}) command.
8009 @vindex gnus-emphasis-alist
8010 How the emphasis is computed is controlled by the
8011 @code{gnus-emphasis-alist} variable. This is an alist where the first
8012 element is a regular expression to be matched. The second is a number
8013 that says what regular expression grouping is used to find the entire
8014 emphasized word. The third is a number that says what regexp grouping
8015 should be displayed and highlighted. (The text between these two
8016 groupings will be hidden.) The fourth is the face used for
8020 (setq gnus-emphasis-alist
8021 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
8022 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
8031 @vindex gnus-emphasis-underline
8032 @vindex gnus-emphasis-bold
8033 @vindex gnus-emphasis-italic
8034 @vindex gnus-emphasis-underline-bold
8035 @vindex gnus-emphasis-underline-italic
8036 @vindex gnus-emphasis-bold-italic
8037 @vindex gnus-emphasis-underline-bold-italic
8038 By default, there are seven rules, and they use the following faces:
8039 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
8040 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
8041 @code{gnus-emphasis-underline-italic},
8042 @code{gnus-emphasis-underline-bold}, and
8043 @code{gnus-emphasis-underline-bold-italic}.
8045 If you want to change these faces, you can either use @kbd{M-x
8046 customize}, or you can use @code{copy-face}. For instance, if you want
8047 to make @code{gnus-emphasis-italic} use a red face instead, you could
8051 (copy-face 'red 'gnus-emphasis-italic)
8054 @vindex gnus-group-highlight-words-alist
8056 If you want to highlight arbitrary words, you can use the
8057 @code{gnus-group-highlight-words-alist} variable, which uses the same
8058 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
8059 parameter (@pxref{Group Parameters}) can also be used.
8061 @xref{Customizing Articles}, for how to fontize articles automatically.
8064 @node Article Hiding
8065 @subsection Article Hiding
8066 @cindex article hiding
8068 Or rather, hiding certain things in each article. There usually is much
8069 too much cruft in most articles.
8074 @kindex W W a (Summary)
8075 @findex gnus-article-hide
8076 Do quite a lot of hiding on the article buffer
8077 (@kbd{gnus-article-hide}). In particular, this function will hide
8078 headers, PGP, cited text and the signature.
8081 @kindex W W h (Summary)
8082 @findex gnus-article-hide-headers
8083 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
8087 @kindex W W b (Summary)
8088 @findex gnus-article-hide-boring-headers
8089 Hide headers that aren't particularly interesting
8090 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
8093 @kindex W W s (Summary)
8094 @findex gnus-article-hide-signature
8095 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
8099 @kindex W W l (Summary)
8100 @findex gnus-article-hide-list-identifiers
8101 @vindex gnus-list-identifiers
8102 Strip list identifiers specified in @code{gnus-list-identifiers}. These
8103 are strings some mailing list servers add to the beginning of all
8104 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
8105 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
8106 may not contain @code{\\(..\\)}.
8110 @item gnus-list-identifiers
8111 @vindex gnus-list-identifiers
8112 A regular expression that matches list identifiers to be removed from
8113 subject. This can also be a list of regular expressions.
8118 @kindex W W P (Summary)
8119 @findex gnus-article-hide-pem
8120 Hide @sc{pem} (privacy enhanced messages) cruft
8121 (@code{gnus-article-hide-pem}).
8124 @kindex W W B (Summary)
8125 @findex gnus-article-strip-banner
8126 @vindex gnus-article-banner-alist
8127 @vindex gnus-article-address-banner-alist
8130 @cindex stripping advertisements
8131 @cindex advertisements
8132 Strip the banner specified by the @code{banner} group parameter
8133 (@code{gnus-article-strip-banner}). This is mainly used to hide those
8134 annoying banners and/or signatures that some mailing lists and moderated
8135 groups adds to all the messages. The way to use this function is to add
8136 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8137 group you want banners stripped from. The parameter either be a string,
8138 which will be interpreted as a regular expression matching text to be
8139 removed, or the symbol @code{signature}, meaning that the (last)
8140 signature should be removed, or other symbol, meaning that the
8141 corresponding regular expression in @code{gnus-article-banner-alist} is
8144 Regardless of a group, you can hide things like advertisements only when
8145 the sender of an article has a certain mail address specified in
8146 @code{gnus-article-address-banner-alist}.
8150 @item gnus-article-address-banner-alist
8151 @vindex gnus-article-address-banner-alist
8152 Alist of mail addresses and banners. Each element has the form
8153 @code{(ADDRESS . BANNER)}, where ADDRESS is a regexp matching a mail
8154 address in the From header, BANNER is one of a symbol @code{signature},
8155 an item in @code{gnus-article-banner-alist}, a regexp and @code{nil}.
8156 If ADDRESS matches author's mail address, it will remove things like
8157 advertisements. For example, if a sender has the mail address
8158 @samp{hail@@yoo-hoo.co.jp} and there is a banner something like
8159 @samp{Do You Yoo-hoo!?} in all articles he sends, you can use the
8160 following element to remove them:
8163 ("@@yoo-hoo\\.co\\.jp\\'" . "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8169 @kindex W W c (Summary)
8170 @findex gnus-article-hide-citation
8171 Hide citation (@code{gnus-article-hide-citation}). Some variables for
8172 customizing the hiding:
8176 @item gnus-cited-opened-text-button-line-format
8177 @itemx gnus-cited-closed-text-button-line-format
8178 @vindex gnus-cited-closed-text-button-line-format
8179 @vindex gnus-cited-opened-text-button-line-format
8180 Gnus adds buttons to show where the cited text has been hidden, and to
8181 allow toggle hiding the text. The format of the variable is specified
8182 by these format-like variable (@pxref{Formatting Variables}). These
8187 Starting point of the hidden text.
8189 Ending point of the hidden text.
8191 Number of characters in the hidden region.
8193 Number of lines of hidden text.
8196 @item gnus-cited-lines-visible
8197 @vindex gnus-cited-lines-visible
8198 The number of lines at the beginning of the cited text to leave
8199 shown. This can also be a cons cell with the number of lines at the top
8200 and bottom of the text, respectively, to remain visible.
8205 @kindex W W C-c (Summary)
8206 @findex gnus-article-hide-citation-maybe
8208 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8209 following two variables:
8212 @item gnus-cite-hide-percentage
8213 @vindex gnus-cite-hide-percentage
8214 If the cited text is of a bigger percentage than this variable (default
8215 50), hide the cited text.
8217 @item gnus-cite-hide-absolute
8218 @vindex gnus-cite-hide-absolute
8219 The cited text must have at least this length (default 10) before it
8224 @kindex W W C (Summary)
8225 @findex gnus-article-hide-citation-in-followups
8226 Hide cited text in articles that aren't roots
8227 (@code{gnus-article-hide-citation-in-followups}). This isn't very
8228 useful as an interactive command, but might be a handy function to stick
8229 have happen automatically (@pxref{Customizing Articles}).
8233 All these ``hiding'' commands are toggles, but if you give a negative
8234 prefix to these commands, they will show what they have previously
8235 hidden. If you give a positive prefix, they will always hide.
8237 Also @pxref{Article Highlighting} for further variables for
8238 citation customization.
8240 @xref{Customizing Articles}, for how to hide article elements
8244 @node Article Washing
8245 @subsection Article Washing
8247 @cindex article washing
8249 We call this ``article washing'' for a really good reason. Namely, the
8250 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8252 @dfn{Washing} is defined by us as ``changing something from something to
8253 something else'', but normally results in something looking better.
8256 @xref{Customizing Articles}, if you want to change how Gnus displays
8257 articles by default.
8262 This is not really washing, it's sort of the opposite of washing. If
8263 you type this, you see the article exactly as it exists on disk or on
8267 @kindex W l (Summary)
8268 @findex gnus-summary-stop-page-breaking
8269 Remove page breaks from the current article
8270 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
8274 @kindex W r (Summary)
8275 @findex gnus-summary-caesar-message
8276 @c @icon{gnus-summary-caesar-message}
8277 Do a Caesar rotate (rot13) on the article buffer
8278 (@code{gnus-summary-caesar-message}).
8279 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8280 (Typically offensive jokes and such.)
8282 It's commonly called ``rot13'' because each letter is rotated 13
8283 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
8284 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
8285 is rumored to have employed this form of, uh, somewhat weak encryption.
8288 @kindex W m (Summary)
8289 @findex gnus-summary-morse-message
8290 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8294 @kindex W t (Summary)
8296 @findex gnus-summary-toggle-header
8297 Toggle whether to display all headers in the article buffer
8298 (@code{gnus-summary-toggle-header}).
8301 @kindex W v (Summary)
8302 @findex gnus-summary-verbose-headers
8303 Toggle whether to display all headers in the article buffer permanently
8304 (@code{gnus-summary-verbose-headers}).
8307 @kindex W o (Summary)
8308 @findex gnus-article-treat-overstrike
8309 Treat overstrike (@code{gnus-article-treat-overstrike}).
8312 @kindex W d (Summary)
8313 @findex gnus-article-treat-dumbquotes
8314 @vindex gnus-article-dumbquotes-map
8316 @cindex M****s*** sm*rtq**t*s
8318 Treat M****s*** sm*rtq**t*s according to
8319 @code{gnus-article-dumbquotes-map}
8320 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
8321 whether a character is a sm*rtq**t* or not, so it should only be used
8324 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
8325 an attempt to provide more quoting characters. If you see something
8326 like @code{\222} or @code{\264} where you're expecting some kind of
8327 apostrophe or quotation mark, then try this wash.
8330 @kindex W Y f (Summary)
8331 @findex gnus-article-outlook-deuglify-article
8332 @cindex Outlook Express
8333 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
8334 unwrap lines, repair attribution and rearrange citation.
8335 (@code{gnus-article-outlook-deuglify-article}).
8338 @kindex W Y u (Summary)
8339 @findex gnus-article-outlook-unwrap-lines
8340 @vindex gnus-outlook-deuglify-unwrap-min
8341 @vindex gnus-outlook-deuglify-unwrap-max
8342 Unwrap lines that appear to be wrapped citation lines. You can control
8343 what lines will be unwrapped by frobbing
8344 @code{gnus-outlook-deuglify-unwrap-min} and
8345 @code{gnus-outlook-deuglify-unwrap-max}, indicating the miminum and
8346 maximum length of an unwrapped citation line.
8347 (@code{gnus-article-outlook-unwrap-lines}).
8350 @kindex W Y a (Summary)
8351 @findex gnus-article-outlook-repair-attribution
8352 Repair a broken attribution line.
8353 (@code{gnus-article-outlook-repair-attribution}).
8356 @kindex W Y c (Summary)
8357 @findex gnus-article-outlook-rearrange-citation
8358 Repair broken citations by rearranging the text.
8359 (@code{gnus-article-outlook-rearrange-citation}).
8362 @kindex W w (Summary)
8363 @findex gnus-article-fill-cited-article
8364 Do word wrap (@code{gnus-article-fill-cited-article}).
8366 You can give the command a numerical prefix to specify the width to use
8370 @kindex W Q (Summary)
8371 @findex gnus-article-fill-long-lines
8372 Fill long lines (@code{gnus-article-fill-long-lines}).
8375 @kindex W C (Summary)
8376 @findex gnus-article-capitalize-sentences
8377 Capitalize the first word in each sentence
8378 (@code{gnus-article-capitalize-sentences}).
8381 @kindex W c (Summary)
8382 @findex gnus-article-remove-cr
8383 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
8384 (this takes care of DOS line endings), and then translate any remaining
8385 CRs into LF (this takes care of Mac line endings)
8386 (@code{gnus-article-remove-cr}).
8389 @kindex W q (Summary)
8390 @findex gnus-article-de-quoted-unreadable
8391 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
8392 Quoted-Printable is one common @sc{mime} encoding employed when sending
8393 non-ASCII (i. e., 8-bit) articles. It typically makes strings like
8394 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
8395 readable to me. Note that this is usually done automatically by
8396 Gnus if the message in question has a @code{Content-Transfer-Encoding}
8397 header that says that this encoding has been done.
8398 If a prefix is given, a charset will be asked for.
8401 @kindex W 6 (Summary)
8402 @findex gnus-article-de-base64-unreadable
8403 Treat base64 (@code{gnus-article-de-base64-unreadable}).
8404 Base64 is one common @sc{mime} encoding employed when sending non-ASCII
8405 (i. e., 8-bit) articles. Note that this is usually done
8406 automatically by Gnus if the message in question has a
8407 @code{Content-Transfer-Encoding} header that says that this encoding has
8409 If a prefix is given, a charset will be asked for.
8412 @kindex W Z (Summary)
8413 @findex gnus-article-decode-HZ
8414 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
8415 common encoding employed when sending Chinese articles. It typically
8416 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
8419 @kindex W u (Summary)
8420 @findex gnus-article-unsplit-urls
8421 Remove newlines from within URLs. Some mailers insert newlines into
8422 outgoing email messages to keep lines short. This reformatting can
8423 split long URLs onto multiple lines. Repair those URLs by removing
8424 the newlines (@code{gnus-article-unsplit-urls}).
8427 @kindex W h (Summary)
8428 @findex gnus-article-wash-html
8429 Treat @sc{html} (@code{gnus-article-wash-html}). Note that this is
8430 usually done automatically by Gnus if the message in question has a
8431 @code{Content-Type} header that says that the message is @sc{html}.
8433 If a prefix is given, a charset will be asked for.
8435 @vindex gnus-article-wash-function
8436 The default is to use the function specified by
8437 @code{mm-text-html-renderer} (@pxref{(emacs-mime)Display
8438 Customization}) to convert the @sc{html}, but this is controlled by
8439 the @code{gnus-article-wash-function} variable. Pre-defined functions
8440 you can use include:
8447 Use emacs-w3m (see @uref{http://emacs-w3m.namazu.org/} for more
8451 Use Links (see @uref{http://artax.karlin.mff.cuni.cz/~mikulas/links/}).
8454 Use Lynx (see @uref{http://lynx.browser.org/}).
8457 Use html2text -- a simple @sc{html} converter included with Gnus.
8462 @kindex W b (Summary)
8463 @findex gnus-article-add-buttons
8464 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
8465 @xref{Article Buttons}.
8468 @kindex W B (Summary)
8469 @findex gnus-article-add-buttons-to-head
8470 Add clickable buttons to the article headers
8471 (@code{gnus-article-add-buttons-to-head}).
8474 @kindex W p (Summary)
8475 @findex gnus-article-verify-x-pgp-sig
8476 Verify a signed control message (@code{gnus-article-verify-x-pgp-sig}).
8477 Control messages such as @code{newgroup} and @code{checkgroups} are
8478 usually signed by the hierarchy maintainer. You need to add the PGP
8479 public key of the maintainer to your keyring to verify the
8480 message.@footnote{PGP keys for many hierarchies are available at
8481 @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
8484 @kindex W s (Summary)
8485 @findex gnus-summary-force-verify-and-decrypt
8486 Verify a signed (PGP, @sc{pgp/mime} or @sc{s/mime}) message
8487 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
8490 @kindex W a (Summary)
8491 @findex gnus-article-strip-headers-in-body
8492 Strip headers like the @code{X-No-Archive} header from the beginning of
8493 article bodies (@code{gnus-article-strip-headers-in-body}).
8496 @kindex W E l (Summary)
8497 @findex gnus-article-strip-leading-blank-lines
8498 Remove all blank lines from the beginning of the article
8499 (@code{gnus-article-strip-leading-blank-lines}).
8502 @kindex W E m (Summary)
8503 @findex gnus-article-strip-multiple-blank-lines
8504 Replace all blank lines with empty lines and then all multiple empty
8505 lines with a single empty line.
8506 (@code{gnus-article-strip-multiple-blank-lines}).
8509 @kindex W E t (Summary)
8510 @findex gnus-article-remove-trailing-blank-lines
8511 Remove all blank lines at the end of the article
8512 (@code{gnus-article-remove-trailing-blank-lines}).
8515 @kindex W E a (Summary)
8516 @findex gnus-article-strip-blank-lines
8517 Do all the three commands above
8518 (@code{gnus-article-strip-blank-lines}).
8521 @kindex W E A (Summary)
8522 @findex gnus-article-strip-all-blank-lines
8523 Remove all blank lines
8524 (@code{gnus-article-strip-all-blank-lines}).
8527 @kindex W E s (Summary)
8528 @findex gnus-article-strip-leading-space
8529 Remove all white space from the beginning of all lines of the article
8530 body (@code{gnus-article-strip-leading-space}).
8533 @kindex W E e (Summary)
8534 @findex gnus-article-strip-trailing-space
8535 Remove all white space from the end of all lines of the article
8536 body (@code{gnus-article-strip-trailing-space}).
8540 @xref{Customizing Articles}, for how to wash articles automatically.
8543 @node Article Header
8544 @subsection Article Header
8546 These commands perform various transformations of article header.
8551 @kindex W G u (Summary)
8552 @findex gnus-article-treat-unfold-headers
8553 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
8556 @kindex W G n (Summary)
8557 @findex gnus-article-treat-fold-newsgroups
8558 Fold the @code{Newsgroups} and @code{Followup-To} headers
8559 (@code{gnus-article-treat-fold-newsgroups}).
8562 @kindex W G f (Summary)
8563 @findex gnus-article-treat-fold-headers
8564 Fold all the message headers
8565 (@code{gnus-article-treat-fold-headers}).
8569 @findex gnus-article-remove-leading-whitespace
8570 Remove excessive whitespace from all headers
8571 (@code{gnus-article-remove-leading-whitespace}).
8576 @node Article Buttons
8577 @subsection Article Buttons
8580 People often include references to other stuff in articles, and it would
8581 be nice if Gnus could just fetch whatever it is that people talk about
8582 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
8583 button on these references.
8585 @vindex gnus-button-man-handler
8586 Gnus adds @dfn{buttons} to certain standard references by default:
8587 Well-formed URLs, mail addresses, Message-IDs, Info links and man pages.
8588 This is controlled by two variables, one that handles article bodies and
8589 one that handles article heads:
8593 @item gnus-button-alist
8594 @vindex gnus-button-alist
8595 This is an alist where each entry has this form:
8598 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
8604 All text that match this regular expression (case insensitive) will be
8605 considered an external reference. Here's a typical regexp that matches
8606 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}. This can also be a
8607 variable containing a regexp, useful variables to use include
8608 @code{gnus-button-url-regexp}.
8611 Gnus has to know which parts of the matches is to be highlighted. This
8612 is a number that says what sub-expression of the regexp is to be
8613 highlighted. If you want it all highlighted, you use 0 here.
8616 This form will be @code{eval}ed, and if the result is non-@code{nil},
8617 this is considered a match. This is useful if you want extra sifting to
8618 avoid false matches.
8621 This function will be called when you click on this button.
8624 As with @var{button-par}, this is a sub-expression number, but this one
8625 says which part of the match is to be sent as data to @var{function}.
8629 So the full entry for buttonizing URLs is then
8632 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
8635 @item gnus-header-button-alist
8636 @vindex gnus-header-button-alist
8637 This is just like the other alist, except that it is applied to the
8638 article head only, and that each entry has an additional element that is
8639 used to say what headers to apply the buttonize coding to:
8642 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
8645 @var{header} is a regular expression.
8647 @item gnus-button-url-regexp
8648 @vindex gnus-button-url-regexp
8649 A regular expression that matches embedded URLs. It is used in the
8650 default values of the variables above.
8652 @item gnus-article-button-face
8653 @vindex gnus-article-button-face
8654 Face used on buttons.
8656 @item gnus-article-mouse-face
8657 @vindex gnus-article-mouse-face
8658 Face used when the mouse cursor is over a button.
8662 @xref{Customizing Articles}, for how to buttonize articles automatically.
8666 @subsection Article Date
8668 The date is most likely generated in some obscure timezone you've never
8669 heard of, so it's quite nice to be able to find out what the time was
8670 when the article was sent.
8675 @kindex W T u (Summary)
8676 @findex gnus-article-date-ut
8677 Display the date in UT (aka. GMT, aka ZULU)
8678 (@code{gnus-article-date-ut}).
8681 @kindex W T i (Summary)
8682 @findex gnus-article-date-iso8601
8684 Display the date in international format, aka. ISO 8601
8685 (@code{gnus-article-date-iso8601}).
8688 @kindex W T l (Summary)
8689 @findex gnus-article-date-local
8690 Display the date in the local timezone (@code{gnus-article-date-local}).
8693 @kindex W T p (Summary)
8694 @findex gnus-article-date-english
8695 Display the date in a format that's easily pronounceable in English
8696 (@code{gnus-article-date-english}).
8699 @kindex W T s (Summary)
8700 @vindex gnus-article-time-format
8701 @findex gnus-article-date-user
8702 @findex format-time-string
8703 Display the date using a user-defined format
8704 (@code{gnus-article-date-user}). The format is specified by the
8705 @code{gnus-article-time-format} variable, and is a string that's passed
8706 to @code{format-time-string}. See the documentation of that variable
8707 for a list of possible format specs.
8710 @kindex W T e (Summary)
8711 @findex gnus-article-date-lapsed
8712 @findex gnus-start-date-timer
8713 @findex gnus-stop-date-timer
8714 Say how much time has elapsed between the article was posted and now
8715 (@code{gnus-article-date-lapsed}). It looks something like:
8718 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
8721 @vindex gnus-article-date-lapsed-new-header
8722 The value of @code{gnus-article-date-lapsed-new-header} determines
8723 whether this header will just be added below the old Date one, or will
8726 An advantage of using Gnus to read mail is that it converts simple bugs
8727 into wonderful absurdities.
8729 If you want to have this line updated continually, you can put
8732 (gnus-start-date-timer)
8735 in your @file{.gnus.el} file, or you can run it off of some hook. If
8736 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
8740 @kindex W T o (Summary)
8741 @findex gnus-article-date-original
8742 Display the original date (@code{gnus-article-date-original}). This can
8743 be useful if you normally use some other conversion function and are
8744 worried that it might be doing something totally wrong. Say, claiming
8745 that the article was posted in 1854. Although something like that is
8746 @emph{totally} impossible. Don't you trust me? *titter*
8750 @xref{Customizing Articles}, for how to display the date in your
8751 preferred format automatically.
8754 @node Article Display
8755 @subsection Article Display
8760 These commands add various frivolous display gimmicks to the article
8761 buffer in Emacs versions that support them.
8763 @code{X-Face} headers are small black-and-white images supplied by the
8764 message headers (@pxref{X-Face}).
8766 Picons, on the other hand, reside on your own system, and Gnus will
8767 try to match the headers to what you have (@pxref{Picons}).
8769 Smileys are those little @samp{:-)} symbols that people like to litter
8770 their messages with (@pxref{Smileys}).
8772 All these functions are toggles--if the elements already exist,
8777 @kindex W D x (Summary)
8778 @findex gnus-article-display-x-face
8779 Display an @code{X-Face} in the @code{From} header.
8780 (@code{gnus-article-display-x-face}).
8783 @kindex W D d (Summary)
8784 @findex gnus-article-display-face
8785 Display a @code{Face} in the @code{From} header.
8786 (@code{gnus-article-display-face}).
8789 @kindex W D s (Summary)
8790 @findex gnus-treat-smiley
8791 Display smileys (@code{gnus-treat-smiley}).
8794 @kindex W D f (Summary)
8795 @findex gnus-treat-from-picon
8796 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
8799 @kindex W D m (Summary)
8800 @findex gnus-treat-mail-picon
8801 Piconify all mail headers (i. e., @code{Cc}, @code{To})
8802 (@code{gnus-treat-mail-picon}).
8805 @kindex W D n (Summary)
8806 @findex gnus-treat-newsgroups-picon
8807 Piconify all news headers (i. e., @code{Newsgroups} and
8808 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
8811 @kindex W D D (Summary)
8812 @findex gnus-article-remove-images
8813 Remove all images from the article buffer
8814 (@code{gnus-article-remove-images}).
8820 @node Article Signature
8821 @subsection Article Signature
8823 @cindex article signature
8825 @vindex gnus-signature-separator
8826 Each article is divided into two parts---the head and the body. The
8827 body can be divided into a signature part and a text part. The variable
8828 that says what is to be considered a signature is
8829 @code{gnus-signature-separator}. This is normally the standard
8830 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
8831 non-standard signature separators, so this variable can also be a list
8832 of regular expressions to be tested, one by one. (Searches are done
8833 from the end of the body towards the beginning.) One likely value is:
8836 (setq gnus-signature-separator
8837 '("^-- $" ; The standard
8838 "^-- *$" ; A common mangling
8839 "^-------*$" ; Many people just use a looong
8840 ; line of dashes. Shame!
8841 "^ *--------*$" ; Double-shame!
8842 "^________*$" ; Underscores are also popular
8843 "^========*$")) ; Pervert!
8846 The more permissive you are, the more likely it is that you'll get false
8849 @vindex gnus-signature-limit
8850 @code{gnus-signature-limit} provides a limit to what is considered a
8851 signature when displaying articles.
8855 If it is an integer, no signature may be longer (in characters) than
8858 If it is a floating point number, no signature may be longer (in lines)
8861 If it is a function, the function will be called without any parameters,
8862 and if it returns @code{nil}, there is no signature in the buffer.
8864 If it is a string, it will be used as a regexp. If it matches, the text
8865 in question is not a signature.
8868 This variable can also be a list where the elements may be of the types
8869 listed above. Here's an example:
8872 (setq gnus-signature-limit
8873 '(200.0 "^---*Forwarded article"))
8876 This means that if there are more than 200 lines after the signature
8877 separator, or the text after the signature separator is matched by
8878 the regular expression @samp{^---*Forwarded article}, then it isn't a
8879 signature after all.
8882 @node Article Miscellania
8883 @subsection Article Miscellania
8887 @kindex A t (Summary)
8888 @findex gnus-article-babel
8889 Translate the article from one language to another
8890 (@code{gnus-article-babel}).
8896 @section MIME Commands
8897 @cindex MIME decoding
8899 @cindex viewing attachments
8901 The following commands all understand the numerical prefix. For
8902 instance, @kbd{3 b} means ``view the third @sc{mime} part''.
8908 @kindex K v (Summary)
8909 View the @sc{mime} part.
8912 @kindex K o (Summary)
8913 Save the @sc{mime} part.
8916 @kindex K c (Summary)
8917 Copy the @sc{mime} part.
8920 @kindex K e (Summary)
8921 View the @sc{mime} part externally.
8924 @kindex K i (Summary)
8925 View the @sc{mime} part internally.
8928 @kindex K | (Summary)
8929 Pipe the @sc{mime} part to an external command.
8932 The rest of these @sc{mime} commands do not use the numerical prefix in
8937 @kindex K b (Summary)
8938 Make all the @sc{mime} parts have buttons in front of them. This is
8939 mostly useful if you wish to save (or perform other actions) on inlined
8943 @kindex K m (Summary)
8944 @findex gnus-summary-repair-multipart
8945 Some multipart messages are transmitted with missing or faulty headers.
8946 This command will attempt to ``repair'' these messages so that they can
8947 be viewed in a more pleasant manner
8948 (@code{gnus-summary-repair-multipart}).
8951 @kindex X m (Summary)
8952 @findex gnus-summary-save-parts
8953 Save all parts matching a @sc{mime} type to a directory
8954 (@code{gnus-summary-save-parts}). Understands the process/prefix
8955 convention (@pxref{Process/Prefix}).
8958 @kindex M-t (Summary)
8959 @findex gnus-summary-toggle-display-buttonized
8960 Toggle the buttonized display of the article buffer
8961 (@code{gnus-summary-toggle-display-buttonized}).
8964 @kindex W M w (Summary)
8965 @findex gnus-article-decode-mime-words
8966 Decode RFC 2047-encoded words in the article headers
8967 (@code{gnus-article-decode-mime-words}).
8970 @kindex W M c (Summary)
8971 @findex gnus-article-decode-charset
8972 Decode encoded article bodies as well as charsets
8973 (@code{gnus-article-decode-charset}).
8975 This command looks in the @code{Content-Type} header to determine the
8976 charset. If there is no such header in the article, you can give it a
8977 prefix, which will prompt for the charset to decode as. In regional
8978 groups where people post using some common encoding (but do not
8979 include @sc{mime} headers), you can set the @code{charset} group/topic
8980 parameter to the required charset (@pxref{Group Parameters}).
8983 @kindex W M v (Summary)
8984 @findex gnus-mime-view-all-parts
8985 View all the @sc{mime} parts in the current article
8986 (@code{gnus-mime-view-all-parts}).
8993 @item gnus-ignored-mime-types
8994 @vindex gnus-ignored-mime-types
8995 This is a list of regexps. @sc{mime} types that match a regexp from
8996 this list will be completely ignored by Gnus. The default value is
8999 To have all Vcards be ignored, you'd say something like this:
9002 (setq gnus-ignored-mime-types
9006 @item gnus-article-loose-mime
9007 @vindex gnus-article-loose-mime
9008 If non-@code{nil}, Gnus won't required the @samp{MIME-Version} header
9009 before interpreting the message as a @sc{mime} message. This helps
9010 when reading messages from certain broken mail user agents. The
9011 default is @code{nil}.
9013 @item gnus-article-emulate-mime
9014 @vindex gnus-article-emulate-mime
9015 There are other, non-@sc{mime} encoding methods used. The most common
9016 is @samp{uuencode}, but yEncode is also getting to be popular. If
9017 This variable is non-@code{nil}, Gnus will look in message bodies to
9018 see if it finds these encodings, and if so, it'll run them through the
9019 Gnus @sc{mime} machinery. The default is @code{t}.
9021 @item gnus-unbuttonized-mime-types
9022 @vindex gnus-unbuttonized-mime-types
9023 This is a list of regexps. @sc{mime} types that match a regexp from
9024 this list won't have @sc{mime} buttons inserted unless they aren't
9025 displayed or this variable is overridden by
9026 @code{gnus-buttonized-mime-types}. The default value is
9027 @code{(".*/.*")}. This variable is only used when
9028 @code{gnus-inhibit-mime-unbuttonizing} is nil.
9030 @item gnus-buttonized-mime-types
9031 @vindex gnus-buttonized-mime-types
9032 This is a list of regexps. @sc{mime} types that match a regexp from
9033 this list will have @sc{mime} buttons inserted unless they aren't
9034 displayed. This variable overrides
9035 @code{gnus-unbuttonized-mime-types}. The default value is @code{nil}.
9036 This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
9039 To see e.g. security buttons but no other buttons, you could set this
9040 variable to @code{("multipart/signed")} and leave
9041 @code{gnus-unbuttonized-mime-types} at the default value.
9043 @item gnus-inhibit-mime-unbuttonizing
9044 @vindex gnus-inhibit-mime-unbuttonizing
9045 If this is non-nil, then all @sc{mime} parts get buttons. The default
9046 value is @code{nil}.
9048 @item gnus-article-mime-part-function
9049 @vindex gnus-article-mime-part-function
9050 For each @sc{mime} part, this function will be called with the @sc{mime}
9051 handle as the parameter. The function is meant to be used to allow
9052 users to gather information from the article (e. g., add Vcard info to
9053 the bbdb database) or to do actions based on parts (e. g., automatically
9054 save all jpegs into some directory).
9056 Here's an example function the does the latter:
9059 (defun my-save-all-jpeg-parts (handle)
9060 (when (equal (car (mm-handle-type handle)) "image/jpeg")
9062 (insert (mm-get-part handle))
9063 (write-region (point-min) (point-max)
9064 (read-file-name "Save jpeg to: ")))))
9065 (setq gnus-article-mime-part-function
9066 'my-save-all-jpeg-parts)
9069 @vindex gnus-mime-multipart-functions
9070 @item gnus-mime-multipart-functions
9071 Alist of @sc{mime} multipart types and functions to handle them.
9073 @vindex mm-file-name-rewrite-functions
9074 @item mm-file-name-rewrite-functions
9075 List of functions used for rewriting file names of @sc{mime} parts.
9076 Each function takes a file name as input and returns a file name.
9078 Ready-made functions include@*
9079 @code{mm-file-name-delete-whitespace},
9080 @code{mm-file-name-trim-whitespace},
9081 @code{mm-file-name-collapse-whitespace}, and
9082 @code{mm-file-name-replace-whitespace}. The later uses the value of
9083 the variable @code{mm-file-name-replace-whitespace} to replace each
9084 whitespace character in a file name with that string; default value
9085 is @code{"_"} (a single underscore).
9086 @findex mm-file-name-delete-whitespace
9087 @findex mm-file-name-trim-whitespace
9088 @findex mm-file-name-collapse-whitespace
9089 @findex mm-file-name-replace-whitespace
9090 @vindex mm-file-name-replace-whitespace
9092 The standard functions @code{capitalize}, @code{downcase},
9093 @code{upcase}, and @code{upcase-initials} may be useful, too.
9095 Everybody knows that whitespace characters in file names are evil,
9096 except those who don't know. If you receive lots of attachments from
9097 such unenlightened users, you can make live easier by adding
9100 (setq mm-file-name-rewrite-functions
9101 '(mm-file-name-trim-whitespace
9102 mm-file-name-collapse-whitespace
9103 mm-file-name-replace-whitespace))
9107 to your @file{.gnus.el} file.
9116 People use different charsets, and we have @sc{mime} to let us know what
9117 charsets they use. Or rather, we wish we had. Many people use
9118 newsreaders and mailers that do not understand or use @sc{mime}, and
9119 just send out messages without saying what character sets they use. To
9120 help a bit with this, some local news hierarchies have policies that say
9121 what character set is the default. For instance, the @samp{fj}
9122 hierarchy uses @code{iso-2022-jp-2}.
9124 @vindex gnus-group-charset-alist
9125 This knowledge is encoded in the @code{gnus-group-charset-alist}
9126 variable, which is an alist of regexps (use the first item to match full
9127 group names) and default charsets to be used when reading these groups.
9129 @vindex gnus-newsgroup-ignored-charsets
9130 In addition, some people do use soi-disant @sc{mime}-aware agents that
9131 aren't. These blithely mark messages as being in @code{iso-8859-1}
9132 even if they really are in @code{koi-8}. To help here, the
9133 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
9134 charsets that are listed here will be ignored. The variable can be
9135 set on a group-by-group basis using the group parameters (@pxref{Group
9136 Parameters}). The default value is @code{(unknown-8bit x-unknown)},
9137 which includes values some agents insist on having in there.
9139 @vindex gnus-group-posting-charset-alist
9140 When posting, @code{gnus-group-posting-charset-alist} is used to
9141 determine which charsets should not be encoded using the @sc{mime}
9142 encodings. For instance, some hierarchies discourage using
9143 quoted-printable header encoding.
9145 This variable is an alist of regexps and permitted unencoded charsets
9146 for posting. Each element of the alist has the form @code{(}@var{test
9147 header body-list}@code{)}, where:
9151 is either a regular expression matching the newsgroup header or a
9154 is the charset which may be left unencoded in the header (@code{nil}
9155 means encode all charsets),
9157 is a list of charsets which may be encoded using 8bit content-transfer
9158 encoding in the body, or one of the special values @code{nil} (always
9159 encode using quoted-printable) or @code{t} (always use 8bit).
9166 @cindex coding system aliases
9167 @cindex preferred charset
9169 Other charset tricks that may be useful, although not Gnus-specific:
9171 If there are several @sc{mime} charsets that encode the same Emacs
9172 charset, you can choose what charset to use by saying the following:
9175 (put-charset-property 'cyrillic-iso8859-5
9176 'preferred-coding-system 'koi8-r)
9179 This means that Russian will be encoded using @code{koi8-r} instead of
9180 the default @code{iso-8859-5} @sc{mime} charset.
9182 If you want to read messages in @code{koi8-u}, you can cheat and say
9185 (define-coding-system-alias 'koi8-u 'koi8-r)
9188 This will almost do the right thing.
9190 And finally, to read charsets like @code{windows-1251}, you can say
9194 (codepage-setup 1251)
9195 (define-coding-system-alias 'windows-1251 'cp1251)
9199 @node Article Commands
9200 @section Article Commands
9207 @kindex A P (Summary)
9208 @vindex gnus-ps-print-hook
9209 @findex gnus-summary-print-article
9210 Generate and print a PostScript image of the article buffer
9211 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will
9212 be run just before printing the buffer. An alternative way to print
9213 article is to use Muttprint (@pxref{Saving Articles}).
9218 @node Summary Sorting
9219 @section Summary Sorting
9220 @cindex summary sorting
9222 You can have the summary buffer sorted in various ways, even though I
9223 can't really see why you'd want that.
9228 @kindex C-c C-s C-n (Summary)
9229 @findex gnus-summary-sort-by-number
9230 Sort by article number (@code{gnus-summary-sort-by-number}).
9233 @kindex C-c C-s C-a (Summary)
9234 @findex gnus-summary-sort-by-author
9235 Sort by author (@code{gnus-summary-sort-by-author}).
9238 @kindex C-c C-s C-s (Summary)
9239 @findex gnus-summary-sort-by-subject
9240 Sort by subject (@code{gnus-summary-sort-by-subject}).
9243 @kindex C-c C-s C-d (Summary)
9244 @findex gnus-summary-sort-by-date
9245 Sort by date (@code{gnus-summary-sort-by-date}).
9248 @kindex C-c C-s C-l (Summary)
9249 @findex gnus-summary-sort-by-lines
9250 Sort by lines (@code{gnus-summary-sort-by-lines}).
9253 @kindex C-c C-s C-c (Summary)
9254 @findex gnus-summary-sort-by-chars
9255 Sort by article length (@code{gnus-summary-sort-by-chars}).
9258 @kindex C-c C-s C-i (Summary)
9259 @findex gnus-summary-sort-by-score
9260 Sort by score (@code{gnus-summary-sort-by-score}).
9263 @kindex C-c C-s C-r (Summary)
9264 @findex gnus-summary-sort-by-random
9265 Randomize (@code{gnus-summary-sort-by-random}).
9268 @kindex C-c C-s C-o (Summary)
9269 @findex gnus-summary-sort-by-original
9270 Sort using the default sorting method
9271 (@code{gnus-summary-sort-by-original}).
9274 These functions will work both when you use threading and when you don't
9275 use threading. In the latter case, all summary lines will be sorted,
9276 line by line. In the former case, sorting will be done on a
9277 root-by-root basis, which might not be what you were looking for. To
9278 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
9282 @node Finding the Parent
9283 @section Finding the Parent
9284 @cindex parent articles
9285 @cindex referring articles
9290 @findex gnus-summary-refer-parent-article
9291 If you'd like to read the parent of the current article, and it is not
9292 displayed in the summary buffer, you might still be able to. That is,
9293 if the current group is fetched by @sc{nntp}, the parent hasn't expired
9294 and the @code{References} in the current article are not mangled, you
9295 can just press @kbd{^} or @kbd{A r}
9296 (@code{gnus-summary-refer-parent-article}). If everything goes well,
9297 you'll get the parent. If the parent is already displayed in the
9298 summary buffer, point will just move to this article.
9300 If given a positive numerical prefix, fetch that many articles back into
9301 the ancestry. If given a negative numerical prefix, fetch just that
9302 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
9303 grandparent and the grandgrandparent of the current article. If you say
9304 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
9308 @findex gnus-summary-refer-references
9309 @kindex A R (Summary)
9310 Fetch all articles mentioned in the @code{References} header of the
9311 article (@code{gnus-summary-refer-references}).
9314 @findex gnus-summary-refer-thread
9315 @kindex A T (Summary)
9316 Display the full thread where the current article appears
9317 (@code{gnus-summary-refer-thread}). This command has to fetch all the
9318 headers in the current group to work, so it usually takes a while. If
9319 you do it often, you may consider setting @code{gnus-fetch-old-headers}
9320 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
9321 visible effects normally, but it'll make this command work a whole lot
9322 faster. Of course, it'll make group entry somewhat slow.
9324 @vindex gnus-refer-thread-limit
9325 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
9326 articles before the first displayed in the current group) headers to
9327 fetch when doing this command. The default is 200. If @code{t}, all
9328 the available headers will be fetched. This variable can be overridden
9329 by giving the @kbd{A T} command a numerical prefix.
9332 @findex gnus-summary-refer-article
9333 @kindex M-^ (Summary)
9335 @cindex fetching by Message-ID
9336 You can also ask the @sc{nntp} server for an arbitrary article, no
9337 matter what group it belongs to. @kbd{M-^}
9338 (@code{gnus-summary-refer-article}) will ask you for a
9339 @code{Message-ID}, which is one of those long, hard-to-read thingies
9340 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
9341 have to get it all exactly right. No fuzzy searches, I'm afraid.
9344 The current select method will be used when fetching by
9345 @code{Message-ID} from non-news select method, but you can override this
9346 by giving this command a prefix.
9348 @vindex gnus-refer-article-method
9349 If the group you are reading is located on a back end that does not
9350 support fetching by @code{Message-ID} very well (like @code{nnspool}),
9351 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
9352 would, perhaps, be best if the @sc{nntp} server you consult is the one
9353 updating the spool you are reading from, but that's not really
9356 It can also be a list of select methods, as well as the special symbol
9357 @code{current}, which means to use the current select method. If it
9358 is a list, Gnus will try all the methods in the list until it finds a
9361 Here's an example setting that will first try the current method, and
9362 then ask Google if that fails:
9365 (setq gnus-refer-article-method
9367 (nnweb "google" (nnweb-type google))))
9370 Most of the mail back ends support fetching by @code{Message-ID}, but
9371 do not do a particularly excellent job at it. That is, @code{nnmbox},
9372 @code{nnbabyl}, and @code{nnmaildir} are able to locate articles from
9373 any groups, while @code{nnml}, @code{nnfolder}, and @code{nnimap} are
9374 only able to locate articles that have been posted to the current group.
9375 (Anything else would be too time consuming.) @code{nnmh} does not
9376 support this at all.
9379 @node Alternative Approaches
9380 @section Alternative Approaches
9382 Different people like to read news using different methods. This being
9383 Gnus, we offer a small selection of minor modes for the summary buffers.
9386 * Pick and Read:: First mark articles and then read them.
9387 * Binary Groups:: Auto-decode all articles.
9392 @subsection Pick and Read
9393 @cindex pick and read
9395 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
9396 a two-phased reading interface. The user first marks in a summary
9397 buffer the articles she wants to read. Then she starts reading the
9398 articles with just an article buffer displayed.
9400 @findex gnus-pick-mode
9401 @kindex M-x gnus-pick-mode
9402 Gnus provides a summary buffer minor mode that allows
9403 this---@code{gnus-pick-mode}. This basically means that a few process
9404 mark commands become one-keystroke commands to allow easy marking, and
9405 it provides one additional command for switching to the summary buffer.
9407 Here are the available keystrokes when using pick mode:
9412 @findex gnus-pick-article-or-thread
9413 Pick the article or thread on the current line
9414 (@code{gnus-pick-article-or-thread}). If the variable
9415 @code{gnus-thread-hide-subtree} is true, then this key selects the
9416 entire thread when used at the first article of the thread. Otherwise,
9417 it selects just the article. If given a numerical prefix, go to that
9418 thread or article and pick it. (The line number is normally displayed
9419 at the beginning of the summary pick lines.)
9422 @kindex SPACE (Pick)
9423 @findex gnus-pick-next-page
9424 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
9425 at the end of the buffer, start reading the picked articles.
9429 @findex gnus-pick-unmark-article-or-thread.
9430 Unpick the thread or article
9431 (@code{gnus-pick-unmark-article-or-thread}). If the variable
9432 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
9433 thread if used at the first article of the thread. Otherwise it unpicks
9434 just the article. You can give this key a numerical prefix to unpick
9435 the thread or article at that line.
9439 @findex gnus-pick-start-reading
9440 @vindex gnus-pick-display-summary
9441 Start reading the picked articles (@code{gnus-pick-start-reading}). If
9442 given a prefix, mark all unpicked articles as read first. If
9443 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
9444 will still be visible when you are reading.
9448 All the normal summary mode commands are still available in the
9449 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
9450 which is mapped to the same function
9451 @code{gnus-summary-tick-article-forward}.
9453 If this sounds like a good idea to you, you could say:
9456 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
9459 @vindex gnus-pick-mode-hook
9460 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
9462 @vindex gnus-mark-unpicked-articles-as-read
9463 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
9464 all unpicked articles as read. The default is @code{nil}.
9466 @vindex gnus-summary-pick-line-format
9467 The summary line format in pick mode is slightly different from the
9468 standard format. At the beginning of each line the line number is
9469 displayed. The pick mode line format is controlled by the
9470 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
9471 Variables}). It accepts the same format specs that
9472 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
9476 @subsection Binary Groups
9477 @cindex binary groups
9479 @findex gnus-binary-mode
9480 @kindex M-x gnus-binary-mode
9481 If you spend much time in binary groups, you may grow tired of hitting
9482 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
9483 is a minor mode for summary buffers that makes all ordinary Gnus article
9484 selection functions uudecode series of articles and display the result
9485 instead of just displaying the articles the normal way.
9488 @findex gnus-binary-show-article
9489 The only way, in fact, to see the actual articles is the @kbd{g}
9490 command, when you have turned on this mode
9491 (@code{gnus-binary-show-article}).
9493 @vindex gnus-binary-mode-hook
9494 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
9498 @section Tree Display
9501 @vindex gnus-use-trees
9502 If you don't like the normal Gnus summary display, you might try setting
9503 @code{gnus-use-trees} to @code{t}. This will create (by default) an
9504 additional @dfn{tree buffer}. You can execute all summary mode commands
9507 There are a few variables to customize the tree display, of course:
9510 @item gnus-tree-mode-hook
9511 @vindex gnus-tree-mode-hook
9512 A hook called in all tree mode buffers.
9514 @item gnus-tree-mode-line-format
9515 @vindex gnus-tree-mode-line-format
9516 A format string for the mode bar in the tree mode buffers (@pxref{Mode
9517 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
9518 of valid specs, @pxref{Summary Buffer Mode Line}.
9520 @item gnus-selected-tree-face
9521 @vindex gnus-selected-tree-face
9522 Face used for highlighting the selected article in the tree buffer. The
9523 default is @code{modeline}.
9525 @item gnus-tree-line-format
9526 @vindex gnus-tree-line-format
9527 A format string for the tree nodes. The name is a bit of a misnomer,
9528 though---it doesn't define a line, but just the node. The default value
9529 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
9530 the name of the poster. It is vital that all nodes are of the same
9531 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
9537 The name of the poster.
9539 The @code{From} header.
9541 The number of the article.
9543 The opening bracket.
9545 The closing bracket.
9550 @xref{Formatting Variables}.
9552 Variables related to the display are:
9555 @item gnus-tree-brackets
9556 @vindex gnus-tree-brackets
9557 This is used for differentiating between ``real'' articles and
9558 ``sparse'' articles. The format is @code{((@var{real-open} . @var{real-close})
9559 (@var{sparse-open} . @var{sparse-close}) (@var{dummy-open} . @var{dummy-close}))}, and the
9560 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
9562 @item gnus-tree-parent-child-edges
9563 @vindex gnus-tree-parent-child-edges
9564 This is a list that contains the characters used for connecting parent
9565 nodes to their children. The default is @code{(?- ?\\ ?|)}.
9569 @item gnus-tree-minimize-window
9570 @vindex gnus-tree-minimize-window
9571 If this variable is non-@code{nil}, Gnus will try to keep the tree
9572 buffer as small as possible to allow more room for the other Gnus
9573 windows. If this variable is a number, the tree buffer will never be
9574 higher than that number. The default is @code{t}. Note that if you
9575 have several windows displayed side-by-side in a frame and the tree
9576 buffer is one of these, minimizing the tree window will also resize all
9577 other windows displayed next to it.
9579 You may also wish to add the following hook to keep the window minimized
9583 (add-hook 'gnus-configure-windows-hook
9584 'gnus-tree-perhaps-minimize)
9587 @item gnus-generate-tree-function
9588 @vindex gnus-generate-tree-function
9589 @findex gnus-generate-horizontal-tree
9590 @findex gnus-generate-vertical-tree
9591 The function that actually generates the thread tree. Two predefined
9592 functions are available: @code{gnus-generate-horizontal-tree} and
9593 @code{gnus-generate-vertical-tree} (which is the default).
9597 Here's an example from a horizontal tree buffer:
9600 @{***@}-(***)-[odd]-[Gun]
9610 Here's the same thread displayed in a vertical tree buffer:
9614 |--------------------------\-----\-----\
9615 (***) [Bjo] [Gun] [Gun]
9617 [odd] [Jan] [odd] (***) [Jor]
9619 [Gun] [Eri] [Eri] [odd]
9624 If you're using horizontal trees, it might be nice to display the trees
9625 side-by-side with the summary buffer. You could add something like the
9626 following to your @file{.gnus.el} file:
9629 (setq gnus-use-trees t
9630 gnus-generate-tree-function 'gnus-generate-horizontal-tree
9631 gnus-tree-minimize-window nil)
9632 (gnus-add-configuration
9636 (summary 0.75 point)
9641 @xref{Window Layout}.
9644 @node Mail Group Commands
9645 @section Mail Group Commands
9646 @cindex mail group commands
9648 Some commands only make sense in mail groups. If these commands are
9649 invalid in the current group, they will raise a hell and let you know.
9651 All these commands (except the expiry and edit commands) use the
9652 process/prefix convention (@pxref{Process/Prefix}).
9657 @kindex B e (Summary)
9658 @findex gnus-summary-expire-articles
9659 Run all expirable articles in the current group through the expiry
9660 process (@code{gnus-summary-expire-articles}). That is, delete all
9661 expirable articles in the group that have been around for a while.
9662 (@pxref{Expiring Mail}).
9665 @kindex B C-M-e (Summary)
9666 @findex gnus-summary-expire-articles-now
9667 Delete all the expirable articles in the group
9668 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
9669 articles eligible for expiry in the current group will
9670 disappear forever into that big @file{/dev/null} in the sky.
9673 @kindex B DEL (Summary)
9674 @findex gnus-summary-delete-article
9675 @c @icon{gnus-summary-mail-delete}
9676 Delete the mail article. This is ``delete'' as in ``delete it from your
9677 disk forever and ever, never to return again.'' Use with caution.
9678 (@code{gnus-summary-delete-article}).
9681 @kindex B m (Summary)
9683 @findex gnus-summary-move-article
9684 @vindex gnus-preserve-marks
9685 Move the article from one mail group to another
9686 (@code{gnus-summary-move-article}). Marks will be preserved if
9687 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
9690 @kindex B c (Summary)
9692 @findex gnus-summary-copy-article
9693 @c @icon{gnus-summary-mail-copy}
9694 Copy the article from one group (mail group or not) to a mail group
9695 (@code{gnus-summary-copy-article}). Marks will be preserved if
9696 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
9699 @kindex B B (Summary)
9700 @cindex crosspost mail
9701 @findex gnus-summary-crosspost-article
9702 Crosspost the current article to some other group
9703 (@code{gnus-summary-crosspost-article}). This will create a new copy of
9704 the article in the other group, and the Xref headers of the article will
9705 be properly updated.
9708 @kindex B i (Summary)
9709 @findex gnus-summary-import-article
9710 Import an arbitrary file into the current mail newsgroup
9711 (@code{gnus-summary-import-article}). You will be prompted for a file
9712 name, a @code{From} header and a @code{Subject} header.
9715 @kindex B I (Summary)
9716 @findex gnus-summary-create-article
9717 Create an empty article in the current mail newsgroups
9718 (@code{gnus-summary-create-article}). You will be prompted for a
9719 @code{From} header and a @code{Subject} header.
9722 @kindex B r (Summary)
9723 @findex gnus-summary-respool-article
9724 @vindex gnus-summary-respool-default-method
9725 Respool the mail article (@code{gnus-summary-respool-article}).
9726 @code{gnus-summary-respool-default-method} will be used as the default
9727 select method when respooling. This variable is @code{nil} by default,
9728 which means that the current group select method will be used instead.
9729 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
9730 (which is the default).
9734 @kindex B w (Summary)
9736 @findex gnus-summary-edit-article
9737 @kindex C-c C-c (Article)
9738 @findex gnus-summary-edit-article-done
9739 Edit the current article (@code{gnus-summary-edit-article}). To finish
9740 editing and make the changes permanent, type @kbd{C-c C-c}
9741 (@code{gnus-summary-edit-article-done}). If you give a prefix to the
9742 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
9745 @kindex B q (Summary)
9746 @findex gnus-summary-respool-query
9747 If you want to re-spool an article, you might be curious as to what group
9748 the article will end up in before you do the re-spooling. This command
9749 will tell you (@code{gnus-summary-respool-query}).
9752 @kindex B t (Summary)
9753 @findex gnus-summary-respool-trace
9754 Similarly, this command will display all fancy splitting patterns used
9755 when respooling, if any (@code{gnus-summary-respool-trace}).
9758 @kindex B p (Summary)
9759 @findex gnus-summary-article-posted-p
9760 Some people have a tendency to send you "courtesy" copies when they
9761 follow up to articles you have posted. These usually have a
9762 @code{Newsgroups} header in them, but not always. This command
9763 (@code{gnus-summary-article-posted-p}) will try to fetch the current
9764 article from your news server (or rather, from
9765 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
9766 report back whether it found the article or not. Even if it says that
9767 it didn't find the article, it may have been posted anyway---mail
9768 propagation is much faster than news propagation, and the news copy may
9769 just not have arrived yet.
9772 @kindex K E (Summary)
9773 @findex gnus-article-encrypt-body
9774 @vindex gnus-article-encrypt-protocol
9775 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
9776 The body is encrypted with the encryption protocol specified by the
9777 variable @code{gnus-article-encrypt-protocol}.
9781 @vindex gnus-move-split-methods
9782 @cindex moving articles
9783 If you move (or copy) articles regularly, you might wish to have Gnus
9784 suggest where to put the articles. @code{gnus-move-split-methods} is a
9785 variable that uses the same syntax as @code{gnus-split-methods}
9786 (@pxref{Saving Articles}). You may customize that variable to create
9787 suggestions you find reasonable. (Note that
9788 @code{gnus-move-split-methods} uses group names where
9789 @code{gnus-split-methods} uses file names.)
9792 (setq gnus-move-split-methods
9793 '(("^From:.*Lars Magne" "nnml:junk")
9794 ("^Subject:.*gnus" "nnfolder:important")
9795 (".*" "nnml:misc")))
9799 @node Various Summary Stuff
9800 @section Various Summary Stuff
9803 * Summary Group Information:: Information oriented commands.
9804 * Searching for Articles:: Multiple article commands.
9805 * Summary Generation Commands::
9806 * Really Various Summary Commands:: Those pesky non-conformant commands.
9810 @vindex gnus-summary-display-while-building
9811 @item gnus-summary-display-while-building
9812 If non-@code{nil}, show and update the summary buffer as it's being
9813 built. If @code{t}, update the buffer after every line is inserted.
9814 If the value is an integer, @var{n}, update the display every @var{n}
9815 lines. The default is @code{nil}.
9817 @vindex gnus-summary-mode-hook
9818 @item gnus-summary-mode-hook
9819 This hook is called when creating a summary mode buffer.
9821 @vindex gnus-summary-generate-hook
9822 @item gnus-summary-generate-hook
9823 This is called as the last thing before doing the threading and the
9824 generation of the summary buffer. It's quite convenient for customizing
9825 the threading variables based on what data the newsgroup has. This hook
9826 is called from the summary buffer after most summary buffer variables
9829 @vindex gnus-summary-prepare-hook
9830 @item gnus-summary-prepare-hook
9831 It is called after the summary buffer has been generated. You might use
9832 it to, for instance, highlight lines or modify the look of the buffer in
9833 some other ungodly manner. I don't care.
9835 @vindex gnus-summary-prepared-hook
9836 @item gnus-summary-prepared-hook
9837 A hook called as the very last thing after the summary buffer has been
9840 @vindex gnus-summary-ignore-duplicates
9841 @item gnus-summary-ignore-duplicates
9842 When Gnus discovers two articles that have the same @code{Message-ID},
9843 it has to do something drastic. No articles are allowed to have the
9844 same @code{Message-ID}, but this may happen when reading mail from some
9845 sources. Gnus allows you to customize what happens with this variable.
9846 If it is @code{nil} (which is the default), Gnus will rename the
9847 @code{Message-ID} (for display purposes only) and display the article as
9848 any other article. If this variable is @code{t}, it won't display the
9849 article---it'll be as if it never existed.
9851 @vindex gnus-alter-articles-to-read-function
9852 @item gnus-alter-articles-to-read-function
9853 This function, which takes two parameters (the group name and the list
9854 of articles to be selected), is called to allow the user to alter the
9855 list of articles to be selected.
9857 For instance, the following function adds the list of cached articles to
9858 the list in one particular group:
9861 (defun my-add-cached-articles (group articles)
9862 (if (string= group "some.group")
9863 (append gnus-newsgroup-cached articles)
9867 @vindex gnus-newsgroup-variables
9868 @item gnus-newsgroup-variables
9869 A list of newsgroup (summary buffer) local variables, or cons of
9870 variables and their default values (when the default values are not
9871 nil), that should be made global while the summary buffer is active.
9872 These variables can be used to set variables in the group parameters
9873 while still allowing them to affect operations done in other
9874 buffers. For example:
9877 (setq gnus-newsgroup-variables
9878 '(message-use-followup-to
9879 (gnus-visible-headers .
9880 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
9886 @node Summary Group Information
9887 @subsection Summary Group Information
9892 @kindex H f (Summary)
9893 @findex gnus-summary-fetch-faq
9894 @vindex gnus-group-faq-directory
9895 Try to fetch the FAQ (list of frequently asked questions) for the
9896 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
9897 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
9898 on a remote machine. This variable can also be a list of directories.
9899 In that case, giving a prefix to this command will allow you to choose
9900 between the various sites. @code{ange-ftp} or @code{efs} will probably
9901 be used for fetching the file.
9904 @kindex H d (Summary)
9905 @findex gnus-summary-describe-group
9906 Give a brief description of the current group
9907 (@code{gnus-summary-describe-group}). If given a prefix, force
9908 rereading the description from the server.
9911 @kindex H h (Summary)
9912 @findex gnus-summary-describe-briefly
9913 Give an extremely brief description of the most important summary
9914 keystrokes (@code{gnus-summary-describe-briefly}).
9917 @kindex H i (Summary)
9918 @findex gnus-info-find-node
9919 Go to the Gnus info node (@code{gnus-info-find-node}).
9923 @node Searching for Articles
9924 @subsection Searching for Articles
9929 @kindex M-s (Summary)
9930 @findex gnus-summary-search-article-forward
9931 Search through all subsequent (raw) articles for a regexp
9932 (@code{gnus-summary-search-article-forward}).
9935 @kindex M-r (Summary)
9936 @findex gnus-summary-search-article-backward
9937 Search through all previous (raw) articles for a regexp
9938 (@code{gnus-summary-search-article-backward}).
9942 @findex gnus-summary-execute-command
9943 This command will prompt you for a header, a regular expression to match
9944 on this field, and a command to be executed if the match is made
9945 (@code{gnus-summary-execute-command}). If the header is an empty
9946 string, the match is done on the entire article. If given a prefix,
9947 search backward instead.
9949 For instance, @kbd{& RET some.*string #} will put the process mark on
9950 all articles that have heads or bodies that match @samp{some.*string}.
9953 @kindex M-& (Summary)
9954 @findex gnus-summary-universal-argument
9955 Perform any operation on all articles that have been marked with
9956 the process mark (@code{gnus-summary-universal-argument}).
9959 @node Summary Generation Commands
9960 @subsection Summary Generation Commands
9965 @kindex Y g (Summary)
9966 @findex gnus-summary-prepare
9967 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
9970 @kindex Y c (Summary)
9971 @findex gnus-summary-insert-cached-articles
9972 Pull all cached articles (for the current group) into the summary buffer
9973 (@code{gnus-summary-insert-cached-articles}).
9976 @kindex Y d (Summary)
9977 @findex gnus-summary-insert-dormant-articles
9978 Pull all dormant articles (for the current group) into the summary buffer
9979 (@code{gnus-summary-insert-dormant-articles}).
9984 @node Really Various Summary Commands
9985 @subsection Really Various Summary Commands
9991 @kindex C-d (Summary)
9992 @kindex A D (Summary)
9993 @findex gnus-summary-enter-digest-group
9994 If the current article is a collection of other articles (for instance,
9995 a digest), you might use this command to enter a group based on the that
9996 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
9997 guess what article type is currently displayed unless you give a prefix
9998 to this command, which forces a ``digest'' interpretation. Basically,
9999 whenever you see a message that is a collection of other messages of
10000 some format, you @kbd{C-d} and read these messages in a more convenient
10004 @kindex C-M-d (Summary)
10005 @findex gnus-summary-read-document
10006 This command is very similar to the one above, but lets you gather
10007 several documents into one biiig group
10008 (@code{gnus-summary-read-document}). It does this by opening several
10009 @code{nndoc} groups for each document, and then opening an
10010 @code{nnvirtual} group on top of these @code{nndoc} groups. This
10011 command understands the process/prefix convention
10012 (@pxref{Process/Prefix}).
10015 @kindex C-t (Summary)
10016 @findex gnus-summary-toggle-truncation
10017 Toggle truncation of summary lines
10018 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
10019 line centering function in the summary buffer, so it's not a good idea
10020 to have truncation switched off while reading articles.
10023 @kindex = (Summary)
10024 @findex gnus-summary-expand-window
10025 Expand the summary buffer window (@code{gnus-summary-expand-window}).
10026 If given a prefix, force an @code{article} window configuration.
10029 @kindex C-M-e (Summary)
10030 @findex gnus-summary-edit-parameters
10031 Edit the group parameters (@pxref{Group Parameters}) of the current
10032 group (@code{gnus-summary-edit-parameters}).
10035 @kindex C-M-a (Summary)
10036 @findex gnus-summary-customize-parameters
10037 Customize the group parameters (@pxref{Group Parameters}) of the current
10038 group (@code{gnus-summary-customize-parameters}).
10043 @node Exiting the Summary Buffer
10044 @section Exiting the Summary Buffer
10045 @cindex summary exit
10046 @cindex exiting groups
10048 Exiting from the summary buffer will normally update all info on the
10049 group and return you to the group buffer.
10055 @kindex Z Z (Summary)
10056 @kindex q (Summary)
10057 @findex gnus-summary-exit
10058 @vindex gnus-summary-exit-hook
10059 @vindex gnus-summary-prepare-exit-hook
10060 @vindex gnus-group-no-more-groups-hook
10061 @c @icon{gnus-summary-exit}
10062 Exit the current group and update all information on the group
10063 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
10064 called before doing much of the exiting, which calls
10065 @code{gnus-summary-expire-articles} by default.
10066 @code{gnus-summary-exit-hook} is called after finishing the exit
10067 process. @code{gnus-group-no-more-groups-hook} is run when returning to
10068 group mode having no more (unread) groups.
10072 @kindex Z E (Summary)
10073 @kindex Q (Summary)
10074 @findex gnus-summary-exit-no-update
10075 Exit the current group without updating any information on the group
10076 (@code{gnus-summary-exit-no-update}).
10080 @kindex Z c (Summary)
10081 @kindex c (Summary)
10082 @findex gnus-summary-catchup-and-exit
10083 @c @icon{gnus-summary-catchup-and-exit}
10084 Mark all unticked articles in the group as read and then exit
10085 (@code{gnus-summary-catchup-and-exit}).
10088 @kindex Z C (Summary)
10089 @findex gnus-summary-catchup-all-and-exit
10090 Mark all articles, even the ticked ones, as read and then exit
10091 (@code{gnus-summary-catchup-all-and-exit}).
10094 @kindex Z n (Summary)
10095 @findex gnus-summary-catchup-and-goto-next-group
10096 Mark all articles as read and go to the next group
10097 (@code{gnus-summary-catchup-and-goto-next-group}).
10100 @kindex Z R (Summary)
10101 @findex gnus-summary-reselect-current-group
10102 Exit this group, and then enter it again
10103 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
10104 all articles, both read and unread.
10108 @kindex Z G (Summary)
10109 @kindex M-g (Summary)
10110 @findex gnus-summary-rescan-group
10111 @c @icon{gnus-summary-mail-get}
10112 Exit the group, check for new articles in the group, and select the
10113 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
10114 articles, both read and unread.
10117 @kindex Z N (Summary)
10118 @findex gnus-summary-next-group
10119 Exit the group and go to the next group
10120 (@code{gnus-summary-next-group}).
10123 @kindex Z P (Summary)
10124 @findex gnus-summary-prev-group
10125 Exit the group and go to the previous group
10126 (@code{gnus-summary-prev-group}).
10129 @kindex Z s (Summary)
10130 @findex gnus-summary-save-newsrc
10131 Save the current number of read/marked articles in the dribble buffer
10132 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
10133 given a prefix, also save the @file{.newsrc} file(s). Using this
10134 command will make exit without updating (the @kbd{Q} command) worthless.
10137 @vindex gnus-exit-group-hook
10138 @code{gnus-exit-group-hook} is called when you exit the current group
10139 with an ``updating'' exit. For instance @kbd{Q}
10140 (@code{gnus-summary-exit-no-update}) does not call this hook.
10142 @findex gnus-summary-wake-up-the-dead
10143 @findex gnus-dead-summary-mode
10144 @vindex gnus-kill-summary-on-exit
10145 If you're in the habit of exiting groups, and then changing your mind
10146 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
10147 If you do that, Gnus won't kill the summary buffer when you exit it.
10148 (Quelle surprise!) Instead it will change the name of the buffer to
10149 something like @samp{*Dead Summary ... *} and install a minor mode
10150 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
10151 buffer, you'll find that all keys are mapped to a function called
10152 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
10153 summary buffer will result in a live, normal summary buffer.
10155 There will never be more than one dead summary buffer at any one time.
10157 @vindex gnus-use-cross-reference
10158 The data on the current group will be updated (which articles you have
10159 read, which articles you have replied to, etc.) when you exit the
10160 summary buffer. If the @code{gnus-use-cross-reference} variable is
10161 @code{t} (which is the default), articles that are cross-referenced to
10162 this group and are marked as read, will also be marked as read in the
10163 other subscribed groups they were cross-posted to. If this variable is
10164 neither @code{nil} nor @code{t}, the article will be marked as read in
10165 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
10168 @node Crosspost Handling
10169 @section Crosspost Handling
10173 Marking cross-posted articles as read ensures that you'll never have to
10174 read the same article more than once. Unless, of course, somebody has
10175 posted it to several groups separately. Posting the same article to
10176 several groups (not cross-posting) is called @dfn{spamming}, and you are
10177 by law required to send nasty-grams to anyone who perpetrates such a
10178 heinous crime. You may want to try NoCeM handling to filter out spam
10181 Remember: Cross-posting is kinda ok, but posting the same article
10182 separately to several groups is not. Massive cross-posting (aka.
10183 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
10184 @code{gnus-summary-mail-crosspost-complaint} command to complain about
10185 excessive crossposting (@pxref{Summary Mail Commands}).
10187 @cindex cross-posting
10190 One thing that may cause Gnus to not do the cross-posting thing
10191 correctly is if you use an @sc{nntp} server that supports @sc{xover}
10192 (which is very nice, because it speeds things up considerably) which
10193 does not include the @code{Xref} header in its @sc{nov} lines. This is
10194 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
10195 even with @sc{xover} by registering the @code{Xref} lines of all
10196 articles you actually read, but if you kill the articles, or just mark
10197 them as read without reading them, Gnus will not get a chance to snoop
10198 the @code{Xref} lines out of these articles, and will be unable to use
10199 the cross reference mechanism.
10201 @cindex LIST overview.fmt
10202 @cindex overview.fmt
10203 To check whether your @sc{nntp} server includes the @code{Xref} header
10204 in its overview files, try @samp{telnet your.nntp.server nntp},
10205 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
10206 overview.fmt}. This may not work, but if it does, and the last line you
10207 get does not read @samp{Xref:full}, then you should shout and whine at
10208 your news admin until she includes the @code{Xref} header in the
10211 @vindex gnus-nov-is-evil
10212 If you want Gnus to get the @code{Xref}s right all the time, you have to
10213 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
10218 For an alternative approach, @pxref{Duplicate Suppression}.
10221 @node Duplicate Suppression
10222 @section Duplicate Suppression
10224 By default, Gnus tries to make sure that you don't have to read the same
10225 article more than once by utilizing the crossposting mechanism
10226 (@pxref{Crosspost Handling}). However, that simple and efficient
10227 approach may not work satisfactory for some users for various
10232 The @sc{nntp} server may fail to generate the @code{Xref} header. This
10233 is evil and not very common.
10236 The @sc{nntp} server may fail to include the @code{Xref} header in the
10237 @file{.overview} data bases. This is evil and all too common, alas.
10240 You may be reading the same group (or several related groups) from
10241 different @sc{nntp} servers.
10244 You may be getting mail that duplicates articles posted to groups.
10247 I'm sure there are other situations where @code{Xref} handling fails as
10248 well, but these four are the most common situations.
10250 If, and only if, @code{Xref} handling fails for you, then you may
10251 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
10252 will remember the @code{Message-ID}s of all articles you have read or
10253 otherwise marked as read, and then, as if by magic, mark them as read
10254 all subsequent times you see them---in @emph{all} groups. Using this
10255 mechanism is quite likely to be somewhat inefficient, but not overly
10256 so. It's certainly preferable to reading the same articles more than
10259 Duplicate suppression is not a very subtle instrument. It's more like a
10260 sledge hammer than anything else. It works in a very simple
10261 fashion---if you have marked an article as read, it adds this Message-ID
10262 to a cache. The next time it sees this Message-ID, it will mark the
10263 article as read with the @samp{M} mark. It doesn't care what group it
10264 saw the article in.
10267 @item gnus-suppress-duplicates
10268 @vindex gnus-suppress-duplicates
10269 If non-@code{nil}, suppress duplicates.
10271 @item gnus-save-duplicate-list
10272 @vindex gnus-save-duplicate-list
10273 If non-@code{nil}, save the list of duplicates to a file. This will
10274 make startup and shutdown take longer, so the default is @code{nil}.
10275 However, this means that only duplicate articles read in a single Gnus
10276 session are suppressed.
10278 @item gnus-duplicate-list-length
10279 @vindex gnus-duplicate-list-length
10280 This variable says how many @code{Message-ID}s to keep in the duplicate
10281 suppression list. The default is 10000.
10283 @item gnus-duplicate-file
10284 @vindex gnus-duplicate-file
10285 The name of the file to store the duplicate suppression list in. The
10286 default is @file{~/News/suppression}.
10289 If you have a tendency to stop and start Gnus often, setting
10290 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
10291 you leave Gnus running for weeks on end, you may have it @code{nil}. On
10292 the other hand, saving the list makes startup and shutdown much slower,
10293 so that means that if you stop and start Gnus often, you should set
10294 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
10295 to you to figure out, I think.
10300 Gnus is able to verify signed messages or decrypt encrypted messages.
10301 The formats that are supported are PGP, @sc{pgp/mime} and @sc{s/mime},
10302 however you need some external programs to get things to work:
10306 To handle PGP and PGP/MIME messages, you have to install an OpenPGP
10307 implementation such as GnuPG. The lisp interface to GnuPG included
10308 with Gnus is called PGG (@pxref{Top, ,PGG, pgg, PGG Manual}), but
10309 Mailcrypt and gpg.el are also supported.
10312 To handle @sc{s/mime} message, you need to install OpenSSL. OpenSSL 0.9.6
10313 or newer is recommended.
10317 More information on how to set things up can be found in the message
10318 manual (@pxref{Security, ,Security, message, Message Manual}).
10321 @item mm-verify-option
10322 @vindex mm-verify-option
10323 Option of verifying signed parts. @code{never}, not verify;
10324 @code{always}, always verify; @code{known}, only verify known
10325 protocols. Otherwise, ask user.
10327 @item mm-decrypt-option
10328 @vindex mm-decrypt-option
10329 Option of decrypting encrypted parts. @code{never}, no decryption;
10330 @code{always}, always decrypt; @code{known}, only decrypt known
10331 protocols. Otherwise, ask user.
10334 @vindex mml1991-use
10335 Symbol indicating elisp interface to OpenPGP implementation for PGP
10336 messages. The default is @code{pgg}, but @code{mailcrypt} and
10337 @code{gpg} are also supported although deprecated.
10340 @vindex mml2015-use
10341 Symbol indicating elisp interface to OpenPGP implementation for
10342 PGP/MIME messages. The default is @code{pgg}, but @code{mailcrypt}
10343 and @code{gpg} are also supported although deprecated.
10348 @section Mailing List
10350 @kindex A M (summary)
10351 @findex gnus-mailing-list-insinuate
10352 Gnus understands some mailing list fields of RFC 2369. To enable it,
10353 either add a `to-list' group parameter (@pxref{Group Parameters}),
10354 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
10355 summary buffer, or say:
10358 (add-hook 'gnus-summary-mode-hook 'turn-on-gnus-mailing-list-mode)
10361 That enables the following commands to the summary buffer:
10366 @kindex C-c C-n h (Summary)
10367 @findex gnus-mailing-list-help
10368 Send a message to fetch mailing list help, if List-Help field exists.
10371 @kindex C-c C-n s (Summary)
10372 @findex gnus-mailing-list-subscribe
10373 Send a message to subscribe the mailing list, if List-Subscribe field exists.
10376 @kindex C-c C-n u (Summary)
10377 @findex gnus-mailing-list-unsubscribe
10378 Send a message to unsubscribe the mailing list, if List-Unsubscribe
10382 @kindex C-c C-n p (Summary)
10383 @findex gnus-mailing-list-post
10384 Post to the mailing list, if List-Post field exists.
10387 @kindex C-c C-n o (Summary)
10388 @findex gnus-mailing-list-owner
10389 Send a message to the mailing list owner, if List-Owner field exists.
10392 @kindex C-c C-n a (Summary)
10393 @findex gnus-mailing-list-owner
10394 Browse the mailing list archive, if List-Archive field exists.
10398 @node Article Buffer
10399 @chapter Article Buffer
10400 @cindex article buffer
10402 The articles are displayed in the article buffer, of which there is only
10403 one. All the summary buffers share the same article buffer unless you
10404 tell Gnus otherwise.
10407 * Hiding Headers:: Deciding what headers should be displayed.
10408 * Using MIME:: Pushing articles through @sc{mime} before reading them.
10409 * Customizing Articles:: Tailoring the look of the articles.
10410 * Article Keymap:: Keystrokes available in the article buffer.
10411 * Misc Article:: Other stuff.
10415 @node Hiding Headers
10416 @section Hiding Headers
10417 @cindex hiding headers
10418 @cindex deleting headers
10420 The top section of each article is the @dfn{head}. (The rest is the
10421 @dfn{body}, but you may have guessed that already.)
10423 @vindex gnus-show-all-headers
10424 There is a lot of useful information in the head: the name of the person
10425 who wrote the article, the date it was written and the subject of the
10426 article. That's well and nice, but there's also lots of information
10427 most people do not want to see---what systems the article has passed
10428 through before reaching you, the @code{Message-ID}, the
10429 @code{References}, etc. ad nauseum---and you'll probably want to get rid
10430 of some of those lines. If you want to keep all those lines in the
10431 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
10433 Gnus provides you with two variables for sifting headers:
10437 @item gnus-visible-headers
10438 @vindex gnus-visible-headers
10439 If this variable is non-@code{nil}, it should be a regular expression
10440 that says what headers you wish to keep in the article buffer. All
10441 headers that do not match this variable will be hidden.
10443 For instance, if you only want to see the name of the person who wrote
10444 the article and the subject, you'd say:
10447 (setq gnus-visible-headers "^From:\\|^Subject:")
10450 This variable can also be a list of regexps to match headers to
10453 @item gnus-ignored-headers
10454 @vindex gnus-ignored-headers
10455 This variable is the reverse of @code{gnus-visible-headers}. If this
10456 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
10457 should be a regular expression that matches all lines that you want to
10458 hide. All lines that do not match this variable will remain visible.
10460 For instance, if you just want to get rid of the @code{References} line
10461 and the @code{Xref} line, you might say:
10464 (setq gnus-ignored-headers "^References:\\|^Xref:")
10467 This variable can also be a list of regexps to match headers to
10470 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
10471 variable will have no effect.
10475 @vindex gnus-sorted-header-list
10476 Gnus can also sort the headers for you. (It does this by default.) You
10477 can control the sorting by setting the @code{gnus-sorted-header-list}
10478 variable. It is a list of regular expressions that says in what order
10479 the headers are to be displayed.
10481 For instance, if you want the name of the author of the article first,
10482 and then the subject, you might say something like:
10485 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
10488 Any headers that are to remain visible, but are not listed in this
10489 variable, will be displayed in random order after all the headers listed in this variable.
10491 @findex gnus-article-hide-boring-headers
10492 @vindex gnus-boring-article-headers
10493 You can hide further boring headers by setting
10494 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
10495 does depends on the @code{gnus-boring-article-headers} variable. It's a
10496 list, but this list doesn't actually contain header names. Instead is
10497 lists various @dfn{boring conditions} that Gnus can check and remove
10500 These conditions are:
10503 Remove all empty headers.
10505 Remove the @code{Followup-To} header if it is identical to the
10506 @code{Newsgroups} header.
10508 Remove the @code{Reply-To} header if it lists the same address as the
10509 @code{From} header.
10511 Remove the @code{Newsgroups} header if it only contains the current group
10514 Remove the @code{To} header if it only contains the address identical to
10515 the current groups's @code{to-address} parameter.
10517 Remove the @code{Date} header if the article is less than three days
10520 Remove the @code{To} header if it is very long.
10522 Remove all @code{To} headers if there are more than one.
10525 To include these three elements, you could say something like:
10528 (setq gnus-boring-article-headers
10529 '(empty followup-to reply-to))
10532 This is also the default value for this variable.
10536 @section Using MIME
10539 Mime is a standard for waving your hands through the air, aimlessly,
10540 while people stand around yawning.
10542 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
10543 while all newsreaders die of fear.
10545 @sc{mime} may specify what character set the article uses, the encoding
10546 of the characters, and it also makes it possible to embed pictures and
10547 other naughty stuff in innocent-looking articles.
10549 @vindex gnus-display-mime-function
10550 @findex gnus-display-mime
10551 Gnus pushes @sc{mime} articles through @code{gnus-display-mime-function}
10552 to display the @sc{mime} parts. This is @code{gnus-display-mime} by
10553 default, which creates a bundle of clickable buttons that can be used to
10554 display, save and manipulate the @sc{mime} objects.
10556 The following commands are available when you have placed point over a
10560 @findex gnus-article-press-button
10561 @item RET (Article)
10562 @kindex RET (Article)
10563 @itemx BUTTON-2 (Article)
10564 Toggle displaying of the @sc{mime} object
10565 (@code{gnus-article-press-button}). If builtin viewers can not display
10566 the object, Gnus resorts to external viewers in the @file{mailcap}
10567 files. If a viewer has the @samp{copiousoutput} specification, the
10568 object is displayed inline.
10570 @findex gnus-mime-view-part
10571 @item M-RET (Article)
10572 @kindex M-RET (Article)
10574 Prompt for a method, and then view the @sc{mime} object using this
10575 method (@code{gnus-mime-view-part}).
10577 @findex gnus-mime-view-part-as-type
10579 @kindex t (Article)
10580 View the @sc{mime} object as if it were a different @sc{mime} media type
10581 (@code{gnus-mime-view-part-as-type}).
10583 @findex gnus-mime-view-part-as-charset
10585 @kindex C (Article)
10586 Prompt for a charset, and then view the @sc{mime} object using this
10587 charset (@code{gnus-mime-view-part-as-charset}).
10589 @findex gnus-mime-save-part
10591 @kindex o (Article)
10592 Prompt for a file name, and then save the @sc{mime} object
10593 (@code{gnus-mime-save-part}).
10595 @findex gnus-mime-save-part-and-strip
10596 @item C-o (Article)
10597 @kindex C-o (Article)
10598 Prompt for a file name, then save the @sc{mime} object and strip it from
10599 the article. Then proceed to article editing, where a reasonable
10600 suggestion is being made on how the altered article should look
10601 like. The stripped @sc{mime} object will be referred via the
10602 message/external-body @sc{mime} type.
10603 (@code{gnus-mime-save-part-and-strip}).
10605 @findex gnus-mime-copy-part
10607 @kindex c (Article)
10608 Copy the @sc{mime} object to a fresh buffer and display this buffer
10609 (@code{gnus-mime-copy-part}). Compressed files like @file{.gz} and
10610 @file{.bz2} are automatically decompressed if
10611 @code{auto-compression-mode} is enabled (@pxref{Compressed Files,,
10612 Accessing Compressed Files, emacs, The Emacs Editor}).
10614 @findex gnus-mime-print-part
10616 @kindex p (Article)
10617 Print the @sc{mime} object (@code{gnus-mime-print-part}). This
10618 command respects the @samp{print=} specifications in the
10619 @file{.mailcap} file.
10621 @findex gnus-mime-inline-part
10623 @kindex i (Article)
10624 Insert the contents of the @sc{mime} object into the buffer
10625 (@code{gnus-mime-inline-part}) as text/plain. If given a prefix, insert
10626 the raw contents without decoding. If given a numerical prefix, you can
10627 do semi-manual charset stuff (see
10628 @code{gnus-summary-show-article-charset-alist} in @pxref{Paging the
10631 @findex gnus-mime-view-part-internally
10633 @kindex E (Article)
10634 View the @sc{mime} object with an internal viewer. If no internal
10635 viewer is available, use an external viewer
10636 (@code{gnus-mime-view-part-internally}).
10638 @findex gnus-mime-view-part-externally
10640 @kindex e (Article)
10641 View the @sc{mime} object with an external viewer.
10642 (@code{gnus-mime-view-part-externally}).
10644 @findex gnus-mime-pipe-part
10646 @kindex | (Article)
10647 Output the @sc{mime} object to a process (@code{gnus-mime-pipe-part}).
10649 @findex gnus-mime-action-on-part
10651 @kindex . (Article)
10652 Interactively run an action on the @sc{mime} object
10653 (@code{gnus-mime-action-on-part}).
10657 Gnus will display some @sc{mime} objects automatically. The way Gnus
10658 determines which parts to do this with is described in the Emacs
10661 It might be best to just use the toggling functions from the article
10662 buffer to avoid getting nasty surprises. (For instance, you enter the
10663 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
10664 decoded the sound file in the article and some horrible sing-a-long song
10665 comes screaming out your speakers, and you can't find the volume button,
10666 because there isn't one, and people are starting to look at you, and you
10667 try to stop the program, but you can't, and you can't find the program
10668 to control the volume, and everybody else in the room suddenly decides
10669 to look at you disdainfully, and you'll feel rather stupid.)
10671 Any similarity to real events and people is purely coincidental. Ahem.
10673 Also see @pxref{MIME Commands}.
10676 @node Customizing Articles
10677 @section Customizing Articles
10678 @cindex article customization
10680 A slew of functions for customizing how the articles are to look like
10681 exist. You can call these functions interactively, or you can have them
10682 called automatically when you select the articles.
10684 To have them called automatically, you should set the corresponding
10685 ``treatment'' variable. For instance, to have headers hidden, you'd set
10686 @code{gnus-treat-hide-headers}. Below is a list of variables that can
10687 be set, but first we discuss the values these variables can have.
10689 Note: Some values, while valid, make little sense. Check the list below
10690 for sensible values.
10694 @code{nil}: Don't do this treatment.
10697 @code{t}: Do this treatment on all body parts.
10700 @code{head}: Do the treatment on the headers.
10703 @code{last}: Do this treatment on the last part.
10706 An integer: Do this treatment on all body parts that have a length less
10710 A list of strings: Do this treatment on all body parts that are in
10711 articles that are read in groups that have names that match one of the
10712 regexps in the list.
10715 A list where the first element is not a string:
10717 The list is evaluated recursively. The first element of the list is a
10718 predicate. The following predicates are recognized: @code{or},
10719 @code{and}, @code{not} and @code{typep}. Here's an example:
10723 (typep "text/x-vcard"))
10728 You may have noticed that the word @dfn{part} is used here. This refers
10729 to the fact that some messages are @sc{mime} multipart articles that may
10730 be divided into several parts. Articles that are not multiparts are
10731 considered to contain just a single part.
10733 @vindex gnus-article-treat-types
10734 Are the treatments applied to all sorts of multipart parts? Yes, if you
10735 want to, but by default, only @samp{text/plain} parts are given the
10736 treatment. This is controlled by the @code{gnus-article-treat-types}
10737 variable, which is a list of regular expressions that are matched to the
10738 type of the part. This variable is ignored if the value of the
10739 controlling variable is a predicate list, as described above.
10741 The following treatment options are available. The easiest way to
10742 customize this is to examine the @code{gnus-article-treat} customization
10743 group. Values in parenthesis are suggested sensible values. Others are
10744 possible but those listed are probably sufficient for most people.
10747 @item gnus-treat-buttonize (t, integer)
10748 @item gnus-treat-buttonize-head (head)
10750 @xref{Article Buttons}.
10752 @item gnus-treat-capitalize-sentences (t, integer)
10753 @item gnus-treat-overstrike (t, integer)
10754 @item gnus-treat-strip-cr (t, integer)
10755 @item gnus-treat-strip-headers-in-body (t, integer)
10756 @item gnus-treat-strip-leading-blank-lines (t, integer)
10757 @item gnus-treat-strip-multiple-blank-lines (t, integer)
10758 @item gnus-treat-strip-pem (t, last, integer)
10759 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
10760 @item gnus-treat-unsplit-urls (t, integer)
10761 @item gnus-treat-wash-html (t, integer)
10763 @xref{Article Washing}.
10765 @item gnus-treat-date-english (head)
10766 @item gnus-treat-date-iso8601 (head)
10767 @item gnus-treat-date-lapsed (head)
10768 @item gnus-treat-date-local (head)
10769 @item gnus-treat-date-original (head)
10770 @item gnus-treat-date-user-defined (head)
10771 @item gnus-treat-date-ut (head)
10773 @xref{Article Date}.
10775 @item gnus-treat-from-picon (head)
10776 @item gnus-treat-mail-picon (head)
10777 @item gnus-treat-newsgroups-picon (head)
10781 @item gnus-treat-display-smileys (t, integer)
10783 @item gnus-treat-body-boundary (head)
10785 @vindex gnus-body-boundary-delimiter
10786 Adds a delimiter between header and body, the string used as delimiter
10787 is controlled by @code{gnus-body-boundary-delimiter}.
10791 @item gnus-treat-display-xface (head)
10795 @item gnus-treat-emphasize (t, head, integer)
10796 @item gnus-treat-fill-article (t, integer)
10797 @item gnus-treat-fill-long-lines (t, integer)
10798 @item gnus-treat-hide-boring-headers (head)
10799 @item gnus-treat-hide-citation (t, integer)
10800 @item gnus-treat-hide-citation-maybe (t, integer)
10801 @item gnus-treat-hide-headers (head)
10802 @item gnus-treat-hide-signature (t, last)
10804 @xref{Article Hiding}.
10806 @item gnus-treat-highlight-citation (t, integer)
10807 @item gnus-treat-highlight-headers (head)
10808 @item gnus-treat-highlight-signature (t, last, integer)
10810 @xref{Article Highlighting}.
10812 @item gnus-treat-play-sounds
10813 @item gnus-treat-translate
10814 @item gnus-treat-x-pgp-sig (head)
10816 @item gnus-treat-unfold-headers (head)
10817 @item gnus-treat-fold-headers (head)
10818 @item gnus-treat-fold-newsgroups (head)
10819 @item gnus-treat-leading-whitespace (head)
10821 @xref{Article Header}.
10826 @vindex gnus-part-display-hook
10827 You can, of course, write your own functions to be called from
10828 @code{gnus-part-display-hook}. The functions are called narrowed to the
10829 part, and you can do anything you like, pretty much. There is no
10830 information that you have to keep in the buffer---you can change
10834 @node Article Keymap
10835 @section Article Keymap
10837 Most of the keystrokes in the summary buffer can also be used in the
10838 article buffer. They should behave as if you typed them in the summary
10839 buffer, which means that you don't actually have to have a summary
10840 buffer displayed while reading. You can do it all from the article
10843 A few additional keystrokes are available:
10848 @kindex SPACE (Article)
10849 @findex gnus-article-next-page
10850 Scroll forwards one page (@code{gnus-article-next-page}).
10853 @kindex DEL (Article)
10854 @findex gnus-article-prev-page
10855 Scroll backwards one page (@code{gnus-article-prev-page}).
10858 @kindex C-c ^ (Article)
10859 @findex gnus-article-refer-article
10860 If point is in the neighborhood of a @code{Message-ID} and you press
10861 @kbd{C-c ^}, Gnus will try to get that article from the server
10862 (@code{gnus-article-refer-article}).
10865 @kindex C-c C-m (Article)
10866 @findex gnus-article-mail
10867 Send a reply to the address near point (@code{gnus-article-mail}). If
10868 given a prefix, include the mail.
10871 @kindex s (Article)
10872 @findex gnus-article-show-summary
10873 Reconfigure the buffers so that the summary buffer becomes visible
10874 (@code{gnus-article-show-summary}).
10877 @kindex ? (Article)
10878 @findex gnus-article-describe-briefly
10879 Give a very brief description of the available keystrokes
10880 (@code{gnus-article-describe-briefly}).
10883 @kindex TAB (Article)
10884 @findex gnus-article-next-button
10885 Go to the next button, if any (@code{gnus-article-next-button}). This
10886 only makes sense if you have buttonizing turned on.
10889 @kindex M-TAB (Article)
10890 @findex gnus-article-prev-button
10891 Go to the previous button, if any (@code{gnus-article-prev-button}).
10894 @kindex R (Article)
10895 @findex gnus-article-reply-with-original
10896 Send a reply to the current article and yank the current article
10897 (@code{gnus-article-reply-with-original}). If given a prefix, make a
10898 wide reply. If the region is active, only yank the text in the
10902 @kindex F (Article)
10903 @findex gnus-article-followup-with-original
10904 Send a followup to the current article and yank the current article
10905 (@code{gnus-article-followup-with-original}). If given a prefix, make
10906 a wide reply. If the region is active, only yank the text in the
10914 @section Misc Article
10918 @item gnus-single-article-buffer
10919 @vindex gnus-single-article-buffer
10920 If non-@code{nil}, use the same article buffer for all the groups.
10921 (This is the default.) If @code{nil}, each group will have its own
10924 @vindex gnus-article-decode-hook
10925 @item gnus-article-decode-hook
10927 Hook used to decode @sc{mime} articles. The default value is
10928 @code{(article-decode-charset article-decode-encoded-words)}
10930 @vindex gnus-article-prepare-hook
10931 @item gnus-article-prepare-hook
10932 This hook is called right after the article has been inserted into the
10933 article buffer. It is mainly intended for functions that do something
10934 depending on the contents; it should probably not be used for changing
10935 the contents of the article buffer.
10937 @item gnus-article-mode-hook
10938 @vindex gnus-article-mode-hook
10939 Hook called in article mode buffers.
10941 @item gnus-article-mode-syntax-table
10942 @vindex gnus-article-mode-syntax-table
10943 Syntax table used in article buffers. It is initialized from
10944 @code{text-mode-syntax-table}.
10946 @vindex gnus-article-mode-line-format
10947 @item gnus-article-mode-line-format
10948 This variable is a format string along the same lines as
10949 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}). It
10950 accepts the same format specifications as that variable, with two
10956 The @dfn{wash status} of the article. This is a short string with one
10957 character for each possible article wash operation that may have been
10958 performed. The characters and their meaning:
10963 Displayed when cited text may be hidden in the article buffer.
10966 Displayed when headers are hidden in the article buffer.
10969 Displayed when article is digitally signed or encrypted, and Gnus has
10970 hidden the security headers. (N.B. does not tell anything about
10971 security status, i.e. good or bad signature.)
10974 Displayed when the signature has been hidden in the Article buffer.
10977 Displayed when Gnus has treated overstrike characters in the article buffer.
10980 Displayed when Gnus has treated emphasised strings in the article buffer.
10985 The number of @sc{mime} parts in the article.
10989 @vindex gnus-break-pages
10991 @item gnus-break-pages
10992 Controls whether @dfn{page breaking} is to take place. If this variable
10993 is non-@code{nil}, the articles will be divided into pages whenever a
10994 page delimiter appears in the article. If this variable is @code{nil},
10995 paging will not be done.
10997 @item gnus-page-delimiter
10998 @vindex gnus-page-delimiter
10999 This is the delimiter mentioned above. By default, it is @samp{^L}
11004 @node Composing Messages
11005 @chapter Composing Messages
11006 @cindex composing messages
11009 @cindex sending mail
11014 @cindex using s/mime
11015 @cindex using smime
11017 @kindex C-c C-c (Post)
11018 All commands for posting and mailing will put you in a message buffer
11019 where you can edit the article all you like, before you send the
11020 article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message,
11021 Message Manual}. Where the message will be posted/mailed to depends
11022 on your setup (@pxref{Posting Server}).
11025 * Mail:: Mailing and replying.
11026 * Posting Server:: What server should you post and mail via?
11027 * Mail and Post:: Mailing and posting at the same time.
11028 * Archived Messages:: Where Gnus stores the messages you've sent.
11029 * Posting Styles:: An easier way to specify who you are.
11030 * Drafts:: Postponing messages and rejected messages.
11031 * Rejected Articles:: What happens if the server doesn't like your article?
11032 * Signing and encrypting:: How to compose secure messages.
11035 Also see @pxref{Canceling and Superseding} for information on how to
11036 remove articles you shouldn't have posted.
11042 Variables for customizing outgoing mail:
11045 @item gnus-uu-digest-headers
11046 @vindex gnus-uu-digest-headers
11047 List of regexps to match headers included in digested messages. The
11048 headers will be included in the sequence they are matched. If
11049 @code{nil} include all headers.
11051 @item gnus-add-to-list
11052 @vindex gnus-add-to-list
11053 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
11054 that have none when you do a @kbd{a}.
11056 @item gnus-confirm-mail-reply-to-news
11057 @vindex gnus-confirm-mail-reply-to-news
11058 This can also be a function receiving the group name as the only
11059 parameter which should return non-@code{nil} if a confirmation is
11060 needed, or a regular expression matching group names, where
11061 confirmation is should be asked for.
11063 If you find yourself never wanting to reply to mail, but occasionally
11064 press R anyway, this variable might be for you.
11066 @item gnus-confirm-treat-mail-like-news
11067 @vindex gnus-confirm-treat-mail-like-news
11068 If non-@code{nil}, Gnus also requests confirmation according to
11069 @code{gnus-confirm-mail-reply-to-news} when replying to mail. This is
11070 useful for treating mailing lists like newsgroups.
11075 @node Posting Server
11076 @section Posting Server
11078 When you press those magical @kbd{C-c C-c} keys to ship off your latest
11079 (extremely intelligent, of course) article, where does it go?
11081 Thank you for asking. I hate you.
11083 It can be quite complicated.
11085 @vindex gnus-post-method
11086 When posting news, Message usually invokes @code{message-send-news}
11087 (@pxref{News Variables, , News Variables, message, Message Manual}).
11088 Normally, Gnus will post using the same select method as you're
11089 reading from (which might be convenient if you're reading lots of
11090 groups from different private servers). However. If the server
11091 you're reading from doesn't allow posting, just reading, you probably
11092 want to use some other server to post your (extremely intelligent and
11093 fabulously interesting) articles. You can then set the
11094 @code{gnus-post-method} to some other method:
11097 (setq gnus-post-method '(nnspool ""))
11100 Now, if you've done this, and then this server rejects your article, or
11101 this server is down, what do you do then? To override this variable you
11102 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
11103 the ``current'' server, to get back the default behavior, for posting.
11105 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
11106 Gnus will prompt you for what method to use for posting.
11108 You can also set @code{gnus-post-method} to a list of select methods.
11109 If that's the case, Gnus will always prompt you for what method to use
11112 Finally, if you want to always post using the native select method,
11113 you can set this variable to @code{native}.
11115 When sending mail, Message invokes @code{message-send-mail-function}.
11116 The default function, @code{message-send-mail-with-sendmail}, pipes
11117 your article to the @code{sendmail} binary for further queuing and
11118 sending. When your local system is not configured for sending mail
11119 using @code{sendmail}, and you have access to a remote @sc{smtp}
11120 server, you can set @code{message-send-mail-function} to
11121 @code{smtpmail-send-it} and make sure to setup the @code{smtpmail}
11122 package correctly. An example:
11125 (setq message-send-mail-function 'smtpmail-send-it
11126 smtpmail-default-smtp-server "YOUR SMTP HOST")
11129 To the thing similar to this, there is @code{message-smtpmail-send-it}.
11130 It is useful if your ISP requires the POP-before-SMTP authentication.
11131 See the documentation for the function @code{mail-source-touch-pop}.
11133 Other possible choices for @code{message-send-mail-function} includes
11134 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
11135 and @code{feedmail-send-it}.
11137 @node Mail and Post
11138 @section Mail and Post
11140 Here's a list of variables relevant to both mailing and
11144 @item gnus-mailing-list-groups
11145 @findex gnus-mailing-list-groups
11146 @cindex mailing lists
11148 If your news server offers groups that are really mailing lists
11149 gatewayed to the @sc{nntp} server, you can read those groups without
11150 problems, but you can't post/followup to them without some difficulty.
11151 One solution is to add a @code{to-address} to the group parameters
11152 (@pxref{Group Parameters}). An easier thing to do is set the
11153 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
11154 really are mailing lists. Then, at least, followups to the mailing
11155 lists will work most of the time. Posting to these groups (@kbd{a}) is
11156 still a pain, though.
11158 @item gnus-version-expose-system
11159 @vindex gnus-version-expose-system
11161 Your system type (@code{system-configuration} variable, such as
11162 @samp{i686-pc-linux}) is exposed in the auto-generated by default
11163 User-Agent header. Sometimes, it may be desireable (mostly because of
11164 aesthetic reasons) to turn it off. In this case, set it to @code{nil}.
11168 You may want to do spell-checking on messages that you send out. Or, if
11169 you don't want to spell-check by hand, you could add automatic
11170 spell-checking via the @code{ispell} package:
11173 @findex ispell-message
11175 (add-hook 'message-send-hook 'ispell-message)
11178 If you want to change the @code{ispell} dictionary based on what group
11179 you're in, you could say something like the following:
11182 (add-hook 'gnus-select-group-hook
11186 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
11187 (ispell-change-dictionary "deutsch"))
11189 (ispell-change-dictionary "english")))))
11192 Modify to suit your needs.
11195 @node Archived Messages
11196 @section Archived Messages
11197 @cindex archived messages
11198 @cindex sent messages
11200 Gnus provides a few different methods for storing the mail and news you
11201 send. The default method is to use the @dfn{archive virtual server} to
11202 store the messages. If you want to disable this completely, the
11203 @code{gnus-message-archive-group} variable should be @code{nil}, which
11206 For archiving interesting messages in a group you read, see the
11207 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
11210 @vindex gnus-message-archive-method
11211 @code{gnus-message-archive-method} says what virtual server Gnus is to
11212 use to store sent messages. The default is:
11215 (nnfolder "archive"
11216 (nnfolder-directory "~/Mail/archive")
11217 (nnfolder-active-file "~/Mail/archive/active")
11218 (nnfolder-get-new-mail nil)
11219 (nnfolder-inhibit-expiry t))
11222 You can, however, use any mail select method (@code{nnml},
11223 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
11224 for doing this sort of thing, though. If you don't like the default
11225 directory chosen, you could say something like:
11228 (setq gnus-message-archive-method
11229 '(nnfolder "archive"
11230 (nnfolder-inhibit-expiry t)
11231 (nnfolder-active-file "~/News/sent-mail/active")
11232 (nnfolder-directory "~/News/sent-mail/")))
11235 @vindex gnus-message-archive-group
11237 Gnus will insert @code{Gcc} headers in all outgoing messages that point
11238 to one or more group(s) on that server. Which group to use is
11239 determined by the @code{gnus-message-archive-group} variable.
11241 This variable can be used to do the following:
11246 Messages will be saved in that group.
11248 Note that you can include a select method in the group name, then the
11249 message will not be stored in the select method given by
11250 @code{gnus-message-archive-method}, but in the select method specified
11251 by the group name, instead. Suppose @code{gnus-message-archive-method}
11252 has the default value shown above. Then setting
11253 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
11254 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
11255 value @code{"nnml:foo"}, then outgoing messages will be stored in
11259 Messages will be saved in all those groups.
11261 an alist of regexps, functions and forms
11262 When a key ``matches'', the result is used.
11265 No message archiving will take place. This is the default.
11270 Just saving to a single group called @samp{MisK}:
11272 (setq gnus-message-archive-group "MisK")
11275 Saving to two groups, @samp{MisK} and @samp{safe}:
11277 (setq gnus-message-archive-group '("MisK" "safe"))
11280 Save to different groups based on what group you are in:
11282 (setq gnus-message-archive-group
11283 '(("^alt" "sent-to-alt")
11284 ("mail" "sent-to-mail")
11285 (".*" "sent-to-misc")))
11288 More complex stuff:
11290 (setq gnus-message-archive-group
11291 '((if (message-news-p)
11296 How about storing all news messages in one file, but storing all mail
11297 messages in one file per month:
11300 (setq gnus-message-archive-group
11301 '((if (message-news-p)
11303 (concat "mail." (format-time-string "%Y-%m")))))
11306 @c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
11307 @c use a different value for @code{gnus-message-archive-group} there.)
11309 Now, when you send a message off, it will be stored in the appropriate
11310 group. (If you want to disable storing for just one particular message,
11311 you can just remove the @code{Gcc} header that has been inserted.) The
11312 archive group will appear in the group buffer the next time you start
11313 Gnus, or the next time you press @kbd{F} in the group buffer. You can
11314 enter it and read the articles in it just like you'd read any other
11315 group. If the group gets really big and annoying, you can simply rename
11316 if (using @kbd{G r} in the group buffer) to something
11317 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
11318 continue to be stored in the old (now empty) group.
11320 That's the default method of archiving sent messages. Gnus offers a
11321 different way for the people who don't like the default method. In that
11322 case you should set @code{gnus-message-archive-group} to @code{nil};
11323 this will disable archiving.
11326 @item gnus-outgoing-message-group
11327 @vindex gnus-outgoing-message-group
11328 All outgoing messages will be put in this group. If you want to store
11329 all your outgoing mail and articles in the group @samp{nnml:archive},
11330 you set this variable to that value. This variable can also be a list of
11333 If you want to have greater control over what group to put each
11334 message in, you can set this variable to a function that checks the
11335 current newsgroup name and then returns a suitable group name (or list
11338 This variable can be used instead of @code{gnus-message-archive-group},
11339 but the latter is the preferred method.
11341 @item gnus-gcc-mark-as-read
11342 @vindex gnus-gcc-mark-as-read
11343 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
11345 @item gnus-gcc-externalize-attachments
11346 @vindex gnus-gcc-externalize-attachments
11347 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
11348 and matches the Gcc group name, attach files as external parts; if it is
11349 @code{all}, attach local files as external parts; if it is other
11350 non-@code{nil}, the behavior is the same as @code{all}, but it may be
11351 changed in the future.
11356 @node Posting Styles
11357 @section Posting Styles
11358 @cindex posting styles
11361 All them variables, they make my head swim.
11363 So what if you want a different @code{Organization} and signature based
11364 on what groups you post to? And you post both from your home machine
11365 and your work machine, and you want different @code{From} lines, and so
11368 @vindex gnus-posting-styles
11369 One way to do stuff like that is to write clever hooks that change the
11370 variables you need to have changed. That's a bit boring, so somebody
11371 came up with the bright idea of letting the user specify these things in
11372 a handy alist. Here's an example of a @code{gnus-posting-styles}
11377 (signature "Peace and happiness")
11378 (organization "What me?"))
11380 (signature "Death to everybody"))
11381 ("comp.emacs.i-love-it"
11382 (organization "Emacs is it")))
11385 As you might surmise from this example, this alist consists of several
11386 @dfn{styles}. Each style will be applicable if the first element
11387 ``matches'', in some form or other. The entire alist will be iterated
11388 over, from the beginning towards the end, and each match will be
11389 applied, which means that attributes in later styles that match override
11390 the same attributes in earlier matching styles. So
11391 @samp{comp.programming.literate} will have the @samp{Death to everybody}
11392 signature and the @samp{What me?} @code{Organization} header.
11394 The first element in each style is called the @code{match}. If it's a
11395 string, then Gnus will try to regexp match it against the group name.
11396 If it is the form @code{(header MATCH REGEXP)}, then Gnus will look in
11397 the original article for a header whose name is MATCH and compare that
11398 REGEXP. MATCH and REGEXP are strings. (There original article is the
11399 one you are replying or following up to. If you are not composing a
11400 reply or a followup, then there is nothing to match against.) If the
11401 @code{match} is a function symbol, that function will be called with no
11402 arguments. If it's a variable symbol, then the variable will be
11403 referenced. If it's a list, then that list will be @code{eval}ed. In
11404 any case, if this returns a non-@code{nil} value, then the style is said
11407 Each style may contain an arbitrary amount of @dfn{attributes}. Each
11408 attribute consists of a @code{(@var{name} @var{value})} pair. The
11409 attribute name can be one of @code{signature}, @code{signature-file},
11410 @code{x-face-file}, @code{address} (overriding
11411 @code{user-mail-address}), @code{name} (overriding
11412 @code{(user-full-name)}) or @code{body}. The attribute name can also
11413 be a string or a symbol. In that case, this will be used as a header
11414 name, and the value will be inserted in the headers of the article; if
11415 the value is @code{nil}, the header name will be removed. If the
11416 attribute name is @code{eval}, the form is evaluated, and the result
11419 The attribute value can be a string (used verbatim), a function with
11420 zero arguments (the return value will be used), a variable (its value
11421 will be used) or a list (it will be @code{eval}ed and the return value
11422 will be used). The functions and sexps are called/@code{eval}ed in the
11423 message buffer that is being set up. The headers of the current article
11424 are available through the @code{message-reply-headers} variable, which
11425 is a vector of the following headers: number subject from date id
11426 references chars lines xref extra.
11428 @vindex message-reply-headers
11430 If you wish to check whether the message you are about to compose is
11431 meant to be a news article or a mail message, you can check the values
11432 of the @code{message-news-p} and @code{message-mail-p} functions.
11434 @findex message-mail-p
11435 @findex message-news-p
11437 So here's a new example:
11440 (setq gnus-posting-styles
11442 (signature-file "~/.signature")
11444 ("X-Home-Page" (getenv "WWW_HOME"))
11445 (organization "People's Front Against MWM"))
11447 (signature my-funny-signature-randomizer))
11448 ((equal (system-name) "gnarly") ;; A form
11449 (signature my-quote-randomizer))
11450 (message-news-p ;; A function symbol
11451 (signature my-news-signature))
11452 (window-system ;; A value symbol
11453 ("X-Window-System" (format "%s" window-system)))
11454 ;; If I'm replying to Larsi, set the Organization header.
11455 ((header "from" "larsi.*org")
11456 (Organization "Somewhere, Inc."))
11457 ((posting-from-work-p) ;; A user defined function
11458 (signature-file "~/.work-signature")
11459 (address "user@@bar.foo")
11460 (body "You are fired.\n\nSincerely, your boss.")
11461 (organization "Important Work, Inc"))
11463 (From (save-excursion
11464 (set-buffer gnus-article-buffer)
11465 (message-fetch-field "to"))))
11467 (signature-file "~/.mail-signature"))))
11470 The @samp{nnml:.*} rule means that you use the @code{To} address as the
11471 @code{From} address in all your outgoing replies, which might be handy
11472 if you fill many roles.
11479 If you are writing a message (mail or news) and suddenly remember that
11480 you have a steak in the oven (or some pesto in the food processor, you
11481 craaazy vegetarians), you'll probably wish there was a method to save
11482 the message you are writing so that you can continue editing it some
11483 other day, and send it when you feel its finished.
11485 Well, don't worry about it. Whenever you start composing a message of
11486 some sort using the Gnus mail and post commands, the buffer you get will
11487 automatically associate to an article in a special @dfn{draft} group.
11488 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
11489 article will be saved there. (Auto-save files also go to the draft
11493 @vindex nndraft-directory
11494 The draft group is a special group (which is implemented as an
11495 @code{nndraft} group, if you absolutely have to know) called
11496 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
11497 @code{nndraft} is to store its files. What makes this group special is
11498 that you can't tick any articles in it or mark any articles as
11499 read---all articles in the group are permanently unread.
11501 If the group doesn't exist, it will be created and you'll be subscribed
11502 to it. The only way to make it disappear from the Group buffer is to
11505 @c @findex gnus-dissociate-buffer-from-draft
11506 @c @kindex C-c M-d (Mail)
11507 @c @kindex C-c M-d (Post)
11508 @c @findex gnus-associate-buffer-with-draft
11509 @c @kindex C-c C-d (Mail)
11510 @c @kindex C-c C-d (Post)
11511 @c If you're writing some super-secret message that you later want to
11512 @c encode with PGP before sending, you may wish to turn the auto-saving
11513 @c (and association with the draft group) off. You never know who might be
11514 @c interested in reading all your extremely valuable and terribly horrible
11515 @c and interesting secrets. The @kbd{C-c M-d}
11516 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
11517 @c If you change your mind and want to turn the auto-saving back on again,
11518 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
11520 @c @vindex gnus-use-draft
11521 @c To leave association with the draft group off by default, set
11522 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
11524 @findex gnus-draft-edit-message
11525 @kindex D e (Draft)
11526 When you want to continue editing the article, you simply enter the
11527 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
11528 that. You will be placed in a buffer where you left off.
11530 Rejected articles will also be put in this draft group (@pxref{Rejected
11533 @findex gnus-draft-send-all-messages
11534 @kindex D s (Draft)
11535 @findex gnus-draft-send-message
11536 @kindex D S (Draft)
11537 If you have lots of rejected messages you want to post (or mail) without
11538 doing further editing, you can use the @kbd{D s} command
11539 (@code{gnus-draft-send-message}). This command understands the
11540 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
11541 command (@code{gnus-draft-send-all-messages}) will ship off all messages
11544 @findex gnus-draft-toggle-sending
11545 @kindex D t (Draft)
11546 If you have some messages that you wish not to send, you can use the
11547 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
11548 as unsendable. This is a toggling command.
11551 @node Rejected Articles
11552 @section Rejected Articles
11553 @cindex rejected articles
11555 Sometimes a news server will reject an article. Perhaps the server
11556 doesn't like your face. Perhaps it just feels miserable. Perhaps
11557 @emph{there be demons}. Perhaps you have included too much cited text.
11558 Perhaps the disk is full. Perhaps the server is down.
11560 These situations are, of course, totally beyond the control of Gnus.
11561 (Gnus, of course, loves the way you look, always feels great, has angels
11562 fluttering around inside of it, doesn't care about how much cited text
11563 you include, never runs full and never goes down.) So Gnus saves these
11564 articles until some later time when the server feels better.
11566 The rejected articles will automatically be put in a special draft group
11567 (@pxref{Drafts}). When the server comes back up again, you'd then
11568 typically enter that group and send all the articles off.
11570 @node Signing and encrypting
11571 @section Signing and encrypting
11573 @cindex using s/mime
11574 @cindex using smime
11576 Gnus can digitally sign and encrypt your messages, using vanilla PGP
11577 format or @sc{pgp/mime} or @sc{s/mime}. For decoding such messages,
11578 see the @code{mm-verify-option} and @code{mm-decrypt-option} options
11579 (@pxref{Security}).
11581 @vindex gnus-message-replysign
11582 @vindex gnus-message-replyencrypt
11583 @vindex gnus-message-replysignencrypted
11584 Often, you would like to sign replies to people who send you signed
11585 messages. Even more often, you might want to encrypt messages which
11586 are in reply to encrypted messages. Gnus offers
11587 @code{gnus-message-replysign} to enable the former, and
11588 @code{gnus-message-replyencrypt} for the latter. In addition, setting
11589 @code{gnus-message-replysignencrypted} (on by default) will sign
11590 automatically encrypted messages.
11592 Instructing MML to perform security operations on a @sc{mime} part is
11593 done using the @kbd{C-c C-m s} key map for signing and the @kbd{C-c
11594 C-m c} key map for encryption, as follows.
11599 @kindex C-c C-m s s
11600 @findex mml-secure-message-sign-smime
11602 Digitally sign current message using @sc{s/mime}.
11605 @kindex C-c C-m s o
11606 @findex mml-secure-message-sign-pgp
11608 Digitally sign current message using PGP.
11611 @kindex C-c C-m s p
11612 @findex mml-secure-message-sign-pgp
11614 Digitally sign current message using @sc{pgp/mime}.
11617 @kindex C-c C-m c s
11618 @findex mml-secure-message-encrypt-smime
11620 Digitally encrypt current message using @sc{s/mime}.
11623 @kindex C-c C-m c o
11624 @findex mml-secure-message-encrypt-pgp
11626 Digitally encrypt current message using PGP.
11629 @kindex C-c C-m c p
11630 @findex mml-secure-message-encrypt-pgpmime
11632 Digitally encrypt current message using @sc{pgp/mime}.
11635 @kindex C-c C-m C-n
11636 @findex mml-unsecure-message
11637 Remove security related MML tags from message.
11641 @xref{Security, ,Security, message, Message Manual}, for more information.
11643 @node Select Methods
11644 @chapter Select Methods
11645 @cindex foreign groups
11646 @cindex select methods
11648 A @dfn{foreign group} is a group not read by the usual (or
11649 default) means. It could be, for instance, a group from a different
11650 @sc{nntp} server, it could be a virtual group, or it could be your own
11651 personal mail group.
11653 A foreign group (or any group, really) is specified by a @dfn{name} and
11654 a @dfn{select method}. To take the latter first, a select method is a
11655 list where the first element says what back end to use (e.g. @code{nntp},
11656 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
11657 name}. There may be additional elements in the select method, where the
11658 value may have special meaning for the back end in question.
11660 One could say that a select method defines a @dfn{virtual server}---so
11661 we do just that (@pxref{Server Buffer}).
11663 The @dfn{name} of the group is the name the back end will recognize the
11666 For instance, the group @samp{soc.motss} on the @sc{nntp} server
11667 @samp{some.where.edu} will have the name @samp{soc.motss} and select
11668 method @code{(nntp "some.where.edu")}. Gnus will call this group
11669 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
11670 back end just knows this group as @samp{soc.motss}.
11672 The different methods all have their peculiarities, of course.
11675 * Server Buffer:: Making and editing virtual servers.
11676 * Getting News:: Reading USENET news with Gnus.
11677 * Getting Mail:: Reading your personal mail with Gnus.
11678 * Browsing the Web:: Getting messages from a plethora of Web sources.
11679 * IMAP:: Using Gnus as a @sc{imap} client.
11680 * Other Sources:: Reading directories, files, SOUP packets.
11681 * Combined Groups:: Combining groups into one group.
11682 * Gnus Unplugged:: Reading news and mail offline.
11686 @node Server Buffer
11687 @section Server Buffer
11689 Traditionally, a @dfn{server} is a machine or a piece of software that
11690 one connects to, and then requests information from. Gnus does not
11691 connect directly to any real servers, but does all transactions through
11692 one back end or other. But that's just putting one layer more between
11693 the actual media and Gnus, so we might just as well say that each
11694 back end represents a virtual server.
11696 For instance, the @code{nntp} back end may be used to connect to several
11697 different actual @sc{nntp} servers, or, perhaps, to many different ports
11698 on the same actual @sc{nntp} server. You tell Gnus which back end to
11699 use, and what parameters to set by specifying a @dfn{select method}.
11701 These select method specifications can sometimes become quite
11702 complicated---say, for instance, that you want to read from the
11703 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
11704 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
11705 Anyway, if you had to specify that for each group that used this
11706 server, that would be too much work, so Gnus offers a way of naming
11707 select methods, which is what you do in the server buffer.
11709 To enter the server buffer, use the @kbd{^}
11710 (@code{gnus-group-enter-server-mode}) command in the group buffer.
11713 * Server Buffer Format:: You can customize the look of this buffer.
11714 * Server Commands:: Commands to manipulate servers.
11715 * Example Methods:: Examples server specifications.
11716 * Creating a Virtual Server:: An example session.
11717 * Server Variables:: Which variables to set.
11718 * Servers and Methods:: You can use server names as select methods.
11719 * Unavailable Servers:: Some servers you try to contact may be down.
11722 @vindex gnus-server-mode-hook
11723 @code{gnus-server-mode-hook} is run when creating the server buffer.
11726 @node Server Buffer Format
11727 @subsection Server Buffer Format
11728 @cindex server buffer format
11730 @vindex gnus-server-line-format
11731 You can change the look of the server buffer lines by changing the
11732 @code{gnus-server-line-format} variable. This is a @code{format}-like
11733 variable, with some simple extensions:
11738 How the news is fetched---the back end name.
11741 The name of this server.
11744 Where the news is to be fetched from---the address.
11747 The opened/closed/denied status of the server.
11750 @vindex gnus-server-mode-line-format
11751 The mode line can also be customized by using the
11752 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
11753 Formatting}). The following specs are understood:
11763 Also @pxref{Formatting Variables}.
11766 @node Server Commands
11767 @subsection Server Commands
11768 @cindex server commands
11774 @findex gnus-server-add-server
11775 Add a new server (@code{gnus-server-add-server}).
11779 @findex gnus-server-edit-server
11780 Edit a server (@code{gnus-server-edit-server}).
11783 @kindex SPACE (Server)
11784 @findex gnus-server-read-server
11785 Browse the current server (@code{gnus-server-read-server}).
11789 @findex gnus-server-exit
11790 Return to the group buffer (@code{gnus-server-exit}).
11794 @findex gnus-server-kill-server
11795 Kill the current server (@code{gnus-server-kill-server}).
11799 @findex gnus-server-yank-server
11800 Yank the previously killed server (@code{gnus-server-yank-server}).
11804 @findex gnus-server-copy-server
11805 Copy the current server (@code{gnus-server-copy-server}).
11809 @findex gnus-server-list-servers
11810 List all servers (@code{gnus-server-list-servers}).
11814 @findex gnus-server-scan-server
11815 Request that the server scan its sources for new articles
11816 (@code{gnus-server-scan-server}). This is mainly sensible with mail
11821 @findex gnus-server-regenerate-server
11822 Request that the server regenerate all its data structures
11823 (@code{gnus-server-regenerate-server}). This can be useful if you have
11824 a mail back end that has gotten out of sync.
11829 @node Example Methods
11830 @subsection Example Methods
11832 Most select methods are pretty simple and self-explanatory:
11835 (nntp "news.funet.fi")
11838 Reading directly from the spool is even simpler:
11844 As you can see, the first element in a select method is the name of the
11845 back end, and the second is the @dfn{address}, or @dfn{name}, if you
11848 After these two elements, there may be an arbitrary number of
11849 @code{(@var{variable} @var{form})} pairs.
11851 To go back to the first example---imagine that you want to read from
11852 port 15 on that machine. This is what the select method should
11856 (nntp "news.funet.fi" (nntp-port-number 15))
11859 You should read the documentation to each back end to find out what
11860 variables are relevant, but here's an @code{nnmh} example:
11862 @code{nnmh} is a mail back end that reads a spool-like structure. Say
11863 you have two structures that you wish to access: One is your private
11864 mail spool, and the other is a public one. Here's the possible spec for
11868 (nnmh "private" (nnmh-directory "~/private/mail/"))
11871 (This server is then called @samp{private}, but you may have guessed
11874 Here's the method for a public spool:
11878 (nnmh-directory "/usr/information/spool/")
11879 (nnmh-get-new-mail nil))
11885 If you are behind a firewall and only have access to the @sc{nntp}
11886 server from the firewall machine, you can instruct Gnus to @code{rlogin}
11887 on the firewall machine and telnet from there to the @sc{nntp} server.
11888 Doing this can be rather fiddly, but your virtual server definition
11889 should probably look something like this:
11893 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
11894 (nntp-via-address "the.firewall.machine")
11895 (nntp-address "the.real.nntp.host")
11896 (nntp-end-of-line "\n"))
11899 If you want to use the wonderful @code{ssh} program to provide a
11900 compressed connection over the modem line, you could add the following
11901 configuration to the example above:
11904 (nntp-via-rlogin-command "ssh")
11907 See also @code{nntp-via-rlogin-command-switches}.
11909 If you're behind a firewall, but have direct access to the outside world
11910 through a wrapper command like "runsocks", you could open a socksified
11911 telnet connection to the news server as follows:
11915 (nntp-pre-command "runsocks")
11916 (nntp-open-connection-function nntp-open-via-telnet)
11917 (nntp-address "the.news.server")
11918 (nntp-end-of-line "\n"))
11921 This means that you have to have set up @code{ssh-agent} correctly to
11922 provide automatic authorization, of course. And to get a compressed
11923 connection, you have to have the @samp{Compression} option in the
11924 @code{ssh} @file{config} file.
11927 @node Creating a Virtual Server
11928 @subsection Creating a Virtual Server
11930 If you're saving lots of articles in the cache by using persistent
11931 articles, you may want to create a virtual server to read the cache.
11933 First you need to add a new server. The @kbd{a} command does that. It
11934 would probably be best to use @code{nnspool} to read the cache. You
11935 could also use @code{nnml} or @code{nnmh}, though.
11937 Type @kbd{a nnspool RET cache RET}.
11939 You should now have a brand new @code{nnspool} virtual server called
11940 @samp{cache}. You now need to edit it to have the right definitions.
11941 Type @kbd{e} to edit the server. You'll be entered into a buffer that
11942 will contain the following:
11952 (nnspool-spool-directory "~/News/cache/")
11953 (nnspool-nov-directory "~/News/cache/")
11954 (nnspool-active-file "~/News/cache/active"))
11957 Type @kbd{C-c C-c} to return to the server buffer. If you now press
11958 @kbd{RET} over this virtual server, you should be entered into a browse
11959 buffer, and you should be able to enter any of the groups displayed.
11962 @node Server Variables
11963 @subsection Server Variables
11965 One sticky point when defining variables (both on back ends and in Emacs
11966 in general) is that some variables are typically initialized from other
11967 variables when the definition of the variables is being loaded. If you
11968 change the "base" variable after the variables have been loaded, you
11969 won't change the "derived" variables.
11971 This typically affects directory and file variables. For instance,
11972 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
11973 directory variables are initialized from that variable, so
11974 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
11975 new virtual @code{nnml} server, it will @emph{not} suffice to set just
11976 @code{nnml-directory}---you have to explicitly set all the file
11977 variables to be what you want them to be. For a complete list of
11978 variables for each back end, see each back end's section later in this
11979 manual, but here's an example @code{nnml} definition:
11983 (nnml-directory "~/my-mail/")
11984 (nnml-active-file "~/my-mail/active")
11985 (nnml-newsgroups-file "~/my-mail/newsgroups"))
11989 @node Servers and Methods
11990 @subsection Servers and Methods
11992 Wherever you would normally use a select method
11993 (e.g. @code{gnus-secondary-select-method}, in the group select method,
11994 when browsing a foreign server) you can use a virtual server name
11995 instead. This could potentially save lots of typing. And it's nice all
11999 @node Unavailable Servers
12000 @subsection Unavailable Servers
12002 If a server seems to be unreachable, Gnus will mark that server as
12003 @code{denied}. That means that any subsequent attempt to make contact
12004 with that server will just be ignored. ``It can't be opened,'' Gnus
12005 will tell you, without making the least effort to see whether that is
12006 actually the case or not.
12008 That might seem quite naughty, but it does make sense most of the time.
12009 Let's say you have 10 groups subscribed to on server
12010 @samp{nephelococcygia.com}. This server is located somewhere quite far
12011 away from you and the machine is quite slow, so it takes 1 minute just
12012 to find out that it refuses connection to you today. If Gnus were to
12013 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
12014 attempt to do that. Once it has gotten a single ``connection refused'',
12015 it will regard that server as ``down''.
12017 So, what happens if the machine was only feeling unwell temporarily?
12018 How do you test to see whether the machine has come up again?
12020 You jump to the server buffer (@pxref{Server Buffer}) and poke it
12021 with the following commands:
12027 @findex gnus-server-open-server
12028 Try to establish connection to the server on the current line
12029 (@code{gnus-server-open-server}).
12033 @findex gnus-server-close-server
12034 Close the connection (if any) to the server
12035 (@code{gnus-server-close-server}).
12039 @findex gnus-server-deny-server
12040 Mark the current server as unreachable
12041 (@code{gnus-server-deny-server}).
12044 @kindex M-o (Server)
12045 @findex gnus-server-open-all-servers
12046 Open the connections to all servers in the buffer
12047 (@code{gnus-server-open-all-servers}).
12050 @kindex M-c (Server)
12051 @findex gnus-server-close-all-servers
12052 Close the connections to all servers in the buffer
12053 (@code{gnus-server-close-all-servers}).
12057 @findex gnus-server-remove-denials
12058 Remove all marks to whether Gnus was denied connection from any servers
12059 (@code{gnus-server-remove-denials}).
12063 @findex gnus-server-offline-server
12064 Set server status to offline (@code{gnus-server-offline-server}).
12070 @section Getting News
12071 @cindex reading news
12072 @cindex news back ends
12074 A newsreader is normally used for reading news. Gnus currently provides
12075 only two methods of getting news---it can read from an @sc{nntp} server,
12076 or it can read from a local spool.
12079 * NNTP:: Reading news from an @sc{nntp} server.
12080 * News Spool:: Reading news from the local spool.
12088 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
12089 You just specify @code{nntp} as method and the address of the @sc{nntp}
12090 server as the, uhm, address.
12092 If the @sc{nntp} server is located at a non-standard port, setting the
12093 third element of the select method to this port number should allow you
12094 to connect to the right port. You'll have to edit the group info for
12095 that (@pxref{Foreign Groups}).
12097 The name of the foreign group can be the same as a native group. In
12098 fact, you can subscribe to the same group from as many different servers
12099 you feel like. There will be no name collisions.
12101 The following variables can be used to create a virtual @code{nntp}
12106 @item nntp-server-opened-hook
12107 @vindex nntp-server-opened-hook
12108 @cindex @sc{mode reader}
12110 @cindex authentification
12111 @cindex nntp authentification
12112 @findex nntp-send-authinfo
12113 @findex nntp-send-mode-reader
12114 is run after a connection has been made. It can be used to send
12115 commands to the @sc{nntp} server after it has been contacted. By
12116 default it sends the command @code{MODE READER} to the server with the
12117 @code{nntp-send-mode-reader} function. This function should always be
12118 present in this hook.
12120 @item nntp-authinfo-function
12121 @vindex nntp-authinfo-function
12122 @findex nntp-send-authinfo
12123 @vindex nntp-authinfo-file
12124 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
12125 server. The default function is @code{nntp-send-authinfo}, which looks
12126 through your @file{~/.authinfo} (or whatever you've set the
12127 @code{nntp-authinfo-file} variable to) for applicable entries. If none
12128 are found, it will prompt you for a login name and a password. The
12129 format of the @file{~/.authinfo} file is (almost) the same as the
12130 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
12131 manual page, but here are the salient facts:
12135 The file contains one or more line, each of which define one server.
12138 Each line may contain an arbitrary number of token/value pairs.
12140 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
12141 @samp{default}. In addition Gnus introduces two new tokens, not present
12142 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
12143 @samp{force}. (This is the only way the @file{.authinfo} file format
12144 deviates from the @file{.netrc} file format.) @samp{port} is used to
12145 indicate what port on the server the credentials apply to and
12146 @samp{force} is explained below.
12150 Here's an example file:
12153 machine news.uio.no login larsi password geheimnis
12154 machine nntp.ifi.uio.no login larsi force yes
12157 The token/value pairs may appear in any order; @samp{machine} doesn't
12158 have to be first, for instance.
12160 In this example, both login name and password have been supplied for the
12161 former server, while the latter has only the login name listed, and the
12162 user will be prompted for the password. The latter also has the
12163 @samp{force} tag, which means that the authinfo will be sent to the
12164 @var{nntp} server upon connection; the default (i.e., when there is not
12165 @samp{force} tag) is to not send authinfo to the @var{nntp} server
12166 until the @var{nntp} server asks for it.
12168 You can also add @samp{default} lines that will apply to all servers
12169 that don't have matching @samp{machine} lines.
12175 This will force sending @samp{AUTHINFO} commands to all servers not
12176 previously mentioned.
12178 Remember to not leave the @file{~/.authinfo} file world-readable.
12180 @item nntp-server-action-alist
12181 @vindex nntp-server-action-alist
12182 This is a list of regexps to match on server types and actions to be
12183 taken when matches are made. For instance, if you want Gnus to beep
12184 every time you connect to innd, you could say something like:
12187 (setq nntp-server-action-alist
12188 '(("innd" (ding))))
12191 You probably don't want to do that, though.
12193 The default value is
12196 '(("nntpd 1\\.5\\.11t"
12197 (remove-hook 'nntp-server-opened-hook
12198 'nntp-send-mode-reader)))
12201 This ensures that Gnus doesn't send the @code{MODE READER} command to
12202 nntpd 1.5.11t, since that command chokes that server, I've been told.
12204 @item nntp-maximum-request
12205 @vindex nntp-maximum-request
12206 If the @sc{nntp} server doesn't support @sc{nov} headers, this back end
12207 will collect headers by sending a series of @code{head} commands. To
12208 speed things up, the back end sends lots of these commands without
12209 waiting for reply, and then reads all the replies. This is controlled
12210 by the @code{nntp-maximum-request} variable, and is 400 by default. If
12211 your network is buggy, you should set this to 1.
12213 @item nntp-connection-timeout
12214 @vindex nntp-connection-timeout
12215 If you have lots of foreign @code{nntp} groups that you connect to
12216 regularly, you're sure to have problems with @sc{nntp} servers not
12217 responding properly, or being too loaded to reply within reasonable
12218 time. This is can lead to awkward problems, which can be helped
12219 somewhat by setting @code{nntp-connection-timeout}. This is an integer
12220 that says how many seconds the @code{nntp} back end should wait for a
12221 connection before giving up. If it is @code{nil}, which is the default,
12222 no timeouts are done.
12224 @c @item nntp-command-timeout
12225 @c @vindex nntp-command-timeout
12226 @c @cindex PPP connections
12227 @c @cindex dynamic IP addresses
12228 @c If you're running Gnus on a machine that has a dynamically assigned
12229 @c address, Gnus may become confused. If the address of your machine
12230 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
12231 @c waiting forever for replies from the server. To help with this
12232 @c unfortunate problem, you can set this command to a number. Gnus will
12233 @c then, if it sits waiting for a reply from the server longer than that
12234 @c number of seconds, shut down the connection, start a new one, and resend
12235 @c the command. This should hopefully be transparent to the user. A
12236 @c likely number is 30 seconds.
12238 @c @item nntp-retry-on-break
12239 @c @vindex nntp-retry-on-break
12240 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
12241 @c hangs. This will have much the same effect as the command timeout
12242 @c described above.
12244 @item nntp-server-hook
12245 @vindex nntp-server-hook
12246 This hook is run as the last step when connecting to an @sc{nntp}
12249 @item nntp-buggy-select
12250 @vindex nntp-buggy-select
12251 Set this to non-@code{nil} if your select routine is buggy.
12253 @item nntp-nov-is-evil
12254 @vindex nntp-nov-is-evil
12255 If the @sc{nntp} server does not support @sc{nov}, you could set this
12256 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
12259 @item nntp-xover-commands
12260 @vindex nntp-xover-commands
12263 List of strings used as commands to fetch @sc{nov} lines from a
12264 server. The default value of this variable is @code{("XOVER"
12268 @vindex nntp-nov-gap
12269 @code{nntp} normally sends just one big request for @sc{nov} lines to
12270 the server. The server responds with one huge list of lines. However,
12271 if you have read articles 2-5000 in the group, and only want to read
12272 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
12273 lines that you will not need. This variable says how
12274 big a gap between two consecutive articles is allowed to be before the
12275 @code{XOVER} request is split into several request. Note that if your
12276 network is fast, setting this variable to a really small number means
12277 that fetching will probably be slower. If this variable is @code{nil},
12278 @code{nntp} will never split requests. The default is 5.
12280 @item nntp-prepare-server-hook
12281 @vindex nntp-prepare-server-hook
12282 A hook run before attempting to connect to an @sc{nntp} server.
12284 @item nntp-warn-about-losing-connection
12285 @vindex nntp-warn-about-losing-connection
12286 If this variable is non-@code{nil}, some noise will be made when a
12287 server closes connection.
12289 @item nntp-record-commands
12290 @vindex nntp-record-commands
12291 If non-@code{nil}, @code{nntp} will log all commands it sends to the
12292 @sc{nntp} server (along with a timestamp) in the @samp{*nntp-log*}
12293 buffer. This is useful if you are debugging a Gnus/@sc{nntp} connection
12294 that doesn't seem to work.
12296 @item nntp-open-connection-function
12297 @vindex nntp-open-connection-function
12298 It is possible to customize how the connection to the nntp server will
12299 be opened. If you specify an @code{nntp-open-connection-function}
12300 parameter, Gnus will use that function to establish the connection.
12301 Five pre-made functions are supplied. These functions can be grouped in
12302 two categories: direct connection functions (three pre-made), and
12303 indirect ones (two pre-made).
12305 @item nntp-prepare-post-hook
12306 @vindex nntp-prepare-post-hook
12307 A hook run just before posting an article. If there is no
12308 @code{Message-ID} header in the article and the news server provides the
12309 recommended ID, it will be added to the article before running this
12310 hook. It is useful to make @code{Cancel-Lock} headers even if you
12311 inhibit Gnus to add a @code{Message-ID} header, you could say:
12314 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
12317 Note that not all servers support the recommended ID. This works for
12318 INN versions 2.3.0 and later, for instance.
12320 @item nntp-read-timeout
12321 @vindex nntp-read-timeout
12322 How long nntp should wait between checking for the end of output.
12323 Shorter values mean quicker response, but is more CPU intensive. The
12324 default is 0.1 seconds. If you have a slow line to the server (and
12325 don't like to see Emacs eat your available CPU power), you might set
12331 * Direct Functions:: Connecting directly to the server.
12332 * Indirect Functions:: Connecting indirectly to the server.
12333 * Common Variables:: Understood by several connection functions.
12337 @node Direct Functions
12338 @subsubsection Direct Functions
12339 @cindex direct connection functions
12341 These functions are called direct because they open a direct connection
12342 between your machine and the @sc{nntp} server. The behavior of these
12343 functions is also affected by commonly understood variables
12344 (@pxref{Common Variables}).
12347 @findex nntp-open-network-stream
12348 @item nntp-open-network-stream
12349 This is the default, and simply connects to some port or other on the
12352 @findex nntp-open-ssl-stream
12353 @item nntp-open-ssl-stream
12354 Opens a connection to a server over a @dfn{secure} channel. To use
12355 this you must have OpenSSL (@uref{http://www.openssl.org}) or SSLeay
12356 installed (@uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also
12357 need @file{ssl.el} (from the W3 distribution, for instance). You then
12358 define a server as follows:
12361 ;; Type `C-c C-c' after you've finished editing.
12363 ;; "snews" is port 563 and is predefined in our /etc/services
12364 ;; however, openssl s_client -port doesn't like named ports
12366 (nntp "snews.bar.com"
12367 (nntp-open-connection-function nntp-open-ssl-stream)
12368 (nntp-port-number 563)
12369 (nntp-address "snews.bar.com"))
12372 @findex nntp-open-telnet-stream
12373 @item nntp-open-telnet-stream
12374 Opens a connection to an @sc{nntp} server by simply @samp{telnet}'ing
12375 it. You might wonder why this function exists, since we have the
12376 default @code{nntp-open-network-stream} which would do the job. (One
12377 of) the reason(s) is that if you are behind a firewall but have direct
12378 connections to the outside world thanks to a command wrapper like
12379 @code{runsocks}, you can use it like this:
12383 (nntp-pre-command "runsocks")
12384 (nntp-open-connection-function nntp-open-telnet-stream)
12385 (nntp-address "the.news.server"))
12388 With the default method, you would need to wrap your whole Emacs
12389 session, which is not a good idea.
12393 @node Indirect Functions
12394 @subsubsection Indirect Functions
12395 @cindex indirect connection functions
12397 These functions are called indirect because they connect to an
12398 intermediate host before actually connecting to the @sc{nntp} server.
12399 All of these functions and related variables are also said to belong to
12400 the "via" family of connection: they're all prefixed with "via" to make
12401 things cleaner. The behavior of these functions is also affected by
12402 commonly understood variables (@pxref{Common Variables}).
12405 @item nntp-open-via-rlogin-and-telnet
12406 @findex nntp-open-via-rlogin-and-telnet
12407 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
12408 to the real @sc{nntp} server from there. This is useful for instance if
12409 you need to connect to a firewall machine first.
12411 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
12414 @item nntp-via-rlogin-command
12415 @vindex nntp-via-rlogin-command
12416 Command used to log in on the intermediate host. The default is
12417 @samp{rsh}, but @samp{ssh} is a popular alternative.
12419 @item nntp-via-rlogin-command-switches
12420 @vindex nntp-via-rlogin-command-switches
12421 List of strings to be used as the switches to
12422 @code{nntp-via-rlogin-command}. The default is @code{nil}. If you use
12423 @samp{ssh} for `nntp-via-rlogin-command', you may set this to
12424 @samp{("-C")} in order to compress all data connections, otherwise set
12425 this to @samp{("-t")} or @samp{("-C" "-t")} if the telnet command
12426 requires a pseudo-tty allocation on an intermediate host.
12429 @item nntp-open-via-telnet-and-telnet
12430 @findex nntp-open-via-telnet-and-telnet
12431 Does essentially the same, but uses @samp{telnet} instead of
12432 @samp{rlogin} to connect to the intermediate host.
12434 @code{nntp-open-via-telnet-and-telnet}-specific variables:
12437 @item nntp-via-telnet-command
12438 @vindex nntp-via-telnet-command
12439 Command used to @code{telnet} the intermediate host. The default is
12442 @item nntp-via-telnet-switches
12443 @vindex nntp-via-telnet-switches
12444 List of strings to be used as the switches to the
12445 @code{nntp-via-telnet-command} command. The default is @samp{("-8")}.
12447 @item nntp-via-user-password
12448 @vindex nntp-via-user-password
12449 Password to use when logging in on the intermediate host.
12451 @item nntp-via-envuser
12452 @vindex nntp-via-envuser
12453 If non-@code{nil}, the intermediate @code{telnet} session (client and
12454 server both) will support the @code{ENVIRON} option and not prompt for
12455 login name. This works for Solaris @code{telnet}, for instance.
12457 @item nntp-via-shell-prompt
12458 @vindex nntp-via-shell-prompt
12459 Regexp matching the shell prompt on the intermediate host. The default
12460 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
12467 Here are some additional variables that are understood by all the above
12472 @item nntp-via-user-name
12473 @vindex nntp-via-user-name
12474 User name to use when connecting to the intermediate host.
12476 @item nntp-via-address
12477 @vindex nntp-via-address
12478 Address of the intermediate host to connect to.
12483 @node Common Variables
12484 @subsubsection Common Variables
12486 The following variables affect the behavior of all, or several of the
12487 pre-made connection functions. When not specified, all functions are
12492 @item nntp-pre-command
12493 @vindex nntp-pre-command
12494 A command wrapper to use when connecting through a non native connection
12495 function (all except @code{nntp-open-network-stream} and
12496 @code{nntp-open-ssl-stream}. This is where you would put a @samp{SOCKS}
12497 wrapper for instance.
12500 @vindex nntp-address
12501 The address of the @sc{nntp} server.
12503 @item nntp-port-number
12504 @vindex nntp-port-number
12505 Port number to connect to the @sc{nntp} server. The default is @samp{nntp}.
12506 If you use @sc{nntp} over @sc{ssl}, you may want to use integer ports rather
12507 than named ports (i.e, use @samp{563} instead of @samp{snews}), because
12508 external SSL tools may not work with named ports.
12510 @item nntp-end-of-line
12511 @vindex nntp-end-of-line
12512 String to use as end-of-line marker when talking to the @sc{nntp}
12513 server. This is @samp{\r\n} by default, but should be @samp{\n} when
12514 using a non native connection function.
12516 @item nntp-telnet-command
12517 @vindex nntp-telnet-command
12518 Command to use when connecting to the @sc{nntp} server through
12519 @samp{telnet}. This is NOT for an intermediate host. This is just for
12520 the real @sc{nntp} server. The default is @samp{telnet}.
12522 @item nntp-telnet-switches
12523 @vindex nntp-telnet-switches
12524 A list of switches to pass to @code{nntp-telnet-command}. The default
12531 @subsection News Spool
12535 Subscribing to a foreign group from the local spool is extremely easy,
12536 and might be useful, for instance, to speed up reading groups that
12537 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
12540 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
12541 anything else) as the address.
12543 If you have access to a local spool, you should probably use that as the
12544 native select method (@pxref{Finding the News}). It is normally faster
12545 than using an @code{nntp} select method, but might not be. It depends.
12546 You just have to try to find out what's best at your site.
12550 @item nnspool-inews-program
12551 @vindex nnspool-inews-program
12552 Program used to post an article.
12554 @item nnspool-inews-switches
12555 @vindex nnspool-inews-switches
12556 Parameters given to the inews program when posting an article.
12558 @item nnspool-spool-directory
12559 @vindex nnspool-spool-directory
12560 Where @code{nnspool} looks for the articles. This is normally
12561 @file{/usr/spool/news/}.
12563 @item nnspool-nov-directory
12564 @vindex nnspool-nov-directory
12565 Where @code{nnspool} will look for @sc{nov} files. This is normally
12566 @file{/usr/spool/news/over.view/}.
12568 @item nnspool-lib-dir
12569 @vindex nnspool-lib-dir
12570 Where the news lib dir is (@file{/usr/lib/news/} by default).
12572 @item nnspool-active-file
12573 @vindex nnspool-active-file
12574 The name of the active file.
12576 @item nnspool-newsgroups-file
12577 @vindex nnspool-newsgroups-file
12578 The name of the group descriptions file.
12580 @item nnspool-history-file
12581 @vindex nnspool-history-file
12582 The name of the news history file.
12584 @item nnspool-active-times-file
12585 @vindex nnspool-active-times-file
12586 The name of the active date file.
12588 @item nnspool-nov-is-evil
12589 @vindex nnspool-nov-is-evil
12590 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
12593 @item nnspool-sift-nov-with-sed
12594 @vindex nnspool-sift-nov-with-sed
12596 If non-@code{nil}, which is the default, use @code{sed} to get the
12597 relevant portion from the overview file. If nil, @code{nnspool} will
12598 load the entire file into a buffer and process it there.
12604 @section Getting Mail
12605 @cindex reading mail
12608 Reading mail with a newsreader---isn't that just plain WeIrD? But of
12612 * Mail in a Newsreader:: Important introductory notes.
12613 * Getting Started Reading Mail:: A simple cookbook example.
12614 * Splitting Mail:: How to create mail groups.
12615 * Mail Sources:: How to tell Gnus where to get mail from.
12616 * Mail Back End Variables:: Variables for customizing mail handling.
12617 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
12618 * Group Mail Splitting:: Use group customize to drive mail splitting.
12619 * Incorporating Old Mail:: What about the old mail you have?
12620 * Expiring Mail:: Getting rid of unwanted mail.
12621 * Washing Mail:: Removing gruft from the mail you get.
12622 * Duplicates:: Dealing with duplicated mail.
12623 * Not Reading Mail:: Using mail back ends for reading other files.
12624 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
12628 @node Mail in a Newsreader
12629 @subsection Mail in a Newsreader
12631 If you are used to traditional mail readers, but have decided to switch
12632 to reading mail with Gnus, you may find yourself experiencing something
12633 of a culture shock.
12635 Gnus does not behave like traditional mail readers. If you want to make
12636 it behave that way, you can, but it's an uphill battle.
12638 Gnus, by default, handles all its groups using the same approach. This
12639 approach is very newsreaderly---you enter a group, see the new/unread
12640 messages, and when you read the messages, they get marked as read, and
12641 you don't see them any more. (Unless you explicitly ask for them.)
12643 In particular, you do not do anything explicitly to delete messages.
12645 Does this mean that all the messages that have been marked as read are
12646 deleted? How awful!
12648 But, no, it means that old messages are @dfn{expired} according to some
12649 scheme or other. For news messages, the expire process is controlled by
12650 the news administrator; for mail, the expire process is controlled by
12651 you. The expire process for mail is covered in depth in @pxref{Expiring
12654 What many Gnus users find, after using it a while for both news and
12655 mail, is that the transport mechanism has very little to do with how
12656 they want to treat a message.
12658 Many people subscribe to several mailing lists. These are transported
12659 via @sc{smtp}, and are therefore mail. But we might go for weeks without
12660 answering, or even reading these messages very carefully. We may not
12661 need to save them because if we should need to read one again, they are
12662 archived somewhere else.
12664 Some people have local news groups which have only a handful of readers.
12665 These are transported via @sc{nntp}, and are therefore news. But we may need
12666 to read and answer a large fraction of the messages very carefully in
12667 order to do our work. And there may not be an archive, so we may need
12668 to save the interesting messages the same way we would personal mail.
12670 The important distinction turns out to be not the transport mechanism,
12671 but other factors such as how interested we are in the subject matter,
12672 or how easy it is to retrieve the message if we need to read it again.
12674 Gnus provides many options for sorting mail into ``groups'' which behave
12675 like newsgroups, and for treating each group (whether mail or news)
12678 Some users never get comfortable using the Gnus (ahem) paradigm and wish
12679 that Gnus should grow up and be a male, er, mail reader. It is possible
12680 to whip Gnus into a more mailreaderly being, but, as said before, it's
12681 not easy. People who prefer proper mail readers should try @sc{vm}
12682 instead, which is an excellent, and proper, mail reader.
12684 I don't mean to scare anybody off, but I want to make it clear that you
12685 may be required to learn a new way of thinking about messages. After
12686 you've been subjected to The Gnus Way, you will come to love it. I can
12687 guarantee it. (At least the guy who sold me the Emacs Subliminal
12688 Brain-Washing Functions that I've put into Gnus did guarantee it. You
12689 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
12693 @node Getting Started Reading Mail
12694 @subsection Getting Started Reading Mail
12696 It's quite easy to use Gnus to read your new mail. You just plonk the
12697 mail back end of your choice into @code{gnus-secondary-select-methods},
12698 and things will happen automatically.
12700 For instance, if you want to use @code{nnml} (which is a "one file per
12701 mail" back end), you could put the following in your @file{.gnus.el} file:
12704 (setq gnus-secondary-select-methods '((nnml "")))
12707 Now, the next time you start Gnus, this back end will be queried for new
12708 articles, and it will move all the messages in your spool file to its
12709 directory, which is @code{~/Mail/} by default. The new group that will
12710 be created (@samp{mail.misc}) will be subscribed, and you can read it
12711 like any other group.
12713 You will probably want to split the mail into several groups, though:
12716 (setq nnmail-split-methods
12717 '(("junk" "^From:.*Lars Ingebrigtsen")
12718 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
12722 This will result in three new @code{nnml} mail groups being created:
12723 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
12724 mail that doesn't fit into the first two groups will be placed in the
12727 This should be sufficient for reading mail with Gnus. You might want to
12728 give the other sections in this part of the manual a perusal, though.
12729 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
12732 @node Splitting Mail
12733 @subsection Splitting Mail
12734 @cindex splitting mail
12735 @cindex mail splitting
12737 @vindex nnmail-split-methods
12738 The @code{nnmail-split-methods} variable says how the incoming mail is
12739 to be split into groups.
12742 (setq nnmail-split-methods
12743 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
12744 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
12745 ("mail.other" "")))
12748 This variable is a list of lists, where the first element of each of
12749 these lists is the name of the mail group (they do not have to be called
12750 something beginning with @samp{mail}, by the way), and the second
12751 element is a regular expression used on the header of each mail to
12752 determine if it belongs in this mail group. The first string may
12753 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
12754 insert sub-expressions from the matched text. For instance:
12757 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
12760 The second element can also be a function. In that case, it will be
12761 called narrowed to the headers with the first element of the rule as the
12762 argument. It should return a non-@code{nil} value if it thinks that the
12763 mail belongs in that group.
12765 The last of these groups should always be a general one, and the regular
12766 expression should @emph{always} be @samp{} so that it matches any mails
12767 that haven't been matched by any of the other regexps. (These rules are
12768 processed from the beginning of the alist toward the end. The first
12769 rule to make a match will "win", unless you have crossposting enabled.
12770 In that case, all matching rules will "win".)
12772 If you like to tinker with this yourself, you can set this variable to a
12773 function of your choice. This function will be called without any
12774 arguments in a buffer narrowed to the headers of an incoming mail
12775 message. The function should return a list of group names that it
12776 thinks should carry this mail message.
12778 Note that the mail back ends are free to maul the poor, innocent,
12779 incoming headers all they want to. They all add @code{Lines} headers;
12780 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
12781 @code{From<SPACE>} line to something else.
12783 @vindex nnmail-crosspost
12784 The mail back ends all support cross-posting. If several regexps match,
12785 the mail will be ``cross-posted'' to all those groups.
12786 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
12787 that no articles are crossposted to the general (@samp{}) group.
12789 @vindex nnmail-crosspost-link-function
12792 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
12793 the crossposted articles. However, not all file systems support hard
12794 links. If that's the case for you, set
12795 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
12796 variable is @code{add-name-to-file} by default.)
12798 @kindex M-x nnmail-split-history
12799 @kindex nnmail-split-history
12800 If you wish to see where the previous mail split put the messages, you
12801 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
12802 where re-spooling messages would put the messages, you can use
12803 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
12806 @vindex nnmail-split-header-length-limit
12807 Header lines longer than the value of
12808 @code{nnmail-split-header-length-limit} are excluded from the split
12811 @vindex nnmail-mail-splitting-charset
12812 @vindex nnmail-mail-splitting-decodes
12813 By default the splitting codes MIME decodes headers so you can match
12814 on non-ASCII strings. The @code{nnmail-mail-splitting-charset}
12815 variable specifies the default charset for decoding. The behaviour
12816 can be turned off completely by binding
12817 @code{nnmail-mail-splitting-decodes} to nil, which is useful if you
12818 want to match articles based on the raw header data.
12820 @vindex nnmail-resplit-incoming
12821 By default, splitting is performed on all incoming messages. If
12822 you specify a @code{directory} entry for the variable
12823 @code{mail-sources} @pxref{Mail Source Specifiers}, however, then
12824 splitting does @emph{not} happen by default. You can set the variable
12825 @code{nnmail-resplit-incoming} to a non-nil value to make splitting
12826 happen even in this case. (This variable has no effect on other kinds
12829 Gnus gives you all the opportunity you could possibly want for shooting
12830 yourself in the foot. Let's say you create a group that will contain
12831 all the mail you get from your boss. And then you accidentally
12832 unsubscribe from the group. Gnus will still put all the mail from your
12833 boss in the unsubscribed group, and so, when your boss mails you ``Have
12834 that report ready by Monday or you're fired!'', you'll never see it and,
12835 come Tuesday, you'll still believe that you're gainfully employed while
12836 you really should be out collecting empty bottles to save up for next
12837 month's rent money.
12841 @subsection Mail Sources
12843 Mail can be gotten from many different sources---the mail spool, from a
12844 POP mail server, from a procmail directory, or from a maildir, for
12848 * Mail Source Specifiers:: How to specify what a mail source is.
12849 * Mail Source Customization:: Some variables that influence things.
12850 * Fetching Mail:: Using the mail source specifiers.
12854 @node Mail Source Specifiers
12855 @subsubsection Mail Source Specifiers
12857 @cindex mail server
12860 @cindex mail source
12862 You tell Gnus how to fetch mail by setting @code{mail-sources}
12863 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
12868 (pop :server "pop3.mailserver.com" :user "myname")
12871 As can be observed, a mail source specifier is a list where the first
12872 element is a @dfn{mail source type}, followed by an arbitrary number of
12873 @dfn{keywords}. Keywords that are not explicitly specified are given
12876 The following mail source types are available:
12880 Get mail from a single file; typically from the mail spool.
12886 The file name. Defaults to the value of the @code{MAIL}
12887 environment variable or the value of @code{rmail-spool-directory}
12888 (usually something like @file{/usr/mail/spool/user-name}).
12891 An example file mail source:
12894 (file :path "/usr/spool/mail/user-name")
12897 Or using the default file name:
12903 If the mail spool file is not located on the local machine, it's best to
12904 use POP or @sc{imap} or the like to fetch the mail. You can not use ange-ftp
12905 file names here---it has no way to lock the mail spool while moving the
12908 If it's impossible to set up a proper server, you can use ssh instead.
12912 '((file :prescript "ssh host bin/getmail >%t")))
12915 The @samp{getmail} script would look something like the following:
12919 # getmail - move mail from spool to stdout
12922 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
12924 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
12927 Alter this script to fit find the @samp{movemail} you want to use.
12931 @vindex nnmail-scan-directory-mail-source-once
12932 Get mail from several files in a directory. This is typically used when
12933 you have procmail split the incoming mail into several files. That is,
12934 there is a one-to-one correspondence between files in that directory and
12935 groups, so that mail from the file @file{foo.bar.spool} will be put in
12936 the group @code{foo.bar}. (You can change the suffix to be used instead
12937 of @code{.spool}.) Setting
12938 @code{nnmail-scan-directory-mail-source-once} to non-nil forces Gnus to
12939 scan the mail source only once. This is particularly useful if you want
12940 to scan mail groups at a specified level.
12942 @vindex nnmail-resplit-incoming
12943 There is also the variable @code{nnmail-resplit-incoming}, if you set
12944 that to a non-nil value, then the normal splitting process is applied
12945 to all the files from the directory, @ref{Splitting Mail}.
12951 The name of the directory where the files are. There is no default
12955 Only files ending with this suffix are used. The default is
12959 Only files that have this predicate return non-@code{nil} are returned.
12960 The default is @code{identity}. This is used as an additional
12961 filter---only files that have the right suffix @emph{and} satisfy this
12962 predicate are considered.
12966 Script run before/after fetching mail.
12970 An example directory mail source:
12973 (directory :path "/home/user-name/procmail-dir/"
12978 Get mail from a POP server.
12984 The name of the POP server. The default is taken from the
12985 @code{MAILHOST} environment variable.
12988 The port number of the POP server. This can be a number (eg,
12989 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
12990 string, it should be a service name as listed in @file{/etc/services} on
12991 Unix systems. The default is @samp{"pop3"}. On some systems you might
12992 need to specify it as @samp{"pop-3"} instead.
12995 The user name to give to the POP server. The default is the login
12999 The password to give to the POP server. If not specified, the user is
13003 The program to use to fetch mail from the POP server. This should be
13004 a @code{format}-like string. Here's an example:
13007 fetchmail %u@@%s -P %p %t
13010 The valid format specifier characters are:
13014 The name of the file the mail is to be moved to. This must always be
13015 included in this string.
13018 The name of the server.
13021 The port number of the server.
13024 The user name to use.
13027 The password to use.
13030 The values used for these specs are taken from the values you give the
13031 corresponding keywords.
13034 A script to be run before fetching the mail. The syntax is the same as
13035 the @code{:program} keyword. This can also be a function to be run.
13038 A script to be run after fetching the mail. The syntax is the same as
13039 the @code{:program} keyword. This can also be a function to be run.
13042 The function to use to fetch mail from the POP server. The function is
13043 called with one parameter---the name of the file where the mail should
13046 @item :authentication
13047 This can be either the symbol @code{password} or the symbol @code{apop}
13048 and says what authentication scheme to use. The default is
13053 If the @code{:program} and @code{:function} keywords aren't specified,
13054 @code{pop3-movemail} will be used.
13056 Here are some examples. Fetch from the default POP server, using the
13057 default user name, and default fetcher:
13063 Fetch from a named server with a named user and password:
13066 (pop :server "my.pop.server"
13067 :user "user-name" :password "secret")
13070 Use @samp{movemail} to move the mail:
13073 (pop :program "movemail po:%u %t %p")
13077 Get mail from a maildir. This is a type of mailbox that is supported by
13078 at least qmail and postfix, where each file in a special directory
13079 contains exactly one mail.
13085 The name of the directory where the mails are stored. The default is
13086 taken from the @code{MAILDIR} environment variable or
13089 The subdirectories of the Maildir. The default is
13090 @samp{("new" "cur")}.
13092 @c If you sometimes look at your mail through a pop3 daemon before fetching
13093 @c them with Gnus, you may also have to fetch your mails from the
13094 @c @code{cur} directory inside the maildir, like in the first example
13097 You can also get mails from remote hosts (because maildirs don't suffer
13098 from locking problems).
13102 Two example maildir mail sources:
13105 (maildir :path "/home/user-name/Maildir/"
13106 :subdirs ("cur" "new"))
13110 (maildir :path "/user@@remotehost.org:~/Maildir/"
13115 Get mail from a @sc{imap} server. If you don't want to use @sc{imap}
13116 as intended, as a network mail reading protocol (ie with nnimap), for
13117 some reason or other, Gnus let you treat it similar to a POP server
13118 and fetches articles from a given @sc{imap} mailbox. @xref{IMAP}, for
13121 Note that for the Kerberos, GSSAPI, SSL/TLS and STARTTLS support you
13122 may need external programs and libraries, @xref{IMAP}.
13128 The name of the @sc{imap} server. The default is taken from the
13129 @code{MAILHOST} environment variable.
13132 The port number of the @sc{imap} server. The default is @samp{143}, or
13133 @samp{993} for SSL/TLS connections.
13136 The user name to give to the @sc{imap} server. The default is the login
13140 The password to give to the @sc{imap} server. If not specified, the user is
13144 What stream to use for connecting to the server, this is one of the
13145 symbols in @code{imap-stream-alist}. Right now, this means
13146 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{ssl},
13147 @samp{shell} or the default @samp{network}.
13149 @item :authentication
13150 Which authenticator to use for authenticating to the server, this is
13151 one of the symbols in @code{imap-authenticator-alist}. Right now,
13152 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
13153 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
13156 When using the `shell' :stream, the contents of this variable is
13157 mapped into the `imap-shell-program' variable. This should be a
13158 @code{format}-like string (or list of strings). Here's an example:
13164 The valid format specifier characters are:
13168 The name of the server.
13171 User name from `imap-default-user'.
13174 The port number of the server.
13177 The values used for these specs are taken from the values you give the
13178 corresponding keywords.
13181 The name of the mailbox to get mail from. The default is @samp{INBOX}
13182 which normally is the mailbox which receive incoming mail.
13185 The predicate used to find articles to fetch. The default, @samp{UNSEEN
13186 UNDELETED}, is probably the best choice for most people, but if you
13187 sometimes peek in your mailbox with a @sc{imap} client and mark some
13188 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
13189 Then all articles in the mailbox is fetched, no matter what. For a
13190 complete list of predicates, see RFC 2060 section 6.4.4.
13193 How to flag fetched articles on the server, the default @samp{\Deleted}
13194 will mark them as deleted, an alternative would be @samp{\Seen} which
13195 would simply mark them as read. These are the two most likely choices,
13196 but more flags are defined in RFC 2060 section 2.3.2.
13199 If non-nil, don't remove all articles marked as deleted in the mailbox
13200 after finishing the fetch.
13204 An example @sc{imap} mail source:
13207 (imap :server "mail.mycorp.com"
13209 :fetchflag "\\Seen")
13213 Get mail from a webmail server, such as @uref{www.hotmail.com},
13214 @uref{webmail.netscape.com}, @uref{www.netaddress.com},
13215 @uref{mail.yahoo..com}.
13217 NOTE: Webmail largely depends cookies. A "one-line-cookie" patch is
13218 required for url "4.0pre.46".
13220 WARNING: Mails may be lost. NO WARRANTY.
13226 The type of the webmail server. The default is @code{hotmail}. The
13227 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
13230 The user name to give to the webmail server. The default is the login
13234 The password to give to the webmail server. If not specified, the user is
13238 If non-nil, only fetch unread articles and don't move them to trash
13239 folder after finishing the fetch.
13243 An example webmail source:
13246 (webmail :subtype 'hotmail
13248 :password "secret")
13253 @item Common Keywords
13254 Common keywords can be used in any type of mail source.
13260 If non-nil, fetch the mail even when Gnus is unplugged. If you use
13261 directory source to get mail, you can specify it as in this example:
13265 '((directory :path "/home/pavel/.Spool/"
13270 Gnus will then fetch your mail even when you are unplugged. This is
13271 useful when you use local mail and news.
13276 @subsubsection Function Interface
13278 Some of the above keywords specify a Lisp function to be executed.
13279 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
13280 the value of the keyword while the function is executing. For example,
13281 consider the following mail-source setting:
13284 (setq mail-sources '((pop :user "jrl"
13285 :server "pophost" :function fetchfunc)))
13288 While the function @code{fetchfunc} is executing, the symbol @code{user}
13289 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
13290 @code{"pophost"}. The symbols @code{port}, @code{password},
13291 @code{program}, @code{prescript}, @code{postscript}, @code{function},
13292 and @code{authentication} are also bound (to their default values).
13294 See above for a list of keywords for each type of mail source.
13297 @node Mail Source Customization
13298 @subsubsection Mail Source Customization
13300 The following is a list of variables that influence how the mail is
13301 fetched. You would normally not need to set or change any of these
13305 @item mail-source-crash-box
13306 @vindex mail-source-crash-box
13307 File where mail will be stored while processing it. The default is
13308 @file{~/.emacs-mail-crash-box}.
13310 @item mail-source-delete-incoming
13311 @vindex mail-source-delete-incoming
13312 If non-@code{nil}, delete incoming files after handling them.
13314 @item mail-source-ignore-errors
13315 @vindex mail-source-ignore-errors
13316 If non-@code{nil}, ignore errors when reading mail from a mail source.
13318 @item mail-source-directory
13319 @vindex mail-source-directory
13320 Directory where files (if any) will be stored. The default is
13321 @file{~/Mail/}. At present, the only thing this is used for is to say
13322 where the incoming files will be stored if the previous variable is
13325 @item mail-source-incoming-file-prefix
13326 @vindex mail-source-incoming-file-prefix
13327 Prefix for file name for storing incoming mail. The default is
13328 @file{Incoming}, in which case files will end up with names like
13329 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
13330 relevant if @code{mail-source-delete-incoming} is @code{nil}.
13332 @item mail-source-default-file-modes
13333 @vindex mail-source-default-file-modes
13334 All new mail files will get this file mode. The default is 384.
13336 @item mail-source-movemail-program
13337 @vindex mail-source-movemail-program
13338 If non-nil, name of program for fetching new mail. If nil,
13339 @code{movemail} in @var{exec-directory}.
13344 @node Fetching Mail
13345 @subsubsection Fetching Mail
13347 @vindex mail-sources
13348 @vindex nnmail-spool-file
13349 The way to actually tell Gnus where to get new mail from is to set
13350 @code{mail-sources} to a list of mail source specifiers
13351 (@pxref{Mail Source Specifiers}).
13353 If this variable (and the obsolescent @code{nnmail-spool-file}) is
13354 @code{nil}, the mail back ends will never attempt to fetch mail by
13357 If you want to fetch mail both from your local spool as well as a POP
13358 mail server, you'd say something like:
13363 (pop :server "pop3.mail.server"
13364 :password "secret")))
13367 Or, if you don't want to use any of the keyword defaults:
13371 '((file :path "/var/spool/mail/user-name")
13372 (pop :server "pop3.mail.server"
13375 :password "secret")))
13379 When you use a mail back end, Gnus will slurp all your mail from your
13380 inbox and plonk it down in your home directory. Gnus doesn't move any
13381 mail if you're not using a mail back end---you have to do a lot of magic
13382 invocations first. At the time when you have finished drawing the
13383 pentagram, lightened the candles, and sacrificed the goat, you really
13384 shouldn't be too surprised when Gnus moves your mail.
13388 @node Mail Back End Variables
13389 @subsection Mail Back End Variables
13391 These variables are (for the most part) pertinent to all the various
13395 @vindex nnmail-read-incoming-hook
13396 @item nnmail-read-incoming-hook
13397 The mail back ends all call this hook after reading new mail. You can
13398 use this hook to notify any mail watch programs, if you want to.
13400 @vindex nnmail-split-hook
13401 @item nnmail-split-hook
13402 @findex gnus-article-decode-encoded-words
13403 @findex RFC 1522 decoding
13404 @findex RFC 2047 decoding
13405 Hook run in the buffer where the mail headers of each message is kept
13406 just before the splitting based on these headers is done. The hook is
13407 free to modify the buffer contents in any way it sees fit---the buffer
13408 is discarded after the splitting has been done, and no changes performed
13409 in the buffer will show up in any files.
13410 @code{gnus-article-decode-encoded-words} is one likely function to add
13413 @vindex nnmail-pre-get-new-mail-hook
13414 @vindex nnmail-post-get-new-mail-hook
13415 @item nnmail-pre-get-new-mail-hook
13416 @itemx nnmail-post-get-new-mail-hook
13417 These are two useful hooks executed when treating new incoming
13418 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
13419 starting to handle the new mail) and
13420 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
13421 is done). Here's and example of using these two hooks to change the
13422 default file modes the new mail files get:
13425 (add-hook 'nnmail-pre-get-new-mail-hook
13426 (lambda () (set-default-file-modes 511)))
13428 (add-hook 'nnmail-post-get-new-mail-hook
13429 (lambda () (set-default-file-modes 551)))
13432 @item nnmail-use-long-file-names
13433 @vindex nnmail-use-long-file-names
13434 If non-@code{nil}, the mail back ends will use long file and directory
13435 names. Groups like @samp{mail.misc} will end up in directories
13436 (assuming use of @code{nnml} back end) or files (assuming use of
13437 @code{nnfolder} back end) like @file{mail.misc}. If it is @code{nil},
13438 the same group will end up in @file{mail/misc}.
13440 @item nnmail-delete-file-function
13441 @vindex nnmail-delete-file-function
13442 @findex delete-file
13443 Function called to delete files. It is @code{delete-file} by default.
13445 @item nnmail-cache-accepted-message-ids
13446 @vindex nnmail-cache-accepted-message-ids
13447 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
13448 the back end (via @code{Gcc}, for instance) into the mail duplication
13449 discovery cache. The default is @code{nil}.
13451 @item nnmail-cache-ignore-groups
13452 @vindex nnmail-cache-ignore-groups
13453 This can be a regular expression or a list of regular expressions.
13454 Group names that match any of the regular expressions will never be
13455 recorded in the @code{Message-ID} cache.
13457 This can be useful, for example, when using Fancy Splitting
13458 (@pxref{Fancy Mail Splitting}) together with the function
13459 @code{nnmail-split-fancy-with-parent}.
13464 @node Fancy Mail Splitting
13465 @subsection Fancy Mail Splitting
13466 @cindex mail splitting
13467 @cindex fancy mail splitting
13469 @vindex nnmail-split-fancy
13470 @findex nnmail-split-fancy
13471 If the rather simple, standard method for specifying how to split mail
13472 doesn't allow you to do what you want, you can set
13473 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
13474 play with the @code{nnmail-split-fancy} variable.
13476 Let's look at an example value of this variable first:
13479 ;; Messages from the mailer daemon are not crossposted to any of
13480 ;; the ordinary groups. Warnings are put in a separate group
13481 ;; from real errors.
13482 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
13484 ;; Non-error messages are crossposted to all relevant
13485 ;; groups, but we don't crosspost between the group for the
13486 ;; (ding) list and the group for other (ding) related mail.
13487 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
13488 ("subject" "ding" "ding.misc"))
13489 ;; Other mailing lists...
13490 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
13491 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
13492 ;; Both lists below have the same suffix, so prevent
13493 ;; cross-posting to mkpkg.list of messages posted only to
13494 ;; the bugs- list, but allow cross-posting when the
13495 ;; message was really cross-posted.
13496 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
13497 (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
13499 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
13500 ;; Unmatched mail goes to the catch all group.
13504 This variable has the format of a @dfn{split}. A split is a (possibly)
13505 recursive structure where each split may contain other splits. Here are
13506 the five possible split syntaxes:
13511 @samp{group}: If the split is a string, that will be taken as a group
13512 name. Normal regexp match expansion will be done. See below for
13516 @code{(@var{field} @var{value} @code{[-} @var{restrict}
13517 @code{[@dots{}]}@code{]} @var{split})}: If the split is a list, the
13518 first element of which is a string, then store the message as
13519 specified by @var{split}, if header @var{field} (a regexp) contains
13520 @var{value} (also a regexp). If @var{restrict} (yet another regexp)
13521 matches some string after @var{field} and before the end of the
13522 matched @var{value}, the @var{split} is ignored. If none of the
13523 @var{restrict} clauses match, @var{split} is processed.
13526 @code{(| @var{split}@dots{})}: If the split is a list, and the first
13527 element is @code{|} (vertical bar), then process each @var{split} until
13528 one of them matches. A @var{split} is said to match if it will cause
13529 the mail message to be stored in one or more groups.
13532 @code{(& @var{split}@dots{})}: If the split is a list, and the first
13533 element is @code{&}, then process all @var{split}s in the list.
13536 @code{junk}: If the split is the symbol @code{junk}, then don't save
13537 (i.e., delete) this message. Use with extreme caution.
13540 @code{(: @var{function} @var{arg1} @var{arg2} @dots{})}: If the split is
13541 a list, and the first element is @code{:}, then the second element will
13542 be called as a function with @var{args} given as arguments. The
13543 function should return a @var{split}.
13546 For instance, the following function could be used to split based on the
13547 body of the messages:
13550 (defun split-on-body ()
13552 (set-buffer " *nnmail incoming*")
13553 (goto-char (point-min))
13554 (when (re-search-forward "Some.*string" nil t)
13558 The @samp{" *nnmail incoming*"} is narrowed to the message in question
13559 when the @code{:} function is run.
13562 @code{(! @var{func} @var{split})}: If the split is a list, and the first
13563 element is @code{!}, then SPLIT will be processed, and FUNC will be
13564 called as a function with the result of SPLIT as argument. FUNC should
13568 @code{nil}: If the split is @code{nil}, it is ignored.
13572 In these splits, @var{field} must match a complete field name.
13573 @var{value} must match a complete word according to the fundamental mode
13574 syntax table. You can use @code{.*} in the regexps to match partial
13575 field names or words. In other words, all @var{value}'s are wrapped in
13576 @samp{\<} and @samp{\>} pairs.
13578 @vindex nnmail-split-abbrev-alist
13579 @var{field} and @var{value} can also be lisp symbols, in that case they
13580 are expanded as specified by the variable
13581 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
13582 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
13585 @vindex nnmail-split-fancy-syntax-table
13586 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
13587 when all this splitting is performed.
13589 If you want to have Gnus create groups dynamically based on some
13590 information in the headers (i.e., do @code{replace-match}-like
13591 substitutions in the group names), you can say things like:
13594 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
13597 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
13598 will be filed in @samp{mail.debian.foo}.
13600 If the string contains the element @samp{\&}, then the previously
13601 matched string will be substituted. Similarly, the elements @samp{\\1}
13602 up to @samp{\\9} will be substituted with the text matched by the
13603 groupings 1 through 9.
13605 @findex nnmail-split-fancy-with-parent
13606 @code{nnmail-split-fancy-with-parent} is a function which allows you to
13607 split followups into the same groups their parents are in. Sometimes
13608 you can't make splitting rules for all your mail. For example, your
13609 boss might send you personal mail regarding different projects you are
13610 working on, and as you can't tell your boss to put a distinguishing
13611 string into the subject line, you have to resort to manually moving the
13612 messages into the right group. With this function, you only have to do
13613 it once per thread.
13615 To use this feature, you have to set @code{nnmail-treat-duplicates} and
13616 @code{nnmail-cache-accepted-message-ids} to a non-nil value. And then
13617 you can include @code{nnmail-split-fancy-with-parent} using the colon
13620 (setq nnmail-treat-duplicates 'warn ; or 'delete
13621 nnmail-cache-accepted-message-ids t
13623 '(| (: nnmail-split-fancy-with-parent)
13624 ;; other splits go here
13628 This feature works as follows: when @code{nnmail-treat-duplicates} is
13629 non-nil, Gnus records the message id of every message it sees in the
13630 file specified by the variable @code{nnmail-message-id-cache-file},
13631 together with the group it is in (the group is omitted for non-mail
13632 messages). When mail splitting is invoked, the function
13633 @code{nnmail-split-fancy-with-parent} then looks at the References (and
13634 In-Reply-To) header of each message to split and searches the file
13635 specified by @code{nnmail-message-id-cache-file} for the message ids.
13636 When it has found a parent, it returns the corresponding group name
13637 unless the group name matches the regexp
13638 @code{nnmail-split-fancy-with-parent-ignore-groups}. It is recommended
13639 that you set @code{nnmail-message-id-cache-length} to a somewhat higher
13640 number than the default so that the message ids are still in the cache.
13641 (A value of 5000 appears to create a file some 300 kBytes in size.)
13642 @vindex nnmail-cache-accepted-message-ids
13643 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
13644 also records the message ids of moved articles, so that the followup
13645 messages goes into the new group.
13647 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
13648 want certain groups to be recorded in the cache. For example, if all
13649 outgoing messages are written to an `outgoing' group, you could set
13650 @code{nnmail-cache-ignore-groups} to match that group name.
13651 Otherwise, answers to all your messages would end up in the
13655 @node Group Mail Splitting
13656 @subsection Group Mail Splitting
13657 @cindex mail splitting
13658 @cindex group mail splitting
13660 @findex gnus-group-split
13661 If you subscribe to dozens of mailing lists but you don't want to
13662 maintain mail splitting rules manually, group mail splitting is for you.
13663 You just have to set @var{to-list} and/or @var{to-address} in group
13664 parameters or group customization and set @code{nnmail-split-methods} to
13665 @code{gnus-group-split}. This splitting function will scan all groups
13666 for those parameters and split mail accordingly, i.e., messages posted
13667 from or to the addresses specified in the parameters @var{to-list} or
13668 @var{to-address} of a mail group will be stored in that group.
13670 Sometimes, mailing lists have multiple addresses, and you may want mail
13671 splitting to recognize them all: just set the @var{extra-aliases} group
13672 parameter to the list of additional addresses and it's done. If you'd
13673 rather use a regular expression, set @var{split-regexp}.
13675 All these parameters in a group will be used to create an
13676 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
13677 the @var{value} is a single regular expression that matches
13678 @var{to-list}, @var{to-address}, all of @var{extra-aliases} and all
13679 matches of @var{split-regexp}, and the @var{split} is the name of the
13680 group. @var{restrict}s are also supported: just set the
13681 @var{split-exclude} parameter to a list of regular expressions.
13683 If you can't get the right split to be generated using all these
13684 parameters, or you just need something fancier, you can set the
13685 parameter @var{split-spec} to an @code{nnmail-split-fancy} split. In
13686 this case, all other aforementioned parameters will be ignored by
13687 @code{gnus-group-split}. In particular, @var{split-spec} may be set to
13688 @code{nil}, in which case the group will be ignored by
13689 @code{gnus-group-split}.
13691 @vindex gnus-group-split-default-catch-all-group
13692 @code{gnus-group-split} will do cross-posting on all groups that match,
13693 by defining a single @code{&} fancy split containing one split for each
13694 group. If a message doesn't match any split, it will be stored in the
13695 group named in @code{gnus-group-split-default-catch-all-group}, unless
13696 some group has @var{split-spec} set to @code{catch-all}, in which case
13697 that group is used as the catch-all group. Even though this variable is
13698 often used just to name a group, it may also be set to an arbitrarily
13699 complex fancy split (after all, a group name is a fancy split), and this
13700 may be useful to split mail that doesn't go to any mailing list to
13701 personal mail folders. Note that this fancy split is added as the last
13702 element of a @code{|} split list that also contains a @code{&} split
13703 with the rules extracted from group parameters.
13705 It's time for an example. Assume the following group parameters have
13710 ((to-address . "bar@@femail.com")
13711 (split-regexp . ".*@@femail\\.com"))
13713 ((to-list . "foo@@nowhere.gov")
13714 (extra-aliases "foo@@localhost" "foo-redist@@home")
13715 (split-exclude "bugs-foo" "rambling-foo")
13716 (admin-address . "foo-request@@nowhere.gov"))
13718 ((split-spec . catch-all))
13721 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
13722 behave as if @code{nnmail-split-fancy} had been selected and variable
13723 @code{nnmail-split-fancy} had been set as follows:
13726 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
13727 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
13728 - "bugs-foo" - "rambling-foo" "mail.foo"))
13732 @findex gnus-group-split-fancy
13733 If you'd rather not use group splitting for all your mail groups, you
13734 may use it for only some of them, by using @code{nnmail-split-fancy}
13738 (: gnus-group-split-fancy GROUPS NO-CROSSPOST CATCH-ALL)
13741 @var{groups} may be a regular expression or a list of group names whose
13742 parameters will be scanned to generate the output split.
13743 @var{no-crosspost} can be used to disable cross-posting; in this case, a
13744 single @code{|} split will be output. @var{catch-all} is the fallback
13745 fancy split, used like @var{gnus-group-split-default-catch-all-group}.
13746 If @var{catch-all} is @code{nil}, or if @var{split-regexp} matches the
13747 empty string in any selected group, no catch-all split will be issued.
13748 Otherwise, if some group has @var{split-spec} set to @code{catch-all},
13749 this group will override the value of the @var{catch-all} argument.
13751 @findex gnus-group-split-setup
13752 Unfortunately, scanning all groups and their parameters can be quite
13753 slow, especially considering that it has to be done for every message.
13754 But don't despair! The function @code{gnus-group-split-setup} can be
13755 used to enable @code{gnus-group-split} in a much more efficient way. It
13756 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
13757 @code{nnmail-split-fancy} to the split produced by
13758 @code{gnus-group-split-fancy}. Thus, the group parameters are only
13759 scanned once, no matter how many messages are split.
13761 @findex gnus-group-split-update
13762 However, if you change group parameters, you'd have to update
13763 @code{nnmail-split-fancy} manually. You can do it by running
13764 @code{gnus-group-split-update}. If you'd rather have it updated
13765 automatically, just tell @code{gnus-group-split-setup} to do it for
13766 you. For example, add to your @file{.gnus.el}:
13769 (gnus-group-split-setup AUTO-UPDATE CATCH-ALL)
13772 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
13773 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
13774 have to worry about updating @code{nnmail-split-fancy} again. If you
13775 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
13776 @code{gnus-group-split-default-catch-all-group} will be set to its
13779 @vindex gnus-group-split-updated-hook
13780 Because you may want to change @code{nnmail-split-fancy} after it is set
13781 by @code{gnus-group-split-update}, this function will run
13782 @code{gnus-group-split-updated-hook} just before finishing.
13784 @node Incorporating Old Mail
13785 @subsection Incorporating Old Mail
13786 @cindex incorporating old mail
13787 @cindex import old mail
13789 Most people have lots of old mail stored in various file formats. If
13790 you have set up Gnus to read mail using one of the spiffy Gnus mail
13791 back ends, you'll probably wish to have that old mail incorporated into
13794 Doing so can be quite easy.
13796 To take an example: You're reading mail using @code{nnml}
13797 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
13798 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
13799 file filled with important, but old, mail. You want to move it into
13800 your @code{nnml} groups.
13806 Go to the group buffer.
13809 Type @kbd{G f} and give the file name to the mbox file when prompted to create an
13810 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
13813 Type @kbd{SPACE} to enter the newly created group.
13816 Type @kbd{M P b} to process-mark all articles in this group's buffer
13817 (@pxref{Setting Process Marks}).
13820 Type @kbd{B r} to respool all the process-marked articles, and answer
13821 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
13824 All the mail messages in the mbox file will now also be spread out over
13825 all your @code{nnml} groups. Try entering them and check whether things
13826 have gone without a glitch. If things look ok, you may consider
13827 deleting the mbox file, but I wouldn't do that unless I was absolutely
13828 sure that all the mail has ended up where it should be.
13830 Respooling is also a handy thing to do if you're switching from one mail
13831 back end to another. Just respool all the mail in the old mail groups
13832 using the new mail back end.
13835 @node Expiring Mail
13836 @subsection Expiring Mail
13837 @cindex article expiry
13839 Traditional mail readers have a tendency to remove mail articles when
13840 you mark them as read, in some way. Gnus takes a fundamentally
13841 different approach to mail reading.
13843 Gnus basically considers mail just to be news that has been received in
13844 a rather peculiar manner. It does not think that it has the power to
13845 actually change the mail, or delete any mail messages. If you enter a
13846 mail group, and mark articles as ``read'', or kill them in some other
13847 fashion, the mail articles will still exist on the system. I repeat:
13848 Gnus will not delete your old, read mail. Unless you ask it to, of
13851 To make Gnus get rid of your unwanted mail, you have to mark the
13852 articles as @dfn{expirable}. (With the default keybindings, this means
13853 that you have to type @kbd{E}.) This does not mean that the articles
13854 will disappear right away, however. In general, a mail article will be
13855 deleted from your system if, 1) it is marked as expirable, AND 2) it is
13856 more than one week old. If you do not mark an article as expirable, it
13857 will remain on your system until hell freezes over. This bears
13858 repeating one more time, with some spurious capitalizations: IF you do
13859 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
13861 You do not have to mark articles as expirable by hand. Gnus provides
13862 two features, called `auto-expire' and `total-expire', that can help you
13863 with this. In a nutshell, `auto-expire' means that Gnus hits @kbd{E}
13864 for you when you select an article. And `total-expire' means that Gnus
13865 considers all articles as expirable that are read. So, in addition to
13866 the articles marked @samp{E}, also the articles marked @samp{r},
13867 @samp{R}, @samp{O}, @samp{K}, @samp{Y} and so on are considered
13870 When should either auto-expire or total-expire be used? Most people
13871 who are subscribed to mailing lists split each list into its own group
13872 and then turn on auto-expire or total-expire for those groups.
13873 (@xref{Splitting Mail}, for more information on splitting each list
13874 into its own group.)
13876 Which one is better, auto-expire or total-expire? It's not easy to
13877 answer. Generally speaking, auto-expire is probably faster. Another
13878 advantage of auto-expire is that you get more marks to work with: for
13879 the articles that are supposed to stick around, you can still choose
13880 between tick and dormant and read marks. But with total-expire, you
13881 only have dormant and ticked to choose from. The advantage of
13882 total-expire is that it works well with adaptive scoring @pxref{Adaptive
13883 Scoring}. Auto-expire works with normal scoring but not with adaptive
13886 @vindex gnus-auto-expirable-newsgroups
13887 Groups that match the regular expression
13888 @code{gnus-auto-expirable-newsgroups} will have all articles that you
13889 read marked as expirable automatically. All articles marked as
13890 expirable have an @samp{E} in the first column in the summary buffer.
13892 By default, if you have auto expiry switched on, Gnus will mark all the
13893 articles you read as expirable, no matter if they were read or unread
13894 before. To avoid having articles marked as read marked as expirable
13895 automatically, you can put something like the following in your
13896 @file{.gnus.el} file:
13898 @vindex gnus-mark-article-hook
13900 (remove-hook 'gnus-mark-article-hook
13901 'gnus-summary-mark-read-and-unread-as-read)
13902 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
13905 Note that making a group auto-expirable doesn't mean that all read
13906 articles are expired---only the articles marked as expirable
13907 will be expired. Also note that using the @kbd{d} command won't make
13908 articles expirable---only semi-automatic marking of articles as read will
13909 mark the articles as expirable in auto-expirable groups.
13911 Let's say you subscribe to a couple of mailing lists, and you want the
13912 articles you have read to disappear after a while:
13915 (setq gnus-auto-expirable-newsgroups
13916 "mail.nonsense-list\\|mail.nice-list")
13919 Another way to have auto-expiry happen is to have the element
13920 @code{auto-expire} in the group parameters of the group.
13922 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
13923 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
13924 don't really mix very well.
13926 @vindex nnmail-expiry-wait
13927 The @code{nnmail-expiry-wait} variable supplies the default time an
13928 expirable article has to live. Gnus starts counting days from when the
13929 message @emph{arrived}, not from when it was sent. The default is seven
13932 Gnus also supplies a function that lets you fine-tune how long articles
13933 are to live, based on what group they are in. Let's say you want to
13934 have one month expiry period in the @samp{mail.private} group, a one day
13935 expiry period in the @samp{mail.junk} group, and a six day expiry period
13938 @vindex nnmail-expiry-wait-function
13940 (setq nnmail-expiry-wait-function
13942 (cond ((string= group "mail.private")
13944 ((string= group "mail.junk")
13946 ((string= group "important")
13952 The group names this function is fed are ``unadorned'' group
13953 names---no @samp{nnml:} prefixes and the like.
13955 The @code{nnmail-expiry-wait} variable and
13956 @code{nnmail-expiry-wait-function} function can either be a number (not
13957 necessarily an integer) or one of the symbols @code{immediate} or
13960 You can also use the @code{expiry-wait} group parameter to selectively
13961 change the expiry period (@pxref{Group Parameters}).
13963 @vindex nnmail-expiry-target
13964 The normal action taken when expiring articles is to delete them.
13965 However, in some circumstances it might make more sense to move them
13966 to other groups instead of deleting them. The variable
13967 @code{nnmail-expiry-target} (and the @code{expiry-target} group
13968 parameter) controls this. The variable supplies a default value for
13969 all groups, which can be overridden for specific groups by the group
13970 parameter. default value is @code{delete}, but this can also be a
13971 string (which should be the name of the group the message should be
13972 moved to), or a function (which will be called in a buffer narrowed to
13973 the message in question, and with the name of the group being moved
13974 from as its parameter) which should return a target -- either a group
13975 name or @code{delete}.
13977 Here's an example for specifying a group name:
13979 (setq nnmail-expiry-target "nnml:expired")
13982 @findex nnmail-fancy-expiry-target
13983 @vindex nnmail-fancy-expiry-targets
13984 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
13985 expire mail to groups according to the variable
13986 @code{nnmail-fancy-expiry-targets}. Here's an example:
13989 (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
13990 nnmail-fancy-expiry-targets
13991 '((to-from "boss" "nnfolder:Work")
13992 ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
13993 ("from" ".*" "nnfolder:Archive-%Y")))
13996 With this setup, any mail that has @code{IMPORTANT} in its Subject
13997 header and was sent in the year @code{YYYY} and month @code{MMM}, will
13998 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
13999 From or To header contains the string @code{boss}, it will get expired
14000 to @code{nnfolder:Work}. All other mail will get expired to
14001 @code{nnfolder:Archive-YYYY}.
14003 @vindex nnmail-keep-last-article
14004 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
14005 expire the final article in a mail newsgroup. This is to make life
14006 easier for procmail users.
14008 @vindex gnus-total-expirable-newsgroups
14009 By the way: That line up there, about Gnus never expiring non-expirable
14010 articles, is a lie. If you put @code{total-expire} in the group
14011 parameters, articles will not be marked as expirable, but all read
14012 articles will be put through the expiry process. Use with extreme
14013 caution. Even more dangerous is the
14014 @code{gnus-total-expirable-newsgroups} variable. All groups that match
14015 this regexp will have all read articles put through the expiry process,
14016 which means that @emph{all} old mail articles in the groups in question
14017 will be deleted after a while. Use with extreme caution, and don't come
14018 crying to me when you discover that the regexp you used matched the
14019 wrong group and all your important mail has disappeared. Be a
14020 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
14023 Most people make most of their mail groups total-expirable, though.
14025 @vindex gnus-inhibit-user-auto-expire
14026 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
14027 commands will not mark an article as expirable, even if the group has
14028 auto-expire turned on.
14032 @subsection Washing Mail
14033 @cindex mail washing
14034 @cindex list server brain damage
14035 @cindex incoming mail treatment
14037 Mailers and list servers are notorious for doing all sorts of really,
14038 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
14039 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
14040 end of all lines passing through our server, so let's do that!!!!1!''
14041 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
14042 considered to be self-evident were not discussed. So. Here we are.
14044 Case in point: The German version of Microsoft Exchange adds @samp{AW:
14045 } to the subjects of replies instead of @samp{Re: }. I could pretend to
14046 be shocked and dismayed by this, but I haven't got the energy. It is to
14049 Gnus provides a plethora of functions for washing articles while
14050 displaying them, but it might be nicer to do the filtering before
14051 storing the mail to disk. For that purpose, we have three hooks and
14052 various functions that can be put in these hooks.
14055 @item nnmail-prepare-incoming-hook
14056 @vindex nnmail-prepare-incoming-hook
14057 This hook is called before doing anything with the mail and is meant for
14058 grand, sweeping gestures. It is called in a buffer that contains all
14059 the new, incoming mail. Functions to be used include:
14062 @item nnheader-ms-strip-cr
14063 @findex nnheader-ms-strip-cr
14064 Remove trailing carriage returns from each line. This is default on
14065 Emacs running on MS machines.
14069 @item nnmail-prepare-incoming-header-hook
14070 @vindex nnmail-prepare-incoming-header-hook
14071 This hook is called narrowed to each header. It can be used when
14072 cleaning up the headers. Functions that can be used include:
14075 @item nnmail-remove-leading-whitespace
14076 @findex nnmail-remove-leading-whitespace
14077 Clear leading white space that ``helpful'' listservs have added to the
14078 headers to make them look nice. Aaah.
14080 (Note that this function works on both the header on the body of all
14081 messages, so it is a potentially dangerous function to use (if a body
14082 of a message contains something that looks like a header line). So
14083 rather than fix the bug, it is of course the right solution to make it
14084 into a feature by documenting it.)
14086 @item nnmail-remove-list-identifiers
14087 @findex nnmail-remove-list-identifiers
14088 Some list servers add an identifier---for example, @samp{(idm)}---to the
14089 beginning of all @code{Subject} headers. I'm sure that's nice for
14090 people who use stone age mail readers. This function will remove
14091 strings that match the @code{nnmail-list-identifiers} regexp, which can
14092 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
14095 For instance, if you want to remove the @samp{(idm)} and the
14096 @samp{nagnagnag} identifiers:
14099 (setq nnmail-list-identifiers
14100 '("(idm)" "nagnagnag"))
14103 This can also be done non-destructively with
14104 @code{gnus-list-identifiers}, @xref{Article Hiding}.
14106 @item nnmail-remove-tabs
14107 @findex nnmail-remove-tabs
14108 Translate all @samp{TAB} characters into @samp{SPACE} characters.
14110 @item nnmail-fix-eudora-headers
14111 @findex nnmail-fix-eudora-headers
14113 Eudora produces broken @code{References} headers, but OK
14114 @code{In-Reply-To} headers. This function will get rid of the
14115 @code{References} headers.
14119 @item nnmail-prepare-incoming-message-hook
14120 @vindex nnmail-prepare-incoming-message-hook
14121 This hook is called narrowed to each message. Functions to be used
14125 @item article-de-quoted-unreadable
14126 @findex article-de-quoted-unreadable
14127 Decode Quoted Readable encoding.
14134 @subsection Duplicates
14136 @vindex nnmail-treat-duplicates
14137 @vindex nnmail-message-id-cache-length
14138 @vindex nnmail-message-id-cache-file
14139 @cindex duplicate mails
14140 If you are a member of a couple of mailing lists, you will sometimes
14141 receive two copies of the same mail. This can be quite annoying, so
14142 @code{nnmail} checks for and treats any duplicates it might find. To do
14143 this, it keeps a cache of old @code{Message-ID}s---
14144 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
14145 default. The approximate maximum number of @code{Message-ID}s stored
14146 there is controlled by the @code{nnmail-message-id-cache-length}
14147 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
14148 stored.) If all this sounds scary to you, you can set
14149 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
14150 default), and @code{nnmail} won't delete duplicate mails. Instead it
14151 will insert a warning into the head of the mail saying that it thinks
14152 that this is a duplicate of a different message.
14154 This variable can also be a function. If that's the case, the function
14155 will be called from a buffer narrowed to the message in question with
14156 the @code{Message-ID} as a parameter. The function must return either
14157 @code{nil}, @code{warn}, or @code{delete}.
14159 You can turn this feature off completely by setting the variable to
14162 If you want all the duplicate mails to be put into a special
14163 @dfn{duplicates} group, you could do that using the normal mail split
14167 (setq nnmail-split-fancy
14168 '(| ;; Messages duplicates go to a separate group.
14169 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
14170 ;; Message from daemons, postmaster, and the like to another.
14171 (any mail "mail.misc")
14178 (setq nnmail-split-methods
14179 '(("duplicates" "^Gnus-Warning:.*duplicate")
14184 Here's a neat feature: If you know that the recipient reads her mail
14185 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
14186 @code{delete}, you can send her as many insults as you like, just by
14187 using a @code{Message-ID} of a mail that you know that she's already
14188 received. Think of all the fun! She'll never see any of it! Whee!
14191 @node Not Reading Mail
14192 @subsection Not Reading Mail
14194 If you start using any of the mail back ends, they have the annoying
14195 habit of assuming that you want to read mail with them. This might not
14196 be unreasonable, but it might not be what you want.
14198 If you set @code{mail-sources} and @code{nnmail-spool-file} to
14199 @code{nil}, none of the back ends will ever attempt to read incoming
14200 mail, which should help.
14202 @vindex nnbabyl-get-new-mail
14203 @vindex nnmbox-get-new-mail
14204 @vindex nnml-get-new-mail
14205 @vindex nnmh-get-new-mail
14206 @vindex nnfolder-get-new-mail
14207 This might be too much, if, for instance, you are reading mail quite
14208 happily with @code{nnml} and just want to peek at some old @sc{rmail}
14209 file you have stashed away with @code{nnbabyl}. All back ends have
14210 variables called back-end-@code{get-new-mail}. If you want to disable
14211 the @code{nnbabyl} mail reading, you edit the virtual server for the
14212 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
14214 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
14215 narrowed to the article to be saved before saving it when reading
14219 @node Choosing a Mail Back End
14220 @subsection Choosing a Mail Back End
14222 Gnus will read the mail spool when you activate a mail group. The mail
14223 file is first copied to your home directory. What happens after that
14224 depends on what format you want to store your mail in.
14226 There are six different mail back ends in the standard Gnus, and more
14227 back ends are available separately. The mail back end most people use
14228 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
14229 Spool}). You might notice that only five back ends are listed below;
14230 @code{nnmaildir}'s documentation has not yet been completely
14231 incorporated into this manual. Until it is, you can find it at
14232 @uref{http://multivac.cwru.edu./nnmaildir/}.
14235 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
14236 * Rmail Babyl:: Emacs programs use the rmail babyl format.
14237 * Mail Spool:: Store your mail in a private spool?
14238 * MH Spool:: An mhspool-like back end.
14239 * Mail Folders:: Having one file for each group.
14240 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
14244 @node Unix Mail Box
14245 @subsubsection Unix Mail Box
14247 @cindex unix mail box
14249 @vindex nnmbox-active-file
14250 @vindex nnmbox-mbox-file
14251 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
14252 mail. @code{nnmbox} will add extra headers to each mail article to say
14253 which group it belongs in.
14255 Virtual server settings:
14258 @item nnmbox-mbox-file
14259 @vindex nnmbox-mbox-file
14260 The name of the mail box in the user's home directory. Default is
14263 @item nnmbox-active-file
14264 @vindex nnmbox-active-file
14265 The name of the active file for the mail box. Default is
14266 @file{~/.mbox-active}.
14268 @item nnmbox-get-new-mail
14269 @vindex nnmbox-get-new-mail
14270 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
14271 into groups. Default is @code{t}.
14276 @subsubsection Rmail Babyl
14280 @vindex nnbabyl-active-file
14281 @vindex nnbabyl-mbox-file
14282 The @dfn{nnbabyl} back end will use a babyl mail box (aka. @dfn{rmail
14283 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
14284 mail article to say which group it belongs in.
14286 Virtual server settings:
14289 @item nnbabyl-mbox-file
14290 @vindex nnbabyl-mbox-file
14291 The name of the rmail mbox file. The default is @file{~/RMAIL}
14293 @item nnbabyl-active-file
14294 @vindex nnbabyl-active-file
14295 The name of the active file for the rmail box. The default is
14296 @file{~/.rmail-active}
14298 @item nnbabyl-get-new-mail
14299 @vindex nnbabyl-get-new-mail
14300 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
14306 @subsubsection Mail Spool
14308 @cindex mail @sc{nov} spool
14310 The @dfn{nnml} spool mail format isn't compatible with any other known
14311 format. It should be used with some caution.
14313 @vindex nnml-directory
14314 If you use this back end, Gnus will split all incoming mail into files,
14315 one file for each mail, and put the articles into the corresponding
14316 directories under the directory specified by the @code{nnml-directory}
14317 variable. The default value is @file{~/Mail/}.
14319 You do not have to create any directories beforehand; Gnus will take
14322 If you have a strict limit as to how many files you are allowed to store
14323 in your account, you should not use this back end. As each mail gets its
14324 own file, you might very well occupy thousands of inodes within a few
14325 weeks. If this is no problem for you, and it isn't a problem for you
14326 having your friendly systems administrator walking around, madly,
14327 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
14328 know that this is probably the fastest format to use. You do not have
14329 to trudge through a big mbox file just to read your new mail.
14331 @code{nnml} is probably the slowest back end when it comes to article
14332 splitting. It has to create lots of files, and it also generates
14333 @sc{nov} databases for the incoming mails. This makes it possibly the
14334 fastest back end when it comes to reading mail.
14336 @cindex self contained nnml servers
14338 When the marks file is used (which it is by default), @code{nnml}
14339 servers have the property that you may backup them using @code{tar} or
14340 similar, and later be able to restore them into Gnus (by adding the
14341 proper @code{nnml} server) and have all your marks be preserved. Marks
14342 for a group is usually stored in the @code{.marks} file (but see
14343 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
14344 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
14345 to restore the group (after restoring the backup into the nnml
14348 If for some reason you believe your @file{.marks} files are screwed
14349 up, you can just delete them all. Gnus will then correctly regenerate
14350 them next time it starts.
14352 Virtual server settings:
14355 @item nnml-directory
14356 @vindex nnml-directory
14357 All @code{nnml} directories will be placed under this directory.
14358 The default is the value of `message-directory' (whose default value is
14361 @item nnml-active-file
14362 @vindex nnml-active-file
14363 The active file for the @code{nnml} server. The default is
14364 @file{~/Mail/active"}.
14366 @item nnml-newsgroups-file
14367 @vindex nnml-newsgroups-file
14368 The @code{nnml} group descriptions file. @xref{Newsgroups File
14369 Format}. The default is @file{~/Mail/newsgroups"}.
14371 @item nnml-get-new-mail
14372 @vindex nnml-get-new-mail
14373 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
14376 @item nnml-nov-is-evil
14377 @vindex nnml-nov-is-evil
14378 If non-@code{nil}, this back end will ignore any @sc{nov} files. The
14379 default is @code{nil}.
14381 @item nnml-nov-file-name
14382 @vindex nnml-nov-file-name
14383 The name of the @sc{nov} files. The default is @file{.overview}.
14385 @item nnml-prepare-save-mail-hook
14386 @vindex nnml-prepare-save-mail-hook
14387 Hook run narrowed to an article before saving.
14389 @item nnml-marks-is-evil
14390 @vindex nnml-marks-is-evil
14391 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
14392 default is @code{nil}.
14394 @item nnml-marks-file-name
14395 @vindex nnml-marks-file-name
14396 The name of the @dfn{marks} files. The default is @file{.marks}.
14398 @item nnml-use-compressed-files
14399 @vindex nnml-use-compressed-files
14400 If non-@code{nil}, @code{nnml} will allow using compressed message
14405 @findex nnml-generate-nov-databases
14406 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
14407 you can do a complete update by typing @kbd{M-x
14408 nnml-generate-nov-databases}. This command will trawl through the
14409 entire @code{nnml} hierarchy, looking at each and every article, so it
14410 might take a while to complete. A better interface to this
14411 functionality can be found in the server buffer (@pxref{Server
14416 @subsubsection MH Spool
14418 @cindex mh-e mail spool
14420 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
14421 @sc{nov} databases and it doesn't keep an active file or marks file.
14422 This makes @code{nnmh} a @emph{much} slower back end than @code{nnml},
14423 but it also makes it easier to write procmail scripts for.
14425 Virtual server settings:
14428 @item nnmh-directory
14429 @vindex nnmh-directory
14430 All @code{nnmh} directories will be located under this directory. The
14431 default is the value of @code{message-directory} (whose default is
14434 @item nnmh-get-new-mail
14435 @vindex nnmh-get-new-mail
14436 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
14440 @vindex nnmh-be-safe
14441 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
14442 sure that the articles in the folder are actually what Gnus thinks they
14443 are. It will check date stamps and stat everything in sight, so
14444 setting this to @code{t} will mean a serious slow-down. If you never
14445 use anything but Gnus to read the @code{nnmh} articles, you do not have
14446 to set this variable to @code{t}. The default is @code{nil}.
14451 @subsubsection Mail Folders
14453 @cindex mbox folders
14454 @cindex mail folders
14456 @code{nnfolder} is a back end for storing each mail group in a separate
14457 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
14458 will add extra headers to keep track of article numbers and arrival
14461 @cindex self contained nnfolder servers
14463 When the marks file is used (which it is by default), @code{nnfolder}
14464 servers have the property that you may backup them using @code{tar} or
14465 similar, and later be able to restore them into Gnus (by adding the
14466 proper @code{nnfolder} server) and have all your marks be preserved.
14467 Marks for a group is usually stored in a file named as the mbox file
14468 with @code{.mrk} concatenated to it (but see
14469 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder} directory.
14470 Individual @code{nnfolder} groups are also possible to backup, use
14471 @kbd{G m} to restore the group (after restoring the backup into the
14472 @code{nnfolder} directory).
14474 Virtual server settings:
14477 @item nnfolder-directory
14478 @vindex nnfolder-directory
14479 All the @code{nnfolder} mail boxes will be stored under this directory.
14480 The default is the value of @code{message-directory} (whose default is
14483 @item nnfolder-active-file
14484 @vindex nnfolder-active-file
14485 The name of the active file. The default is @file{~/Mail/active}.
14487 @item nnfolder-newsgroups-file
14488 @vindex nnfolder-newsgroups-file
14489 The name of the group descriptions file. @xref{Newsgroups File
14490 Format}. The default is @file{~/Mail/newsgroups"}
14492 @item nnfolder-get-new-mail
14493 @vindex nnfolder-get-new-mail
14494 If non-@code{nil}, @code{nnfolder} will read incoming mail. The default
14497 @item nnfolder-save-buffer-hook
14498 @vindex nnfolder-save-buffer-hook
14499 @cindex backup files
14500 Hook run before saving the folders. Note that Emacs does the normal
14501 backup renaming of files even with the @code{nnfolder} buffers. If you
14502 wish to switch this off, you could say something like the following in
14503 your @file{.emacs} file:
14506 (defun turn-off-backup ()
14507 (set (make-local-variable 'backup-inhibited) t))
14509 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
14512 @item nnfolder-delete-mail-hook
14513 @vindex nnfolder-delete-mail-hook
14514 Hook run in a buffer narrowed to the message that is to be deleted.
14515 This function can be used to copy the message to somewhere else, or to
14516 extract some information from it before removing it.
14518 @item nnfolder-nov-is-evil
14519 @vindex nnfolder-nov-is-evil
14520 If non-@code{nil}, this back end will ignore any @sc{nov} files. The
14521 default is @code{nil}.
14523 @item nnfolder-nov-file-suffix
14524 @vindex nnfolder-nov-file-suffix
14525 The extension for @sc{nov} files. The default is @file{.nov}.
14527 @item nnfolder-nov-directory
14528 @vindex nnfolder-nov-directory
14529 The directory where the @sc{nov} files should be stored. If nil,
14530 @code{nnfolder-directory} is used.
14532 @item nnfolder-marks-is-evil
14533 @vindex nnfolder-marks-is-evil
14534 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
14535 default is @code{nil}.
14537 @item nnfolder-marks-file-suffix
14538 @vindex nnfolder-marks-file-suffix
14539 The extension for @sc{marks} files. The default is @file{.mrk}.
14541 @item nnfolder-marks-directory
14542 @vindex nnfolder-marks-directory
14543 The directory where the @sc{marks} files should be stored. If nil,
14544 @code{nnfolder-directory} is used.
14549 @findex nnfolder-generate-active-file
14550 @kindex M-x nnfolder-generate-active-file
14551 If you have lots of @code{nnfolder}-like files you'd like to read with
14552 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
14553 command to make @code{nnfolder} aware of all likely files in
14554 @code{nnfolder-directory}. This only works if you use long file names,
14557 @node Comparing Mail Back Ends
14558 @subsubsection Comparing Mail Back Ends
14560 First, just for terminology, the @dfn{back end} is the common word for a
14561 low-level access method---a transport, if you will, by which something
14562 is acquired. The sense is that one's mail has to come from somewhere,
14563 and so selection of a suitable back end is required in order to get that
14564 mail within spitting distance of Gnus.
14566 The same concept exists for Usenet itself: Though access to articles is
14567 typically done by @sc{nntp} these days, once upon a midnight dreary, everyone
14568 in the world got at Usenet by running a reader on the machine where the
14569 articles lay (the machine which today we call an @sc{nntp} server), and
14570 access was by the reader stepping into the articles' directory spool
14571 area directly. One can still select between either the @code{nntp} or
14572 @code{nnspool} back ends, to select between these methods, if one happens
14573 actually to live on the server (or can see its spool directly, anyway,
14576 The goal in selecting a mail back end is to pick one which
14577 simultaneously represents a suitable way of dealing with the original
14578 format plus leaving mail in a form that is convenient to use in the
14579 future. Here are some high and low points on each:
14584 UNIX systems have historically had a single, very common, and well-
14585 defined format. All messages arrive in a single @dfn{spool file}, and
14586 they are delineated by a line whose regular expression matches
14587 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
14588 to make it clear in this instance that this is not the RFC-specified
14589 @samp{From:} header.) Because Emacs and therefore Gnus emanate
14590 historically from the Unix environment, it is simplest if one does not
14591 mess a great deal with the original mailbox format, so if one chooses
14592 this back end, Gnus' primary activity in getting mail from the real spool
14593 area to Gnus' preferred directory is simply to copy it, with no
14594 (appreciable) format change in the process. It is the ``dumbest'' way
14595 to move mail into availability in the Gnus environment. This makes it
14596 fast to move into place, but slow to parse, when Gnus has to look at
14601 Once upon a time, there was the DEC-10 and DEC-20, running operating
14602 systems called TOPS and related things, and the usual (only?) mail
14603 reading environment was a thing called Babyl. I don't know what format
14604 was used for mail landing on the system, but Babyl had its own internal
14605 format to which mail was converted, primarily involving creating a
14606 spool-file-like entity with a scheme for inserting Babyl-specific
14607 headers and status bits above the top of each message in the file.
14608 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
14609 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
14610 to understand the mail files folks already had in existence. Gnus (and
14611 VM, for that matter) continue to support this format because it's
14612 perceived as having some good qualities in those mailer-specific
14613 headers/status bits stuff. RMAIL itself still exists as well, of
14614 course, and is still maintained by Stallman.
14616 Both of the above forms leave your mail in a single file on your
14617 file system, and they must parse that entire file each time you take a
14622 @code{nnml} is the back end which smells the most as though you were
14623 actually operating with an @code{nnspool}-accessed Usenet system. (In
14624 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
14625 lo these years ago.) One's mail is taken from the original spool file,
14626 and is then cut up into individual message files, 1:1. It maintains a
14627 Usenet-style active file (analogous to what one finds in an INN- or
14628 CNews-based news system in (for instance) @file{/var/lib/news/active},
14629 or what is returned via the @samp{NNTP LIST} verb) and also creates
14630 @dfn{overview} files for efficient group entry, as has been defined for
14631 @sc{nntp} servers for some years now. It is slower in mail-splitting,
14632 due to the creation of lots of files, updates to the @code{nnml} active
14633 file, and additions to overview files on a per-message basis, but it is
14634 extremely fast on access because of what amounts to the indexing support
14635 provided by the active file and overviews.
14637 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
14638 resource which defines available places in the file system to put new
14639 files. Sysadmins take a dim view of heavy inode occupation within
14640 tight, shared file systems. But if you live on a personal machine where
14641 the file system is your own and space is not at a premium, @code{nnml}
14644 It is also problematic using this back end if you are living in a
14645 FAT16-based Windows world, since much space will be wasted on all these
14650 The Rand MH mail-reading system has been around UNIX systems for a very
14651 long time; it operates by splitting one's spool file of messages into
14652 individual files, but with little or no indexing support -- @code{nnmh}
14653 is considered to be semantically equivalent to ``@code{nnml} without
14654 active file or overviews''. This is arguably the worst choice, because
14655 one gets the slowness of individual file creation married to the
14656 slowness of access parsing when learning what's new in one's groups.
14660 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
14661 method described above) on a per-group basis. That is, @code{nnmbox}
14662 itself puts *all* one's mail in one file; @code{nnfolder} provides a
14663 little bit of optimization to this so that each of one's mail groups has
14664 a Unix mail box file. It's faster than @code{nnmbox} because each group
14665 can be parsed separately, and still provides the simple Unix mail box
14666 format requiring minimal effort in moving the mail around. In addition,
14667 it maintains an ``active'' file making it much faster for Gnus to figure
14668 out how many messages there are in each separate group.
14670 If you have groups that are expected to have a massive amount of
14671 messages, @code{nnfolder} is not the best choice, but if you receive
14672 only a moderate amount of mail, @code{nnfolder} is probably the most
14673 friendly mail back end all over.
14677 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
14678 differences. Each message is stored in a separate file, but the
14679 filename is unrelated to the article number in Gnus. @code{nnmaildir}
14680 also stores the equivalent of @code{nnml}'s overview files in one file
14681 per article, so it uses about twice as many inodes as @code{nnml}. (Use
14682 @code{df -i} to see how plentiful your inode supply is.) If this slows
14683 you down or takes up very much space, consider switching to ReiserFS
14684 (@uref{http://www.namesys.com/}) or another non-block-structured
14687 Since maildirs don't require locking for delivery, the maildirs you use
14688 as groups can also be the maildirs your mail is directly delivered to.
14689 This means you can skip Gnus's mail splitting if your mail is already
14690 organized into different mailboxes during delivery. A @code{directory}
14691 entry in @code{mail-sources} would have a similar effect, but would
14692 require one set of mailboxes for spooling deliveries (in mbox format,
14693 thus damaging message bodies), and another set to be used as groups (in
14694 whatever format you like). A maildir has a built-in spool, in the
14695 @code{new/} subdirectory. Beware that currently, mail moved from
14696 @code{new/} to @code{cur/} instead of via mail splitting will undergo
14697 treatment such as duplicate checking.
14699 An article will not necessarily keep the same number across Gnus
14700 sessions; articles are renumbered starting from 1 for each Gnus session
14701 (more precisely, each time you open the @code{nnmaildir} server). This
14702 way, you don't get gaps in your article number ranges, and when entering
14703 large groups, Gnus is likely to give a more accurate article count. The
14704 price is that @code{nnmaildir} doesn't work with the cache or agent.
14705 This will probably be changed in the future.
14707 @code{nnmaildir} stores article marks for a given group in the
14708 corresponding maildir, in a way designed so that it's easy to manipulate
14709 them from outside Gnus. You can tar up a maildir, unpack it somewhere
14710 else, and still have your marks. @code{nnml} also stores marks, but
14711 it's not as easy to work with them from outside Gnus as with
14714 For configuring expiry and other things, @code{nnmaildir} uses group
14715 parameters slightly different from those of other mail back ends.
14717 @code{nnmaildir} uses a significant amount of memory to speed things up.
14718 (It keeps in memory some of the things that @code{nnml} stores in files
14719 and that @code{nnmh} repeatedly parses out of message files.) If this
14720 is a problem for you, you can set the @code{nov-cache-size} group
14721 parameter to something small (0 would probably not work, but 1 probably
14722 would) to make it use less memory.
14724 Startup and shutdown are likely to be slower with @code{nnmaildir} than
14725 with other back ends. Everything in between is likely to be faster,
14726 depending in part on your file system.
14728 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
14729 to write an @code{nnmaildir}-derived back end.
14734 @node Browsing the Web
14735 @section Browsing the Web
14737 @cindex browsing the web
14741 Web-based discussion forums are getting more and more popular. On many
14742 subjects, the web-based forums have become the most important forums,
14743 eclipsing the importance of mailing lists and news groups. The reason
14744 is easy to understand---they are friendly to new users; you just point
14745 and click, and there's the discussion. With mailing lists, you have to
14746 go through a cumbersome subscription procedure, and most people don't
14747 even know what a news group is.
14749 The problem with this scenario is that web browsers are not very good at
14750 being newsreaders. They do not keep track of what articles you've read;
14751 they do not allow you to score on subjects you're interested in; they do
14752 not allow off-line browsing; they require you to click around and drive
14753 you mad in the end.
14755 So---if web browsers suck at reading discussion forums, why not use Gnus
14758 Gnus has been getting a bit of a collection of back ends for providing
14759 interfaces to these sources.
14763 * Web Searches:: Creating groups from articles that match a string.
14764 * Slashdot:: Reading the Slashdot comments.
14765 * Ultimate:: The Ultimate Bulletin Board systems.
14766 * Web Archive:: Reading mailing list archived on web.
14767 * RSS:: Reading RDF site summary.
14768 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
14771 All the web sources require Emacs/w3 and the url library to work.
14773 The main caveat with all these web sources is that they probably won't
14774 work for a very long time. Gleaning information from the @sc{html} data
14775 is guesswork at best, and when the layout is altered, the Gnus back end
14776 will fail. If you have reasonably new versions of these back ends,
14777 though, you should be ok.
14779 One thing all these Web methods have in common is that the Web sources
14780 are often down, unavailable or just plain too slow to be fun. In those
14781 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
14782 Unplugged}) handle downloading articles, and then you can read them at
14783 leisure from your local disk. No more World Wide Wait for you.
14785 @node Archiving Mail
14786 @subsection Archiving Mail
14787 @cindex archiving mail
14788 @cindex backup of mail
14790 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
14791 @code{nnmaildir}, now actually store the article marks with each group.
14792 For these servers, archiving and restoring a group while preserving
14793 marks is fairly simple.
14795 (Preserving the group level and group parameters as well still
14796 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
14799 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
14800 server, take a recursive copy of the server directory. There is no need
14801 to shut down Gnus, so archiving may be invoked by @code{cron} or
14802 similar. You restore the data by restoring the directory tree, and
14803 adding a server definition pointing to that directory in Gnus. The
14804 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
14805 might interfere with overwriting data, so you may want to shut down Gnus
14806 before you restore the data.
14808 It is also possible to archive individual @code{nnml},
14809 @code{nnfolder}, or @code{nnmaildir} groups, while preserving marks.
14810 For @code{nnml} or @code{nnmaildir}, you copy all files in the group's
14811 directory. For @code{nnfolder} you need to copy both the base folder
14812 file itself (@file{FOO}, say), and the marks file (@file{FOO.mrk} in
14813 this example). Restoring the group is done with @kbd{G m} from the Group
14814 buffer. The last step makes Gnus notice the new directory.
14815 @code{nnmaildir} notices the new directory automatically, so @kbd{G m}
14816 is unnecessary in that case.
14819 @subsection Web Searches
14824 @cindex Usenet searches
14825 @cindex searching the Usenet
14827 It's, like, too neat to search the Usenet for articles that match a
14828 string, but it, like, totally @emph{sucks}, like, totally, to use one of
14829 those, like, Web browsers, and you, like, have to, rilly, like, look at
14830 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
14831 searches without having to use a browser.
14833 The @code{nnweb} back end allows an easy interface to the mighty search
14834 engine. You create an @code{nnweb} group, enter a search pattern, and
14835 then enter the group and read the articles like you would any normal
14836 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
14837 Groups}) will do this in an easy-to-use fashion.
14839 @code{nnweb} groups don't really lend themselves to being solid
14840 groups---they have a very fleeting idea of article numbers. In fact,
14841 each time you enter an @code{nnweb} group (not even changing the search
14842 pattern), you are likely to get the articles ordered in a different
14843 manner. Not even using duplicate suppression (@pxref{Duplicate
14844 Suppression}) will help, since @code{nnweb} doesn't even know the
14845 @code{Message-ID} of the articles before reading them using some search
14846 engines (Google, for instance). The only possible way to keep track
14847 of which articles you've read is by scoring on the @code{Date}
14848 header---mark all articles posted before the last date you read the
14851 If the search engine changes its output substantially, @code{nnweb}
14852 won't be able to parse it and will fail. One could hardly fault the Web
14853 providers if they were to do this---their @emph{raison d'être} is to
14854 make money off of advertisements, not to provide services to the
14855 community. Since @code{nnweb} washes the ads off all the articles, one
14856 might think that the providers might be somewhat miffed. We'll see.
14858 You must have the @code{url} and @code{w3} package installed to be able
14859 to use @code{nnweb}.
14861 Virtual server variables:
14866 What search engine type is being used. The currently supported types
14867 are @code{google}, @code{dejanews}, and @code{gmane}. Note that
14868 @code{dejanews} is an alias to @code{google}.
14871 @vindex nnweb-search
14872 The search string to feed to the search engine.
14874 @item nnweb-max-hits
14875 @vindex nnweb-max-hits
14876 Advisory maximum number of hits per search to display. The default is
14879 @item nnweb-type-definition
14880 @vindex nnweb-type-definition
14881 Type-to-definition alist. This alist says what @code{nnweb} should do
14882 with the various search engine types. The following elements must be
14887 Function to decode the article and provide something that Gnus
14891 Function to create an article number to message header and URL alist.
14894 Function to send the search string to the search engine.
14897 The address the aforementioned function should send the search string
14901 Format string URL to fetch an article by @code{Message-ID}.
14908 @subsection Slashdot
14912 Slashdot (@uref{http://slashdot.org/}) is a popular news site, with
14913 lively discussion following the news articles. @code{nnslashdot} will
14914 let you read this forum in a convenient manner.
14916 The easiest way to read this source is to put something like the
14917 following in your @file{.gnus.el} file:
14920 (setq gnus-secondary-select-methods
14921 '((nnslashdot "")))
14924 This will make Gnus query the @code{nnslashdot} back end for new comments
14925 and groups. The @kbd{F} command will subscribe each new news article as
14926 a new Gnus group, and you can read the comments by entering these
14927 groups. (Note that the default subscription method is to subscribe new
14928 groups as zombies. Other methods are available (@pxref{Subscription
14931 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
14932 command is the most handy tool (@pxref{Foreign Groups}).
14934 When following up to @code{nnslashdot} comments (or posting new
14935 comments), some light @sc{html}izations will be performed. In
14936 particular, text quoted with @samp{> } will be quoted with
14937 @code{blockquote} instead, and signatures will have @code{br} added to
14938 the end of each line. Other than that, you can just write @sc{html}
14939 directly into the message buffer. Note that Slashdot filters out some
14942 The following variables can be altered to change its behavior:
14945 @item nnslashdot-threaded
14946 Whether @code{nnslashdot} should display threaded groups or not. The
14947 default is @code{t}. To be able to display threads, @code{nnslashdot}
14948 has to retrieve absolutely all comments in a group upon entry. If a
14949 threaded display is not required, @code{nnslashdot} will only retrieve
14950 the comments that are actually wanted by the user. Threading is nicer,
14951 but much, much slower than unthreaded.
14953 @item nnslashdot-login-name
14954 @vindex nnslashdot-login-name
14955 The login name to use when posting.
14957 @item nnslashdot-password
14958 @vindex nnslashdot-password
14959 The password to use when posting.
14961 @item nnslashdot-directory
14962 @vindex nnslashdot-directory
14963 Where @code{nnslashdot} will store its files. The default is
14964 @samp{~/News/slashdot/}.
14966 @item nnslashdot-active-url
14967 @vindex nnslashdot-active-url
14968 The @sc{url} format string that will be used to fetch the information on
14969 news articles and comments. The default is
14970 @samp{http://slashdot.org/search.pl?section=&min=%d}.
14972 @item nnslashdot-comments-url
14973 @vindex nnslashdot-comments-url
14974 The @sc{url} format string that will be used to fetch comments. The
14976 @samp{http://slashdot.org/comments.pl?sid=%s&threshold=%d&commentsort=%d&mode=flat&startat=%d}.
14978 @item nnslashdot-article-url
14979 @vindex nnslashdot-article-url
14980 The @sc{url} format string that will be used to fetch the news article. The
14982 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
14984 @item nnslashdot-threshold
14985 @vindex nnslashdot-threshold
14986 The score threshold. The default is -1.
14988 @item nnslashdot-group-number
14989 @vindex nnslashdot-group-number
14990 The number of old groups, in addition to the ten latest, to keep
14991 updated. The default is 0.
14998 @subsection Ultimate
15000 @cindex Ultimate Bulletin Board
15002 The Ultimate Bulletin Board (@uref{http://www.ultimatebb.com/}) is
15003 probably the most popular Web bulletin board system used. It has a
15004 quite regular and nice interface, and it's possible to get the
15005 information Gnus needs to keep groups updated.
15007 The easiest way to get started with @code{nnultimate} is to say
15008 something like the following in the group buffer: @kbd{B nnultimate RET
15009 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @sc{url}
15010 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
15011 you're interested in; there's quite a list of them on the Ultimate web
15012 site.) Then subscribe to the groups you're interested in from the
15013 server buffer, and read them from the group buffer.
15015 The following @code{nnultimate} variables can be altered:
15018 @item nnultimate-directory
15019 @vindex nnultimate-directory
15020 The directory where @code{nnultimate} stores its files. The default is
15021 @samp{~/News/ultimate/}.
15026 @subsection Web Archive
15028 @cindex Web Archive
15030 Some mailing lists only have archives on Web servers, such as
15031 @uref{http://www.egroups.com/} and
15032 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
15033 interface, and it's possible to get the information Gnus needs to keep
15036 @findex gnus-group-make-warchive-group
15037 The easiest way to get started with @code{nnwarchive} is to say
15038 something like the following in the group buffer: @kbd{M-x
15039 gnus-group-make-warchive-group RET an_egroup RET egroups RET
15040 www.egroups.com RET your@@email.address RET}. (Substitute the
15041 @sc{an_egroup} with the mailing list you subscribed, the
15042 @sc{your@@email.address} with your email address.), or to browse the
15043 back end by @kbd{B nnwarchive RET mail-archive RET}.
15045 The following @code{nnwarchive} variables can be altered:
15048 @item nnwarchive-directory
15049 @vindex nnwarchive-directory
15050 The directory where @code{nnwarchive} stores its files. The default is
15051 @samp{~/News/warchive/}.
15053 @item nnwarchive-login
15054 @vindex nnwarchive-login
15055 The account name on the web server.
15057 @item nnwarchive-passwd
15058 @vindex nnwarchive-passwd
15059 The password for your account on the web server.
15067 Some sites have RDF site summary (RSS)
15068 @uref{http://purl.org/rss/1.0/spec}. It has a quite regular and nice
15069 interface, and it's possible to get the information Gnus needs to keep
15072 The easiest way to get started with @code{nnrss} is to say something
15073 like the following in the group buffer: @kbd{B nnrss RET RET}, then
15076 The following @code{nnrss} variables can be altered:
15079 @item nnrss-directory
15080 @vindex nnrss-directory
15081 The directory where @code{nnrss} stores its files. The default is
15082 @samp{~/News/rss/}.
15086 The following code may be helpful, if you want to show the description in
15087 the summary buffer.
15090 (add-to-list 'nnmail-extra-headers nnrss-description-field)
15091 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
15093 (defun gnus-user-format-function-X (header)
15095 (assq nnrss-description-field (mail-header-extra header))))
15096 (if descr (concat "\n\t" (cdr descr)) "")))
15099 The following code may be useful to open an nnrss url directly from the
15102 (require 'browse-url)
15104 (defun browse-nnrss-url( arg )
15106 (let ((url (assq nnrss-url-field
15109 (assq (gnus-summary-article-number)
15110 gnus-newsgroup-data))))))
15113 (browse-url (cdr url))
15114 (gnus-summary-mark-as-read-forward 1))
15115 (gnus-summary-scroll-up arg))))
15117 (eval-after-load "gnus"
15118 #'(define-key gnus-summary-mode-map
15119 (kbd "<RET>") 'browse-nnrss-url))
15120 (add-to-list 'nnmail-extra-headers nnrss-url-field)
15123 @node Customizing w3
15124 @subsection Customizing w3
15130 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
15131 pages. Emacs/w3 is documented in its own manual, but there are some
15132 things that may be more relevant for Gnus users.
15134 For instance, a common question is how to make Emacs/w3 follow links
15135 using the @code{browse-url} functions (which will call some external web
15136 browser like Netscape). Here's one way:
15139 (eval-after-load "w3"
15141 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
15142 (defun w3-fetch (&optional url target)
15143 (interactive (list (w3-read-url-with-default)))
15144 (if (eq major-mode 'gnus-article-mode)
15146 (w3-fetch-orig url target)))))
15149 Put that in your @file{.emacs} file, and hitting links in w3-rendered
15150 @sc{html} in the Gnus article buffers will use @code{browse-url} to
15159 @sc{imap} is a network protocol for reading mail (or news, or ...),
15160 think of it as a modernized @sc{nntp}. Connecting to a @sc{imap}
15161 server is much similar to connecting to a news server, you just
15162 specify the network address of the server.
15164 @sc{imap} has two properties. First, @sc{imap} can do everything that
15165 POP can, it can hence be viewed as a POP++. Secondly, @sc{imap} is a
15166 mail storage protocol, similar to @sc{nntp} being a news storage
15167 protocol -- however, @sc{imap} offers more features than @sc{nntp}
15168 because news is more or less read-only whereas mail is read-write.
15170 If you want to use @sc{imap} as a POP++, use an imap entry in
15171 @code{mail-sources}. With this, Gnus will fetch mails from the
15172 @sc{imap} server and store them on the local disk. This is not the
15173 usage described in this section--@xref{Mail Sources}.
15175 If you want to use @sc{imap} as a mail storage protocol, use an nnimap
15176 entry in @code{gnus-secondary-select-methods}. With this, Gnus will
15177 manipulate mails stored on the @sc{imap} server. This is the kind of
15178 usage explained in this section.
15180 A server configuration in @code{~/.gnus} with a few @sc{imap} servers
15181 might look something like the following. (Note that for SSL/TLS, you
15182 need external programs and libraries, see below.)
15185 (setq gnus-secondary-select-methods
15186 '((nnimap "simpleserver") ; no special configuration
15187 ; perhaps a ssh port forwarded server:
15189 (nnimap-address "localhost")
15190 (nnimap-server-port 1430))
15191 ; a UW server running on localhost
15193 (nnimap-server-port 143)
15194 (nnimap-address "localhost")
15195 (nnimap-list-pattern ("INBOX" "mail/*")))
15196 ; anonymous public cyrus server:
15197 (nnimap "cyrus.andrew.cmu.edu"
15198 (nnimap-authenticator anonymous)
15199 (nnimap-list-pattern "archive.*")
15200 (nnimap-stream network))
15201 ; a ssl server on a non-standard port:
15203 (nnimap-address "vic20.somewhere.com")
15204 (nnimap-server-port 9930)
15205 (nnimap-stream ssl))))
15208 After defining the new server, you can subscribe to groups on the
15209 server using normal Gnus commands such as @kbd{U} in the Group Buffer
15210 (@pxref{Subscription Commands}) or via the Server Buffer
15211 (@pxref{Server Buffer}).
15213 The following variables can be used to create a virtual @code{nnimap}
15218 @item nnimap-address
15219 @vindex nnimap-address
15221 The address of the remote @sc{imap} server. Defaults to the virtual
15222 server name if not specified.
15224 @item nnimap-server-port
15225 @vindex nnimap-server-port
15226 Port on server to contact. Defaults to port 143, or 993 for SSL.
15228 Note that this should be an integer, example server specification:
15231 (nnimap "mail.server.com"
15232 (nnimap-server-port 4711))
15235 @item nnimap-list-pattern
15236 @vindex nnimap-list-pattern
15237 String or list of strings of mailboxes to limit available groups to.
15238 This is used when the server has very many mailboxes and you're only
15239 interested in a few -- some servers export your home directory via
15240 @sc{imap}, you'll probably want to limit the mailboxes to those in
15241 @file{~/Mail/*} then.
15243 The string can also be a cons of REFERENCE and the string as above, what
15244 REFERENCE is used for is server specific, but on the University of
15245 Washington server it's a directory that will be concatenated with the
15248 Example server specification:
15251 (nnimap "mail.server.com"
15252 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
15253 ("~friend/Mail/" . "list/*"))))
15256 @item nnimap-stream
15257 @vindex nnimap-stream
15258 The type of stream used to connect to your server. By default, nnimap
15259 will detect and automatically use all of the below, with the exception
15260 of SSL/TLS. (@sc{imap} over SSL/TLS is being replaced by STARTTLS, which
15261 can be automatically detected, but it's not widely deployed yet.)
15263 Example server specification:
15266 (nnimap "mail.server.com"
15267 (nnimap-stream ssl))
15270 Please note that the value of @code{nnimap-stream} is a symbol!
15274 @dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5). Requires the
15275 @samp{imtest} program.
15277 @dfn{kerberos4:} Connect with Kerberos 4. Requires the @samp{imtest} program.
15279 @dfn{starttls:} Connect via the STARTTLS extension (similar to
15280 SSL). Requires the external library @samp{starttls.el} and program
15283 @dfn{ssl:} Connect through SSL. Requires OpenSSL (the program
15284 @samp{openssl}) or SSLeay (@samp{s_client}) as well as the external
15285 library @samp{ssl.el}.
15287 @dfn{shell:} Use a shell command to start @sc{imap} connection.
15289 @dfn{network:} Plain, TCP/IP network connection.
15292 @vindex imap-kerberos4-program
15293 The @samp{imtest} program is shipped with Cyrus IMAPD. If you're
15294 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
15295 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
15296 to make @code{imap.el} use a pty instead of a pipe when communicating
15297 with @samp{imtest}. You will then suffer from a line length
15298 restrictions on @sc{imap} commands, which might make Gnus seem to hang
15299 indefinitely if you have many articles in a mailbox. The variable
15300 @code{imap-kerberos4-program} contain parameters to pass to the imtest
15303 @vindex imap-ssl-program
15304 For SSL connections, the OpenSSL program is available from
15305 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
15306 and nnimap support it too - although the most recent versions of
15307 SSLeay, 0.9.x, are known to have serious bugs making it
15308 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
15309 work. The variable @code{imap-ssl-program} contain parameters to pass
15310 to OpenSSL/SSLeay. You also need @samp{ssl.el} (from the W3
15311 distribution, for instance).
15313 @vindex imap-shell-program
15314 @vindex imap-shell-host
15315 For @sc{imap} connections using the @code{shell} stream, the variable
15316 @code{imap-shell-program} specify what program to call.
15318 @item nnimap-authenticator
15319 @vindex nnimap-authenticator
15321 The authenticator used to connect to the server. By default, nnimap
15322 will use the most secure authenticator your server is capable of.
15324 Example server specification:
15327 (nnimap "mail.server.com"
15328 (nnimap-authenticator anonymous))
15331 Please note that the value of @code{nnimap-authenticator} is a symbol!
15335 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Requires
15336 external program @code{imtest}.
15338 @dfn{kerberos4:} Kerberos 4 authentication. Requires external program
15341 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Requires
15342 external library @code{digest-md5.el}.
15344 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
15346 @dfn{login:} Plain-text username/password via LOGIN.
15348 @dfn{anonymous:} Login as `anonymous', supplying your email address as password.
15351 @item nnimap-expunge-on-close
15353 @vindex nnimap-expunge-on-close
15354 Unlike Parmenides the @sc{imap} designers has decided that things that
15355 doesn't exist actually does exist. More specifically, @sc{imap} has
15356 this concept of marking articles @code{Deleted} which doesn't actually
15357 delete them, and this (marking them @code{Deleted}, that is) is what
15358 nnimap does when you delete a article in Gnus (with @kbd{B DEL} or
15361 Since the articles aren't really removed when we mark them with the
15362 @code{Deleted} flag we'll need a way to actually delete them. Feel like
15363 running in circles yet?
15365 Traditionally, nnimap has removed all articles marked as @code{Deleted}
15366 when closing a mailbox but this is now configurable by this server
15369 The possible options are:
15374 The default behavior, delete all articles marked as "Deleted" when
15377 Never actually delete articles. Currently there is no way of showing
15378 the articles marked for deletion in nnimap, but other @sc{imap} clients
15379 may allow you to do this. If you ever want to run the EXPUNGE command
15380 manually, @xref{Expunging mailboxes}.
15382 When closing mailboxes, nnimap will ask if you wish to expunge deleted
15387 @item nnimap-importantize-dormant
15388 @vindex nnimap-importantize-dormant
15390 If non-nil (the default), marks dormant articles as ticked (as well),
15391 for other @sc{imap} clients. Within Gnus, dormant articles will
15392 naturally still (only) be marked as dormant. This is to make dormant
15393 articles stand out, just like ticked articles, in other @sc{imap}
15394 clients. (In other words, Gnus has two ``Tick'' marks and @sc{imap}
15397 Probably the only reason for frobing this would be if you're trying
15398 enable per-user persistant dormant flags, using something like:
15401 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
15402 (format "gnus-dormant-%s" (user-login-name)))
15403 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
15404 (format "KEYWORD gnus-dormant-%s" (user-login-name)))
15407 In this case, you would not want the per-user dormant flag showing up
15408 as ticked for other users.
15410 @item nnimap-expunge-search-string
15412 @vindex nnimap-expunge-search-string
15414 This variable contain the @sc{imap} search command sent to server when
15415 searching for articles eligible for expiring. The default is
15416 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
15417 UID set and the second @code{%s} is replaced by a date.
15419 Probably the only useful value to change this to is
15420 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
15421 messages instead of the internal article date. See section 6.4.4 of
15422 RFC 2060 for more information on valid strings.
15424 @item nnimap-authinfo-file
15425 @vindex nnimap-authinfo-file
15427 A file containing credentials used to log in on servers. The format is
15428 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
15429 variable @code{nntp-authinfo-file} for exact syntax; also see
15435 * Splitting in IMAP:: Splitting mail with nnimap.
15436 * Expiring in IMAP:: Expiring mail with nnimap.
15437 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
15438 * Expunging mailboxes:: Equivalent of a "compress mailbox" button.
15439 * A note on namespaces:: How to (not) use IMAP namespace in Gnus.
15444 @node Splitting in IMAP
15445 @subsection Splitting in IMAP
15446 @cindex splitting imap mail
15448 Splitting is something Gnus users has loved and used for years, and now
15449 the rest of the world is catching up. Yeah, dream on, not many
15450 @sc{imap} server has server side splitting and those that have splitting
15451 seem to use some non-standard protocol. This means that @sc{imap}
15452 support for Gnus has to do it's own splitting.
15456 Here are the variables of interest:
15460 @item nnimap-split-crosspost
15461 @cindex splitting, crosspost
15463 @vindex nnimap-split-crosspost
15465 If non-nil, do crossposting if several split methods match the mail. If
15466 nil, the first match in @code{nnimap-split-rule} found will be used.
15468 Nnmail equivalent: @code{nnmail-crosspost}.
15470 @item nnimap-split-inbox
15471 @cindex splitting, inbox
15473 @vindex nnimap-split-inbox
15475 A string or a list of strings that gives the name(s) of @sc{imap}
15476 mailboxes to split from. Defaults to nil, which means that splitting is
15480 (setq nnimap-split-inbox
15481 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
15484 No nnmail equivalent.
15486 @item nnimap-split-rule
15487 @cindex Splitting, rules
15488 @vindex nnimap-split-rule
15490 New mail found in @code{nnimap-split-inbox} will be split according to
15493 This variable contains a list of lists, where the first element in the
15494 sublist gives the name of the @sc{imap} mailbox to move articles
15495 matching the regexp in the second element in the sublist. Got that?
15496 Neither did I, we need examples.
15499 (setq nnimap-split-rule
15501 "^Sender: owner-nnimap@@vic20.globalcom.se")
15502 ("INBOX.junk" "^Subject:.*MAKE MONEY")
15503 ("INBOX.private" "")))
15506 This will put all articles from the nnimap mailing list into mailbox
15507 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
15508 into INBOX.junk and everything else in INBOX.private.
15510 The first string may contain `\\1' forms, like the ones used by
15511 replace-match to insert sub-expressions from the matched text. For
15515 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
15518 The first element can also be the symbol @code{junk} to indicate that
15519 matching messages should simply be deleted. Use with care.
15521 The second element can also be a function. In that case, it will be
15522 called with the first element of the rule as the argument, in a buffer
15523 containing the headers of the article. It should return a non-nil value
15524 if it thinks that the mail belongs in that group.
15526 Nnmail users might recollect that the last regexp had to be empty to
15527 match all articles (like in the example above). This is not required in
15528 nnimap. Articles not matching any of the regexps will not be moved out
15529 of your inbox. (This might affect performance if you keep lots of
15530 unread articles in your inbox, since the splitting code would go over
15531 them every time you fetch new mail.)
15533 These rules are processed from the beginning of the alist toward the
15534 end. The first rule to make a match will "win", unless you have
15535 crossposting enabled. In that case, all matching rules will "win".
15537 This variable can also have a function as its value, the function will
15538 be called with the headers narrowed and should return a group where it
15539 thinks the article should be split to. See @code{nnimap-split-fancy}.
15541 The splitting code tries to create mailboxes if it needs to.
15543 To allow for different split rules on different virtual servers, and
15544 even different split rules in different inboxes on the same server,
15545 the syntax of this variable have been extended along the lines of:
15548 (setq nnimap-split-rule
15549 '(("my1server" (".*" (("ding" "ding@@gnus.org")
15550 ("junk" "From:.*Simon")))
15551 ("my2server" ("INBOX" nnimap-split-fancy))
15552 ("my[34]server" (".*" (("private" "To:.*Simon")
15553 ("junk" my-junk-func)))))
15556 The virtual server name is in fact a regexp, so that the same rules
15557 may apply to several servers. In the example, the servers
15558 @code{my3server} and @code{my4server} both use the same rules.
15559 Similarly, the inbox string is also a regexp. The actual splitting
15560 rules are as before, either a function, or a list with group/regexp or
15561 group/function elements.
15563 Nnmail equivalent: @code{nnmail-split-methods}.
15565 @item nnimap-split-predicate
15567 @vindex nnimap-split-predicate
15569 Mail matching this predicate in @code{nnimap-split-inbox} will be
15570 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
15572 This might be useful if you use another @sc{imap} client to read mail in
15573 your inbox but would like Gnus to split all articles in the inbox
15574 regardless of readedness. Then you might change this to
15577 @item nnimap-split-fancy
15578 @cindex splitting, fancy
15579 @findex nnimap-split-fancy
15580 @vindex nnimap-split-fancy
15582 It's possible to set @code{nnimap-split-rule} to
15583 @code{nnmail-split-fancy} if you want to use fancy
15584 splitting. @xref{Fancy Mail Splitting}.
15586 However, to be able to have different fancy split rules for nnmail and
15587 nnimap back ends you can set @code{nnimap-split-rule} to
15588 @code{nnimap-split-fancy} and define the nnimap specific fancy split
15589 rule in @code{nnimap-split-fancy}.
15594 (setq nnimap-split-rule 'nnimap-split-fancy
15595 nnimap-split-fancy ...)
15598 Nnmail equivalent: @code{nnmail-split-fancy}.
15600 @item nnimap-split-download-body
15601 @findex nnimap-split-download-body
15602 @vindex nnimap-split-download-body
15604 Set to non-nil to download entire articles during splitting. This is
15605 generally not required, and will slow things down considerably. You
15606 may need it if you want to use an advanced splitting function that
15607 analyses the body to split the article.
15611 @node Expiring in IMAP
15612 @subsection Expiring in IMAP
15613 @cindex expiring imap mail
15615 Even though @code{nnimap} is not a proper @code{nnmail} derived back
15616 end, it supports most features in regular expiring (@pxref{Expiring
15617 Mail}). Unlike splitting in IMAP (@pxref{Splitting in IMAP}) it do
15618 not clone the @code{nnmail} variables (i.e., creating
15619 @var{nnimap-expiry-wait}) but reuse the @code{nnmail} variables. What
15620 follows below are the variables used by the @code{nnimap} expiry
15623 A note on how the expire mark is stored on the @sc{imap} server is
15624 appropriate here as well. The expire mark is translated into a
15625 @code{imap} client specific mark, @code{gnus-expire}, and stored on the
15626 message. This means that likely only Gnus will understand and treat
15627 the @code{gnus-expire} mark properly, although other clients may allow
15628 you to view client specific flags on the message. It also means that
15629 your server must support permanent storage of client specific flags on
15630 messages. Most do, fortunately.
15634 @item nnmail-expiry-wait
15635 @item nnmail-expiry-wait-function
15637 These variables are fully supported. The expire value can be a
15638 number, the symbol @var{immediate} or @var{never}.
15640 @item nnmail-expiry-target
15642 This variable is supported, and internally implemented by calling the
15643 @code{nnmail} functions that handle this. It contains an optimization
15644 that if the destination is a IMAP group on the same server, the
15645 article is copied instead of appended (that is, uploaded again).
15649 @node Editing IMAP ACLs
15650 @subsection Editing IMAP ACLs
15651 @cindex editing imap acls
15652 @cindex Access Control Lists
15653 @cindex Editing @sc{imap} ACLs
15655 @findex gnus-group-nnimap-edit-acl
15657 ACL stands for Access Control List. ACLs are used in @sc{imap} for
15658 limiting (or enabling) other users access to your mail boxes. Not all
15659 @sc{imap} servers support this, this function will give an error if it
15662 To edit a ACL for a mailbox, type @kbd{G l}
15663 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with a ACL
15664 editing window with detailed instructions.
15666 Some possible uses:
15670 Giving "anyone" the "lrs" rights (lookup, read, keep seen/unseen flags)
15671 on your mailing list mailboxes enables other users on the same server to
15672 follow the list without subscribing to it.
15674 At least with the Cyrus server, you are required to give the user
15675 "anyone" posting ("p") capabilities to have "plussing" work (that is,
15676 mail sent to user+mailbox@@domain ending up in the @sc{imap} mailbox
15680 @node Expunging mailboxes
15681 @subsection Expunging mailboxes
15685 @cindex Manual expunging
15687 @findex gnus-group-nnimap-expunge
15689 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
15690 you may want the option of expunging all deleted articles in a mailbox
15691 manually. This is exactly what @kbd{G x} does.
15693 Currently there is no way of showing deleted articles, you can just
15696 @node A note on namespaces
15697 @subsection A note on namespaces
15698 @cindex IMAP namespace
15701 The IMAP protocol has a concept called namespaces, described by the
15702 following text in the RFC:
15705 5.1.2. Mailbox Namespace Naming Convention
15707 By convention, the first hierarchical element of any mailbox name
15708 which begins with "#" identifies the "namespace" of the remainder of
15709 the name. This makes it possible to disambiguate between different
15710 types of mailbox stores, each of which have their own namespaces.
15712 For example, implementations which offer access to USENET
15713 newsgroups MAY use the "#news" namespace to partition the USENET
15714 newsgroup namespace from that of other mailboxes. Thus, the
15715 comp.mail.misc newsgroup would have an mailbox name of
15716 "#news.comp.mail.misc", and the name "comp.mail.misc" could refer
15717 to a different object (e.g. a user's private mailbox).
15720 While there is nothing in this text that warrants concern for the IMAP
15721 implementation in Gnus, some servers use namespace prefixes in a way
15722 that does not work with how Gnus uses mailbox names.
15724 Specifically, University of Washington's IMAP server uses mailbox
15725 names like @code{#driver.mbx/read-mail} which are valid only in the
15726 @sc{create} and @sc{append} commands. After the mailbox is created
15727 (or a messages is appended to a mailbox), it must be accessed without
15728 the namespace prefix, i.e @code{read-mail}. Since Gnus do not make it
15729 possible for the user to guarantee that user entered mailbox names
15730 will only be used with the CREATE and APPEND commands, you should
15731 simply not use the namespace prefixed mailbox names in Gnus.
15733 See the UoW @sc{imapd} documentation for the @code{#driver.*/} prefix
15734 for more information on how to use the prefixes. They are a power
15735 tool and should be used only if you are sure what the effects are.
15737 @node Other Sources
15738 @section Other Sources
15740 Gnus can do more than just read news or mail. The methods described
15741 below allow Gnus to view directories and files as if they were
15745 * Directory Groups:: You can read a directory as if it was a newsgroup.
15746 * Anything Groups:: Dired? Who needs dired?
15747 * Document Groups:: Single files can be the basis of a group.
15748 * SOUP:: Reading @sc{soup} packets ``offline''.
15749 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
15753 @node Directory Groups
15754 @subsection Directory Groups
15756 @cindex directory groups
15758 If you have a directory that has lots of articles in separate files in
15759 it, you might treat it as a newsgroup. The files have to have numerical
15762 This might be an opportune moment to mention @code{ange-ftp} (and its
15763 successor @code{efs}), that most wonderful of all wonderful Emacs
15764 packages. When I wrote @code{nndir}, I didn't think much about it---a
15765 back end to read directories. Big deal.
15767 @code{ange-ftp} changes that picture dramatically. For instance, if you
15768 enter the @code{ange-ftp} file name
15769 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
15770 @code{ange-ftp} or @code{efs} will actually allow you to read this
15771 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
15773 @code{nndir} will use @sc{nov} files if they are present.
15775 @code{nndir} is a ``read-only'' back end---you can't delete or expire
15776 articles with this method. You can use @code{nnmh} or @code{nnml} for
15777 whatever you use @code{nndir} for, so you could switch to any of those
15778 methods if you feel the need to have a non-read-only @code{nndir}.
15781 @node Anything Groups
15782 @subsection Anything Groups
15785 From the @code{nndir} back end (which reads a single spool-like
15786 directory), it's just a hop and a skip to @code{nneething}, which
15787 pretends that any arbitrary directory is a newsgroup. Strange, but
15790 When @code{nneething} is presented with a directory, it will scan this
15791 directory and assign article numbers to each file. When you enter such
15792 a group, @code{nneething} must create ``headers'' that Gnus can use.
15793 After all, Gnus is a newsreader, in case you're forgetting.
15794 @code{nneething} does this in a two-step process. First, it snoops each
15795 file in question. If the file looks like an article (i.e., the first
15796 few lines look like headers), it will use this as the head. If this is
15797 just some arbitrary file without a head (e.g. a C source file),
15798 @code{nneething} will cobble up a header out of thin air. It will use
15799 file ownership, name and date and do whatever it can with these
15802 All this should happen automatically for you, and you will be presented
15803 with something that looks very much like a newsgroup. Totally like a
15804 newsgroup, to be precise. If you select an article, it will be displayed
15805 in the article buffer, just as usual.
15807 If you select a line that represents a directory, Gnus will pop you into
15808 a new summary buffer for this @code{nneething} group. And so on. You can
15809 traverse the entire disk this way, if you feel like, but remember that
15810 Gnus is not dired, really, and does not intend to be, either.
15812 There are two overall modes to this action---ephemeral or solid. When
15813 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
15814 will not store information on what files you have read, and what files
15815 are new, and so on. If you create a solid @code{nneething} group the
15816 normal way with @kbd{G m}, Gnus will store a mapping table between
15817 article numbers and file names, and you can treat this group like any
15818 other groups. When you activate a solid @code{nneething} group, you will
15819 be told how many unread articles it contains, etc., etc.
15824 @item nneething-map-file-directory
15825 @vindex nneething-map-file-directory
15826 All the mapping files for solid @code{nneething} groups will be stored
15827 in this directory, which defaults to @file{~/.nneething/}.
15829 @item nneething-exclude-files
15830 @vindex nneething-exclude-files
15831 All files that match this regexp will be ignored. Nice to use to exclude
15832 auto-save files and the like, which is what it does by default.
15834 @item nneething-include-files
15835 @vindex nneething-include-files
15836 Regexp saying what files to include in the group. If this variable is
15837 non-@code{nil}, only files matching this regexp will be included.
15839 @item nneething-map-file
15840 @vindex nneething-map-file
15841 Name of the map files.
15845 @node Document Groups
15846 @subsection Document Groups
15848 @cindex documentation group
15851 @code{nndoc} is a cute little thing that will let you read a single file
15852 as a newsgroup. Several files types are supported:
15859 The babyl (rmail) mail box.
15864 The standard Unix mbox file.
15866 @cindex MMDF mail box
15868 The MMDF mail box format.
15871 Several news articles appended into a file.
15874 @cindex rnews batch files
15875 The rnews batch transport format.
15876 @cindex forwarded messages
15879 Forwarded articles.
15882 Netscape mail boxes.
15885 @sc{mime} multipart messages.
15887 @item standard-digest
15888 The standard (RFC 1153) digest format.
15891 A @sc{mime} digest of messages.
15893 @item lanl-gov-announce
15894 Announcement messages from LANL Gov Announce.
15896 @item rfc822-forward
15897 A message forwarded according to RFC822.
15900 The Outlook mail box.
15903 The Outlook Express dbx mail box.
15906 A bounce message from the Exim MTA.
15909 A message forwarded according to informal rules.
15912 An RFC934-forwarded message.
15918 A digest of Clarinet brief news items.
15921 Non-standard digest format---matches most things, but does it badly.
15927 You can also use the special ``file type'' @code{guess}, which means
15928 that @code{nndoc} will try to guess what file type it is looking at.
15929 @code{digest} means that @code{nndoc} should guess what digest type the
15932 @code{nndoc} will not try to change the file or insert any extra headers into
15933 it---it will simply, like, let you use the file as the basis for a
15934 group. And that's it.
15936 If you have some old archived articles that you want to insert into your
15937 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
15938 that. Say you have an old @file{RMAIL} file with mail that you now want
15939 to split into your new @code{nnml} groups. You look at that file using
15940 @code{nndoc} (using the @kbd{G f} command in the group buffer
15941 (@pxref{Foreign Groups})), set the process mark on all the articles in
15942 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
15943 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
15944 file is now also stored in lots of @code{nnml} directories, and you can
15945 delete that pesky @file{RMAIL} file. If you have the guts!
15947 Virtual server variables:
15950 @item nndoc-article-type
15951 @vindex nndoc-article-type
15952 This should be one of @code{mbox}, @code{babyl}, @code{digest},
15953 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
15954 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
15955 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
15956 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
15958 @item nndoc-post-type
15959 @vindex nndoc-post-type
15960 This variable says whether Gnus is to consider the group a news group or
15961 a mail group. There are two valid values: @code{mail} (the default)
15966 * Document Server Internals:: How to add your own document types.
15970 @node Document Server Internals
15971 @subsubsection Document Server Internals
15973 Adding new document types to be recognized by @code{nndoc} isn't
15974 difficult. You just have to whip up a definition of what the document
15975 looks like, write a predicate function to recognize that document type,
15976 and then hook into @code{nndoc}.
15978 First, here's an example document type definition:
15982 (article-begin . "^\^A\^A\^A\^A\n")
15983 (body-end . "^\^A\^A\^A\^A\n"))
15986 The definition is simply a unique @dfn{name} followed by a series of
15987 regexp pseudo-variable settings. Below are the possible
15988 variables---don't be daunted by the number of variables; most document
15989 types can be defined with very few settings:
15992 @item first-article
15993 If present, @code{nndoc} will skip past all text until it finds
15994 something that match this regexp. All text before this will be
15997 @item article-begin
15998 This setting has to be present in all document type definitions. It
15999 says what the beginning of each article looks like.
16001 @item head-begin-function
16002 If present, this should be a function that moves point to the head of
16005 @item nndoc-head-begin
16006 If present, this should be a regexp that matches the head of the
16009 @item nndoc-head-end
16010 This should match the end of the head of the article. It defaults to
16011 @samp{^$}---the empty line.
16013 @item body-begin-function
16014 If present, this function should move point to the beginning of the body
16018 This should match the beginning of the body of the article. It defaults
16021 @item body-end-function
16022 If present, this function should move point to the end of the body of
16026 If present, this should match the end of the body of the article.
16029 If present, this should match the end of the file. All text after this
16030 regexp will be totally ignored.
16034 So, using these variables @code{nndoc} is able to dissect a document
16035 file into a series of articles, each with a head and a body. However, a
16036 few more variables are needed since not all document types are all that
16037 news-like---variables needed to transform the head or the body into
16038 something that's palatable for Gnus:
16041 @item prepare-body-function
16042 If present, this function will be called when requesting an article. It
16043 will be called with point at the start of the body, and is useful if the
16044 document has encoded some parts of its contents.
16046 @item article-transform-function
16047 If present, this function is called when requesting an article. It's
16048 meant to be used for more wide-ranging transformation of both head and
16049 body of the article.
16051 @item generate-head-function
16052 If present, this function is called to generate a head that Gnus can
16053 understand. It is called with the article number as a parameter, and is
16054 expected to generate a nice head for the article in question. It is
16055 called when requesting the headers of all articles.
16059 Let's look at the most complicated example I can come up with---standard
16064 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
16065 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
16066 (prepare-body-function . nndoc-unquote-dashes)
16067 (body-end-function . nndoc-digest-body-end)
16068 (head-end . "^ ?$")
16069 (body-begin . "^ ?\n")
16070 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
16071 (subtype digest guess))
16074 We see that all text before a 70-width line of dashes is ignored; all
16075 text after a line that starts with that @samp{^End of} is also ignored;
16076 each article begins with a 30-width line of dashes; the line separating
16077 the head from the body may contain a single space; and that the body is
16078 run through @code{nndoc-unquote-dashes} before being delivered.
16080 To hook your own document definition into @code{nndoc}, use the
16081 @code{nndoc-add-type} function. It takes two parameters---the first is
16082 the definition itself and the second (optional) parameter says where in
16083 the document type definition alist to put this definition. The alist is
16084 traversed sequentially, and @code{nndoc-TYPE-type-p} is called for a given type @code{TYPE}. So @code{nndoc-mmdf-type-p} is called to see whether a document
16085 is of @code{mmdf} type, and so on. These type predicates should return
16086 @code{nil} if the document is not of the correct type; @code{t} if it is
16087 of the correct type; and a number if the document might be of the
16088 correct type. A high number means high probability; a low number means
16089 low probability with @samp{0} being the lowest valid number.
16097 In the PC world people often talk about ``offline'' newsreaders. These
16098 are thingies that are combined reader/news transport monstrosities.
16099 With built-in modem programs. Yecchh!
16101 Of course, us Unix Weenie types of human beans use things like
16102 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
16103 transport things like Ghod intended. And then we just use normal
16106 However, it can sometimes be convenient to do something that's a bit
16107 easier on the brain if you have a very slow modem, and you're not really
16108 that interested in doing things properly.
16110 A file format called @sc{soup} has been developed for transporting news
16111 and mail from servers to home machines and back again. It can be a bit
16114 First some terminology:
16119 This is the machine that is connected to the outside world and where you
16120 get news and/or mail from.
16123 This is the machine that you want to do the actual reading and responding
16124 on. It is typically not connected to the rest of the world in any way.
16127 Something that contains messages and/or commands. There are two kinds
16131 @item message packets
16132 These are packets made at the server, and typically contain lots of
16133 messages for you to read. These are called @file{SoupoutX.tgz} by
16134 default, where @var{x} is a number.
16136 @item response packets
16137 These are packets made at the home machine, and typically contains
16138 replies that you've written. These are called @file{SoupinX.tgz} by
16139 default, where @var{x} is a number.
16149 You log in on the server and create a @sc{soup} packet. You can either
16150 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
16151 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
16152 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
16155 You transfer the packet home. Rail, boat, car or modem will do fine.
16158 You put the packet in your home directory.
16161 You fire up Gnus on your home machine using the @code{nnsoup} back end as
16162 the native or secondary server.
16165 You read articles and mail and answer and followup to the things you
16166 want (@pxref{SOUP Replies}).
16169 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
16173 You transfer this packet to the server.
16176 You use Gnus to mail this packet out with the @kbd{G s s} command.
16179 You then repeat until you die.
16183 So you basically have a bipartite system---you use @code{nnsoup} for
16184 reading and Gnus for packing/sending these @sc{soup} packets.
16187 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
16188 * SOUP Groups:: A back end for reading @sc{soup} packets.
16189 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
16193 @node SOUP Commands
16194 @subsubsection SOUP Commands
16196 These are commands for creating and manipulating @sc{soup} packets.
16200 @kindex G s b (Group)
16201 @findex gnus-group-brew-soup
16202 Pack all unread articles in the current group
16203 (@code{gnus-group-brew-soup}). This command understands the
16204 process/prefix convention.
16207 @kindex G s w (Group)
16208 @findex gnus-soup-save-areas
16209 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
16212 @kindex G s s (Group)
16213 @findex gnus-soup-send-replies
16214 Send all replies from the replies packet
16215 (@code{gnus-soup-send-replies}).
16218 @kindex G s p (Group)
16219 @findex gnus-soup-pack-packet
16220 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
16223 @kindex G s r (Group)
16224 @findex nnsoup-pack-replies
16225 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
16228 @kindex O s (Summary)
16229 @findex gnus-soup-add-article
16230 This summary-mode command adds the current article to a @sc{soup} packet
16231 (@code{gnus-soup-add-article}). It understands the process/prefix
16232 convention (@pxref{Process/Prefix}).
16237 There are a few variables to customize where Gnus will put all these
16242 @item gnus-soup-directory
16243 @vindex gnus-soup-directory
16244 Directory where Gnus will save intermediate files while composing
16245 @sc{soup} packets. The default is @file{~/SoupBrew/}.
16247 @item gnus-soup-replies-directory
16248 @vindex gnus-soup-replies-directory
16249 This is what Gnus will use as a temporary directory while sending our
16250 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
16252 @item gnus-soup-prefix-file
16253 @vindex gnus-soup-prefix-file
16254 Name of the file where Gnus stores the last used prefix. The default is
16255 @samp{gnus-prefix}.
16257 @item gnus-soup-packer
16258 @vindex gnus-soup-packer
16259 A format string command for packing a @sc{soup} packet. The default is
16260 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
16262 @item gnus-soup-unpacker
16263 @vindex gnus-soup-unpacker
16264 Format string command for unpacking a @sc{soup} packet. The default is
16265 @samp{gunzip -c %s | tar xvf -}.
16267 @item gnus-soup-packet-directory
16268 @vindex gnus-soup-packet-directory
16269 Where Gnus will look for reply packets. The default is @file{~/}.
16271 @item gnus-soup-packet-regexp
16272 @vindex gnus-soup-packet-regexp
16273 Regular expression matching @sc{soup} reply packets in
16274 @code{gnus-soup-packet-directory}.
16280 @subsubsection SOUP Groups
16283 @code{nnsoup} is the back end for reading @sc{soup} packets. It will
16284 read incoming packets, unpack them, and put them in a directory where
16285 you can read them at leisure.
16287 These are the variables you can use to customize its behavior:
16291 @item nnsoup-tmp-directory
16292 @vindex nnsoup-tmp-directory
16293 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
16294 directory. (@file{/tmp/} by default.)
16296 @item nnsoup-directory
16297 @vindex nnsoup-directory
16298 @code{nnsoup} then moves each message and index file to this directory.
16299 The default is @file{~/SOUP/}.
16301 @item nnsoup-replies-directory
16302 @vindex nnsoup-replies-directory
16303 All replies will be stored in this directory before being packed into a
16304 reply packet. The default is @file{~/SOUP/replies/"}.
16306 @item nnsoup-replies-format-type
16307 @vindex nnsoup-replies-format-type
16308 The @sc{soup} format of the replies packets. The default is @samp{?n}
16309 (rnews), and I don't think you should touch that variable. I probably
16310 shouldn't even have documented it. Drats! Too late!
16312 @item nnsoup-replies-index-type
16313 @vindex nnsoup-replies-index-type
16314 The index type of the replies packet. The default is @samp{?n}, which
16315 means ``none''. Don't fiddle with this one either!
16317 @item nnsoup-active-file
16318 @vindex nnsoup-active-file
16319 Where @code{nnsoup} stores lots of information. This is not an ``active
16320 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
16321 this file or mess it up in any way, you're dead. The default is
16322 @file{~/SOUP/active}.
16324 @item nnsoup-packer
16325 @vindex nnsoup-packer
16326 Format string command for packing a reply @sc{soup} packet. The default
16327 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
16329 @item nnsoup-unpacker
16330 @vindex nnsoup-unpacker
16331 Format string command for unpacking incoming @sc{soup} packets. The
16332 default is @samp{gunzip -c %s | tar xvf -}.
16334 @item nnsoup-packet-directory
16335 @vindex nnsoup-packet-directory
16336 Where @code{nnsoup} will look for incoming packets. The default is
16339 @item nnsoup-packet-regexp
16340 @vindex nnsoup-packet-regexp
16341 Regular expression matching incoming @sc{soup} packets. The default is
16344 @item nnsoup-always-save
16345 @vindex nnsoup-always-save
16346 If non-@code{nil}, save the replies buffer after each posted message.
16352 @subsubsection SOUP Replies
16354 Just using @code{nnsoup} won't mean that your postings and mailings end
16355 up in @sc{soup} reply packets automagically. You have to work a bit
16356 more for that to happen.
16358 @findex nnsoup-set-variables
16359 The @code{nnsoup-set-variables} command will set the appropriate
16360 variables to ensure that all your followups and replies end up in the
16363 In specific, this is what it does:
16366 (setq message-send-news-function 'nnsoup-request-post)
16367 (setq message-send-mail-function 'nnsoup-request-mail)
16370 And that's it, really. If you only want news to go into the @sc{soup}
16371 system you just use the first line. If you only want mail to be
16372 @sc{soup}ed you use the second.
16375 @node Mail-To-News Gateways
16376 @subsection Mail-To-News Gateways
16377 @cindex mail-to-news gateways
16380 If your local @code{nntp} server doesn't allow posting, for some reason
16381 or other, you can post using one of the numerous mail-to-news gateways.
16382 The @code{nngateway} back end provides the interface.
16384 Note that you can't read anything from this back end---it can only be
16390 @item nngateway-address
16391 @vindex nngateway-address
16392 This is the address of the mail-to-news gateway.
16394 @item nngateway-header-transformation
16395 @vindex nngateway-header-transformation
16396 News headers often have to be transformed in some odd way or other
16397 for the mail-to-news gateway to accept it. This variable says what
16398 transformation should be called, and defaults to
16399 @code{nngateway-simple-header-transformation}. The function is called
16400 narrowed to the headers to be transformed and with one parameter---the
16403 This default function just inserts a new @code{To} header based on the
16404 @code{Newsgroups} header and the gateway address.
16405 For instance, an article with this @code{Newsgroups} header:
16408 Newsgroups: alt.religion.emacs
16411 will get this @code{To} header inserted:
16414 To: alt-religion-emacs@@GATEWAY
16417 The following pre-defined functions exist:
16419 @findex nngateway-simple-header-transformation
16422 @item nngateway-simple-header-transformation
16423 Creates a @code{To} header that looks like
16424 @var{newsgroup}@@@code{nngateway-address}.
16426 @findex nngateway-mail2news-header-transformation
16428 @item nngateway-mail2news-header-transformation
16429 Creates a @code{To} header that looks like
16430 @code{nngateway-address}.
16435 (setq gnus-post-method
16437 "mail2news@@replay.com"
16438 (nngateway-header-transformation
16439 nngateway-mail2news-header-transformation)))
16447 So, to use this, simply say something like:
16450 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
16455 @node Combined Groups
16456 @section Combined Groups
16458 Gnus allows combining a mixture of all the other group types into bigger
16462 * Virtual Groups:: Combining articles from many groups.
16463 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
16467 @node Virtual Groups
16468 @subsection Virtual Groups
16470 @cindex virtual groups
16471 @cindex merging groups
16473 An @dfn{nnvirtual group} is really nothing more than a collection of
16476 For instance, if you are tired of reading many small groups, you can
16477 put them all in one big group, and then grow tired of reading one
16478 big, unwieldy group. The joys of computing!
16480 You specify @code{nnvirtual} as the method. The address should be a
16481 regexp to match component groups.
16483 All marks in the virtual group will stick to the articles in the
16484 component groups. So if you tick an article in a virtual group, the
16485 article will also be ticked in the component group from whence it
16486 came. (And vice versa---marks from the component groups will also be
16487 shown in the virtual group.). To create an empty virtual group, run
16488 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
16489 and edit the method regexp with @kbd{M-e}
16490 (@code{gnus-group-edit-group-method})
16492 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
16493 newsgroups into one, big, happy newsgroup:
16496 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
16499 The component groups can be native or foreign; everything should work
16500 smoothly, but if your computer explodes, it was probably my fault.
16502 Collecting the same group from several servers might actually be a good
16503 idea if users have set the Distribution header to limit distribution.
16504 If you would like to read @samp{soc.motss} both from a server in Japan
16505 and a server in Norway, you could use the following as the group regexp:
16508 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
16511 (Remember, though, that if you're creating the group with @kbd{G m}, you
16512 shouldn't double the backslashes, and you should leave off the quote
16513 characters at the beginning and the end of the string.)
16515 This should work kinda smoothly---all articles from both groups should
16516 end up in this one, and there should be no duplicates. Threading (and
16517 the rest) will still work as usual, but there might be problems with the
16518 sequence of articles. Sorting on date might be an option here
16519 (@pxref{Selecting a Group}).
16521 One limitation, however---all groups included in a virtual
16522 group have to be alive (i.e., subscribed or unsubscribed). Killed or
16523 zombie groups can't be component groups for @code{nnvirtual} groups.
16525 @vindex nnvirtual-always-rescan
16526 If the @code{nnvirtual-always-rescan} is non-@code{nil},
16527 @code{nnvirtual} will always scan groups for unread articles when
16528 entering a virtual group. If this variable is @code{nil} (which is the
16529 default) and you read articles in a component group after the virtual
16530 group has been activated, the read articles from the component group
16531 will show up when you enter the virtual group. You'll also see this
16532 effect if you have two virtual groups that have a component group in
16533 common. If that's the case, you should set this variable to @code{t}.
16534 Or you can just tap @code{M-g} on the virtual group every time before
16535 you enter it---it'll have much the same effect.
16537 @code{nnvirtual} can have both mail and news groups as component groups.
16538 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
16539 has to ask the back end of the component group the article comes from
16540 whether it is a news or mail back end. However, when you do a @kbd{^},
16541 there is typically no sure way for the component back end to know this,
16542 and in that case @code{nnvirtual} tells Gnus that the article came from a
16543 not-news back end. (Just to be on the safe side.)
16545 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
16546 line from the article you respond to in these cases.
16548 @code{nnvirtual} groups do not inherit anything but articles and marks
16549 from component groups---group parameters, for instance, are not
16553 @node Kibozed Groups
16554 @subsection Kibozed Groups
16558 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
16559 the news feed''. @code{nnkiboze} is a back end that will do this for
16560 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
16561 with useless requests! Oh happiness!
16563 @kindex G k (Group)
16564 To create a kibozed group, use the @kbd{G k} command in the group
16567 The address field of the @code{nnkiboze} method is, as with
16568 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
16569 @code{nnkiboze} group. That's where most similarities between @code{nnkiboze}
16570 and @code{nnvirtual} end.
16572 In addition to this regexp detailing component groups, an @code{nnkiboze} group
16573 must have a score file to say what articles are to be included in
16574 the group (@pxref{Scoring}).
16576 @kindex M-x nnkiboze-generate-groups
16577 @findex nnkiboze-generate-groups
16578 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
16579 @code{nnkiboze} groups you want to have. This command will take time. Lots of
16580 time. Oodles and oodles of time. Gnus has to fetch the headers from
16581 all the articles in all the component groups and run them through the
16582 scoring process to determine if there are any articles in the groups
16583 that are to be part of the @code{nnkiboze} groups.
16585 Please limit the number of component groups by using restrictive
16586 regexps. Otherwise your sysadmin may become annoyed with you, and the
16587 @sc{nntp} site may throw you off and never let you back in again.
16588 Stranger things have happened.
16590 @code{nnkiboze} component groups do not have to be alive---they can be dead,
16591 and they can be foreign. No restrictions.
16593 @vindex nnkiboze-directory
16594 The generation of an @code{nnkiboze} group means writing two files in
16595 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
16596 contains the @sc{nov} header lines for all the articles in the group,
16597 and the other is an additional @file{.newsrc} file to store information
16598 on what groups have been searched through to find component articles.
16600 Articles marked as read in the @code{nnkiboze} group will have
16601 their @sc{nov} lines removed from the @sc{nov} file.
16604 @node Gnus Unplugged
16605 @section Gnus Unplugged
16610 @cindex Gnus Unplugged
16612 In olden times (ca. February '88), people used to run their newsreaders
16613 on big machines with permanent connections to the net. News transport
16614 was dealt with by news servers, and all the newsreaders had to do was to
16615 read news. Believe it or not.
16617 Nowadays most people read news and mail at home, and use some sort of
16618 modem to connect to the net. To avoid running up huge phone bills, it
16619 would be nice to have a way to slurp down all the news and mail, hang up
16620 the phone, read for several hours, and then upload any responses you
16621 have to make. And then you repeat the procedure.
16623 Of course, you can use news servers for doing this as well. I've used
16624 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
16625 for some years, but doing that's a bore. Moving the news server
16626 functionality up to the newsreader makes sense if you're the only person
16627 reading news on a machine.
16629 Setting up Gnus as an ``offline'' newsreader is quite simple. In
16630 fact, you don't even have to configure anything.
16632 Of course, to use it as such, you have to learn a few new commands.
16635 * Agent Basics:: How it all is supposed to work.
16636 * Agent Categories:: How to tell the Gnus Agent what to download.
16637 * Agent Commands:: New commands for all the buffers.
16638 * Agent as Cache:: The Agent is a big cache too.
16639 * Agent Expiry:: How to make old articles go away.
16640 * Agent Regeneration:: How to recover from lost connections and other accidents.
16641 * Agent and IMAP:: How to use the Agent with IMAP.
16642 * Outgoing Messages:: What happens when you post/mail something?
16643 * Agent Variables:: Customizing is fun.
16644 * Example Setup:: An example @file{.gnus.el} file for offline people.
16645 * Batching Agents:: How to fetch news from a @code{cron} job.
16646 * Agent Caveats:: What you think it'll do and what it does.
16651 @subsection Agent Basics
16653 First, let's get some terminology out of the way.
16655 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
16656 connection to the net (and notified the Agent that this is the case).
16657 When the connection to the net is up again (and Gnus knows this), the
16658 Agent is @dfn{plugged}.
16660 The @dfn{local} machine is the one you're running on, and which isn't
16661 connected to the net continuously.
16663 @dfn{Downloading} means fetching things from the net to your local
16664 machine. @dfn{Uploading} is doing the opposite.
16666 Let's take a typical Gnus session using the Agent.
16671 @findex gnus-unplugged
16672 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
16673 Agent in a disconnected state. You can read all the news that you have
16674 already fetched while in this mode.
16677 You then decide to see whether any new news has arrived. You connect
16678 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
16679 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
16680 as usual. To check for new mail in unplugged mode, see (@pxref{Mail
16681 Source Specifiers}).
16684 You can then read the new news immediately, or you can download the news
16685 onto your local machine. If you want to do the latter, you press @kbd{g}
16686 to check if there are any new news and then @kbd{J
16687 s} to fetch all the eligible articles in all the groups. (To let Gnus
16688 know which articles you want to download, @pxref{Agent Categories}.)
16691 After fetching the articles, you press @kbd{J j} to make Gnus become
16692 unplugged again, and you shut down the PPP thing (or whatever). And
16693 then you read the news offline.
16696 And then you go to step 2.
16699 Here are some things you should do the first time (or so) that you use
16705 Decide which servers should be covered by the Agent. If you have a mail
16706 back end, it would probably be nonsensical to have it covered by the
16707 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
16708 @kbd{J a} on the server (or servers) that you wish to have covered by the
16709 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
16710 added servers you do not wish to have covered by the Agent. By default,
16711 all @code{nntp} and @code{nnimap} groups in @code{gnus-select-method} and
16712 @code{gnus-secondary-select-methods} are agentized.
16715 Decide on download policy. @xref{Agent Categories}.
16722 @node Agent Categories
16723 @subsection Agent Categories
16725 One of the main reasons to integrate the news transport layer into the
16726 newsreader is to allow greater control over what articles to download.
16727 There's not much point in downloading huge amounts of articles, just to
16728 find out that you're not interested in reading any of them. It's better
16729 to be somewhat more conservative in choosing what to download, and then
16730 mark the articles for downloading manually if it should turn out that
16731 you're interested in the articles anyway.
16733 The main way to control what is to be downloaded is to create a
16734 @dfn{category} and then assign some (or all) groups to this category.
16735 Groups that do not belong in any other category belong to the
16736 @code{default} category. Gnus has its own buffer for creating and
16737 managing categories.
16740 * Category Syntax:: What a category looks like.
16741 * Category Buffer:: A buffer for maintaining categories.
16742 * Category Variables:: Customize'r'Us.
16746 @node Category Syntax
16747 @subsubsection Category Syntax
16749 A category consists of two things.
16753 A predicate which (generally) gives a rough outline of which articles
16754 are eligible for downloading; and
16757 a score rule which (generally) gives you a finer granularity when
16758 deciding what articles to download. (Note that this @dfn{download
16759 score} is not necessarily related to normal scores.)
16762 A predicate in its simplest form can be a single predicate such as
16763 @code{true} or @code{false}. These two will download every available
16764 article or nothing respectively. In the case of these two special
16765 predicates an additional score rule is superfluous.
16767 Predicates of @code{high} or @code{low} download articles in respect of
16768 their scores in relationship to @code{gnus-agent-high-score} and
16769 @code{gnus-agent-low-score} as described below.
16771 To gain even finer control of what is to be regarded eligible for
16772 download a predicate can consist of a number of predicates with logical
16773 operators sprinkled in between.
16775 Perhaps some examples are in order.
16777 Here's a simple predicate. (It's the default predicate, in fact, used
16778 for all groups that don't belong to any other category.)
16784 Quite simple, eh? This predicate is true if and only if the article is
16785 short (for some value of ``short'').
16787 Here's a more complex predicate:
16796 This means that an article should be downloaded if it has a high score,
16797 or if the score is not low and the article is not long. You get the
16800 The available logical operators are @code{or}, @code{and} and
16801 @code{not}. (If you prefer, you can use the more ``C''-ish operators
16802 @samp{|}, @code{&} and @code{!} instead.)
16804 The following predicates are pre-defined, but if none of these fit what
16805 you want to do, you can write your own.
16809 True iff the article is shorter than @code{gnus-agent-short-article}
16810 lines; default 100.
16813 True iff the article is longer than @code{gnus-agent-long-article}
16814 lines; default 200.
16817 True iff the article has a download score less than
16818 @code{gnus-agent-low-score}; default 0.
16821 True iff the article has a download score greater than
16822 @code{gnus-agent-high-score}; default 0.
16825 True iff the Gnus Agent guesses that the article is spam. The
16826 heuristics may change over time, but at present it just computes a
16827 checksum and sees whether articles match.
16836 If you want to create your own predicate function, here's what you have
16837 to know: The functions are called with no parameters, but the
16838 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
16841 For example, you could decide that you don't want to download articles
16842 that were posted more than a certain number of days ago (e.g. posted
16843 more than @code{gnus-agent-expire-days} ago) you might write a function
16844 something along the lines of the following:
16847 (defun my-article-old-p ()
16848 "Say whether an article is old."
16849 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
16850 (- (time-to-days (current-time)) gnus-agent-expire-days)))
16853 with the predicate then defined as:
16856 (not my-article-old-p)
16859 or you could append your predicate to the predefined
16860 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
16864 (require 'gnus-agent)
16865 (setq gnus-category-predicate-alist
16866 (append gnus-category-predicate-alist
16867 '((old . my-article-old-p))))
16870 and simply specify your predicate as:
16876 If/when using something like the above, be aware that there are many
16877 misconfigured systems/mailers out there and so an article's date is not
16878 always a reliable indication of when it was posted. Hell, some people
16879 just don't give a damn.
16881 The above predicates apply to *all* the groups which belong to the
16882 category. However, if you wish to have a specific predicate for an
16883 individual group within a category, or you're just too lazy to set up a
16884 new category, you can enter a group's individual predicate in it's group
16885 parameters like so:
16888 (agent-predicate . short)
16891 This is the group parameter equivalent of the agent category default.
16892 Note that when specifying a single word predicate like this, the
16893 @code{agent-predicate} specification must be in dotted pair notation.
16895 The equivalent of the longer example from above would be:
16898 (agent-predicate or high (and (not low) (not long)))
16901 The outer parenthesis required in the category specification are not
16902 entered here as, not being in dotted pair notation, the value of the
16903 predicate is assumed to be a list.
16906 Now, the syntax of the download score is the same as the syntax of
16907 normal score files, except that all elements that require actually
16908 seeing the article itself are verboten. This means that only the
16909 following headers can be scored on: @code{Subject}, @code{From},
16910 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
16911 @code{Lines}, and @code{Xref}.
16913 As with predicates, the specification of the @code{download score rule}
16914 to use in respect of a group can be in either the category definition if
16915 it's to be applicable to all groups in therein, or a group's parameters
16916 if it's to be specific to that group.
16918 In both of these places the @code{download score rule} can take one of
16925 This has the same syntax as a normal gnus score file except only a
16926 subset of scoring keywords are available as mentioned above.
16932 Category specification
16936 ("Lars Ingebrigtsen" 1000000 nil s))
16942 Group Parameter specification
16945 (agent-score ("from"
16946 ("Lars Ingebrigtsen" 1000000 nil s))
16951 Again, note the omission of the outermost parenthesis here.
16957 These score files must *only* contain the permitted scoring keywords
16964 Category specification
16967 ("~/News/agent.SCORE")
16973 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
16977 Group Parameter specification
16980 (agent-score "~/News/agent.SCORE")
16983 Additional score files can be specified as above. Need I say anything
16988 Use @code{normal} score files
16990 If you don't want to maintain two sets of scoring rules for a group, and
16991 your desired @code{downloading} criteria for a group are the same as your
16992 @code{reading} criteria then you can tell the agent to refer to your
16993 @code{normal} score files when deciding what to download.
16995 These directives in either the category definition or a group's
16996 parameters will cause the agent to read in all the applicable score
16997 files for a group, *filtering out* those sections that do not
16998 relate to one of the permitted subset of scoring keywords.
17002 Category Specification
17009 Group Parameter specification
17012 (agent-score . file)
17017 @node Category Buffer
17018 @subsubsection Category Buffer
17020 You'd normally do all category maintenance from the category buffer.
17021 When you enter it for the first time (with the @kbd{J c} command from
17022 the group buffer), you'll only see the @code{default} category.
17024 The following commands are available in this buffer:
17028 @kindex q (Category)
17029 @findex gnus-category-exit
17030 Return to the group buffer (@code{gnus-category-exit}).
17033 @kindex k (Category)
17034 @findex gnus-category-kill
17035 Kill the current category (@code{gnus-category-kill}).
17038 @kindex c (Category)
17039 @findex gnus-category-copy
17040 Copy the current category (@code{gnus-category-copy}).
17043 @kindex a (Category)
17044 @findex gnus-category-add
17045 Add a new category (@code{gnus-category-add}).
17048 @kindex p (Category)
17049 @findex gnus-category-edit-predicate
17050 Edit the predicate of the current category
17051 (@code{gnus-category-edit-predicate}).
17054 @kindex g (Category)
17055 @findex gnus-category-edit-groups
17056 Edit the list of groups belonging to the current category
17057 (@code{gnus-category-edit-groups}).
17060 @kindex s (Category)
17061 @findex gnus-category-edit-score
17062 Edit the download score rule of the current category
17063 (@code{gnus-category-edit-score}).
17066 @kindex l (Category)
17067 @findex gnus-category-list
17068 List all the categories (@code{gnus-category-list}).
17072 @node Category Variables
17073 @subsubsection Category Variables
17076 @item gnus-category-mode-hook
17077 @vindex gnus-category-mode-hook
17078 Hook run in category buffers.
17080 @item gnus-category-line-format
17081 @vindex gnus-category-line-format
17082 Format of the lines in the category buffer (@pxref{Formatting
17083 Variables}). Valid elements are:
17087 The name of the category.
17090 The number of groups in the category.
17093 @item gnus-category-mode-line-format
17094 @vindex gnus-category-mode-line-format
17095 Format of the category mode line (@pxref{Mode Line Formatting}).
17097 @item gnus-agent-short-article
17098 @vindex gnus-agent-short-article
17099 Articles that have fewer lines than this are short. Default 100.
17101 @item gnus-agent-long-article
17102 @vindex gnus-agent-long-article
17103 Articles that have more lines than this are long. Default 200.
17105 @item gnus-agent-low-score
17106 @vindex gnus-agent-low-score
17107 Articles that have a score lower than this have a low score. Default
17110 @item gnus-agent-high-score
17111 @vindex gnus-agent-high-score
17112 Articles that have a score higher than this have a high score. Default
17118 @node Agent Commands
17119 @subsection Agent Commands
17120 @findex gnus-agent-toggle-plugged
17121 @kindex J j (Agent)
17123 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
17124 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
17125 toggles the plugged/unplugged state of the Gnus Agent.
17129 * Group Agent Commands:: Configure groups and fetch their contents.
17130 * Summary Agent Commands:: Manually select then fetch specific articles.
17131 * Server Agent Commands:: Select the servers that are supported by the agent.
17137 @node Group Agent Commands
17138 @subsubsection Group Agent Commands
17142 @kindex J u (Agent Group)
17143 @findex gnus-agent-fetch-groups
17144 Fetch all eligible articles in the current group
17145 (@code{gnus-agent-fetch-groups}).
17148 @kindex J c (Agent Group)
17149 @findex gnus-enter-category-buffer
17150 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
17153 @kindex J s (Agent Group)
17154 @findex gnus-agent-fetch-session
17155 Fetch all eligible articles in all groups
17156 (@code{gnus-agent-fetch-session}).
17159 @kindex J S (Agent Group)
17160 @findex gnus-group-send-queue
17161 Send all sendable messages in the queue group
17162 (@code{gnus-group-send-queue}). @xref{Drafts}.
17165 @kindex J a (Agent Group)
17166 @findex gnus-agent-add-group
17167 Add the current group to an Agent category
17168 (@code{gnus-agent-add-group}). This command understands the
17169 process/prefix convention (@pxref{Process/Prefix}).
17172 @kindex J r (Agent Group)
17173 @findex gnus-agent-remove-group
17174 Remove the current group from its category, if any
17175 (@code{gnus-agent-remove-group}). This command understands the
17176 process/prefix convention (@pxref{Process/Prefix}).
17179 @kindex J Y (Agent Group)
17180 @findex gnus-agent-synchronize-flags
17181 Synchronize flags changed while unplugged with remote server, if any.
17187 @node Summary Agent Commands
17188 @subsubsection Summary Agent Commands
17192 @kindex J # (Agent Summary)
17193 @findex gnus-agent-mark-article
17194 Mark the article for downloading (@code{gnus-agent-mark-article}).
17197 @kindex J M-# (Agent Summary)
17198 @findex gnus-agent-unmark-article
17199 Remove the downloading mark from the article
17200 (@code{gnus-agent-unmark-article}).
17204 @kindex @@ (Agent Summary)
17205 @findex gnus-agent-toggle-mark
17206 Toggle whether to download the article
17207 (@code{gnus-agent-toggle-mark}). The dowload mark is @samp{%} by
17211 @kindex J c (Agent Summary)
17212 @findex gnus-agent-catchup
17213 Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable.
17216 @kindex J S (Agent Summary)
17217 @findex gnus-agent-fetch-group
17218 Download all eligible (See @pxref{Agent Categories}) articles in this group.
17219 (@code{gnus-agent-fetch-group}).
17222 @kindex J s (Agent Summary)
17223 @findex gnus-agent-fetch-series
17224 Download all processable articles in this group.
17225 (@code{gnus-agent-fetch-series}).
17228 @kindex J u (Agent Summary)
17229 @findex gnus-agent-summary-fetch-group
17230 Download all downloadable articles in the current group
17231 (@code{gnus-agent-summary-fetch-group}).
17236 @node Server Agent Commands
17237 @subsubsection Server Agent Commands
17241 @kindex J a (Agent Server)
17242 @findex gnus-agent-add-server
17243 Add the current server to the list of servers covered by the Gnus Agent
17244 (@code{gnus-agent-add-server}).
17247 @kindex J r (Agent Server)
17248 @findex gnus-agent-remove-server
17249 Remove the current server from the list of servers covered by the Gnus
17250 Agent (@code{gnus-agent-remove-server}).
17255 @node Agent as Cache
17256 @subsection Agent as Cache
17258 When Gnus is plugged, it is not efficient to download headers or
17259 articles from the server again, if they are already stored in the
17260 Agent. So, Gnus normally only downloads headers once, and stores them
17261 in the Agent. These headers are later used when generating the summary
17262 buffer, regardless of whether you are plugged or unplugged. Articles
17263 are not cached in the Agent by default though (that would potentially
17264 consume lots of disk space), but if you have already downloaded an
17265 article into the Agent, Gnus will not download the article from the
17266 server again but use the locally stored copy instead.
17268 This behaviour can be controlled by @code{gnus-agent-cache}
17269 (@pxref{Agent Variables}).
17272 @subsection Agent Expiry
17274 @vindex gnus-agent-expire-days
17275 @findex gnus-agent-expire
17276 @kindex M-x gnus-agent-expire
17277 @cindex Agent expiry
17278 @cindex Gnus Agent expiry
17281 @code{nnagent} doesn't handle expiry. Instead, there's a special
17282 @code{gnus-agent-expire} command that will expire all read articles that
17283 are older than @code{gnus-agent-expire-days} days. It can be run
17284 whenever you feel that you're running out of space. It's not
17285 particularly fast or efficient, and it's not a particularly good idea to
17286 interrupt it (with @kbd{C-g} or anything else) once you've started it.
17288 Note that other functions, e.g. @code{gnus-request-expire-articles},
17289 might run @code{gnus-agent-expire} for you to keep the agent
17290 synchronized with the group.
17292 @code{gnus-agent-expire-days} can also be a list of regexp/day pairs.
17293 The regexps will be matched against group names to allow differing
17294 expiry in different groups.
17297 (setq gnus-agent-expire-days
17303 If you use the list form, the last element must always be the default
17304 method---it must always match all groups. Also, for a regexp to match,
17305 it must match from the beginning of the group's name.
17307 @vindex gnus-agent-expire-all
17308 If @code{gnus-agent-expire-all} is non-@code{nil}, this command will
17309 expire all articles---unread, read, ticked and dormant. If @code{nil}
17310 (which is the default), only read articles are eligible for expiry, and
17311 unread, ticked and dormant articles will be kept indefinitely.
17313 If you find that some articles eligible for expiry are never expired,
17314 perhaps some Gnus Agent files are corrupted. There's a special
17315 @code{gnus-agent-regenerate} command to fix possible problems.
17317 @node Agent Regeneration
17318 @subsection Agent Regeneration
17320 @cindex Agent Regeneration
17321 @cindex Gnus Agent Regeneration
17322 @cindex regeneration
17324 The local data structures used by @code{nnagent} may become corrupted
17325 due to certain exceptional conditions. When this happens,
17326 @code{nnagent} functionality may degrade or even fail. The solution
17327 to this problem is to repair the local data structures by removing all
17328 internal inconsistencies.
17330 For example, if your connection to your server is lost while
17331 downloaded articles into the agent, the local data structures will not
17332 know about articles downloaded prior to the connection failure.
17333 Running @code{gnus-agent-regenerate} or
17334 @code{gnus-agent-regenerate-group} will update the data structures
17335 such that you don't need to download these articles a second time.
17337 @findex gnus-agent-regenerate
17338 @kindex M-x gnus-agent-regenerate
17339 The command @code{gnus-agent-regenerate} will perform
17340 @code{gnus-agent-regenerate-group} on every agentized group. While
17341 you can run @code{gnus-agent-regenerate} in any buffer, it is strongly
17342 recommended that you first close all summary buffers.
17344 @findex gnus-agent-regenerate-group
17345 @kindex M-x gnus-agent-regenerate-group
17346 The command @code{gnus-agent-regenerate-group} uses the local copies
17347 of individual articles to repair the local NOV(header) database. It
17348 then updates the internal data structures that document which articles
17349 are stored locally. An optional argument will mark articles in the
17352 @node Agent and IMAP
17353 @subsection Agent and IMAP
17355 The Agent works with any Gnus back end, including nnimap. However,
17356 since there are some conceptual differences between @sc{nntp} and
17357 @sc{imap}, this section (should) provide you with some information to
17358 make Gnus Agent work smoother as a @sc{imap} Disconnected Mode client.
17360 The first thing to keep in mind is that all flags (read, ticked, etc)
17361 are kept on the @sc{imap} server, rather than in @file{.newsrc} as is the
17362 case for nntp. Thus Gnus need to remember flag changes when
17363 disconnected, and synchronize these flags when you plug back in.
17365 Gnus keeps track of flag changes when reading nnimap groups under the
17366 Agent. When you plug back in, Gnus will check if you have any changed
17367 any flags and ask if you wish to synchronize these with the server.
17368 The behavior is customizable by @code{gnus-agent-synchronize-flags}.
17370 @vindex gnus-agent-synchronize-flags
17371 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
17372 never automatically synchronize flags. If it is @code{ask}, which is
17373 the default, the Agent will check if you made any changes and if so
17374 ask if you wish to synchronize these when you re-connect. If it has
17375 any other value, all flags will be synchronized automatically.
17377 If you do not wish to synchronize flags automatically when you
17378 re-connect, you can do it manually with the
17379 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
17380 in the group buffer.
17382 Some things are currently not implemented in the Agent that you'd might
17383 expect from a disconnected @sc{imap} client, including:
17388 Copying/moving articles into nnimap groups when unplugged.
17391 Creating/deleting nnimap groups when unplugged.
17395 Technical note: the synchronization algorithm does not work by "pushing"
17396 all local flags to the server, but rather incrementally update the
17397 server view of flags by changing only those flags that were changed by
17398 the user. Thus, if you set one flag on a article, quit the group and
17399 re-select the group and remove the flag; the flag will be set and
17400 removed from the server when you "synchronize". The queued flag
17401 operations can be found in the per-server @code{flags} file in the Agent
17402 directory. It's emptied when you synchronize flags.
17405 @node Outgoing Messages
17406 @subsection Outgoing Messages
17408 When Gnus is unplugged, all outgoing messages (both mail and news) are
17409 stored in the draft group ``queue'' (@pxref{Drafts}). You can view
17410 them there after posting, and edit them at will.
17412 When Gnus is plugged again, you can send the messages either from the
17413 draft group with the special commands available there, or you can use
17414 the @kbd{J S} command in the group buffer to send all the sendable
17415 messages in the draft group.
17419 @node Agent Variables
17420 @subsection Agent Variables
17423 @item gnus-agent-directory
17424 @vindex gnus-agent-directory
17425 Where the Gnus Agent will store its files. The default is
17426 @file{~/News/agent/}.
17428 @item gnus-agent-handle-level
17429 @vindex gnus-agent-handle-level
17430 Groups on levels (@pxref{Group Levels}) higher than this variable will
17431 be ignored by the Agent. The default is @code{gnus-level-subscribed},
17432 which means that only subscribed group will be considered by the Agent
17435 @item gnus-agent-plugged-hook
17436 @vindex gnus-agent-plugged-hook
17437 Hook run when connecting to the network.
17439 @item gnus-agent-unplugged-hook
17440 @vindex gnus-agent-unplugged-hook
17441 Hook run when disconnecting from the network.
17443 @item gnus-agent-fetched-hook
17444 @vindex gnus-agent-fetched-hook
17445 Hook run when after finishing fetching articles.
17447 @item gnus-agent-cache
17448 @vindex gnus-agent-cache
17449 Variable to control whether use the locally stored @sc{nov} and
17450 articles when plugged, e.g. essentially using the Agent as a cache.
17451 The default is non-nil, which means to use the Agent as a cache.
17453 @item gnus-agent-go-online
17454 @vindex gnus-agent-go-online
17455 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
17456 automatically switch offline servers into online status. If it is
17457 @code{ask}, the default, the Agent will ask if you wish to switch
17458 offline servers into online status when you re-connect. If it has any
17459 other value, all offline servers will be automatically switched into
17462 @item gnus-agent-mark-unread-after-downloaded
17463 @vindex gnus-agent-mark-unread-after-downloaded
17464 If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil},
17465 mark articles as unread after downloading. The default is t.
17467 @item gnus-agent-consider-all-articles
17468 @vindex gnus-agent-consider-all-articles
17469 If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the
17470 agent will fetch all missing headers. When @code{nil}, the agent will
17471 fetch only new headers. The default is @code{nil}.
17473 @item gnus-agent-max-fetch-size
17474 @vindex gnus-agent-max-fetch-size
17475 The agent fetches articles into a temporary buffer prior to parsing
17476 them into individual files. To avoid exceeding the max. buffer size,
17477 the agent alternates between fetching and parsing until all articles
17478 have been fetched. @code{gnus-agent-max-fetch-size} provides a size
17479 limit to control how often the cycling occurs. A large value improves
17480 performance. A small value minimizes the time lost should the
17481 connection be lost while fetching (You may need to run
17482 @code{gnus-agent-regenerate-group} to update the group's state.
17483 However, all articles parsed prior to loosing the connection will be
17484 available while unplugged).
17486 @item gnus-server-unopen-status
17487 @vindex gnus-server-unopen-status
17488 Perhaps not a Agent variable, but closely related to the Agent, this
17489 variable says what will happen if Gnus cannot open a server. If the
17490 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
17491 whether to deny the server or whether to unplug the agent. If the
17492 Agent is disabled, Gnus always simply deny the server. Other choices
17493 for this variable include @code{denied} and @code{offline} the latter
17494 is only valid if the Agent is used.
17499 @node Example Setup
17500 @subsection Example Setup
17502 If you don't want to read this manual, and you have a fairly standard
17503 setup, you may be able to use something like the following as your
17504 @file{.gnus.el} file to get started.
17507 ;;; Define how Gnus is to fetch news. We do this over @sc{nntp}
17508 ;;; from your ISP's server.
17509 (setq gnus-select-method '(nntp "news.your-isp.com"))
17511 ;;; Define how Gnus is to read your mail. We read mail from
17512 ;;; your ISP's POP server.
17513 (setq mail-sources '((pop :server "pop.your-isp.com")))
17515 ;;; Say how Gnus is to store the mail. We use nnml groups.
17516 (setq gnus-secondary-select-methods '((nnml "")))
17518 ;;; Make Gnus into an offline newsreader.
17519 ;;; (gnus-agentize) ; The obsolete setting.
17520 ;;; (setq gnus-agent t) ; Now the default.
17523 That should be it, basically. Put that in your @file{~/.gnus.el} file,
17524 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
17527 If this is the first time you've run Gnus, you will be subscribed
17528 automatically to a few default newsgroups. You'll probably want to
17529 subscribe to more groups, and to do that, you have to query the
17530 @sc{nntp} server for a complete list of groups with the @kbd{A A}
17531 command. This usually takes quite a while, but you only have to do it
17534 After reading and parsing a while, you'll be presented with a list of
17535 groups. Subscribe to the ones you want to read with the @kbd{u}
17536 command. @kbd{l} to make all the killed groups disappear after you've
17537 subscribe to all the groups you want to read. (@kbd{A k} will bring
17538 back all the killed groups.)
17540 You can now read the groups at once, or you can download the articles
17541 with the @kbd{J s} command. And then read the rest of this manual to
17542 find out which of the other gazillion things you want to customize.
17545 @node Batching Agents
17546 @subsection Batching Agents
17547 @findex gnus-agent-batch
17549 Having the Gnus Agent fetch articles (and post whatever messages you've
17550 written) is quite easy once you've gotten things set up properly. The
17551 following shell script will do everything that is necessary:
17553 You can run a complete batch command from the command line with the
17554 following incantation:
17558 emacs -batch -l ~/.emacs -f -l ~/.gnus.el gnus-agent-batch >/dev/null 2>&1
17562 @node Agent Caveats
17563 @subsection Agent Caveats
17565 The Gnus Agent doesn't seem to work like most other offline
17566 newsreaders. Here are some common questions that some imaginary people
17570 @item If I read an article while plugged, do they get entered into the Agent?
17572 @strong{No}. If you want this behaviour, add
17573 @code{gnus-agent-fetch-selected-article} to
17574 @code{gnus-select-article-hook}.
17576 @item If I read an article while plugged, and the article already exists in the Agent, will it get downloaded once more?
17578 @strong{No}, unless @code{gnus-agent-cache} is `nil'.
17582 In short, when Gnus is unplugged, it only looks into the locally stored
17583 articles; when it's plugged, it talks to your ISP and may also use the
17584 locally stored articles.
17591 Other people use @dfn{kill files}, but we here at Gnus Towers like
17592 scoring better than killing, so we'd rather switch than fight. They do
17593 something completely different as well, so sit up straight and pay
17596 @vindex gnus-summary-mark-below
17597 All articles have a default score (@code{gnus-summary-default-score}),
17598 which is 0 by default. This score may be raised or lowered either
17599 interactively or by score files. Articles that have a score lower than
17600 @code{gnus-summary-mark-below} are marked as read.
17602 Gnus will read any @dfn{score files} that apply to the current group
17603 before generating the summary buffer.
17605 There are several commands in the summary buffer that insert score
17606 entries based on the current article. You can, for instance, ask Gnus to
17607 lower or increase the score of all articles with a certain subject.
17609 There are two sorts of scoring entries: Permanent and temporary.
17610 Temporary score entries are self-expiring entries. Any entries that are
17611 temporary and have not been used for, say, a week, will be removed
17612 silently to help keep the sizes of the score files down.
17615 * Summary Score Commands:: Adding score entries for the current group.
17616 * Group Score Commands:: General score commands.
17617 * Score Variables:: Customize your scoring. (My, what terminology).
17618 * Score File Format:: What a score file may contain.
17619 * Score File Editing:: You can edit score files by hand as well.
17620 * Adaptive Scoring:: Big Sister Gnus knows what you read.
17621 * Home Score File:: How to say where new score entries are to go.
17622 * Followups To Yourself:: Having Gnus notice when people answer you.
17623 * Scoring On Other Headers:: Scoring on non-standard headers.
17624 * Scoring Tips:: How to score effectively.
17625 * Reverse Scoring:: That problem child of old is not problem.
17626 * Global Score Files:: Earth-spanning, ear-splitting score files.
17627 * Kill Files:: They are still here, but they can be ignored.
17628 * Converting Kill Files:: Translating kill files to score files.
17629 * GroupLens:: Getting predictions on what you like to read.
17630 * Advanced Scoring:: Using logical expressions to build score rules.
17631 * Score Decays:: It can be useful to let scores wither away.
17635 @node Summary Score Commands
17636 @section Summary Score Commands
17637 @cindex score commands
17639 The score commands that alter score entries do not actually modify real
17640 score files. That would be too inefficient. Gnus maintains a cache of
17641 previously loaded score files, one of which is considered the
17642 @dfn{current score file alist}. The score commands simply insert
17643 entries into this list, and upon group exit, this list is saved.
17645 The current score file is by default the group's local score file, even
17646 if no such score file actually exists. To insert score commands into
17647 some other score file (e.g. @file{all.SCORE}), you must first make this
17648 score file the current one.
17650 General score commands that don't actually change the score file:
17655 @kindex V s (Summary)
17656 @findex gnus-summary-set-score
17657 Set the score of the current article (@code{gnus-summary-set-score}).
17660 @kindex V S (Summary)
17661 @findex gnus-summary-current-score
17662 Display the score of the current article
17663 (@code{gnus-summary-current-score}).
17666 @kindex V t (Summary)
17667 @findex gnus-score-find-trace
17668 Display all score rules that have been used on the current article
17669 (@code{gnus-score-find-trace}).
17672 @kindex V w (Summary)
17673 @findex gnus-score-find-favourite-words
17674 List words used in scoring (@code{gnus-score-find-favourite-words}).
17677 @kindex V R (Summary)
17678 @findex gnus-summary-rescore
17679 Run the current summary through the scoring process
17680 (@code{gnus-summary-rescore}). This might be useful if you're playing
17681 around with your score files behind Gnus' back and want to see the
17682 effect you're having.
17685 @kindex V c (Summary)
17686 @findex gnus-score-change-score-file
17687 Make a different score file the current
17688 (@code{gnus-score-change-score-file}).
17691 @kindex V e (Summary)
17692 @findex gnus-score-edit-current-scores
17693 Edit the current score file (@code{gnus-score-edit-current-scores}).
17694 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
17698 @kindex V f (Summary)
17699 @findex gnus-score-edit-file
17700 Edit a score file and make this score file the current one
17701 (@code{gnus-score-edit-file}).
17704 @kindex V F (Summary)
17705 @findex gnus-score-flush-cache
17706 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
17707 after editing score files.
17710 @kindex V C (Summary)
17711 @findex gnus-score-customize
17712 Customize a score file in a visually pleasing manner
17713 (@code{gnus-score-customize}).
17717 The rest of these commands modify the local score file.
17722 @kindex V m (Summary)
17723 @findex gnus-score-set-mark-below
17724 Prompt for a score, and mark all articles with a score below this as
17725 read (@code{gnus-score-set-mark-below}).
17728 @kindex V x (Summary)
17729 @findex gnus-score-set-expunge-below
17730 Prompt for a score, and add a score rule to the current score file to
17731 expunge all articles below this score
17732 (@code{gnus-score-set-expunge-below}).
17735 The keystrokes for actually making score entries follow a very regular
17736 pattern, so there's no need to list all the commands. (Hundreds of
17739 @findex gnus-summary-increase-score
17740 @findex gnus-summary-lower-score
17744 The first key is either @kbd{I} (upper case i) for increasing the score
17745 or @kbd{L} for lowering the score.
17747 The second key says what header you want to score on. The following
17748 keys are available:
17752 Score on the author name.
17755 Score on the subject line.
17758 Score on the @code{Xref} line---i.e., the cross-posting line.
17761 Score on the @code{References} line.
17767 Score on the number of lines.
17770 Score on the @code{Message-ID} header.
17773 Score on an "extra" header, that is, one of those in gnus-extra-headers,
17774 if your @sc{nntp} server tracks additional header data in overviews.
17777 Score on followups---this matches the author name, and adds scores to
17778 the followups to this author. (Using this key leads to the creation of
17779 @file{ADAPT} files.)
17788 Score on thread. (Using this key leads to the creation of @file{ADAPT}
17794 The third key is the match type. Which match types are valid depends on
17795 what headers you are scoring on.
17807 Substring matching.
17810 Fuzzy matching (@pxref{Fuzzy Matching}).
17839 Greater than number.
17844 The fourth and usually final key says whether this is a temporary (i.e.,
17845 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
17846 or whether it is to be done immediately, without adding to the score
17851 Temporary score entry.
17854 Permanent score entry.
17857 Immediately scoring.
17861 If you are scoring on `e' (extra) headers, you will then be prompted for
17862 the header name on which you wish to score. This must be a header named
17863 in gnus-extra-headers, and @samp{TAB} completion is available.
17867 So, let's say you want to increase the score on the current author with
17868 exact matching permanently: @kbd{I a e p}. If you want to lower the
17869 score based on the subject line, using substring matching, and make a
17870 temporary score entry: @kbd{L s s t}. Pretty easy.
17872 To make things a bit more complicated, there are shortcuts. If you use
17873 a capital letter on either the second or third keys, Gnus will use
17874 defaults for the remaining one or two keystrokes. The defaults are
17875 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
17876 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
17878 These functions take both the numerical prefix and the symbolic prefix
17879 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
17880 (or increase) the score of the article. A symbolic prefix of @code{a}
17881 says to use the @file{all.SCORE} file for the command instead of the
17882 current score file.
17884 @vindex gnus-score-mimic-keymap
17885 The @code{gnus-score-mimic-keymap} says whether these commands will
17886 pretend they are keymaps or not.
17889 @node Group Score Commands
17890 @section Group Score Commands
17891 @cindex group score commands
17893 There aren't many of these as yet, I'm afraid.
17898 @kindex W f (Group)
17899 @findex gnus-score-flush-cache
17900 Gnus maintains a cache of score alists to avoid having to reload them
17901 all the time. This command will flush the cache
17902 (@code{gnus-score-flush-cache}).
17906 You can do scoring from the command line by saying something like:
17908 @findex gnus-batch-score
17909 @cindex batch scoring
17911 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
17915 @node Score Variables
17916 @section Score Variables
17917 @cindex score variables
17921 @item gnus-use-scoring
17922 @vindex gnus-use-scoring
17923 If @code{nil}, Gnus will not check for score files, and will not, in
17924 general, do any score-related work. This is @code{t} by default.
17926 @item gnus-kill-killed
17927 @vindex gnus-kill-killed
17928 If this variable is @code{nil}, Gnus will never apply score files to
17929 articles that have already been through the kill process. While this
17930 may save you lots of time, it also means that if you apply a kill file
17931 to a group, and then change the kill file and want to run it over you
17932 group again to kill more articles, it won't work. You have to set this
17933 variable to @code{t} to do that. (It is @code{t} by default.)
17935 @item gnus-kill-files-directory
17936 @vindex gnus-kill-files-directory
17937 All kill and score files will be stored in this directory, which is
17938 initialized from the @code{SAVEDIR} environment variable by default.
17939 This is @file{~/News/} by default.
17941 @item gnus-score-file-suffix
17942 @vindex gnus-score-file-suffix
17943 Suffix to add to the group name to arrive at the score file name
17944 (@samp{SCORE} by default.)
17946 @item gnus-score-uncacheable-files
17947 @vindex gnus-score-uncacheable-files
17948 @cindex score cache
17949 All score files are normally cached to avoid excessive re-loading of
17950 score files. However, if this might make your Emacs grow big and
17951 bloated, so this regexp can be used to weed out score files unlikely to be needed again. It would be a bad idea to deny caching of
17952 @file{all.SCORE}, while it might be a good idea to not cache
17953 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
17954 variable is @samp{ADAPT$} by default, so no adaptive score files will
17957 @item gnus-save-score
17958 @vindex gnus-save-score
17959 If you have really complicated score files, and do lots of batch
17960 scoring, then you might set this variable to @code{t}. This will make
17961 Gnus save the scores into the @file{.newsrc.eld} file.
17963 If you do not set this to @code{t}, then manual scores (like those set
17964 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
17965 across group visits.
17967 @item gnus-score-interactive-default-score
17968 @vindex gnus-score-interactive-default-score
17969 Score used by all the interactive raise/lower commands to raise/lower
17970 score with. Default is 1000, which may seem excessive, but this is to
17971 ensure that the adaptive scoring scheme gets enough room to play with.
17972 We don't want the small changes from the adaptive scoring to overwrite
17973 manually entered data.
17975 @item gnus-summary-default-score
17976 @vindex gnus-summary-default-score
17977 Default score of an article, which is 0 by default.
17979 @item gnus-summary-expunge-below
17980 @vindex gnus-summary-expunge-below
17981 Don't display the summary lines of articles that have scores lower than
17982 this variable. This is @code{nil} by default, which means that no
17983 articles will be hidden. This variable is local to the summary buffers,
17984 and has to be set from @code{gnus-summary-mode-hook}.
17986 @item gnus-score-over-mark
17987 @vindex gnus-score-over-mark
17988 Mark (in the third column) used for articles with a score over the
17989 default. Default is @samp{+}.
17991 @item gnus-score-below-mark
17992 @vindex gnus-score-below-mark
17993 Mark (in the third column) used for articles with a score below the
17994 default. Default is @samp{-}.
17996 @item gnus-score-find-score-files-function
17997 @vindex gnus-score-find-score-files-function
17998 Function used to find score files for the current group. This function
17999 is called with the name of the group as the argument.
18001 Predefined functions available are:
18004 @item gnus-score-find-single
18005 @findex gnus-score-find-single
18006 Only apply the group's own score file.
18008 @item gnus-score-find-bnews
18009 @findex gnus-score-find-bnews
18010 Apply all score files that match, using bnews syntax. This is the
18011 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
18012 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
18013 @file{gnu.all.SCORE} would all apply. In short, the instances of
18014 @samp{all} in the score file names are translated into @samp{.*}, and
18015 then a regexp match is done.
18017 This means that if you have some score entries that you want to apply to
18018 all groups, then you put those entries in the @file{all.SCORE} file.
18020 The score files are applied in a semi-random order, although Gnus will
18021 try to apply the more general score files before the more specific score
18022 files. It does this by looking at the number of elements in the score
18023 file names---discarding the @samp{all} elements.
18025 @item gnus-score-find-hierarchical
18026 @findex gnus-score-find-hierarchical
18027 Apply all score files from all the parent groups. This means that you
18028 can't have score files like @file{all.SCORE}, but you can have
18029 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
18033 This variable can also be a list of functions. In that case, all
18034 these functions will be called with the group name as argument, and
18035 all the returned lists of score files will be applied. These
18036 functions can also return lists of lists of score alists directly. In
18037 that case, the functions that return these non-file score alists
18038 should probably be placed before the ``real'' score file functions, to
18039 ensure that the last score file returned is the local score file.
18042 For example, to do hierarchical scoring but use a non-server-specific
18043 overall score file, you could use the value
18045 (list (lambda (group) ("all.SCORE"))
18046 'gnus-score-find-hierarchical)
18049 @item gnus-score-expiry-days
18050 @vindex gnus-score-expiry-days
18051 This variable says how many days should pass before an unused score file
18052 entry is expired. If this variable is @code{nil}, no score file entries
18053 are expired. It's 7 by default.
18055 @item gnus-update-score-entry-dates
18056 @vindex gnus-update-score-entry-dates
18057 If this variable is non-@code{nil}, temporary score entries that have
18058 been triggered (matched) will have their dates updated. (This is how Gnus
18059 controls expiry---all non-matched-entries will become too old while
18060 matched entries will stay fresh and young.) However, if you set this
18061 variable to @code{nil}, even matched entries will grow old and will
18062 have to face that oh-so grim reaper.
18064 @item gnus-score-after-write-file-function
18065 @vindex gnus-score-after-write-file-function
18066 Function called with the name of the score file just written.
18068 @item gnus-score-thread-simplify
18069 @vindex gnus-score-thread-simplify
18070 If this variable is non-@code{nil}, article subjects will be simplified
18071 for subject scoring purposes in the same manner as with
18072 threading---according to the current value of
18073 gnus-simplify-subject-functions. If the scoring entry uses
18074 @code{substring} or @code{exact} matching, the match will also be
18075 simplified in this manner.
18080 @node Score File Format
18081 @section Score File Format
18082 @cindex score file format
18084 A score file is an @code{emacs-lisp} file that normally contains just a
18085 single form. Casual users are not expected to edit these files;
18086 everything can be changed from the summary buffer.
18088 Anyway, if you'd like to dig into it yourself, here's an example:
18092 ("Lars Ingebrigtsen" -10000)
18094 ("larsi\\|lmi" -50000 nil R))
18096 ("Ding is Badd" nil 728373))
18098 ("alt.politics" -1000 728372 s))
18103 (mark-and-expunge -10)
18107 (files "/hom/larsi/News/gnu.SCORE")
18108 (exclude-files "all.SCORE")
18109 (local (gnus-newsgroup-auto-expire t)
18110 (gnus-summary-make-false-root empty))
18114 This example demonstrates most score file elements. For a different
18115 approach, see @pxref{Advanced Scoring}.
18117 Even though this looks much like lisp code, nothing here is actually
18118 @code{eval}ed. The lisp reader is used to read this form, though, so it
18119 has to be valid syntactically, if not semantically.
18121 Six keys are supported by this alist:
18126 If the key is a string, it is the name of the header to perform the
18127 match on. Scoring can only be performed on these eight headers:
18128 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
18129 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
18130 these headers, there are three strings to tell Gnus to fetch the entire
18131 article and do the match on larger parts of the article: @code{Body}
18132 will perform the match on the body of the article, @code{Head} will
18133 perform the match on the head of the article, and @code{All} will
18134 perform the match on the entire article. Note that using any of these
18135 last three keys will slow down group entry @emph{considerably}. The
18136 final ``header'' you can score on is @code{Followup}. These score
18137 entries will result in new score entries being added for all follow-ups
18138 to articles that matches these score entries.
18140 Following this key is a arbitrary number of score entries, where each
18141 score entry has one to four elements.
18145 The first element is the @dfn{match element}. On most headers this will
18146 be a string, but on the Lines and Chars headers, this must be an
18150 If the second element is present, it should be a number---the @dfn{score
18151 element}. This number should be an integer in the neginf to posinf
18152 interval. This number is added to the score of the article if the match
18153 is successful. If this element is not present, the
18154 @code{gnus-score-interactive-default-score} number will be used
18155 instead. This is 1000 by default.
18158 If the third element is present, it should be a number---the @dfn{date
18159 element}. This date says when the last time this score entry matched,
18160 which provides a mechanism for expiring the score entries. It this
18161 element is not present, the score entry is permanent. The date is
18162 represented by the number of days since December 31, 1 BCE.
18165 If the fourth element is present, it should be a symbol---the @dfn{type
18166 element}. This element specifies what function should be used to see
18167 whether this score entry matches the article. What match types that can
18168 be used depends on what header you wish to perform the match on.
18171 @item From, Subject, References, Xref, Message-ID
18172 For most header types, there are the @code{r} and @code{R} (regexp), as
18173 well as @code{s} and @code{S} (substring) types, and @code{e} and
18174 @code{E} (exact match), and @code{w} (word match) types. If this
18175 element is not present, Gnus will assume that substring matching should
18176 be used. @code{R}, @code{S}, and @code{E} differ from the others in
18177 that the matches will be done in a case-sensitive manner. All these
18178 one-letter types are really just abbreviations for the @code{regexp},
18179 @code{string}, @code{exact}, and @code{word} types, which you can use
18180 instead, if you feel like.
18183 Just as for the standard string overview headers, if you are using
18184 gnus-extra-headers, you can score on these headers' values. In this
18185 case, there is a 5th element in the score entry, being the name of the
18186 header to be scored. The following entry is useful in your
18187 @file{all.SCORE} file in case of spam attacks from a single origin host,
18188 if your @sc{nntp} server tracks NNTP-Posting-Host in overviews:
18191 ("111.222.333.444" -1000 nil s "NNTP-Posting-Host")
18195 These two headers use different match types: @code{<}, @code{>},
18196 @code{=}, @code{>=} and @code{<=}.
18198 These predicates are true if
18201 (PREDICATE HEADER MATCH)
18204 evaluates to non-@code{nil}. For instance, the advanced match
18205 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
18212 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
18213 the match, we get the score added if the article has less than 4 lines.
18214 (It's easy to get confused and think it's the other way around. But
18215 it's not. I think.)
18217 When matching on @code{Lines}, be careful because some back ends (like
18218 @code{nndir}) do not generate @code{Lines} header, so every article ends
18219 up being marked as having 0 lines. This can lead to strange results if
18220 you happen to lower score of the articles with few lines.
18223 For the Date header we have three kinda silly match types:
18224 @code{before}, @code{at} and @code{after}. I can't really imagine this
18225 ever being useful, but, like, it would feel kinda silly not to provide
18226 this function. Just in case. You never know. Better safe than sorry.
18227 Once burnt, twice shy. Don't judge a book by its cover. Never not have
18228 sex on a first date. (I have been told that at least one person, and I
18229 quote, ``found this function indispensable'', however.)
18233 A more useful match type is @code{regexp}. With it, you can match the
18234 date string using a regular expression. The date is normalized to
18235 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
18236 you want to match all articles that have been posted on April 1st in
18237 every year, you could use @samp{....0401.........} as a match string,
18238 for instance. (Note that the date is kept in its original time zone, so
18239 this will match articles that were posted when it was April 1st where
18240 the article was posted from. Time zones are such wholesome fun for the
18243 @item Head, Body, All
18244 These three match keys use the same match types as the @code{From} (etc)
18248 This match key is somewhat special, in that it will match the
18249 @code{From} header, and affect the score of not only the matching
18250 articles, but also all followups to the matching articles. This allows
18251 you e.g. increase the score of followups to your own articles, or
18252 decrease the score of followups to the articles of some known
18253 trouble-maker. Uses the same match types as the @code{From} header
18254 uses. (Using this match key will lead to creation of @file{ADAPT}
18258 This match key works along the same lines as the @code{Followup} match
18259 key. If you say that you want to score on a (sub-)thread started by an
18260 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
18261 match. This will add a new @samp{thread} match for each article that
18262 has @var{x} in its @code{References} header. (These new @samp{thread}
18263 matches will use the @code{Message-ID}s of these matching articles.)
18264 This will ensure that you can raise/lower the score of an entire thread,
18265 even though some articles in the thread may not have complete
18266 @code{References} headers. Note that using this may lead to
18267 undeterministic scores of the articles in the thread. (Using this match
18268 key will lead to creation of @file{ADAPT} files.)
18272 @cindex Score File Atoms
18274 The value of this entry should be a number. Any articles with a score
18275 lower than this number will be marked as read.
18278 The value of this entry should be a number. Any articles with a score
18279 lower than this number will be removed from the summary buffer.
18281 @item mark-and-expunge
18282 The value of this entry should be a number. Any articles with a score
18283 lower than this number will be marked as read and removed from the
18286 @item thread-mark-and-expunge
18287 The value of this entry should be a number. All articles that belong to
18288 a thread that has a total score below this number will be marked as read
18289 and removed from the summary buffer. @code{gnus-thread-score-function}
18290 says how to compute the total score for a thread.
18293 The value of this entry should be any number of file names. These files
18294 are assumed to be score files as well, and will be loaded the same way
18297 @item exclude-files
18298 The clue of this entry should be any number of files. These files will
18299 not be loaded, even though they would normally be so, for some reason or
18303 The value of this entry will be @code{eval}el. This element will be
18304 ignored when handling global score files.
18307 Read-only score files will not be updated or saved. Global score files
18308 should feature this atom (@pxref{Global Score Files}). (Note:
18309 @dfn{Global} here really means @dfn{global}; not your personal
18310 apply-to-all-groups score files.)
18313 The value of this entry should be a number. Articles that do not have
18314 parents will get this number added to their scores. Imagine you follow
18315 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
18316 will only follow a few of the threads, also want to see any new threads.
18318 You can do this with the following two score file entries:
18322 (mark-and-expunge -100)
18325 When you enter the group the first time, you will only see the new
18326 threads. You then raise the score of the threads that you find
18327 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
18328 rest. Next time you enter the group, you will see new articles in the
18329 interesting threads, plus any new threads.
18331 I.e.---the orphan score atom is for high-volume groups where a few
18332 interesting threads which can't be found automatically by ordinary
18333 scoring rules exist.
18336 This entry controls the adaptive scoring. If it is @code{t}, the
18337 default adaptive scoring rules will be used. If it is @code{ignore}, no
18338 adaptive scoring will be performed on this group. If it is a list, this
18339 list will be used as the adaptive scoring rules. If it isn't present,
18340 or is something other than @code{t} or @code{ignore}, the default
18341 adaptive scoring rules will be used. If you want to use adaptive
18342 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
18343 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
18344 not want adaptive scoring. If you only want adaptive scoring in a few
18345 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
18346 insert @code{(adapt t)} in the score files of the groups where you want
18350 All adaptive score entries will go to the file named by this entry. It
18351 will also be applied when entering the group. This atom might be handy
18352 if you want to adapt on several groups at once, using the same adaptive
18353 file for a number of groups.
18356 @cindex local variables
18357 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
18358 Each @var{var} will be made buffer-local to the current summary buffer,
18359 and set to the value specified. This is a convenient, if somewhat
18360 strange, way of setting variables in some groups if you don't like hooks
18361 much. Note that the @var{value} won't be evaluated.
18365 @node Score File Editing
18366 @section Score File Editing
18368 You normally enter all scoring commands from the summary buffer, but you
18369 might feel the urge to edit them by hand as well, so we've supplied you
18370 with a mode for that.
18372 It's simply a slightly customized @code{emacs-lisp} mode, with these
18373 additional commands:
18378 @kindex C-c C-c (Score)
18379 @findex gnus-score-edit-done
18380 Save the changes you have made and return to the summary buffer
18381 (@code{gnus-score-edit-done}).
18384 @kindex C-c C-d (Score)
18385 @findex gnus-score-edit-insert-date
18386 Insert the current date in numerical format
18387 (@code{gnus-score-edit-insert-date}). This is really the day number, if
18388 you were wondering.
18391 @kindex C-c C-p (Score)
18392 @findex gnus-score-pretty-print
18393 The adaptive score files are saved in an unformatted fashion. If you
18394 intend to read one of these files, you want to @dfn{pretty print} it
18395 first. This command (@code{gnus-score-pretty-print}) does that for
18400 Type @kbd{M-x gnus-score-mode} to use this mode.
18402 @vindex gnus-score-mode-hook
18403 @code{gnus-score-menu-hook} is run in score mode buffers.
18405 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
18406 e} to begin editing score files.
18409 @node Adaptive Scoring
18410 @section Adaptive Scoring
18411 @cindex adaptive scoring
18413 If all this scoring is getting you down, Gnus has a way of making it all
18414 happen automatically---as if by magic. Or rather, as if by artificial
18415 stupidity, to be precise.
18417 @vindex gnus-use-adaptive-scoring
18418 When you read an article, or mark an article as read, or kill an
18419 article, you leave marks behind. On exit from the group, Gnus can sniff
18420 these marks and add score elements depending on what marks it finds.
18421 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
18422 @code{t} or @code{(line)}. If you want score adaptively on separate
18423 words appearing in the subjects, you should set this variable to
18424 @code{(word)}. If you want to use both adaptive methods, set this
18425 variable to @code{(word line)}.
18427 @vindex gnus-default-adaptive-score-alist
18428 To give you complete control over the scoring process, you can customize
18429 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
18430 might look something like this:
18433 (setq gnus-default-adaptive-score-alist
18434 '((gnus-unread-mark)
18435 (gnus-ticked-mark (from 4))
18436 (gnus-dormant-mark (from 5))
18437 (gnus-del-mark (from -4) (subject -1))
18438 (gnus-read-mark (from 4) (subject 2))
18439 (gnus-expirable-mark (from -1) (subject -1))
18440 (gnus-killed-mark (from -1) (subject -3))
18441 (gnus-kill-file-mark)
18442 (gnus-ancient-mark)
18443 (gnus-low-score-mark)
18444 (gnus-catchup-mark (from -1) (subject -1))))
18447 As you see, each element in this alist has a mark as a key (either a
18448 variable name or a ``real'' mark---a character). Following this key is
18449 a arbitrary number of header/score pairs. If there are no header/score
18450 pairs following the key, no adaptive scoring will be done on articles
18451 that have that key as the article mark. For instance, articles with
18452 @code{gnus-unread-mark} in the example above will not get adaptive score
18455 Each article can have only one mark, so just a single of these rules
18456 will be applied to each article.
18458 To take @code{gnus-del-mark} as an example---this alist says that all
18459 articles that have that mark (i.e., are marked with @samp{D}) will have a
18460 score entry added to lower based on the @code{From} header by -4, and
18461 lowered by @code{Subject} by -1. Change this to fit your prejudices.
18463 If you have marked 10 articles with the same subject with
18464 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
18465 That means that that subject will get a score of ten times -1, which
18466 should be, unless I'm much mistaken, -10.
18468 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
18469 the read articles will be marked with the @samp{E} mark. This'll
18470 probably make adaptive scoring slightly impossible, so auto-expiring and
18471 adaptive scoring doesn't really mix very well.
18473 The headers you can score on are @code{from}, @code{subject},
18474 @code{message-id}, @code{references}, @code{xref}, @code{lines},
18475 @code{chars} and @code{date}. In addition, you can score on
18476 @code{followup}, which will create an adaptive score entry that matches
18477 on the @code{References} header using the @code{Message-ID} of the
18478 current article, thereby matching the following thread.
18480 If you use this scheme, you should set the score file atom @code{mark}
18481 to something small---like -300, perhaps, to avoid having small random
18482 changes result in articles getting marked as read.
18484 After using adaptive scoring for a week or so, Gnus should start to
18485 become properly trained and enhance the authors you like best, and kill
18486 the authors you like least, without you having to say so explicitly.
18488 You can control what groups the adaptive scoring is to be performed on
18489 by using the score files (@pxref{Score File Format}). This will also
18490 let you use different rules in different groups.
18492 @vindex gnus-adaptive-file-suffix
18493 The adaptive score entries will be put into a file where the name is the
18494 group name with @code{gnus-adaptive-file-suffix} appended. The default
18497 @vindex gnus-score-exact-adapt-limit
18498 When doing adaptive scoring, substring or fuzzy matching would probably
18499 give you the best results in most cases. However, if the header one
18500 matches is short, the possibility for false positives is great, so if
18501 the length of the match is less than
18502 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
18503 this variable is @code{nil}, exact matching will always be used to avoid
18506 @vindex gnus-default-adaptive-word-score-alist
18507 As mentioned above, you can adapt either on individual words or entire
18508 headers. If you adapt on words, the
18509 @code{gnus-default-adaptive-word-score-alist} variable says what score
18510 each instance of a word should add given a mark.
18513 (setq gnus-default-adaptive-word-score-alist
18514 `((,gnus-read-mark . 30)
18515 (,gnus-catchup-mark . -10)
18516 (,gnus-killed-mark . -20)
18517 (,gnus-del-mark . -15)))
18520 This is the default value. If you have adaption on words enabled, every
18521 word that appears in subjects of articles marked with
18522 @code{gnus-read-mark} will result in a score rule that increase the
18523 score with 30 points.
18525 @vindex gnus-default-ignored-adaptive-words
18526 @vindex gnus-ignored-adaptive-words
18527 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
18528 will be ignored. If you wish to add more words to be ignored, use the
18529 @code{gnus-ignored-adaptive-words} list instead.
18531 @vindex gnus-adaptive-word-length-limit
18532 Some may feel that short words shouldn't count when doing adaptive
18533 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
18534 an integer. Words shorter than this number will be ignored. This
18535 variable defaults to @code{nil}.
18537 @vindex gnus-adaptive-word-syntax-table
18538 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
18539 syntax table in effect. It is similar to the standard syntax table, but
18540 it considers numbers to be non-word-constituent characters.
18542 @vindex gnus-adaptive-word-minimum
18543 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
18544 word scoring process will never bring down the score of an article to
18545 below this number. The default is @code{nil}.
18547 @vindex gnus-adaptive-word-no-group-words
18548 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
18549 won't adaptively word score any of the words in the group name. Useful
18550 for groups like @samp{comp.editors.emacs}, where most of the subject
18551 lines contain the word @samp{emacs}.
18553 After using this scheme for a while, it might be nice to write a
18554 @code{gnus-psychoanalyze-user} command to go through the rules and see
18555 what words you like and what words you don't like. Or perhaps not.
18557 Note that the adaptive word scoring thing is highly experimental and is
18558 likely to change in the future. Initial impressions seem to indicate
18559 that it's totally useless as it stands. Some more work (involving more
18560 rigorous statistical methods) will have to be done to make this useful.
18563 @node Home Score File
18564 @section Home Score File
18566 The score file where new score file entries will go is called the
18567 @dfn{home score file}. This is normally (and by default) the score file
18568 for the group itself. For instance, the home score file for
18569 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
18571 However, this may not be what you want. It is often convenient to share
18572 a common home score file among many groups---all @samp{emacs} groups
18573 could perhaps use the same home score file.
18575 @vindex gnus-home-score-file
18576 The variable that controls this is @code{gnus-home-score-file}. It can
18581 A string. Then this file will be used as the home score file for all
18585 A function. The result of this function will be used as the home score
18586 file. The function will be called with the name of the group as the
18590 A list. The elements in this list can be:
18594 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
18595 group name, the @var{file-name} will be used as the home score file.
18598 A function. If the function returns non-nil, the result will be used as
18599 the home score file.
18602 A string. Use the string as the home score file.
18605 The list will be traversed from the beginning towards the end looking
18610 So, if you want to use just a single score file, you could say:
18613 (setq gnus-home-score-file
18614 "my-total-score-file.SCORE")
18617 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
18618 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
18620 @findex gnus-hierarchial-home-score-file
18622 (setq gnus-home-score-file
18623 'gnus-hierarchial-home-score-file)
18626 This is a ready-made function provided for your convenience.
18627 Other functions include
18630 @item gnus-current-home-score-file
18631 @findex gnus-current-home-score-file
18632 Return the ``current'' regular score file. This will make scoring
18633 commands add entry to the ``innermost'' matching score file.
18637 If you want to have one score file for the @samp{emacs} groups and
18638 another for the @samp{comp} groups, while letting all other groups use
18639 their own home score files:
18642 (setq gnus-home-score-file
18643 ;; All groups that match the regexp "\\.emacs"
18644 '(("\\.emacs" "emacs.SCORE")
18645 ;; All the comp groups in one score file
18646 ("^comp" "comp.SCORE")))
18649 @vindex gnus-home-adapt-file
18650 @code{gnus-home-adapt-file} works exactly the same way as
18651 @code{gnus-home-score-file}, but says what the home adaptive score file
18652 is instead. All new adaptive file entries will go into the file
18653 specified by this variable, and the same syntax is allowed.
18655 In addition to using @code{gnus-home-score-file} and
18656 @code{gnus-home-adapt-file}, you can also use group parameters
18657 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
18658 Parameters}) to achieve much the same. Group and topic parameters take
18659 precedence over this variable.
18662 @node Followups To Yourself
18663 @section Followups To Yourself
18665 Gnus offers two commands for picking out the @code{Message-ID} header in
18666 the current buffer. Gnus will then add a score rule that scores using
18667 this @code{Message-ID} on the @code{References} header of other
18668 articles. This will, in effect, increase the score of all articles that
18669 respond to the article in the current buffer. Quite useful if you want
18670 to easily note when people answer what you've said.
18674 @item gnus-score-followup-article
18675 @findex gnus-score-followup-article
18676 This will add a score to articles that directly follow up your own
18679 @item gnus-score-followup-thread
18680 @findex gnus-score-followup-thread
18681 This will add a score to all articles that appear in a thread ``below''
18685 @vindex message-sent-hook
18686 These two functions are both primarily meant to be used in hooks like
18687 @code{message-sent-hook}, like this:
18689 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
18693 If you look closely at your own @code{Message-ID}, you'll notice that
18694 the first two or three characters are always the same. Here's two of
18698 <x6u3u47icf.fsf@@eyesore.no>
18699 <x6sp9o7ibw.fsf@@eyesore.no>
18702 So ``my'' ident on this machine is @samp{x6}. This can be
18703 exploited---the following rule will raise the score on all followups to
18708 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
18712 Whether it's the first two or first three characters that are ``yours''
18713 is system-dependent.
18716 @node Scoring On Other Headers
18717 @section Scoring On Other Headers
18718 @cindex scoring on other headers
18720 Gnus is quite fast when scoring the ``traditional''
18721 headers---@samp{From}, @samp{Subject} and so on. However, scoring
18722 other headers requires writing a @code{head} scoring rule, which means
18723 that Gnus has to request every single article from the back end to find
18724 matches. This takes a long time in big groups.
18726 Now, there's not much you can do about this for news groups, but for
18727 mail groups, you have greater control. In the @pxref{To From
18728 Newsgroups} section of the manual, it's explained in greater detail what
18729 this mechanism does, but here's a cookbook example for @code{nnml} on
18730 how to allow scoring on the @samp{To} and @samp{Cc} headers.
18732 Put the following in your @file{.gnus.el} file.
18735 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
18736 nnmail-extra-headers gnus-extra-headers)
18739 Restart Gnus and rebuild your @code{nnml} overview files with the
18740 @kbd{M-x nnml-generate-nov-databases} command. This will take a long
18741 time if you have much mail.
18743 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
18744 so: @kbd{I e s p To RET <your name> RET}.
18750 @section Scoring Tips
18751 @cindex scoring tips
18757 @cindex scoring crossposts
18758 If you want to lower the score of crossposts, the line to match on is
18759 the @code{Xref} header.
18761 ("xref" (" talk.politics.misc:" -1000))
18764 @item Multiple crossposts
18765 If you want to lower the score of articles that have been crossposted to
18766 more than, say, 3 groups:
18769 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
18773 @item Matching on the body
18774 This is generally not a very good idea---it takes a very long time.
18775 Gnus actually has to fetch each individual article from the server. But
18776 you might want to anyway, I guess. Even though there are three match
18777 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
18778 and stick with it in each score file. If you use any two, each article
18779 will be fetched @emph{twice}. If you want to match a bit on the
18780 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
18783 @item Marking as read
18784 You will probably want to mark articles that have scores below a certain
18785 number as read. This is most easily achieved by putting the following
18786 in your @file{all.SCORE} file:
18790 You may also consider doing something similar with @code{expunge}.
18792 @item Negated character classes
18793 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
18794 That will match newlines, which might lead to, well, The Unknown. Say
18795 @code{[^abcd\n]*} instead.
18799 @node Reverse Scoring
18800 @section Reverse Scoring
18801 @cindex reverse scoring
18803 If you want to keep just articles that have @samp{Sex with Emacs} in the
18804 subject header, and expunge all other articles, you could put something
18805 like this in your score file:
18809 ("Sex with Emacs" 2))
18814 So, you raise all articles that match @samp{Sex with Emacs} and mark the
18815 rest as read, and expunge them to boot.
18818 @node Global Score Files
18819 @section Global Score Files
18820 @cindex global score files
18822 Sure, other newsreaders have ``global kill files''. These are usually
18823 nothing more than a single kill file that applies to all groups, stored
18824 in the user's home directory. Bah! Puny, weak newsreaders!
18826 What I'm talking about here are Global Score Files. Score files from
18827 all over the world, from users everywhere, uniting all nations in one
18828 big, happy score file union! Ange-score! New and untested!
18830 @vindex gnus-global-score-files
18831 All you have to do to use other people's score files is to set the
18832 @code{gnus-global-score-files} variable. One entry for each score file,
18833 or each score file directory. Gnus will decide by itself what score
18834 files are applicable to which group.
18836 To use the score file
18837 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
18838 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
18842 (setq gnus-global-score-files
18843 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
18844 "/ftp@@ftp.some-where:/pub/score/"))
18847 @findex gnus-score-search-global-directories
18849 Simple, eh? Directory names must end with a @samp{/}. These
18850 directories are typically scanned only once during each Gnus session.
18851 If you feel the need to manually re-scan the remote directories, you can
18852 use the @code{gnus-score-search-global-directories} command.
18854 Note that, at present, using this option will slow down group entry
18855 somewhat. (That is---a lot.)
18857 If you want to start maintaining score files for other people to use,
18858 just put your score file up for anonymous ftp and announce it to the
18859 world. Become a retro-moderator! Participate in the retro-moderator
18860 wars sure to ensue, where retro-moderators battle it out for the
18861 sympathy of the people, luring them to use their score files on false
18862 premises! Yay! The net is saved!
18864 Here are some tips for the would-be retro-moderator, off the top of my
18870 Articles heavily crossposted are probably junk.
18872 To lower a single inappropriate article, lower by @code{Message-ID}.
18874 Particularly brilliant authors can be raised on a permanent basis.
18876 Authors that repeatedly post off-charter for the group can safely be
18877 lowered out of existence.
18879 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
18880 articles completely.
18883 Use expiring score entries to keep the size of the file down. You
18884 should probably have a long expiry period, though, as some sites keep
18885 old articles for a long time.
18888 ... I wonder whether other newsreaders will support global score files
18889 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
18890 Wave, xrn and 1stReader are bound to implement scoring. Should we start
18891 holding our breath yet?
18895 @section Kill Files
18898 Gnus still supports those pesky old kill files. In fact, the kill file
18899 entries can now be expiring, which is something I wrote before Daniel
18900 Quinlan thought of doing score files, so I've left the code in there.
18902 In short, kill processing is a lot slower (and I do mean @emph{a lot})
18903 than score processing, so it might be a good idea to rewrite your kill
18904 files into score files.
18906 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
18907 forms into this file, which means that you can use kill files as some
18908 sort of primitive hook function to be run on group entry, even though
18909 that isn't a very good idea.
18911 Normal kill files look like this:
18914 (gnus-kill "From" "Lars Ingebrigtsen")
18915 (gnus-kill "Subject" "ding")
18919 This will mark every article written by me as read, and remove the
18920 marked articles from the summary buffer. Very useful, you'll agree.
18922 Other programs use a totally different kill file syntax. If Gnus
18923 encounters what looks like a @code{rn} kill file, it will take a stab at
18926 Two summary functions for editing a GNUS kill file:
18931 @kindex M-k (Summary)
18932 @findex gnus-summary-edit-local-kill
18933 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
18936 @kindex M-K (Summary)
18937 @findex gnus-summary-edit-global-kill
18938 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
18941 Two group mode functions for editing the kill files:
18946 @kindex M-k (Group)
18947 @findex gnus-group-edit-local-kill
18948 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
18951 @kindex M-K (Group)
18952 @findex gnus-group-edit-global-kill
18953 Edit the general kill file (@code{gnus-group-edit-global-kill}).
18956 Kill file variables:
18959 @item gnus-kill-file-name
18960 @vindex gnus-kill-file-name
18961 A kill file for the group @samp{soc.motss} is normally called
18962 @file{soc.motss.KILL}. The suffix appended to the group name to get
18963 this file name is detailed by the @code{gnus-kill-file-name} variable.
18964 The ``global'' kill file (not in the score file sense of ``global'', of
18965 course) is just called @file{KILL}.
18967 @vindex gnus-kill-save-kill-file
18968 @item gnus-kill-save-kill-file
18969 If this variable is non-@code{nil}, Gnus will save the
18970 kill file after processing, which is necessary if you use expiring
18973 @item gnus-apply-kill-hook
18974 @vindex gnus-apply-kill-hook
18975 @findex gnus-apply-kill-file-unless-scored
18976 @findex gnus-apply-kill-file
18977 A hook called to apply kill files to a group. It is
18978 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
18979 kill file if you have a score file for the same group, you can set this
18980 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
18981 kill files to be processed, you should set this variable to @code{nil}.
18983 @item gnus-kill-file-mode-hook
18984 @vindex gnus-kill-file-mode-hook
18985 A hook called in kill-file mode buffers.
18990 @node Converting Kill Files
18991 @section Converting Kill Files
18993 @cindex converting kill files
18995 If you have loads of old kill files, you may want to convert them into
18996 score files. If they are ``regular'', you can use
18997 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
19000 The kill to score conversion package isn't included in Gnus by default.
19001 You can fetch it from
19002 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
19004 If your old kill files are very complex---if they contain more
19005 non-@code{gnus-kill} forms than not, you'll have to convert them by
19006 hand. Or just let them be as they are. Gnus will still use them as
19014 GroupLens (@uref{http://www.cs.umn.edu/Research/GroupLens/}) is a
19015 collaborative filtering system that helps you work together with other
19016 people to find the quality news articles out of the huge volume of
19017 news articles generated every day.
19019 To accomplish this the GroupLens system combines your opinions about
19020 articles you have already read with the opinions of others who have done
19021 likewise and gives you a personalized prediction for each unread news
19022 article. Think of GroupLens as a matchmaker. GroupLens watches how you
19023 rate articles, and finds other people that rate articles the same way.
19024 Once it has found some people you agree with it tells you, in the form
19025 of a prediction, what they thought of the article. You can use this
19026 prediction to help you decide whether or not you want to read the
19029 @sc{Note:} Unfortunately the GroupLens system seems to have shut down,
19030 so this section is mostly of historical interest.
19033 * Using GroupLens:: How to make Gnus use GroupLens.
19034 * Rating Articles:: Letting GroupLens know how you rate articles.
19035 * Displaying Predictions:: Displaying predictions given by GroupLens.
19036 * GroupLens Variables:: Customizing GroupLens.
19040 @node Using GroupLens
19041 @subsection Using GroupLens
19043 To use GroupLens you must register a pseudonym with your local Better
19045 @uref{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
19046 better bit in town at the moment.
19048 Once you have registered you'll need to set a couple of variables.
19052 @item gnus-use-grouplens
19053 @vindex gnus-use-grouplens
19054 Setting this variable to a non-@code{nil} value will make Gnus hook into
19055 all the relevant GroupLens functions.
19057 @item grouplens-pseudonym
19058 @vindex grouplens-pseudonym
19059 This variable should be set to the pseudonym you got when registering
19060 with the Better Bit Bureau.
19062 @item grouplens-newsgroups
19063 @vindex grouplens-newsgroups
19064 A list of groups that you want to get GroupLens predictions for.
19068 That's the minimum of what you need to get up and running with GroupLens.
19069 Once you've registered, GroupLens will start giving you scores for
19070 articles based on the average of what other people think. But, to get
19071 the real benefit of GroupLens you need to start rating articles
19072 yourself. Then the scores GroupLens gives you will be personalized for
19073 you, based on how the people you usually agree with have already rated.
19076 @node Rating Articles
19077 @subsection Rating Articles
19079 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
19080 Where 1 means something like this article is a waste of bandwidth and 5
19081 means that the article was really good. The basic question to ask
19082 yourself is, "on a scale from 1 to 5 would I like to see more articles
19085 There are four ways to enter a rating for an article in GroupLens.
19090 @kindex r (GroupLens)
19091 @findex bbb-summary-rate-article
19092 This function will prompt you for a rating on a scale of one to five.
19095 @kindex k (GroupLens)
19096 @findex grouplens-score-thread
19097 This function will prompt you for a rating, and rate all the articles in
19098 the thread. This is really useful for some of those long running giant
19099 threads in rec.humor.
19103 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
19104 the score of the article you're reading.
19109 @kindex n (GroupLens)
19110 @findex grouplens-next-unread-article
19111 Rate the article and go to the next unread article.
19114 @kindex , (GroupLens)
19115 @findex grouplens-best-unread-article
19116 Rate the article and go to the next unread article with the highest score.
19120 If you want to give the current article a score of 4 and then go to the
19121 next article, just type @kbd{4 n}.
19124 @node Displaying Predictions
19125 @subsection Displaying Predictions
19127 GroupLens makes a prediction for you about how much you will like a
19128 news article. The predictions from GroupLens are on a scale from 1 to
19129 5, where 1 is the worst and 5 is the best. You can use the predictions
19130 from GroupLens in one of three ways controlled by the variable
19131 @code{gnus-grouplens-override-scoring}.
19133 @vindex gnus-grouplens-override-scoring
19134 There are three ways to display predictions in grouplens. You may
19135 choose to have the GroupLens scores contribute to, or override the
19136 regular gnus scoring mechanism. override is the default; however, some
19137 people prefer to see the Gnus scores plus the grouplens scores. To get
19138 the separate scoring behavior you need to set
19139 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
19140 GroupLens predictions combined with the grouplens scores set it to
19141 @code{'override} and to combine the scores set
19142 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
19143 the combine option you will also want to set the values for
19144 @code{grouplens-prediction-offset} and
19145 @code{grouplens-score-scale-factor}.
19147 @vindex grouplens-prediction-display
19148 In either case, GroupLens gives you a few choices for how you would like
19149 to see your predictions displayed. The display of predictions is
19150 controlled by the @code{grouplens-prediction-display} variable.
19152 The following are valid values for that variable.
19155 @item prediction-spot
19156 The higher the prediction, the further to the right an @samp{*} is
19159 @item confidence-interval
19160 A numeric confidence interval.
19162 @item prediction-bar
19163 The higher the prediction, the longer the bar.
19165 @item confidence-bar
19166 Numerical confidence.
19168 @item confidence-spot
19169 The spot gets bigger with more confidence.
19171 @item prediction-num
19172 Plain-old numeric value.
19174 @item confidence-plus-minus
19175 Prediction +/- confidence.
19180 @node GroupLens Variables
19181 @subsection GroupLens Variables
19185 @item gnus-summary-grouplens-line-format
19186 The summary line format used in GroupLens-enhanced summary buffers. It
19187 accepts the same specs as the normal summary line format (@pxref{Summary
19188 Buffer Lines}). The default is @samp{%U%R%z%l%I%(%[%4L: %-23,23n%]%)
19191 @item grouplens-bbb-host
19192 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
19195 @item grouplens-bbb-port
19196 Port of the host running the bbbd server. The default is 9000.
19198 @item grouplens-score-offset
19199 Offset the prediction by this value. In other words, subtract the
19200 prediction value by this number to arrive at the effective score. The
19203 @item grouplens-score-scale-factor
19204 This variable allows the user to magnify the effect of GroupLens scores.
19205 The scale factor is applied after the offset. The default is 1.
19210 @node Advanced Scoring
19211 @section Advanced Scoring
19213 Scoring on Subjects and From headers is nice enough, but what if you're
19214 really interested in what a person has to say only when she's talking
19215 about a particular subject? Or what if you really don't want to
19216 read what person A has to say when she's following up to person B, but
19217 want to read what she says when she's following up to person C?
19219 By using advanced scoring rules you may create arbitrarily complex
19223 * Advanced Scoring Syntax:: A definition.
19224 * Advanced Scoring Examples:: What they look like.
19225 * Advanced Scoring Tips:: Getting the most out of it.
19229 @node Advanced Scoring Syntax
19230 @subsection Advanced Scoring Syntax
19232 Ordinary scoring rules have a string as the first element in the rule.
19233 Advanced scoring rules have a list as the first element. The second
19234 element is the score to be applied if the first element evaluated to a
19235 non-@code{nil} value.
19237 These lists may consist of three logical operators, one redirection
19238 operator, and various match operators.
19245 This logical operator will evaluate each of its arguments until it finds
19246 one that evaluates to @code{false}, and then it'll stop. If all arguments
19247 evaluate to @code{true} values, then this operator will return
19252 This logical operator will evaluate each of its arguments until it finds
19253 one that evaluates to @code{true}. If no arguments are @code{true},
19254 then this operator will return @code{false}.
19259 This logical operator only takes a single argument. It returns the
19260 logical negation of the value of its argument.
19264 There is an @dfn{indirection operator} that will make its arguments
19265 apply to the ancestors of the current article being scored. For
19266 instance, @code{1-} will make score rules apply to the parent of the
19267 current article. @code{2-} will make score rules apply to the
19268 grandparent of the current article. Alternatively, you can write
19269 @code{^^}, where the number of @code{^}s (carets) says how far back into
19270 the ancestry you want to go.
19272 Finally, we have the match operators. These are the ones that do the
19273 real work. Match operators are header name strings followed by a match
19274 and a match type. A typical match operator looks like @samp{("from"
19275 "Lars Ingebrigtsen" s)}. The header names are the same as when using
19276 simple scoring, and the match types are also the same.
19279 @node Advanced Scoring Examples
19280 @subsection Advanced Scoring Examples
19282 Please note that the following examples are score file rules. To
19283 make a complete score file from them, surround them with another pair
19286 Let's say you want to increase the score of articles written by Lars
19287 when he's talking about Gnus:
19291 ("from" "Lars Ingebrigtsen")
19292 ("subject" "Gnus"))
19298 When he writes long articles, he sometimes has something nice to say:
19302 ("from" "Lars Ingebrigtsen")
19309 However, when he responds to things written by Reig Eigil Logge, you
19310 really don't want to read what he's written:
19314 ("from" "Lars Ingebrigtsen")
19315 (1- ("from" "Reig Eigir Logge")))
19319 Everybody that follows up Redmondo when he writes about disappearing
19320 socks should have their scores raised, but only when they talk about
19321 white socks. However, when Lars talks about socks, it's usually not
19328 ("from" "redmondo@@.*no" r)
19329 ("body" "disappearing.*socks" t)))
19330 (! ("from" "Lars Ingebrigtsen"))
19331 ("body" "white.*socks"))
19335 The possibilities are endless.
19338 @node Advanced Scoring Tips
19339 @subsection Advanced Scoring Tips
19341 The @code{&} and @code{|} logical operators do short-circuit logic.
19342 That is, they stop processing their arguments when it's clear what the
19343 result of the operation will be. For instance, if one of the arguments
19344 of an @code{&} evaluates to @code{false}, there's no point in evaluating
19345 the rest of the arguments. This means that you should put slow matches
19346 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
19347 @samp{subject}) first.
19349 The indirection arguments (@code{1-} and so on) will make their
19350 arguments work on previous generations of the thread. If you say
19361 Then that means "score on the from header of the grandparent of the
19362 current article". An indirection is quite fast, but it's better to say:
19368 ("subject" "Gnus")))
19375 (1- ("from" "Lars"))
19376 (1- ("subject" "Gnus")))
19381 @section Score Decays
19382 @cindex score decays
19385 You may find that your scores have a tendency to grow without
19386 bounds, especially if you're using adaptive scoring. If scores get too
19387 big, they lose all meaning---they simply max out and it's difficult to
19388 use them in any sensible way.
19390 @vindex gnus-decay-scores
19391 @findex gnus-decay-score
19392 @vindex gnus-decay-score-function
19393 Gnus provides a mechanism for decaying scores to help with this problem.
19394 When score files are loaded and @code{gnus-decay-scores} is
19395 non-@code{nil}, Gnus will run the score files through the decaying
19396 mechanism thereby lowering the scores of all non-permanent score rules.
19397 The decay itself if performed by the @code{gnus-decay-score-function}
19398 function, which is @code{gnus-decay-score} by default. Here's the
19399 definition of that function:
19402 (defun gnus-decay-score (score)
19404 This is done according to `gnus-score-decay-constant'
19405 and `gnus-score-decay-scale'."
19408 (* (if (< score 0) 1 -1)
19410 (max gnus-score-decay-constant
19412 gnus-score-decay-scale)))))))
19415 @vindex gnus-score-decay-scale
19416 @vindex gnus-score-decay-constant
19417 @code{gnus-score-decay-constant} is 3 by default and
19418 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
19422 Scores between -3 and 3 will be set to 0 when this function is called.
19425 Scores with magnitudes between 3 and 60 will be shrunk by 3.
19428 Scores with magnitudes greater than 60 will be shrunk by 5% of the
19432 If you don't like this decay function, write your own. It is called
19433 with the score to be decayed as its only parameter, and it should return
19434 the new score, which should be an integer.
19436 Gnus will try to decay scores once a day. If you haven't run Gnus for
19437 four days, Gnus will decay the scores four times, for instance.
19442 @include message.texi
19443 @chapter Emacs MIME
19444 @include emacs-mime.texi
19446 @include sieve.texi
19456 * Process/Prefix:: A convention used by many treatment commands.
19457 * Interactive:: Making Gnus ask you many questions.
19458 * Symbolic Prefixes:: How to supply some Gnus functions with options.
19459 * Formatting Variables:: You can specify what buffers should look like.
19460 * Window Layout:: Configuring the Gnus buffer windows.
19461 * Faces and Fonts:: How to change how faces look.
19462 * Compilation:: How to speed Gnus up.
19463 * Mode Lines:: Displaying information in the mode lines.
19464 * Highlighting and Menus:: Making buffers look all nice and cozy.
19465 * Buttons:: Get tendinitis in ten easy steps!
19466 * Daemons:: Gnus can do things behind your back.
19467 * NoCeM:: How to avoid spam and other fatty foods.
19468 * Undo:: Some actions can be undone.
19469 * Predicate Specifiers:: Specifying predicates.
19470 * Moderation:: What to do if you're a moderator.
19471 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
19472 * Fuzzy Matching:: What's the big fuzz?
19473 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
19474 * Various Various:: Things that are really various.
19478 @node Process/Prefix
19479 @section Process/Prefix
19480 @cindex process/prefix convention
19482 Many functions, among them functions for moving, decoding and saving
19483 articles, use what is known as the @dfn{Process/Prefix convention}.
19485 This is a method for figuring out what articles the user wants the
19486 command to be performed on.
19490 If the numeric prefix is N, perform the operation on the next N
19491 articles, starting with the current one. If the numeric prefix is
19492 negative, perform the operation on the previous N articles, starting
19493 with the current one.
19495 @vindex transient-mark-mode
19496 If @code{transient-mark-mode} in non-@code{nil} and the region is
19497 active, all articles in the region will be worked upon.
19499 If there is no numeric prefix, but some articles are marked with the
19500 process mark, perform the operation on the articles marked with
19503 If there is neither a numeric prefix nor any articles marked with the
19504 process mark, just perform the operation on the current article.
19506 Quite simple, really, but it needs to be made clear so that surprises
19509 Commands that react to the process mark will push the current list of
19510 process marked articles onto a stack and will then clear all process
19511 marked articles. You can restore the previous configuration with the
19512 @kbd{M P y} command (@pxref{Setting Process Marks}).
19514 @vindex gnus-summary-goto-unread
19515 One thing that seems to shock & horrify lots of people is that, for
19516 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
19517 Since each @kbd{d} (which marks the current article as read) by default
19518 goes to the next unread article after marking, this means that @kbd{3 d}
19519 will mark the next three unread articles as read, no matter what the
19520 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
19521 @code{nil} for a more straightforward action.
19523 Many commands do not use the process/prefix convention. All commands
19524 that do explicitly say so in this manual. To apply the process/prefix
19525 convention to commands that do not use it, you can use the @kbd{M-&}
19526 command. For instance, to mark all the articles in the group as
19527 expirable, you could say `M P b M-& E'.
19531 @section Interactive
19532 @cindex interaction
19536 @item gnus-novice-user
19537 @vindex gnus-novice-user
19538 If this variable is non-@code{nil}, you are either a newcomer to the
19539 World of Usenet, or you are very cautious, which is a nice thing to be,
19540 really. You will be given questions of the type ``Are you sure you want
19541 to do this?'' before doing anything dangerous. This is @code{t} by
19544 @item gnus-expert-user
19545 @vindex gnus-expert-user
19546 If this variable is non-@code{nil}, you will seldom be asked any
19547 questions by Gnus. It will simply assume you know what you're doing, no
19548 matter how strange.
19550 @item gnus-interactive-catchup
19551 @vindex gnus-interactive-catchup
19552 Require confirmation before catching up a group if non-@code{nil}. It
19553 is @code{t} by default.
19555 @item gnus-interactive-exit
19556 @vindex gnus-interactive-exit
19557 Require confirmation before exiting Gnus. This variable is @code{t} by
19562 @node Symbolic Prefixes
19563 @section Symbolic Prefixes
19564 @cindex symbolic prefixes
19566 Quite a lot of Emacs commands react to the (numeric) prefix. For
19567 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
19568 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
19569 rule of 900 to the current article.
19571 This is all nice and well, but what if you want to give a command some
19572 additional information? Well, what most commands do is interpret the
19573 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
19574 doesn't want a backup file to be created when saving the current buffer,
19575 for instance. But what if you want to save without making a backup
19576 file, and you want Emacs to flash lights and play a nice tune at the
19577 same time? You can't, and you're probably perfectly happy that way.
19579 @kindex M-i (Summary)
19580 @findex gnus-symbolic-argument
19581 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
19582 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
19583 character typed in is the value. You can stack as many @kbd{M-i}
19584 prefixes as you want. @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
19585 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b C-M-u} means
19586 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
19587 @code{b}''. You get the drift.
19589 Typing in symbolic prefixes to commands that don't accept them doesn't
19590 hurt, but it doesn't do any good either. Currently not many Gnus
19591 functions make use of the symbolic prefix.
19593 If you're interested in how Gnus implements this, @pxref{Extended
19597 @node Formatting Variables
19598 @section Formatting Variables
19599 @cindex formatting variables
19601 Throughout this manual you've probably noticed lots of variables called
19602 things like @code{gnus-group-line-format} and
19603 @code{gnus-summary-mode-line-format}. These control how Gnus is to
19604 output lines in the various buffers. There's quite a lot of them.
19605 Fortunately, they all use the same syntax, so there's not that much to
19608 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
19609 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
19610 lots of percentages everywhere.
19613 * Formatting Basics:: A formatting variable is basically a format string.
19614 * Mode Line Formatting:: Some rules about mode line formatting variables.
19615 * Advanced Formatting:: Modifying output in various ways.
19616 * User-Defined Specs:: Having Gnus call your own functions.
19617 * Formatting Fonts:: Making the formatting look colorful and nice.
19618 * Positioning Point:: Moving point to a position after an operation.
19619 * Tabulation:: Tabulating your output.
19620 * Wide Characters:: Dealing with wide characters.
19623 Currently Gnus uses the following formatting variables:
19624 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
19625 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
19626 @code{gnus-group-mode-line-format},
19627 @code{gnus-summary-mode-line-format},
19628 @code{gnus-article-mode-line-format},
19629 @code{gnus-server-mode-line-format}, and
19630 @code{gnus-summary-pick-line-format}.
19632 All these format variables can also be arbitrary elisp forms. In that
19633 case, they will be @code{eval}ed to insert the required lines.
19635 @kindex M-x gnus-update-format
19636 @findex gnus-update-format
19637 Gnus includes a command to help you while creating your own format
19638 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
19639 update the spec in question and pop you to a buffer where you can
19640 examine the resulting lisp code to be run to generate the line.
19644 @node Formatting Basics
19645 @subsection Formatting Basics
19647 Each @samp{%} element will be replaced by some string or other when the
19648 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
19649 spec, and pad with spaces to get a 5-character field''.
19651 As with normal C and Emacs Lisp formatting strings, the numerical
19652 modifier between the @samp{%} and the formatting type character will
19653 @dfn{pad} the output so that it is always at least that long.
19654 @samp{%5y} will make the field always (at least) five characters wide by
19655 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
19658 You may also wish to limit the length of the field to protect against
19659 particularly wide values. For that you can say @samp{%4,6y}, which
19660 means that the field will never be more than 6 characters wide and never
19661 less than 4 characters wide.
19663 Also Gnus supports some extended format specifications, such as
19664 @samp{%&user-date;}.
19667 @node Mode Line Formatting
19668 @subsection Mode Line Formatting
19670 Mode line formatting variables (e.g.,
19671 @code{gnus-summary-mode-line-format}) follow the same rules as other,
19672 buffer line oriented formatting variables (@pxref{Formatting Basics})
19673 with the following two differences:
19678 There must be no newline (@samp{\n}) at the end.
19681 The special @samp{%%b} spec can be used to display the buffer name.
19682 Well, it's no spec at all, really---@samp{%%} is just a way to quote
19683 @samp{%} to allow it to pass through the formatting machinery unmangled,
19684 so that Emacs receives @samp{%b}, which is something the Emacs mode line
19685 display interprets to mean ``show the buffer name''. For a full list of
19686 mode line specs Emacs understands, see the documentation of the
19687 @code{mode-line-format} variable.
19692 @node Advanced Formatting
19693 @subsection Advanced Formatting
19695 It is frequently useful to post-process the fields in some way.
19696 Padding, limiting, cutting off parts and suppressing certain values can
19697 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
19698 look like @samp{%~(cut 3)~(ignore "0")y}.
19700 These are the valid modifiers:
19705 Pad the field to the left with spaces until it reaches the required
19709 Pad the field to the right with spaces until it reaches the required
19714 Cut off characters from the left until it reaches the specified length.
19717 Cut off characters from the right until it reaches the specified
19722 Cut off the specified number of characters from the left.
19725 Cut off the specified number of characters from the right.
19728 Return an empty string if the field is equal to the specified value.
19731 Use the specified form as the field value when the @samp{@@} spec is
19737 "~(form (current-time-string))@@"
19742 Let's take an example. The @samp{%o} spec in the summary mode lines
19743 will return a date in compact ISO8601 format---@samp{19960809T230410}.
19744 This is quite a mouthful, so we want to shave off the century number and
19745 the time, leaving us with a six-character date. That would be
19746 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
19747 maxing, and we need the padding to ensure that the date is never less
19748 than 6 characters to make it look nice in columns.)
19750 Ignoring is done first; then cutting; then maxing; and then as the very
19751 last operation, padding.
19753 If you use lots of these advanced thingies, you'll find that Gnus gets
19754 quite slow. This can be helped enormously by running @kbd{M-x
19755 gnus-compile} when you are satisfied with the look of your lines.
19756 @xref{Compilation}.
19759 @node User-Defined Specs
19760 @subsection User-Defined Specs
19762 All the specs allow for inserting user defined specifiers---@samp{u}.
19763 The next character in the format string should be a letter. Gnus
19764 will call the function @code{gnus-user-format-function-}@samp{X}, where
19765 @samp{X} is the letter following @samp{%u}. The function will be passed
19766 a single parameter---what the parameter means depends on what buffer
19767 it's being called from. The function should return a string, which will
19768 be inserted into the buffer just like information from any other
19769 specifier. This function may also be called with dummy values, so it
19770 should protect against that.
19772 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
19773 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
19775 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
19776 much the same without defining new functions. Here's an example:
19777 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
19778 given here will be evaluated to yield the current line number, and then
19782 @node Formatting Fonts
19783 @subsection Formatting Fonts
19785 There are specs for highlighting, and these are shared by all the format
19786 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
19787 the special @code{mouse-face} property set, which means that it will be
19788 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
19791 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
19792 normal faces set using @code{gnus-face-0}, which is @code{bold} by
19793 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
19794 and so on. Create as many faces as you wish. The same goes for the
19795 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
19796 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
19798 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
19799 special @code{balloon-help} property set to @code{gnus-balloon-face-0}.
19800 If you say @samp{%1<<}, you'll get @code{gnus-balloon-face-1} and so on.
19801 The @code{gnus-balloon-face-*} variables should be either strings or
19802 symbols naming functions that return a string. When the mouse passes
19803 over text with this property set, a balloon window will appear and
19804 display the string. Please refer to @ref{(emacs)Help Echo} (in GNU
19805 Emacs) or the doc string of @code{balloon-help-mode} (in XEmacs) for
19806 more information on this. (For technical reasons, the guillemets have
19807 been approximated as @samp{<<} and @samp{>>} in this paragraph.)
19809 Here's an alternative recipe for the group buffer:
19812 ;; Create three face types.
19813 (setq gnus-face-1 'bold)
19814 (setq gnus-face-3 'italic)
19816 ;; We want the article count to be in
19817 ;; a bold and green face. So we create
19818 ;; a new face called `my-green-bold'.
19819 (copy-face 'bold 'my-green-bold)
19821 (set-face-foreground 'my-green-bold "ForestGreen")
19822 (setq gnus-face-2 'my-green-bold)
19824 ;; Set the new & fancy format.
19825 (setq gnus-group-line-format
19826 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
19829 I'm sure you'll be able to use this scheme to create totally unreadable
19830 and extremely vulgar displays. Have fun!
19832 Note that the @samp{%(} specs (and friends) do not make any sense on the
19833 mode-line variables.
19835 @node Positioning Point
19836 @subsection Positioning Point
19838 Gnus usually moves point to a pre-defined place on each line in most
19839 buffers. By default, point move to the first colon character on the
19840 line. You can customize this behaviour in three different ways.
19842 You can move the colon character to somewhere else on the line.
19844 @findex gnus-goto-colon
19845 You can redefine the function that moves the point to the colon. The
19846 function is called @code{gnus-goto-colon}.
19848 But perhaps the most convenient way to deal with this, if you don't want
19849 to have a colon in your line, is to use the @samp{%*} specifier. If you
19850 put a @samp{%*} somewhere in your format line definition, Gnus will
19855 @subsection Tabulation
19857 You can usually line up your displays by padding and cutting your
19858 strings. However, when combining various strings of different size, it
19859 can often be more convenient to just output the strings, and then worry
19860 about lining up the following text afterwards.
19862 To do that, Gnus supplies tabulator specs--@samp{%=}. There are two
19863 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
19865 @samp{%50=} will insert space characters to pad the line up to column
19866 50. If the text is already past column 50, nothing will be inserted.
19867 This is the soft tabulator.
19869 @samp{%-50=} will insert space characters to pad the line up to column
19870 50. If the text is already past column 50, the excess text past column
19871 50 will be removed. This is the hard tabulator.
19874 @node Wide Characters
19875 @subsection Wide Characters
19877 Proportional fonts in most countries have characters of the same width.
19878 Some countries, however, use Latin characters mixed with wider
19879 characters---most notable East Asian countries.
19881 The problem is that when formatting, Gnus assumes that if a string is 10
19882 characters wide, it'll be 10 Latin characters wide on the screen. In
19883 these countries, that's not true.
19885 @vindex gnus-use-correct-string-widths
19886 To help fix this, you can set @code{gnus-use-correct-string-widths} to
19887 @code{t}. This makes buffer generation slower, but the results will be
19888 prettier. The default value under XEmacs is @code{t} but @code{nil}
19892 @node Window Layout
19893 @section Window Layout
19894 @cindex window layout
19896 No, there's nothing here about X, so be quiet.
19898 @vindex gnus-use-full-window
19899 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
19900 other windows and occupy the entire Emacs screen by itself. It is
19901 @code{t} by default.
19903 Setting this variable to @code{nil} kinda works, but there are
19904 glitches. Use at your own peril.
19906 @vindex gnus-buffer-configuration
19907 @code{gnus-buffer-configuration} describes how much space each Gnus
19908 buffer should be given. Here's an excerpt of this variable:
19911 ((group (vertical 1.0 (group 1.0 point)
19912 (if gnus-carpal (group-carpal 4))))
19913 (article (vertical 1.0 (summary 0.25 point)
19917 This is an alist. The @dfn{key} is a symbol that names some action or
19918 other. For instance, when displaying the group buffer, the window
19919 configuration function will use @code{group} as the key. A full list of
19920 possible names is listed below.
19922 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
19923 should occupy. To take the @code{article} split as an example -
19926 (article (vertical 1.0 (summary 0.25 point)
19930 This @dfn{split} says that the summary buffer should occupy 25% of upper
19931 half of the screen, and that it is placed over the article buffer. As
19932 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
19933 reaching for that calculator there). However, the special number
19934 @code{1.0} is used to signal that this buffer should soak up all the
19935 rest of the space available after the rest of the buffers have taken
19936 whatever they need. There should be only one buffer with the @code{1.0}
19937 size spec per split.
19939 Point will be put in the buffer that has the optional third element
19940 @code{point}. In a @code{frame} split, the last subsplit having a leaf
19941 split where the tag @code{frame-focus} is a member (i.e. is the third or
19942 fourth element in the list, depending on whether the @code{point} tag is
19943 present) gets focus.
19945 Here's a more complicated example:
19948 (article (vertical 1.0 (group 4)
19949 (summary 0.25 point)
19950 (if gnus-carpal (summary-carpal 4))
19954 If the size spec is an integer instead of a floating point number,
19955 then that number will be used to say how many lines a buffer should
19956 occupy, not a percentage.
19958 If the @dfn{split} looks like something that can be @code{eval}ed (to be
19959 precise---if the @code{car} of the split is a function or a subr), this
19960 split will be @code{eval}ed. If the result is non-@code{nil}, it will
19961 be used as a split. This means that there will be three buffers if
19962 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
19965 Not complicated enough for you? Well, try this on for size:
19968 (article (horizontal 1.0
19973 (summary 0.25 point)
19978 Whoops. Two buffers with the mystery 100% tag. And what's that
19979 @code{horizontal} thingie?
19981 If the first element in one of the split is @code{horizontal}, Gnus will
19982 split the window horizontally, giving you two windows side-by-side.
19983 Inside each of these strips you may carry on all you like in the normal
19984 fashion. The number following @code{horizontal} says what percentage of
19985 the screen is to be given to this strip.
19987 For each split, there @emph{must} be one element that has the 100% tag.
19988 The splitting is never accurate, and this buffer will eat any leftover
19989 lines from the splits.
19991 To be slightly more formal, here's a definition of what a valid split
19995 split = frame | horizontal | vertical | buffer | form
19996 frame = "(frame " size *split ")"
19997 horizontal = "(horizontal " size *split ")"
19998 vertical = "(vertical " size *split ")"
19999 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
20000 size = number | frame-params
20001 buf-name = group | article | summary ...
20004 The limitations are that the @code{frame} split can only appear as the
20005 top-level split. @var{form} should be an Emacs Lisp form that should
20006 return a valid split. We see that each split is fully recursive, and
20007 may contain any number of @code{vertical} and @code{horizontal} splits.
20009 @vindex gnus-window-min-width
20010 @vindex gnus-window-min-height
20011 @cindex window height
20012 @cindex window width
20013 Finding the right sizes can be a bit complicated. No window may be less
20014 than @code{gnus-window-min-height} (default 1) characters high, and all
20015 windows must be at least @code{gnus-window-min-width} (default 1)
20016 characters wide. Gnus will try to enforce this before applying the
20017 splits. If you want to use the normal Emacs window width/height limit,
20018 you can just set these two variables to @code{nil}.
20020 If you're not familiar with Emacs terminology, @code{horizontal} and
20021 @code{vertical} splits may work the opposite way of what you'd expect.
20022 Windows inside a @code{horizontal} split are shown side-by-side, and
20023 windows within a @code{vertical} split are shown above each other.
20025 @findex gnus-configure-frame
20026 If you want to experiment with window placement, a good tip is to call
20027 @code{gnus-configure-frame} directly with a split. This is the function
20028 that does all the real work when splitting buffers. Below is a pretty
20029 nonsensical configuration with 5 windows; two for the group buffer and
20030 three for the article buffer. (I said it was nonsensical.) If you
20031 @code{eval} the statement below, you can get an idea of how that would
20032 look straight away, without going through the normal Gnus channels.
20033 Play with it until you're satisfied, and then use
20034 @code{gnus-add-configuration} to add your new creation to the buffer
20035 configuration list.
20038 (gnus-configure-frame
20042 (article 0.3 point))
20050 You might want to have several frames as well. No prob---just use the
20051 @code{frame} split:
20054 (gnus-configure-frame
20057 (summary 0.25 point frame-focus)
20059 (vertical ((height . 5) (width . 15)
20060 (user-position . t)
20061 (left . -1) (top . 1))
20066 This split will result in the familiar summary/article window
20067 configuration in the first (or ``main'') frame, while a small additional
20068 frame will be created where picons will be shown. As you can see,
20069 instead of the normal @code{1.0} top-level spec, each additional split
20070 should have a frame parameter alist as the size spec.
20071 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
20072 Reference Manual}. Under XEmacs, a frame property list will be
20073 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
20075 The list of all possible keys for @code{gnus-buffer-configuration} can
20076 be found in its default value.
20078 Note that the @code{message} key is used for both
20079 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
20080 it is desirable to distinguish between the two, something like this
20084 (message (horizontal 1.0
20085 (vertical 1.0 (message 1.0 point))
20087 (if (buffer-live-p gnus-summary-buffer)
20092 One common desire for a multiple frame split is to have a separate frame
20093 for composing mail and news while leaving the original frame intact. To
20094 accomplish that, something like the following can be done:
20099 (if (not (buffer-live-p gnus-summary-buffer))
20100 (car (cdr (assoc 'group gnus-buffer-configuration)))
20101 (car (cdr (assoc 'summary gnus-buffer-configuration))))
20102 (vertical ((user-position . t) (top . 1) (left . 1)
20103 (name . "Message"))
20104 (message 1.0 point))))
20107 @findex gnus-add-configuration
20108 Since the @code{gnus-buffer-configuration} variable is so long and
20109 complicated, there's a function you can use to ease changing the config
20110 of a single setting: @code{gnus-add-configuration}. If, for instance,
20111 you want to change the @code{article} setting, you could say:
20114 (gnus-add-configuration
20115 '(article (vertical 1.0
20117 (summary .25 point)
20121 You'd typically stick these @code{gnus-add-configuration} calls in your
20122 @file{.gnus.el} file or in some startup hook---they should be run after
20123 Gnus has been loaded.
20125 @vindex gnus-always-force-window-configuration
20126 If all windows mentioned in the configuration are already visible, Gnus
20127 won't change the window configuration. If you always want to force the
20128 ``right'' window configuration, you can set
20129 @code{gnus-always-force-window-configuration} to non-@code{nil}.
20131 If you're using tree displays (@pxref{Tree Display}), and the tree
20132 window is displayed vertically next to another window, you may also want
20133 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
20136 @subsection Example Window Configurations
20140 Narrow left hand side occupied by group buffer. Right hand side split
20141 between summary buffer (top one-sixth) and article buffer (bottom).
20156 (gnus-add-configuration
20159 (vertical 25 (group 1.0))
20161 (summary 0.16 point)
20164 (gnus-add-configuration
20167 (vertical 25 (group 1.0))
20168 (vertical 1.0 (summary 1.0 point)))))
20174 @node Faces and Fonts
20175 @section Faces and Fonts
20180 Fiddling with fonts and faces used to be very difficult, but these days
20181 it is very simple. You simply say @kbd{M-x customize-face}, pick out
20182 the face you want to alter, and alter it via the standard Customize
20187 @section Compilation
20188 @cindex compilation
20189 @cindex byte-compilation
20191 @findex gnus-compile
20193 Remember all those line format specification variables?
20194 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
20195 on. Now, Gnus will of course heed whatever these variables are, but,
20196 unfortunately, changing them will mean a quite significant slow-down.
20197 (The default values of these variables have byte-compiled functions
20198 associated with them, while the user-generated versions do not, of
20201 To help with this, you can run @kbd{M-x gnus-compile} after you've
20202 fiddled around with the variables and feel that you're (kind of)
20203 satisfied. This will result in the new specs being byte-compiled, and
20204 you'll get top speed again. Gnus will save these compiled specs in the
20205 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
20206 this function, though---you should compile them yourself by sticking
20207 them into the @file{.gnus.el} file and byte-compiling that file.)
20211 @section Mode Lines
20214 @vindex gnus-updated-mode-lines
20215 @code{gnus-updated-mode-lines} says what buffers should keep their mode
20216 lines updated. It is a list of symbols. Supported symbols include
20217 @code{group}, @code{article}, @code{summary}, @code{server},
20218 @code{browse}, and @code{tree}. If the corresponding symbol is present,
20219 Gnus will keep that mode line updated with information that may be
20220 pertinent. If this variable is @code{nil}, screen refresh may be
20223 @cindex display-time
20225 @vindex gnus-mode-non-string-length
20226 By default, Gnus displays information on the current article in the mode
20227 lines of the summary and article buffers. The information Gnus wishes
20228 to display (e.g. the subject of the article) is often longer than the
20229 mode lines, and therefore have to be cut off at some point. The
20230 @code{gnus-mode-non-string-length} variable says how long the other
20231 elements on the line is (i.e., the non-info part). If you put
20232 additional elements on the mode line (e.g. a clock), you should modify
20235 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
20237 (add-hook 'display-time-hook
20238 (lambda () (setq gnus-mode-non-string-length
20240 (if line-number-mode 5 0)
20241 (if column-number-mode 4 0)
20242 (length display-time-string)))))
20245 If this variable is @code{nil} (which is the default), the mode line
20246 strings won't be chopped off, and they won't be padded either. Note
20247 that the default is unlikely to be desirable, as even the percentage
20248 complete in the buffer may be crowded off the mode line; the user should
20249 configure this variable appropriately for her configuration.
20252 @node Highlighting and Menus
20253 @section Highlighting and Menus
20255 @cindex highlighting
20258 @vindex gnus-visual
20259 The @code{gnus-visual} variable controls most of the Gnus-prettifying
20260 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
20261 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
20264 This variable can be a list of visual properties that are enabled. The
20265 following elements are valid, and are all included by default:
20268 @item group-highlight
20269 Do highlights in the group buffer.
20270 @item summary-highlight
20271 Do highlights in the summary buffer.
20272 @item article-highlight
20273 Do highlights in the article buffer.
20275 Turn on highlighting in all buffers.
20277 Create menus in the group buffer.
20279 Create menus in the summary buffers.
20281 Create menus in the article buffer.
20283 Create menus in the browse buffer.
20285 Create menus in the server buffer.
20287 Create menus in the score buffers.
20289 Create menus in all buffers.
20292 So if you only want highlighting in the article buffer and menus in all
20293 buffers, you could say something like:
20296 (setq gnus-visual '(article-highlight menu))
20299 If you want highlighting only and no menus whatsoever, you'd say:
20302 (setq gnus-visual '(highlight))
20305 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
20306 in all Gnus buffers.
20308 Other general variables that influence the look of all buffers include:
20311 @item gnus-mouse-face
20312 @vindex gnus-mouse-face
20313 This is the face (i.e., font) used for mouse highlighting in Gnus. No
20314 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
20318 There are hooks associated with the creation of all the different menus:
20322 @item gnus-article-menu-hook
20323 @vindex gnus-article-menu-hook
20324 Hook called after creating the article mode menu.
20326 @item gnus-group-menu-hook
20327 @vindex gnus-group-menu-hook
20328 Hook called after creating the group mode menu.
20330 @item gnus-summary-menu-hook
20331 @vindex gnus-summary-menu-hook
20332 Hook called after creating the summary mode menu.
20334 @item gnus-server-menu-hook
20335 @vindex gnus-server-menu-hook
20336 Hook called after creating the server mode menu.
20338 @item gnus-browse-menu-hook
20339 @vindex gnus-browse-menu-hook
20340 Hook called after creating the browse mode menu.
20342 @item gnus-score-menu-hook
20343 @vindex gnus-score-menu-hook
20344 Hook called after creating the score mode menu.
20355 Those new-fangled @dfn{mouse} contraptions is very popular with the
20356 young, hep kids who don't want to learn the proper way to do things
20357 these days. Why, I remember way back in the summer of '89, when I was
20358 using Emacs on a Tops 20 system. Three hundred users on one single
20359 machine, and every user was running Simula compilers. Bah!
20363 @vindex gnus-carpal
20364 Well, you can make Gnus display bufferfuls of buttons you can click to
20365 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
20366 really. Tell the chiropractor I sent you.
20371 @item gnus-carpal-mode-hook
20372 @vindex gnus-carpal-mode-hook
20373 Hook run in all carpal mode buffers.
20375 @item gnus-carpal-button-face
20376 @vindex gnus-carpal-button-face
20377 Face used on buttons.
20379 @item gnus-carpal-header-face
20380 @vindex gnus-carpal-header-face
20381 Face used on carpal buffer headers.
20383 @item gnus-carpal-group-buffer-buttons
20384 @vindex gnus-carpal-group-buffer-buttons
20385 Buttons in the group buffer.
20387 @item gnus-carpal-summary-buffer-buttons
20388 @vindex gnus-carpal-summary-buffer-buttons
20389 Buttons in the summary buffer.
20391 @item gnus-carpal-server-buffer-buttons
20392 @vindex gnus-carpal-server-buffer-buttons
20393 Buttons in the server buffer.
20395 @item gnus-carpal-browse-buffer-buttons
20396 @vindex gnus-carpal-browse-buffer-buttons
20397 Buttons in the browse buffer.
20400 All the @code{buttons} variables are lists. The elements in these list
20401 are either cons cells where the @code{car} contains a text to be displayed and
20402 the @code{cdr} contains a function symbol, or a simple string.
20410 Gnus, being larger than any program ever written (allegedly), does lots
20411 of strange stuff that you may wish to have done while you're not
20412 present. For instance, you may want it to check for new mail once in a
20413 while. Or you may want it to close down all connections to all servers
20414 when you leave Emacs idle. And stuff like that.
20416 Gnus will let you do stuff like that by defining various
20417 @dfn{handlers}. Each handler consists of three elements: A
20418 @var{function}, a @var{time}, and an @var{idle} parameter.
20420 Here's an example of a handler that closes connections when Emacs has
20421 been idle for thirty minutes:
20424 (gnus-demon-close-connections nil 30)
20427 Here's a handler that scans for PGP headers every hour when Emacs is
20431 (gnus-demon-scan-pgp 60 t)
20434 This @var{time} parameter and than @var{idle} parameter work together
20435 in a strange, but wonderful fashion. Basically, if @var{idle} is
20436 @code{nil}, then the function will be called every @var{time} minutes.
20438 If @var{idle} is @code{t}, then the function will be called after
20439 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
20440 the function will never be called. But once Emacs goes idle, the
20441 function will be called every @var{time} minutes.
20443 If @var{idle} is a number and @var{time} is a number, the function will
20444 be called every @var{time} minutes only when Emacs has been idle for
20445 @var{idle} minutes.
20447 If @var{idle} is a number and @var{time} is @code{nil}, the function
20448 will be called once every time Emacs has been idle for @var{idle}
20451 And if @var{time} is a string, it should look like @samp{07:31}, and
20452 the function will then be called once every day somewhere near that
20453 time. Modified by the @var{idle} parameter, of course.
20455 @vindex gnus-demon-timestep
20456 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
20457 seconds. This is 60 by default. If you change that variable,
20458 all the timings in the handlers will be affected.)
20460 So, if you want to add a handler, you could put something like this in
20461 your @file{.gnus.el} file:
20463 @findex gnus-demon-add-handler
20465 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
20468 @findex gnus-demon-add-nocem
20469 @findex gnus-demon-add-scanmail
20470 @findex gnus-demon-add-rescan
20471 @findex gnus-demon-add-scan-timestamps
20472 @findex gnus-demon-add-disconnection
20473 Some ready-made functions to do this have been created:
20474 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
20475 @code{gnus-demon-add-nntp-close-connection},
20476 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
20477 @code{gnus-demon-add-scanmail}. Just put those functions in your
20478 @file{.gnus.el} if you want those abilities.
20480 @findex gnus-demon-init
20481 @findex gnus-demon-cancel
20482 @vindex gnus-demon-handlers
20483 If you add handlers to @code{gnus-demon-handlers} directly, you should
20484 run @code{gnus-demon-init} to make the changes take hold. To cancel all
20485 daemons, you can use the @code{gnus-demon-cancel} function.
20487 Note that adding daemons can be pretty naughty if you over do it. Adding
20488 functions that scan all news and mail from all servers every two seconds
20489 is a sure-fire way of getting booted off any respectable system. So
20498 @dfn{Spamming} is posting the same article lots and lots of times.
20499 Spamming is bad. Spamming is evil.
20501 Spamming is usually canceled within a day or so by various anti-spamming
20502 agencies. These agencies usually also send out @dfn{NoCeM} messages.
20503 NoCeM is pronounced ``no see-'em'', and means what the name
20504 implies---these are messages that make the offending articles, like, go
20507 What use are these NoCeM messages if the articles are canceled anyway?
20508 Some sites do not honor cancel messages and some sites just honor cancels
20509 from a select few people. Then you may wish to make use of the NoCeM
20510 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
20512 Gnus can read and parse the messages in this group automatically, and
20513 this will make spam disappear.
20515 There are some variables to customize, of course:
20518 @item gnus-use-nocem
20519 @vindex gnus-use-nocem
20520 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
20523 @item gnus-nocem-groups
20524 @vindex gnus-nocem-groups
20525 Gnus will look for NoCeM messages in the groups in this list. The
20526 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
20527 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
20529 @item gnus-nocem-issuers
20530 @vindex gnus-nocem-issuers
20531 There are many people issuing NoCeM messages. This list says what
20532 people you want to listen to. The default is @code{("Automoose-1"
20533 "clewis@@ferret.ocunix.on.ca" "cosmo.roadkill" "SpamHippo"
20534 "hweede@@snafu.de")}; fine, upstanding citizens all of them.
20536 Known despammers that you can put in this list are listed at
20537 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
20539 You do not have to heed NoCeM messages from all these people---just the
20540 ones you want to listen to. You also don't have to accept all NoCeM
20541 messages from the people you like. Each NoCeM message has a @dfn{type}
20542 header that gives the message a (more or less, usually less) rigorous
20543 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
20544 @samp{binary}, and @samp{troll}. To specify this, you have to use
20545 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
20546 Each condition is either a string (which is a regexp that matches types
20547 you want to use) or a list on the form @code{(not @var{string})}, where
20548 @var{string} is a regexp that matches types you don't want to use.
20550 For instance, if you want all NoCeM messages from Chris Lewis except his
20551 @samp{troll} messages, you'd say:
20554 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
20557 On the other hand, if you just want nothing but his @samp{spam} and
20558 @samp{spew} messages, you'd say:
20561 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
20564 The specs are applied left-to-right.
20567 @item gnus-nocem-verifyer
20568 @vindex gnus-nocem-verifyer
20570 This should be a function for verifying that the NoCeM issuer is who she
20571 says she is. The default is @code{mc-verify}, which is a Mailcrypt
20572 function. If this is too slow and you don't care for verification
20573 (which may be dangerous), you can set this variable to @code{nil}.
20575 If you want signed NoCeM messages to be verified and unsigned messages
20576 not to be verified (but used anyway), you could do something like:
20579 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
20581 (defun my-gnus-mc-verify ()
20589 This might be dangerous, though.
20591 @item gnus-nocem-directory
20592 @vindex gnus-nocem-directory
20593 This is where Gnus will store its NoCeM cache files. The default is
20594 @file{~/News/NoCeM/}.
20596 @item gnus-nocem-expiry-wait
20597 @vindex gnus-nocem-expiry-wait
20598 The number of days before removing old NoCeM entries from the cache.
20599 The default is 15. If you make it shorter Gnus will be faster, but you
20600 might then see old spam.
20602 @item gnus-nocem-check-from
20603 @vindex gnus-nocem-check-from
20604 Non-@code{nil} means check for valid issuers in message bodies.
20605 Otherwise don't bother fetching articles unless their author matches a
20606 valid issuer; that is much faster if you are selective about the
20609 @item gnus-nocem-check-article-limit
20610 @vindex gnus-nocem-check-article-limit
20611 If non-@code{nil}, the maximum number of articles to check in any NoCeM
20612 group. NoCeM groups can be huge and very slow to process.
20616 Using NoCeM could potentially be a memory hog. If you have many living
20617 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
20618 big. If this is a problem, you should kill off all (or most) of your
20619 unsubscribed groups (@pxref{Subscription Commands}).
20626 It is very useful to be able to undo actions one has done. In normal
20627 Emacs buffers, it's easy enough---you just push the @code{undo} button.
20628 In Gnus buffers, however, it isn't that simple.
20630 The things Gnus displays in its buffer is of no value whatsoever to
20631 Gnus---it's all just data designed to look nice to the user.
20632 Killing a group in the group buffer with @kbd{C-k} makes the line
20633 disappear, but that's just a side-effect of the real action---the
20634 removal of the group in question from the internal Gnus structures.
20635 Undoing something like that can't be done by the normal Emacs
20636 @code{undo} function.
20638 Gnus tries to remedy this somewhat by keeping track of what the user
20639 does and coming up with actions that would reverse the actions the user
20640 takes. When the user then presses the @code{undo} key, Gnus will run
20641 the code to reverse the previous action, or the previous actions.
20642 However, not all actions are easily reversible, so Gnus currently offers
20643 a few key functions to be undoable. These include killing groups,
20644 yanking groups, and changing the list of read articles of groups.
20645 That's it, really. More functions may be added in the future, but each
20646 added function means an increase in data to be stored, so Gnus will
20647 never be totally undoable.
20649 @findex gnus-undo-mode
20650 @vindex gnus-use-undo
20652 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
20653 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
20654 default. The @kbd{C-M-_} key performs the @code{gnus-undo}
20655 command, which should feel kinda like the normal Emacs @code{undo}
20659 @node Predicate Specifiers
20660 @section Predicate Specifiers
20661 @cindex predicate specifiers
20663 Some Gnus variables are @dfn{predicate specifiers}. This is a special
20664 form that allows flexible specification of predicates without having
20665 to type all that much.
20667 These specifiers are lists consisting of functions, symbols and lists.
20672 (or gnus-article-unseen-p
20673 gnus-article-unread-p)
20676 The available symbols are @code{or}, @code{and} and @code{not}. The
20677 functions all take one parameter.
20679 @findex gnus-make-predicate
20680 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
20681 to create a function that can be called. This input parameter to this
20682 function will be passed along to all the functions in the predicate
20687 @section Moderation
20690 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
20691 It is not included in the standard Gnus package. Write a mail to
20692 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
20695 The moderation package is implemented as a minor mode for summary
20699 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
20702 in your @file{.gnus.el} file.
20704 If you are the moderator of @samp{rec.zoofle}, this is how it's
20709 You split your incoming mail by matching on
20710 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
20711 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
20714 You enter that group once in a while and post articles using the @kbd{e}
20715 (edit-and-post) or @kbd{s} (just send unedited) commands.
20718 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
20719 articles that weren't approved by you, you can cancel them with the
20723 To use moderation mode in these two groups, say:
20726 (setq gnus-moderated-list
20727 "^nnml:rec.zoofle$\\|^rec.zoofle$")
20731 @node Image Enhancements
20732 @section Image Enhancements
20734 XEmacs, as well as Emacs 21, is able to display pictures and stuff, so
20735 Gnus has taken advantage of that.
20738 * Picons:: How to display pictures of what you're reading.
20739 * Smileys:: Show all those happy faces the way they were meant to be shown.
20740 * X-Face:: Display a funky, teensy black-and-white image.
20741 * XVarious:: Other XEmacsy Gnusey variables.
20754 So@dots{} You want to slow down your news reader even more! This is a
20755 good way to do so. Its also a great way to impress people staring
20756 over your shoulder as you read news.
20758 What are Picons? To quote directly from the Picons Web site:
20767 @dfn{Picons} is short for ``personal icons''. They're small,
20768 constrained images used to represent users and domains on the net,
20769 organized into databases so that the appropriate image for a given
20770 e-mail address can be found. Besides users and domains, there are picon
20771 databases for Usenet newsgroups and weather forecasts. The picons are
20772 in either monochrome @code{XBM} format or color @code{XPM} and
20773 @code{GIF} formats.
20776 @vindex gnus-picon-databases
20777 For instructions on obtaining and installing the picons databases,
20778 point your Web browser at
20779 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.
20781 If you are using Debian GNU/Linux, saying @samp{apt-get install
20782 picons.*} will install the picons where Gnus can find them.
20784 To enable displaying picons, simply make sure that
20785 @code{gnus-picon-databases} points to the directory containing the
20788 The following variables offer control over where things are located.
20792 @item gnus-picon-databases
20793 @vindex gnus-picon-databases
20794 The location of the picons database. This is a list of directories
20795 containing the @file{news}, @file{domains}, @file{users} (and so on)
20796 subdirectories. Defaults to @code{("/usr/lib/picon"
20797 "/usr/local/faces")}.
20799 @item gnus-picon-news-directories
20800 @vindex gnus-picon-news-directories
20801 List of subdirectories to search in @code{gnus-picon-databases} for
20802 newsgroups faces. @code{("news")} is the default.
20804 @item gnus-picon-user-directories
20805 @vindex gnus-picon-user-directories
20806 List of subdirectories to search in @code{gnus-picon-databases} for user
20807 faces. @code{("users" "usenix" "local" "misc")} is the default.
20809 @item gnus-picon-domain-directories
20810 @vindex gnus-picon-domain-directories
20811 List of subdirectories to search in @code{gnus-picon-databases} for
20812 domain name faces. Defaults to @code{("domains")}. Some people may
20813 want to add @samp{"unknown"} to this list.
20815 @item gnus-picon-file-types
20816 @vindex gnus-picon-file-types
20817 Ordered list of suffixes on picon file names to try. Defaults to
20818 @code{("xpm" "gif" "xbm")} minus those not builtin your Emacs.
20823 @subsection Smileys
20828 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
20833 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
20834 currently the only package that uses Smiley, it is documented here.
20836 In short---to use Smiley in Gnus, put the following in your
20837 @file{.gnus.el} file:
20840 (setq gnus-treat-display-smileys t)
20843 Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and
20844 the like---to pictures and displays those instead of the text smiley
20845 faces. The conversion is controlled by a list of regexps that matches
20846 text and maps that to file names.
20848 @vindex smiley-regexp-alist
20849 The alist used is specified by the @code{smiley-regexp-alist}
20850 variable. The first item in each element is the regexp to be matched;
20851 the second element is the regexp match group that is to be replaced by
20852 the picture; and the third element is the name of the file to be
20855 The following variables customize where Smiley will look for these
20860 @item smiley-data-directory
20861 @vindex smiley-data-directory
20862 Where Smiley will look for smiley faces files.
20864 @item gnus-smiley-file-types
20865 @vindex gnus-smiley-file-types
20866 List of suffixes on smiley file names to try.
20875 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
20876 depth) image that's supposed to represent the author of the message.
20877 It seems to be supported by an ever-growing number of mail and news
20881 @findex gnus-article-display-x-face
20882 @findex gnus-article-x-face-command
20883 @vindex gnus-article-x-face-command
20884 @vindex gnus-article-x-face-too-ugly
20892 Decoding an @code{X-Face} header either requires an Emacs that has
20893 @samp{compface} support (which most XEmacs versions has), or that you
20894 have @samp{compface} installed on your system. If either is true,
20895 Gnus will default to displaying @code{X-Face} headers.
20897 The variable that controls this is the
20898 @code{gnus-article-x-face-command} variable. If this variable is a
20899 string, this string will be executed in a sub-shell. If it is a
20900 function, this function will be called with the face as the argument.
20901 If the @code{gnus-article-x-face-too-ugly} (which is a regexp) matches
20902 the @code{From} header, the face will not be shown.
20904 The default action under Emacs 20 is to fork off the @code{display}
20905 program@footnote{@code{display} is from the ImageMagick package. For
20906 the @code{uncompface} and @code{icontopbm} programs look for a package
20907 like @code{compface} or @code{faces-xface} on a GNU/Linux system.} to
20910 Under XEmacs or Emacs 21+ with suitable image support, the default
20911 action is to display the face before the @code{From} header. (It's
20912 nicer if XEmacs has been compiled with @code{X-Face} support---that
20913 will make display somewhat faster. If there's no native @code{X-Face}
20914 support, Gnus will try to convert the @code{X-Face} header using
20915 external programs from the @code{pbmplus} package and
20916 friends.@footnote{On a GNU/Linux system look for packages with names
20917 like @code{netpbm}, @code{libgr-progs} and @code{compface}.})
20919 (NOTE: @code{x-face} is used in the variable/function names, not
20922 Gnus provides a few convenience functions and variables to allow
20923 easier insertion of X-Face headers in outgoing messages.
20925 @findex gnus-random-x-face
20926 @vindex gnus-convert-pbm-to-x-face-command
20927 @vindex gnus-x-face-directory
20928 @code{gnus-random-x-face} goes through all the @samp{pbm} files in
20929 @code{gnus-x-face-directory} and picks one at random, and then
20930 converts it to the X-Face format by using the
20931 @code{gnus-convert-pbm-to-x-face-command} shell command. The
20932 @samp{pbm} files should be 48x48 pixels big. It returns the X-Face
20933 header data as a string.
20935 @findex gnus-insert-random-x-face-header
20936 @code{gnus-insert-random-x-face-header} calls
20937 @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the
20938 randomly generated data.
20940 @findex gnus-x-face-from-file
20941 @vindex gnus-convert-image-to-x-face-command
20942 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
20943 converts the file to X-Face format by using the
20944 @code{gnus-convert-image-to-x-face-command} shell command.
20946 Here's how you would typically use the first function. Put something
20947 like the following in your @file{.gnus.el} file:
20950 (setq message-required-news-headers
20951 (nconc message-required-news-headers
20952 (list '(X-Face . gnus-random-x-face))))
20955 Using the last function would be something like this:
20958 (setq message-required-news-headers
20959 (nconc message-required-news-headers
20960 (list '(X-Face . (lambda ()
20961 (gnus-x-face-from-file
20962 "~/My-face.gif"))))))
20967 @subsection Various XEmacs Variables
20970 @item gnus-xmas-glyph-directory
20971 @vindex gnus-xmas-glyph-directory
20972 This is where Gnus will look for pictures. Gnus will normally
20973 auto-detect this directory, but you may set it manually if you have an
20974 unusual directory structure.
20976 @item gnus-xmas-logo-color-alist
20977 @vindex gnus-xmas-logo-color-alist
20978 This is an alist where the key is a type symbol and the values are the
20979 foreground and background color of the splash page glyph.
20981 @item gnus-xmas-logo-color-style
20982 @vindex gnus-xmas-logo-color-style
20983 This is the key used to look up the color in the alist described above.
20984 Valid values include @code{flame}, @code{pine}, @code{moss},
20985 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
20986 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
20988 @item gnus-xmas-modeline-glyph
20989 @vindex gnus-xmas-modeline-glyph
20990 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
20995 @subsubsection Toolbar
20999 @item gnus-use-toolbar
21000 @vindex gnus-use-toolbar
21001 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
21002 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
21003 @code{right-toolbar}, or @code{left-toolbar}.
21005 @item gnus-group-toolbar
21006 @vindex gnus-group-toolbar
21007 The toolbar in the group buffer.
21009 @item gnus-summary-toolbar
21010 @vindex gnus-summary-toolbar
21011 The toolbar in the summary buffer.
21013 @item gnus-summary-mail-toolbar
21014 @vindex gnus-summary-mail-toolbar
21015 The toolbar in the summary buffer of mail groups.
21026 @node Fuzzy Matching
21027 @section Fuzzy Matching
21028 @cindex fuzzy matching
21030 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
21031 things like scoring, thread gathering and thread comparison.
21033 As opposed to regular expression matching, fuzzy matching is very fuzzy.
21034 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
21035 means, and the implementation has changed over time.
21037 Basically, it tries to remove all noise from lines before comparing.
21038 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
21039 out of the strings before comparing the results. This often leads to
21040 adequate results---even when faced with strings generated by text
21041 manglers masquerading as newsreaders.
21044 @node Thwarting Email Spam
21045 @section Thwarting Email Spam
21049 @cindex unsolicited commercial email
21051 In these last days of the Usenet, commercial vultures are hanging about
21052 and grepping through news like crazy to find email addresses they can
21053 foist off their scams and products to. As a reaction to this, many
21054 people have started putting nonsense addresses into their @code{From}
21055 lines. I think this is counterproductive---it makes it difficult for
21056 people to send you legitimate mail in response to things you write, as
21057 well as making it difficult to see who wrote what. This rewriting may
21058 perhaps be a bigger menace than the unsolicited commercial email itself
21061 The biggest problem I have with email spam is that it comes in under
21062 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
21063 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
21064 mail group, only to find two pyramid schemes, seven advertisements
21065 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
21066 and one mail asking me to repent and find some god.
21068 This is annoying. Here's what you can do about it.
21071 * The problem of spam:: Some background, and some solutions
21072 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
21073 * SpamAssassin:: How to use external anti-spam tools.
21074 * Hashcash:: Reduce spam by burning CPU time.
21075 * Filtering Spam Using The Spam ELisp Package::
21076 * Filtering Spam Using Statistics with spam-stat::
21079 @node The problem of spam
21080 @subsection The problem of spam
21082 @cindex spam filtering approaches
21083 @cindex filtering approaches, spam
21085 @cindex unsolicited commercial email
21087 First, some background on spam.
21089 If you have access to e-mail, you are familiar with spam (technically
21090 termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it exists
21091 because e-mail delivery is very cheap compared to paper mail, so only
21092 a very small percentage of people need to respond to an UCE to make it
21093 worthwhile to the advertiser. Ironically, one of the most common
21094 spams is the one offering a database of e-mail addresses for further
21095 spamming. Senders of spam are usually called @emph{spammers}, but terms like
21096 @emph{vermin}, @emph{scum}, and @emph{morons} are in common use as well.
21098 Spam comes from a wide variety of sources. It is simply impossible to
21099 dispose of all spam without discarding useful messages. A good
21100 example is the TMDA system, which requires senders
21101 unknown to you to confirm themselves as legitimate senders before
21102 their e-mail can reach you. Without getting into the technical side
21103 of TMDA, a downside is clearly that e-mail from legitimate sources may
21104 be discarded if those sources can't or won't confirm themselves
21105 through the TMDA system. Another problem with TMDA is that it
21106 requires its users to have a basic understanding of e-mail delivery
21109 The simplest approach to filtering spam is filtering. If you get 200
21110 spam messages per day from @email{random-address@@vmadmin.com}, you
21111 block @samp{vmadmin.com}. If you get 200 messages about
21112 @samp{VIAGRA}, you discard all messages with @samp{VIAGRA} in the
21113 message. This, unfortunately, is a great way to discard legitimate
21114 e-mail. For instance, the very informative and useful RISKS digest
21115 has been blocked by overzealous mail filters because it
21116 @strong{contained} words that were common in spam messages.
21117 Nevertheless, in isolated cases, with great care, direct filtering of
21118 mail can be useful.
21120 Another approach to filtering e-mail is the distributed spam
21121 processing, for instance DCC implements such a system. In essence,
21122 @code{N} systems around the world agree that a machine @samp{X} in
21123 China, Ghana, or California is sending out spam e-mail, and these
21124 @code{N} systems enter @samp{X} or the spam e-mail from @samp{X} into
21125 a database. The criteria for spam detection vary - it may be the
21126 number of messages sent, the content of the messages, and so on. When
21127 a user of the distributed processing system wants to find out if a
21128 message is spam, he consults one of those @code{N} systems.
21130 Distributed spam processing works very well against spammers that send
21131 a large number of messages at once, but it requires the user to set up
21132 fairly complicated checks. There are commercial and free distributed
21133 spam processing systems. Distributed spam processing has its risks as
21134 well. For instance legitimate e-mail senders have been accused of
21135 sending spam, and their web sites have been shut down for some time
21136 because of the incident.
21138 The statistical approach to spam filtering is also popular. It is
21139 based on a statistical analysis of previous spam messages. Usually
21140 the analysis is a simple word frequency count, with perhaps pairs of
21141 words or 3-word combinations thrown into the mix. Statistical
21142 analysis of spam works very well in most of the cases, but it can
21143 classify legitimate e-mail as spam in some cases. It takes time to
21144 run the analysis, the full message must be analyzed, and the user has
21145 to store the database of spam analyses.
21147 @node Anti-Spam Basics
21148 @subsection Anti-Spam Basics
21152 @cindex unsolicited commercial email
21154 One way of dealing with spam is having Gnus split out all spam into a
21155 @samp{spam} mail group (@pxref{Splitting Mail}).
21157 First, pick one (1) valid mail address that you can be reached at, and
21158 put it in your @code{From} header of all your news articles. (I've
21159 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
21160 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
21161 sysadmin whether your sendmail installation accepts keywords in the local
21162 part of the mail address.)
21165 (setq message-default-news-headers
21166 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
21169 Then put the following split rule in @code{nnmail-split-fancy}
21170 (@pxref{Fancy Mail Splitting}):
21175 (to "larsi@@trym.ifi.uio.no"
21176 (| ("subject" "re:.*" "misc")
21177 ("references" ".*@@.*" "misc")
21183 This says that all mail to this address is suspect, but if it has a
21184 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
21185 header, it's probably ok. All the rest goes to the @samp{spam} group.
21186 (This idea probably comes from Tim Pierce.)
21188 In addition, many mail spammers talk directly to your @sc{smtp} server
21189 and do not include your email address explicitly in the @code{To}
21190 header. Why they do this is unknown---perhaps it's to thwart this
21191 thwarting scheme? In any case, this is trivial to deal with---you just
21192 put anything not addressed to you in the @samp{spam} group by ending
21193 your fancy split rule in this way:
21198 (to "larsi" "misc")
21202 In my experience, this will sort virtually everything into the right
21203 group. You still have to check the @samp{spam} group from time to time to
21204 check for legitimate mail, though. If you feel like being a good net
21205 citizen, you can even send off complaints to the proper authorities on
21206 each unsolicited commercial email---at your leisure.
21208 If you are also a lazy net citizen, you will probably prefer complaining
21209 automatically with the @file{gnus-junk.el} package, available FOR FREE
21210 at @* @uref{http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html}.
21211 Since most e-mail spam is sent automatically, this may reconcile the
21212 cosmic balance somewhat.
21214 This works for me. It allows people an easy way to contact me (they can
21215 just press @kbd{r} in the usual way), and I'm not bothered at all with
21216 spam. It's a win-win situation. Forging @code{From} headers to point
21217 to non-existent domains is yucky, in my opinion.
21222 @subsection SpamAssassin, Vipul's Razor, DCC, etc
21223 @cindex SpamAssassin
21224 @cindex Vipul's Razor
21227 The days where the hints in the previous section was sufficient in
21228 avoiding spam is coming to an end. There are many tools out there
21229 that claim to reduce the amount of spam you get. This section could
21230 easily become outdated fast, as new products replace old, but
21231 fortunately most of these tools seem to have similar interfaces. Even
21232 though this section will use SpamAssassin as an example, it should be
21233 easy to adapt it to most other tools.
21235 If the tool you are using is not installed on the mail server, you
21236 need to invoke it yourself. Ideas on how to use the
21237 @code{:postscript} mail source parameter (@pxref{Mail Source
21238 Specifiers}) follows.
21242 '((file :prescript "formail -bs spamassassin < /var/mail/%u")
21245 :postscript "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
21248 Once you managed to process your incoming spool somehow, thus making
21249 the mail contain e.g. a header indicating it is spam, you are ready to
21250 filter it out. Using normal split methods (@pxref{Splitting Mail}):
21253 (setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES")
21257 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
21260 (setq nnmail-split-methods 'nnmail-split-fancy
21261 nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
21265 Some people might not like the idea of piping the mail through various
21266 programs using a @code{:prescript} (if some program is buggy, you
21267 might lose all mail). If you are one of them, another solution is to
21268 call the external tools during splitting. Example fancy split method:
21271 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
21273 (defun kevin-spamassassin ()
21275 (let ((buf (or (get-buffer " *nnmail incoming*")
21276 (get-buffer " *nnml move*"))))
21278 (progn (message "Oops, cannot find message buffer") nil)
21280 (if (eq 1 (call-process-region (point-min) (point-max)
21281 "spamc" nil nil nil "-c"))
21285 That is about it. As some spam is likely to get through anyway, you
21286 might want to have a nifty function to call when you happen to read
21287 spam. And here is the nifty function:
21290 (defun my-gnus-raze-spam ()
21291 "Submit SPAM to Vipul's Razor, then mark it as expirable."
21293 (gnus-summary-show-raw-article)
21294 (gnus-summary-save-in-pipe "razor-report -f -d")
21295 (gnus-summary-mark-as-expirable 1))
21299 @subsection Hashcash
21302 A novel technique to fight spam is to require senders to do something
21303 costly for each message they send. This has the obvious drawback that
21304 you cannot rely on that everyone in the world uses this technique,
21305 since it is not part of the Internet standards, but it may be useful
21306 in smaller communities.
21308 While the tools in the previous section work well in practice, they
21309 work only because the tools are constantly maintained and updated as
21310 new form of spam appears. This means that a small percentage of spam
21311 will always get through. It also means that somewhere, someone needs
21312 to read lots of spam to update these tools. Hashcash avoids that, but
21313 instead requires that everyone you communicate with supports the
21314 scheme. You can view the two approaches as pragmatic vs dogmatic.
21315 The approaches have their own advantages and disadvantages, but as
21316 often in the real world, a combination of them is stronger than either
21317 one of them separately.
21320 The ``something costly'' is to burn CPU time, more specifically to
21321 compute a hash collision up to a certain number of bits. The
21322 resulting hashcash cookie is inserted in a @samp{X-Hashcash:}
21323 header. For more details, and for the external application
21324 @code{hashcash} you need to install to use this feature, see
21325 @uref{http://www.cypherspace.org/~adam/hashcash/}. Even more
21326 information can be found at @uref{http://www.camram.org/}.
21328 If you wish to call hashcash for each message you send, say something
21332 (require 'hashcash)
21333 (add-hook 'message-send-hook 'mail-add-payment)
21336 The @code{hashcash.el} library can be found at
21337 @uref{http://users.actrix.gen.nz/mycroft/hashcash.el}, or in the Gnus
21338 development contrib directory.
21340 You will need to set up some additional variables as well:
21344 @item hashcash-default-payment
21345 @vindex hashcash-default-payment
21346 This variable indicates the default number of bits the hash collision
21347 should consist of. By default this is 0, meaning nothing will be
21348 done. Suggested useful values include 17 to 29.
21350 @item hashcash-payment-alist
21351 @vindex hashcash-payment-alist
21352 Some receivers may require you to spend burn more CPU time than the
21353 default. This variable contains a list of @samp{(ADDR AMOUNT)} cells,
21354 where ADDR is the receiver (email address or newsgroup) and AMOUNT is
21355 the number of bits in the collision that is needed. It can also
21356 contain @samp{(ADDR STRING AMOUNT)} cells, where the STRING is the
21357 string to use (normally the email address or newsgroup name is used).
21361 Where the @code{hashcash} binary is installed.
21365 Currently there is no built in functionality in Gnus to verify
21366 hashcash cookies, it is expected that this is performed by your hand
21367 customized mail filtering scripts. Improvements in this area would be
21368 a useful contribution, however.
21370 @node Filtering Spam Using The Spam ELisp Package
21371 @subsection Filtering Spam Using The Spam ELisp Package
21372 @cindex spam filtering
21375 The idea behind @code{spam.el} is to have a control center for spam detection
21376 and filtering in Gnus. To that end, @code{spam.el} does two things: it
21377 filters incoming mail, and it analyzes mail known to be spam or ham.
21378 @emph{Ham} is the name used throughout @code{spam.el} to indicate
21381 So, what happens when you load @code{spam.el}? First of all, you get
21382 the following keyboard commands:
21392 @findex gnus-summary-mark-as-spam
21393 @code{gnus-summary-mark-as-spam}.
21395 Mark current article as spam, showing it with the @samp{$} mark.
21396 Whenever you see a spam article, make sure to mark its summary line
21397 with @kbd{M-d} before leaving the group. This is done automatically
21398 for unread articles in @emph{spam} groups.
21404 @findex spam-bogofilter-score
21405 @code{spam-bogofilter-score}.
21407 You must have Bogofilter installed for that command to work properly.
21413 Also, when you load @code{spam.el}, you will be able to customize its
21414 variables. Try @code{customize-group} on the @samp{spam} variable
21417 The concepts of ham processors and spam processors are very important.
21418 Ham processors and spam processors for a group can be set with the
21419 @code{spam-process} group parameter, or the
21420 @code{gnus-spam-process-newsgroups} variable. Ham processors take
21421 mail known to be non-spam (@emph{ham}) and process it in some way so
21422 that later similar mail will also be considered non-spam. Spam
21423 processors take mail known to be spam and process it so similar spam
21424 will be detected later.
21426 Gnus learns from the spam you get. You have to collect your spam in
21427 one or more spam groups, and set or customize the variable
21428 @code{spam-junk-mailgroups} as appropriate. You can also declare
21429 groups to contain spam by setting their group parameter
21430 @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or
21431 by customizing the corresponding variable
21432 @code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group
21433 parameter and the @code{gnus-spam-newsgroup-contents} variable can
21434 also be used to declare groups as @emph{ham} groups if you set their
21435 classification to @code{gnus-group-spam-classification-ham}. If
21436 groups are not classified by means of @code{spam-junk-mailgroups},
21437 @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are
21438 considered @emph{unclassified}. All groups are unclassified by
21441 In spam groups, all messages are considered to be spam by default:
21442 they get the @samp{$} mark when you enter the group. You must review
21443 these messages from time to time and remove the @samp{$} mark for
21444 every message that is not spam after all. To remove the @samp{$}
21445 mark, you can use @kbd{M-u} to "unread" the article, or @kbd{d} for
21446 declaring it read the non-spam way. When you leave a group, all
21447 spam-marked (@samp{$}) articles are sent to a spam processor which
21448 will study them as spam samples.
21450 Messages may also be deleted in various other ways, and unless
21451 @code{spam-ham-marks} gets overridden below, marks @samp{R} and
21452 @samp{r} for default read or explicit delete, marks @samp{X} and
21453 @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for
21454 low scores, are all considered to be associated with articles which
21455 are not spam. This assumption might be false, in particular if you
21456 use kill files or score files as means for detecting genuine spam, you
21457 should then adjust the @code{spam-ham-marks} variable.
21459 @defvar spam-ham-marks
21460 You can customize this variable to be the list of marks you want to
21461 consider ham. By default, the list contains the deleted, read,
21462 killed, kill-filed, and low-score marks.
21465 @defvar spam-spam-marks
21466 You can customize this variable to be the list of marks you want to
21467 consider spam. By default, the list contains only the spam mark.
21470 When you leave @emph{any} group, regardless of its
21471 @code{spam-contents} classification, all spam-marked articles are sent
21472 to a spam processor, which will study these as spam samples. If you
21473 explicit kill a lot, you might sometimes end up with articles marked
21474 @samp{K} which you never saw, and which might accidentally contain
21475 spam. Best is to make sure that real spam is marked with @samp{$},
21478 When you leave a @emph{spam} group, all spam-marked articles are
21479 marked as expired after processing with the spam processor. This is
21480 not done for @emph{unclassified} or @emph{ham} groups. Also, any
21481 @strong{ham} articles in a spam group will be moved to a location
21482 determined by either the @code{ham-process-destination} group
21483 parameter or a match in the @code{gnus-ham-process-destinations}
21484 variable, which is a list of regular expressions matched with group
21485 names (it's easiest to customize this variable with
21486 @code{customize-variable gnus-ham-process-destinations}). The ultimate
21487 location is a group name. If the @code{ham-process-destination}
21488 parameter is not set, spam articles are only expired.
21490 When you leave a @emph{ham} group, all ham-marked articles are sent to
21491 a ham processor, which will study these as non-spam samples.
21493 When you leave a @emph{ham} or @emph{unclassified} group, all
21494 @strong{spam} articles are moved to a location determined by either
21495 the @code{spam-process-destination} group parameter or a match in the
21496 @code{gnus-spam-process-destinations} variable, which is a list of
21497 regular expressions matched with group names (it's easiest to
21498 customize this variable with @code{customize-variable
21499 gnus-spam-process-destinations}). The ultimate location is a group
21500 name. If the @code{spam-process-destination} parameter is not set,
21501 the spam articles are only expired.
21503 To use the @code{spam.el} facilities for incoming mail filtering, you
21504 must add the following to your fancy split list
21505 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}:
21511 Note that the fancy split may be called @code{nnmail-split-fancy} or
21512 @code{nnimap-split-fancy}, depending on whether you use the nnmail or
21513 nnimap back ends to retrieve your mail.
21515 The @code{spam-split} function will process incoming mail and send the
21516 mail considered to be spam into the group name given by the variable
21517 @code{spam-split-group}. By default that group name is @samp{spam},
21518 but you can customize it.
21520 @emph{Note for IMAP users}
21522 The boolean variable @code{nnimap-split-download-body} needs to be
21523 set, if you want to split based on the whole message instead of just
21524 the headers. By default, the nnimap backend will only retrieve the
21525 message headers. If you use spam-check-bogofilter, spam-check-ifile,
21526 or spam-check-stat (the splitters that can benefit from the full
21527 message body), you should set this variable. It is not set by default
21528 because it will slow IMAP down.
21530 @xref{Splitting in IMAP}.
21532 @emph{TODO: Currently, spam.el only supports insertion of articles
21533 into a backend. There is no way to tell spam.el that an article is no
21534 longer spam or ham.}
21536 @emph{TODO: spam.el needs to provide a uniform way of training all the
21537 statistical databases. Some have that functionality built-in, others
21540 The following are the methods you can use to control the behavior of
21541 @code{spam-split} and their corresponding spam and ham processors:
21544 * Blacklists and Whitelists::
21545 * BBDB Whitelists::
21547 * Regular Expressions Header Matching::
21549 * ifile spam filtering::
21550 * spam-stat spam filtering::
21551 * Extending the spam elisp package::
21554 @node Blacklists and Whitelists
21555 @subsubsection Blacklists and Whitelists
21556 @cindex spam filtering
21557 @cindex whitelists, spam filtering
21558 @cindex blacklists, spam filtering
21561 @defvar spam-use-blacklist
21562 Set this variable to @code{t} if you want to use blacklists when
21563 splitting incoming mail. Messages whose senders are in the blacklist
21564 will be sent to the @code{spam-split-group}. This is an explicit
21565 filter, meaning that it acts only on mail senders @emph{declared} to
21569 @defvar spam-use-whitelist
21570 Set this variable to @code{t} if you want to use whitelists when
21571 splitting incoming mail. Messages whose senders are not in the
21572 whitelist will be sent to the @code{spam-split-group}. This is an
21573 implicit filter, meaning it believes everyone to be a spammer unless
21574 told otherwise. Use with care.
21577 @defvar gnus-group-spam-exit-processor-blacklist
21578 Add this symbol to a group's @code{spam-process} parameter by
21579 customizing the group parameters or the
21580 @code{gnus-spam-process-newsgroups} variable. When this symbol is
21581 added to a group's @code{spam-process} parameter, the senders of
21582 spam-marked articles will be added to the blacklist.
21585 @defvar gnus-group-ham-exit-processor-whitelist
21586 Add this symbol to a group's @code{spam-process} parameter by
21587 customizing the group parameters or the
21588 @code{gnus-spam-process-newsgroups} variable. When this symbol is
21589 added to a group's @code{spam-process} parameter, the senders of
21590 ham-marked articles in @emph{ham} groups will be added to the
21591 whitelist. Note that this ham processor has no effect in @emph{spam}
21592 or @emph{unclassified} groups.
21595 Blacklists are lists of regular expressions matching addresses you
21596 consider to be spam senders. For instance, to block mail from any
21597 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
21598 blacklist. You start out with an empty blacklist. Blacklist entries
21599 use the Emacs regular expression syntax.
21601 Conversely, whitelists tell Gnus what addresses are considered
21602 legitimate. All non-whitelisted addresses are considered spammers.
21603 This option is probably not useful for most Gnus users unless the
21604 whitelists is very comprehensive or permissive. Also see @ref{BBDB
21605 Whitelists}. Whitelist entries use the Emacs regular expression
21608 The blacklist and whitelist file locations can be customized with the
21609 @code{spam-directory} variable (@file{~/News/spam} by default), or
21610 the @code{spam-whitelist} and @code{spam-blacklist} variables
21611 directly. The whitelist and blacklist files will by default be in the
21612 @code{spam-directory} directory, named @file{whitelist} and
21613 @file{blacklist} respectively.
21615 @node BBDB Whitelists
21616 @subsubsection BBDB Whitelists
21617 @cindex spam filtering
21618 @cindex BBDB whitelists, spam filtering
21619 @cindex BBDB, spam filtering
21622 @defvar spam-use-BBDB
21624 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
21625 Whitelists}), but uses the BBDB as the source of whitelisted addresses,
21626 without regular expressions. You must have the BBDB loaded for
21627 @code{spam-use-BBDB} to work properly. Only addresses in the BBDB
21628 will be allowed through; all others will be classified as spam.
21632 @defvar gnus-group-ham-exit-processor-BBDB
21633 Add this symbol to a group's @code{spam-process} parameter by
21634 customizing the group parameters or the
21635 @code{gnus-spam-process-newsgroups} variable. When this symbol is
21636 added to a group's @code{spam-process} parameter, the senders of
21637 ham-marked articles in @emph{ham} groups will be added to the
21638 BBDB. Note that this ham processor has no effect in @emph{spam}
21639 or @emph{unclassified} groups.
21643 @subsubsection Blackholes
21644 @cindex spam filtering
21645 @cindex blackholes, spam filtering
21648 @defvar spam-use-blackholes
21650 This option is disabled by default. You can let Gnus consult the
21651 blackhole-type distributed spam processing systems (DCC, for instance)
21652 when you set this option. The variable @code{spam-blackhole-servers}
21653 holds the list of blackhole servers Gnus will consult. The current
21654 list is fairly comprehensive, but make sure to let us know if it
21655 contains outdated servers.
21657 The blackhole check uses the @code{dig.el} package, but you can tell
21658 @code{spam.el} to use @code{dns.el} instead for better performance if
21659 you set @code{spam-use-dig} to nil. It is not recommended at this
21660 time to set @code{spam-use-dig} to nil despite the possible
21661 performance improvements, because some users may be unable to use it,
21662 but you can try it and see if it works for you.
21666 @defvar spam-blackhole-servers
21668 The list of servers to consult for blackhole checks.
21672 @defvar spam-blackhole-good-server-regex
21674 A regular expression for IPs that should not be checked against the
21675 blackhole server list. When set to nil, it has no effect.
21679 @defvar spam-use-dig
21681 Use the @code{dig.el} package instead of the @code{dns.el} package.
21682 The default setting of @code{t} is recommended.
21686 Blackhole checks are done only on incoming mail. There is no spam or
21687 ham processor for blackholes.
21689 @node Regular Expressions Header Matching
21690 @subsubsection Regular Expressions Header Matching
21691 @cindex spam filtering
21692 @cindex regular expressions header matching, spam filtering
21695 @defvar spam-use-regex-headers
21697 This option is disabled by default. You can let Gnus check the
21698 message headers against lists of regular expressions when you set this
21699 option. The variables @code{spam-regex-headers-spam} and
21700 @code{spam-regex-headers-ham} hold the list of regular expressions.
21701 Gnus will check against the message headers to determine if the
21702 message is spam or ham, respectively.
21706 @defvar spam-regex-headers-spam
21708 The list of regular expressions that, when matched in the headers of
21709 the message, positively identify it as spam.
21713 @defvar spam-regex-headers-ham
21715 The list of regular expressions that, when matched in the headers of
21716 the message, positively identify it as ham.
21720 Regular expression header checks are done only on incoming mail.
21721 There is no specific spam or ham processor for regular expressions.
21724 @subsubsection Bogofilter
21725 @cindex spam filtering
21726 @cindex bogofilter, spam filtering
21729 @defvar spam-use-bogofilter
21731 Set this variable if you want @code{spam-split} to use Eric Raymond's
21734 With a minimum of care for associating the @samp{$} mark for spam
21735 articles only, Bogofilter training all gets fairly automatic. You
21736 should do this until you get a few hundreds of articles in each
21737 category, spam or not. The command @kbd{S t} in summary mode, either
21738 for debugging or for curiosity, shows the @emph{spamicity} score of
21739 the current article (between 0.0 and 1.0).
21741 Bogofilter determines if a message is spam based on an internal
21742 threshold, set at compilation time. That threshold can't be
21745 If the @code{bogofilter} executable is not in your path, Bogofilter
21746 processing will be turned off.
21748 You should not enable this if you use @code{spam-use-bogofilter-headers}.
21752 @defvar spam-use-bogofilter-headers
21754 Set this variable if you want @code{spam-split} to use Eric Raymond's
21755 speedy Bogofilter, looking only at the message headers. It works
21756 similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header
21757 must be in the message already. Normally you would do this with a
21758 procmail recipe or something similar; consult the Bogofilter
21759 installation documents for details.
21761 You should not enable this if you use @code{spam-use-bogofilter}.
21765 @defvar gnus-group-spam-exit-processor-bogofilter
21766 Add this symbol to a group's @code{spam-process} parameter by
21767 customizing the group parameters or the
21768 @code{gnus-spam-process-newsgroups} variable. When this symbol is
21769 added to a group's @code{spam-process} parameter, spam-marked articles
21770 will be added to the Bogofilter spam database.
21773 @defvar gnus-group-ham-exit-processor-bogofilter
21774 Add this symbol to a group's @code{spam-process} parameter by
21775 customizing the group parameters or the
21776 @code{gnus-spam-process-newsgroups} variable. When this symbol is
21777 added to a group's @code{spam-process} parameter, the ham-marked
21778 articles in @emph{ham} groups will be added to the Bogofilter database
21779 of non-spam messages. Note that this ham processor has no effect in
21780 @emph{spam} or @emph{unclassified} groups.
21783 @defvar spam-bogofilter-database-directory
21785 This is the directory where Bogofilter will store its databases. It
21786 is not specified by default, so Bogofilter will use its own default
21787 database directory.
21791 The Bogofilter mail classifier is similar to ifile in intent and
21792 purpose. A ham and a spam processor are provided, plus the
21793 @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers}
21794 variables to indicate to spam-split that Bogofilter should either be
21795 used, or has already been used on the article. The 0.9.2.1 version of
21796 Bogofilter was used to test this functionality.
21798 @node ifile spam filtering
21799 @subsubsection ifile spam filtering
21800 @cindex spam filtering
21801 @cindex ifile, spam filtering
21804 @defvar spam-use-ifile
21806 Enable this variable if you want @code{spam-split} to use ifile, a
21807 statistical analyzer similar to Bogofilter.
21811 @defvar spam-ifile-all-categories
21813 Enable this variable if you want @code{spam-use-ifile} to give you all
21814 the ifile categories, not just spam/non-spam. If you use this, make
21815 sure you train ifile as described in its documentation.
21819 @defvar spam-ifile-spam-category
21821 This is the category of spam messages as far as ifile is concerned.
21822 The actual string used is irrelevant, but you probably want to leave
21823 the default value of @samp{spam}.
21826 @defvar spam-ifile-database-path
21828 This is the filename for the ifile database. It is not specified by
21829 default, so ifile will use its own default database name.
21833 The ifile mail classifier is similar to Bogofilter in intent and
21834 purpose. A ham and a spam processor are provided, plus the
21835 @code{spam-use-ifile} variable to indicate to spam-split that ifile
21836 should be used. The 1.2.1 version of ifile was used to test this
21839 @node spam-stat spam filtering
21840 @subsubsection spam-stat spam filtering
21841 @cindex spam filtering
21842 @cindex spam-stat, spam filtering
21846 @xref{Filtering Spam Using Statistics with spam-stat}.
21848 @defvar spam-use-stat
21850 Enable this variable if you want @code{spam-split} to use
21851 spam-stat.el, an Emacs Lisp statistical analyzer.
21855 @defvar gnus-group-spam-exit-processor-stat
21856 Add this symbol to a group's @code{spam-process} parameter by
21857 customizing the group parameters or the
21858 @code{gnus-spam-process-newsgroups} variable. When this symbol is
21859 added to a group's @code{spam-process} parameter, the spam-marked
21860 articles will be added to the spam-stat database of spam messages.
21863 @defvar gnus-group-ham-exit-processor-stat
21864 Add this symbol to a group's @code{spam-process} parameter by
21865 customizing the group parameters or the
21866 @code{gnus-spam-process-newsgroups} variable. When this symbol is
21867 added to a group's @code{spam-process} parameter, the ham-marked
21868 articles in @emph{ham} groups will be added to the spam-stat database
21869 of non-spam messages. Note that this ham processor has no effect in
21870 @emph{spam} or @emph{unclassified} groups.
21873 This enables spam.el to cooperate with spam-stat.el. spam-stat.el
21874 provides an internal (Lisp-only) spam database, which unlike ifile or
21875 Bogofilter does not require external programs. A spam and a ham
21876 processor, and the @code{spam-use-stat} variable for @code{spam-split}
21879 @node Extending the spam elisp package
21880 @subsubsection Extending the spam elisp package
21881 @cindex spam filtering
21882 @cindex spam elisp package, extending
21883 @cindex extending the spam elisp package
21885 Say you want to add a new back end called blackbox. For filtering
21886 incoming mail, provide the following:
21894 (defvar spam-use-blackbox nil
21895 "True if blackbox should be used.")
21900 (spam-use-blackbox . spam-check-blackbox)
21902 to @code{spam-list-of-checks}.
21907 Write the @code{spam-check-blackbox} function. It should return
21908 @samp{nil} or @code{spam-split-group}. See the existing
21909 @code{spam-check-*} functions for examples of what you can do.
21912 For processing spam and ham messages, provide the following:
21919 Note you don't have to provide a spam or a ham processor. Only
21920 provide them if Blackbox supports spam or ham processing.
21923 (defvar gnus-group-spam-exit-processor-blackbox "blackbox"
21924 "The Blackbox summary exit spam processor.
21925 Only applicable to spam groups.")
21927 (defvar gnus-group-ham-exit-processor-blackbox "blackbox"
21928 "The whitelist summary exit ham processor.
21929 Only applicable to non-spam (unclassified and ham) groups.")
21937 (defun spam-blackbox-register-spam-routine ()
21938 (spam-generic-register-routine
21939 ;; the spam function
21941 (let ((from (spam-fetch-field-from-fast article)))
21942 (when (stringp from)
21943 (blackbox-do-something-with-this-spammer from))))
21944 ;; the ham function
21947 (defun spam-blackbox-register-ham-routine ()
21948 (spam-generic-register-routine
21949 ;; the spam function
21951 ;; the ham function
21953 (let ((from (spam-fetch-field-from-fast article)))
21954 (when (stringp from)
21955 (blackbox-do-something-with-this-ham-sender from))))))
21958 Write the @code{blackbox-do-something-with-this-ham-sender} and
21959 @code{blackbox-do-something-with-this-spammer} functions. You can add
21960 more complex code than fetching the message sender, but keep in mind
21961 that retrieving the whole message takes significantly longer than the
21962 sender through @code{spam-fetch-field-from-fast}, because the message
21963 senders are kept in memory by Gnus.
21968 @node Filtering Spam Using Statistics with spam-stat
21969 @subsection Filtering Spam Using Statistics with spam-stat
21970 @cindex Paul Graham
21971 @cindex Graham, Paul
21972 @cindex naive Bayesian spam filtering
21973 @cindex Bayesian spam filtering, naive
21974 @cindex spam filtering, naive Bayesian
21976 Paul Graham has written an excellent essay about spam filtering using
21977 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
21978 Spam}. In it he describes the inherent deficiency of rule-based
21979 filtering as used by SpamAssassin, for example: Somebody has to write
21980 the rules, and everybody else has to install these rules. You are
21981 always late. It would be much better, he argues, to filter mail based
21982 on whether it somehow resembles spam or non-spam. One way to measure
21983 this is word distribution. He then goes on to describe a solution
21984 that checks whether a new mail resembles any of your other spam mails
21987 The basic idea is this: Create a two collections of your mail, one
21988 with spam, one with non-spam. Count how often each word appears in
21989 either collection, weight this by the total number of mails in the
21990 collections, and store this information in a dictionary. For every
21991 word in a new mail, determine its probability to belong to a spam or a
21992 non-spam mail. Use the 15 most conspicuous words, compute the total
21993 probability of the mail being spam. If this probability is higher
21994 than a certain threshold, the mail is considered to be spam.
21996 Gnus supports this kind of filtering. But it needs some setting up.
21997 First, you need two collections of your mail, one with spam, one with
21998 non-spam. Then you need to create a dictionary using these two
21999 collections, and save it. And last but not least, you need to use
22000 this dictionary in your fancy mail splitting rules.
22003 * Creating a spam-stat dictionary::
22004 * Splitting mail using spam-stat::
22005 * Low-level interface to the spam-stat dictionary::
22008 @node Creating a spam-stat dictionary
22009 @subsubsection Creating a spam-stat dictionary
22011 Before you can begin to filter spam based on statistics, you must
22012 create these statistics based on two mail collections, one with spam,
22013 one with non-spam. These statistics are then stored in a dictionary
22014 for later use. In order for these statistics to be meaningful, you
22015 need several hundred emails in both collections.
22017 Gnus currently supports only the nnml back end for automated dictionary
22018 creation. The nnml back end stores all mails in a directory, one file
22019 per mail. Use the following:
22021 @defun spam-stat-process-spam-directory
22022 Create spam statistics for every file in this directory. Every file
22023 is treated as one spam mail.
22026 @defun spam-stat-process-non-spam-directory
22027 Create non-spam statistics for every file in this directory. Every
22028 file is treated as one non-spam mail.
22031 Usually you would call @code{spam-stat-process-spam-directory} on a
22032 directory such as @file{~/Mail/mail/spam} (this usually corresponds
22033 the the group @samp{nnml:mail.spam}), and you would call
22034 @code{spam-stat-process-non-spam-directory} on a directory such as
22035 @file{~/Mail/mail/misc} (this usually corresponds the the group
22036 @samp{nnml:mail.misc}).
22038 When you are using IMAP, you won't have the mails available locally,
22039 so that will not work. One solution is to use the Gnus Agent to cache
22040 the articles. Then you can use directories such as
22041 @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for
22042 @code{spam-stat-process-spam-directory}. @xref{Agent as Cache}.
22045 This variable holds the hash-table with all the statistics -- the
22046 dictionary we have been talking about. For every word in either
22047 collection, this hash-table stores a vector describing how often the
22048 word appeared in spam and often it appeared in non-spam mails.
22051 If you want to regenerate the statistics from scratch, you need to
22052 reset the dictionary.
22054 @defun spam-stat-reset
22055 Reset the @code{spam-stat} hash-table, deleting all the statistics.
22058 When you are done, you must save the dictionary. The dictionary may
22059 be rather large. If you will not update the dictionary incrementally
22060 (instead, you will recreate it once a month, for example), then you
22061 can reduce the size of the dictionary by deleting all words that did
22062 not appear often enough or that do not clearly belong to only spam or
22063 only non-spam mails.
22065 @defun spam-stat-reduce-size
22066 Reduce the size of the dictionary. Use this only if you do not want
22067 to update the dictionary incrementally.
22070 @defun spam-stat-save
22071 Save the dictionary.
22074 @defvar spam-stat-file
22075 The filename used to store the dictionary. This defaults to
22076 @file{~/.spam-stat.el}.
22079 @node Splitting mail using spam-stat
22080 @subsubsection Splitting mail using spam-stat
22082 In order to use @code{spam-stat} to split your mail, you need to add the
22083 following to your @file{~/.gnus} file:
22086 (require 'spam-stat)
22090 This will load the necessary Gnus code, and the dictionary you
22093 Next, you need to adapt your fancy splitting rules: You need to
22094 determine how to use @code{spam-stat}. The following examples are for
22095 the nnml back end. Using the nnimap back end works just as well. Just
22096 use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}.
22098 In the simplest case, you only have two groups, @samp{mail.misc} and
22099 @samp{mail.spam}. The following expression says that mail is either
22100 spam or it should go into @samp{mail.misc}. If it is spam, then
22101 @code{spam-stat-split-fancy} will return @samp{mail.spam}.
22104 (setq nnmail-split-fancy
22105 `(| (: spam-stat-split-fancy)
22109 @defvar spam-stat-split-fancy-spam-group
22110 The group to use for spam. Default is @samp{mail.spam}.
22113 If you also filter mail with specific subjects into other groups, use
22114 the following expression. Only mails not matching the regular
22115 expression are considered potential spam.
22118 (setq nnmail-split-fancy
22119 `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
22120 (: spam-stat-split-fancy)
22124 If you want to filter for spam first, then you must be careful when
22125 creating the dictionary. Note that @code{spam-stat-split-fancy} must
22126 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
22127 non-spam, therefore both should be in your collection of non-spam
22128 mails, when creating the dictionary!
22131 (setq nnmail-split-fancy
22132 `(| (: spam-stat-split-fancy)
22133 ("Subject" "\\bspam-stat\\b" "mail.emacs")
22137 You can combine this with traditional filtering. Here, we move all
22138 HTML-only mails into the @samp{mail.spam.filtered} group. Note that since
22139 @code{spam-stat-split-fancy} will never see them, the mails in
22140 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
22141 nor in your collection of non-spam mails, when creating the
22145 (setq nnmail-split-fancy
22146 `(| ("Content-Type" "text/html" "mail.spam.filtered")
22147 (: spam-stat-split-fancy)
22148 ("Subject" "\\bspam-stat\\b" "mail.emacs")
22153 @node Low-level interface to the spam-stat dictionary
22154 @subsubsection Low-level interface to the spam-stat dictionary
22156 The main interface to using @code{spam-stat}, are the following functions:
22158 @defun spam-stat-buffer-is-spam
22159 Called in a buffer, that buffer is considered to be a new spam mail.
22160 Use this for new mail that has not been processed before.
22163 @defun spam-stat-buffer-is-no-spam
22164 Called in a buffer, that buffer is considered to be a new non-spam
22165 mail. Use this for new mail that has not been processed before.
22168 @defun spam-stat-buffer-change-to-spam
22169 Called in a buffer, that buffer is no longer considered to be normal
22170 mail but spam. Use this to change the status of a mail that has
22171 already been processed as non-spam.
22174 @defun spam-stat-buffer-change-to-non-spam
22175 Called in a buffer, that buffer is no longer considered to be spam but
22176 normal mail. Use this to change the status of a mail that has already
22177 been processed as spam.
22180 @defun spam-stat-save
22181 Save the hash table to the file. The filename used is stored in the
22182 variable @code{spam-stat-file}.
22185 @defun spam-stat-load
22186 Load the hash table from a file. The filename used is stored in the
22187 variable @code{spam-stat-file}.
22190 @defun spam-stat-score-word
22191 Return the spam score for a word.
22194 @defun spam-stat-score-buffer
22195 Return the spam score for a buffer.
22198 @defun spam-stat-split-fancy
22199 Use this function for fancy mail splitting. Add the rule @samp{(:
22200 spam-stat-split-fancy)} to @code{nnmail-split-fancy}
22203 Make sure you load the dictionary before using it. This requires the
22204 following in your @file{~/.gnus} file:
22207 (require 'spam-stat)
22211 Typical test will involve calls to the following functions:
22214 Reset: (setq spam-stat (make-hash-table :test 'equal))
22215 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
22216 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
22217 Save table: (spam-stat-save)
22218 File size: (nth 7 (file-attributes spam-stat-file))
22219 Number of words: (hash-table-count spam-stat)
22220 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
22221 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
22222 Reduce table size: (spam-stat-reduce-size)
22223 Save table: (spam-stat-save)
22224 File size: (nth 7 (file-attributes spam-stat-file))
22225 Number of words: (hash-table-count spam-stat)
22226 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
22227 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
22230 Here is how you would create your dictionary:
22233 Reset: (setq spam-stat (make-hash-table :test 'equal))
22234 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
22235 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
22236 Repeat for any other non-spam group you need...
22237 Reduce table size: (spam-stat-reduce-size)
22238 Save table: (spam-stat-save)
22241 @node Various Various
22242 @section Various Various
22248 @item gnus-home-directory
22249 @vindex gnus-home-directory
22250 All Gnus file and directory variables will be initialized from this
22251 variable, which defaults to @file{~/}.
22253 @item gnus-directory
22254 @vindex gnus-directory
22255 Most Gnus storage file and directory variables will be initialized from
22256 this variable, which defaults to the @samp{SAVEDIR} environment
22257 variable, or @file{~/News/} if that variable isn't set.
22259 Note that Gnus is mostly loaded when the @file{.gnus.el} file is read.
22260 This means that other directory variables that are initialized from this
22261 variable won't be set properly if you set this variable in
22262 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
22264 @item gnus-default-directory
22265 @vindex gnus-default-directory
22266 Not related to the above variable at all---this variable says what the
22267 default directory of all Gnus buffers should be. If you issue commands
22268 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
22269 default directory. If this variable is @code{nil} (which is the
22270 default), the default directory will be the default directory of the
22271 buffer you were in when you started Gnus.
22274 @vindex gnus-verbose
22275 This variable is an integer between zero and ten. The higher the value,
22276 the more messages will be displayed. If this variable is zero, Gnus
22277 will never flash any messages, if it is seven (which is the default),
22278 most important messages will be shown, and if it is ten, Gnus won't ever
22279 shut up, but will flash so many messages it will make your head swim.
22281 @item gnus-verbose-backends
22282 @vindex gnus-verbose-backends
22283 This variable works the same way as @code{gnus-verbose}, but it applies
22284 to the Gnus back ends instead of Gnus proper.
22286 @item nnheader-max-head-length
22287 @vindex nnheader-max-head-length
22288 When the back ends read straight heads of articles, they all try to read
22289 as little as possible. This variable (default 4096) specifies
22290 the absolute max length the back ends will try to read before giving up
22291 on finding a separator line between the head and the body. If this
22292 variable is @code{nil}, there is no upper read bound. If it is
22293 @code{t}, the back ends won't try to read the articles piece by piece,
22294 but read the entire articles. This makes sense with some versions of
22295 @code{ange-ftp} or @code{efs}.
22297 @item nnheader-head-chop-length
22298 @vindex nnheader-head-chop-length
22299 This variable (default 2048) says how big a piece of each article to
22300 read when doing the operation described above.
22302 @item nnheader-file-name-translation-alist
22303 @vindex nnheader-file-name-translation-alist
22305 @cindex invalid characters in file names
22306 @cindex characters in file names
22307 This is an alist that says how to translate characters in file names.
22308 For instance, if @samp{:} is invalid as a file character in file names
22309 on your system (you OS/2 user you), you could say something like:
22312 (setq nnheader-file-name-translation-alist
22316 In fact, this is the default value for this variable on OS/2 and MS
22317 Windows (phooey) systems.
22319 @item gnus-hidden-properties
22320 @vindex gnus-hidden-properties
22321 This is a list of properties to use to hide ``invisible'' text. It is
22322 @code{(invisible t intangible t)} by default on most systems, which
22323 makes invisible text invisible and intangible.
22325 @item gnus-parse-headers-hook
22326 @vindex gnus-parse-headers-hook
22327 A hook called before parsing headers. It can be used, for instance, to
22328 gather statistics on the headers fetched, or perhaps you'd like to prune
22329 some headers. I don't see why you'd want that, though.
22331 @item gnus-shell-command-separator
22332 @vindex gnus-shell-command-separator
22333 String used to separate two shell commands. The default is @samp{;}.
22335 @item gnus-invalid-group-regexp
22336 @vindex gnus-invalid-group-regexp
22338 Regexp to match ``invalid'' group names when querying user for a group
22339 name. The default value catches some @strong{really} invalid group
22340 names who could possibly mess up Gnus internally (like allowing
22341 @samp{:} in a group name, which is normally used to delimit method and
22344 @sc{imap} users might want to allow @samp{/} in group names though.
22352 Well, that's the manual---you can get on with your life now. Keep in
22353 touch. Say hello to your cats from me.
22355 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
22357 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
22363 Not because of victories @*
22366 but for the common sunshine,@*
22368 the largess of the spring.
22372 but for the day's work done@*
22373 as well as I was able;@*
22374 not for a seat upon the dais@*
22375 but at the common table.@*
22380 @chapter Appendices
22383 * XEmacs:: Requirements for installing under XEmacs.
22384 * History:: How Gnus got where it is today.
22385 * On Writing Manuals:: Why this is not a beginner's guide.
22386 * Terminology:: We use really difficult, like, words here.
22387 * Customization:: Tailoring Gnus to your needs.
22388 * Troubleshooting:: What you might try if things do not work.
22389 * Gnus Reference Guide:: Rilly, rilly technical stuff.
22390 * Emacs for Heathens:: A short introduction to Emacsian terms.
22391 * Frequently Asked Questions::
22398 @cindex Installing under XEmacs
22400 XEmacs is distributed as a collection of packages. You should install
22401 whatever packages the Gnus XEmacs package requires. The current
22402 requirements are @samp{gnus}, @samp{w3}, @samp{mh-e},
22403 @samp{mailcrypt}, @samp{rmail}, @samp{eterm}, @samp{mail-lib},
22404 @samp{xemacs-base}, @samp{sh-script} and @samp{fsf-compat}. The
22405 @samp{misc-games} package is required for Morse decoding.
22412 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
22413 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
22415 If you want to investigate the person responsible for this outrage,
22416 you can point your (feh!) web browser to
22417 @uref{http://quimby.gnus.org/}. This is also the primary
22418 distribution point for the new and spiffy versions of Gnus, and is
22419 known as The Site That Destroys Newsrcs And Drives People Mad.
22421 During the first extended alpha period of development, the new Gnus was
22422 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
22423 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
22424 (Besides, the ``Gnus'' in this abbreviation should probably be
22425 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
22426 appropriate name, don't you think?)
22428 In any case, after spending all that energy on coming up with a new and
22429 spunky name, we decided that the name was @emph{too} spunky, so we
22430 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
22431 ``@sc{gnus}''. New vs. old.
22434 * Gnus Versions:: What Gnus versions have been released.
22435 * Other Gnus Versions:: Other Gnus versions that also have been released.
22436 * Why?:: What's the point of Gnus?
22437 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
22438 * Conformity:: Gnus tries to conform to all standards.
22439 * Emacsen:: Gnus can be run on a few modern Emacsen.
22440 * Gnus Development:: How Gnus is developed.
22441 * Contributors:: Oodles of people.
22442 * New Features:: Pointers to some of the new stuff in Gnus.
22446 @node Gnus Versions
22447 @subsection Gnus Versions
22449 @cindex September Gnus
22451 @cindex Quassia Gnus
22452 @cindex Pterodactyl Gnus
22456 The first ``proper'' release of Gnus 5 was done in November 1995 when it
22457 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
22458 plus 15 Gnus 5.0 releases).
22460 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
22461 releases)) was released under the name ``Gnus 5.2'' (40 releases).
22463 On July 28th 1996 work on Red Gnus was begun, and it was released on
22464 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
22466 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
22467 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
22469 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
22470 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
22473 On the 26th of October 2000, Oort Gnus was begun.
22475 If you happen upon a version of Gnus that has a prefixed name --
22476 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
22477 ``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic. Don't let it know
22478 that you're frightened. Back away. Slowly. Whatever you do, don't
22479 run. Walk away, calmly, until you're out of its reach. Find a proper
22480 released version of Gnus and snuggle up to that instead.
22483 @node Other Gnus Versions
22484 @subsection Other Gnus Versions
22487 In addition to the versions of Gnus which have had their releases
22488 coordinated by Lars, one major development has been Semi-gnus from
22489 Japan. It's based on a library called @sc{semi}, which provides
22490 @sc{mime} capabilities.
22492 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
22493 Collectively, they are called ``Semi-gnus'', and different strains are
22494 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
22495 @sc{mime} and multilingualization things, especially important for
22502 What's the point of Gnus?
22504 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
22505 newsreader, that lets you do anything you can think of. That was my
22506 original motivation, but while working on Gnus, it has become clear to
22507 me that this generation of newsreaders really belong in the stone age.
22508 Newsreaders haven't developed much since the infancy of the net. If the
22509 volume continues to rise with the current rate of increase, all current
22510 newsreaders will be pretty much useless. How do you deal with
22511 newsgroups that have thousands of new articles each day? How do you
22512 keep track of millions of people who post?
22514 Gnus offers no real solutions to these questions, but I would very much
22515 like to see Gnus being used as a testing ground for new methods of
22516 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
22517 to separate the newsreader from the back ends, Gnus now offers a simple
22518 interface for anybody who wants to write new back ends for fetching mail
22519 and news from different sources. I have added hooks for customizations
22520 everywhere I could imagine it being useful. By doing so, I'm inviting
22521 every one of you to explore and invent.
22523 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
22524 @kbd{C-u 100 M-x all-hail-xemacs}.
22527 @node Compatibility
22528 @subsection Compatibility
22530 @cindex compatibility
22531 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
22532 bindings have been kept. More key bindings have been added, of course,
22533 but only in one or two obscure cases have old bindings been changed.
22538 @center In a cloud bones of steel.
22542 All commands have kept their names. Some internal functions have changed
22545 The @code{gnus-uu} package has changed drastically. @xref{Decoding
22548 One major compatibility question is the presence of several summary
22549 buffers. All variables relevant while reading a group are
22550 buffer-local to the summary buffer they belong in. Although many
22551 important variables have their values copied into their global
22552 counterparts whenever a command is executed in the summary buffer, this
22553 change might lead to incorrect values being used unless you are careful.
22555 All code that relies on knowledge of @sc{gnus} internals will probably
22556 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
22557 changing it in any way, as a matter of fact) is strictly verboten. Gnus
22558 maintains a hash table that points to the entries in this alist (which
22559 speeds up many functions), and changing the alist directly will lead to
22563 @cindex highlighting
22564 Old hilit19 code does not work at all. In fact, you should probably
22565 remove all hilit code from all Gnus hooks
22566 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
22567 Gnus provides various integrated functions for highlighting. These are
22568 faster and more accurate. To make life easier for everybody, Gnus will
22569 by default remove all hilit calls from all hilit hooks. Uncleanliness!
22572 Packages like @code{expire-kill} will no longer work. As a matter of
22573 fact, you should probably remove all old @sc{gnus} packages (and other
22574 code) when you start using Gnus. More likely than not, Gnus already
22575 does what you have written code to make @sc{gnus} do. (Snicker.)
22577 Even though old methods of doing things are still supported, only the
22578 new methods are documented in this manual. If you detect a new method of
22579 doing something while reading this manual, that does not mean you have
22580 to stop doing it the old way.
22582 Gnus understands all @sc{gnus} startup files.
22584 @kindex M-x gnus-bug
22586 @cindex reporting bugs
22588 Overall, a casual user who hasn't written much code that depends on
22589 @sc{gnus} internals should suffer no problems. If problems occur,
22590 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
22592 @vindex gnus-bug-create-help-buffer
22593 If you are in the habit of sending bug reports @emph{very} often, you
22594 may find the helpful help buffer annoying after a while. If so, set
22595 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
22600 @subsection Conformity
22602 No rebels without a clue here, ma'am. We conform to all standards known
22603 to (wo)man. Except for those standards and/or conventions we disagree
22611 There are no known breaches of this standard.
22615 There are no known breaches of this standard, either.
22617 @item Son-of-RFC 1036
22618 @cindex Son-of-RFC 1036
22619 We do have some breaches to this one.
22625 These are considered to be ``vanity headers'', while I consider them
22626 to be consumer information. After seeing so many badly formatted
22627 articles coming from @code{tin} and @code{Netscape} I know not to use
22628 either of those for posting articles. I would not have known that if
22629 it wasn't for the @code{X-Newsreader} header.
22634 USEFOR is an IETF working group writing a successor to RFC 1036, based
22635 on Son-of-RFC 1036. They have produced a number of drafts proposing
22636 various changes to the format of news articles. The Gnus towers will
22637 look into implementing the changes when the draft is accepted as an RFC.
22639 @item MIME - RFC 2045-2049 etc
22641 All the various @sc{mime} RFCs are supported.
22643 @item Disposition Notifications - RFC 2298
22644 Message Mode is able to request notifications from the receiver.
22646 @item PGP - RFC 1991 and RFC 2440
22649 RFC 1991 is the original PGP message specification, published as a
22650 Information RFC. RFC 2440 was the follow-up, now called Open PGP, and
22651 put on the Standards Track. Both document a non-@sc{mime} aware PGP
22652 format. Gnus supports both encoding (signing and encryption) and
22653 decoding (verification and decryption).
22655 @item PGP/MIME - RFC 2015/3156
22656 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
22657 1991) describes the @sc{mime}-wrapping around the RF 1991/2440 format.
22658 Gnus supports both encoding and decoding.
22660 @item S/MIME - RFC 2633
22661 RFC 2633 describes the @sc{s/mime} format.
22663 @item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
22664 RFC 1730 is @sc{imap} version 4, updated somewhat by RFC 2060 (@sc{imap} 4
22665 revision 1). RFC 2195 describes CRAM-MD5 authentication for @sc{imap}. RFC
22666 2086 describes access control lists (ACLs) for @sc{imap}. RFC 2359
22667 describes a @sc{imap} protocol enhancement. RFC 2595 describes the proper
22668 TLS integration (STARTTLS) with @sc{imap}. RFC 1731 describes the
22669 GSSAPI/Kerberos4 mechanisms for @sc{imap}.
22673 If you ever notice Gnus acting non-compliant with regards to the texts
22674 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
22679 @subsection Emacsen
22685 Gnus should work on :
22693 XEmacs 20.4 and up.
22697 This Gnus version will absolutely not work on any Emacsen older than
22698 that. Not reliably, at least. Older versions of Gnus may work on older
22701 There are some vague differences between Gnus on the various
22702 platforms---XEmacs features more graphics (a logo and a toolbar)---but
22703 other than that, things should look pretty much the same under all
22707 @node Gnus Development
22708 @subsection Gnus Development
22710 Gnus is developed in a two-phased cycle. The first phase involves much
22711 discussion on the @samp{ding@@gnus.org} mailing list, where people
22712 propose changes and new features, post patches and new back ends. This
22713 phase is called the @dfn{alpha} phase, since the Gnusae released in this
22714 phase are @dfn{alpha releases}, or (perhaps more commonly in other
22715 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
22716 unstable and should not be used by casual users. Gnus alpha releases
22717 have names like ``Red Gnus'' and ``Quassia Gnus''.
22719 After futzing around for 50-100 alpha releases, Gnus is declared
22720 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
22721 and is called things like ``Gnus 5.6.32'' instead. Normal people are
22722 supposed to be able to use these, and these are mostly discussed on the
22723 @samp{gnu.emacs.gnus} newsgroup.
22726 @vindex mail-source-delete-incoming
22727 Some variable defaults differ between alpha Gnusae and released Gnusae.
22728 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
22729 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
22730 lossage of mail if an alpha release hiccups while handling the mail.
22732 The division of discussion between the ding mailing list and the Gnus
22733 newsgroup is not purely based on publicity concerns. It's true that
22734 having people write about the horrible things that an alpha Gnus release
22735 can do (sometimes) in a public forum may scare people off, but more
22736 importantly, talking about new experimental features that have been
22737 introduced may confuse casual users. New features are frequently
22738 introduced, fiddled with, and judged to be found wanting, and then
22739 either discarded or totally rewritten. People reading the mailing list
22740 usually keep up with these rapid changes, while people on the newsgroup
22741 can't be assumed to do so.
22746 @subsection Contributors
22747 @cindex contributors
22749 The new Gnus version couldn't have been done without the help of all the
22750 people on the (ding) mailing list. Every day for over a year I have
22751 gotten billions of nice bug reports from them, filling me with joy,
22752 every single one of them. Smooches. The people on the list have been
22753 tried beyond endurance, what with my ``oh, that's a neat idea <type
22754 type>, yup, I'll release it right away <ship off> no wait, that doesn't
22755 work at all <type type>, yup, I'll ship that one off right away <ship
22756 off> no, wait, that absolutely does not work'' policy for releases.
22757 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
22758 ``worser''? ``much worser''? ``worsest''?)
22760 I would like to take this opportunity to thank the Academy for... oops,
22766 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
22769 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
22770 nnwarchive and many, many other things connected with @sc{mime} and
22771 other types of en/decoding, as well as general bug fixing, new
22772 functionality and stuff.
22775 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
22776 well as numerous other things).
22779 Luis Fernandes---design and graphics.
22782 Joe Reiss---creator of the smiley faces.
22785 Justin Sheehy--the FAQ maintainer.
22788 Erik Naggum---help, ideas, support, code and stuff.
22791 Wes Hardaker---@file{gnus-picon.el} and the manual section on
22792 @dfn{picons} (@pxref{Picons}).
22795 Kim-Minh Kaplan---further work on the picon code.
22798 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
22799 (@pxref{GroupLens}).
22802 Sudish Joseph---innumerable bug fixes.
22805 Ilja Weis---@file{gnus-topic.el}.
22808 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
22811 Vladimir Alexiev---the refcard and reference booklets.
22814 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
22815 distribution by Felix Lee and JWZ.
22818 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
22821 Peter Mutsaers---orphan article scoring code.
22824 Ken Raeburn---POP mail support.
22827 Hallvard B Furuseth---various bits and pieces, especially dealing with
22831 Brian Edmonds---@file{gnus-bbdb.el}.
22834 David Moore---rewrite of @file{nnvirtual.el} and many other things.
22837 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
22840 François Pinard---many, many interesting and thorough bug reports, as
22841 well as autoconf support.
22845 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
22846 Borges, and Jost Krieger proof-reading parts of the manual.
22848 The following people have contributed many patches and suggestions:
22857 Jason L. Tibbitts, III,
22861 Also thanks to the following for patches and stuff:
22871 Alexei V. Barantsev,
22886 Massimo Campostrini,
22891 Jae-you Chung, @c ?
22892 James H. Cloos, Jr.,
22896 Andrew J. Cosgriff,
22899 Geoffrey T. Dairiki,
22905 Michael Welsh Duggan,
22910 Enami Tsugutomo, @c Enami
22914 Nelson Jose dos Santos Ferreira,
22922 Arne Georg Gleditsch,
22924 Michelangelo Grigni,
22928 Kenichi Handa, @c Handa
22930 Yoshiki Hayashi, @c ?
22932 Hisashige Kenji, @c Hisashige
22939 François Felix Ingrand,
22940 Tatsuya Ichikawa, @c ?
22941 Ishikawa Ichiro, @c Ishikawa
22943 Iwamuro Motonori, @c Iwamuro
22954 Peter Skov Knudsen,
22955 Shuhei Kobayashi, @c Kobayashi
22957 Koseki Yoshinori, @c Koseki
22958 Thor Kristoffersen,
22961 Seokchan Lee, @c Lee
22979 Morioka Tomohiko, @c Morioka
22980 Erik Toubro Nielsen,
22987 Masaharu Onishi, @c Onishi
22992 Jens-Ulrik Holger Petersen,
22996 John McClary Prevost,
23002 Lars Balker Rasmussen,
23007 Christian von Roques,
23010 Wolfgang Rupprecht,
23017 Philippe Schnoebelen,
23019 Randal L. Schwartz,
23033 Kiyokazu Suto, @c Suto
23038 Tozawa Akihiko, @c Tozawa
23054 Katsumi Yamaoka @c Yamaoka
23059 For a full overview of what each person has done, the ChangeLogs
23060 included in the Gnus alpha distributions should give ample reading
23061 (550kB and counting).
23063 Apologies to everybody that I've forgotten, of which there are many, I'm
23066 Gee, that's quite a list of people. I guess that must mean that there
23067 actually are people who are using Gnus. Who'd'a thunk it!
23071 @subsection New Features
23072 @cindex new features
23075 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
23076 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
23077 * Red Gnus:: Third time best---Gnus 5.4/5.5.
23078 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
23079 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
23082 These lists are, of course, just @emph{short} overviews of the
23083 @emph{most} important new features. No, really. There are tons more.
23084 Yes, we have feeping creaturism in full effect.
23087 @subsubsection (ding) Gnus
23089 New features in Gnus 5.0/5.1:
23094 The look of all buffers can be changed by setting format-like variables
23095 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
23098 Local spool and several @sc{nntp} servers can be used at once
23099 (@pxref{Select Methods}).
23102 You can combine groups into virtual groups (@pxref{Virtual Groups}).
23105 You can read a number of different mail formats (@pxref{Getting Mail}).
23106 All the mail back ends implement a convenient mail expiry scheme
23107 (@pxref{Expiring Mail}).
23110 Gnus can use various strategies for gathering threads that have lost
23111 their roots (thereby gathering loose sub-threads into one thread) or it
23112 can go back and retrieve enough headers to build a complete thread
23113 (@pxref{Customizing Threading}).
23116 Killed groups can be displayed in the group buffer, and you can read
23117 them as well (@pxref{Listing Groups}).
23120 Gnus can do partial group updates---you do not have to retrieve the
23121 entire active file just to check for new articles in a few groups
23122 (@pxref{The Active File}).
23125 Gnus implements a sliding scale of subscribedness to groups
23126 (@pxref{Group Levels}).
23129 You can score articles according to any number of criteria
23130 (@pxref{Scoring}). You can even get Gnus to find out how to score
23131 articles for you (@pxref{Adaptive Scoring}).
23134 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
23135 manner, so it should be difficult to lose much data on what you have
23136 read if your machine should go down (@pxref{Auto Save}).
23139 Gnus now has its own startup file (@file{.gnus.el}) to avoid cluttering up
23140 the @file{.emacs} file.
23143 You can set the process mark on both groups and articles and perform
23144 operations on all the marked items (@pxref{Process/Prefix}).
23147 You can grep through a subset of groups and create a group from the
23148 results (@pxref{Kibozed Groups}).
23151 You can list subsets of groups according to, well, anything
23152 (@pxref{Listing Groups}).
23155 You can browse foreign servers and subscribe to groups from those
23156 servers (@pxref{Browse Foreign Server}).
23159 Gnus can fetch articles, asynchronously, on a second connection to the
23160 server (@pxref{Asynchronous Fetching}).
23163 You can cache articles locally (@pxref{Article Caching}).
23166 The uudecode functions have been expanded and generalized
23167 (@pxref{Decoding Articles}).
23170 You can still post uuencoded articles, which was a little-known feature
23171 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
23174 Fetching parents (and other articles) now actually works without
23175 glitches (@pxref{Finding the Parent}).
23178 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
23181 Digests (and other files) can be used as the basis for groups
23182 (@pxref{Document Groups}).
23185 Articles can be highlighted and customized (@pxref{Customizing
23189 URLs and other external references can be buttonized (@pxref{Article
23193 You can do lots of strange stuff with the Gnus window & frame
23194 configuration (@pxref{Window Layout}).
23197 You can click on buttons instead of using the keyboard
23203 @node September Gnus
23204 @subsubsection September Gnus
23208 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
23212 New features in Gnus 5.2/5.3:
23217 A new message composition mode is used. All old customization variables
23218 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
23222 Gnus is now able to generate @dfn{sparse} threads---threads where
23223 missing articles are represented by empty nodes (@pxref{Customizing
23227 (setq gnus-build-sparse-threads 'some)
23231 Outgoing articles are stored on a special archive server
23232 (@pxref{Archived Messages}).
23235 Partial thread regeneration now happens when articles are
23239 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
23242 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
23245 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
23248 (setq gnus-use-trees t)
23252 An @code{nn}-like pick-and-read minor mode is available for the summary
23253 buffers (@pxref{Pick and Read}).
23256 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
23260 In binary groups you can use a special binary minor mode (@pxref{Binary
23264 Groups can be grouped in a folding topic hierarchy (@pxref{Group
23268 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
23272 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
23275 Groups can now have a score, and bubbling based on entry frequency
23276 is possible (@pxref{Group Score}).
23279 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
23283 Groups can be process-marked, and commands can be performed on
23284 groups of groups (@pxref{Marking Groups}).
23287 Caching is possible in virtual groups.
23290 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
23291 news batches, ClariNet briefs collections, and just about everything
23292 else (@pxref{Document Groups}).
23295 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets
23299 The Gnus cache is much faster.
23302 Groups can be sorted according to many criteria (@pxref{Sorting
23306 New group parameters have been introduced to set list-addresses and
23307 expiry times (@pxref{Group Parameters}).
23310 All formatting specs allow specifying faces to be used
23311 (@pxref{Formatting Fonts}).
23314 There are several more commands for setting/removing/acting on process
23315 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
23318 The summary buffer can be limited to show parts of the available
23319 articles based on a wide range of criteria. These commands have been
23320 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
23323 Articles can be made persistent with the @kbd{*} command
23324 (@pxref{Persistent Articles}).
23327 All functions for hiding article elements are now toggles.
23330 Article headers can be buttonized (@pxref{Article Washing}).
23333 All mail back ends support fetching articles by @code{Message-ID}.
23336 Duplicate mail can now be treated properly (@pxref{Duplicates}).
23339 All summary mode commands are available directly from the article
23340 buffer (@pxref{Article Keymap}).
23343 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
23347 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
23350 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
23355 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
23358 (setq gnus-use-nocem t)
23362 Groups can be made permanently visible (@pxref{Listing Groups}).
23365 (setq gnus-permanently-visible-groups "^nnml:")
23369 Many new hooks have been introduced to make customizing easier.
23372 Gnus respects the @code{Mail-Copies-To} header.
23375 Threads can be gathered by looking at the @code{References} header
23376 (@pxref{Customizing Threading}).
23379 (setq gnus-summary-thread-gathering-function
23380 'gnus-gather-threads-by-references)
23384 Read articles can be stored in a special backlog buffer to avoid
23385 refetching (@pxref{Article Backlog}).
23388 (setq gnus-keep-backlog 50)
23392 A clean copy of the current article is always stored in a separate
23393 buffer to allow easier treatment.
23396 Gnus can suggest where to save articles (@pxref{Saving Articles}).
23399 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
23403 (setq gnus-prompt-before-saving t)
23407 @code{gnus-uu} can view decoded files asynchronously while fetching
23408 articles (@pxref{Other Decode Variables}).
23411 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
23415 Filling in the article buffer now works properly on cited text
23416 (@pxref{Article Washing}).
23419 Hiding cited text adds buttons to toggle hiding, and how much
23420 cited text to hide is now customizable (@pxref{Article Hiding}).
23423 (setq gnus-cited-lines-visible 2)
23427 Boring headers can be hidden (@pxref{Article Hiding}).
23430 Default scoring values can now be set from the menu bar.
23433 Further syntax checking of outgoing articles have been added.
23439 @subsubsection Red Gnus
23441 New features in Gnus 5.4/5.5:
23445 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
23452 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
23455 Article prefetching functionality has been moved up into
23456 Gnus (@pxref{Asynchronous Fetching}).
23459 Scoring can now be performed with logical operators like @code{and},
23460 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
23464 Article washing status can be displayed in the
23465 article mode line (@pxref{Misc Article}).
23468 @file{gnus.el} has been split into many smaller files.
23471 Suppression of duplicate articles based on Message-ID can be done
23472 (@pxref{Duplicate Suppression}).
23475 (setq gnus-suppress-duplicates t)
23479 New variables for specifying what score and adapt files are to be
23480 considered home score and adapt files (@pxref{Home Score File}) have
23484 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
23485 Server Internals}).
23488 Groups can inherit group parameters from parent topics (@pxref{Topic
23492 Article editing has been revamped and is now actually usable.
23495 Signatures can be recognized in more intelligent fashions
23496 (@pxref{Article Signature}).
23499 Summary pick mode has been made to look more @code{nn}-like. Line
23500 numbers are displayed and the @kbd{.} command can be used to pick
23501 articles (@code{Pick and Read}).
23504 Commands for moving the @file{.newsrc.eld} from one server to
23505 another have been added (@pxref{Changing Servers}).
23508 There's a way now to specify that ``uninteresting'' fields be suppressed
23509 when generating lines in buffers (@pxref{Advanced Formatting}).
23512 Several commands in the group buffer can be undone with @kbd{C-M-_}
23516 Scoring can be done on words using the new score type @code{w}
23517 (@pxref{Score File Format}).
23520 Adaptive scoring can be done on a Subject word-by-word basis
23521 (@pxref{Adaptive Scoring}).
23524 (setq gnus-use-adaptive-scoring '(word))
23528 Scores can be decayed (@pxref{Score Decays}).
23531 (setq gnus-decay-scores t)
23535 Scoring can be performed using a regexp on the Date header. The Date is
23536 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
23539 A new command has been added to remove all data on articles from
23540 the native server (@pxref{Changing Servers}).
23543 A new command for reading collections of documents
23544 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
23545 (@pxref{Really Various Summary Commands}).
23548 Process mark sets can be pushed and popped (@pxref{Setting Process
23552 A new mail-to-news back end makes it possible to post even when the @sc{nntp}
23553 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
23556 A new back end for reading searches from Web search engines
23557 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
23558 (@pxref{Web Searches}).
23561 Groups inside topics can now be sorted using the standard sorting
23562 functions, and each topic can be sorted independently (@pxref{Topic
23566 Subsets of the groups can be sorted independently (@code{Sorting
23570 Cached articles can be pulled into the groups (@pxref{Summary Generation
23574 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
23579 Score files are now applied in a more reliable order (@pxref{Score
23583 Reports on where mail messages end up can be generated (@pxref{Splitting
23587 More hooks and functions have been added to remove junk from incoming
23588 mail before saving the mail (@pxref{Washing Mail}).
23591 Emphasized text can be properly fontisized:
23597 @subsubsection Quassia Gnus
23599 New features in Gnus 5.6:
23604 New functionality for using Gnus as an offline newsreader has been
23605 added. A plethora of new commands and modes have been added. See
23606 @pxref{Gnus Unplugged} for the full story.
23609 The @code{nndraft} back end has returned, but works differently than
23610 before. All Message buffers are now also articles in the @code{nndraft}
23611 group, which is created automatically.
23614 @code{gnus-alter-header-function} can now be used to alter header
23618 @code{gnus-summary-goto-article} now accept Message-ID's.
23621 A new Message command for deleting text in the body of a message
23622 outside the region: @kbd{C-c C-v}.
23625 You can now post to component group in @code{nnvirtual} groups with
23629 @code{nntp-rlogin-program}---new variable to ease customization.
23632 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
23633 re-highlighting of the article buffer.
23636 New element in @code{gnus-boring-article-headers}---@code{long-to}.
23639 @kbd{M-i} symbolic prefix command. See the section "Symbolic
23640 Prefixes" in the Gnus manual for details.
23643 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
23644 @kbd{a} to add the score rule to the "all.SCORE" file.
23647 @code{gnus-simplify-subject-functions} variable to allow greater
23648 control over simplification.
23651 @kbd{A T}---new command for fetching the current thread.
23654 @kbd{/ T}---new command for including the current thread in the
23658 @kbd{M-RET} is a new Message command for breaking cited text.
23661 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
23664 The @code{custom-face-lookup} function has been removed.
23665 If you used this function in your initialization files, you must
23666 rewrite them to use @code{face-spec-set} instead.
23669 Canceling now uses the current select method. Symbolic prefix
23670 @kbd{a} forces normal posting method.
23673 New command to translate M******** sm*rtq**t*s into proper
23677 For easier debugging of @code{nntp}, you can set
23678 @code{nntp-record-commands} to a non-@code{nil} value.
23681 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
23682 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
23685 A command for editing group parameters from the summary buffer
23689 A history of where mails have been split is available.
23692 A new article date command has been added---@code{article-date-iso8601}.
23695 Subjects can be simplified when threading by setting
23696 @code{gnus-score-thread-simplify}.
23699 A new function for citing in Message has been
23700 added---@code{message-cite-original-without-signature}.
23703 @code{article-strip-all-blank-lines}---new article command.
23706 A new Message command to kill to the end of the article has
23710 A minimum adaptive score can be specified by using the
23711 @code{gnus-adaptive-word-minimum} variable.
23714 The "lapsed date" article header can be kept continually
23715 updated by the @code{gnus-start-date-timer} command.
23718 Web listserv archives can be read with the @code{nnlistserv} back end.
23721 Old dejanews archives can now be read by @code{nnweb}.
23725 @node Pterodactyl Gnus
23726 @subsubsection Pterodactyl Gnus
23728 New features in Gnus 5.8:
23733 The mail-fetching functions have changed. See the manual for the
23734 many details. In particular, all procmail fetching variables are gone.
23736 If you used procmail like in
23739 (setq nnmail-use-procmail t)
23740 (setq nnmail-spool-file 'procmail)
23741 (setq nnmail-procmail-directory "~/mail/incoming/")
23742 (setq nnmail-procmail-suffix "\\.in")
23745 this now has changed to
23749 '((directory :path "~/mail/incoming/"
23753 More information is available in the info doc at Select Methods ->
23754 Getting Mail -> Mail Sources
23757 Gnus is now a @sc{mime}-capable reader. This affects many parts of
23758 Gnus, and adds a slew of new commands. See the manual for details.
23761 Gnus has also been multilingualized. This also affects too
23762 many parts of Gnus to summarize here, and adds many new variables.
23765 @code{gnus-auto-select-first} can now be a function to be
23766 called to position point.
23769 The user can now decide which extra headers should be included in
23770 summary buffers and @sc{nov} files.
23773 @code{gnus-article-display-hook} has been removed. Instead, a number
23774 of variables starting with @code{gnus-treat-} have been added.
23777 The Gnus posting styles have been redone again and now works in a
23778 subtly different manner.
23781 New web-based back ends have been added: @code{nnslashdot},
23782 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
23783 again, to keep up with ever-changing layouts.
23786 Gnus can now read @sc{imap} mail via @code{nnimap}.
23794 @section The Manual
23798 This manual was generated from a TeXinfo file and then run through
23799 either @code{texi2dvi}
23801 or my own home-brewed TeXinfo to \LaTeX\ transformer,
23802 and then run through @code{latex} and @code{dvips}
23804 to get what you hold in your hands now.
23806 The following conventions have been used:
23811 This is a @samp{string}
23814 This is a @kbd{keystroke}
23817 This is a @file{file}
23820 This is a @code{symbol}
23824 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
23828 (setq flargnoze "yes")
23831 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
23834 (setq flumphel 'yes)
23837 @samp{yes} and @code{yes} are two @emph{very} different things---don't
23838 ever get them confused.
23842 Of course, everything in this manual is of vital interest, so you should
23843 read it all. Several times. However, if you feel like skimming the
23844 manual, look for that gnu head you should see in the margin over
23845 there---it means that what's being discussed is of more importance than
23846 the rest of the stuff. (On the other hand, if everything is infinitely
23847 important, how can anything be more important than that? Just one more
23848 of the mysteries of this world, I guess.)
23854 @node On Writing Manuals
23855 @section On Writing Manuals
23857 I guess most manuals are written after-the-fact; documenting a program
23858 that's already there. This is not how this manual is written. When
23859 implementing something, I write the manual entry for that something
23860 straight away. I then see that it's difficult to explain the
23861 functionality, so I write how it's supposed to be, and then I change the
23862 implementation. Writing the documentation and writing the code goes
23865 This, of course, means that this manual has no, or little, flow. It
23866 documents absolutely everything in Gnus, but often not where you're
23867 looking for it. It is a reference manual, and not a guide to how to get
23870 That would be a totally different book, that should be written using the
23871 reference manual as source material. It would look quite differently.
23876 @section Terminology
23878 @cindex terminology
23883 This is what you are supposed to use this thing for---reading news.
23884 News is generally fetched from a nearby @sc{nntp} server, and is
23885 generally publicly available to everybody. If you post news, the entire
23886 world is likely to read just what you have written, and they'll all
23887 snigger mischievously. Behind your back.
23891 Everything that's delivered to you personally is mail. Some news/mail
23892 readers (like Gnus) blur the distinction between mail and news, but
23893 there is a difference. Mail is private. News is public. Mailing is
23894 not posting, and replying is not following up.
23898 Send a mail to the person who has written what you are reading.
23902 Post an article to the current newsgroup responding to the article you
23907 Gnus considers mail and news to be mostly the same, really. The only
23908 difference is how to access the actual articles. News articles are
23909 commonly fetched via the protocol NNTP, whereas mail messages could be
23910 read from a file on the local disk. The internal architecture of Gnus
23911 thus comprises a `front end' and a number of `back ends'. Internally,
23912 when you enter a group (by hitting @key{RET}, say), you thereby invoke
23913 a function in the front end in Gnus. The front end then `talks' to a
23914 back end and says things like ``Give me the list of articles in the foo
23915 group'' or ``Show me article number 4711''.
23917 So a back end mainly defines either a protocol (the @code{nntp} back end
23918 accesses news via NNTP, the @code{nnimap} back end accesses mail via
23919 IMAP) or a file format and directory layout (the @code{nnspool} back end
23920 accesses news via the common `spool directory' format, the @code{nnml}
23921 back end access mail via a file format and directory layout that's
23924 Gnus does not handle the underlying media, so to speak---this is all
23925 done by the back ends. A back end is a collection of functions to
23926 access the articles.
23928 However, sometimes the term `back end' is also used where `server'
23929 would have been more appropriate. And then there is the term `select
23930 method' which can mean either. The Gnus terminology can be quite
23935 Gnus will always use one method (and back end) as the @dfn{native}, or
23936 default, way of getting news.
23940 You can also have any number of foreign groups active at the same time.
23941 These are groups that use non-native non-secondary back ends for getting
23946 Secondary back ends are somewhere half-way between being native and being
23947 foreign, but they mostly act like they are native.
23951 A message that has been posted as news.
23954 @cindex mail message
23955 A message that has been mailed.
23959 A mail message or news article
23963 The top part of a message, where administrative information (etc.) is
23968 The rest of an article. Everything not in the head is in the
23973 A line from the head of an article.
23977 A collection of such lines, or a collection of heads. Or even a
23978 collection of @sc{nov} lines.
23982 When Gnus enters a group, it asks the back end for the headers of all
23983 unread articles in the group. Most servers support the News OverView
23984 format, which is more compact and much faster to read and parse than the
23985 normal @sc{head} format.
23989 Each group is subscribed at some @dfn{level} or other (1-9). The ones
23990 that have a lower level are ``more'' subscribed than the groups with a
23991 higher level. In fact, groups on levels 1-5 are considered
23992 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
23993 are @dfn{killed}. Commands for listing groups and scanning for new
23994 articles will all use the numeric prefix as @dfn{working level}.
23996 @item killed groups
23997 @cindex killed groups
23998 No information on killed groups is stored or updated, which makes killed
23999 groups much easier to handle than subscribed groups.
24001 @item zombie groups
24002 @cindex zombie groups
24003 Just like killed groups, only slightly less dead.
24006 @cindex active file
24007 The news server has to keep track of what articles it carries, and what
24008 groups exist. All this information in stored in the active file, which
24009 is rather large, as you might surmise.
24012 @cindex bogus groups
24013 A group that exists in the @file{.newsrc} file, but isn't known to the
24014 server (i.e., it isn't in the active file), is a @emph{bogus group}.
24015 This means that the group probably doesn't exist (any more).
24018 @cindex activating groups
24019 The act of asking the server for info on a group and computing the
24020 number of unread articles is called @dfn{activating the group}.
24021 Un-activated groups are listed with @samp{*} in the group buffer.
24025 A machine one can connect to and get news (or mail) from.
24027 @item select method
24028 @cindex select method
24029 A structure that specifies the back end, the server and the virtual
24032 @item virtual server
24033 @cindex virtual server
24034 A named select method. Since a select method defines all there is to
24035 know about connecting to a (physical) server, taking the thing as a
24036 whole is a virtual server.
24040 Taking a buffer and running it through a filter of some sort. The
24041 result will (more often than not) be cleaner and more pleasing than the
24044 @item ephemeral groups
24045 @cindex ephemeral groups
24046 Most groups store data on what articles you have read. @dfn{Ephemeral}
24047 groups are groups that will have no data stored---when you exit the
24048 group, it'll disappear into the aether.
24051 @cindex solid groups
24052 This is the opposite of ephemeral groups. All groups listed in the
24053 group buffer are solid groups.
24055 @item sparse articles
24056 @cindex sparse articles
24057 These are article placeholders shown in the summary buffer when
24058 @code{gnus-build-sparse-threads} has been switched on.
24062 To put responses to articles directly after the articles they respond
24063 to---in a hierarchical fashion.
24067 @cindex thread root
24068 The first article in a thread is the root. It is the ancestor of all
24069 articles in the thread.
24073 An article that has responses.
24077 An article that responds to a different article---its parent.
24081 A collection of messages in one file. The most common digest format is
24082 specified by RFC 1153.
24088 @node Customization
24089 @section Customization
24090 @cindex general customization
24092 All variables are properly documented elsewhere in this manual. This
24093 section is designed to give general pointers on how to customize Gnus
24094 for some quite common situations.
24097 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
24098 * Slow Terminal Connection:: You run a remote Emacs.
24099 * Little Disk Space:: You feel that having large setup files is icky.
24100 * Slow Machine:: You feel like buying a faster machine.
24104 @node Slow/Expensive Connection
24105 @subsection Slow/Expensive NNTP Connection
24107 If you run Emacs on a machine locally, and get your news from a machine
24108 over some very thin strings, you want to cut down on the amount of data
24109 Gnus has to get from the @sc{nntp} server.
24113 @item gnus-read-active-file
24114 Set this to @code{nil}, which will inhibit Gnus from requesting the
24115 entire active file from the server. This file is often v. large. You
24116 also have to set @code{gnus-check-new-newsgroups} and
24117 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
24118 doesn't suddenly decide to fetch the active file anyway.
24120 @item gnus-nov-is-evil
24121 This one has to be @code{nil}. If not, grabbing article headers from
24122 the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers
24123 support @sc{xover}; Gnus will detect this by itself.
24127 @node Slow Terminal Connection
24128 @subsection Slow Terminal Connection
24130 Let's say you use your home computer for dialing up the system that runs
24131 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
24132 possible) the amount of data sent over the wires.
24136 @item gnus-auto-center-summary
24137 Set this to @code{nil} to inhibit Gnus from re-centering the summary
24138 buffer all the time. If it is @code{vertical}, do only vertical
24139 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
24140 horizontal and vertical recentering.
24142 @item gnus-visible-headers
24143 Cut down on the headers included in the articles to the
24144 minimum. You can, in fact, make do without them altogether---most of the
24145 useful data is in the summary buffer, anyway. Set this variable to
24146 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
24148 Set this hook to all the available hiding commands:
24150 (setq gnus-treat-hide-headers 'head
24151 gnus-treat-hide-signature t
24152 gnus-treat-hide-citation t)
24155 @item gnus-use-full-window
24156 By setting this to @code{nil}, you can make all the windows smaller.
24157 While this doesn't really cut down much generally, it means that you
24158 have to see smaller portions of articles before deciding that you didn't
24159 want to read them anyway.
24161 @item gnus-thread-hide-subtree
24162 If this is non-@code{nil}, all threads in the summary buffer will be
24166 @item gnus-updated-mode-lines
24167 If this is @code{nil}, Gnus will not put information in the buffer mode
24168 lines, which might save some time.
24172 @node Little Disk Space
24173 @subsection Little Disk Space
24176 The startup files can get rather large, so you may want to cut their
24177 sizes a bit if you are running out of space.
24181 @item gnus-save-newsrc-file
24182 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
24183 only save @file{.newsrc.eld}. This means that you will not be able to
24184 use any other newsreaders than Gnus. This variable is @code{t} by
24187 @item gnus-read-newsrc-file
24188 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
24189 only read @file{.newsrc.eld}. This means that you will not be able to
24190 use any other newsreaders than Gnus. This variable is @code{t} by
24193 @item gnus-save-killed-list
24194 If this is @code{nil}, Gnus will not save the list of dead groups. You
24195 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
24196 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
24197 variable to @code{nil}. This variable is @code{t} by default.
24203 @subsection Slow Machine
24204 @cindex slow machine
24206 If you have a slow machine, or are just really impatient, there are a
24207 few things you can do to make Gnus run faster.
24209 Set @code{gnus-check-new-newsgroups} and
24210 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
24212 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
24213 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
24214 summary buffer faster.
24218 @node Troubleshooting
24219 @section Troubleshooting
24220 @cindex troubleshooting
24222 Gnus works @emph{so} well straight out of the box---I can't imagine any
24230 Make sure your computer is switched on.
24233 Make sure that you really load the current Gnus version. If you have
24234 been running @sc{gnus}, you need to exit Emacs and start it up again before
24238 Try doing an @kbd{M-x gnus-version}. If you get something that looks
24239 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded. If,
24240 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
24241 flee}, you have some old @file{.el} files lying around. Delete these.
24244 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
24248 @vindex max-lisp-eval-depth
24249 Gnus works on many recursive structures, and in some extreme (and very
24250 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
24251 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
24252 something like that.
24255 If all else fails, report the problem as a bug.
24258 @cindex reporting bugs
24260 @kindex M-x gnus-bug
24262 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
24263 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
24264 me the backtrace. I will fix bugs, but I can only fix them if you send
24265 me a precise description as to how to reproduce the bug.
24267 You really can never be too detailed in a bug report. Always use the
24268 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
24269 a 10Kb mail each time you use it, and even if you have sent me your
24270 environment 500 times before. I don't care. I want the full info each
24273 It is also important to remember that I have no memory whatsoever. If
24274 you send a bug report, and I send you a reply, and then you just send
24275 back ``No, it's not! Moron!'', I will have no idea what you are
24276 insulting me about. Always over-explain everything. It's much easier
24277 for all of us---if I don't have all the information I need, I will just
24278 mail you and ask for more info, and everything takes more time.
24280 If the problem you're seeing is very visual, and you can't quite explain
24281 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
24282 it somewhere it can be reached, and include the URL of the picture in
24286 If you would like to contribute a patch to fix bugs or make
24287 improvements, please produce the patch using @samp{diff -u}.
24290 If you want to debug your problem further before reporting, possibly
24291 in order to solve the problem yourself and send a patch, you can use
24292 edebug. Debugging lisp code is documented in the Elisp manual
24293 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
24294 Lisp Reference Manual}). To get you started with edebug, consider if
24295 you discover some weird behaviour when pressing @kbd{c}, the first
24296 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
24297 the documentation buffer that leads you to the function definition,
24298 then press @kbd{M-x edebug-defun RET} with point inside that function,
24299 return to Gnus and press @kbd{c} to invoke the code. You will be
24300 placed in the lisp buffer and can single step using @kbd{SPC} and
24301 evaluate expressions using @kbd{M-:} or inspect variables using
24302 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
24303 @kbd{c} or @kbd{g}.
24308 Sometimes, a problem do not directly generate a elisp error but
24309 manifests itself by causing Gnus to be very slow. In these cases, you
24310 can use @kbd{M-x toggle-debug-on-quit} and press C-j when things are
24311 slow, and then try to analyze the backtrace (repeating the procedure
24312 helps isolating the real problem areas). A fancier approach is to use
24313 the elisp profiler, ELP. The profiler is (or should be) fully
24314 documented elsewhere, but to get you started there are a few steps
24315 that need to be followed. First, instrument the part of Gnus you are
24316 interested in for profiling, e.g. @kbd{M-x elp-instrument-package RET
24317 gnus} or @kbd{M-x elp-instrument-packagre RET message}. Then perform
24318 the operation that is slow and press @kbd{M-x elp-results}. You will
24319 then see which operations that takes time, and can debug them further.
24320 If the entire operation takes much longer than the time spent in the
24321 slowest function in the profiler output, you probably profiled the
24322 wrong part of Gnus. To reset profiling statistics, use @kbd{M-x
24323 elp-reset-all}. @kbd{M-x elp-restore-all} is supposed to remove
24324 profiling, but given the complexities and dynamic code generation in
24325 Gnus, it might not always work perfectly.
24327 If you just need help, you are better off asking on
24328 @samp{gnu.emacs.gnus}. I'm not very helpful.
24330 @cindex gnu.emacs.gnus
24331 @cindex ding mailing list
24332 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
24333 Write to @samp{ding-request@@gnus.org} to subscribe.
24337 @node Gnus Reference Guide
24338 @section Gnus Reference Guide
24340 It is my hope that other people will figure out smart stuff that Gnus
24341 can do, and that other people will write those smart things as well. To
24342 facilitate that I thought it would be a good idea to describe the inner
24343 workings of Gnus. And some of the not-so-inner workings, while I'm at
24346 You can never expect the internals of a program not to change, but I
24347 will be defining (in some details) the interface between Gnus and its
24348 back ends (this is written in stone), the format of the score files
24349 (ditto), data structures (some are less likely to change than others)
24350 and general methods of operation.
24353 * Gnus Utility Functions:: Common functions and variable to use.
24354 * Back End Interface:: How Gnus communicates with the servers.
24355 * Score File Syntax:: A BNF definition of the score file standard.
24356 * Headers:: How Gnus stores headers internally.
24357 * Ranges:: A handy format for storing mucho numbers.
24358 * Group Info:: The group info format.
24359 * Extended Interactive:: Symbolic prefixes and stuff.
24360 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
24361 * Various File Formats:: Formats of files that Gnus use.
24365 @node Gnus Utility Functions
24366 @subsection Gnus Utility Functions
24367 @cindex Gnus utility functions
24368 @cindex utility functions
24370 @cindex internal variables
24372 When writing small functions to be run from hooks (and stuff), it's
24373 vital to have access to the Gnus internal functions and variables.
24374 Below is a list of the most common ones.
24378 @item gnus-newsgroup-name
24379 @vindex gnus-newsgroup-name
24380 This variable holds the name of the current newsgroup.
24382 @item gnus-find-method-for-group
24383 @findex gnus-find-method-for-group
24384 A function that returns the select method for @var{group}.
24386 @item gnus-group-real-name
24387 @findex gnus-group-real-name
24388 Takes a full (prefixed) Gnus group name, and returns the unprefixed
24391 @item gnus-group-prefixed-name
24392 @findex gnus-group-prefixed-name
24393 Takes an unprefixed group name and a select method, and returns the full
24394 (prefixed) Gnus group name.
24396 @item gnus-get-info
24397 @findex gnus-get-info
24398 Returns the group info list for @var{group}.
24400 @item gnus-group-unread
24401 @findex gnus-group-unread
24402 The number of unread articles in @var{group}, or @code{t} if that is
24406 @findex gnus-active
24407 The active entry for @var{group}.
24409 @item gnus-set-active
24410 @findex gnus-set-active
24411 Set the active entry for @var{group}.
24413 @item gnus-add-current-to-buffer-list
24414 @findex gnus-add-current-to-buffer-list
24415 Adds the current buffer to the list of buffers to be killed on Gnus
24418 @item gnus-continuum-version
24419 @findex gnus-continuum-version
24420 Takes a Gnus version string as a parameter and returns a floating point
24421 number. Earlier versions will always get a lower number than later
24424 @item gnus-group-read-only-p
24425 @findex gnus-group-read-only-p
24426 Says whether @var{group} is read-only or not.
24428 @item gnus-news-group-p
24429 @findex gnus-news-group-p
24430 Says whether @var{group} came from a news back end.
24432 @item gnus-ephemeral-group-p
24433 @findex gnus-ephemeral-group-p
24434 Says whether @var{group} is ephemeral or not.
24436 @item gnus-server-to-method
24437 @findex gnus-server-to-method
24438 Returns the select method corresponding to @var{server}.
24440 @item gnus-server-equal
24441 @findex gnus-server-equal
24442 Says whether two virtual servers are equal.
24444 @item gnus-group-native-p
24445 @findex gnus-group-native-p
24446 Says whether @var{group} is native or not.
24448 @item gnus-group-secondary-p
24449 @findex gnus-group-secondary-p
24450 Says whether @var{group} is secondary or not.
24452 @item gnus-group-foreign-p
24453 @findex gnus-group-foreign-p
24454 Says whether @var{group} is foreign or not.
24456 @item group-group-find-parameter
24457 @findex group-group-find-parameter
24458 Returns the parameter list of @var{group}. If given a second parameter,
24459 returns the value of that parameter for @var{group}.
24461 @item gnus-group-set-parameter
24462 @findex gnus-group-set-parameter
24463 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
24465 @item gnus-narrow-to-body
24466 @findex gnus-narrow-to-body
24467 Narrows the current buffer to the body of the article.
24469 @item gnus-check-backend-function
24470 @findex gnus-check-backend-function
24471 Takes two parameters, @var{function} and @var{group}. If the back end
24472 @var{group} comes from supports @var{function}, return non-@code{nil}.
24475 (gnus-check-backend-function "request-scan" "nnml:misc")
24479 @item gnus-read-method
24480 @findex gnus-read-method
24481 Prompts the user for a select method.
24486 @node Back End Interface
24487 @subsection Back End Interface
24489 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
24490 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
24491 server is a @dfn{back end} and some @dfn{back end variables}. As examples
24492 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
24493 examples of the latter we have @code{nntp-port-number} and
24494 @code{nnmbox-directory}.
24496 When Gnus asks for information from a back end---say @code{nntp}---on
24497 something, it will normally include a virtual server name in the
24498 function parameters. (If not, the back end should use the ``current''
24499 virtual server.) For instance, @code{nntp-request-list} takes a virtual
24500 server as its only (optional) parameter. If this virtual server hasn't
24501 been opened, the function should fail.
24503 Note that a virtual server name has no relation to some physical server
24504 name. Take this example:
24508 (nntp-address "ifi.uio.no")
24509 (nntp-port-number 4324))
24512 Here the virtual server name is @samp{odd-one} while the name of
24513 the physical server is @samp{ifi.uio.no}.
24515 The back ends should be able to switch between several virtual servers.
24516 The standard back ends implement this by keeping an alist of virtual
24517 server environments that they pull down/push up when needed.
24519 There are two groups of interface functions: @dfn{required functions},
24520 which must be present, and @dfn{optional functions}, which Gnus will
24521 always check for presence before attempting to call 'em.
24523 All these functions are expected to return data in the buffer
24524 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
24525 unfortunately named, but we'll have to live with it. When I talk about
24526 @dfn{resulting data}, I always refer to the data in that buffer. When I
24527 talk about @dfn{return value}, I talk about the function value returned by
24528 the function call. Functions that fail should return @code{nil} as the
24531 Some back ends could be said to be @dfn{server-forming} back ends, and
24532 some might be said not to be. The latter are back ends that generally
24533 only operate on one group at a time, and have no concept of ``server''
24534 -- they have a group, and they deliver info on that group and nothing
24537 Gnus identifies each message by way of group name and article number. A
24538 few remarks about these article numbers might be useful. First of all,
24539 the numbers are positive integers. Secondly, it is normally not
24540 possible for later articles to `re-use' older article numbers without
24541 confusing Gnus. That is, if a group has ever contained a message
24542 numbered 42, then no other message may get that number, or Gnus will get
24543 mightily confused.@footnote{See the function
24544 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
24545 Third, article numbers must be assigned in order of arrival in the
24546 group; this is not necessarily the same as the date of the message.
24548 The previous paragraph already mentions all the `hard' restrictions that
24549 article numbers must fulfill. But it seems that it might be useful to
24550 assign @emph{consecutive} article numbers, for Gnus gets quite confused
24551 if there are holes in the article numbering sequence. However, due to
24552 the `no-reuse' restriction, holes cannot be avoided altogether. It's
24553 also useful for the article numbers to start at 1 to avoid running out
24554 of numbers as long as possible.
24556 Note that by convention, backends are named @code{nnsomething}, but
24557 Gnus also comes with some @code{nnnotbackends}, such as
24558 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
24560 In the examples and definitions I will refer to the imaginary back end
24563 @cindex @code{nnchoke}
24566 * Required Back End Functions:: Functions that must be implemented.
24567 * Optional Back End Functions:: Functions that need not be implemented.
24568 * Error Messaging:: How to get messages and report errors.
24569 * Writing New Back Ends:: Extending old back ends.
24570 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
24571 * Mail-like Back Ends:: Some tips on mail back ends.
24575 @node Required Back End Functions
24576 @subsubsection Required Back End Functions
24580 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
24582 @var{articles} is either a range of article numbers or a list of
24583 @code{Message-ID}s. Current back ends do not fully support either---only
24584 sequences (lists) of article numbers, and most back ends do not support
24585 retrieval of @code{Message-ID}s. But they should try for both.
24587 The result data should either be HEADs or @sc{nov} lines, and the result
24588 value should either be @code{headers} or @code{nov} to reflect this.
24589 This might later be expanded to @code{various}, which will be a mixture
24590 of HEADs and @sc{nov} lines, but this is currently not supported by Gnus.
24592 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
24593 headers", in some meaning of the word. This is generally done by
24594 fetching (at most) @var{fetch-old} extra headers less than the smallest
24595 article number in @code{articles}, and filling the gaps as well. The
24596 presence of this parameter can be ignored if the back end finds it
24597 cumbersome to follow the request. If this is non-@code{nil} and not a
24598 number, do maximum fetches.
24600 Here's an example HEAD:
24603 221 1056 Article retrieved.
24604 Path: ifi.uio.no!sturles
24605 From: sturles@@ifi.uio.no (Sturle Sunde)
24606 Newsgroups: ifi.discussion
24607 Subject: Re: Something very droll
24608 Date: 27 Oct 1994 14:02:57 +0100
24609 Organization: Dept. of Informatics, University of Oslo, Norway
24611 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
24612 References: <38jdmq$4qu@@visbur.ifi.uio.no>
24613 NNTP-Posting-Host: holmenkollen.ifi.uio.no
24617 So a @code{headers} return value would imply that there's a number of
24618 these in the data buffer.
24620 Here's a BNF definition of such a buffer:
24624 head = error / valid-head
24625 error-message = [ "4" / "5" ] 2number " " <error message> eol
24626 valid-head = valid-message *header "." eol
24627 valid-message = "221 " <number> " Article retrieved." eol
24628 header = <text> eol
24631 If the return value is @code{nov}, the data buffer should contain
24632 @dfn{network overview database} lines. These are basically fields
24636 nov-buffer = *nov-line
24637 nov-line = 8*9 [ field <TAB> ] eol
24638 field = <text except TAB>
24641 For a closer look at what should be in those fields,
24645 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
24647 @var{server} is here the virtual server name. @var{definitions} is a
24648 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
24650 If the server can't be opened, no error should be signaled. The back end
24651 may then choose to refuse further attempts at connecting to this
24652 server. In fact, it should do so.
24654 If the server is opened already, this function should return a
24655 non-@code{nil} value. There should be no data returned.
24658 @item (nnchoke-close-server &optional SERVER)
24660 Close connection to @var{server} and free all resources connected
24661 to it. Return @code{nil} if the server couldn't be closed for some
24664 There should be no data returned.
24667 @item (nnchoke-request-close)
24669 Close connection to all servers and free all resources that the back end
24670 have reserved. All buffers that have been created by that back end
24671 should be killed. (Not the @code{nntp-server-buffer}, though.) This
24672 function is generally only called when Gnus is shutting down.
24674 There should be no data returned.
24677 @item (nnchoke-server-opened &optional SERVER)
24679 If @var{server} is the current virtual server, and the connection to the
24680 physical server is alive, then this function should return a
24681 non-@code{nil} vlue. This function should under no circumstances
24682 attempt to reconnect to a server we have lost connection to.
24684 There should be no data returned.
24687 @item (nnchoke-status-message &optional SERVER)
24689 This function should return the last error message from @var{server}.
24691 There should be no data returned.
24694 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
24696 The result data from this function should be the article specified by
24697 @var{article}. This might either be a @code{Message-ID} or a number.
24698 It is optional whether to implement retrieval by @code{Message-ID}, but
24699 it would be nice if that were possible.
24701 If @var{to-buffer} is non-@code{nil}, the result data should be returned
24702 in this buffer instead of the normal data buffer. This is to make it
24703 possible to avoid copying large amounts of data from one buffer to
24704 another, while Gnus mainly requests articles to be inserted directly
24705 into its article buffer.
24707 If it is at all possible, this function should return a cons cell where
24708 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
24709 the article number. This will enable Gnus to find out what the real
24710 group and article numbers are when fetching articles by
24711 @code{Message-ID}. If this isn't possible, @code{t} should be returned
24712 on successful article retrieval.
24715 @item (nnchoke-request-group GROUP &optional SERVER FAST)
24717 Get data on @var{group}. This function also has the side effect of
24718 making @var{group} the current group.
24720 If @var{fast}, don't bother to return useful data, just make @var{group}
24723 Here's an example of some result data and a definition of the same:
24726 211 56 1000 1059 ifi.discussion
24729 The first number is the status, which should be 211. Next is the
24730 total number of articles in the group, the lowest article number, the
24731 highest article number, and finally the group name. Note that the total
24732 number of articles may be less than one might think while just
24733 considering the highest and lowest article numbers, but some articles
24734 may have been canceled. Gnus just discards the total-number, so
24735 whether one should take the bother to generate it properly (if that is a
24736 problem) is left as an exercise to the reader. If the group contains no
24737 articles, the lowest article number should be reported as 1 and the
24741 group-status = [ error / info ] eol
24742 error = [ "4" / "5" ] 2<number> " " <Error message>
24743 info = "211 " 3* [ <number> " " ] <string>
24747 @item (nnchoke-close-group GROUP &optional SERVER)
24749 Close @var{group} and free any resources connected to it. This will be
24750 a no-op on most back ends.
24752 There should be no data returned.
24755 @item (nnchoke-request-list &optional SERVER)
24757 Return a list of all groups available on @var{server}. And that means
24760 Here's an example from a server that only carries two groups:
24763 ifi.test 0000002200 0000002000 y
24764 ifi.discussion 3324 3300 n
24767 On each line we have a group name, then the highest article number in
24768 that group, the lowest article number, and finally a flag. If the group
24769 contains no articles, the lowest article number should be reported as 1
24770 and the highest as 0.
24773 active-file = *active-line
24774 active-line = name " " <number> " " <number> " " flags eol
24776 flags = "n" / "y" / "m" / "x" / "j" / "=" name
24779 The flag says whether the group is read-only (@samp{n}), is moderated
24780 (@samp{m}), is dead (@samp{x}), is aliased to some other group
24781 (@samp{=other-group}) or none of the above (@samp{y}).
24784 @item (nnchoke-request-post &optional SERVER)
24786 This function should post the current buffer. It might return whether
24787 the posting was successful or not, but that's not required. If, for
24788 instance, the posting is done asynchronously, it has generally not been
24789 completed by the time this function concludes. In that case, this
24790 function should set up some kind of sentinel to beep the user loud and
24791 clear if the posting could not be completed.
24793 There should be no result data from this function.
24798 @node Optional Back End Functions
24799 @subsubsection Optional Back End Functions
24803 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
24805 @var{groups} is a list of groups, and this function should request data
24806 on all those groups. How it does it is of no concern to Gnus, but it
24807 should attempt to do this in a speedy fashion.
24809 The return value of this function can be either @code{active} or
24810 @code{group}, which says what the format of the result data is. The
24811 former is in the same format as the data from
24812 @code{nnchoke-request-list}, while the latter is a buffer full of lines
24813 in the same format as @code{nnchoke-request-group} gives.
24816 group-buffer = *active-line / *group-status
24820 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
24822 A Gnus group info (@pxref{Group Info}) is handed to the back end for
24823 alterations. This comes in handy if the back end really carries all the
24824 information (as is the case with virtual and imap groups). This
24825 function should destructively alter the info to suit its needs, and
24826 should return a non-nil value.
24828 There should be no result data from this function.
24831 @item (nnchoke-request-type GROUP &optional ARTICLE)
24833 When the user issues commands for ``sending news'' (@kbd{F} in the
24834 summary buffer, for instance), Gnus has to know whether the article the
24835 user is following up on is news or mail. This function should return
24836 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
24837 is mail and @code{unknown} if the type can't be decided. (The
24838 @var{article} parameter is necessary in @code{nnvirtual} groups which
24839 might very well combine mail groups and news groups.) Both @var{group}
24840 and @var{article} may be @code{nil}.
24842 There should be no result data from this function.
24845 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
24847 Set/remove/add marks on articles. Normally Gnus handles the article
24848 marks (such as read, ticked, expired etc) internally, and store them in
24849 @file{~/.newsrc.eld}. Some back ends (such as @sc{imap}) however carry
24850 all information about the articles on the server, so Gnus need to
24851 propagate the mark information to the server.
24853 @var{action} is a list of mark setting requests, having this format:
24856 (RANGE ACTION MARK)
24859 @var{range} is a range of articles you wish to update marks on.
24860 @var{action} is @code{add} or @code{del}, used to add marks or remove
24861 marks (preserving all marks not mentioned). @var{mark} is a list of
24862 marks; where each mark is a symbol. Currently used marks are
24863 @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed},
24864 @code{dormant}, @code{save}, @code{download}, @code{unsend},
24865 @code{forward} and @code{recent}, but your back end should, if
24866 possible, not limit itself to these.
24868 Given contradictory actions, the last action in the list should be the
24869 effective one. That is, if your action contains a request to add the
24870 @code{tick} mark on article 1 and, later in the list, a request to
24871 remove the mark on the same article, the mark should in fact be removed.
24873 An example action list:
24876 (((5 12 30) 'del '(tick))
24877 ((10 . 90) 'add '(read expire))
24878 ((92 94) 'del '(read)))
24881 The function should return a range of articles it wasn't able to set the
24882 mark on (currently not used for anything).
24884 There should be no result data from this function.
24886 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
24888 If the user tries to set a mark that the back end doesn't like, this
24889 function may change the mark. Gnus will use whatever this function
24890 returns as the mark for @var{article} instead of the original
24891 @var{mark}. If the back end doesn't care, it must return the original
24892 @var{mark}, and not @code{nil} or any other type of garbage.
24894 The only use for this I can see is what @code{nnvirtual} does with
24895 it---if a component group is auto-expirable, marking an article as read
24896 in the virtual group should result in the article being marked as
24899 There should be no result data from this function.
24902 @item (nnchoke-request-scan &optional GROUP SERVER)
24904 This function may be called at any time (by Gnus or anything else) to
24905 request that the back end check for incoming articles, in one way or
24906 another. A mail back end will typically read the spool file or query the
24907 POP server when this function is invoked. The @var{group} doesn't have
24908 to be heeded---if the back end decides that it is too much work just
24909 scanning for a single group, it may do a total scan of all groups. It
24910 would be nice, however, to keep things local if that's practical.
24912 There should be no result data from this function.
24915 @item (nnchoke-request-group-description GROUP &optional SERVER)
24917 The result data from this function should be a description of
24921 description-line = name <TAB> description eol
24923 description = <text>
24926 @item (nnchoke-request-list-newsgroups &optional SERVER)
24928 The result data from this function should be the description of all
24929 groups available on the server.
24932 description-buffer = *description-line
24936 @item (nnchoke-request-newgroups DATE &optional SERVER)
24938 The result data from this function should be all groups that were
24939 created after @samp{date}, which is in normal human-readable date format
24940 (i.e., the date format used in mail and news headers, and returned by
24941 the function @code{message-make-date} by default). The data should be
24942 in the active buffer format.
24944 It is okay for this function to return `too many' groups; some back ends
24945 might find it cheaper to return the full list of groups, rather than
24946 just the new groups. But don't do this for back ends with many groups.
24947 Normally, if the user creates the groups herself, there won't be too
24948 many groups, so @code{nnml} and the like are probably safe. But for
24949 back ends like @code{nntp}, where the groups have been created by the
24950 server, it is quite likely that there can be many groups.
24953 @item (nnchoke-request-create-group GROUP &optional SERVER)
24955 This function should create an empty group with name @var{group}.
24957 There should be no return data.
24960 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
24962 This function should run the expiry process on all articles in the
24963 @var{articles} range (which is currently a simple list of article
24964 numbers.) It is left up to the back end to decide how old articles
24965 should be before they are removed by this function. If @var{force} is
24966 non-@code{nil}, all @var{articles} should be deleted, no matter how new
24969 This function should return a list of articles that it did not/was not
24972 There should be no result data returned.
24975 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
24978 This function should move @var{article} (which is a number) from
24979 @var{group} by calling @var{accept-form}.
24981 This function should ready the article in question for moving by
24982 removing any header lines it has added to the article, and generally
24983 should ``tidy up'' the article. Then it should @code{eval}
24984 @var{accept-form} in the buffer where the ``tidy'' article is. This
24985 will do the actual copying. If this @code{eval} returns a
24986 non-@code{nil} value, the article should be removed.
24988 If @var{last} is @code{nil}, that means that there is a high likelihood
24989 that there will be more requests issued shortly, so that allows some
24992 The function should return a cons where the @code{car} is the group name and
24993 the @code{cdr} is the article number that the article was entered as.
24995 There should be no data returned.
24998 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
25000 This function takes the current buffer and inserts it into @var{group}.
25001 If @var{last} in @code{nil}, that means that there will be more calls to
25002 this function in short order.
25004 The function should return a cons where the @code{car} is the group name and
25005 the @code{cdr} is the article number that the article was entered as.
25007 The group should exist before the backend is asked to accept the
25008 article for that group.
25010 There should be no data returned.
25013 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
25015 This function should remove @var{article} (which is a number) from
25016 @var{group} and insert @var{buffer} there instead.
25018 There should be no data returned.
25021 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
25023 This function should delete @var{group}. If @var{force}, it should
25024 really delete all the articles in the group, and then delete the group
25025 itself. (If there is such a thing as ``the group itself''.)
25027 There should be no data returned.
25030 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
25032 This function should rename @var{group} into @var{new-name}. All
25033 articles in @var{group} should move to @var{new-name}.
25035 There should be no data returned.
25040 @node Error Messaging
25041 @subsubsection Error Messaging
25043 @findex nnheader-report
25044 @findex nnheader-get-report
25045 The back ends should use the function @code{nnheader-report} to report
25046 error conditions---they should not raise errors when they aren't able to
25047 perform a request. The first argument to this function is the back end
25048 symbol, and the rest are interpreted as arguments to @code{format} if
25049 there are multiple of them, or just a string if there is one of them.
25050 This function must always returns @code{nil}.
25053 (nnheader-report 'nnchoke "You did something totally bogus")
25055 (nnheader-report 'nnchoke "Could not request group %s" group)
25058 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
25059 @code{nil} back from a server, and this function returns the most
25060 recently reported message for the back end in question. This function
25061 takes one argument---the server symbol.
25063 Internally, these functions access @var{back-end}@code{-status-string},
25064 so the @code{nnchoke} back end will have its error message stored in
25065 @code{nnchoke-status-string}.
25068 @node Writing New Back Ends
25069 @subsubsection Writing New Back Ends
25071 Many back ends are quite similar. @code{nnml} is just like
25072 @code{nnspool}, but it allows you to edit the articles on the server.
25073 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
25074 and it doesn't maintain overview databases. @code{nndir} is just like
25075 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
25078 It would make sense if it were possible to ``inherit'' functions from
25079 back ends when writing new back ends. And, indeed, you can do that if you
25080 want to. (You don't have to if you don't want to, of course.)
25082 All the back ends declare their public variables and functions by using a
25083 package called @code{nnoo}.
25085 To inherit functions from other back ends (and allow other back ends to
25086 inherit functions from the current back end), you should use the
25092 This macro declares the first parameter to be a child of the subsequent
25093 parameters. For instance:
25096 (nnoo-declare nndir
25100 @code{nndir} has declared here that it intends to inherit functions from
25101 both @code{nnml} and @code{nnmh}.
25104 This macro is equivalent to @code{defvar}, but registers the variable as
25105 a public server variable. Most state-oriented variables should be
25106 declared with @code{defvoo} instead of @code{defvar}.
25108 In addition to the normal @code{defvar} parameters, it takes a list of
25109 variables in the parent back ends to map the variable to when executing
25110 a function in those back ends.
25113 (defvoo nndir-directory nil
25114 "Where nndir will look for groups."
25115 nnml-current-directory nnmh-current-directory)
25118 This means that @code{nnml-current-directory} will be set to
25119 @code{nndir-directory} when an @code{nnml} function is called on behalf
25120 of @code{nndir}. (The same with @code{nnmh}.)
25122 @item nnoo-define-basics
25123 This macro defines some common functions that almost all back ends should
25127 (nnoo-define-basics nndir)
25131 This macro is just like @code{defun} and takes the same parameters. In
25132 addition to doing the normal @code{defun} things, it registers the
25133 function as being public so that other back ends can inherit it.
25135 @item nnoo-map-functions
25136 This macro allows mapping of functions from the current back end to
25137 functions from the parent back ends.
25140 (nnoo-map-functions nndir
25141 (nnml-retrieve-headers 0 nndir-current-group 0 0)
25142 (nnmh-request-article 0 nndir-current-group 0 0))
25145 This means that when @code{nndir-retrieve-headers} is called, the first,
25146 third, and fourth parameters will be passed on to
25147 @code{nnml-retrieve-headers}, while the second parameter is set to the
25148 value of @code{nndir-current-group}.
25151 This macro allows importing functions from back ends. It should be the
25152 last thing in the source file, since it will only define functions that
25153 haven't already been defined.
25159 nnmh-request-newgroups)
25163 This means that calls to @code{nndir-request-list} should just be passed
25164 on to @code{nnmh-request-list}, while all public functions from
25165 @code{nnml} that haven't been defined in @code{nndir} yet should be
25170 Below is a slightly shortened version of the @code{nndir} back end.
25173 ;;; nndir.el --- single directory newsgroup access for Gnus
25174 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
25178 (require 'nnheader)
25182 (eval-when-compile (require 'cl))
25184 (nnoo-declare nndir
25187 (defvoo nndir-directory nil
25188 "Where nndir will look for groups."
25189 nnml-current-directory nnmh-current-directory)
25191 (defvoo nndir-nov-is-evil nil
25192 "*Non-nil means that nndir will never retrieve NOV headers."
25195 (defvoo nndir-current-group ""
25197 nnml-current-group nnmh-current-group)
25198 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
25199 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
25201 (defvoo nndir-status-string "" nil nnmh-status-string)
25202 (defconst nndir-version "nndir 1.0")
25204 ;;; Interface functions.
25206 (nnoo-define-basics nndir)
25208 (deffoo nndir-open-server (server &optional defs)
25209 (setq nndir-directory
25210 (or (cadr (assq 'nndir-directory defs))
25212 (unless (assq 'nndir-directory defs)
25213 (push `(nndir-directory ,server) defs))
25214 (push `(nndir-current-group
25215 ,(file-name-nondirectory
25216 (directory-file-name nndir-directory)))
25218 (push `(nndir-top-directory
25219 ,(file-name-directory (directory-file-name nndir-directory)))
25221 (nnoo-change-server 'nndir server defs))
25223 (nnoo-map-functions nndir
25224 (nnml-retrieve-headers 0 nndir-current-group 0 0)
25225 (nnmh-request-article 0 nndir-current-group 0 0)
25226 (nnmh-request-group nndir-current-group 0 0)
25227 (nnmh-close-group nndir-current-group 0))
25231 nnmh-status-message
25233 nnmh-request-newgroups))
25239 @node Hooking New Back Ends Into Gnus
25240 @subsubsection Hooking New Back Ends Into Gnus
25242 @vindex gnus-valid-select-methods
25243 @findex gnus-declare-backend
25244 Having Gnus start using your new back end is rather easy---you just
25245 declare it with the @code{gnus-declare-backend} functions. This will
25246 enter the back end into the @code{gnus-valid-select-methods} variable.
25248 @code{gnus-declare-backend} takes two parameters---the back end name and
25249 an arbitrary number of @dfn{abilities}.
25254 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
25257 The above line would then go in the @file{nnchoke.el} file.
25259 The abilities can be:
25263 This is a mailish back end---followups should (probably) go via mail.
25265 This is a newsish back end---followups should (probably) go via news.
25267 This back end supports both mail and news.
25269 This is neither a post nor mail back end---it's something completely
25272 It supports respooling---or rather, it is able to modify its source
25273 articles and groups.
25275 The name of the server should be in the virtual server name. This is
25276 true for almost all back ends.
25277 @item prompt-address
25278 The user should be prompted for an address when doing commands like
25279 @kbd{B} in the group buffer. This is true for back ends like
25280 @code{nntp}, but not @code{nnmbox}, for instance.
25284 @node Mail-like Back Ends
25285 @subsubsection Mail-like Back Ends
25287 One of the things that separate the mail back ends from the rest of the
25288 back ends is the heavy dependence by most of the mail back ends on
25289 common functions in @file{nnmail.el}. For instance, here's the
25290 definition of @code{nnml-request-scan}:
25293 (deffoo nnml-request-scan (&optional group server)
25294 (setq nnml-article-file-alist nil)
25295 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
25298 It simply calls @code{nnmail-get-new-mail} with a few parameters,
25299 and @code{nnmail} takes care of all the moving and splitting of the
25302 This function takes four parameters.
25306 This should be a symbol to designate which back end is responsible for
25309 @item exit-function
25310 This function should be called after the splitting has been performed.
25312 @item temp-directory
25313 Where the temporary files should be stored.
25316 This optional argument should be a group name if the splitting is to be
25317 performed for one group only.
25320 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
25321 save each article. @var{back-end}@code{-active-number} will be called to
25322 find the article number assigned to this article.
25324 The function also uses the following variables:
25325 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
25326 this back end); and @var{back-end}@code{-group-alist} and
25327 @var{back-end}@code{-active-file} to generate the new active file.
25328 @var{back-end}@code{-group-alist} should be a group-active alist, like
25332 (("a-group" (1 . 10))
25333 ("some-group" (34 . 39)))
25337 @node Score File Syntax
25338 @subsection Score File Syntax
25340 Score files are meant to be easily parseable, but yet extremely
25341 mallable. It was decided that something that had the same read syntax
25342 as an Emacs Lisp list would fit that spec.
25344 Here's a typical score file:
25348 ("win95" -10000 nil s)
25355 BNF definition of a score file:
25358 score-file = "" / "(" *element ")"
25359 element = rule / atom
25360 rule = string-rule / number-rule / date-rule
25361 string-rule = "(" quote string-header quote space *string-match ")"
25362 number-rule = "(" quote number-header quote space *number-match ")"
25363 date-rule = "(" quote date-header quote space *date-match ")"
25365 string-header = "subject" / "from" / "references" / "message-id" /
25366 "xref" / "body" / "head" / "all" / "followup"
25367 number-header = "lines" / "chars"
25368 date-header = "date"
25369 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
25370 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
25371 score = "nil" / <integer>
25372 date = "nil" / <natural number>
25373 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
25374 "r" / "regex" / "R" / "Regex" /
25375 "e" / "exact" / "E" / "Exact" /
25376 "f" / "fuzzy" / "F" / "Fuzzy"
25377 number-match = "(" <integer> [ "" / [ space score [ "" /
25378 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
25379 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
25380 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
25381 space date [ "" / [ space date-match-t ] ] ] ] ")"
25382 date-match-t = "nil" / "at" / "before" / "after"
25383 atom = "(" [ required-atom / optional-atom ] ")"
25384 required-atom = mark / expunge / mark-and-expunge / files /
25385 exclude-files / read-only / touched
25386 optional-atom = adapt / local / eval
25387 mark = "mark" space nil-or-number
25388 nil-or-number = "nil" / <integer>
25389 expunge = "expunge" space nil-or-number
25390 mark-and-expunge = "mark-and-expunge" space nil-or-number
25391 files = "files" *[ space <string> ]
25392 exclude-files = "exclude-files" *[ space <string> ]
25393 read-only = "read-only" [ space "nil" / space "t" ]
25394 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
25395 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
25396 local = "local" *[ space "(" <string> space <form> ")" ]
25397 eval = "eval" space <form>
25398 space = *[ " " / <TAB> / <NEWLINE> ]
25401 Any unrecognized elements in a score file should be ignored, but not
25404 As you can see, white space is needed, but the type and amount of white
25405 space is irrelevant. This means that formatting of the score file is
25406 left up to the programmer---if it's simpler to just spew it all out on
25407 one looong line, then that's ok.
25409 The meaning of the various atoms are explained elsewhere in this
25410 manual (@pxref{Score File Format}).
25414 @subsection Headers
25416 Internally Gnus uses a format for storing article headers that
25417 corresponds to the @sc{nov} format in a mysterious fashion. One could
25418 almost suspect that the author looked at the @sc{nov} specification and
25419 just shamelessly @emph{stole} the entire thing, and one would be right.
25421 @dfn{Header} is a severely overloaded term. ``Header'' is used in
25422 RFC 1036 to talk about lines in the head of an article (e.g.,
25423 @code{From}). It is used by many people as a synonym for
25424 ``head''---``the header and the body''. (That should be avoided, in my
25425 opinion.) And Gnus uses a format internally that it calls ``header'',
25426 which is what I'm talking about here. This is a 9-element vector,
25427 basically, with each header (ouch) having one slot.
25429 These slots are, in order: @code{number}, @code{subject}, @code{from},
25430 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
25431 @code{xref}, and @code{extra}. There are macros for accessing and
25432 setting these slots---they all have predictable names beginning with
25433 @code{mail-header-} and @code{mail-header-set-}, respectively.
25435 All these slots contain strings, except the @code{extra} slot, which
25436 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
25442 @sc{gnus} introduced a concept that I found so useful that I've started
25443 using it a lot and have elaborated on it greatly.
25445 The question is simple: If you have a large amount of objects that are
25446 identified by numbers (say, articles, to take a @emph{wild} example)
25447 that you want to qualify as being ``included'', a normal sequence isn't
25448 very useful. (A 200,000 length sequence is a bit long-winded.)
25450 The solution is as simple as the question: You just collapse the
25454 (1 2 3 4 5 6 10 11 12)
25457 is transformed into
25460 ((1 . 6) (10 . 12))
25463 To avoid having those nasty @samp{(13 . 13)} elements to denote a
25464 lonesome object, a @samp{13} is a valid element:
25467 ((1 . 6) 7 (10 . 12))
25470 This means that comparing two ranges to find out whether they are equal
25471 is slightly tricky:
25474 ((1 . 5) 7 8 (10 . 12))
25480 ((1 . 5) (7 . 8) (10 . 12))
25483 are equal. In fact, any non-descending list is a range:
25489 is a perfectly valid range, although a pretty long-winded one. This is
25496 and is equal to the previous range.
25498 Here's a BNF definition of ranges. Of course, one must remember the
25499 semantic requirement that the numbers are non-descending. (Any number
25500 of repetition of the same number is allowed, but apt to disappear in
25504 range = simple-range / normal-range
25505 simple-range = "(" number " . " number ")"
25506 normal-range = "(" start-contents ")"
25507 contents = "" / simple-range *[ " " contents ] /
25508 number *[ " " contents ]
25511 Gnus currently uses ranges to keep track of read articles and article
25512 marks. I plan on implementing a number of range operators in C if The
25513 Powers That Be are willing to let me. (I haven't asked yet, because I
25514 need to do some more thinking on what operators I need to make life
25515 totally range-based without ever having to convert back to normal
25520 @subsection Group Info
25522 Gnus stores all permanent info on groups in a @dfn{group info} list.
25523 This list is from three to six elements (or more) long and exhaustively
25524 describes the group.
25526 Here are two example group infos; one is a very simple group while the
25527 second is a more complex one:
25530 ("no.group" 5 ((1 . 54324)))
25532 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
25533 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
25535 ((auto-expire . t) (to-address . "ding@@gnus.org")))
25538 The first element is the @dfn{group name}---as Gnus knows the group,
25539 anyway. The second element is the @dfn{subscription level}, which
25540 normally is a small integer. (It can also be the @dfn{rank}, which is a
25541 cons cell where the @code{car} is the level and the @code{cdr} is the
25542 score.) The third element is a list of ranges of read articles. The
25543 fourth element is a list of lists of article marks of various kinds.
25544 The fifth element is the select method (or virtual server, if you like).
25545 The sixth element is a list of @dfn{group parameters}, which is what
25546 this section is about.
25548 Any of the last three elements may be missing if they are not required.
25549 In fact, the vast majority of groups will normally only have the first
25550 three elements, which saves quite a lot of cons cells.
25552 Here's a BNF definition of the group info format:
25555 info = "(" group space ralevel space read
25556 [ "" / [ space marks-list [ "" / [ space method [ "" /
25557 space parameters ] ] ] ] ] ")"
25558 group = quote <string> quote
25559 ralevel = rank / level
25560 level = <integer in the range of 1 to inf>
25561 rank = "(" level "." score ")"
25562 score = <integer in the range of 1 to inf>
25564 marks-lists = nil / "(" *marks ")"
25565 marks = "(" <string> range ")"
25566 method = "(" <string> *elisp-forms ")"
25567 parameters = "(" *elisp-forms ")"
25570 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
25571 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
25574 If you have a Gnus info and want to access the elements, Gnus offers a
25575 series of macros for getting/setting these elements.
25578 @item gnus-info-group
25579 @itemx gnus-info-set-group
25580 @findex gnus-info-group
25581 @findex gnus-info-set-group
25582 Get/set the group name.
25584 @item gnus-info-rank
25585 @itemx gnus-info-set-rank
25586 @findex gnus-info-rank
25587 @findex gnus-info-set-rank
25588 Get/set the group rank (@pxref{Group Score}).
25590 @item gnus-info-level
25591 @itemx gnus-info-set-level
25592 @findex gnus-info-level
25593 @findex gnus-info-set-level
25594 Get/set the group level.
25596 @item gnus-info-score
25597 @itemx gnus-info-set-score
25598 @findex gnus-info-score
25599 @findex gnus-info-set-score
25600 Get/set the group score (@pxref{Group Score}).
25602 @item gnus-info-read
25603 @itemx gnus-info-set-read
25604 @findex gnus-info-read
25605 @findex gnus-info-set-read
25606 Get/set the ranges of read articles.
25608 @item gnus-info-marks
25609 @itemx gnus-info-set-marks
25610 @findex gnus-info-marks
25611 @findex gnus-info-set-marks
25612 Get/set the lists of ranges of marked articles.
25614 @item gnus-info-method
25615 @itemx gnus-info-set-method
25616 @findex gnus-info-method
25617 @findex gnus-info-set-method
25618 Get/set the group select method.
25620 @item gnus-info-params
25621 @itemx gnus-info-set-params
25622 @findex gnus-info-params
25623 @findex gnus-info-set-params
25624 Get/set the group parameters.
25627 All the getter functions take one parameter---the info list. The setter
25628 functions take two parameters---the info list and the new value.
25630 The last three elements in the group info aren't mandatory, so it may be
25631 necessary to extend the group info before setting the element. If this
25632 is necessary, you can just pass on a non-@code{nil} third parameter to
25633 the three final setter functions to have this happen automatically.
25636 @node Extended Interactive
25637 @subsection Extended Interactive
25638 @cindex interactive
25639 @findex gnus-interactive
25641 Gnus extends the standard Emacs @code{interactive} specification
25642 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
25643 Prefixes}). Here's an example of how this is used:
25646 (defun gnus-summary-increase-score (&optional score symp)
25647 (interactive (gnus-interactive "P\ny"))
25652 The best thing to do would have been to implement
25653 @code{gnus-interactive} as a macro which would have returned an
25654 @code{interactive} form, but this isn't possible since Emacs checks
25655 whether a function is interactive or not by simply doing an @code{assq}
25656 on the lambda form. So, instead we have @code{gnus-interactive}
25657 function that takes a string and returns values that are usable to
25658 @code{interactive}.
25660 This function accepts (almost) all normal @code{interactive} specs, but
25665 @vindex gnus-current-prefix-symbol
25666 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
25670 @vindex gnus-current-prefix-symbols
25671 A list of the current symbolic prefixes---the
25672 @code{gnus-current-prefix-symbol} variable.
25675 The current article number---the @code{gnus-summary-article-number}
25679 The current article header---the @code{gnus-summary-article-header}
25683 The current group name---the @code{gnus-group-group-name}
25689 @node Emacs/XEmacs Code
25690 @subsection Emacs/XEmacs Code
25694 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
25695 platforms must be the primary one. I chose Emacs. Not because I don't
25696 like XEmacs or Mule, but because it comes first alphabetically.
25698 This means that Gnus will byte-compile under Emacs with nary a warning,
25699 while XEmacs will pump out gigabytes of warnings while byte-compiling.
25700 As I use byte-compilation warnings to help me root out trivial errors in
25701 Gnus, that's very useful.
25703 I've also consistently used Emacs function interfaces, but have used
25704 Gnusey aliases for the functions. To take an example: Emacs defines a
25705 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
25706 function. I then define a function called @code{gnus-run-at-time} that
25707 takes the same parameters as the Emacs @code{run-at-time}. When running
25708 Gnus under Emacs, the former function is just an alias for the latter.
25709 However, when running under XEmacs, the former is an alias for the
25710 following function:
25713 (defun gnus-xmas-run-at-time (time repeat function &rest args)
25717 (,function ,@@args))
25721 This sort of thing has been done for bunches of functions. Gnus does
25722 not redefine any native Emacs functions while running under XEmacs---it
25723 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
25726 In the cases where the XEmacs function interface was obviously cleaner,
25727 I used it instead. For example @code{gnus-region-active-p} is an alias
25728 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
25730 Of course, I could have chosen XEmacs as my native platform and done
25731 mapping functions the other way around. But I didn't. The performance
25732 hit these indirections impose on Gnus under XEmacs should be slight.
25735 @node Various File Formats
25736 @subsection Various File Formats
25739 * Active File Format:: Information on articles and groups available.
25740 * Newsgroups File Format:: Group descriptions.
25744 @node Active File Format
25745 @subsubsection Active File Format
25747 The active file lists all groups available on the server in
25748 question. It also lists the highest and lowest current article numbers
25751 Here's an excerpt from a typical active file:
25754 soc.motss 296030 293865 y
25755 alt.binaries.pictures.fractals 3922 3913 n
25756 comp.sources.unix 1605 1593 m
25757 comp.binaries.ibm.pc 5097 5089 y
25758 no.general 1000 900 y
25761 Here's a pseudo-BNF definition of this file:
25764 active = *group-line
25765 group-line = group spc high-number spc low-number spc flag <NEWLINE>
25766 group = <non-white-space string>
25768 high-number = <non-negative integer>
25769 low-number = <positive integer>
25770 flag = "y" / "n" / "m" / "j" / "x" / "=" group
25773 For a full description of this file, see the manual pages for
25774 @samp{innd}, in particular @samp{active(5)}.
25777 @node Newsgroups File Format
25778 @subsubsection Newsgroups File Format
25780 The newsgroups file lists groups along with their descriptions. Not all
25781 groups on the server have to be listed, and not all groups in the file
25782 have to exist on the server. The file is meant purely as information to
25785 The format is quite simple; a group name, a tab, and the description.
25786 Here's the definition:
25790 line = group tab description <NEWLINE>
25791 group = <non-white-space string>
25793 description = <string>
25798 @node Emacs for Heathens
25799 @section Emacs for Heathens
25801 Believe it or not, but some people who use Gnus haven't really used
25802 Emacs much before they embarked on their journey on the Gnus Love Boat.
25803 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
25804 region'', and ``set @code{gnus-flargblossen} to an alist where the key
25805 is a regexp that is used for matching on the group name'' are magical
25806 phrases with little or no meaning, then this appendix is for you. If
25807 you are already familiar with Emacs, just ignore this and go fondle your
25811 * Keystrokes:: Entering text and executing commands.
25812 * Emacs Lisp:: The built-in Emacs programming language.
25817 @subsection Keystrokes
25821 Q: What is an experienced Emacs user?
25824 A: A person who wishes that the terminal had pedals.
25827 Yes, when you use Emacs, you are apt to use the control key, the shift
25828 key and the meta key a lot. This is very annoying to some people
25829 (notably @code{vi}le users), and the rest of us just love the hell out
25830 of it. Just give up and submit. Emacs really does stand for
25831 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
25832 may have heard from other disreputable sources (like the Emacs author).
25834 The shift keys are normally located near your pinky fingers, and are
25835 normally used to get capital letters and stuff. You probably use it all
25836 the time. The control key is normally marked ``CTRL'' or something like
25837 that. The meta key is, funnily enough, never marked as such on any
25838 keyboard. The one I'm currently at has a key that's marked ``Alt'',
25839 which is the meta key on this keyboard. It's usually located somewhere
25840 to the left hand side of the keyboard, usually on the bottom row.
25842 Now, us Emacs people don't say ``press the meta-control-m key'',
25843 because that's just too inconvenient. We say ``press the @kbd{C-M-m}
25844 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
25845 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
25846 down the control key, and hold it down while you press @kbd{k}''.
25847 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
25848 the control key and then press @kbd{k}''. Simple, ay?
25850 This is somewhat complicated by the fact that not all keyboards have a
25851 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
25852 means ``press escape, release escape, press @kbd{k}''. That's much more
25853 work than if you have a meta key, so if that's the case, I respectfully
25854 suggest you get a real keyboard with a meta key. You can't live without
25860 @subsection Emacs Lisp
25862 Emacs is the King of Editors because it's really a Lisp interpreter.
25863 Each and every key you tap runs some Emacs Lisp code snippet, and since
25864 Emacs Lisp is an interpreted language, that means that you can configure
25865 any key to run any arbitrary code. You just, like, do it.
25867 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
25868 functions. (These are byte-compiled for speed, but it's still
25869 interpreted.) If you decide that you don't like the way Gnus does
25870 certain things, it's trivial to have it do something a different way.
25871 (Well, at least if you know how to write Lisp code.) However, that's
25872 beyond the scope of this manual, so we are simply going to talk about
25873 some common constructs that you normally use in your @file{.emacs} file
25876 If you want to set the variable @code{gnus-florgbnize} to four (4), you
25877 write the following:
25880 (setq gnus-florgbnize 4)
25883 This function (really ``special form'') @code{setq} is the one that can
25884 set a variable to some value. This is really all you need to know. Now
25885 you can go and fill your @file{.emacs} file with lots of these to change
25888 If you have put that thing in your @file{.emacs} file, it will be read
25889 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
25890 start Emacs. If you want to change the variable right away, simply say
25891 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
25892 previous ``form'', which is a simple @code{setq} statement here.
25894 Go ahead---just try it, if you're located at your Emacs. After you
25895 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
25896 is the return value of the form you @code{eval}ed.
25900 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
25904 (setq gnus-read-active-file 'some)
25907 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
25908 @samp{nntp.ifi.uio.no}'', that means:
25911 (setq gnus-nntp-server "nntp.ifi.uio.no")
25914 So be careful not to mix up strings (the latter) with symbols (the
25915 former). The manual is unambiguous, but it can be confusing.
25918 @include gnus-faq.texi
25938 @c Local Variables:
25940 @c coding: iso-8859-1
25942 % LocalWords: BNF mucho detailmenu cindex kindex kbd
25943 % LocalWords: findex Gnusae vindex dfn dfn samp nntp setq nnspool nntpserver
25944 % LocalWords: nnmbox newusers Blllrph NEWGROUPS dingnusdingnusdingnus
25945 % LocalWords: pre fab rec comp nnslashdot regex ga ga sci nnml nnbabyl nnmh
25946 % LocalWords: nnfolder emph looong eld newsreaders defun init elc pxref