1 \input texinfo @c -*-texinfo-*- -*- coding: iso-latin-1 -*-
10 * Gnus: (gnus). The newsreader Gnus.
15 @setchapternewpage odd
19 \documentclass[twoside,a4paper,openright,11pt]{book}
20 \usepackage[latin1]{inputenc}
21 \usepackage{pagestyle}
29 \newcommand{\gnuschaptername}{}
30 \newcommand{\gnussectionname}{}
32 \newcommand{\gnusbackslash}{/}
34 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
35 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
37 \newcommand{\gnuskindex}[1]{\index{#1}}
38 \newcommand{\gnusindex}[1]{\index{#1}}
40 \newcommand{\gnustt}[1]{{\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}}
41 \newcommand{\gnuscode}[1]{\gnustt{#1}}
42 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}''}
43 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
44 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
45 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
46 \newcommand{\gnusdfn}[1]{\textit{#1}}
47 \newcommand{\gnusi}[1]{\textit{#1}}
48 \newcommand{\gnusstrong}[1]{\textbf{#1}}
49 \newcommand{\gnusemph}[1]{\textit{#1}}
50 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
51 \newcommand{\gnussc}[1]{\textsc{#1}}
52 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
53 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
54 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
56 \newcommand{\gnusbullet}{{${\bullet}$}}
57 \newcommand{\gnusdollar}{\$}
58 \newcommand{\gnusampersand}{\&}
59 \newcommand{\gnuspercent}{\%}
60 \newcommand{\gnushash}{\#}
61 \newcommand{\gnushat}{\symbol{"5E}}
62 \newcommand{\gnusunderline}{\symbol{"5F}}
63 \newcommand{\gnusnot}{$\neg$}
64 \newcommand{\gnustilde}{\symbol{"7E}}
65 \newcommand{\gnusless}{{$<$}}
66 \newcommand{\gnusgreater}{{$>$}}
67 \newcommand{\gnusbraceleft}{{$>$}}
68 \newcommand{\gnusbraceright}{{$>$}}
70 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
71 \newcommand{\gnusinteresting}{
72 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
75 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
77 \newcommand{\gnuspagechapter}[1]{
84 \newcommand{\gnuschapter}[2]{
86 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
88 \renewcommand{\gnussectionname}{}
89 \renewcommand{\gnuschaptername}{#2}
92 \begin{picture}(500,500)(0,0)
93 \put(480,350){\makebox(0,0)[tr]{#1}}
94 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
99 \newcommand{\gnusfigure}[3]{
101 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
108 \newcommand{\gnusicon}[1]{
109 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=tmp/#1-up.ps,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=tmp/#1-up.ps,height=1cm}}}
112 \newcommand{\gnuspicon}[1]{
113 \margindex{\epsfig{figure=#1,width=2cm}}
116 \newcommand{\gnusxface}[2]{
117 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
120 \newcommand{\gnussmiley}[2]{
121 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
124 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
126 \newcommand{\gnussection}[1]{
127 \renewcommand{\gnussectionname}{#1}
131 \newenvironment{codelist}%
136 \newenvironment{kbdlist}%
142 \newenvironment{dfnlist}%
147 \newenvironment{stronglist}%
152 \newenvironment{samplist}%
157 \newenvironment{varlist}%
162 \newenvironment{emphlist}%
167 \newlength\gnusheadtextwidth
168 \setlength{\gnusheadtextwidth}{\headtextwidth}
169 \addtolength{\gnusheadtextwidth}{1cm}
171 \newpagestyle{gnuspreamble}%
176 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
180 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
189 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
191 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
196 \newpagestyle{gnusindex}%
201 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
205 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
213 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
215 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
225 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
229 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
237 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
239 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
244 \pagenumbering{roman}
245 \pagestyle{gnuspreamble}
255 %\addtolength{\oddsidemargin}{-5cm}
256 %\addtolength{\evensidemargin}{-5cm}
258 \addtolength{\textheight}{2cm}
260 \gnustitle{\gnustitlename}\\
263 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
266 \gnusauthor{by Lars Magne Ingebrigtsen}
273 \thispagestyle{empty}
275 Copyright \copyright{} 1995, 1996, 1997, 1998, 1999, 2000
276 Free Software Foundation, Inc.
279 Permission is granted to copy, distribute and/or modify this document
280 under the terms of the GNU Free Documentation License, Version 1.1 or
281 any later version published by the Free Software Foundation; with no
282 Invariant Sections, with the Front-Cover texts being ``A GNU
283 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
284 license is included in the section entitled ``GNU Free Documentation
285 License'' in the Emacs manual.
287 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
288 this GNU Manual, like GNU software. Copies published by the Free
289 Software Foundation raise funds for GNU development.''
291 This document is part of a collection distributed under the GNU Free
292 Documentation License. If you want to distribute this document
293 separately from the collection, you can do so by adding a copy of the
294 license to the document, as described in section 6 of the license.
302 This file documents Gnus, the GNU Emacs newsreader.
304 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
306 Permission is granted to copy, distribute and/or modify this document
307 under the terms of the GNU Free Documentation License, Version 1.1 or
308 any later version published by the Free Software Foundation; with the
309 Invariant Sections being none, with the Front-Cover texts being ``A GNU
310 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
311 license is included in the section entitled ``GNU Free Documentation
312 License'' in the Emacs manual.
314 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
315 this GNU Manual, like GNU software. Copies published by the Free
316 Software Foundation raise funds for GNU development.''
318 This document is part of a collection distributed under the GNU Free
319 Documentation License. If you want to distribute this document
320 separately from the collection, you can do so by adding a copy of the
321 license to the document, as described in section 6 of the license.
329 @author by Lars Magne Ingebrigtsen
332 @vskip 0pt plus 1filll
333 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
335 Permission is granted to copy, distribute and/or modify this document
336 under the terms of the GNU Free Documentation License, Version 1.1 or
337 any later version published by the Free Software Foundation; with no
338 Invariant Sections, with the Front-Cover texts being ``A GNU
339 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
340 license is included in the section entitled ``GNU Free Documentation
341 License'' in the Emacs manual.
343 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
344 this GNU Manual, like GNU software. Copies published by the Free
345 Software Foundation raise funds for GNU development.''
347 This document is part of a collection distributed under the GNU Free
348 Documentation License. If you want to distribute this document
349 separately from the collection, you can do so by adding a copy of the
350 license to the document, as described in section 6 of the license.
359 @top The Gnus Newsreader
363 You can read news (and mail) from within Emacs by using Gnus. The news
364 can be gotten by any nefarious means you can think of---@sc{nntp}, local
365 spool or your mbox file. All at the same time, if you want to push your
368 This manual corresponds to Oort Gnus v.
379 Gnus is the advanced, self-documenting, customizable, extensible
380 unreal-time newsreader for GNU Emacs.
382 Oops. That sounds oddly familiar, so let's start over again to avoid
383 being accused of plagiarism:
385 Gnus is a message-reading laboratory. It will let you look at just
386 about anything as if it were a newsgroup. You can read mail with it,
387 you can browse directories with it, you can @code{ftp} with it---you
388 can even read news with it!
390 Gnus tries to empower people who read news the same way Emacs empowers
391 people who edit text. Gnus sets no limits to what the user should be
392 allowed to do. Users are encouraged to extend Gnus to make it behave
393 like they want it to behave. A program should not control people;
394 people should be empowered to do what they want by using (or abusing)
400 * Starting Up:: Finding news can be a pain.
401 * Group Buffer:: Selecting, subscribing and killing groups.
402 * Summary Buffer:: Reading, saving and posting articles.
403 * Article Buffer:: Displaying and handling articles.
404 * Composing Messages:: Information on sending mail and news.
405 * Select Methods:: Gnus reads all messages from various select methods.
406 * Scoring:: Assigning values to articles.
407 * Various:: General purpose settings.
408 * The End:: Farewell and goodbye.
409 * Appendices:: Terminology, Emacs intro, FAQ, History, Internals.
410 * Index:: Variable, function and concept index.
411 * Key Index:: Key Index.
414 --- The Detailed Node Listing ---
418 * Finding the News:: Choosing a method for getting news.
419 * The First Time:: What does Gnus do the first time you start it?
420 * The Server is Down:: How can I read my mail then?
421 * Slave Gnusae:: You can have more than one Gnus active at a time.
422 * Fetching a Group:: Starting Gnus just to read a group.
423 * New Groups:: What is Gnus supposed to do with new groups?
424 * Startup Files:: Those pesky startup files---@file{.newsrc}.
425 * Auto Save:: Recovering from a crash.
426 * The Active File:: Reading the active file over a slow line Takes Time.
427 * Changing Servers:: You may want to move from one server to another.
428 * Startup Variables:: Other variables you might change.
432 * Checking New Groups:: Determining what groups are new.
433 * Subscription Methods:: What Gnus should do with new groups.
434 * Filtering New Groups:: Making Gnus ignore certain new groups.
438 * Group Buffer Format:: Information listed and how you can change it.
439 * Group Maneuvering:: Commands for moving in the group buffer.
440 * Selecting a Group:: Actually reading news.
441 * Group Data:: Changing the info for a group.
442 * Subscription Commands:: Unsubscribing, killing, subscribing.
443 * Group Levels:: Levels? What are those, then?
444 * Group Score:: A mechanism for finding out what groups you like.
445 * Marking Groups:: You can mark groups for later processing.
446 * Foreign Groups:: Creating and editing groups.
447 * Group Parameters:: Each group may have different parameters set.
448 * Listing Groups:: Gnus can list various subsets of the groups.
449 * Sorting Groups:: Re-arrange the group order.
450 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
451 * Browse Foreign Server:: You can browse a server. See what it has to offer.
452 * Exiting Gnus:: Stop reading news and get some work done.
453 * Group Topics:: A folding group mode divided into topics.
454 * Misc Group Stuff:: Other stuff that you can to do.
458 * Group Line Specification:: Deciding how the group buffer is to look.
459 * Group Modeline Specification:: The group buffer modeline.
460 * Group Highlighting:: Having nice colors in the group buffer.
464 * Topic Variables:: How to customize the topics the Lisp Way.
465 * Topic Commands:: Interactive E-Z commands.
466 * Topic Sorting:: Sorting each topic individually.
467 * Topic Topology:: A map of the world.
468 * Topic Parameters:: Parameters that apply to all groups in a topic.
472 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
473 * Group Information:: Information and help on groups and Gnus.
474 * Group Timestamp:: Making Gnus keep track of when you last read a group.
475 * File Commands:: Reading and writing the Gnus files.
479 * Summary Buffer Format:: Deciding how the summary buffer is to look.
480 * Summary Maneuvering:: Moving around the summary buffer.
481 * Choosing Articles:: Reading articles.
482 * Paging the Article:: Scrolling the current article.
483 * Reply Followup and Post:: Posting articles.
484 * Marking Articles:: Marking articles as read, expirable, etc.
485 * Limiting:: You can limit the summary buffer.
486 * Threading:: How threads are made.
487 * Sorting the Summary Buffer:: How articles and threads are sorted.
488 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
489 * Article Caching:: You may store articles in a cache.
490 * Persistent Articles:: Making articles expiry-resistant.
491 * Article Backlog:: Having already read articles hang around.
492 * Saving Articles:: Ways of customizing article saving.
493 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
494 * Article Treatment:: The article buffer can be mangled at will.
495 * MIME Commands:: Doing MIMEy things with the articles.
496 * Charsets:: Character set issues.
497 * Article Commands:: Doing various things with the article buffer.
498 * Summary Sorting:: Sorting the summary buffer in various ways.
499 * Finding the Parent:: No child support? Get the parent.
500 * Alternative Approaches:: Reading using non-default summaries.
501 * Tree Display:: A more visual display of threads.
502 * Mail Group Commands:: Some commands can only be used in mail groups.
503 * Various Summary Stuff:: What didn't fit anywhere else.
504 * Exiting the Summary Buffer:: Returning to the Group buffer.
505 * Crosspost Handling:: How crossposted articles are dealt with.
506 * Duplicate Suppression:: An alternative when crosspost handling fails.
507 * Security:: Decrypt and Verify.
509 Summary Buffer Format
511 * Summary Buffer Lines:: You can specify how summary lines should look.
512 * To From Newsgroups:: How to not display your own name.
513 * Summary Buffer Mode Line:: You can say how the mode line should look.
514 * Summary Highlighting:: Making the summary buffer all pretty and nice.
518 * Choosing Commands:: Commands for choosing articles.
519 * Choosing Variables:: Variables that influence these commands.
521 Reply, Followup and Post
523 * Summary Mail Commands:: Sending mail.
524 * Summary Post Commands:: Sending news.
525 * Summary Message Commands:: Other Message-related commands.
526 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
530 * Unread Articles:: Marks for unread articles.
531 * Read Articles:: Marks for read articles.
532 * Other Marks:: Marks that do not affect readedness.
533 * Setting Marks:: How to set and remove marks.
534 * Generic Marking Commands:: How to customize the marking.
535 * Setting Process Marks:: How to mark articles for later processing.
539 * Customizing Threading:: Variables you can change to affect the threading.
540 * Thread Commands:: Thread based commands in the summary buffer.
542 Customizing Threading
544 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
545 * Filling In Threads:: Making the threads displayed look fuller.
546 * More Threading:: Even more variables for fiddling with threads.
547 * Low-Level Threading:: You thought it was over... but you were wrong!
551 * Uuencoded Articles:: Uudecode articles.
552 * Shell Archives:: Unshar articles.
553 * PostScript Files:: Split PostScript.
554 * Other Files:: Plain save and binhex.
555 * Decoding Variables:: Variables for a happy decoding.
556 * Viewing Files:: You want to look at the result of the decoding?
560 * Rule Variables:: Variables that say how a file is to be viewed.
561 * Other Decode Variables:: Other decode variables.
562 * Uuencoding and Posting:: Variables for customizing uuencoding.
566 * Article Highlighting:: You want to make the article look like fruit salad.
567 * Article Fontisizing:: Making emphasized text look nice.
568 * Article Hiding:: You also want to make certain info go away.
569 * Article Washing:: Lots of way-neat functions to make life better.
570 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
571 * Article Date:: Grumble, UT!
572 * Article Signature:: What is a signature?
573 * Article Miscellania:: Various other stuff.
575 Alternative Approaches
577 * Pick and Read:: First mark articles and then read them.
578 * Binary Groups:: Auto-decode all articles.
580 Various Summary Stuff
582 * Summary Group Information:: Information oriented commands.
583 * Searching for Articles:: Multiple article commands.
584 * Summary Generation Commands:: (Re)generating the summary buffer.
585 * Really Various Summary Commands:: Those pesky non-conformant commands.
589 * Hiding Headers:: Deciding what headers should be displayed.
590 * Using MIME:: Pushing articles through @sc{mime} before reading them.
591 * Customizing Articles:: Tailoring the look of the articles.
592 * Article Keymap:: Keystrokes available in the article buffer.
593 * Misc Article:: Other stuff.
597 * Mail:: Mailing and replying.
598 * Posting Server:: What server should you post via?
599 * Mail and Post:: Mailing and posting at the same time.
600 * Archived Messages:: Where Gnus stores the messages you've sent.
601 * Posting Styles:: An easier way to specify who you are.
602 * Drafts:: Postponing messages and rejected messages.
603 * Rejected Articles:: What happens if the server doesn't like your article?
604 * Using GPG:: How to use GPG and MML to sign and encrypt messages
608 * Server Buffer:: Making and editing virtual servers.
609 * Getting News:: Reading USENET news with Gnus.
610 * Getting Mail:: Reading your personal mail with Gnus.
611 * Browsing the Web:: Getting messages from a plethora of Web sources.
612 * Other Sources:: Reading directories, files, SOUP packets.
613 * Combined Groups:: Combining groups into one group.
614 * Gnus Unplugged:: Reading news and mail offline.
618 * Server Buffer Format:: You can customize the look of this buffer.
619 * Server Commands:: Commands to manipulate servers.
620 * Example Methods:: Examples server specifications.
621 * Creating a Virtual Server:: An example session.
622 * Server Variables:: Which variables to set.
623 * Servers and Methods:: You can use server names as select methods.
624 * Unavailable Servers:: Some servers you try to contact may be down.
628 * NNTP:: Reading news from an @sc{nntp} server.
629 * News Spool:: Reading news from the local spool.
633 * Mail in a Newsreader:: Important introductory notes.
634 * Getting Started Reading Mail:: A simple cookbook example.
635 * Splitting Mail:: How to create mail groups.
636 * Mail Sources:: How to tell Gnus where to get mail from.
637 * Mail Backend Variables:: Variables for customizing mail handling.
638 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
639 * Group Mail Splitting:: Use group customize to drive mail splitting.
640 * Incorporating Old Mail:: What about the old mail you have?
641 * Expiring Mail:: Getting rid of unwanted mail.
642 * Washing Mail:: Removing cruft from the mail you get.
643 * Duplicates:: Dealing with duplicated mail.
644 * Not Reading Mail:: Using mail backends for reading other files.
645 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
649 * Mail Source Specifiers:: How to specify what a mail source is.
650 * Mail Source Customization:: Some variables that influence things.
651 * Fetching Mail:: Using the mail source specifiers.
653 Choosing a Mail Backend
655 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
656 * Rmail Babyl:: Emacs programs use the rmail babyl format.
657 * Mail Spool:: Store your mail in a private spool?
658 * MH Spool:: An mhspool-like backend.
659 * Mail Folders:: Having one file for each group.
660 * Comparing Mail Backends:: An in-depth looks at pros and cons.
664 * Web Searches:: Creating groups from articles that match a string.
665 * Slashdot:: Reading the Slashdot comments.
666 * Ultimate:: The Ultimate Bulletin Board systems.
667 * Web Archive:: Reading mailing list archived on web.
671 * Directory Groups:: You can read a directory as if it was a newsgroup.
672 * Anything Groups:: Dired? Who needs dired?
673 * Document Groups:: Single files can be the basis of a group.
674 * SOUP:: Reading @sc{soup} packets ``offline''.
675 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
676 * IMAP:: Using Gnus as a @sc{imap} client.
680 * Document Server Internals:: How to add your own document types.
684 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
685 * SOUP Groups:: A backend for reading @sc{soup} packets.
686 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
690 * Splitting in IMAP:: Splitting mail with nnimap.
691 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
692 * Expunging mailboxes:: Equivalent of a "compress mailbox" button.
696 * Virtual Groups:: Combining articles from many groups.
697 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
701 * Agent Basics:: How it all is supposed to work.
702 * Agent Categories:: How to tell the Gnus Agent what to download.
703 * Agent Commands:: New commands for all the buffers.
704 * Agent Expiry:: How to make old articles go away.
705 * Agent and IMAP:: How to use the Agent with IMAP.
706 * Outgoing Messages:: What happens when you post/mail something?
707 * Agent Variables:: Customizing is fun.
708 * Example Setup:: An example @file{.gnus.el} file for offline people.
709 * Batching Agents:: How to fetch news from a @code{cron} job.
710 * Agent Caveats:: What you think it'll do and what it does.
714 * Category Syntax:: What a category looks like.
715 * Category Buffer:: A buffer for maintaining categories.
716 * Category Variables:: Customize'r'Us.
720 * Group Agent Commands::
721 * Summary Agent Commands::
722 * Server Agent Commands::
726 * Summary Score Commands:: Adding score entries for the current group.
727 * Group Score Commands:: General score commands.
728 * Score Variables:: Customize your scoring. (My, what terminology).
729 * Score File Format:: What a score file may contain.
730 * Score File Editing:: You can edit score files by hand as well.
731 * Adaptive Scoring:: Big Sister Gnus knows what you read.
732 * Home Score File:: How to say where new score entries are to go.
733 * Followups To Yourself:: Having Gnus notice when people answer you.
734 * Scoring Tips:: How to score effectively.
735 * Reverse Scoring:: That problem child of old is not problem.
736 * Global Score Files:: Earth-spanning, ear-splitting score files.
737 * Kill Files:: They are still here, but they can be ignored.
738 * Converting Kill Files:: Translating kill files to score files.
739 * GroupLens:: Getting predictions on what you like to read.
740 * Advanced Scoring:: Using logical expressions to build score rules.
741 * Score Decays:: It can be useful to let scores wither away.
745 * Using GroupLens:: How to make Gnus use GroupLens.
746 * Rating Articles:: Letting GroupLens know how you rate articles.
747 * Displaying Predictions:: Displaying predictions given by GroupLens.
748 * GroupLens Variables:: Customizing GroupLens.
752 * Advanced Scoring Syntax:: A definition.
753 * Advanced Scoring Examples:: What they look like.
754 * Advanced Scoring Tips:: Getting the most out of it.
758 * Process/Prefix:: A convention used by many treatment commands.
759 * Interactive:: Making Gnus ask you many questions.
760 * Symbolic Prefixes:: How to supply some Gnus functions with options.
761 * Formatting Variables:: You can specify what buffers should look like.
762 * Windows Configuration:: Configuring the Gnus buffer windows.
763 * Faces and Fonts:: How to change how faces look.
764 * Compilation:: How to speed Gnus up.
765 * Mode Lines:: Displaying information in the mode lines.
766 * Highlighting and Menus:: Making buffers look all nice and cozy.
767 * Buttons:: Get tendinitis in ten easy steps!
768 * Daemons:: Gnus can do things behind your back.
769 * NoCeM:: How to avoid spam and other fatty foods.
770 * Undo:: Some actions can be undone.
771 * Moderation:: What to do if you're a moderator.
772 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
773 * Fuzzy Matching:: What's the big fuzz?
774 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
775 * Various Various:: Things that are really various.
779 * Formatting Basics:: A formatting variable is basically a format string.
780 * Mode Line Formatting:: Some rules about mode line formatting variables.
781 * Advanced Formatting:: Modifying output in various ways.
782 * User-Defined Specs:: Having Gnus call your own functions.
783 * Formatting Fonts:: Making the formatting look colorful and nice.
787 * Picons:: How to display pictures of what your reading.
788 * Smileys:: Show all those happy faces the way they were meant to be shown.
789 * Toolbar:: Click'n'drool.
790 * XVarious:: Other XEmacsy Gnusey variables.
794 * Picon Basics:: What are picons and How do I get them.
795 * Picon Requirements:: Don't go further if you aren't using XEmacs.
796 * Easy Picons:: Displaying Picons---the easy way.
797 * Hard Picons:: The way you should do it. You'll learn something.
798 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
802 * History:: How Gnus got where it is today.
803 * On Writing Manuals:: Why this is not a beginner's guide.
804 * Terminology:: We use really difficult, like, words here.
805 * Customization:: Tailoring Gnus to your needs.
806 * Troubleshooting:: What you might try if things do not work.
807 * Gnus Reference Guide:: Rilly, rilly technical stuff.
808 * Emacs for Heathens:: A short introduction to Emacsian terms.
809 * Frequently Asked Questions:: A question-and-answer session.
813 * Gnus Versions:: What Gnus versions have been released.
814 * Other Gnus Versions:: Other Gnus versions that also have been released.
815 * Why?:: What's the point of Gnus?
816 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
817 * Conformity:: Gnus tries to conform to all standards.
818 * Emacsen:: Gnus can be run on a few modern Emacsen.
819 * Gnus Development:: How Gnus is developed.
820 * Contributors:: Oodles of people.
821 * New Features:: Pointers to some of the new stuff in Gnus.
825 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
826 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
827 * Red Gnus:: Third time best---Gnus 5.4/5.5.
828 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
829 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
833 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
834 * Slow Terminal Connection:: You run a remote Emacs.
835 * Little Disk Space:: You feel that having large setup files is icky.
836 * Slow Machine:: You feel like buying a faster machine.
840 * Gnus Utility Functions:: Common functions and variable to use.
841 * Backend Interface:: How Gnus communicates with the servers.
842 * Score File Syntax:: A BNF definition of the score file standard.
843 * Headers:: How Gnus stores headers internally.
844 * Ranges:: A handy format for storing mucho numbers.
845 * Group Info:: The group info format.
846 * Extended Interactive:: Symbolic prefixes and stuff.
847 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
848 * Various File Formats:: Formats of files that Gnus use.
852 * Required Backend Functions:: Functions that must be implemented.
853 * Optional Backend Functions:: Functions that need not be implemented.
854 * Error Messaging:: How to get messages and report errors.
855 * Writing New Backends:: Extending old backends.
856 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
857 * Mail-like Backends:: Some tips on mail backends.
861 * Active File Format:: Information on articles and groups available.
862 * Newsgroups File Format:: Group descriptions.
866 * Keystrokes:: Entering text and executing commands.
867 * Emacs Lisp:: The built-in Emacs programming language.
873 @chapter Starting Gnus
878 If your system administrator has set things up properly, starting Gnus
879 and reading news is extremely easy---you just type @kbd{M-x gnus} in
882 @findex gnus-other-frame
883 @kindex M-x gnus-other-frame
884 If you want to start Gnus in a different frame, you can use the command
885 @kbd{M-x gnus-other-frame} instead.
887 If things do not go smoothly at startup, you have to twiddle some
888 variables in your @file{~/.gnus} file. This file is similar to
889 @file{~/.emacs}, but is read when gnus starts.
891 If you puzzle at any terms used in this manual, please refer to the
892 terminology section (@pxref{Terminology}).
895 * Finding the News:: Choosing a method for getting news.
896 * The First Time:: What does Gnus do the first time you start it?
897 * The Server is Down:: How can I read my mail then?
898 * Slave Gnusae:: You can have more than one Gnus active at a time.
899 * Fetching a Group:: Starting Gnus just to read a group.
900 * New Groups:: What is Gnus supposed to do with new groups?
901 * Startup Files:: Those pesky startup files---@file{.newsrc}.
902 * Auto Save:: Recovering from a crash.
903 * The Active File:: Reading the active file over a slow line Takes Time.
904 * Changing Servers:: You may want to move from one server to another.
905 * Startup Variables:: Other variables you might change.
909 @node Finding the News
910 @section Finding the News
913 @vindex gnus-select-method
915 The @code{gnus-select-method} variable says where Gnus should look for
916 news. This variable should be a list where the first element says
917 @dfn{how} and the second element says @dfn{where}. This method is your
918 native method. All groups not fetched with this method are
921 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
922 you want to get your daily dosage of news from, you'd say:
925 (setq gnus-select-method '(nntp "news.somewhere.edu"))
928 If you want to read directly from the local spool, say:
931 (setq gnus-select-method '(nnspool ""))
934 If you can use a local spool, you probably should, as it will almost
935 certainly be much faster.
937 @vindex gnus-nntpserver-file
939 @cindex @sc{nntp} server
940 If this variable is not set, Gnus will take a look at the
941 @code{NNTPSERVER} environment variable. If that variable isn't set,
942 Gnus will see whether @code{gnus-nntpserver-file}
943 (@file{/etc/nntpserver} by default) has any opinions on the matter. If
944 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server. That's a long shot, though.
946 @vindex gnus-nntp-server
947 If @code{gnus-nntp-server} is set, this variable will override
948 @code{gnus-select-method}. You should therefore set
949 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
951 @vindex gnus-secondary-servers
952 @vindex gnus-nntp-server
953 You can also make Gnus prompt you interactively for the name of an
954 @sc{nntp} server. If you give a non-numerical prefix to @code{gnus}
955 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
956 in the @code{gnus-secondary-servers} list (if any). You can also just
957 type in the name of any server you feel like visiting. (Note that this
958 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
959 gnus} later in the same Emacs session, Gnus will contact the same
962 @findex gnus-group-browse-foreign-server
964 However, if you use one @sc{nntp} server regularly and are just
965 interested in a couple of groups from a different server, you would be
966 better served by using the @kbd{B} command in the group buffer. It will
967 let you have a look at what groups are available, and you can subscribe
968 to any of the groups you want to. This also makes @file{.newsrc}
969 maintenance much tidier. @xref{Foreign Groups}.
971 @vindex gnus-secondary-select-methods
973 A slightly different approach to foreign groups is to set the
974 @code{gnus-secondary-select-methods} variable. The select methods
975 listed in this variable are in many ways just as native as the
976 @code{gnus-select-method} server. They will also be queried for active
977 files during startup (if that's required), and new newsgroups that
978 appear on these servers will be subscribed (or not) just as native
981 For instance, if you use the @code{nnmbox} backend to read your mail, you
982 would typically set this variable to
985 (setq gnus-secondary-select-methods '((nnmbox "")))
990 @section The First Time
991 @cindex first time usage
993 If no startup files exist, Gnus will try to determine what groups should
994 be subscribed by default.
996 @vindex gnus-default-subscribed-newsgroups
997 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
998 will subscribe you to just those groups in that list, leaving the rest
999 killed. Your system administrator should have set this variable to
1002 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
1003 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1004 here as @dfn{whatever Lars thinks you should read}.)
1006 You'll also be subscribed to the Gnus documentation group, which should
1007 help you with most common problems.
1009 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
1010 use the normal functions for handling new groups, and not do anything
1014 @node The Server is Down
1015 @section The Server is Down
1016 @cindex server errors
1018 If the default server is down, Gnus will understandably have some
1019 problems starting. However, if you have some mail groups in addition to
1020 the news groups, you may want to start Gnus anyway.
1022 Gnus, being the trusting sort of program, will ask whether to proceed
1023 without a native select method if that server can't be contacted. This
1024 will happen whether the server doesn't actually exist (i.e., you have
1025 given the wrong address) or the server has just momentarily taken ill
1026 for some reason or other. If you decide to continue and have no foreign
1027 groups, you'll find it difficult to actually do anything in the group
1028 buffer. But, hey, that's your problem. Blllrph!
1030 @findex gnus-no-server
1031 @kindex M-x gnus-no-server
1033 If you know that the server is definitely down, or you just want to read
1034 your mail without bothering with the server at all, you can use the
1035 @code{gnus-no-server} command to start Gnus. That might come in handy
1036 if you're in a hurry as well. This command will not attempt to contact
1037 your primary server---instead, it will just activate all groups on level
1038 1 and 2. (You should preferably keep no native groups on those two
1039 levels.) Also @pxref{Group Levels}.
1043 @section Slave Gnusae
1046 You might want to run more than one Emacs with more than one Gnus at the
1047 same time. If you are using different @file{.newsrc} files (e.g., if you
1048 are using the two different Gnusae to read from two different servers),
1049 that is no problem whatsoever. You just do it.
1051 The problem appears when you want to run two Gnusae that use the same
1052 @code{.newsrc} file.
1054 To work around that problem some, we here at the Think-Tank at the Gnus
1055 Towers have come up with a new concept: @dfn{Masters} and
1056 @dfn{slaves}. (We have applied for a patent on this concept, and have
1057 taken out a copyright on those words. If you wish to use those words in
1058 conjunction with each other, you have to send $1 per usage instance to
1059 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1060 Applications}) will be much more expensive, of course.)
1062 Anyway, you start one Gnus up the normal way with @kbd{M-x gnus} (or
1063 however you do it). Each subsequent slave Gnusae should be started with
1064 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1065 files, but instead save @dfn{slave files} that contain information only
1066 on what groups have been read in the slave session. When a master Gnus
1067 starts, it will read (and delete) these slave files, incorporating all
1068 information from them. (The slave files will be read in the sequence
1069 they were created, so the latest changes will have precedence.)
1071 Information from the slave files has, of course, precedence over the
1072 information in the normal (i.e., master) @code{.newsrc} file.
1075 @node Fetching a Group
1076 @section Fetching a Group
1077 @cindex fetching a group
1079 @findex gnus-fetch-group
1080 It is sometimes convenient to be able to just say ``I want to read this
1081 group and I don't care whether Gnus has been started or not''. This is
1082 perhaps more useful for people who write code than for users, but the
1083 command @code{gnus-fetch-group} provides this functionality in any case.
1084 It takes the group name as a parameter.
1090 @cindex subscription
1092 @vindex gnus-check-new-newsgroups
1093 If you are satisfied that you really never want to see any new groups,
1094 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1095 also save you some time at startup. Even if this variable is
1096 @code{nil}, you can always subscribe to the new groups just by pressing
1097 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1098 is @code{ask-server} by default. If you set this variable to
1099 @code{always}, then Gnus will query the backends for new groups even
1100 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1103 * Checking New Groups:: Determining what groups are new.
1104 * Subscription Methods:: What Gnus should do with new groups.
1105 * Filtering New Groups:: Making Gnus ignore certain new groups.
1109 @node Checking New Groups
1110 @subsection Checking New Groups
1112 Gnus normally determines whether a group is new or not by comparing the
1113 list of groups from the active file(s) with the lists of subscribed and
1114 dead groups. This isn't a particularly fast method. If
1115 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
1116 server for new groups since the last time. This is both faster and
1117 cheaper. This also means that you can get rid of the list of killed
1118 groups altogether, so you may set @code{gnus-save-killed-list} to
1119 @code{nil}, which will save time both at startup, at exit, and all over.
1120 Saves disk space, too. Why isn't this the default, then?
1121 Unfortunately, not all servers support this command.
1123 I bet I know what you're thinking now: How do I find out whether my
1124 server supports @code{ask-server}? No? Good, because I don't have a
1125 fail-safe answer. I would suggest just setting this variable to
1126 @code{ask-server} and see whether any new groups appear within the next
1127 few days. If any do, then it works. If none do, then it doesn't
1128 work. I could write a function to make Gnus guess whether the server
1129 supports @code{ask-server}, but it would just be a guess. So I won't.
1130 You could @code{telnet} to the server and say @code{HELP} and see
1131 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1132 it does, then it might work. (But there are servers that lists
1133 @samp{NEWGROUPS} without supporting the function properly.)
1135 This variable can also be a list of select methods. If so, Gnus will
1136 issue an @code{ask-server} command to each of the select methods, and
1137 subscribe them (or not) using the normal methods. This might be handy
1138 if you are monitoring a few servers for new groups. A side effect is
1139 that startup will take much longer, so you can meditate while waiting.
1140 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1143 @node Subscription Methods
1144 @subsection Subscription Methods
1146 @vindex gnus-subscribe-newsgroup-method
1147 What Gnus does when it encounters a new group is determined by the
1148 @code{gnus-subscribe-newsgroup-method} variable.
1150 This variable should contain a function. This function will be called
1151 with the name of the new group as the only parameter.
1153 Some handy pre-fab functions are:
1157 @item gnus-subscribe-zombies
1158 @vindex gnus-subscribe-zombies
1159 Make all new groups zombies. This is the default. You can browse the
1160 zombies later (with @kbd{A z}) and either kill them all off properly
1161 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1163 @item gnus-subscribe-randomly
1164 @vindex gnus-subscribe-randomly
1165 Subscribe all new groups in arbitrary order. This really means that all
1166 new groups will be added at ``the top'' of the group buffer.
1168 @item gnus-subscribe-alphabetically
1169 @vindex gnus-subscribe-alphabetically
1170 Subscribe all new groups in alphabetical order.
1172 @item gnus-subscribe-hierarchically
1173 @vindex gnus-subscribe-hierarchically
1174 Subscribe all new groups hierarchically. The difference between this
1175 function and @code{gnus-subscribe-alphabetically} is slight.
1176 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1177 alphabetical fashion, while this function will enter groups into its
1178 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1179 @samp{comp} hierarchy, this function will not mess that configuration
1180 up. Or something like that.
1182 @item gnus-subscribe-interactively
1183 @vindex gnus-subscribe-interactively
1184 Subscribe new groups interactively. This means that Gnus will ask
1185 you about @strong{all} new groups. The groups you choose to subscribe
1186 to will be subscribed hierarchically.
1188 @item gnus-subscribe-killed
1189 @vindex gnus-subscribe-killed
1190 Kill all new groups.
1192 @item gnus-subscribe-topics
1193 @vindex gnus-subscribe-topics
1194 Put the groups into the topic that has a matching @code{subscribe} topic
1195 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1196 topic parameter that looks like
1202 will mean that all groups that match that regex will be subscribed under
1205 If no topics match the groups, the groups will be subscribed in the
1210 @vindex gnus-subscribe-hierarchical-interactive
1211 A closely related variable is
1212 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1213 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
1214 hierarchical fashion whether to subscribe to new groups or not. Gnus
1215 will ask you for each sub-hierarchy whether you want to descend the
1218 One common mistake is to set the variable a few paragraphs above
1219 (@code{gnus-subscribe-newsgroup-method}) to
1220 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1221 will not work. This is ga-ga. So don't do it.
1224 @node Filtering New Groups
1225 @subsection Filtering New Groups
1227 A nice and portable way to control which new newsgroups should be
1228 subscribed (or ignored) is to put an @dfn{options} line at the start of
1229 the @file{.newsrc} file. Here's an example:
1232 options -n !alt.all !rec.all sci.all
1235 @vindex gnus-subscribe-options-newsgroup-method
1236 This line obviously belongs to a serious-minded intellectual scientific
1237 person (or she may just be plain old boring), because it says that all
1238 groups that have names beginning with @samp{alt} and @samp{rec} should
1239 be ignored, and all groups with names beginning with @samp{sci} should
1240 be subscribed. Gnus will not use the normal subscription method for
1241 subscribing these groups.
1242 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1243 variable defaults to @code{gnus-subscribe-alphabetically}.
1245 @vindex gnus-options-not-subscribe
1246 @vindex gnus-options-subscribe
1247 If you don't want to mess with your @file{.newsrc} file, you can just
1248 set the two variables @code{gnus-options-subscribe} and
1249 @code{gnus-options-not-subscribe}. These two variables do exactly the
1250 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1251 and if the new group matches the former, it will be unconditionally
1252 subscribed, and if it matches the latter, it will be ignored.
1254 @vindex gnus-auto-subscribed-groups
1255 Yet another variable that meddles here is
1256 @code{gnus-auto-subscribed-groups}. It works exactly like
1257 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
1258 thought it would be nice to have two of these. This variable is more
1259 meant for setting some ground rules, while the other variable is used
1260 more for user fiddling. By default this variable makes all new groups
1261 that come from mail backends (@code{nnml}, @code{nnbabyl},
1262 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed. If you
1263 don't like that, just set this variable to @code{nil}.
1265 New groups that match this regexp are subscribed using
1266 @code{gnus-subscribe-options-newsgroup-method}.
1269 @node Changing Servers
1270 @section Changing Servers
1271 @cindex changing servers
1273 Sometimes it is necessary to move from one @sc{nntp} server to another.
1274 This happens very rarely, but perhaps you change jobs, or one server is
1275 very flaky and you want to use another.
1277 Changing the server is pretty easy, right? You just change
1278 @code{gnus-select-method} to point to the new server?
1282 Article numbers are not (in any way) kept synchronized between different
1283 @sc{nntp} servers, and the only way Gnus keeps track of what articles
1284 you have read is by keeping track of article numbers. So when you
1285 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1288 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1289 file from one server to another. They all have one thing in
1290 common---they take a looong time to run. You don't want to use these
1291 functions more than absolutely necessary.
1293 @kindex M-x gnus-change-server
1294 @findex gnus-change-server
1295 If you have access to both servers, Gnus can request the headers for all
1296 the articles you have read and compare @code{Message-ID}s and map the
1297 article numbers of the read articles and article marks. The @kbd{M-x
1298 gnus-change-server} command will do this for all your native groups. It
1299 will prompt for the method you want to move to.
1301 @kindex M-x gnus-group-move-group-to-server
1302 @findex gnus-group-move-group-to-server
1303 You can also move individual groups with the @kbd{M-x
1304 gnus-group-move-group-to-server} command. This is useful if you want to
1305 move a (foreign) group from one server to another.
1307 @kindex M-x gnus-group-clear-data-on-native-groups
1308 @findex gnus-group-clear-data-on-native-groups
1309 If you don't have access to both the old and new server, all your marks
1310 and read ranges have become worthless. You can use the @kbd{M-x
1311 gnus-group-clear-data-on-native-groups} command to clear out all data
1312 that you have on your native groups. Use with caution.
1314 After changing servers, you @strong{must} move the cache hierarchy away,
1315 since the cached articles will have wrong article numbers, which will
1316 affect which articles Gnus thinks are read.
1320 @section Startup Files
1321 @cindex startup files
1326 Now, you all know about the @file{.newsrc} file. All subscription
1327 information is traditionally stored in this file.
1329 Things got a bit more complicated with @sc{gnus}. In addition to
1330 keeping the @file{.newsrc} file updated, it also used a file called
1331 @file{.newsrc.el} for storing all the information that didn't fit into
1332 the @file{.newsrc} file. (Actually, it also duplicated everything in
1333 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1334 files was the most recently saved, which enabled people to swap between
1335 @sc{gnus} and other newsreaders.
1337 That was kinda silly, so Gnus went one better: In addition to the
1338 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1339 @file{.newsrc.eld}. It will read whichever of these files that are most
1340 recent, but it will never write a @file{.newsrc.el} file. You should
1341 never delete the @file{.newsrc.eld} file---it contains much information
1342 not stored in the @file{.newsrc} file.
1344 @vindex gnus-save-newsrc-file
1345 @vindex gnus-read-newsrc-file
1346 You can turn off writing the @file{.newsrc} file by setting
1347 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1348 the file and save some space, as well as exiting from Gnus faster.
1349 However, this will make it impossible to use other newsreaders than
1350 Gnus. But hey, who would want to, right? Similarly, setting
1351 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
1352 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1353 convenient if you have a tendency to use Netscape once in a while.
1355 @vindex gnus-save-killed-list
1356 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1357 will not save the list of killed groups to the startup file. This will
1358 save both time (when starting and quitting) and space (on disk). It
1359 will also mean that Gnus has no record of what groups are new or old,
1360 so the automatic new groups subscription methods become meaningless.
1361 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1362 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1363 Groups}). This variable can also be a regular expression. If that's
1364 the case, remove all groups that do not match this regexp before
1365 saving. This can be useful in certain obscure situations that involve
1366 several servers where not all servers support @code{ask-server}.
1368 @vindex gnus-startup-file
1369 The @code{gnus-startup-file} variable says where the startup files are.
1370 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1371 file being whatever that one is, with a @samp{.eld} appended.
1373 @vindex gnus-save-newsrc-hook
1374 @vindex gnus-save-quick-newsrc-hook
1375 @vindex gnus-save-standard-newsrc-hook
1376 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1377 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1378 saving the @file{.newsrc.eld} file, and
1379 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1380 @file{.newsrc} file. The latter two are commonly used to turn version
1381 control on or off. Version control is on by default when saving the
1382 startup files. If you want to turn backup creation off, say something like:
1385 (defun turn-off-backup ()
1386 (set (make-local-variable 'backup-inhibited) t))
1388 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1389 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1392 @vindex gnus-init-file
1393 When Gnus starts, it will read the @code{gnus-site-init-file}
1394 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1395 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1396 and can be used to avoid cluttering your @file{~/.emacs} and
1397 @file{site-init} files with Gnus stuff. Gnus will also check for files
1398 with the same names as these, but with @file{.elc} and @file{.el}
1399 suffixes. In other words, if you have set @code{gnus-init-file} to
1400 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1401 and finally @file{~/.gnus} (in this order).
1407 @cindex dribble file
1410 Whenever you do something that changes the Gnus data (reading articles,
1411 catching up, killing/subscribing groups), the change is added to a
1412 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1413 Emacs way. If your Emacs should crash before you have saved the
1414 @file{.newsrc} files, all changes you have made can be recovered from
1417 If Gnus detects this file at startup, it will ask the user whether to
1418 read it. The auto save file is deleted whenever the real startup file is
1421 @vindex gnus-use-dribble-file
1422 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
1423 maintain a dribble buffer. The default is @code{t}.
1425 @vindex gnus-dribble-directory
1426 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1427 this variable is @code{nil}, which it is by default, Gnus will dribble
1428 into the directory where the @file{.newsrc} file is located. (This is
1429 normally the user's home directory.) The dribble file will get the same
1430 file permissions as the @code{.newsrc} file.
1432 @vindex gnus-always-read-dribble-file
1433 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1434 read the dribble file on startup without querying the user.
1437 @node The Active File
1438 @section The Active File
1440 @cindex ignored groups
1442 When Gnus starts, or indeed whenever it tries to determine whether new
1443 articles have arrived, it reads the active file. This is a very large
1444 file that lists all the active groups and articles on the server.
1446 @vindex gnus-ignored-newsgroups
1447 Before examining the active file, Gnus deletes all lines that match the
1448 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1449 any groups with bogus names, but you can use this variable to make Gnus
1450 ignore hierarchies you aren't ever interested in. However, this is not
1451 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1452 Groups} for an overview of other variables that can be used instead.
1455 @c @code{nil} by default, and will slow down active file handling somewhat
1456 @c if you set it to anything else.
1458 @vindex gnus-read-active-file
1460 The active file can be rather Huge, so if you have a slow network, you
1461 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
1462 reading the active file. This variable is @code{some} by default.
1464 Gnus will try to make do by getting information just on the groups that
1465 you actually subscribe to.
1467 Note that if you subscribe to lots and lots of groups, setting this
1468 variable to @code{nil} will probably make Gnus slower, not faster. At
1469 present, having this variable @code{nil} will slow Gnus down
1470 considerably, unless you read news over a 2400 baud modem.
1472 This variable can also have the value @code{some}. Gnus will then
1473 attempt to read active info only on the subscribed groups. On some
1474 servers this is quite fast (on sparkling, brand new INN servers that
1475 support the @code{LIST ACTIVE group} command), on others this isn't fast
1476 at all. In any case, @code{some} should be faster than @code{nil}, and
1477 is certainly faster than @code{t} over slow lines.
1479 Some news servers (old versions of Leafnode and old versions of INN, for
1480 instance) do not support the @code{LIST ACTIVE group}. For these
1481 servers, @code{nil} is probably the most efficient value for this
1484 If this variable is @code{nil}, Gnus will ask for group info in total
1485 lock-step, which isn't very fast. If it is @code{some} and you use an
1486 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
1487 read all the replies in one swoop. This will normally result in better
1488 performance, but if the server does not support the aforementioned
1489 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1491 If you think that starting up Gnus takes too long, try all the three
1492 different values for this variable and see what works best for you.
1494 In any case, if you use @code{some} or @code{nil}, you should definitely
1495 kill all groups that you aren't interested in to speed things up.
1497 Note that this variable also affects active file retrieval from
1498 secondary select methods.
1501 @node Startup Variables
1502 @section Startup Variables
1506 @item gnus-load-hook
1507 @vindex gnus-load-hook
1508 A hook run while Gnus is being loaded. Note that this hook will
1509 normally be run just once in each Emacs session, no matter how many
1510 times you start Gnus.
1512 @item gnus-before-startup-hook
1513 @vindex gnus-before-startup-hook
1514 A hook run after starting up Gnus successfully.
1516 @item gnus-startup-hook
1517 @vindex gnus-startup-hook
1518 A hook run as the very last thing after starting up Gnus
1520 @item gnus-started-hook
1521 @vindex gnus-started-hook
1522 A hook that is run as the very last thing after starting up Gnus
1525 @item gnus-setup-news-hook
1526 @vindex gnus-setup-news-hook
1527 A hook that is run after reading the @file{.newsrc} file(s), but before
1528 generating the group buffer.
1530 @item gnus-check-bogus-newsgroups
1531 @vindex gnus-check-bogus-newsgroups
1532 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1533 startup. A @dfn{bogus group} is a group that you have in your
1534 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1535 bogus groups can take quite a while, so to save time and resources it's
1536 best to leave this option off, and do the checking for bogus groups once
1537 in a while from the group buffer instead (@pxref{Group Maintenance}).
1539 @item gnus-inhibit-startup-message
1540 @vindex gnus-inhibit-startup-message
1541 If non-@code{nil}, the startup message won't be displayed. That way,
1542 your boss might not notice as easily that you are reading news instead
1543 of doing your job. Note that this variable is used before
1544 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1546 @item gnus-no-groups-message
1547 @vindex gnus-no-groups-message
1548 Message displayed by Gnus when no groups are available.
1550 @item gnus-play-startup-jingle
1551 @vindex gnus-play-startup-jingle
1552 If non-@code{nil}, play the Gnus jingle at startup.
1554 @item gnus-startup-jingle
1555 @vindex gnus-startup-jingle
1556 Jingle to be played if the above variable is non-@code{nil}. The
1557 default is @samp{Tuxedomoon.Jingle4.au}.
1563 @chapter Group Buffer
1564 @cindex group buffer
1566 The @dfn{group buffer} lists all (or parts) of the available groups. It
1567 is the first buffer shown when Gnus starts, and will never be killed as
1568 long as Gnus is active.
1572 \gnusfigure{The Group Buffer}{320}{
1573 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1574 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1575 \put(120,38){\vector(1,2){10}}
1576 \put(40,60){\makebox(0,0)[r]{Mode line}}
1577 \put(40,58){\vector(1,0){30}}
1578 \put(200,28){\makebox(0,0)[t]{Native select method}}
1579 \put(200,26){\vector(-1,2){15}}
1585 * Group Buffer Format:: Information listed and how you can change it.
1586 * Group Maneuvering:: Commands for moving in the group buffer.
1587 * Selecting a Group:: Actually reading news.
1588 * Group Data:: Changing the info for a group.
1589 * Subscription Commands:: Unsubscribing, killing, subscribing.
1590 * Group Levels:: Levels? What are those, then?
1591 * Group Score:: A mechanism for finding out what groups you like.
1592 * Marking Groups:: You can mark groups for later processing.
1593 * Foreign Groups:: Creating and editing groups.
1594 * Group Parameters:: Each group may have different parameters set.
1595 * Listing Groups:: Gnus can list various subsets of the groups.
1596 * Sorting Groups:: Re-arrange the group order.
1597 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1598 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1599 * Exiting Gnus:: Stop reading news and get some work done.
1600 * Group Topics:: A folding group mode divided into topics.
1601 * Misc Group Stuff:: Other stuff that you can to do.
1605 @node Group Buffer Format
1606 @section Group Buffer Format
1609 * Group Line Specification:: Deciding how the group buffer is to look.
1610 * Group Modeline Specification:: The group buffer modeline.
1611 * Group Highlighting:: Having nice colors in the group buffer.
1615 @node Group Line Specification
1616 @subsection Group Line Specification
1617 @cindex group buffer format
1619 The default format of the group buffer is nice and dull, but you can
1620 make it as exciting and ugly as you feel like.
1622 Here's a couple of example group lines:
1625 25: news.announce.newusers
1626 * 0: alt.fan.andrea-dworkin
1631 You can see that there are 25 unread articles in
1632 @samp{news.announce.newusers}. There are no unread articles, but some
1633 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1634 asterisk at the beginning of the line?).
1636 @vindex gnus-group-line-format
1637 You can change that format to whatever you want by fiddling with the
1638 @code{gnus-group-line-format} variable. This variable works along the
1639 lines of a @code{format} specification, which is pretty much the same as
1640 a @code{printf} specifications, for those of you who use (feh!) C.
1641 @xref{Formatting Variables}.
1643 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1645 There should always be a colon on the line; the cursor always moves to
1646 the colon after performing an operation. Nothing else is required---not
1647 even the group name. All displayed text is just window dressing, and is
1648 never examined by Gnus. Gnus stores all real information it needs using
1651 (Note that if you make a really strange, wonderful, spreadsheet-like
1652 layout, everybody will believe you are hard at work with the accounting
1653 instead of wasting time reading news.)
1655 Here's a list of all available format characters:
1660 An asterisk if the group only has marked articles.
1663 Whether the group is subscribed.
1666 Level of subscribedness.
1669 Number of unread articles.
1672 Number of dormant articles.
1675 Number of ticked articles.
1678 Number of read articles.
1681 Estimated total number of articles. (This is really @var{max-number}
1682 minus @var{min-number} plus 1.)
1685 Number of unread, unticked, non-dormant articles.
1688 Number of ticked and dormant articles.
1697 Newsgroup description.
1700 @samp{m} if moderated.
1703 @samp{(m)} if moderated.
1712 A string that looks like @samp{<%s:%n>} if a foreign select method is
1716 Indentation based on the level of the topic (@pxref{Group Topics}).
1719 @vindex gnus-group-uncollapsed-levels
1720 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1721 variable says how many levels to leave at the end of the group name.
1722 The default is 1---this will mean that group names like
1723 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1726 @vindex gnus-new-mail-mark
1728 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1732 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1735 A string that says when you last read the group (@pxref{Group
1739 User defined specifier. The next character in the format string should
1740 be a letter. Gnus will call the function
1741 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1742 following @samp{%u}. The function will be passed a single dummy
1743 parameter as argument. The function should return a string, which will
1744 be inserted into the buffer just like information from any other
1749 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1750 if no info is available---for instance, if it is a non-activated foreign
1751 group, or a bogus native group.
1754 @node Group Modeline Specification
1755 @subsection Group Modeline Specification
1756 @cindex group modeline
1758 @vindex gnus-group-mode-line-format
1759 The mode line can be changed by setting
1760 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1761 doesn't understand that many format specifiers:
1765 The native news server.
1767 The native select method.
1771 @node Group Highlighting
1772 @subsection Group Highlighting
1773 @cindex highlighting
1774 @cindex group highlighting
1776 @vindex gnus-group-highlight
1777 Highlighting in the group buffer is controlled by the
1778 @code{gnus-group-highlight} variable. This is an alist with elements
1779 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1780 something non-@code{nil}, the @var{face} will be used on the line.
1782 Here's an example value for this variable that might look nice if the
1786 (cond (window-system
1787 (setq custom-background-mode 'light)
1788 (defface my-group-face-1
1789 '((t (:foreground "Red" :bold t))) "First group face")
1790 (defface my-group-face-2
1791 '((t (:foreground "DarkSeaGreen4" :bold t))) "Second group face")
1792 (defface my-group-face-3
1793 '((t (:foreground "Green4" :bold t))) "Third group face")
1794 (defface my-group-face-4
1795 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1796 (defface my-group-face-5
1797 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1799 (setq gnus-group-highlight
1800 '(((> unread 200) . my-group-face-1)
1801 ((and (< level 3) (zerop unread)) . my-group-face-2)
1802 ((< level 3) . my-group-face-3)
1803 ((zerop unread) . my-group-face-4)
1804 (t . my-group-face-5)))
1807 Also @pxref{Faces and Fonts}.
1809 Variables that are dynamically bound when the forms are evaluated
1816 The number of unread articles in the group.
1820 Whether the group is a mail group.
1822 The level of the group.
1824 The score of the group.
1826 The number of ticked articles in the group.
1828 The total number of articles in the group. Or rather, MAX-NUMBER minus
1829 MIN-NUMBER plus one.
1831 When using the topic minor mode, this variable is bound to the current
1832 topic being inserted.
1835 When the forms are @code{eval}ed, point is at the beginning of the line
1836 of the group in question, so you can use many of the normal Gnus
1837 functions for snarfing info on the group.
1839 @vindex gnus-group-update-hook
1840 @findex gnus-group-highlight-line
1841 @code{gnus-group-update-hook} is called when a group line is changed.
1842 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1843 calls @code{gnus-group-highlight-line} by default.
1846 @node Group Maneuvering
1847 @section Group Maneuvering
1848 @cindex group movement
1850 All movement commands understand the numeric prefix and will behave as
1851 expected, hopefully.
1857 @findex gnus-group-next-unread-group
1858 Go to the next group that has unread articles
1859 (@code{gnus-group-next-unread-group}).
1865 @findex gnus-group-prev-unread-group
1866 Go to the previous group that has unread articles
1867 (@code{gnus-group-prev-unread-group}).
1871 @findex gnus-group-next-group
1872 Go to the next group (@code{gnus-group-next-group}).
1876 @findex gnus-group-prev-group
1877 Go to the previous group (@code{gnus-group-prev-group}).
1881 @findex gnus-group-next-unread-group-same-level
1882 Go to the next unread group on the same (or lower) level
1883 (@code{gnus-group-next-unread-group-same-level}).
1887 @findex gnus-group-prev-unread-group-same-level
1888 Go to the previous unread group on the same (or lower) level
1889 (@code{gnus-group-prev-unread-group-same-level}).
1892 Three commands for jumping to groups:
1898 @findex gnus-group-jump-to-group
1899 Jump to a group (and make it visible if it isn't already)
1900 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
1905 @findex gnus-group-best-unread-group
1906 Jump to the unread group with the lowest level
1907 (@code{gnus-group-best-unread-group}).
1911 @findex gnus-group-first-unread-group
1912 Jump to the first group with unread articles
1913 (@code{gnus-group-first-unread-group}).
1916 @vindex gnus-group-goto-unread
1917 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1918 commands will move to the next group, not the next unread group. Even
1919 the commands that say they move to the next unread group. The default
1923 @node Selecting a Group
1924 @section Selecting a Group
1925 @cindex group selection
1930 @kindex SPACE (Group)
1931 @findex gnus-group-read-group
1932 Select the current group, switch to the summary buffer and display the
1933 first unread article (@code{gnus-group-read-group}). If there are no
1934 unread articles in the group, or if you give a non-numerical prefix to
1935 this command, Gnus will offer to fetch all the old articles in this
1936 group from the server. If you give a numerical prefix @var{N}, @var{N}
1937 determines the number of articles Gnus will fetch. If @var{N} is
1938 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1939 negative, Gnus fetches the @code{abs(@var{N})} oldest articles.
1941 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
1942 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
1943 - 4 2 SPC} fetches the 42 oldest ones.
1945 When you are in the group (in the Summary buffer), you can type
1946 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
1951 @findex gnus-group-select-group
1952 Select the current group and switch to the summary buffer
1953 (@code{gnus-group-select-group}). Takes the same arguments as
1954 @code{gnus-group-read-group}---the only difference is that this command
1955 does not display the first unread article automatically upon group
1959 @kindex M-RET (Group)
1960 @findex gnus-group-quick-select-group
1961 This does the same as the command above, but tries to do it with the
1962 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
1963 scoring/killing will be performed, there will be no highlights and no
1964 expunging. This might be useful if you're in a real hurry and have to
1965 enter some humongous group. If you give a 0 prefix to this command
1966 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
1967 which is useful if you want to toggle threading before generating the
1968 summary buffer (@pxref{Summary Generation Commands}).
1971 @kindex M-SPACE (Group)
1972 @findex gnus-group-visible-select-group
1973 This is yet one more command that does the same as the @kbd{RET}
1974 command, but this one does it without expunging and hiding dormants
1975 (@code{gnus-group-visible-select-group}).
1978 @kindex M-C-RET (Group)
1979 @findex gnus-group-select-group-ephemerally
1980 Finally, this command selects the current group ephemerally without
1981 doing any processing of its contents
1982 (@code{gnus-group-select-group-ephemerally}). Even threading has been
1983 turned off. Everything you do in the group after selecting it in this
1984 manner will have no permanent effects.
1988 @vindex gnus-large-newsgroup
1989 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1990 to be a big group. This is 200 by default. If the group has more
1991 (unread and/or ticked) articles than this, Gnus will query the user
1992 before entering the group. The user can then specify how many articles
1993 should be fetched from the server. If the user specifies a negative
1994 number (@code{-n}), the @code{n} oldest articles will be fetched. If it
1995 is positive, the @code{n} articles that have arrived most recently will
1998 @vindex gnus-select-group-hook
1999 @vindex gnus-auto-select-first
2000 @code{gnus-auto-select-first} control whether any articles are selected
2001 automatically when entering a group with the @kbd{SPACE} command.
2006 Don't select any articles when entering the group. Just display the
2007 full summary buffer.
2010 Select the first unread article when entering the group.
2013 Select the highest scored article in the group when entering the
2018 This variable can also be a function. In that case, that function will
2019 be called to place point on a subject line, and/or select some article.
2020 Useful functions include:
2023 @item gnus-summary-first-unread-subject
2024 Place point on the subject line of the first unread article, but
2025 don't select the article.
2027 @item gnus-summary-first-unread-article
2028 Select the first unread article.
2030 @item gnus-summary-best-unread-article
2031 Select the highest-scored unread article.
2035 If you want to prevent automatic selection in some group (say, in a
2036 binary group with Huge articles) you can set this variable to @code{nil}
2037 in @code{gnus-select-group-hook}, which is called when a group is
2041 @node Subscription Commands
2042 @section Subscription Commands
2043 @cindex subscription
2051 @findex gnus-group-unsubscribe-current-group
2052 @c @icon{gnus-group-unsubscribe}
2053 Toggle subscription to the current group
2054 (@code{gnus-group-unsubscribe-current-group}).
2060 @findex gnus-group-unsubscribe-group
2061 Prompt for a group to subscribe, and then subscribe it. If it was
2062 subscribed already, unsubscribe it instead
2063 (@code{gnus-group-unsubscribe-group}).
2069 @findex gnus-group-kill-group
2070 @c @icon{gnus-group-kill-group}
2071 Kill the current group (@code{gnus-group-kill-group}).
2077 @findex gnus-group-yank-group
2078 Yank the last killed group (@code{gnus-group-yank-group}).
2081 @kindex C-x C-t (Group)
2082 @findex gnus-group-transpose-groups
2083 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2084 really a subscription command, but you can use it instead of a
2085 kill-and-yank sequence sometimes.
2091 @findex gnus-group-kill-region
2092 Kill all groups in the region (@code{gnus-group-kill-region}).
2096 @findex gnus-group-kill-all-zombies
2097 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2100 @kindex S C-k (Group)
2101 @findex gnus-group-kill-level
2102 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2103 These groups can't be yanked back after killing, so this command should
2104 be used with some caution. The only time where this command comes in
2105 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2106 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2107 kill off all unsubscribed groups that do not have message numbers in the
2108 @file{.newsrc} file.
2112 Also @pxref{Group Levels}.
2122 @findex gnus-group-catchup-current
2123 @vindex gnus-group-catchup-group-hook
2124 @c @icon{gnus-group-catchup-current}
2125 Mark all unticked articles in this group as read
2126 (@code{gnus-group-catchup-current}).
2127 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2132 @findex gnus-group-catchup-current-all
2133 Mark all articles in this group, even the ticked ones, as read
2134 (@code{gnus-group-catchup-current-all}).
2138 @findex gnus-group-clear-data
2139 Clear the data from the current group---nix out marks and the list of
2140 read articles (@code{gnus-group-clear-data}).
2142 @item M-x gnus-group-clear-data-on-native-groups
2143 @kindex M-x gnus-group-clear-data-on-native-groups
2144 @findex gnus-group-clear-data-on-native-groups
2145 If you have switched from one @sc{nntp} server to another, all your marks
2146 and read ranges have become worthless. You can use this command to
2147 clear out all data that you have on your native groups. Use with
2154 @section Group Levels
2158 All groups have a level of @dfn{subscribedness}. For instance, if a
2159 group is on level 2, it is more subscribed than a group on level 5. You
2160 can ask Gnus to just list groups on a given level or lower
2161 (@pxref{Listing Groups}), or to just check for new articles in groups on
2162 a given level or lower (@pxref{Scanning New Messages}).
2164 Remember: The higher the level of the group, the less important it is.
2170 @findex gnus-group-set-current-level
2171 Set the level of the current group. If a numeric prefix is given, the
2172 next @var{n} groups will have their levels set. The user will be
2173 prompted for a level.
2176 @vindex gnus-level-killed
2177 @vindex gnus-level-zombie
2178 @vindex gnus-level-unsubscribed
2179 @vindex gnus-level-subscribed
2180 Gnus considers groups from levels 1 to
2181 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2182 @code{gnus-level-subscribed} (exclusive) and
2183 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2184 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2185 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2186 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2187 same, but zombie and killed groups have no information on what articles
2188 you have read, etc, stored. This distinction between dead and living
2189 groups isn't done because it is nice or clever, it is done purely for
2190 reasons of efficiency.
2192 It is recommended that you keep all your mail groups (if any) on quite
2193 low levels (e.g. 1 or 2).
2195 Maybe the following description of the default behavior of Gnus helps to
2196 understand what these levels are all about. By default, Gnus shows you
2197 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2198 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2199 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2200 groups are hidden, in a way.
2202 Zombie and killed groups are similar to unsubscribed groups in that they
2203 are hidden by default. But they are different from subscribed and
2204 unsubscribed groups in that Gnus doesn't ask the news server for
2205 information (number of messages, number of unread messages) on zombie
2206 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2207 aren't interested in. If most groups are killed, Gnus is faster.
2209 Why does Gnus distinguish between zombie and killed groups? Well, when
2210 a new group arrives on the server, Gnus by default makes it a zombie
2211 group. This means that you are normally not bothered with new groups,
2212 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2213 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2214 list of killed groups.)
2216 If you want to play with the level variables, you should show some care.
2217 Set them once, and don't touch them ever again. Better yet, don't touch
2218 them at all unless you know exactly what you're doing.
2220 @vindex gnus-level-default-unsubscribed
2221 @vindex gnus-level-default-subscribed
2222 Two closely related variables are @code{gnus-level-default-subscribed}
2223 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2224 which are the levels that new groups will be put on if they are
2225 (un)subscribed. These two variables should, of course, be inside the
2226 relevant valid ranges.
2228 @vindex gnus-keep-same-level
2229 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2230 will only move to groups of the same level (or lower). In
2231 particular, going from the last article in one group to the next group
2232 will go to the next group of the same level (or lower). This might be
2233 handy if you want to read the most important groups before you read the
2236 If this variable is @code{best}, Gnus will make the next newsgroup the
2237 one with the best level.
2239 @vindex gnus-group-default-list-level
2240 All groups with a level less than or equal to
2241 @code{gnus-group-default-list-level} will be listed in the group buffer
2244 @vindex gnus-group-list-inactive-groups
2245 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2246 groups will be listed along with the unread groups. This variable is
2247 @code{t} by default. If it is @code{nil}, inactive groups won't be
2250 @vindex gnus-group-use-permanent-levels
2251 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2252 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2253 use this level as the ``work'' level.
2255 @vindex gnus-activate-level
2256 Gnus will normally just activate (i. e., query the server about) groups
2257 on level @code{gnus-activate-level} or less. If you don't want to
2258 activate unsubscribed groups, for instance, you might set this variable
2259 to 5. The default is 6.
2263 @section Group Score
2268 You would normally keep important groups on high levels, but that scheme
2269 is somewhat restrictive. Don't you wish you could have Gnus sort the
2270 group buffer according to how often you read groups, perhaps? Within
2273 This is what @dfn{group score} is for. You can have Gnus assign a score
2274 to each group through the mechanism described below. You can then sort
2275 the group buffer based on this score. Alternatively, you can sort on
2276 score and then level. (Taken together, the level and the score is
2277 called the @dfn{rank} of the group. A group that is on level 4 and has
2278 a score of 1 has a higher rank than a group on level 5 that has a score
2279 of 300. (The level is the most significant part and the score is the
2280 least significant part.))
2282 @findex gnus-summary-bubble-group
2283 If you want groups you read often to get higher scores than groups you
2284 read seldom you can add the @code{gnus-summary-bubble-group} function to
2285 the @code{gnus-summary-exit-hook} hook. This will result (after
2286 sorting) in a bubbling sort of action. If you want to see that in
2287 action after each summary exit, you can add
2288 @code{gnus-group-sort-groups-by-rank} or
2289 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2290 slow things down somewhat.
2293 @node Marking Groups
2294 @section Marking Groups
2295 @cindex marking groups
2297 If you want to perform some command on several groups, and they appear
2298 subsequently in the group buffer, you would normally just give a
2299 numerical prefix to the command. Most group commands will then do your
2300 bidding on those groups.
2302 However, if the groups are not in sequential order, you can still
2303 perform a command on several groups. You simply mark the groups first
2304 with the process mark and then execute the command.
2312 @findex gnus-group-mark-group
2313 Set the mark on the current group (@code{gnus-group-mark-group}).
2319 @findex gnus-group-unmark-group
2320 Remove the mark from the current group
2321 (@code{gnus-group-unmark-group}).
2325 @findex gnus-group-unmark-all-groups
2326 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2330 @findex gnus-group-mark-region
2331 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2335 @findex gnus-group-mark-buffer
2336 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2340 @findex gnus-group-mark-regexp
2341 Mark all groups that match some regular expression
2342 (@code{gnus-group-mark-regexp}).
2345 Also @pxref{Process/Prefix}.
2347 @findex gnus-group-universal-argument
2348 If you want to execute some command on all groups that have been marked
2349 with the process mark, you can use the @kbd{M-&}
2350 (@code{gnus-group-universal-argument}) command. It will prompt you for
2351 the command to be executed.
2354 @node Foreign Groups
2355 @section Foreign Groups
2356 @cindex foreign groups
2358 Below are some group mode commands for making and editing general foreign
2359 groups, as well as commands to ease the creation of a few
2360 special-purpose groups. All these commands insert the newly created
2361 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2368 @findex gnus-group-make-group
2369 @cindex making groups
2370 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2371 for a name, a method and possibly an @dfn{address}. For an easier way
2372 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
2376 @findex gnus-group-rename-group
2377 @cindex renaming groups
2378 Rename the current group to something else
2379 (@code{gnus-group-rename-group}). This is valid only on some
2380 groups---mail groups mostly. This command might very well be quite slow
2386 @findex gnus-group-customize
2387 Customize the group parameters (@code{gnus-group-customize}).
2391 @findex gnus-group-edit-group-method
2392 @cindex renaming groups
2393 Enter a buffer where you can edit the select method of the current
2394 group (@code{gnus-group-edit-group-method}).
2398 @findex gnus-group-edit-group-parameters
2399 Enter a buffer where you can edit the group parameters
2400 (@code{gnus-group-edit-group-parameters}).
2404 @findex gnus-group-edit-group
2405 Enter a buffer where you can edit the group info
2406 (@code{gnus-group-edit-group}).
2410 @findex gnus-group-make-directory-group
2412 Make a directory group (@pxref{Directory Groups}). You will be prompted
2413 for a directory name (@code{gnus-group-make-directory-group}).
2418 @findex gnus-group-make-help-group
2419 Make the Gnus help group (@code{gnus-group-make-help-group}).
2423 @cindex (ding) archive
2424 @cindex archive group
2425 @findex gnus-group-make-archive-group
2426 @vindex gnus-group-archive-directory
2427 @vindex gnus-group-recent-archive-directory
2428 Make a Gnus archive group (@code{gnus-group-make-archive-group}). By
2429 default a group pointing to the most recent articles will be created
2430 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2431 group will be created from @code{gnus-group-archive-directory}.
2435 @findex gnus-group-make-kiboze-group
2437 Make a kiboze group. You will be prompted for a name, for a regexp to
2438 match groups to be ``included'' in the kiboze group, and a series of
2439 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2440 @xref{Kibozed Groups}.
2444 @findex gnus-group-enter-directory
2446 Read an arbitrary directory as if it were a newsgroup with the
2447 @code{nneething} backend (@code{gnus-group-enter-directory}).
2448 @xref{Anything Groups}.
2452 @findex gnus-group-make-doc-group
2453 @cindex ClariNet Briefs
2455 Make a group based on some file or other
2456 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2457 command, you will be prompted for a file name and a file type.
2458 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
2459 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
2460 @code{rfc934}, @code{rfc822-forward}, @code{nsmail} and @code{forward}.
2461 If you run this command without a prefix, Gnus will guess at the file
2462 type. @xref{Document Groups}.
2466 @vindex gnus-useful-groups
2467 @findex gnus-group-make-useful-group
2468 Create one of the groups mentioned in @code{gnus-useful-groups}
2469 (@code{gnus-group-make-useful-group}).
2473 @findex gnus-group-make-web-group
2478 Make an ephemeral group based on a web search
2479 (@code{gnus-group-make-web-group}). If you give a prefix to this
2480 command, make a solid group instead. You will be prompted for the
2481 search engine type and the search string. Valid search engine types
2482 include @code{dejanews}, @code{altavista} and @code{reference}.
2483 @xref{Web Searches}.
2485 If you use the @code{dejanews} search engine, you can limit the search
2486 to a particular group by using a match string like
2487 @samp{~g alt.sysadmin.recovery shaving}.
2490 @kindex G DEL (Group)
2491 @findex gnus-group-delete-group
2492 This function will delete the current group
2493 (@code{gnus-group-delete-group}). If given a prefix, this function will
2494 actually delete all the articles in the group, and forcibly remove the
2495 group itself from the face of the Earth. Use a prefix only if you are
2496 absolutely sure of what you are doing. This command can't be used on
2497 read-only groups (like @code{nntp} group), though.
2501 @findex gnus-group-make-empty-virtual
2502 Make a new, fresh, empty @code{nnvirtual} group
2503 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2507 @findex gnus-group-add-to-virtual
2508 Add the current group to an @code{nnvirtual} group
2509 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2512 @xref{Select Methods}, for more information on the various select
2515 @vindex gnus-activate-foreign-newsgroups
2516 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2517 Gnus will check all foreign groups with this level or lower at startup.
2518 This might take quite a while, especially if you subscribe to lots of
2519 groups from different @sc{nntp} servers. Also @pxref{Group Levels};
2520 @code{gnus-activate-level} also affects activation of foreign
2524 @node Group Parameters
2525 @section Group Parameters
2526 @cindex group parameters
2528 The group parameters store information local to a particular group.
2529 Here's an example group parameter list:
2532 ((to-address . "ding@@gnus.org")
2536 We see that each element consists of a "dotted pair"---the thing before
2537 the dot is the key, while the thing after the dot is the value. All the
2538 parameters have this form @emph{except} local variable specs, which are
2539 not dotted pairs, but proper lists.
2541 Some parameters have correspondant customizable variables, each of which
2542 is an alist of regexps and values.
2544 The following group parameters can be used:
2549 Address used by when doing followups and new posts.
2552 (to-address . "some@@where.com")
2555 This is primarily useful in mail groups that represent closed mailing
2556 lists---mailing lists where it's expected that everybody that writes to
2557 the mailing list is subscribed to it. Since using this parameter
2558 ensures that the mail only goes to the mailing list itself, it means
2559 that members won't receive two copies of your followups.
2561 Using @code{to-address} will actually work whether the group is foreign
2562 or not. Let's say there's a group on the server that is called
2563 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2564 the articles from a mail-to-news gateway. Posting directly to this
2565 group is therefore impossible---you have to send mail to the mailing
2566 list address instead.
2568 See also @code{gnus-parameter-to-address-alist}.
2572 Address used when doing @kbd{a} in that group.
2575 (to-list . "some@@where.com")
2578 It is totally ignored
2579 when doing a followup---except that if it is present in a news group,
2580 you'll get mail group semantics when doing @kbd{f}.
2582 If you do an @kbd{a} command in a mail group and you have neither a
2583 @code{to-list} group parameter nor a @code{to-address} group parameter,
2584 then a @code{to-list} group parameter will be added automatically upon
2585 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2586 @vindex gnus-add-to-list
2588 If you do an @kbd{a} command in a mail group and you don't have a
2589 @code{to-list} group parameter, one will be added automatically upon
2590 sending the message.
2592 See also @code{gnus-parameter-to-list-alist}.
2596 If the group parameter list has the element @code{(visible . t)},
2597 that group will always be visible in the Group buffer, regardless
2598 of whether it has any unread articles.
2600 @item broken-reply-to
2601 @cindex broken-reply-to
2602 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2603 headers in this group are to be ignored. This can be useful if you're
2604 reading a mailing list group where the listserv has inserted
2605 @code{Reply-To} headers that point back to the listserv itself. This is
2606 broken behavior. So there!
2610 Elements like @code{(to-group . "some.group.name")} means that all
2611 posts in that group will be sent to @code{some.group.name}.
2615 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2616 will treat all responses as if they were responses to news articles.
2617 This can be useful if you have a mail group that's really a mirror of a
2622 If @code{(gcc-self . t)} is present in the group parameter list, newly
2623 composed messages will be @code{Gcc}'d to the current group. If
2624 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2625 generated, if @code{(gcc-self . "string")} is present, this string will
2626 be inserted literally as a @code{gcc} header. This parameter takes
2627 precedence over any default @code{Gcc} rules as described later
2628 (@pxref{Archived Messages}).
2632 If the group parameter has an element that looks like @code{(auto-expire
2633 . t)}, all articles read will be marked as expirable. For an
2634 alternative approach, @pxref{Expiring Mail}.
2636 See also @code{gnus-auto-expirable-newsgroups}.
2639 @cindex total-expire
2640 If the group parameter has an element that looks like
2641 @code{(total-expire . t)}, all read articles will be put through the
2642 expiry process, even if they are not marked as expirable. Use with
2643 caution. Unread, ticked and dormant articles are not eligible for
2646 See also @code{gnus-total-expirable-newsgroups}.
2650 @vindex nnmail-expiry-wait-function
2651 If the group parameter has an element that looks like @code{(expiry-wait
2652 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2653 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2654 The value can either be a number of days (not necessarily an integer) or
2655 the symbols @code{never} or @code{immediate}.
2658 @cindex score file group parameter
2659 Elements that look like @code{(score-file . "file")} will make
2660 @file{file} into the current score file for the group in question. All
2661 interactive score entries will be put into this file.
2664 @cindex adapt file group parameter
2665 Elements that look like @code{(adapt-file . "file")} will make
2666 @file{file} into the current adaptive file for the group in question.
2667 All adaptive score entries will be put into this file.
2670 When unsubscribing from a mailing list you should never send the
2671 unsubscription notice to the mailing list itself. Instead, you'd send
2672 messages to the administrative address. This parameter allows you to
2673 put the admin address somewhere convenient.
2676 Elements that look like @code{(display . MODE)} say which articles to
2677 display on entering the group. Valid values are:
2681 Display all articles, both read and unread.
2684 Display the default visible articles, which normally includes unread and
2689 Elements that look like @code{(comment . "This is a comment")}
2690 are arbitrary comments on the group. They are currently ignored by
2691 Gnus, but provide a place for you to store information on particular
2695 Elements that look like @code{(charset . iso-8859-1)} will make
2696 @code{iso-8859-1} the default charset; that is, the charset that will be
2697 used for all articles that do not specify a charset.
2699 See also @code{gnus-group-charset-alist}.
2701 @item ignored-charsets
2702 Elements that look like @code{(ignored-charsets x-known iso-8859-1)}
2703 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2704 default charset will be used for decoding articles.
2706 See also @code{gnus-group-ignored-charsets-alist}.
2709 You can store additional posting style information for this group only
2710 here (@pxref{Posting Styles}). The format is that of an entry in the
2711 @code{gnus-posting-styles} alist, except that there's no regexp matching
2712 the group name (of course). Style elements in this group parameter will
2713 take precedence over the ones found in @code{gnus-posting-styles}.
2715 For instance, if you want a funky name and signature in this group only,
2716 instead of hacking @code{gnus-posting-styles}, you could put something
2717 like this in the group parameters:
2722 (signature "Funky Signature"))
2726 An item like @code{(banner . "regex")} causes any part of an article
2727 that matches the regular expression "regex" to be stripped. Instead of
2728 "regex", you can also use the symbol @code{signature} which strips the
2729 last signature or any of the elements of the alist
2730 @code{gnus-article-banner-alist}.
2732 @item (@var{variable} @var{form})
2733 You can use the group parameters to set variables local to the group you
2734 are entering. If you want to turn threading off in @samp{news.answers},
2735 you could put @code{(gnus-show-threads nil)} in the group parameters of
2736 that group. @code{gnus-show-threads} will be made into a local variable
2737 in the summary buffer you enter, and the form @code{nil} will be
2738 @code{eval}ed there.
2740 This can also be used as a group-specific hook function, if you'd like.
2741 If you want to hear a beep when you enter a group, you could put
2742 something like @code{(dummy-variable (ding))} in the parameters of that
2743 group. @code{dummy-variable} will be set to the result of the
2744 @code{(ding)} form, but who cares?
2748 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
2749 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
2750 presents you with a Customize-like interface. The latter helps avoid
2751 silly Lisp errors.) You might also be interested in reading about topic
2752 parameters (@pxref{Topic Parameters}).
2755 @node Listing Groups
2756 @section Listing Groups
2757 @cindex group listing
2759 These commands all list various slices of the groups available.
2767 @findex gnus-group-list-groups
2768 List all groups that have unread articles
2769 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
2770 command will list only groups of level ARG and lower. By default, it
2771 only lists groups of level five (i. e.,
2772 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2779 @findex gnus-group-list-all-groups
2780 List all groups, whether they have unread articles or not
2781 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
2782 this command will list only groups of level ARG and lower. By default,
2783 it lists groups of level seven or lower (i.e., just subscribed and
2784 unsubscribed groups).
2788 @findex gnus-group-list-level
2789 List all unread groups on a specific level
2790 (@code{gnus-group-list-level}). If given a prefix, also list the groups
2791 with no unread articles.
2795 @findex gnus-group-list-killed
2796 List all killed groups (@code{gnus-group-list-killed}). If given a
2797 prefix argument, really list all groups that are available, but aren't
2798 currently (un)subscribed. This could entail reading the active file
2803 @findex gnus-group-list-zombies
2804 List all zombie groups (@code{gnus-group-list-zombies}).
2808 @findex gnus-group-list-matching
2809 List all unread, subscribed groups with names that match a regexp
2810 (@code{gnus-group-list-matching}).
2814 @findex gnus-group-list-all-matching
2815 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2819 @findex gnus-group-list-active
2820 List absolutely all groups in the active file(s) of the
2821 server(s) you are connected to (@code{gnus-group-list-active}). This
2822 might very well take quite a while. It might actually be a better idea
2823 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2824 thing to match on. Also note that this command may list groups that
2825 don't exist (yet)---these will be listed as if they were killed groups.
2826 Take the output with some grains of salt.
2830 @findex gnus-group-apropos
2831 List all groups that have names that match a regexp
2832 (@code{gnus-group-apropos}).
2836 @findex gnus-group-description-apropos
2837 List all groups that have names or descriptions that match a regexp
2838 (@code{gnus-group-description-apropos}).
2842 @findex gnus-group-list-cached
2843 List all groups with cached articles (@code{gnus-group-list-cached}).
2847 @findex gnus-group-list-dormant
2848 List all groups with dormant articles (@code{gnus-group-list-dormant}).
2852 @findex gnus-group-list-limit
2853 List groups limited within the current selection
2854 (@code{gnus-group-list-limit}).
2858 @findex gnus-group-list-flush
2859 Flush groups from the current selection (@code{gnus-group-list-flush}).
2863 @findex gnus-group-list-plus
2864 List groups plus the current selection (@code{gnus-group-list-plus}).
2868 @vindex gnus-permanently-visible-groups
2869 @cindex visible group parameter
2870 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2871 always be shown, whether they have unread articles or not. You can also
2872 add the @code{visible} element to the group parameters in question to
2873 get the same effect.
2875 @vindex gnus-list-groups-with-ticked-articles
2876 Groups that have just ticked articles in it are normally listed in the
2877 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
2878 @code{nil}, these groups will be treated just like totally empty
2879 groups. It is @code{t} by default.
2882 @node Sorting Groups
2883 @section Sorting Groups
2884 @cindex sorting groups
2886 @kindex C-c C-s (Group)
2887 @findex gnus-group-sort-groups
2888 @vindex gnus-group-sort-function
2889 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2890 group buffer according to the function(s) given by the
2891 @code{gnus-group-sort-function} variable. Available sorting functions
2896 @item gnus-group-sort-by-alphabet
2897 @findex gnus-group-sort-by-alphabet
2898 Sort the group names alphabetically. This is the default.
2900 @item gnus-group-sort-by-real-name
2901 @findex gnus-group-sort-by-real-name
2902 Sort the group alphabetically on the real (unprefixed) group names.
2904 @item gnus-group-sort-by-level
2905 @findex gnus-group-sort-by-level
2906 Sort by group level.
2908 @item gnus-group-sort-by-score
2909 @findex gnus-group-sort-by-score
2910 Sort by group score. @xref{Group Score}.
2912 @item gnus-group-sort-by-rank
2913 @findex gnus-group-sort-by-rank
2914 Sort by group score and then the group level. The level and the score
2915 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
2917 @item gnus-group-sort-by-unread
2918 @findex gnus-group-sort-by-unread
2919 Sort by number of unread articles.
2921 @item gnus-group-sort-by-method
2922 @findex gnus-group-sort-by-method
2923 Sort alphabetically on the select method.
2925 @item gnus-group-sort-by-server
2926 @findex gnus-group-sort-by-server
2927 Sort alphabetically on the Gnus server name.
2932 @code{gnus-group-sort-function} can also be a list of sorting
2933 functions. In that case, the most significant sort key function must be
2937 There are also a number of commands for sorting directly according to
2938 some sorting criteria:
2942 @kindex G S a (Group)
2943 @findex gnus-group-sort-groups-by-alphabet
2944 Sort the group buffer alphabetically by group name
2945 (@code{gnus-group-sort-groups-by-alphabet}).
2948 @kindex G S u (Group)
2949 @findex gnus-group-sort-groups-by-unread
2950 Sort the group buffer by the number of unread articles
2951 (@code{gnus-group-sort-groups-by-unread}).
2954 @kindex G S l (Group)
2955 @findex gnus-group-sort-groups-by-level
2956 Sort the group buffer by group level
2957 (@code{gnus-group-sort-groups-by-level}).
2960 @kindex G S v (Group)
2961 @findex gnus-group-sort-groups-by-score
2962 Sort the group buffer by group score
2963 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
2966 @kindex G S r (Group)
2967 @findex gnus-group-sort-groups-by-rank
2968 Sort the group buffer by group rank
2969 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
2972 @kindex G S m (Group)
2973 @findex gnus-group-sort-groups-by-method
2974 Sort the group buffer alphabetically by backend name
2975 (@code{gnus-group-sort-groups-by-method}).
2979 All the commands below obey the process/prefix convention
2980 (@pxref{Process/Prefix}).
2982 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
2983 commands will sort in reverse order.
2985 You can also sort a subset of the groups:
2989 @kindex G P a (Group)
2990 @findex gnus-group-sort-selected-groups-by-alphabet
2991 Sort the groups alphabetically by group name
2992 (@code{gnus-group-sort-selected-groups-by-alphabet}).
2995 @kindex G P u (Group)
2996 @findex gnus-group-sort-selected-groups-by-unread
2997 Sort the groups by the number of unread articles
2998 (@code{gnus-group-sort-selected-groups-by-unread}).
3001 @kindex G P l (Group)
3002 @findex gnus-group-sort-selected-groups-by-level
3003 Sort the groups by group level
3004 (@code{gnus-group-sort-selected-groups-by-level}).
3007 @kindex G P v (Group)
3008 @findex gnus-group-sort-selected-groups-by-score
3009 Sort the groups by group score
3010 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3013 @kindex G P r (Group)
3014 @findex gnus-group-sort-selected-groups-by-rank
3015 Sort the groups by group rank
3016 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3019 @kindex G P m (Group)
3020 @findex gnus-group-sort-selected-groups-by-method
3021 Sort the groups alphabetically by backend name
3022 (@code{gnus-group-sort-selected-groups-by-method}).
3026 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3030 @node Group Maintenance
3031 @section Group Maintenance
3032 @cindex bogus groups
3037 @findex gnus-group-check-bogus-groups
3038 Find bogus groups and delete them
3039 (@code{gnus-group-check-bogus-groups}).
3043 @findex gnus-group-find-new-groups
3044 Find new groups and process them (@code{gnus-group-find-new-groups}).
3045 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3046 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3047 to query the server for new groups, and subscribe the new groups as
3051 @kindex C-c C-x (Group)
3052 @findex gnus-group-expire-articles
3053 Run all expirable articles in the current group through the expiry
3054 process (if any) (@code{gnus-group-expire-articles}).
3057 @kindex C-c M-C-x (Group)
3058 @findex gnus-group-expire-all-groups
3059 Run all articles in all groups through the expiry process
3060 (@code{gnus-group-expire-all-groups}).
3065 @node Browse Foreign Server
3066 @section Browse Foreign Server
3067 @cindex foreign servers
3068 @cindex browsing servers
3073 @findex gnus-group-browse-foreign-server
3074 You will be queried for a select method and a server name. Gnus will
3075 then attempt to contact this server and let you browse the groups there
3076 (@code{gnus-group-browse-foreign-server}).
3079 @findex gnus-browse-mode
3080 A new buffer with a list of available groups will appear. This buffer
3081 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3082 a lot) like a normal group buffer.
3084 Here's a list of keystrokes available in the browse mode:
3089 @findex gnus-group-next-group
3090 Go to the next group (@code{gnus-group-next-group}).
3094 @findex gnus-group-prev-group
3095 Go to the previous group (@code{gnus-group-prev-group}).
3098 @kindex SPACE (Browse)
3099 @findex gnus-browse-read-group
3100 Enter the current group and display the first article
3101 (@code{gnus-browse-read-group}).
3104 @kindex RET (Browse)
3105 @findex gnus-browse-select-group
3106 Enter the current group (@code{gnus-browse-select-group}).
3110 @findex gnus-browse-unsubscribe-current-group
3111 Unsubscribe to the current group, or, as will be the case here,
3112 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3118 @findex gnus-browse-exit
3119 Exit browse mode (@code{gnus-browse-exit}).
3123 @findex gnus-browse-describe-briefly
3124 Describe browse mode briefly (well, there's not much to describe, is
3125 there) (@code{gnus-browse-describe-briefly}).
3130 @section Exiting Gnus
3131 @cindex exiting Gnus
3133 Yes, Gnus is ex(c)iting.
3138 @findex gnus-group-suspend
3139 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
3140 but it kills all buffers except the Group buffer. I'm not sure why this
3141 is a gain, but then who am I to judge?
3145 @findex gnus-group-exit
3146 @c @icon{gnus-group-exit}
3147 Quit Gnus (@code{gnus-group-exit}).
3151 @findex gnus-group-quit
3152 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3153 The dribble file will be saved, though (@pxref{Auto Save}).
3156 @vindex gnus-exit-gnus-hook
3157 @vindex gnus-suspend-gnus-hook
3158 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
3159 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
3160 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3165 If you wish to completely unload Gnus and all its adherents, you can use
3166 the @code{gnus-unload} command. This command is also very handy when
3167 trying to customize meta-variables.
3172 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3173 numbly heavy and herself fall into a hazy trance as the boy sitting
3174 behind her drew repeated lines with his pencil across the back of her
3180 @section Group Topics
3183 If you read lots and lots of groups, it might be convenient to group
3184 them hierarchically according to topics. You put your Emacs groups over
3185 here, your sex groups over there, and the rest (what, two groups or so?)
3186 you put in some misc section that you never bother with anyway. You can
3187 even group the Emacs sex groups as a sub-topic to either the Emacs
3188 groups or the sex groups---or both! Go wild!
3192 \gnusfigure{Group Topics}{400}{
3193 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
3204 2: alt.religion.emacs
3207 0: comp.talk.emacs.recovery
3209 8: comp.binaries.fractals
3210 13: comp.sources.unix
3213 @findex gnus-topic-mode
3215 To get this @emph{fab} functionality you simply turn on (ooh!) the
3216 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3217 is a toggling command.)
3219 Go ahead, just try it. I'll still be here when you get back. La de
3220 dum... Nice tune, that... la la la... What, you're back? Yes, and now
3221 press @kbd{l}. There. All your groups are now listed under
3222 @samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and
3225 If you want this permanently enabled, you should add that minor mode to
3226 the hook for the group mode:
3229 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3233 * Topic Variables:: How to customize the topics the Lisp Way.
3234 * Topic Commands:: Interactive E-Z commands.
3235 * Topic Sorting:: Sorting each topic individually.
3236 * Topic Topology:: A map of the world.
3237 * Topic Parameters:: Parameters that apply to all groups in a topic.
3241 @node Topic Variables
3242 @subsection Topic Variables
3243 @cindex topic variables
3245 Now, if you select a topic, it will fold/unfold that topic, which is
3246 really neat, I think.
3248 @vindex gnus-topic-line-format
3249 The topic lines themselves are created according to the
3250 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3263 Number of groups in the topic.
3265 Number of unread articles in the topic.
3267 Number of unread articles in the topic and all its subtopics.
3270 @vindex gnus-topic-indent-level
3271 Each sub-topic (and the groups in the sub-topics) will be indented with
3272 @code{gnus-topic-indent-level} times the topic level number of spaces.
3275 @vindex gnus-topic-mode-hook
3276 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3278 @vindex gnus-topic-display-empty-topics
3279 The @code{gnus-topic-display-empty-topics} says whether to display even
3280 topics that have no unread articles in them. The default is @code{t}.
3283 @node Topic Commands
3284 @subsection Topic Commands
3285 @cindex topic commands
3287 When the topic minor mode is turned on, a new @kbd{T} submap will be
3288 available. In addition, a few of the standard keys change their
3289 definitions slightly.
3295 @findex gnus-topic-create-topic
3296 Prompt for a new topic name and create it
3297 (@code{gnus-topic-create-topic}).
3301 @findex gnus-topic-move-group
3302 Move the current group to some other topic
3303 (@code{gnus-topic-move-group}). This command uses the process/prefix
3304 convention (@pxref{Process/Prefix}).
3308 @findex gnus-topic-jump-to-topic
3309 Go to a topic (@code{gnus-topic-jump-to-topic}).
3313 @findex gnus-topic-copy-group
3314 Copy the current group to some other topic
3315 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3316 convention (@pxref{Process/Prefix}).
3320 @findex gnus-topic-hide-topic
3321 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3322 a prefix, hide the topic permanently.
3326 @findex gnus-topic-show-topic
3327 Show the current topic (@code{gnus-topic-show-topic}). If given
3328 a prefix, show the topic permanently.
3332 @findex gnus-topic-remove-group
3333 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3334 This command is mainly useful if you have the same group in several
3335 topics and wish to remove it from one of the topics. You may also
3336 remove a group from all topics, but in that case, Gnus will add it to
3337 the root topic the next time you start Gnus. In fact, all new groups
3338 (which, naturally, don't belong to any topic) will show up in the root
3341 This command uses the process/prefix convention
3342 (@pxref{Process/Prefix}).
3346 @findex gnus-topic-move-matching
3347 Move all groups that match some regular expression to a topic
3348 (@code{gnus-topic-move-matching}).
3352 @findex gnus-topic-copy-matching
3353 Copy all groups that match some regular expression to a topic
3354 (@code{gnus-topic-copy-matching}).
3358 @findex gnus-topic-toggle-display-empty-topics
3359 Toggle hiding empty topics
3360 (@code{gnus-topic-toggle-display-empty-topics}).
3364 @findex gnus-topic-mark-topic
3365 Mark all groups in the current topic with the process mark
3366 (@code{gnus-topic-mark-topic}).
3369 @kindex T M-# (Topic)
3370 @findex gnus-topic-unmark-topic
3371 Remove the process mark from all groups in the current topic
3372 (@code{gnus-topic-unmark-topic}).
3376 @kindex T TAB (Topic)
3378 @findex gnus-topic-indent
3379 ``Indent'' the current topic so that it becomes a sub-topic of the
3380 previous topic (@code{gnus-topic-indent}). If given a prefix,
3381 ``un-indent'' the topic instead.
3384 @kindex M-TAB (Topic)
3385 @findex gnus-topic-unindent
3386 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3387 parent of its current parent (@code{gnus-topic-unindent}).
3391 @findex gnus-topic-select-group
3393 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3394 When you perform this command on a group, you'll enter the group, as
3395 usual. When done on a topic line, the topic will be folded (if it was
3396 visible) or unfolded (if it was folded already). So it's basically a
3397 toggling command on topics. In addition, if you give a numerical
3398 prefix, group on that level (and lower) will be displayed.
3401 @kindex C-c C-x (Topic)
3402 @findex gnus-topic-expire-articles
3403 Run all expirable articles in the current group or topic through the expiry
3404 process (if any) (@code{gnus-topic-expire-articles}).
3408 @findex gnus-topic-kill-group
3409 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3410 topic will be removed along with the topic.
3414 @findex gnus-topic-yank-group
3415 Yank the previously killed group or topic
3416 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3421 @findex gnus-topic-rename
3422 Rename a topic (@code{gnus-topic-rename}).
3425 @kindex T DEL (Topic)
3426 @findex gnus-topic-delete
3427 Delete an empty topic (@code{gnus-topic-delete}).
3431 @findex gnus-topic-list-active
3432 List all groups that Gnus knows about in a topics-ified way
3433 (@code{gnus-topic-list-active}).
3437 @findex gnus-topic-edit-parameters
3438 @cindex group parameters
3439 @cindex topic parameters
3441 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3442 @xref{Topic Parameters}.
3448 @subsection Topic Sorting
3449 @cindex topic sorting
3451 You can sort the groups in each topic individually with the following
3457 @kindex T S a (Topic)
3458 @findex gnus-topic-sort-groups-by-alphabet
3459 Sort the current topic alphabetically by group name
3460 (@code{gnus-topic-sort-groups-by-alphabet}).
3463 @kindex T S u (Topic)
3464 @findex gnus-topic-sort-groups-by-unread
3465 Sort the current topic by the number of unread articles
3466 (@code{gnus-topic-sort-groups-by-unread}).
3469 @kindex T S l (Topic)
3470 @findex gnus-topic-sort-groups-by-level
3471 Sort the current topic by group level
3472 (@code{gnus-topic-sort-groups-by-level}).
3475 @kindex T S v (Topic)
3476 @findex gnus-topic-sort-groups-by-score
3477 Sort the current topic by group score
3478 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
3481 @kindex T S r (Topic)
3482 @findex gnus-topic-sort-groups-by-rank
3483 Sort the current topic by group rank
3484 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
3487 @kindex T S m (Topic)
3488 @findex gnus-topic-sort-groups-by-method
3489 Sort the current topic alphabetically by backend name
3490 (@code{gnus-topic-sort-groups-by-method}).
3494 @xref{Sorting Groups}, for more information about group sorting.
3497 @node Topic Topology
3498 @subsection Topic Topology
3499 @cindex topic topology
3502 So, let's have a look at an example group buffer:
3508 2: alt.religion.emacs
3511 0: comp.talk.emacs.recovery
3513 8: comp.binaries.fractals
3514 13: comp.sources.unix
3517 So, here we have one top-level topic (@samp{Gnus}), two topics under
3518 that, and one sub-topic under one of the sub-topics. (There is always
3519 just one (1) top-level topic). This topology can be expressed as
3524 (("Emacs -- I wuw it!" visible)
3525 (("Naughty Emacs" visible)))
3529 @vindex gnus-topic-topology
3530 This is in fact how the variable @code{gnus-topic-topology} would look
3531 for the display above. That variable is saved in the @file{.newsrc.eld}
3532 file, and shouldn't be messed with manually---unless you really want
3533 to. Since this variable is read from the @file{.newsrc.eld} file,
3534 setting it in any other startup files will have no effect.
3536 This topology shows what topics are sub-topics of what topics (right),
3537 and which topics are visible. Two settings are currently
3538 allowed---@code{visible} and @code{invisible}.
3541 @node Topic Parameters
3542 @subsection Topic Parameters
3543 @cindex topic parameters
3545 All groups in a topic will inherit group parameters from the parent (and
3546 ancestor) topic parameters. All valid group parameters are valid topic
3547 parameters (@pxref{Group Parameters}).
3549 In addition, the following parameters are only valid as topic
3554 When subscribing new groups by topic (@pxref{Subscription Methods}), the
3555 @code{subscribe} topic parameter says what groups go in what topic. Its
3556 value should be a regexp to match the groups that should go in that
3561 Group parameters (of course) override topic parameters, and topic
3562 parameters in sub-topics override topic parameters in super-topics. You
3563 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
3564 verb, although you may feel free to disagree with me here.)
3570 2: alt.religion.emacs
3574 0: comp.talk.emacs.recovery
3576 8: comp.binaries.fractals
3577 13: comp.sources.unix
3581 The @samp{Emacs} topic has the topic parameter @code{(score-file
3582 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
3583 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
3584 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
3585 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
3586 . "religion.SCORE")}.
3588 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
3589 will get the @file{relief.SCORE} home score file. If you enter the same
3590 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
3591 score file. If you enter the group @samp{alt.religion.emacs}, you'll
3592 get the @file{religion.SCORE} home score file.
3594 This seems rather simple and self-evident, doesn't it? Well, yes. But
3595 there are some problems, especially with the @code{total-expiry}
3596 parameter. Say you have a mail group in two topics; one with
3597 @code{total-expiry} and one without. What happens when you do @kbd{M-x
3598 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
3599 of these topics you mean to expire articles from, so anything may
3600 happen. In fact, I hereby declare that it is @dfn{undefined} what
3601 happens. You just have to be careful if you do stuff like that.
3604 @node Misc Group Stuff
3605 @section Misc Group Stuff
3608 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
3609 * Group Information:: Information and help on groups and Gnus.
3610 * Group Timestamp:: Making Gnus keep track of when you last read a group.
3611 * File Commands:: Reading and writing the Gnus files.
3618 @findex gnus-group-enter-server-mode
3619 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3620 @xref{Server Buffer}.
3624 @findex gnus-group-post-news
3625 Post an article to a group (@code{gnus-group-post-news}). If given a
3626 prefix, the current group name will be used as the default.
3630 @findex gnus-group-mail
3631 Mail a message somewhere (@code{gnus-group-mail}).
3635 Variables for the group buffer:
3639 @item gnus-group-mode-hook
3640 @vindex gnus-group-mode-hook
3641 is called after the group buffer has been
3644 @item gnus-group-prepare-hook
3645 @vindex gnus-group-prepare-hook
3646 is called after the group buffer is
3647 generated. It may be used to modify the buffer in some strange,
3650 @item gnus-group-prepared-hook
3651 @vindex gnus-group-prepare-hook
3652 is called as the very last thing after the group buffer has been
3653 generated. It may be used to move point around, for instance.
3655 @item gnus-permanently-visible-groups
3656 @vindex gnus-permanently-visible-groups
3657 Groups matching this regexp will always be listed in the group buffer,
3658 whether they are empty or not.
3660 @item gnus-group-name-charset-method-alist
3661 @vindex gnus-group-name-charset-method-alist
3662 An alist of method and the charset for group names. It is used to show
3663 non-ASCII group names.
3667 (setq gnus-group-name-charset-method-alist
3668 '(((nntp "news.com.cn") . cn-gb-2312)))
3671 @item gnus-group-name-charset-group-alist
3672 @vindex gnus-group-name-charset-group-alist
3673 An alist of regexp of group name and the charset for group names.
3674 It is used to show non-ASCII group names.
3678 (setq gnus-group-name-charset-group-alist
3679 '(("\\.com\\.cn:" . cn-gb-2312)))
3684 @node Scanning New Messages
3685 @subsection Scanning New Messages
3686 @cindex new messages
3687 @cindex scanning new news
3693 @findex gnus-group-get-new-news
3694 @c @icon{gnus-group-get-new-news}
3695 Check the server(s) for new articles. If the numerical prefix is used,
3696 this command will check only groups of level @var{arg} and lower
3697 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
3698 command will force a total re-reading of the active file(s) from the
3703 @findex gnus-group-get-new-news-this-group
3704 @vindex gnus-goto-next-group-when-activating
3705 @c @icon{gnus-group-get-new-news-this-group}
3706 Check whether new articles have arrived in the current group
3707 (@code{gnus-group-get-new-news-this-group}).
3708 @code{gnus-goto-next-group-when-activating} says whether this command is
3709 to move point to the next group or not. It is @code{t} by default.
3711 @findex gnus-activate-all-groups
3712 @cindex activating groups
3714 @kindex C-c M-g (Group)
3715 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3720 @findex gnus-group-restart
3721 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
3722 file(s), closes the connection to all servers, clears up all run-time
3723 Gnus variables, and then starts Gnus all over again.
3727 @vindex gnus-get-new-news-hook
3728 @code{gnus-get-new-news-hook} is run just before checking for new news.
3730 @vindex gnus-after-getting-new-news-hook
3731 @code{gnus-after-getting-new-news-hook} is run after checking for new
3735 @node Group Information
3736 @subsection Group Information
3737 @cindex group information
3738 @cindex information on groups
3745 @findex gnus-group-fetch-faq
3746 @vindex gnus-group-faq-directory
3749 Try to fetch the FAQ for the current group
3750 (@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from
3751 @code{gnus-group-faq-directory}, which is usually a directory on a
3752 remote machine. This variable can also be a list of directories. In
3753 that case, giving a prefix to this command will allow you to choose
3754 between the various sites. @code{ange-ftp} (or @code{efs}) will be used
3755 for fetching the file.
3757 If fetching from the first site is unsuccessful, Gnus will attempt to go
3758 through @code{gnus-group-faq-directory} and try to open them one by one.
3762 @c @icon{gnus-group-describe-group}
3764 @kindex C-c C-d (Group)
3765 @cindex describing groups
3766 @cindex group description
3767 @findex gnus-group-describe-group
3768 Describe the current group (@code{gnus-group-describe-group}). If given
3769 a prefix, force Gnus to re-read the description from the server.
3773 @findex gnus-group-describe-all-groups
3774 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
3775 prefix, force Gnus to re-read the description file from the server.
3782 @findex gnus-version
3783 Display current Gnus version numbers (@code{gnus-version}).
3787 @findex gnus-group-describe-briefly
3788 Give a very short help message (@code{gnus-group-describe-briefly}).
3791 @kindex C-c C-i (Group)
3794 @findex gnus-info-find-node
3795 Go to the Gnus info node (@code{gnus-info-find-node}).
3799 @node Group Timestamp
3800 @subsection Group Timestamp
3802 @cindex group timestamps
3804 It can be convenient to let Gnus keep track of when you last read a
3805 group. To set the ball rolling, you should add
3806 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3809 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3812 After doing this, each time you enter a group, it'll be recorded.
3814 This information can be displayed in various ways---the easiest is to
3815 use the @samp{%d} spec in the group line format:
3818 (setq gnus-group-line-format
3819 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3822 This will result in lines looking like:
3825 * 0: mail.ding 19961002T012943
3826 0: custom 19961002T012713
3829 As you can see, the date is displayed in compact ISO 8601 format. This
3830 may be a bit too much, so to just display the date, you could say
3834 (setq gnus-group-line-format
3835 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3840 @subsection File Commands
3841 @cindex file commands
3847 @findex gnus-group-read-init-file
3848 @vindex gnus-init-file
3849 @cindex reading init file
3850 Re-read the init file (@code{gnus-init-file}, which defaults to
3851 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3855 @findex gnus-group-save-newsrc
3856 @cindex saving .newsrc
3857 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3858 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
3859 file(s) whether Gnus thinks it is necessary or not.
3862 @c @kindex Z (Group)
3863 @c @findex gnus-group-clear-dribble
3864 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3869 @node Summary Buffer
3870 @chapter Summary Buffer
3871 @cindex summary buffer
3873 A line for each article is displayed in the summary buffer. You can
3874 move around, read articles, post articles and reply to articles.
3876 The most common way to a summary buffer is to select a group from the
3877 group buffer (@pxref{Selecting a Group}).
3879 You can have as many summary buffers open as you wish.
3882 * Summary Buffer Format:: Deciding how the summary buffer is to look.
3883 * Summary Maneuvering:: Moving around the summary buffer.
3884 * Choosing Articles:: Reading articles.
3885 * Paging the Article:: Scrolling the current article.
3886 * Reply Followup and Post:: Posting articles.
3887 * Marking Articles:: Marking articles as read, expirable, etc.
3888 * Limiting:: You can limit the summary buffer.
3889 * Threading:: How threads are made.
3890 * Sorting the Summary Buffer:: How articles and threads are sorted.
3891 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
3892 * Article Caching:: You may store articles in a cache.
3893 * Persistent Articles:: Making articles expiry-resistant.
3894 * Article Backlog:: Having already read articles hang around.
3895 * Saving Articles:: Ways of customizing article saving.
3896 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
3897 * Article Treatment:: The article buffer can be mangled at will.
3898 * MIME Commands:: Doing MIMEy things with the articles.
3899 * Charsets:: Character set issues.
3900 * Article Commands:: Doing various things with the article buffer.
3901 * Summary Sorting:: Sorting the summary buffer in various ways.
3902 * Finding the Parent:: No child support? Get the parent.
3903 * Alternative Approaches:: Reading using non-default summaries.
3904 * Tree Display:: A more visual display of threads.
3905 * Mail Group Commands:: Some commands can only be used in mail groups.
3906 * Various Summary Stuff:: What didn't fit anywhere else.
3907 * Exiting the Summary Buffer:: Returning to the Group buffer,
3908 or reselecting the current group.
3909 * Crosspost Handling:: How crossposted articles are dealt with.
3910 * Duplicate Suppression:: An alternative when crosspost handling fails.
3911 * Security:: Decrypt and Verify.
3915 @node Summary Buffer Format
3916 @section Summary Buffer Format
3917 @cindex summary buffer format
3921 \gnusfigure{The Summary Buffer}{180}{
3922 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3923 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3929 * Summary Buffer Lines:: You can specify how summary lines should look.
3930 * To From Newsgroups:: How to not display your own name.
3931 * Summary Buffer Mode Line:: You can say how the mode line should look.
3932 * Summary Highlighting:: Making the summary buffer all pretty and nice.
3935 @findex mail-extract-address-components
3936 @findex gnus-extract-address-components
3937 @vindex gnus-extract-address-components
3938 Gnus will use the value of the @code{gnus-extract-address-components}
3939 variable as a function for getting the name and address parts of a
3940 @code{From} header. Two pre-defined functions exist:
3941 @code{gnus-extract-address-components}, which is the default, quite
3942 fast, and too simplistic solution; and
3943 @code{mail-extract-address-components}, which works very nicely, but is
3944 slower. The default function will return the wrong answer in 5% of the
3945 cases. If this is unacceptable to you, use the other function instead:
3948 (setq gnus-extract-address-components
3949 'mail-extract-address-components)
3952 @vindex gnus-summary-same-subject
3953 @code{gnus-summary-same-subject} is a string indicating that the current
3954 article has the same subject as the previous. This string will be used
3955 with those specs that require it. The default is @code{""}.
3958 @node Summary Buffer Lines
3959 @subsection Summary Buffer Lines
3961 @vindex gnus-summary-line-format
3962 You can change the format of the lines in the summary buffer by changing
3963 the @code{gnus-summary-line-format} variable. It works along the same
3964 lines as a normal @code{format} string, with some extensions
3965 (@pxref{Formatting Variables}).
3967 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3969 The following format specification characters are understood:
3975 Subject string. List identifiers stripped,
3976 @code{gnus-list-identifies}. @xref{Article Hiding}.
3978 Subject if the article is the root of the thread or the previous article
3979 had a different subject, @code{gnus-summary-same-subject} otherwise.
3980 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3982 Full @code{From} header.
3984 The name (from the @code{From} header).
3986 The name, code @code{To} header or the @code{Newsgroups} header
3987 (@pxref{To From Newsgroups}).
3989 The name (from the @code{From} header). This differs from the @code{n}
3990 spec in that it uses the function designated by the
3991 @code{gnus-extract-address-components} variable, which is slower, but
3992 may be more thorough.
3994 The address (from the @code{From} header). This works the same way as
3997 Number of lines in the article.
3999 Number of characters in the article. This specifier is not supported in some
4000 methods (like nnfolder).
4002 Indentation based on thread level (@pxref{Customizing Threading}).
4004 Nothing if the article is a root and lots of spaces if it isn't (it
4005 pushes everything after it off the screen).
4007 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4008 for adopted articles (@pxref{Customizing Threading}).
4010 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4011 for adopted articles.
4013 One space for each thread level.
4015 Twenty minus thread level spaces.
4020 This misleadingly named specifier is the @dfn{secondary mark}. This
4021 mark will say whether the article has been replied to, has been cached,
4025 Score as a number (@pxref{Scoring}).
4027 @vindex gnus-summary-zcore-fuzz
4028 Zcore, @samp{+} if above the default level and @samp{-} if below the
4029 default level. If the difference between
4030 @code{gnus-summary-default-score} and the score is less than
4031 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4039 The @code{Date} in @code{DD-MMM} format.
4041 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4047 Number of articles in the current sub-thread. Using this spec will slow
4048 down summary buffer generation somewhat.
4050 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4051 article has any children.
4057 User defined specifier. The next character in the format string should
4058 be a letter. Gnus will call the function
4059 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
4060 following @samp{%u}. The function will be passed the current header as
4061 argument. The function should return a string, which will be inserted
4062 into the summary just like information from any other summary specifier.
4065 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4066 have to be handled with care. For reasons of efficiency, Gnus will
4067 compute what column these characters will end up in, and ``hard-code''
4068 that. This means that it is invalid to have these specs after a
4069 variable-length spec. Well, you might not be arrested, but your summary
4070 buffer will look strange, which is bad enough.
4072 The smart choice is to have these specs as far to the left as possible.
4073 (Isn't that the case with everything, though? But I digress.)
4075 This restriction may disappear in later versions of Gnus.
4078 @node To From Newsgroups
4079 @subsection To From Newsgroups
4083 In some groups (particularly in archive groups), the @code{From} header
4084 isn't very interesting, since all the articles there are written by
4085 you. To display the information in the @code{To} or @code{Newsgroups}
4086 headers instead, you need to decide three things: What information to
4087 gather; where to display it; and when to display it.
4091 @vindex gnus-extra-headers
4092 The reading of extra header information is controlled by the
4093 @code{gnus-extra-headers}. This is a list of header symbols. For
4097 (setq gnus-extra-headers
4098 '(To Newsgroups X-Newsreader))
4101 This will result in Gnus trying to obtain these three headers, and
4102 storing it in header structures for later easy retrieval.
4105 @findex gnus-extra-header
4106 The value of these extra headers can be accessed via the
4107 @code{gnus-extra-header} function. Here's a format line spec that will
4108 access the @code{X-Newsreader} header:
4111 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4115 @vindex gnus-ignored-from-addresses
4116 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4117 summary line spec returns the @code{To}, @code{Newsreader} or
4118 @code{From} header. If this regexp matches the contents of the
4119 @code{From} header, the value of the @code{To} or @code{Newsreader}
4120 headers are used instead.
4124 @vindex nnmail-extra-headers
4125 A related variable is @code{nnmail-extra-headers}, which controls when
4126 to include extra headers when generating overview (@sc{nov}) files. If
4127 you have old overview files, you should regenerate them after changing
4130 @vindex gnus-summary-line-format
4131 You also have to instruct Gnus to display the data by changing the
4132 @code{%n} spec to the @code{%f} spec in the
4133 @code{gnus-summary-line-format} variable.
4135 In summary, you'd typically put something like the following in
4139 (setq gnus-extra-headers
4141 (setq nnmail-extra-headers gnus-extra-headers)
4142 (setq gnus-summary-line-format
4143 "%U%R%z%I%(%[%4L: %-20,20f%]%) %s\n")
4144 (setq gnus-ignored-from-addresses
4148 Now, this is mostly useful for mail groups, where you have control over
4149 the @sc{nov} files that are created. However, if you can persuade your
4156 to the end of her @file{overview.fmt} file, then you can use that just
4157 as you would the extra headers from the mail groups.
4160 @node Summary Buffer Mode Line
4161 @subsection Summary Buffer Mode Line
4163 @vindex gnus-summary-mode-line-format
4164 You can also change the format of the summary mode bar (@pxref{Mode Line
4165 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
4166 like. The default is @samp{Gnus: %%b [%A] %Z}.
4168 Here are the elements you can play with:
4174 Unprefixed group name.
4176 Current article number.
4178 Current article score.
4182 Number of unread articles in this group.
4184 Number of unread articles in this group that aren't displayed in the
4187 A string with the number of unread and unselected articles represented
4188 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4189 articles, and just as @samp{<%U more>} if there are just unread articles
4190 and no unselected ones.
4192 Shortish group name. For instance, @samp{rec.arts.anime} will be
4193 shortened to @samp{r.a.anime}.
4195 Subject of the current article.
4197 User-defined spec (@pxref{User-Defined Specs}).
4199 Name of the current score file (@pxref{Scoring}).
4201 Number of dormant articles (@pxref{Unread Articles}).
4203 Number of ticked articles (@pxref{Unread Articles}).
4205 Number of articles that have been marked as read in this session.
4207 Number of articles expunged by the score files.
4211 @node Summary Highlighting
4212 @subsection Summary Highlighting
4216 @item gnus-visual-mark-article-hook
4217 @vindex gnus-visual-mark-article-hook
4218 This hook is run after selecting an article. It is meant to be used for
4219 highlighting the article in some way. It is not run if
4220 @code{gnus-visual} is @code{nil}.
4222 @item gnus-summary-update-hook
4223 @vindex gnus-summary-update-hook
4224 This hook is called when a summary line is changed. It is not run if
4225 @code{gnus-visual} is @code{nil}.
4227 @item gnus-summary-selected-face
4228 @vindex gnus-summary-selected-face
4229 This is the face (or @dfn{font} as some people call it) used to
4230 highlight the current article in the summary buffer.
4232 @item gnus-summary-highlight
4233 @vindex gnus-summary-highlight
4234 Summary lines are highlighted according to this variable, which is a
4235 list where the elements are of the format @code{(@var{form}
4236 . @var{face})}. If you would, for instance, like ticked articles to be
4237 italic and high-scored articles to be bold, you could set this variable
4240 (((eq mark gnus-ticked-mark) . italic)
4241 ((> score default) . bold))
4243 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4244 @var{face} will be applied to the line.
4248 @node Summary Maneuvering
4249 @section Summary Maneuvering
4250 @cindex summary movement
4252 All the straight movement commands understand the numeric prefix and
4253 behave pretty much as you'd expect.
4255 None of these commands select articles.
4260 @kindex M-n (Summary)
4261 @kindex G M-n (Summary)
4262 @findex gnus-summary-next-unread-subject
4263 Go to the next summary line of an unread article
4264 (@code{gnus-summary-next-unread-subject}).
4268 @kindex M-p (Summary)
4269 @kindex G M-p (Summary)
4270 @findex gnus-summary-prev-unread-subject
4271 Go to the previous summary line of an unread article
4272 (@code{gnus-summary-prev-unread-subject}).
4275 @kindex G g (Summary)
4276 @findex gnus-summary-goto-subject
4277 Ask for an article number and then go to the summary line of that article
4278 without displaying the article (@code{gnus-summary-goto-subject}).
4281 If Gnus asks you to press a key to confirm going to the next group, you
4282 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4283 buffer, searching for the next group to read without actually returning
4284 to the group buffer.
4286 Variables related to summary movement:
4290 @vindex gnus-auto-select-next
4291 @item gnus-auto-select-next
4292 If you issue one of the movement commands (like @kbd{n}) and there are
4293 no more unread articles after the current one, Gnus will offer to go to
4294 the next group. If this variable is @code{t} and the next group is
4295 empty, Gnus will exit summary mode and return to the group buffer. If
4296 this variable is neither @code{t} nor @code{nil}, Gnus will select the
4297 next group, no matter whether it has any unread articles or not. As a
4298 special case, if this variable is @code{quietly}, Gnus will select the
4299 next group without asking for confirmation. If this variable is
4300 @code{almost-quietly}, the same will happen only if you are located on
4301 the last article in the group. Finally, if this variable is
4302 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
4303 without confirmation. Also @pxref{Group Levels}.
4305 @item gnus-auto-select-same
4306 @vindex gnus-auto-select-same
4307 If non-@code{nil}, all the movement commands will try to go to the next
4308 article with the same subject as the current. (@dfn{Same} here might
4309 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
4310 for details (@pxref{Customizing Threading}).) If there are no more
4311 articles with the same subject, go to the first unread article.
4313 This variable is not particularly useful if you use a threaded display.
4315 @item gnus-summary-check-current
4316 @vindex gnus-summary-check-current
4317 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4318 to the next (or previous) article if the current article is unread.
4319 Instead, they will choose the current article.
4321 @item gnus-auto-center-summary
4322 @vindex gnus-auto-center-summary
4323 If non-@code{nil}, Gnus will keep the point in the summary buffer
4324 centered at all times. This makes things quite tidy, but if you have a
4325 slow network connection, or simply do not like this un-Emacsism, you can
4326 set this variable to @code{nil} to get the normal Emacs scrolling
4327 action. This will also inhibit horizontal re-centering of the summary
4328 buffer, which might make it more inconvenient to read extremely long
4331 This variable can also be a number. In that case, center the window at
4332 the given number of lines from the top.
4337 @node Choosing Articles
4338 @section Choosing Articles
4339 @cindex selecting articles
4342 * Choosing Commands:: Commands for choosing articles.
4343 * Choosing Variables:: Variables that influence these commands.
4347 @node Choosing Commands
4348 @subsection Choosing Commands
4350 None of the following movement commands understand the numeric prefix,
4351 and they all select and display an article.
4353 If you want to fetch new articles or redisplay the group, see
4354 @ref{Exiting the Summary Buffer}.
4358 @kindex SPACE (Summary)
4359 @findex gnus-summary-next-page
4360 Select the current article, or, if that one's read already, the next
4361 unread article (@code{gnus-summary-next-page}).
4366 @kindex G n (Summary)
4367 @findex gnus-summary-next-unread-article
4368 @c @icon{gnus-summary-next-unread}
4369 Go to next unread article (@code{gnus-summary-next-unread-article}).
4374 @findex gnus-summary-prev-unread-article
4375 @c @icon{gnus-summary-prev-unread}
4376 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
4381 @kindex G N (Summary)
4382 @findex gnus-summary-next-article
4383 Go to the next article (@code{gnus-summary-next-article}).
4388 @kindex G P (Summary)
4389 @findex gnus-summary-prev-article
4390 Go to the previous article (@code{gnus-summary-prev-article}).
4393 @kindex G C-n (Summary)
4394 @findex gnus-summary-next-same-subject
4395 Go to the next article with the same subject
4396 (@code{gnus-summary-next-same-subject}).
4399 @kindex G C-p (Summary)
4400 @findex gnus-summary-prev-same-subject
4401 Go to the previous article with the same subject
4402 (@code{gnus-summary-prev-same-subject}).
4406 @kindex G f (Summary)
4408 @findex gnus-summary-first-unread-article
4409 Go to the first unread article
4410 (@code{gnus-summary-first-unread-article}).
4414 @kindex G b (Summary)
4416 @findex gnus-summary-best-unread-article
4417 Go to the article with the highest score
4418 (@code{gnus-summary-best-unread-article}).
4423 @kindex G l (Summary)
4424 @findex gnus-summary-goto-last-article
4425 Go to the previous article read (@code{gnus-summary-goto-last-article}).
4428 @kindex G o (Summary)
4429 @findex gnus-summary-pop-article
4431 @cindex article history
4432 Pop an article off the summary history and go to this article
4433 (@code{gnus-summary-pop-article}). This command differs from the
4434 command above in that you can pop as many previous articles off the
4435 history as you like, while @kbd{l} toggles the two last read articles.
4436 For a somewhat related issue (if you use these commands a lot),
4437 @pxref{Article Backlog}.
4442 @kindex G j (Summary)
4443 @findex gnus-summary-goto-article
4444 Ask for an article number or @code{Message-ID}, and then go to that
4445 article (@code{gnus-summary-goto-article}).
4450 @node Choosing Variables
4451 @subsection Choosing Variables
4453 Some variables relevant for moving and selecting articles:
4456 @item gnus-auto-extend-newsgroup
4457 @vindex gnus-auto-extend-newsgroup
4458 All the movement commands will try to go to the previous (or next)
4459 article, even if that article isn't displayed in the Summary buffer if
4460 this variable is non-@code{nil}. Gnus will then fetch the article from
4461 the server and display it in the article buffer.
4463 @item gnus-select-article-hook
4464 @vindex gnus-select-article-hook
4465 This hook is called whenever an article is selected. By default it
4466 exposes any threads hidden under the selected article.
4468 @item gnus-mark-article-hook
4469 @vindex gnus-mark-article-hook
4470 @findex gnus-summary-mark-unread-as-read
4471 @findex gnus-summary-mark-read-and-unread-as-read
4472 @findex gnus-unread-mark
4473 This hook is called whenever an article is selected. It is intended to
4474 be used for marking articles as read. The default value is
4475 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
4476 mark of almost any article you read to @code{gnus-unread-mark}. The
4477 only articles not affected by this function are ticked, dormant, and
4478 expirable articles. If you'd instead like to just have unread articles
4479 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
4480 instead. It will leave marks like @code{gnus-low-score-mark},
4481 @code{gnus-del-mark} (and so on) alone.
4486 @node Paging the Article
4487 @section Scrolling the Article
4488 @cindex article scrolling
4493 @kindex SPACE (Summary)
4494 @findex gnus-summary-next-page
4495 Pressing @kbd{SPACE} will scroll the current article forward one page,
4496 or, if you have come to the end of the current article, will choose the
4497 next article (@code{gnus-summary-next-page}).
4500 @kindex DEL (Summary)
4501 @findex gnus-summary-prev-page
4502 Scroll the current article back one page (@code{gnus-summary-prev-page}).
4505 @kindex RET (Summary)
4506 @findex gnus-summary-scroll-up
4507 Scroll the current article one line forward
4508 (@code{gnus-summary-scroll-up}).
4511 @kindex M-RET (Summary)
4512 @findex gnus-summary-scroll-down
4513 Scroll the current article one line backward
4514 (@code{gnus-summary-scroll-down}).
4518 @kindex A g (Summary)
4520 @findex gnus-summary-show-article
4521 @vindex gnus-summary-show-article-charset-alist
4522 (Re)fetch the current article (@code{gnus-summary-show-article}). If
4523 given a prefix, fetch the current article, but don't run any of the
4524 article treatment functions. This will give you a ``raw'' article, just
4525 the way it came from the server.
4527 If given a numerical prefix, you can do semi-manual charset stuff.
4528 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
4529 encoded in the @code{cn-gb-2312} charset. If you have
4532 (setq gnus-summary-show-article-charset-alist
4537 then you can say @kbd{C-u 1 g} to get the same effect.
4542 @kindex A < (Summary)
4543 @findex gnus-summary-beginning-of-article
4544 Scroll to the beginning of the article
4545 (@code{gnus-summary-beginning-of-article}).
4550 @kindex A > (Summary)
4551 @findex gnus-summary-end-of-article
4552 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
4556 @kindex A s (Summary)
4558 @findex gnus-summary-isearch-article
4559 Perform an isearch in the article buffer
4560 (@code{gnus-summary-isearch-article}).
4564 @findex gnus-summary-select-article-buffer
4565 Select the article buffer (@code{gnus-summary-select-article-buffer}).
4570 @node Reply Followup and Post
4571 @section Reply, Followup and Post
4574 * Summary Mail Commands:: Sending mail.
4575 * Summary Post Commands:: Sending news.
4576 * Summary Message Commands:: Other Message-related commands.
4577 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
4581 @node Summary Mail Commands
4582 @subsection Summary Mail Commands
4584 @cindex composing mail
4586 Commands for composing a mail message:
4592 @kindex S r (Summary)
4594 @findex gnus-summary-reply
4595 @c @icon{gnus-summary-mail-reply}
4596 @c @icon{gnus-summary-reply}
4597 Mail a reply to the author of the current article
4598 (@code{gnus-summary-reply}).
4603 @kindex S R (Summary)
4604 @findex gnus-summary-reply-with-original
4605 @c @icon{gnus-summary-reply-with-original}
4606 Mail a reply to the author of the current article and include the
4607 original message (@code{gnus-summary-reply-with-original}). This
4608 command uses the process/prefix convention.
4611 @kindex S w (Summary)
4612 @findex gnus-summary-wide-reply
4613 Mail a wide reply to the author of the current article
4614 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
4615 goes out to all people listed in the @code{To}, @code{From} (or
4616 @code{Reply-to}) and @code{Cc} headers.
4619 @kindex S W (Summary)
4620 @findex gnus-summary-wide-reply-with-original
4621 Mail a wide reply to the current article and include the original
4622 message (@code{gnus-summary-wide-reply-with-original}). This command uses
4623 the process/prefix convention.
4626 @kindex S v (Summary)
4627 @findex gnus-summary-very-wide-reply
4628 Mail a very wide reply to the author of the current article
4629 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
4630 that goes out to all people listed in the @code{To}, @code{From} (or
4631 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
4632 articles. This command uses the process/prefix convention.
4635 @kindex S W (Summary)
4636 @findex gnus-summary-wide-reply-with-original
4637 Mail a very wide reply to the current article and include the original
4638 message (@code{gnus-summary-wide-reply-with-original}). This command uses
4639 the process/prefix convention.
4643 @kindex S o m (Summary)
4644 @kindex C-c C-f (Summary)
4645 @findex gnus-summary-mail-forward
4646 @c @icon{gnus-summary-mail-forward}
4647 Forward the current article to some other person
4648 (@code{gnus-summary-mail-forward}). If no prefix is given, the message
4649 is forwarded according to the value of (@code{message-forward-as-mime})
4650 and (@code{message-forward-show-mml}); if the prefix is 1, decode the
4651 message and forward directly inline; if the prefix is 2, forward message
4652 as an rfc822 MIME section; if the prefix is 3, decode message and
4653 forward as an rfc822 MIME section; if the prefix is 4, forward message
4654 directly inline; otherwise, the message is forwarded as no prefix given
4655 but use the flipped value of (@code{message-forward-as-mime}). By
4656 default, the message is decoded and forwarded as an rfc822 MIME section.
4661 @kindex S m (Summary)
4662 @findex gnus-summary-mail-other-window
4663 @c @icon{gnus-summary-mail-originate}
4664 Send a mail to some other person
4665 (@code{gnus-summary-mail-other-window}).
4668 @kindex S D b (Summary)
4669 @findex gnus-summary-resend-bounced-mail
4670 @cindex bouncing mail
4671 If you have sent a mail, but the mail was bounced back to you for some
4672 reason (wrong address, transient failure), you can use this command to
4673 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
4674 will be popped into a mail buffer where you can edit the headers before
4675 sending the mail off again. If you give a prefix to this command, and
4676 the bounced mail is a reply to some other mail, Gnus will try to fetch
4677 that mail and display it for easy perusal of its headers. This might
4678 very well fail, though.
4681 @kindex S D r (Summary)
4682 @findex gnus-summary-resend-message
4683 Not to be confused with the previous command,
4684 @code{gnus-summary-resend-message} will prompt you for an address to
4685 send the current message off to, and then send it to that place. The
4686 headers of the message won't be altered---but lots of headers that say
4687 @code{Resent-To}, @code{Resent-From} and so on will be added. This
4688 means that you actually send a mail to someone that has a @code{To}
4689 header that (probably) points to yourself. This will confuse people.
4690 So, natcherly you'll only do that if you're really eVIl.
4692 This command is mainly used if you have several accounts and want to
4693 ship a mail to a different account of yours. (If you're both
4694 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4695 to the @code{root} account, you may want to resend it to
4696 @code{postmaster}. Ordnung muß sein!
4698 This command understands the process/prefix convention
4699 (@pxref{Process/Prefix}).
4702 @kindex S O m (Summary)
4703 @findex gnus-uu-digest-mail-forward
4704 Digest the current series (@pxref{Decoding Articles}) and forward the
4705 result using mail (@code{gnus-uu-digest-mail-forward}). This command
4706 uses the process/prefix convention (@pxref{Process/Prefix}).
4709 @kindex S M-c (Summary)
4710 @findex gnus-summary-mail-crosspost-complaint
4711 @cindex crossposting
4712 @cindex excessive crossposting
4713 Send a complaint about excessive crossposting to the author of the
4714 current article (@code{gnus-summary-mail-crosspost-complaint}).
4716 @findex gnus-crosspost-complaint
4717 This command is provided as a way to fight back against the current
4718 crossposting pandemic that's sweeping Usenet. It will compose a reply
4719 using the @code{gnus-crosspost-complaint} variable as a preamble. This
4720 command understands the process/prefix convention
4721 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
4725 Also @pxref{(message)Header Commands} for more information.
4728 @node Summary Post Commands
4729 @subsection Summary Post Commands
4731 @cindex composing news
4733 Commands for posting a news article:
4739 @kindex S p (Summary)
4740 @findex gnus-summary-post-news
4741 @c @icon{gnus-summary-post-news}
4742 Post an article to the current group
4743 (@code{gnus-summary-post-news}).
4748 @kindex S f (Summary)
4749 @findex gnus-summary-followup
4750 @c @icon{gnus-summary-followup}
4751 Post a followup to the current article (@code{gnus-summary-followup}).
4755 @kindex S F (Summary)
4757 @c @icon{gnus-summary-followup-with-original}
4758 @findex gnus-summary-followup-with-original
4759 Post a followup to the current article and include the original message
4760 (@code{gnus-summary-followup-with-original}). This command uses the
4761 process/prefix convention.
4764 @kindex S n (Summary)
4765 @findex gnus-summary-followup-to-mail
4766 Post a followup to the current article via news, even if you got the
4767 message through mail (@code{gnus-summary-followup-to-mail}).
4770 @kindex S N (Summary)
4771 @findex gnus-summary-followup-to-mail-with-original
4772 Post a followup to the current article via news, even if you got the
4773 message through mail and include the original message
4774 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
4775 the process/prefix convention.
4778 @kindex S o p (Summary)
4779 @findex gnus-summary-post-forward
4780 Forward the current article to a newsgroup
4781 (@code{gnus-summary-post-forward}).
4782 If no prefix is given, the message is forwarded according to the value
4783 of (@code{message-forward-as-mime}) and
4784 (@code{message-forward-show-mml}); if the prefix is 1, decode the
4785 message and forward directly inline; if the prefix is 2, forward message
4786 as an rfc822 MIME section; if the prefix is 3, decode message and
4787 forward as an rfc822 MIME section; if the prefix is 4, forward message
4788 directly inline; otherwise, the message is forwarded as no prefix given
4789 but use the flipped value of (@code{message-forward-as-mime}). By
4790 default, the message is decoded and forwarded as an rfc822 MIME section.
4793 @kindex S O p (Summary)
4794 @findex gnus-uu-digest-post-forward
4796 @cindex making digests
4797 Digest the current series and forward the result to a newsgroup
4798 (@code{gnus-uu-digest-mail-forward}). This command uses the
4799 process/prefix convention.
4802 @kindex S u (Summary)
4803 @findex gnus-uu-post-news
4804 @c @icon{gnus-uu-post-news}
4805 Uuencode a file, split it into parts, and post it as a series
4806 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
4809 Also @pxref{(message)Header Commands} for more information.
4812 @node Summary Message Commands
4813 @subsection Summary Message Commands
4817 @kindex S y (Summary)
4818 @findex gnus-summary-yank-message
4819 Yank the current article into an already existing Message composition
4820 buffer (@code{gnus-summary-yank-message}). This command prompts for
4821 what message buffer you want to yank into, and understands the
4822 process/prefix convention (@pxref{Process/Prefix}).
4827 @node Canceling and Superseding
4828 @subsection Canceling Articles
4829 @cindex canceling articles
4830 @cindex superseding articles
4832 Have you ever written something, and then decided that you really,
4833 really, really wish you hadn't posted that?
4835 Well, you can't cancel mail, but you can cancel posts.
4837 @findex gnus-summary-cancel-article
4839 @c @icon{gnus-summary-cancel-article}
4840 Find the article you wish to cancel (you can only cancel your own
4841 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
4842 c} (@code{gnus-summary-cancel-article}). Your article will be
4843 canceled---machines all over the world will be deleting your article.
4844 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4846 Be aware, however, that not all sites honor cancels, so your article may
4847 live on here and there, while most sites will delete the article in
4850 Gnus will use the ``current'' select method when canceling. If you
4851 want to use the standard posting method, use the @samp{a} symbolic
4852 prefix (@pxref{Symbolic Prefixes}).
4854 If you discover that you have made some mistakes and want to do some
4855 corrections, you can post a @dfn{superseding} article that will replace
4856 your original article.
4858 @findex gnus-summary-supersede-article
4860 Go to the original article and press @kbd{S s}
4861 (@code{gnus-summary-supersede-article}). You will be put in a buffer
4862 where you can edit the article all you want before sending it off the
4865 The same goes for superseding as for canceling, only more so: Some
4866 sites do not honor superseding. On those sites, it will appear that you
4867 have posted almost the same article twice.
4869 If you have just posted the article, and change your mind right away,
4870 there is a trick you can use to cancel/supersede the article without
4871 waiting for the article to appear on your site first. You simply return
4872 to the post buffer (which is called @code{*sent ...*}). There you will
4873 find the article you just posted, with all the headers intact. Change
4874 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4875 header by substituting one of those words for the word
4876 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
4877 you would do normally. The previous article will be
4878 canceled/superseded.
4880 Just remember, kids: There is no 'c' in 'supersede'.
4883 @node Marking Articles
4884 @section Marking Articles
4885 @cindex article marking
4886 @cindex article ticking
4889 There are several marks you can set on an article.
4891 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4892 neologism ohoy!) of the article. Alphabetic marks generally mean
4893 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4895 In addition, you also have marks that do not affect readedness.
4898 * Unread Articles:: Marks for unread articles.
4899 * Read Articles:: Marks for read articles.
4900 * Other Marks:: Marks that do not affect readedness.
4904 There's a plethora of commands for manipulating these marks:
4908 * Setting Marks:: How to set and remove marks.
4909 * Generic Marking Commands:: How to customize the marking.
4910 * Setting Process Marks:: How to mark articles for later processing.
4914 @node Unread Articles
4915 @subsection Unread Articles
4917 The following marks mark articles as (kinda) unread, in one form or
4922 @vindex gnus-ticked-mark
4923 Marked as ticked (@code{gnus-ticked-mark}).
4925 @dfn{Ticked articles} are articles that will remain visible always. If
4926 you see an article that you find interesting, or you want to put off
4927 reading it, or replying to it, until sometime later, you'd typically
4928 tick it. However, articles can be expired (from news servers by the
4929 news server software, Gnus itself never expires ticked messages), so if
4930 you want to keep an article forever, you'll have to make it persistent
4931 (@pxref{Persistent Articles}).
4934 @vindex gnus-dormant-mark
4935 Marked as dormant (@code{gnus-dormant-mark}).
4937 @dfn{Dormant articles} will only appear in the summary buffer if there
4938 are followups to it. If you want to see them even if they don't have
4939 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4940 Otherwise (except for the visibility issue), they are just like ticked
4944 @vindex gnus-unread-mark
4945 Marked as unread (@code{gnus-unread-mark}).
4947 @dfn{Unread articles} are articles that haven't been read at all yet.
4952 @subsection Read Articles
4953 @cindex expirable mark
4955 All the following marks mark articles as read.
4960 @vindex gnus-del-mark
4961 These are articles that the user has marked as read with the @kbd{d}
4962 command manually, more or less (@code{gnus-del-mark}).
4965 @vindex gnus-read-mark
4966 Articles that have actually been read (@code{gnus-read-mark}).
4969 @vindex gnus-ancient-mark
4970 Articles that were marked as read in previous sessions and are now
4971 @dfn{old} (@code{gnus-ancient-mark}).
4974 @vindex gnus-killed-mark
4975 Marked as killed (@code{gnus-killed-mark}).
4978 @vindex gnus-kill-file-mark
4979 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4982 @vindex gnus-low-score-mark
4983 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4986 @vindex gnus-catchup-mark
4987 Marked as read by a catchup (@code{gnus-catchup-mark}).
4990 @vindex gnus-canceled-mark
4991 Canceled article (@code{gnus-canceled-mark})
4994 @vindex gnus-souped-mark
4995 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
4998 @vindex gnus-sparse-mark
4999 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
5003 @vindex gnus-duplicate-mark
5004 Article marked as read by duplicate suppression
5005 (@code{gnus-duplicated-mark}). @xref{Duplicate Suppression}.
5009 All these marks just mean that the article is marked as read, really.
5010 They are interpreted differently when doing adaptive scoring, though.
5012 One more special mark, though:
5016 @vindex gnus-expirable-mark
5017 Marked as expirable (@code{gnus-expirable-mark}).
5019 Marking articles as @dfn{expirable} (or have them marked as such
5020 automatically) doesn't make much sense in normal groups---a user doesn't
5021 control expiring of news articles, but in mail groups, for instance,
5022 articles marked as @dfn{expirable} can be deleted by Gnus at
5028 @subsection Other Marks
5029 @cindex process mark
5032 There are some marks that have nothing to do with whether the article is
5038 You can set a bookmark in the current article. Say you are reading a
5039 long thesis on cats' urinary tracts, and have to go home for dinner
5040 before you've finished reading the thesis. You can then set a bookmark
5041 in the article, and Gnus will jump to this bookmark the next time it
5042 encounters the article. @xref{Setting Marks}.
5045 @vindex gnus-replied-mark
5046 All articles that you have replied to or made a followup to (i.e., have
5047 answered) will be marked with an @samp{A} in the second column
5048 (@code{gnus-replied-mark}).
5050 @vindex gnus-forwarded-mark
5051 All articles that you have forwarded will be marked with an @samp{O} in
5052 the second column (@code{gnus-forwarded-mark}).
5055 @vindex gnus-cached-mark
5056 Articles stored in the article cache will be marked with an @samp{*} in
5057 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
5060 @vindex gnus-saved-mark
5061 Articles ``saved'' (in some manner or other; not necessarily
5062 religiously) are marked with an @samp{S} in the second column
5063 (@code{gnus-saved-mark}).
5066 @vindex gnus-not-empty-thread-mark
5067 @vindex gnus-empty-thread-mark
5068 If the @samp{%e} spec is used, the presence of threads or not will be
5069 marked with @code{gnus-not-empty-thread-mark} and
5070 @code{gnus-empty-thread-mark} in the third column, respectively.
5073 @vindex gnus-process-mark
5074 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
5075 variety of commands react to the presence of the process mark. For
5076 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5077 all articles that have been marked with the process mark. Articles
5078 marked with the process mark have a @samp{#} in the second column.
5082 You might have noticed that most of these ``non-readedness'' marks
5083 appear in the second column by default. So if you have a cached, saved,
5084 replied article that you have process-marked, what will that look like?
5086 Nothing much. The precedence rules go as follows: process -> cache ->
5087 replied -> saved. So if the article is in the cache and is replied,
5088 you'll only see the cache mark and not the replied mark.
5092 @subsection Setting Marks
5093 @cindex setting marks
5095 All the marking commands understand the numeric prefix.
5100 @kindex M c (Summary)
5101 @kindex M-u (Summary)
5102 @findex gnus-summary-clear-mark-forward
5103 @cindex mark as unread
5104 Clear all readedness-marks from the current article
5105 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
5111 @kindex M t (Summary)
5112 @findex gnus-summary-tick-article-forward
5113 Tick the current article (@code{gnus-summary-tick-article-forward}).
5114 @xref{Article Caching}.
5119 @kindex M ? (Summary)
5120 @findex gnus-summary-mark-as-dormant
5121 Mark the current article as dormant
5122 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
5126 @kindex M d (Summary)
5128 @findex gnus-summary-mark-as-read-forward
5129 Mark the current article as read
5130 (@code{gnus-summary-mark-as-read-forward}).
5134 @findex gnus-summary-mark-as-read-backward
5135 Mark the current article as read and move point to the previous line
5136 (@code{gnus-summary-mark-as-read-backward}).
5141 @kindex M k (Summary)
5142 @findex gnus-summary-kill-same-subject-and-select
5143 Mark all articles that have the same subject as the current one as read,
5144 and then select the next unread article
5145 (@code{gnus-summary-kill-same-subject-and-select}).
5149 @kindex M K (Summary)
5150 @kindex C-k (Summary)
5151 @findex gnus-summary-kill-same-subject
5152 Mark all articles that have the same subject as the current one as read
5153 (@code{gnus-summary-kill-same-subject}).
5156 @kindex M C (Summary)
5157 @findex gnus-summary-catchup
5158 @c @icon{gnus-summary-catchup}
5159 Mark all unread articles as read (@code{gnus-summary-catchup}).
5162 @kindex M C-c (Summary)
5163 @findex gnus-summary-catchup-all
5164 Mark all articles in the group as read---even the ticked and dormant
5165 articles (@code{gnus-summary-catchup-all}).
5168 @kindex M H (Summary)
5169 @findex gnus-summary-catchup-to-here
5170 Catchup the current group to point
5171 (@code{gnus-summary-catchup-to-here}).
5174 @kindex C-w (Summary)
5175 @findex gnus-summary-mark-region-as-read
5176 Mark all articles between point and mark as read
5177 (@code{gnus-summary-mark-region-as-read}).
5180 @kindex M V k (Summary)
5181 @findex gnus-summary-kill-below
5182 Kill all articles with scores below the default score (or below the
5183 numeric prefix) (@code{gnus-summary-kill-below}).
5187 @kindex M e (Summary)
5189 @findex gnus-summary-mark-as-expirable
5190 Mark the current article as expirable
5191 (@code{gnus-summary-mark-as-expirable}).
5194 @kindex M b (Summary)
5195 @findex gnus-summary-set-bookmark
5196 Set a bookmark in the current article
5197 (@code{gnus-summary-set-bookmark}).
5200 @kindex M B (Summary)
5201 @findex gnus-summary-remove-bookmark
5202 Remove the bookmark from the current article
5203 (@code{gnus-summary-remove-bookmark}).
5206 @kindex M V c (Summary)
5207 @findex gnus-summary-clear-above
5208 Clear all marks from articles with scores over the default score (or
5209 over the numeric prefix) (@code{gnus-summary-clear-above}).
5212 @kindex M V u (Summary)
5213 @findex gnus-summary-tick-above
5214 Tick all articles with scores over the default score (or over the
5215 numeric prefix) (@code{gnus-summary-tick-above}).
5218 @kindex M V m (Summary)
5219 @findex gnus-summary-mark-above
5220 Prompt for a mark, and mark all articles with scores over the default
5221 score (or over the numeric prefix) with this mark
5222 (@code{gnus-summary-clear-above}).
5225 @vindex gnus-summary-goto-unread
5226 The @code{gnus-summary-goto-unread} variable controls what action should
5227 be taken after setting a mark. If non-@code{nil}, point will move to
5228 the next/previous unread article. If @code{nil}, point will just move
5229 one line up or down. As a special case, if this variable is
5230 @code{never}, all the marking commands as well as other commands (like
5231 @kbd{SPACE}) will move to the next article, whether it is unread or not.
5232 The default is @code{t}.
5235 @node Generic Marking Commands
5236 @subsection Generic Marking Commands
5238 Some people would like the command that ticks an article (@kbd{!}) go to
5239 the next article. Others would like it to go to the next unread
5240 article. Yet others would like it to stay on the current article. And
5241 even though I haven't heard of anybody wanting it to go to the
5242 previous (unread) article, I'm sure there are people that want that as
5245 Multiply these five behaviors with five different marking commands, and
5246 you get a potentially complex set of variable to control what each
5249 To sidestep that mess, Gnus provides commands that do all these
5250 different things. They can be found on the @kbd{M M} map in the summary
5251 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
5252 to list in this manual.
5254 While you can use these commands directly, most users would prefer
5255 altering the summary mode keymap. For instance, if you would like the
5256 @kbd{!} command to go to the next article instead of the next unread
5257 article, you could say something like:
5260 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
5261 (defun my-alter-summary-map ()
5262 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
5268 (defun my-alter-summary-map ()
5269 (local-set-key "!" "MM!n"))
5273 @node Setting Process Marks
5274 @subsection Setting Process Marks
5275 @cindex setting process marks
5282 @kindex M P p (Summary)
5283 @findex gnus-summary-mark-as-processable
5284 Mark the current article with the process mark
5285 (@code{gnus-summary-mark-as-processable}).
5286 @findex gnus-summary-unmark-as-processable
5290 @kindex M P u (Summary)
5291 @kindex M-# (Summary)
5292 Remove the process mark, if any, from the current article
5293 (@code{gnus-summary-unmark-as-processable}).
5296 @kindex M P U (Summary)
5297 @findex gnus-summary-unmark-all-processable
5298 Remove the process mark from all articles
5299 (@code{gnus-summary-unmark-all-processable}).
5302 @kindex M P i (Summary)
5303 @findex gnus-uu-invert-processable
5304 Invert the list of process marked articles
5305 (@code{gnus-uu-invert-processable}).
5308 @kindex M P R (Summary)
5309 @findex gnus-uu-mark-by-regexp
5310 Mark articles that have a @code{Subject} header that matches a regular
5311 expression (@code{gnus-uu-mark-by-regexp}).
5314 @kindex M P G (Summary)
5315 @findex gnus-uu-unmark-by-regexp
5316 Unmark articles that have a @code{Subject} header that matches a regular
5317 expression (@code{gnus-uu-unmark-by-regexp}).
5320 @kindex M P r (Summary)
5321 @findex gnus-uu-mark-region
5322 Mark articles in region (@code{gnus-uu-mark-region}).
5325 @kindex M P t (Summary)
5326 @findex gnus-uu-mark-thread
5327 Mark all articles in the current (sub)thread
5328 (@code{gnus-uu-mark-thread}).
5331 @kindex M P T (Summary)
5332 @findex gnus-uu-unmark-thread
5333 Unmark all articles in the current (sub)thread
5334 (@code{gnus-uu-unmark-thread}).
5337 @kindex M P v (Summary)
5338 @findex gnus-uu-mark-over
5339 Mark all articles that have a score above the prefix argument
5340 (@code{gnus-uu-mark-over}).
5343 @kindex M P s (Summary)
5344 @findex gnus-uu-mark-series
5345 Mark all articles in the current series (@code{gnus-uu-mark-series}).
5348 @kindex M P S (Summary)
5349 @findex gnus-uu-mark-sparse
5350 Mark all series that have already had some articles marked
5351 (@code{gnus-uu-mark-sparse}).
5354 @kindex M P a (Summary)
5355 @findex gnus-uu-mark-all
5356 Mark all articles in series order (@code{gnus-uu-mark-series}).
5359 @kindex M P b (Summary)
5360 @findex gnus-uu-mark-buffer
5361 Mark all articles in the buffer in the order they appear
5362 (@code{gnus-uu-mark-buffer}).
5365 @kindex M P k (Summary)
5366 @findex gnus-summary-kill-process-mark
5367 Push the current process mark set onto the stack and unmark all articles
5368 (@code{gnus-summary-kill-process-mark}).
5371 @kindex M P y (Summary)
5372 @findex gnus-summary-yank-process-mark
5373 Pop the previous process mark set from the stack and restore it
5374 (@code{gnus-summary-yank-process-mark}).
5377 @kindex M P w (Summary)
5378 @findex gnus-summary-save-process-mark
5379 Push the current process mark set onto the stack
5380 (@code{gnus-summary-save-process-mark}).
5384 Also see the @kbd{&} command in @pxref{Searching for Articles} for how to
5385 set process marks based on article body contents.
5392 It can be convenient to limit the summary buffer to just show some
5393 subset of the articles currently in the group. The effect most limit
5394 commands have is to remove a few (or many) articles from the summary
5397 All limiting commands work on subsets of the articles already fetched
5398 from the servers. None of these commands query the server for
5399 additional articles.
5405 @kindex / / (Summary)
5406 @findex gnus-summary-limit-to-subject
5407 Limit the summary buffer to articles that match some subject
5408 (@code{gnus-summary-limit-to-subject}).
5411 @kindex / a (Summary)
5412 @findex gnus-summary-limit-to-author
5413 Limit the summary buffer to articles that match some author
5414 (@code{gnus-summary-limit-to-author}).
5417 @kindex / x (Summary)
5418 @findex gnus-summary-limit-to-extra
5419 Limit the summary buffer to articles that match one of the ``extra''
5420 headers (@pxref{To From Newsgroups})
5421 (@code{gnus-summary-limit-to-extra}).
5425 @kindex / u (Summary)
5427 @findex gnus-summary-limit-to-unread
5428 Limit the summary buffer to articles not marked as read
5429 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
5430 buffer to articles strictly unread. This means that ticked and
5431 dormant articles will also be excluded.
5434 @kindex / m (Summary)
5435 @findex gnus-summary-limit-to-marks
5436 Ask for a mark and then limit to all articles that have been marked
5437 with that mark (@code{gnus-summary-limit-to-marks}).
5440 @kindex / t (Summary)
5441 @findex gnus-summary-limit-to-age
5442 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
5443 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
5444 articles younger than that number of days.
5447 @kindex / n (Summary)
5448 @findex gnus-summary-limit-to-articles
5449 Limit the summary buffer to the current article
5450 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
5451 convention (@pxref{Process/Prefix}).
5454 @kindex / w (Summary)
5455 @findex gnus-summary-pop-limit
5456 Pop the previous limit off the stack and restore it
5457 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
5461 @kindex / v (Summary)
5462 @findex gnus-summary-limit-to-score
5463 Limit the summary buffer to articles that have a score at or above some
5464 score (@code{gnus-summary-limit-to-score}).
5468 @kindex M S (Summary)
5469 @kindex / E (Summary)
5470 @findex gnus-summary-limit-include-expunged
5471 Include all expunged articles in the limit
5472 (@code{gnus-summary-limit-include-expunged}).
5475 @kindex / D (Summary)
5476 @findex gnus-summary-limit-include-dormant
5477 Include all dormant articles in the limit
5478 (@code{gnus-summary-limit-include-dormant}).
5481 @kindex / * (Summary)
5482 @findex gnus-summary-limit-include-cached
5483 Include all cached articles in the limit
5484 (@code{gnus-summary-limit-include-cached}).
5487 @kindex / d (Summary)
5488 @findex gnus-summary-limit-exclude-dormant
5489 Exclude all dormant articles from the limit
5490 (@code{gnus-summary-limit-exclude-dormant}).
5493 @kindex / M (Summary)
5494 @findex gnus-summary-limit-exclude-marks
5495 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
5498 @kindex / T (Summary)
5499 @findex gnus-summary-limit-include-thread
5500 Include all the articles in the current thread in the limit.
5503 @kindex / c (Summary)
5504 @findex gnus-summary-limit-exclude-childless-dormant
5505 Exclude all dormant articles that have no children from the limit
5506 (@code{gnus-summary-limit-exclude-childless-dormant}).
5509 @kindex / C (Summary)
5510 @findex gnus-summary-limit-mark-excluded-as-read
5511 Mark all excluded unread articles as read
5512 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
5513 also mark excluded ticked and dormant articles as read.
5521 @cindex article threading
5523 Gnus threads articles by default. @dfn{To thread} is to put responses
5524 to articles directly after the articles they respond to---in a
5525 hierarchical fashion.
5527 Threading is done by looking at the @code{References} headers of the
5528 articles. In a perfect world, this would be enough to build pretty
5529 trees, but unfortunately, the @code{References} header is often broken
5530 or simply missing. Weird news propagation exacerbates the problem,
5531 so one has to employ other heuristics to get pleasing results. A
5532 plethora of approaches exists, as detailed in horrible detail in
5533 @pxref{Customizing Threading}.
5535 First, a quick overview of the concepts:
5539 The top-most article in a thread; the first article in the thread.
5542 A tree-like article structure.
5545 A small(er) section of this tree-like structure.
5548 Threads often lose their roots due to article expiry, or due to the root
5549 already having been read in a previous session, and not displayed in the
5550 summary buffer. We then typically have many sub-threads that really
5551 belong to one thread, but are without connecting roots. These are
5552 called loose threads.
5554 @item thread gathering
5555 An attempt to gather loose threads into bigger threads.
5557 @item sparse threads
5558 A thread where the missing articles have been ``guessed'' at, and are
5559 displayed as empty lines in the summary buffer.
5565 * Customizing Threading:: Variables you can change to affect the threading.
5566 * Thread Commands:: Thread based commands in the summary buffer.
5570 @node Customizing Threading
5571 @subsection Customizing Threading
5572 @cindex customizing threading
5575 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
5576 * Filling In Threads:: Making the threads displayed look fuller.
5577 * More Threading:: Even more variables for fiddling with threads.
5578 * Low-Level Threading:: You thought it was over... but you were wrong!
5583 @subsubsection Loose Threads
5586 @cindex loose threads
5589 @item gnus-summary-make-false-root
5590 @vindex gnus-summary-make-false-root
5591 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
5592 and create a dummy root at the top. (Wait a minute. Root at the top?
5593 Yup.) Loose subtrees occur when the real root has expired, or you've
5594 read or killed the root in a previous session.
5596 When there is no real root of a thread, Gnus will have to fudge
5597 something. This variable says what fudging method Gnus should use.
5598 There are four possible values:
5602 \gnusfigure{The Summary Buffer}{390}{
5603 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
5604 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
5605 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
5606 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
5611 @cindex adopting articles
5616 Gnus will make the first of the orphaned articles the parent. This
5617 parent will adopt all the other articles. The adopted articles will be
5618 marked as such by pointy brackets (@samp{<>}) instead of the standard
5619 square brackets (@samp{[]}). This is the default method.
5622 @vindex gnus-summary-dummy-line-format
5623 Gnus will create a dummy summary line that will pretend to be the
5624 parent. This dummy line does not correspond to any real article, so
5625 selecting it will just select the first real article after the dummy
5626 article. @code{gnus-summary-dummy-line-format} is used to specify the
5627 format of the dummy roots. It accepts only one format spec: @samp{S},
5628 which is the subject of the article. @xref{Formatting Variables}.
5631 Gnus won't actually make any article the parent, but simply leave the
5632 subject field of all orphans except the first empty. (Actually, it will
5633 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
5637 Don't make any article parent at all. Just gather the threads and
5638 display them after one another.
5641 Don't gather loose threads.
5644 @item gnus-summary-gather-subject-limit
5645 @vindex gnus-summary-gather-subject-limit
5646 Loose threads are gathered by comparing subjects of articles. If this
5647 variable is @code{nil}, Gnus requires an exact match between the
5648 subjects of the loose threads before gathering them into one big
5649 super-thread. This might be too strict a requirement, what with the
5650 presence of stupid newsreaders that chop off long subject lines. If
5651 you think so, set this variable to, say, 20 to require that only the
5652 first 20 characters of the subjects have to match. If you set this
5653 variable to a really low number, you'll find that Gnus will gather
5654 everything in sight into one thread, which isn't very helpful.
5656 @cindex fuzzy article gathering
5657 If you set this variable to the special value @code{fuzzy}, Gnus will
5658 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
5661 @item gnus-simplify-subject-fuzzy-regexp
5662 @vindex gnus-simplify-subject-fuzzy-regexp
5663 This can either be a regular expression or list of regular expressions
5664 that match strings that will be removed from subjects if fuzzy subject
5665 simplification is used.
5667 @item gnus-simplify-ignored-prefixes
5668 @vindex gnus-simplify-ignored-prefixes
5669 If you set @code{gnus-summary-gather-subject-limit} to something as low
5670 as 10, you might consider setting this variable to something sensible:
5672 @c Written by Michael Ernst <mernst@cs.rice.edu>
5674 (setq gnus-simplify-ignored-prefixes
5680 "wanted" "followup" "summary\\( of\\)?"
5681 "help" "query" "problem" "question"
5682 "answer" "reference" "announce"
5683 "How can I" "How to" "Comparison of"
5688 (mapconcat 'identity
5689 '("for" "for reference" "with" "about")
5691 "\\)?\\]?:?[ \t]*"))
5694 All words that match this regexp will be removed before comparing two
5697 @item gnus-simplify-subject-functions
5698 @vindex gnus-simplify-subject-functions
5699 If non-@code{nil}, this variable overrides
5700 @code{gnus-summary-gather-subject-limit}. This variable should be a
5701 list of functions to apply to the @code{Subject} string iteratively to
5702 arrive at the simplified version of the string.
5704 Useful functions to put in this list include:
5707 @item gnus-simplify-subject-re
5708 @findex gnus-simplify-subject-re
5709 Strip the leading @samp{Re:}.
5711 @item gnus-simplify-subject-fuzzy
5712 @findex gnus-simplify-subject-fuzzy
5715 @item gnus-simplify-whitespace
5716 @findex gnus-simplify-whitespace
5717 Remove excessive whitespace.
5720 You may also write your own functions, of course.
5723 @item gnus-summary-gather-exclude-subject
5724 @vindex gnus-summary-gather-exclude-subject
5725 Since loose thread gathering is done on subjects only, that might lead
5726 to many false hits, especially with certain common subjects like
5727 @samp{} and @samp{(none)}. To make the situation slightly better,
5728 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
5729 what subjects should be excluded from the gathering process.@*
5730 The default is @samp{^ *$\\|^(none)$}.
5732 @item gnus-summary-thread-gathering-function
5733 @vindex gnus-summary-thread-gathering-function
5734 Gnus gathers threads by looking at @code{Subject} headers. This means
5735 that totally unrelated articles may end up in the same ``thread'', which
5736 is confusing. An alternate approach is to look at all the
5737 @code{Message-ID}s in all the @code{References} headers to find matches.
5738 This will ensure that no gathered threads ever include unrelated
5739 articles, but it also means that people who have posted with broken
5740 newsreaders won't be gathered properly. The choice is yours---plague or
5744 @item gnus-gather-threads-by-subject
5745 @findex gnus-gather-threads-by-subject
5746 This function is the default gathering function and looks at
5747 @code{Subject}s exclusively.
5749 @item gnus-gather-threads-by-references
5750 @findex gnus-gather-threads-by-references
5751 This function looks at @code{References} headers exclusively.
5754 If you want to test gathering by @code{References}, you could say
5758 (setq gnus-summary-thread-gathering-function
5759 'gnus-gather-threads-by-references)
5765 @node Filling In Threads
5766 @subsubsection Filling In Threads
5769 @item gnus-fetch-old-headers
5770 @vindex gnus-fetch-old-headers
5771 If non-@code{nil}, Gnus will attempt to build old threads by fetching
5772 more old headers---headers to articles marked as read. If you
5773 would like to display as few summary lines as possible, but still
5774 connect as many loose threads as possible, you should set this variable
5775 to @code{some} or a number. If you set it to a number, no more than
5776 that number of extra old headers will be fetched. In either case,
5777 fetching old headers only works if the backend you are using carries
5778 overview files---this would normally be @code{nntp}, @code{nnspool} and
5779 @code{nnml}. Also remember that if the root of the thread has been
5780 expired by the server, there's not much Gnus can do about that.
5782 This variable can also be set to @code{invisible}. This won't have any
5783 visible effects, but is useful if you use the @kbd{A T} command a lot
5784 (@pxref{Finding the Parent}).
5786 @item gnus-build-sparse-threads
5787 @vindex gnus-build-sparse-threads
5788 Fetching old headers can be slow. A low-rent similar effect can be
5789 gotten by setting this variable to @code{some}. Gnus will then look at
5790 the complete @code{References} headers of all articles and try to string
5791 together articles that belong in the same thread. This will leave
5792 @dfn{gaps} in the threading display where Gnus guesses that an article
5793 is missing from the thread. (These gaps appear like normal summary
5794 lines. If you select a gap, Gnus will try to fetch the article in
5795 question.) If this variable is @code{t}, Gnus will display all these
5796 ``gaps'' without regard for whether they are useful for completing the
5797 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
5798 off sparse leaf nodes that don't lead anywhere. This variable is
5799 @code{nil} by default.
5804 @node More Threading
5805 @subsubsection More Threading
5808 @item gnus-show-threads
5809 @vindex gnus-show-threads
5810 If this variable is @code{nil}, no threading will be done, and all of
5811 the rest of the variables here will have no effect. Turning threading
5812 off will speed group selection up a bit, but it is sure to make reading
5813 slower and more awkward.
5815 @item gnus-thread-hide-subtree
5816 @vindex gnus-thread-hide-subtree
5817 If non-@code{nil}, all threads will be hidden when the summary buffer is
5820 @item gnus-thread-expunge-below
5821 @vindex gnus-thread-expunge-below
5822 All threads that have a total score (as defined by
5823 @code{gnus-thread-score-function}) less than this number will be
5824 expunged. This variable is @code{nil} by default, which means that no
5825 threads are expunged.
5827 @item gnus-thread-hide-killed
5828 @vindex gnus-thread-hide-killed
5829 if you kill a thread and this variable is non-@code{nil}, the subtree
5832 @item gnus-thread-ignore-subject
5833 @vindex gnus-thread-ignore-subject
5834 Sometimes somebody changes the subject in the middle of a thread. If
5835 this variable is non-@code{nil}, which is the default, the subject
5836 change is ignored. If it is @code{nil}, a change in the subject will
5837 result in a new thread.
5839 @item gnus-thread-indent-level
5840 @vindex gnus-thread-indent-level
5841 This is a number that says how much each sub-thread should be indented.
5844 @item gnus-sort-gathered-threads-function
5845 @vindex gnus-sort-gathered-threads-function
5846 Sometimes, particularly with mailing lists, the order in which mails
5847 arrive locally is not necessarily the same as the order in which they
5848 arrived on the mailing list. Consequently, when sorting sub-threads
5849 using the default @code{gnus-thread-sort-by-number}, responses can end
5850 up appearing before the article to which they are responding to.
5851 Setting this variable to an alternate value
5852 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
5853 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
5854 more logical sub-thread ordering in such instances.
5859 @node Low-Level Threading
5860 @subsubsection Low-Level Threading
5864 @item gnus-parse-headers-hook
5865 @vindex gnus-parse-headers-hook
5866 Hook run before parsing any headers.
5868 @item gnus-alter-header-function
5869 @vindex gnus-alter-header-function
5870 If non-@code{nil}, this function will be called to allow alteration of
5871 article header structures. The function is called with one parameter,
5872 the article header vector, which it may alter in any way. For instance,
5873 if you have a mail-to-news gateway which alters the @code{Message-ID}s
5874 in systematic ways (by adding prefixes and such), you can use this
5875 variable to un-scramble the @code{Message-ID}s so that they are more
5876 meaningful. Here's one example:
5879 (setq gnus-alter-header-function 'my-alter-message-id)
5881 (defun my-alter-message-id (header)
5882 (let ((id (mail-header-id header)))
5884 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
5886 (concat (match-string 1 id) "@@" (match-string 2 id))
5893 @node Thread Commands
5894 @subsection Thread Commands
5895 @cindex thread commands
5901 @kindex T k (Summary)
5902 @kindex M-C-k (Summary)
5903 @findex gnus-summary-kill-thread
5904 Mark all articles in the current (sub-)thread as read
5905 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
5906 remove all marks instead. If the prefix argument is negative, tick
5911 @kindex T l (Summary)
5912 @kindex M-C-l (Summary)
5913 @findex gnus-summary-lower-thread
5914 Lower the score of the current (sub-)thread
5915 (@code{gnus-summary-lower-thread}).
5918 @kindex T i (Summary)
5919 @findex gnus-summary-raise-thread
5920 Increase the score of the current (sub-)thread
5921 (@code{gnus-summary-raise-thread}).
5924 @kindex T # (Summary)
5925 @findex gnus-uu-mark-thread
5926 Set the process mark on the current (sub-)thread
5927 (@code{gnus-uu-mark-thread}).
5930 @kindex T M-# (Summary)
5931 @findex gnus-uu-unmark-thread
5932 Remove the process mark from the current (sub-)thread
5933 (@code{gnus-uu-unmark-thread}).
5936 @kindex T T (Summary)
5937 @findex gnus-summary-toggle-threads
5938 Toggle threading (@code{gnus-summary-toggle-threads}).
5941 @kindex T s (Summary)
5942 @findex gnus-summary-show-thread
5943 Expose the (sub-)thread hidden under the current article, if any
5944 (@code{gnus-summary-show-thread}).
5947 @kindex T h (Summary)
5948 @findex gnus-summary-hide-thread
5949 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5952 @kindex T S (Summary)
5953 @findex gnus-summary-show-all-threads
5954 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5957 @kindex T H (Summary)
5958 @findex gnus-summary-hide-all-threads
5959 Hide all threads (@code{gnus-summary-hide-all-threads}).
5962 @kindex T t (Summary)
5963 @findex gnus-summary-rethread-current
5964 Re-thread the current article's thread
5965 (@code{gnus-summary-rethread-current}). This works even when the
5966 summary buffer is otherwise unthreaded.
5969 @kindex T ^ (Summary)
5970 @findex gnus-summary-reparent-thread
5971 Make the current article the child of the marked (or previous) article
5972 (@code{gnus-summary-reparent-thread}).
5976 The following commands are thread movement commands. They all
5977 understand the numeric prefix.
5982 @kindex T n (Summary)
5984 @kindex M-C-n (Summary)
5986 @kindex M-down (Summary)
5987 @findex gnus-summary-next-thread
5988 Go to the next thread (@code{gnus-summary-next-thread}).
5991 @kindex T p (Summary)
5993 @kindex M-C-p (Summary)
5995 @kindex M-up (Summary)
5996 @findex gnus-summary-prev-thread
5997 Go to the previous thread (@code{gnus-summary-prev-thread}).
6000 @kindex T d (Summary)
6001 @findex gnus-summary-down-thread
6002 Descend the thread (@code{gnus-summary-down-thread}).
6005 @kindex T u (Summary)
6006 @findex gnus-summary-up-thread
6007 Ascend the thread (@code{gnus-summary-up-thread}).
6010 @kindex T o (Summary)
6011 @findex gnus-summary-top-thread
6012 Go to the top of the thread (@code{gnus-summary-top-thread}).
6015 @vindex gnus-thread-operation-ignore-subject
6016 If you ignore subject while threading, you'll naturally end up with
6017 threads that have several different subjects in them. If you then issue
6018 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
6019 wish to kill the entire thread, but just those parts of the thread that
6020 have the same subject as the current article. If you like this idea,
6021 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
6022 is non-@code{nil} (which it is by default), subjects will be ignored
6023 when doing thread commands. If this variable is @code{nil}, articles in
6024 the same thread with different subjects will not be included in the
6025 operation in question. If this variable is @code{fuzzy}, only articles
6026 that have subjects fuzzily equal will be included (@pxref{Fuzzy
6030 @node Sorting the Summary Buffer
6031 @section Sorting the Summary Buffer
6033 @findex gnus-thread-sort-by-total-score
6034 @findex gnus-thread-sort-by-date
6035 @findex gnus-thread-sort-by-score
6036 @findex gnus-thread-sort-by-subject
6037 @findex gnus-thread-sort-by-author
6038 @findex gnus-thread-sort-by-number
6039 @vindex gnus-thread-sort-functions
6040 If you are using a threaded summary display, you can sort the threads by
6041 setting @code{gnus-thread-sort-functions}, which can be either a single
6042 function, a list of functions, or a list containing functions and
6043 @code{(not some-function)} elements.
6045 By default, sorting is done on article numbers. Ready-made sorting
6046 predicate functions include @code{gnus-thread-sort-by-number},
6047 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
6048 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
6049 @code{gnus-thread-sort-by-total-score}.
6051 Each function takes two threads and returns non-@code{nil} if the first
6052 thread should be sorted before the other. Note that sorting really is
6053 normally done by looking only at the roots of each thread.
6055 If you use more than one function, the primary sort key should be the
6056 last function in the list. You should probably always include
6057 @code{gnus-thread-sort-by-number} in the list of sorting
6058 functions---preferably first. This will ensure that threads that are
6059 equal with respect to the other sort criteria will be displayed in
6060 ascending article order.
6062 If you would like to sort by reverse score, then by subject, and finally
6063 by number, you could do something like:
6066 (setq gnus-thread-sort-functions
6067 '(gnus-thread-sort-by-number
6068 gnus-thread-sort-by-subject
6069 (not gnus-thread-sort-by-total-score)))
6072 The threads that have highest score will be displayed first in the
6073 summary buffer. When threads have the same score, they will be sorted
6074 alphabetically. The threads that have the same score and the same
6075 subject will be sorted by number, which is (normally) the sequence in
6076 which the articles arrived.
6078 If you want to sort by score and then reverse arrival order, you could
6082 (setq gnus-thread-sort-functions
6084 (not (gnus-thread-sort-by-number t1 t2)))
6085 gnus-thread-sort-by-score))
6088 @vindex gnus-thread-score-function
6089 The function in the @code{gnus-thread-score-function} variable (default
6090 @code{+}) is used for calculating the total score of a thread. Useful
6091 functions might be @code{max}, @code{min}, or squared means, or whatever
6094 @findex gnus-article-sort-functions
6095 @findex gnus-article-sort-by-date
6096 @findex gnus-article-sort-by-score
6097 @findex gnus-article-sort-by-subject
6098 @findex gnus-article-sort-by-author
6099 @findex gnus-article-sort-by-number
6100 If you are using an unthreaded display for some strange reason or other,
6101 you have to fiddle with the @code{gnus-article-sort-functions} variable.
6102 It is very similar to the @code{gnus-thread-sort-functions}, except that
6103 it uses slightly different functions for article comparison. Available
6104 sorting predicate functions are @code{gnus-article-sort-by-number},
6105 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
6106 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
6108 If you want to sort an unthreaded summary display by subject, you could
6112 (setq gnus-article-sort-functions
6113 '(gnus-article-sort-by-number
6114 gnus-article-sort-by-subject))
6119 @node Asynchronous Fetching
6120 @section Asynchronous Article Fetching
6121 @cindex asynchronous article fetching
6122 @cindex article pre-fetch
6125 If you read your news from an @sc{nntp} server that's far away, the
6126 network latencies may make reading articles a chore. You have to wait
6127 for a while after pressing @kbd{n} to go to the next article before the
6128 article appears. Why can't Gnus just go ahead and fetch the article
6129 while you are reading the previous one? Why not, indeed.
6131 First, some caveats. There are some pitfalls to using asynchronous
6132 article fetching, especially the way Gnus does it.
6134 Let's say you are reading article 1, which is short, and article 2 is
6135 quite long, and you are not interested in reading that. Gnus does not
6136 know this, so it goes ahead and fetches article 2. You decide to read
6137 article 3, but since Gnus is in the process of fetching article 2, the
6138 connection is blocked.
6140 To avoid these situations, Gnus will open two (count 'em two)
6141 connections to the server. Some people may think this isn't a very nice
6142 thing to do, but I don't see any real alternatives. Setting up that
6143 extra connection takes some time, so Gnus startup will be slower.
6145 Gnus will fetch more articles than you will read. This will mean that
6146 the link between your machine and the @sc{nntp} server will become more
6147 loaded than if you didn't use article pre-fetch. The server itself will
6148 also become more loaded---both with the extra article requests, and the
6151 Ok, so now you know that you shouldn't really use this thing... unless
6154 @vindex gnus-asynchronous
6155 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
6156 happen automatically.
6158 @vindex gnus-use-article-prefetch
6159 You can control how many articles are to be pre-fetched by setting
6160 @code{gnus-use-article-prefetch}. This is 30 by default, which means
6161 that when you read an article in the group, the backend will pre-fetch
6162 the next 30 articles. If this variable is @code{t}, the backend will
6163 pre-fetch all the articles it can without bound. If it is
6164 @code{nil}, no pre-fetching will be done.
6166 @vindex gnus-async-prefetch-article-p
6167 @findex gnus-async-read-p
6168 There are probably some articles that you don't want to pre-fetch---read
6169 articles, for instance. The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched. This function should
6170 return non-@code{nil} when the article in question is to be
6171 pre-fetched. The default is @code{gnus-async-read-p}, which returns
6172 @code{nil} on read articles. The function is called with an article
6173 data structure as the only parameter.
6175 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
6178 (defun my-async-short-unread-p (data)
6179 "Return non-nil for short, unread articles."
6180 (and (gnus-data-unread-p data)
6181 (< (mail-header-lines (gnus-data-header data))
6184 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
6187 These functions will be called many, many times, so they should
6188 preferably be short and sweet to avoid slowing down Gnus too much.
6189 It's probably a good idea to byte-compile things like this.
6191 @vindex gnus-prefetched-article-deletion-strategy
6192 Articles have to be removed from the asynch buffer sooner or later. The
6193 @code{gnus-prefetched-article-deletion-strategy} says when to remove
6194 articles. This is a list that may contain the following elements:
6198 Remove articles when they are read.
6201 Remove articles when exiting the group.
6204 The default value is @code{(read exit)}.
6206 @c @vindex gnus-use-header-prefetch
6207 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
6208 @c from the next group.
6211 @node Article Caching
6212 @section Article Caching
6213 @cindex article caching
6216 If you have an @emph{extremely} slow @sc{nntp} connection, you may
6217 consider turning article caching on. Each article will then be stored
6218 locally under your home directory. As you may surmise, this could
6219 potentially use @emph{huge} amounts of disk space, as well as eat up all
6220 your inodes so fast it will make your head swim. In vodka.
6222 Used carefully, though, it could be just an easier way to save articles.
6224 @vindex gnus-use-long-file-name
6225 @vindex gnus-cache-directory
6226 @vindex gnus-use-cache
6227 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
6228 all articles ticked or marked as dormant will then be copied
6229 over to your local cache (@code{gnus-cache-directory}). Whether this
6230 cache is flat or hierarchical is controlled by the
6231 @code{gnus-use-long-file-name} variable, as usual.
6233 When re-selecting a ticked or dormant article, it will be fetched from the
6234 cache instead of from the server. As articles in your cache will never
6235 expire, this might serve as a method of saving articles while still
6236 keeping them where they belong. Just mark all articles you want to save
6237 as dormant, and don't worry.
6239 When an article is marked as read, is it removed from the cache.
6241 @vindex gnus-cache-remove-articles
6242 @vindex gnus-cache-enter-articles
6243 The entering/removal of articles from the cache is controlled by the
6244 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
6245 variables. Both are lists of symbols. The first is @code{(ticked
6246 dormant)} by default, meaning that ticked and dormant articles will be
6247 put in the cache. The latter is @code{(read)} by default, meaning that
6248 articles marked as read are removed from the cache. Possibly
6249 symbols in these two lists are @code{ticked}, @code{dormant},
6250 @code{unread} and @code{read}.
6252 @findex gnus-jog-cache
6253 So where does the massive article-fetching and storing come into the
6254 picture? The @code{gnus-jog-cache} command will go through all
6255 subscribed newsgroups, request all unread articles, score them, and
6256 store them in the cache. You should only ever, ever ever ever, use this
6257 command if 1) your connection to the @sc{nntp} server is really, really,
6258 really slow and 2) you have a really, really, really huge disk.
6259 Seriously. One way to cut down on the number of articles downloaded is
6260 to score unwanted articles down and have them marked as read. They will
6261 not then be downloaded by this command.
6263 @vindex gnus-uncacheable-groups
6264 @vindex gnus-cacheable-groups
6265 It is likely that you do not want caching on all groups. For instance,
6266 if your @code{nnml} mail is located under your home directory, it makes no
6267 sense to cache it somewhere else under your home directory. Unless you
6268 feel that it's neat to use twice as much space.
6270 To limit the caching, you could set @code{gnus-cacheable-groups} to a
6271 regexp of groups to cache, @samp{^nntp} for instance, or set the
6272 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
6273 Both variables are @code{nil} by default. If a group matches both
6274 variables, the group is not cached.
6276 @findex gnus-cache-generate-nov-databases
6277 @findex gnus-cache-generate-active
6278 @vindex gnus-cache-active-file
6279 The cache stores information on what articles it contains in its active
6280 file (@code{gnus-cache-active-file}). If this file (or any other parts
6281 of the cache) becomes all messed up for some reason or other, Gnus
6282 offers two functions that will try to set things right. @kbd{M-x
6283 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
6284 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
6288 @node Persistent Articles
6289 @section Persistent Articles
6290 @cindex persistent articles
6292 Closely related to article caching, we have @dfn{persistent articles}.
6293 In fact, it's just a different way of looking at caching, and much more
6294 useful in my opinion.
6296 Say you're reading a newsgroup, and you happen on to some valuable gem
6297 that you want to keep and treasure forever. You'd normally just save it
6298 (using one of the many saving commands) in some file. The problem with
6299 that is that it's just, well, yucky. Ideally you'd prefer just having
6300 the article remain in the group where you found it forever; untouched by
6301 the expiry going on at the news server.
6303 This is what a @dfn{persistent article} is---an article that just won't
6304 be deleted. It's implemented using the normal cache functions, but
6305 you use two explicit commands for managing persistent articles:
6311 @findex gnus-cache-enter-article
6312 Make the current article persistent (@code{gnus-cache-enter-article}).
6315 @kindex M-* (Summary)
6316 @findex gnus-cache-remove-article
6317 Remove the current article from the persistent articles
6318 (@code{gnus-cache-remove-article}). This will normally delete the
6322 Both these commands understand the process/prefix convention.
6324 To avoid having all ticked articles (and stuff) entered into the cache,
6325 you should set @code{gnus-use-cache} to @code{passive} if you're just
6326 interested in persistent articles:
6329 (setq gnus-use-cache 'passive)
6333 @node Article Backlog
6334 @section Article Backlog
6336 @cindex article backlog
6338 If you have a slow connection, but the idea of using caching seems
6339 unappealing to you (and it is, really), you can help the situation some
6340 by switching on the @dfn{backlog}. This is where Gnus will buffer
6341 already read articles so that it doesn't have to re-fetch articles
6342 you've already read. This only helps if you are in the habit of
6343 re-selecting articles you've recently read, of course. If you never do
6344 that, turning the backlog on will slow Gnus down a little bit, and
6345 increase memory usage some.
6347 @vindex gnus-keep-backlog
6348 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
6349 at most @var{n} old articles in a buffer for later re-fetching. If this
6350 variable is non-@code{nil} and is not a number, Gnus will store
6351 @emph{all} read articles, which means that your Emacs will grow without
6352 bound before exploding and taking your machine down with you. I put
6353 that in there just to keep y'all on your toes.
6355 This variable is @code{nil} by default.
6358 @node Saving Articles
6359 @section Saving Articles
6360 @cindex saving articles
6362 Gnus can save articles in a number of ways. Below is the documentation
6363 for saving articles in a fairly straight-forward fashion (i.e., little
6364 processing of the article is done before it is saved). For a different
6365 approach (uudecoding, unsharing) you should use @code{gnus-uu}
6366 (@pxref{Decoding Articles}).
6368 @vindex gnus-save-all-headers
6369 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
6370 unwanted headers before saving the article.
6372 @vindex gnus-saved-headers
6373 If the preceding variable is @code{nil}, all headers that match the
6374 @code{gnus-saved-headers} regexp will be kept, while the rest will be
6375 deleted before saving.
6381 @kindex O o (Summary)
6383 @findex gnus-summary-save-article
6384 @c @icon{gnus-summary-save-article}
6385 Save the current article using the default article saver
6386 (@code{gnus-summary-save-article}).
6389 @kindex O m (Summary)
6390 @findex gnus-summary-save-article-mail
6391 Save the current article in mail format
6392 (@code{gnus-summary-save-article-mail}).
6395 @kindex O r (Summary)
6396 @findex gnus-summary-save-article-rmail
6397 Save the current article in rmail format
6398 (@code{gnus-summary-save-article-rmail}).
6401 @kindex O f (Summary)
6402 @findex gnus-summary-save-article-file
6403 @c @icon{gnus-summary-save-article-file}
6404 Save the current article in plain file format
6405 (@code{gnus-summary-save-article-file}).
6408 @kindex O F (Summary)
6409 @findex gnus-summary-write-article-file
6410 Write the current article in plain file format, overwriting any previous
6411 file contents (@code{gnus-summary-write-article-file}).
6414 @kindex O b (Summary)
6415 @findex gnus-summary-save-article-body-file
6416 Save the current article body in plain file format
6417 (@code{gnus-summary-save-article-body-file}).
6420 @kindex O h (Summary)
6421 @findex gnus-summary-save-article-folder
6422 Save the current article in mh folder format
6423 (@code{gnus-summary-save-article-folder}).
6426 @kindex O v (Summary)
6427 @findex gnus-summary-save-article-vm
6428 Save the current article in a VM folder
6429 (@code{gnus-summary-save-article-vm}).
6432 @kindex O p (Summary)
6433 @findex gnus-summary-pipe-output
6434 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
6435 the current article to a process (@code{gnus-summary-pipe-output}).
6438 @vindex gnus-prompt-before-saving
6439 All these commands use the process/prefix convention
6440 (@pxref{Process/Prefix}). If you save bunches of articles using these
6441 functions, you might get tired of being prompted for files to save each
6442 and every article in. The prompting action is controlled by
6443 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
6444 default, giving you that excessive prompting action you know and
6445 loathe. If you set this variable to @code{t} instead, you'll be prompted
6446 just once for each series of articles you save. If you like to really
6447 have Gnus do all your thinking for you, you can even set this variable
6448 to @code{nil}, which means that you will never be prompted for files to
6449 save articles in. Gnus will simply save all the articles in the default
6453 @vindex gnus-default-article-saver
6454 You can customize the @code{gnus-default-article-saver} variable to make
6455 Gnus do what you want it to. You can use any of the six ready-made
6456 functions below, or you can create your own.
6460 @item gnus-summary-save-in-rmail
6461 @findex gnus-summary-save-in-rmail
6462 @vindex gnus-rmail-save-name
6463 @findex gnus-plain-save-name
6464 This is the default format, @dfn{babyl}. Uses the function in the
6465 @code{gnus-rmail-save-name} variable to get a file name to save the
6466 article in. The default is @code{gnus-plain-save-name}.
6468 @item gnus-summary-save-in-mail
6469 @findex gnus-summary-save-in-mail
6470 @vindex gnus-mail-save-name
6471 Save in a Unix mail (mbox) file. Uses the function in the
6472 @code{gnus-mail-save-name} variable to get a file name to save the
6473 article in. The default is @code{gnus-plain-save-name}.
6475 @item gnus-summary-save-in-file
6476 @findex gnus-summary-save-in-file
6477 @vindex gnus-file-save-name
6478 @findex gnus-numeric-save-name
6479 Append the article straight to an ordinary file. Uses the function in
6480 the @code{gnus-file-save-name} variable to get a file name to save the
6481 article in. The default is @code{gnus-numeric-save-name}.
6483 @item gnus-summary-save-body-in-file
6484 @findex gnus-summary-save-body-in-file
6485 Append the article body to an ordinary file. Uses the function in the
6486 @code{gnus-file-save-name} variable to get a file name to save the
6487 article in. The default is @code{gnus-numeric-save-name}.
6489 @item gnus-summary-save-in-folder
6490 @findex gnus-summary-save-in-folder
6491 @findex gnus-folder-save-name
6492 @findex gnus-Folder-save-name
6493 @vindex gnus-folder-save-name
6496 Save the article to an MH folder using @code{rcvstore} from the MH
6497 library. Uses the function in the @code{gnus-folder-save-name} variable
6498 to get a file name to save the article in. The default is
6499 @code{gnus-folder-save-name}, but you can also use
6500 @code{gnus-Folder-save-name}, which creates capitalized names.
6502 @item gnus-summary-save-in-vm
6503 @findex gnus-summary-save-in-vm
6504 Save the article in a VM folder. You have to have the VM mail
6505 reader to use this setting.
6508 @vindex gnus-article-save-directory
6509 All of these functions, except for the last one, will save the article
6510 in the @code{gnus-article-save-directory}, which is initialized from the
6511 @code{SAVEDIR} environment variable. This is @file{~/News/} by
6514 As you can see above, the functions use different functions to find a
6515 suitable name of a file to save the article in. Below is a list of
6516 available functions that generate names:
6520 @item gnus-Numeric-save-name
6521 @findex gnus-Numeric-save-name
6522 File names like @file{~/News/Alt.andrea-dworkin/45}.
6524 @item gnus-numeric-save-name
6525 @findex gnus-numeric-save-name
6526 File names like @file{~/News/alt.andrea-dworkin/45}.
6528 @item gnus-Plain-save-name
6529 @findex gnus-Plain-save-name
6530 File names like @file{~/News/Alt.andrea-dworkin}.
6532 @item gnus-plain-save-name
6533 @findex gnus-plain-save-name
6534 File names like @file{~/News/alt.andrea-dworkin}.
6536 @item gnus-sender-save-name
6537 @findex gnus-sender-save-name
6538 File names like @file{~/News/larsi}.
6541 @vindex gnus-split-methods
6542 You can have Gnus suggest where to save articles by plonking a regexp into
6543 the @code{gnus-split-methods} alist. For instance, if you would like to
6544 save articles related to Gnus in the file @file{gnus-stuff}, and articles
6545 related to VM in @code{vm-stuff}, you could set this variable to something
6549 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
6550 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
6551 (my-choosing-function "../other-dir/my-stuff")
6552 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
6555 We see that this is a list where each element is a list that has two
6556 elements---the @dfn{match} and the @dfn{file}. The match can either be
6557 a string (in which case it is used as a regexp to match on the article
6558 head); it can be a symbol (which will be called as a function with the
6559 group name as a parameter); or it can be a list (which will be
6560 @code{eval}ed). If any of these actions have a non-@code{nil} result,
6561 the @dfn{file} will be used as a default prompt. In addition, the
6562 result of the operation itself will be used if the function or form
6563 called returns a string or a list of strings.
6565 You basically end up with a list of file names that might be used when
6566 saving the current article. (All ``matches'' will be used.) You will
6567 then be prompted for what you really want to use as a name, with file
6568 name completion over the results from applying this variable.
6570 This variable is @code{((gnus-article-archive-name))} by default, which
6571 means that Gnus will look at the articles it saves for an
6572 @code{Archive-name} line and use that as a suggestion for the file
6575 Here's an example function to clean up file names somewhat. If you have
6576 lots of mail groups called things like
6577 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
6578 these group names before creating the file name to save to. The
6579 following will do just that:
6582 (defun my-save-name (group)
6583 (when (string-match "^nnml:mail." group)
6584 (substring group (match-end 0))))
6586 (setq gnus-split-methods
6587 '((gnus-article-archive-name)
6592 @vindex gnus-use-long-file-name
6593 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
6594 @code{nil}, all the preceding functions will replace all periods
6595 (@samp{.}) in the group names with slashes (@samp{/})---which means that
6596 the functions will generate hierarchies of directories instead of having
6597 all the files in the top level directory
6598 (@file{~/News/alt/andrea-dworkin} instead of
6599 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
6600 on most systems. However, for historical reasons, this is @code{nil} on
6601 Xenix and usg-unix-v machines by default.
6603 This function also affects kill and score file names. If this variable
6604 is a list, and the list contains the element @code{not-score}, long file
6605 names will not be used for score files, if it contains the element
6606 @code{not-save}, long file names will not be used for saving, and if it
6607 contains the element @code{not-kill}, long file names will not be used
6610 If you'd like to save articles in a hierarchy that looks something like
6614 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
6615 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
6618 Then just save with @kbd{o}. You'd then read this hierarchy with
6619 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
6620 the top level directory as the argument (@file{~/News/}). Then just walk
6621 around to the groups/directories with @code{nneething}.
6624 @node Decoding Articles
6625 @section Decoding Articles
6626 @cindex decoding articles
6628 Sometime users post articles (or series of articles) that have been
6629 encoded in some way or other. Gnus can decode them for you.
6632 * Uuencoded Articles:: Uudecode articles.
6633 * Shell Archives:: Unshar articles.
6634 * PostScript Files:: Split PostScript.
6635 * Other Files:: Plain save and binhex.
6636 * Decoding Variables:: Variables for a happy decoding.
6637 * Viewing Files:: You want to look at the result of the decoding?
6641 @cindex article series
6642 All these functions use the process/prefix convention
6643 (@pxref{Process/Prefix}) for finding out what articles to work on, with
6644 the extension that a ``single article'' means ``a single series''. Gnus
6645 can find out by itself what articles belong to a series, decode all the
6646 articles and unpack/view/save the resulting file(s).
6648 Gnus guesses what articles are in the series according to the following
6649 simplish rule: The subjects must be (nearly) identical, except for the
6650 last two numbers of the line. (Spaces are largely ignored, however.)
6652 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
6653 will find all the articles that match the regexp @samp{^cat.gif
6654 ([0-9]+/[0-9]+).*$}.
6656 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
6657 series}, will not be properly recognized by any of the automatic viewing
6658 commands, and you have to mark the articles manually with @kbd{#}.
6661 @node Uuencoded Articles
6662 @subsection Uuencoded Articles
6664 @cindex uuencoded articles
6669 @kindex X u (Summary)
6670 @findex gnus-uu-decode-uu
6671 @c @icon{gnus-uu-decode-uu}
6672 Uudecodes the current series (@code{gnus-uu-decode-uu}).
6675 @kindex X U (Summary)
6676 @findex gnus-uu-decode-uu-and-save
6677 Uudecodes and saves the current series
6678 (@code{gnus-uu-decode-uu-and-save}).
6681 @kindex X v u (Summary)
6682 @findex gnus-uu-decode-uu-view
6683 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
6686 @kindex X v U (Summary)
6687 @findex gnus-uu-decode-uu-and-save-view
6688 Uudecodes, views and saves the current series
6689 (@code{gnus-uu-decode-uu-and-save-view}).
6693 Remember that these all react to the presence of articles marked with
6694 the process mark. If, for instance, you'd like to decode and save an
6695 entire newsgroup, you'd typically do @kbd{M P a}
6696 (@code{gnus-uu-mark-all}) and then @kbd{X U}
6697 (@code{gnus-uu-decode-uu-and-save}).
6699 All this is very much different from how @code{gnus-uu} worked with
6700 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
6701 the sun. This version of @code{gnus-uu} generally assumes that you mark
6702 articles in some way (@pxref{Setting Process Marks}) and then press
6705 @vindex gnus-uu-notify-files
6706 Note: When trying to decode articles that have names matching
6707 @code{gnus-uu-notify-files}, which is hard-coded to
6708 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
6709 automatically post an article on @samp{comp.unix.wizards} saying that
6710 you have just viewed the file in question. This feature can't be turned
6714 @node Shell Archives
6715 @subsection Shell Archives
6717 @cindex shell archives
6718 @cindex shared articles
6720 Shell archives (``shar files'') used to be a popular way to distribute
6721 sources, but it isn't used all that much today. In any case, we have
6722 some commands to deal with these:
6727 @kindex X s (Summary)
6728 @findex gnus-uu-decode-unshar
6729 Unshars the current series (@code{gnus-uu-decode-unshar}).
6732 @kindex X S (Summary)
6733 @findex gnus-uu-decode-unshar-and-save
6734 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
6737 @kindex X v s (Summary)
6738 @findex gnus-uu-decode-unshar-view
6739 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
6742 @kindex X v S (Summary)
6743 @findex gnus-uu-decode-unshar-and-save-view
6744 Unshars, views and saves the current series
6745 (@code{gnus-uu-decode-unshar-and-save-view}).
6749 @node PostScript Files
6750 @subsection PostScript Files
6756 @kindex X p (Summary)
6757 @findex gnus-uu-decode-postscript
6758 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
6761 @kindex X P (Summary)
6762 @findex gnus-uu-decode-postscript-and-save
6763 Unpack and save the current PostScript series
6764 (@code{gnus-uu-decode-postscript-and-save}).
6767 @kindex X v p (Summary)
6768 @findex gnus-uu-decode-postscript-view
6769 View the current PostScript series
6770 (@code{gnus-uu-decode-postscript-view}).
6773 @kindex X v P (Summary)
6774 @findex gnus-uu-decode-postscript-and-save-view
6775 View and save the current PostScript series
6776 (@code{gnus-uu-decode-postscript-and-save-view}).
6781 @subsection Other Files
6785 @kindex X o (Summary)
6786 @findex gnus-uu-decode-save
6787 Save the current series
6788 (@code{gnus-uu-decode-save}).
6791 @kindex X b (Summary)
6792 @findex gnus-uu-decode-binhex
6793 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
6794 doesn't really work yet.
6798 @node Decoding Variables
6799 @subsection Decoding Variables
6801 Adjective, not verb.
6804 * Rule Variables:: Variables that say how a file is to be viewed.
6805 * Other Decode Variables:: Other decode variables.
6806 * Uuencoding and Posting:: Variables for customizing uuencoding.
6810 @node Rule Variables
6811 @subsubsection Rule Variables
6812 @cindex rule variables
6814 Gnus uses @dfn{rule variables} to decide how to view a file. All these
6815 variables are of the form
6818 (list '(regexp1 command2)
6825 @item gnus-uu-user-view-rules
6826 @vindex gnus-uu-user-view-rules
6828 This variable is consulted first when viewing files. If you wish to use,
6829 for instance, @code{sox} to convert an @samp{.au} sound file, you could
6832 (setq gnus-uu-user-view-rules
6833 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
6836 @item gnus-uu-user-view-rules-end
6837 @vindex gnus-uu-user-view-rules-end
6838 This variable is consulted if Gnus couldn't make any matches from the
6839 user and default view rules.
6841 @item gnus-uu-user-archive-rules
6842 @vindex gnus-uu-user-archive-rules
6843 This variable can be used to say what commands should be used to unpack
6848 @node Other Decode Variables
6849 @subsubsection Other Decode Variables
6852 @vindex gnus-uu-grabbed-file-functions
6854 @item gnus-uu-grabbed-file-functions
6855 All functions in this list will be called right after each file has been
6856 successfully decoded---so that you can move or view files right away,
6857 and don't have to wait for all files to be decoded before you can do
6858 anything. Ready-made functions you can put in this list are:
6862 @item gnus-uu-grab-view
6863 @findex gnus-uu-grab-view
6866 @item gnus-uu-grab-move
6867 @findex gnus-uu-grab-move
6868 Move the file (if you're using a saving function.)
6871 @item gnus-uu-be-dangerous
6872 @vindex gnus-uu-be-dangerous
6873 Specifies what to do if unusual situations arise during decoding. If
6874 @code{nil}, be as conservative as possible. If @code{t}, ignore things
6875 that didn't work, and overwrite existing files. Otherwise, ask each
6878 @item gnus-uu-ignore-files-by-name
6879 @vindex gnus-uu-ignore-files-by-name
6880 Files with name matching this regular expression won't be viewed.
6882 @item gnus-uu-ignore-files-by-type
6883 @vindex gnus-uu-ignore-files-by-type
6884 Files with a @sc{mime} type matching this variable won't be viewed.
6885 Note that Gnus tries to guess what type the file is based on the name.
6886 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
6889 @item gnus-uu-tmp-dir
6890 @vindex gnus-uu-tmp-dir
6891 Where @code{gnus-uu} does its work.
6893 @item gnus-uu-do-not-unpack-archives
6894 @vindex gnus-uu-do-not-unpack-archives
6895 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
6896 looking for files to display.
6898 @item gnus-uu-view-and-save
6899 @vindex gnus-uu-view-and-save
6900 Non-@code{nil} means that the user will always be asked to save a file
6903 @item gnus-uu-ignore-default-view-rules
6904 @vindex gnus-uu-ignore-default-view-rules
6905 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
6908 @item gnus-uu-ignore-default-archive-rules
6909 @vindex gnus-uu-ignore-default-archive-rules
6910 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
6913 @item gnus-uu-kill-carriage-return
6914 @vindex gnus-uu-kill-carriage-return
6915 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
6918 @item gnus-uu-unmark-articles-not-decoded
6919 @vindex gnus-uu-unmark-articles-not-decoded
6920 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
6921 decoded articles as unread.
6923 @item gnus-uu-correct-stripped-uucode
6924 @vindex gnus-uu-correct-stripped-uucode
6925 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
6926 uuencoded files that have had trailing spaces deleted.
6928 @item gnus-uu-pre-uudecode-hook
6929 @vindex gnus-uu-pre-uudecode-hook
6930 Hook run before sending a message to @code{uudecode}.
6932 @item gnus-uu-view-with-metamail
6933 @vindex gnus-uu-view-with-metamail
6935 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
6936 commands defined by the rule variables and just fudge a @sc{mime}
6937 content type based on the file name. The result will be fed to
6938 @code{metamail} for viewing.
6940 @item gnus-uu-save-in-digest
6941 @vindex gnus-uu-save-in-digest
6942 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
6943 decoding, will save in digests. If this variable is @code{nil},
6944 @code{gnus-uu} will just save everything in a file without any
6945 embellishments. The digesting almost conforms to RFC 1153---no easy way
6946 to specify any meaningful volume and issue numbers were found, so I
6947 simply dropped them.
6952 @node Uuencoding and Posting
6953 @subsubsection Uuencoding and Posting
6957 @item gnus-uu-post-include-before-composing
6958 @vindex gnus-uu-post-include-before-composing
6959 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6960 before you compose the article. If this variable is @code{t}, you can
6961 either include an encoded file with @kbd{C-c C-i} or have one included
6962 for you when you post the article.
6964 @item gnus-uu-post-length
6965 @vindex gnus-uu-post-length
6966 Maximum length of an article. The encoded file will be split into how
6967 many articles it takes to post the entire file.
6969 @item gnus-uu-post-threaded
6970 @vindex gnus-uu-post-threaded
6971 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6972 thread. This may not be smart, as no other decoder I have seen is able
6973 to follow threads when collecting uuencoded articles. (Well, I have
6974 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6975 think that counts...) Default is @code{nil}.
6977 @item gnus-uu-post-separate-description
6978 @vindex gnus-uu-post-separate-description
6979 Non-@code{nil} means that the description will be posted in a separate
6980 article. The first article will typically be numbered (0/x). If this
6981 variable is @code{nil}, the description the user enters will be included
6982 at the beginning of the first article, which will be numbered (1/x).
6983 Default is @code{t}.
6989 @subsection Viewing Files
6990 @cindex viewing files
6991 @cindex pseudo-articles
6993 After decoding, if the file is some sort of archive, Gnus will attempt
6994 to unpack the archive and see if any of the files in the archive can be
6995 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
6996 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
6997 uncompress and de-tar the main file, and then view the two pictures.
6998 This unpacking process is recursive, so if the archive contains archives
6999 of archives, it'll all be unpacked.
7001 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
7002 extracted file into the summary buffer. If you go to these
7003 ``articles'', you will be prompted for a command to run (usually Gnus
7004 will make a suggestion), and then the command will be run.
7006 @vindex gnus-view-pseudo-asynchronously
7007 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
7008 until the viewing is done before proceeding.
7010 @vindex gnus-view-pseudos
7011 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
7012 the pseudo-articles into the summary buffer, but view them
7013 immediately. If this variable is @code{not-confirm}, the user won't even
7014 be asked for a confirmation before viewing is done.
7016 @vindex gnus-view-pseudos-separately
7017 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
7018 pseudo-article will be created for each file to be viewed. If
7019 @code{nil}, all files that use the same viewing command will be given as
7020 a list of parameters to that command.
7022 @vindex gnus-insert-pseudo-articles
7023 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
7024 pseudo-articles when decoding. It is @code{t} by default.
7026 So; there you are, reading your @emph{pseudo-articles} in your
7027 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
7028 Why isn't anything real anymore? How did we get here?
7031 @node Article Treatment
7032 @section Article Treatment
7034 Reading through this huge manual, you may have quite forgotten that the
7035 object of newsreaders is to actually, like, read what people have
7036 written. Reading articles. Unfortunately, people are quite bad at
7037 writing, so there are tons of functions and variables to make reading
7038 these articles easier.
7041 * Article Highlighting:: You want to make the article look like fruit salad.
7042 * Article Fontisizing:: Making emphasized text look nice.
7043 * Article Hiding:: You also want to make certain info go away.
7044 * Article Washing:: Lots of way-neat functions to make life better.
7045 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
7046 * Article Date:: Grumble, UT!
7047 * Article Signature:: What is a signature?
7048 * Article Miscellania:: Various other stuff.
7052 @node Article Highlighting
7053 @subsection Article Highlighting
7054 @cindex highlighting
7056 Not only do you want your article buffer to look like fruit salad, but
7057 you want it to look like technicolor fruit salad.
7062 @kindex W H a (Summary)
7063 @findex gnus-article-highlight
7064 @findex gnus-article-maybe-highlight
7065 Do much highlighting of the current article
7066 (@code{gnus-article-highlight}). This function highlights header, cited
7067 text, the signature, and adds buttons to the body and the head.
7070 @kindex W H h (Summary)
7071 @findex gnus-article-highlight-headers
7072 @vindex gnus-header-face-alist
7073 Highlight the headers (@code{gnus-article-highlight-headers}). The
7074 highlighting will be done according to the @code{gnus-header-face-alist}
7075 variable, which is a list where each element has the form
7076 @code{(@var{regexp} @var{name} @var{content})}.
7077 @var{regexp} is a regular expression for matching the
7078 header, @var{name} is the face used for highlighting the header name
7079 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
7080 the header value. The first match made will be used. Note that
7081 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
7084 @kindex W H c (Summary)
7085 @findex gnus-article-highlight-citation
7086 Highlight cited text (@code{gnus-article-highlight-citation}).
7088 Some variables to customize the citation highlights:
7091 @vindex gnus-cite-parse-max-size
7093 @item gnus-cite-parse-max-size
7094 If the article size if bigger than this variable (which is 25000 by
7095 default), no citation highlighting will be performed.
7097 @item gnus-cite-max-prefix
7098 @vindex gnus-cite-max-prefix
7099 Maximum possible length for a citation prefix (default 20).
7101 @item gnus-cite-face-list
7102 @vindex gnus-cite-face-list
7103 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
7104 When there are citations from multiple articles in the same message,
7105 Gnus will try to give each citation from each article its own face.
7106 This should make it easier to see who wrote what.
7108 @item gnus-supercite-regexp
7109 @vindex gnus-supercite-regexp
7110 Regexp matching normal Supercite attribution lines.
7112 @item gnus-supercite-secondary-regexp
7113 @vindex gnus-supercite-secondary-regexp
7114 Regexp matching mangled Supercite attribution lines.
7116 @item gnus-cite-minimum-match-count
7117 @vindex gnus-cite-minimum-match-count
7118 Minimum number of identical prefixes we have to see before we believe
7119 that it's a citation.
7121 @item gnus-cite-attribution-prefix
7122 @vindex gnus-cite-attribution-prefix
7123 Regexp matching the beginning of an attribution line.
7125 @item gnus-cite-attribution-suffix
7126 @vindex gnus-cite-attribution-suffix
7127 Regexp matching the end of an attribution line.
7129 @item gnus-cite-attribution-face
7130 @vindex gnus-cite-attribution-face
7131 Face used for attribution lines. It is merged with the face for the
7132 cited text belonging to the attribution.
7138 @kindex W H s (Summary)
7139 @vindex gnus-signature-separator
7140 @vindex gnus-signature-face
7141 @findex gnus-article-highlight-signature
7142 Highlight the signature (@code{gnus-article-highlight-signature}).
7143 Everything after @code{gnus-signature-separator} (@pxref{Article
7144 Signature}) in an article will be considered a signature and will be
7145 highlighted with @code{gnus-signature-face}, which is @code{italic} by
7150 @xref{Customizing Articles}, for how to highlight articles automatically.
7153 @node Article Fontisizing
7154 @subsection Article Fontisizing
7156 @cindex article emphasis
7158 @findex gnus-article-emphasize
7159 @kindex W e (Summary)
7160 People commonly add emphasis to words in news articles by writing things
7161 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
7162 this look nicer by running the article through the @kbd{W e}
7163 (@code{gnus-article-emphasize}) command.
7165 @vindex gnus-emphasis-alist
7166 How the emphasis is computed is controlled by the
7167 @code{gnus-emphasis-alist} variable. This is an alist where the first
7168 element is a regular expression to be matched. The second is a number
7169 that says what regular expression grouping is used to find the entire
7170 emphasized word. The third is a number that says what regexp grouping
7171 should be displayed and highlighted. (The text between these two
7172 groupings will be hidden.) The fourth is the face used for
7176 (setq gnus-emphasis-alist
7177 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
7178 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
7187 @vindex gnus-emphasis-underline
7188 @vindex gnus-emphasis-bold
7189 @vindex gnus-emphasis-italic
7190 @vindex gnus-emphasis-underline-bold
7191 @vindex gnus-emphasis-underline-italic
7192 @vindex gnus-emphasis-bold-italic
7193 @vindex gnus-emphasis-underline-bold-italic
7194 By default, there are seven rules, and they use the following faces:
7195 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
7196 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
7197 @code{gnus-emphasis-underline-italic},
7198 @code{gnus-emphasis-underline-bold}, and
7199 @code{gnus-emphasis-underline-bold-italic}.
7201 If you want to change these faces, you can either use @kbd{M-x
7202 customize}, or you can use @code{copy-face}. For instance, if you want
7203 to make @code{gnus-emphasis-italic} use a red face instead, you could
7207 (copy-face 'red 'gnus-emphasis-italic)
7210 @vindex gnus-group-highlight-words-alist
7212 If you want to highlight arbitrary words, you can use the
7213 @code{gnus-group-highlight-words-alist} variable, which uses the same
7214 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
7215 parameter (@pxref{Group Parameters}) can also be used.
7217 @xref{Customizing Articles}, for how to fontize articles automatically.
7220 @node Article Hiding
7221 @subsection Article Hiding
7222 @cindex article hiding
7224 Or rather, hiding certain things in each article. There usually is much
7225 too much cruft in most articles.
7230 @kindex W W a (Summary)
7231 @findex gnus-article-hide
7232 Do quite a lot of hiding on the article buffer
7233 (@kbd{gnus-article-hide}). In particular, this function will hide
7234 headers, PGP, cited text and the signature.
7237 @kindex W W h (Summary)
7238 @findex gnus-article-hide-headers
7239 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
7243 @kindex W W b (Summary)
7244 @findex gnus-article-hide-boring-headers
7245 Hide headers that aren't particularly interesting
7246 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
7249 @kindex W W s (Summary)
7250 @findex gnus-article-hide-signature
7251 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
7255 @kindex W W l (Summary)
7256 @findex gnus-article-hide-list-identifiers
7257 @vindex gnus-list-identifiers
7258 Strip list identifiers specified in @code{gnus-list-identifiers}. These
7259 are strings some mailing list servers add to the beginning of all
7260 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
7261 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
7262 may not contain @code{\\(..\\)}.
7266 @item gnus-list-identifiers
7267 @vindex gnus-list-identifiers
7268 A regular expression that matches list identifiers to be removed from
7269 subject. This can also be a list of regular expressions.
7274 @kindex W W p (Summary)
7275 @findex gnus-article-hide-pgp
7276 @vindex gnus-article-hide-pgp-hook
7277 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). The
7278 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
7279 signature has been hidden. For example, to automatically verify
7280 articles that have signatures in them do:
7282 ;;; Hide pgp cruft if any.
7284 (setq gnus-treat-strip-pgp t)
7286 ;;; After hiding pgp, verify the message;
7287 ;;; only happens if pgp signature is found.
7289 (add-hook 'gnus-article-hide-pgp-hook
7292 (set-buffer gnus-original-article-buffer)
7297 @kindex W W P (Summary)
7298 @findex gnus-article-hide-pem
7299 Hide @sc{pem} (privacy enhanced messages) cruft
7300 (@code{gnus-article-hide-pem}).
7303 @kindex W W B (Summary)
7304 @findex gnus-article-strip-banner
7307 @cindex stripping advertisements
7308 @cindex advertisements
7309 Strip the banner specified by the @code{banner} group parameter
7310 (@code{gnus-article-strip-banner}). This is mainly used to hide those
7311 annoying banners and/or signatures that some mailing lists and moderated
7312 groups adds to all the messages. The way to use this function is to add
7313 the @code{banner} group parameter (@pxref{Group Parameters}) to the
7314 group you want banners stripped from. The parameter either be a string,
7315 which will be interpreted as a regular expression matching text to be
7316 removed, or the symbol @code{signature}, meaning that the (last)
7317 signature should be removed, or other symbol, meaning that the
7318 corresponding regular expression in @code{gnus-article-banner-alist} is
7322 @kindex W W c (Summary)
7323 @findex gnus-article-hide-citation
7324 Hide citation (@code{gnus-article-hide-citation}). Some variables for
7325 customizing the hiding:
7329 @item gnus-cited-opened-text-button-line-format
7330 @itemx gnus-cited-closed-text-button-line-format
7331 @vindex gnus-cited-closed-text-button-line-format
7332 @vindex gnus-cited-opened-text-button-line-format
7333 Gnus adds buttons to show where the cited text has been hidden, and to
7334 allow toggle hiding the text. The format of the variable is specified
7335 by these format-like variable (@pxref{Formatting Variables}). These
7340 Starting point of the hidden text.
7342 Ending point of the hidden text.
7344 Number of characters in the hidden region.
7346 Number of lines of hidden text.
7349 @item gnus-cited-lines-visible
7350 @vindex gnus-cited-lines-visible
7351 The number of lines at the beginning of the cited text to leave
7352 shown. This can also be a cons cell with the number of lines at the top
7353 and bottom of the text, respectively, to remain visible.
7358 @kindex W W C-c (Summary)
7359 @findex gnus-article-hide-citation-maybe
7361 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
7362 following two variables:
7365 @item gnus-cite-hide-percentage
7366 @vindex gnus-cite-hide-percentage
7367 If the cited text is of a bigger percentage than this variable (default
7368 50), hide the cited text.
7370 @item gnus-cite-hide-absolute
7371 @vindex gnus-cite-hide-absolute
7372 The cited text must have at least this length (default 10) before it
7377 @kindex W W C (Summary)
7378 @findex gnus-article-hide-citation-in-followups
7379 Hide cited text in articles that aren't roots
7380 (@code{gnus-article-hide-citation-in-followups}). This isn't very
7381 useful as an interactive command, but might be a handy function to stick
7382 have happen automatically (@pxref{Customizing Articles}).
7386 All these ``hiding'' commands are toggles, but if you give a negative
7387 prefix to these commands, they will show what they have previously
7388 hidden. If you give a positive prefix, they will always hide.
7390 Also @pxref{Article Highlighting} for further variables for
7391 citation customization.
7393 @xref{Customizing Articles}, for how to hide article elements
7397 @node Article Washing
7398 @subsection Article Washing
7400 @cindex article washing
7402 We call this ``article washing'' for a really good reason. Namely, the
7403 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
7405 @dfn{Washing} is defined by us as ``changing something from something to
7406 something else'', but normally results in something looking better.
7409 @xref{Customizing Articles}, if you want to change how Gnus displays
7410 articles by default.
7415 This is not really washing, it's sort of the opposite of washing. If
7416 you type this, you see the article exactly as it exists on disk or on
7420 @kindex W l (Summary)
7421 @findex gnus-summary-stop-page-breaking
7422 Remove page breaks from the current article
7423 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
7427 @kindex W r (Summary)
7428 @findex gnus-summary-caesar-message
7429 @c @icon{gnus-summary-caesar-message}
7430 Do a Caesar rotate (rot13) on the article buffer
7431 (@code{gnus-summary-caesar-message}).
7432 Unreadable articles that tell you to read them with Caesar rotate or rot13.
7433 (Typically offensive jokes and such.)
7435 It's commonly called ``rot13'' because each letter is rotated 13
7436 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
7437 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
7438 is rumored to have employed this form of, uh, somewhat weak encryption.
7442 @kindex W t (Summary)
7444 @findex gnus-summary-toggle-header
7445 Toggle whether to display all headers in the article buffer
7446 (@code{gnus-summary-toggle-header}).
7449 @kindex W v (Summary)
7450 @findex gnus-summary-verbose-header
7451 Toggle whether to display all headers in the article buffer permanently
7452 (@code{gnus-summary-verbose-header}).
7455 @kindex W o (Summary)
7456 @findex gnus-article-treat-overstrike
7457 Treat overstrike (@code{gnus-article-treat-overstrike}).
7460 @kindex W d (Summary)
7461 @findex gnus-article-treat-dumbquotes
7462 @vindex gnus-article-dumbquotes-map
7464 @cindex M****s*** sm*rtq**t*s
7466 Treat M****s*** sm*rtq**t*s according to
7467 @code{gnus-article-dumbquotes-map}
7468 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
7469 whether a character is a sm*rtq**t* or not, so it should only be used
7472 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
7473 an attempt to provide more quoting characters. If you see something
7474 like @code{\222} or @code{\264} where you're expecting some kind of
7475 apostrophe or quotation mark, then try this wash.
7478 @kindex W w (Summary)
7479 @findex gnus-article-fill-cited-article
7480 Do word wrap (@code{gnus-article-fill-cited-article}).
7482 You can give the command a numerical prefix to specify the width to use
7486 @kindex W Q (Summary)
7487 @findex gnus-article-fill-long-lines
7488 Fill long lines (@code{gnus-article-fill-long-lines}).
7491 @kindex W C (Summary)
7492 @findex gnus-article-capitalize-sentences
7493 Capitalize the first word in each sentence
7494 (@code{gnus-article-capitalize-sentences}).
7497 @kindex W c (Summary)
7498 @findex gnus-article-remove-cr
7499 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
7500 (this takes care of DOS line endings), and then translate any remaining
7501 CRs into LF (this takes care of Mac line endings)
7502 (@code{gnus-article-remove-cr}).
7505 @kindex W q (Summary)
7506 @findex gnus-article-de-quoted-unreadable
7507 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
7508 Quoted-Printable is one common @sc{mime} encoding employed when sending
7509 non-ASCII (i. e., 8-bit) articles. It typically makes strings like
7510 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
7511 readable to me. Note that the this is usually done automatically by
7512 Gnus if the message in question has a @code{Content-Transfer-Encoding}
7513 header that says that this encoding has been done.
7516 @kindex W 6 (Summary)
7517 @findex gnus-article-de-base64-unreadable
7518 Treat base64 (@code{gnus-article-de-base64-unreadable}).
7519 Base64 is one common @sc{mime} encoding employed when sending non-ASCII
7520 (i. e., 8-bit) articles. Note that the this is usually done
7521 automatically by Gnus if the message in question has a
7522 @code{Content-Transfer-Encoding} header that says that this encoding has
7526 @kindex W Z (Summary)
7527 @findex gnus-article-decode-HZ
7528 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
7529 common encoding employed when sending Chinese articles. It typically
7530 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
7533 @kindex W h (Summary)
7534 @findex gnus-article-wash-html
7535 Treat HTML (@code{gnus-article-wash-html}).
7536 Note that the this is usually done automatically by Gnus if the message
7537 in question has a @code{Content-Type} header that says that this type
7541 @kindex W f (Summary)
7543 @findex gnus-article-display-x-face
7544 @findex gnus-article-x-face-command
7545 @vindex gnus-article-x-face-command
7546 @vindex gnus-article-x-face-too-ugly
7553 Look for and display any X-Face headers
7554 (@code{gnus-article-display-x-face}). The command executed by this
7555 function is given by the @code{gnus-article-x-face-command} variable.
7556 If this variable is a string, this string will be executed in a
7557 sub-shell. If it is a function, this function will be called with the
7558 face as the argument. If the @code{gnus-article-x-face-too-ugly} (which
7559 is a regexp) matches the @code{From} header, the face will not be shown.
7560 The default action under Emacs is to fork off the @code{display}
7561 program@footnote{@code{display} is from the ImageMagick package. For the
7562 @code{uncompface} and @code{icontopbm} programs look for a package
7563 like `compface' or `faces-xface' on a GNU/Linux system.}
7564 to view the face. Under XEmacs or Emacs 21+ with suitable image
7565 support, the default action is to display the face before the
7566 @code{From} header. (It's nicer if XEmacs has been compiled with X-Face
7567 support---that will make display somewhat faster. If there's no native
7568 X-Face support, Gnus will try to convert the @code{X-Face} header using
7569 external programs from the @code{pbmplus} package and
7570 friends.@footnote{On a GNU/Linux system look for packages with names
7571 like @code{netpbm} or @code{libgr-progs}.}) If you
7572 want to have this function in the display hook, it should probably come
7576 @kindex W b (Summary)
7577 @findex gnus-article-add-buttons
7578 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
7579 @xref{Article Buttons}.
7582 @kindex W B (Summary)
7583 @findex gnus-article-add-buttons-to-head
7584 Add clickable buttons to the article headers
7585 (@code{gnus-article-add-buttons-to-head}).
7588 @kindex W W H (Summary)
7589 @findex gnus-article-strip-headers-from-body
7590 Strip headers like the @code{X-No-Archive} header from the beginning of
7591 article bodies (@code{gnus-article-strip-headers-from-body}).
7594 @kindex W E l (Summary)
7595 @findex gnus-article-strip-leading-blank-lines
7596 Remove all blank lines from the beginning of the article
7597 (@code{gnus-article-strip-leading-blank-lines}).
7600 @kindex W E m (Summary)
7601 @findex gnus-article-strip-multiple-blank-lines
7602 Replace all blank lines with empty lines and then all multiple empty
7603 lines with a single empty line.
7604 (@code{gnus-article-strip-multiple-blank-lines}).
7607 @kindex W E t (Summary)
7608 @findex gnus-article-remove-trailing-blank-lines
7609 Remove all blank lines at the end of the article
7610 (@code{gnus-article-remove-trailing-blank-lines}).
7613 @kindex W E a (Summary)
7614 @findex gnus-article-strip-blank-lines
7615 Do all the three commands above
7616 (@code{gnus-article-strip-blank-lines}).
7619 @kindex W E A (Summary)
7620 @findex gnus-article-strip-all-blank-lines
7621 Remove all blank lines
7622 (@code{gnus-article-strip-all-blank-lines}).
7625 @kindex W E s (Summary)
7626 @findex gnus-article-strip-leading-space
7627 Remove all white space from the beginning of all lines of the article
7628 body (@code{gnus-article-strip-leading-space}).
7631 @kindex W E e (Summary)
7632 @findex gnus-article-strip-trailing-space
7633 Remove all white space from the end of all lines of the article
7634 body (@code{gnus-article-strip-trailing-space}).
7638 @xref{Customizing Articles}, for how to wash articles automatically.
7641 @node Article Buttons
7642 @subsection Article Buttons
7645 People often include references to other stuff in articles, and it would
7646 be nice if Gnus could just fetch whatever it is that people talk about
7647 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
7648 button on these references.
7650 Gnus adds @dfn{buttons} to certain standard references by default:
7651 Well-formed URLs, mail addresses and Message-IDs. This is controlled by
7652 two variables, one that handles article bodies and one that handles
7657 @item gnus-button-alist
7658 @vindex gnus-button-alist
7659 This is an alist where each entry has this form:
7662 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
7668 All text that match this regular expression will be considered an
7669 external reference. Here's a typical regexp that matches embedded URLs:
7670 @samp{<URL:\\([^\n\r>]*\\)>}.
7673 Gnus has to know which parts of the matches is to be highlighted. This
7674 is a number that says what sub-expression of the regexp is to be
7675 highlighted. If you want it all highlighted, you use 0 here.
7678 This form will be @code{eval}ed, and if the result is non-@code{nil},
7679 this is considered a match. This is useful if you want extra sifting to
7680 avoid false matches.
7683 This function will be called when you click on this button.
7686 As with @var{button-par}, this is a sub-expression number, but this one
7687 says which part of the match is to be sent as data to @var{function}.
7691 So the full entry for buttonizing URLs is then
7694 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
7697 @item gnus-header-button-alist
7698 @vindex gnus-header-button-alist
7699 This is just like the other alist, except that it is applied to the
7700 article head only, and that each entry has an additional element that is
7701 used to say what headers to apply the buttonize coding to:
7704 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
7707 @var{header} is a regular expression.
7709 @item gnus-button-url-regexp
7710 @vindex gnus-button-url-regexp
7711 A regular expression that matches embedded URLs. It is used in the
7712 default values of the variables above.
7714 @item gnus-article-button-face
7715 @vindex gnus-article-button-face
7716 Face used on buttons.
7718 @item gnus-article-mouse-face
7719 @vindex gnus-article-mouse-face
7720 Face used when the mouse cursor is over a button.
7724 @xref{Customizing Articles}, for how to buttonize articles automatically.
7728 @subsection Article Date
7730 The date is most likely generated in some obscure timezone you've never
7731 heard of, so it's quite nice to be able to find out what the time was
7732 when the article was sent.
7737 @kindex W T u (Summary)
7738 @findex gnus-article-date-ut
7739 Display the date in UT (aka. GMT, aka ZULU)
7740 (@code{gnus-article-date-ut}).
7743 @kindex W T i (Summary)
7744 @findex gnus-article-date-iso8601
7746 Display the date in international format, aka. ISO 8601
7747 (@code{gnus-article-date-iso8601}).
7750 @kindex W T l (Summary)
7751 @findex gnus-article-date-local
7752 Display the date in the local timezone (@code{gnus-article-date-local}).
7755 @kindex W T p (Summary)
7756 @findex gnus-article-date-english
7757 Display the date in a format that's easily pronounceable in English
7758 (@code{gnus-article-date-english}).
7761 @kindex W T s (Summary)
7762 @vindex gnus-article-time-format
7763 @findex gnus-article-date-user
7764 @findex format-time-string
7765 Display the date using a user-defined format
7766 (@code{gnus-article-date-user}). The format is specified by the
7767 @code{gnus-article-time-format} variable, and is a string that's passed
7768 to @code{format-time-string}. See the documentation of that variable
7769 for a list of possible format specs.
7772 @kindex W T e (Summary)
7773 @findex gnus-article-date-lapsed
7774 @findex gnus-start-date-timer
7775 @findex gnus-stop-date-timer
7776 Say how much time has elapsed between the article was posted and now
7777 (@code{gnus-article-date-lapsed}). It looks something like:
7780 X-Sent: 9 years, 6 weeks, 4 days, 9 hours, 3 minutes, 28 seconds ago
7783 The value of @code{gnus-article-date-lapsed-new-header} determines
7784 whether this header will just be added below the old Date one, or will
7787 An advantage of using Gnus to read mail is that it converts simple bugs
7788 into wonderful absurdities.
7790 If you want to have this line updated continually, you can put
7793 (gnus-start-date-timer)
7796 in your @file{.gnus.el} file, or you can run it off of some hook. If
7797 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
7801 @kindex W T o (Summary)
7802 @findex gnus-article-date-original
7803 Display the original date (@code{gnus-article-date-original}). This can
7804 be useful if you normally use some other conversion function and are
7805 worried that it might be doing something totally wrong. Say, claiming
7806 that the article was posted in 1854. Although something like that is
7807 @emph{totally} impossible. Don't you trust me? *titter*
7811 @xref{Customizing Articles}, for how to display the date in your
7812 preferred format automatically.
7815 @node Article Signature
7816 @subsection Article Signature
7818 @cindex article signature
7820 @vindex gnus-signature-separator
7821 Each article is divided into two parts---the head and the body. The
7822 body can be divided into a signature part and a text part. The variable
7823 that says what is to be considered a signature is
7824 @code{gnus-signature-separator}. This is normally the standard
7825 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
7826 non-standard signature separators, so this variable can also be a list
7827 of regular expressions to be tested, one by one. (Searches are done
7828 from the end of the body towards the beginning.) One likely value is:
7831 (setq gnus-signature-separator
7832 '("^-- $" ; The standard
7833 "^-- *$" ; A common mangling
7834 "^-------*$" ; Many people just use a looong
7835 ; line of dashes. Shame!
7836 "^ *--------*$" ; Double-shame!
7837 "^________*$" ; Underscores are also popular
7838 "^========*$")) ; Pervert!
7841 The more permissive you are, the more likely it is that you'll get false
7844 @vindex gnus-signature-limit
7845 @code{gnus-signature-limit} provides a limit to what is considered a
7846 signature when displaying articles.
7850 If it is an integer, no signature may be longer (in characters) than
7853 If it is a floating point number, no signature may be longer (in lines)
7856 If it is a function, the function will be called without any parameters,
7857 and if it returns @code{nil}, there is no signature in the buffer.
7859 If it is a string, it will be used as a regexp. If it matches, the text
7860 in question is not a signature.
7863 This variable can also be a list where the elements may be of the types
7864 listed above. Here's an example:
7867 (setq gnus-signature-limit
7868 '(200.0 "^---*Forwarded article"))
7871 This means that if there are more than 200 lines after the signature
7872 separator, or the text after the signature separator is matched by
7873 the regular expression @samp{^---*Forwarded article}, then it isn't a
7874 signature after all.
7877 @node Article Miscellania
7878 @subsection Article Miscellania
7882 @kindex A t (Summary)
7883 @findex gnus-article-babel
7884 Translate the article from one language to another
7885 (@code{gnus-article-babel}).
7891 @section @sc{mime} Commands
7892 @cindex MIME decoding
7894 @cindex viewing attachments
7896 The following commands all understand the numerical prefix. For
7897 instance, @kbd{3 b} means ``view the third @sc{mime} part''.
7903 @kindex K v (Summary)
7904 View the @sc{mime} part.
7907 @kindex K o (Summary)
7908 Save the @sc{mime} part.
7911 @kindex K c (Summary)
7912 Copy the @sc{mime} part.
7915 @kindex K e (Summary)
7916 View the @sc{mime} part externally.
7919 @kindex K i (Summary)
7920 View the @sc{mime} part internally.
7923 @kindex K | (Summary)
7924 Pipe the @sc{mime} part to an external command.
7927 The rest of these @sc{mime} commands do not use the numerical prefix in
7932 @kindex K b (Summary)
7933 Make all the @sc{mime} parts have buttons in front of them. This is
7934 mostly useful if you wish to save (or perform other actions) on inlined
7938 @kindex K m (Summary)
7939 @findex gnus-summary-repair-multipart
7940 Some multipart messages are transmitted with missing or faulty headers.
7941 This command will attempt to ``repair'' these messages so that they can
7942 be viewed in a more pleasant manner
7943 (@code{gnus-summary-repair-multipart}).
7946 @kindex X m (Summary)
7947 @findex gnus-summary-save-parts
7948 Save all parts matching a @sc{mime} type to a directory
7949 (@code{gnus-summary-save-parts}). Understands the process/prefix
7950 convention (@pxref{Process/Prefix}).
7953 @kindex M-t (Summary)
7954 @findex gnus-summary-display-buttonized
7955 Toggle the buttonized display of the article buffer
7956 (@code{gnus-summary-toggle-display-buttonized}).
7959 @kindex W M w (Summary)
7960 Decode RFC 2047-encoded words in the article headers
7961 (@code{gnus-article-decode-mime-words}).
7964 @kindex W M c (Summary)
7965 Decode encoded article bodies as well as charsets
7966 (@code{gnus-article-decode-charset}).
7968 This command looks in the @code{Content-Type} header to determine the
7969 charset. If there is no such header in the article, you can give it a
7970 prefix, which will prompt for the charset to decode as. In regional
7971 groups where people post using some common encoding (but do not include
7972 MIME headers), you can set the @code{charset} group/topic parameter to
7973 the required charset (@pxref{Group Parameters}).
7976 @kindex W M v (Summary)
7977 View all the @sc{mime} parts in the current article
7978 (@code{gnus-mime-view-all-parts}).
7985 @item gnus-ignored-mime-types
7986 @vindex gnus-ignored-mime-types
7987 This is a list of regexps. @sc{mime} types that match a regexp from
7988 this list will be completely ignored by Gnus. The default value is
7991 To have all Vcards be ignored, you'd say something like this:
7994 (setq gnus-ignored-mime-types
7998 @item gnus-unbuttonized-mime-types
7999 @vindex gnus-unbuttonized-mime-types
8000 This is a list of regexps. @sc{mime} types that match a regexp from
8001 this list won't have @sc{mime} buttons inserted unless they aren't
8002 displayed. The default value is @code{(".*/.*")}.
8004 @item gnus-article-mime-part-function
8005 @vindex gnus-article-mime-part-function
8006 For each @sc{mime} part, this function will be called with the @sc{mime}
8007 handle as the parameter. The function is meant to be used to allow
8008 users to gather information from the article (e. g., add Vcard info to
8009 the bbdb database) or to do actions based on parts (e. g., automatically
8010 save all jpegs into some directory).
8012 Here's an example function the does the latter:
8015 (defun my-save-all-jpeg-parts (handle)
8016 (when (equal (car (mm-handle-type handle)) "image/jpeg")
8018 (insert (mm-get-part handle))
8019 (write-region (point-min) (point-max)
8020 (read-file-name "Save jpeg to: ")))))
8021 (setq gnus-article-mime-part-function
8022 'my-save-all-jpeg-parts)
8025 @vindex gnus-mime-multipart-functions
8026 @item gnus-mime-multipart-functions
8027 Alist of @sc{mime} multipart types and functions to handle them.
8036 People use different charsets, and we have @sc{mime} to let us know what
8037 charsets they use. Or rather, we wish we had. Many people use
8038 newsreaders and mailers that do not understand or use @sc{mime}, and
8039 just send out messages without saying what character sets they use. To
8040 help a bit with this, some local news hierarchies have policies that say
8041 what character set is the default. For instance, the @samp{fj}
8042 hierarchy uses @code{iso-2022-jp-2}.
8044 @vindex gnus-group-charset-alist
8045 This knowledge is encoded in the @code{gnus-group-charset-alist}
8046 variable, which is an alist of regexps (to match full group names) and
8047 default charsets to be used when reading these groups.
8049 In addition, some people do use soi-disant @sc{mime}-aware agents that
8050 aren't. These blithely mark messages as being in @code{iso-8859-1} even
8051 if they really are in @code{koi-8}. To help here, the
8052 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
8053 charsets that are listed here will be ignored. The variable can be set
8054 on a group-by-group basis using the group parameters (@pxref{Group
8055 Parameters}). The default value is @code{(unknown-8bit)}, which is
8056 something some agents insist on having in there.
8058 @vindex gnus-group-posting-charset-alist
8059 When posting, @code{gnus-group-posting-charset-alist} is used to
8060 determine which charsets should not be encoded using the @sc{mime}
8061 encodings. For instance, some hierarchies discourage using
8062 quoted-printable header encoding.
8064 This variable is an alist of regexps and permitted unencoded charsets
8065 for posting. Each element of the alist has the form @code{(}@var{test
8066 header body-list}@code{)}, where:
8070 is either a regular expression matching the newsgroup header or a
8073 is the charset which may be left unencoded in the header (@code{nil}
8074 means encode all charsets),
8076 is a list of charsets which may be encoded using 8bit content-transfer
8077 encoding in the body, or one of the special values @code{nil} (always
8078 encode using quoted-printable) or @code{t} (always use 8bit).
8085 @cindex coding system aliases
8086 @cindex preferred charset
8088 Other charset tricks that may be useful, although not Gnus-specific:
8090 If there are several @sc{mime} charsets that encode the same Emacs
8091 charset, you can choose what charset to use by saying the following:
8094 (put-charset-property 'cyrillic-iso8859-5
8095 'preferred-coding-system 'koi8-r)
8098 This means that Russian will be encoded using @code{koi8-r} instead of
8099 the default @code{iso-8859-5} @sc{mime} charset.
8101 If you want to read messages in @code{koi8-u}, you can cheat and say
8104 (define-coding-system-alias 'koi8-u 'koi8-r)
8107 This will almost do the right thing.
8109 And finally, to read charsets like @code{windows-1251}, you can say
8113 (codepage-setup 1251)
8114 (define-coding-system-alias 'windows-1251 'cp1251)
8118 @node Article Commands
8119 @section Article Commands
8126 @kindex A P (Summary)
8127 @vindex gnus-ps-print-hook
8128 @findex gnus-summary-print-article
8129 Generate and print a PostScript image of the article buffer
8130 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be
8131 run just before printing the buffer.
8136 @node Summary Sorting
8137 @section Summary Sorting
8138 @cindex summary sorting
8140 You can have the summary buffer sorted in various ways, even though I
8141 can't really see why you'd want that.
8146 @kindex C-c C-s C-n (Summary)
8147 @findex gnus-summary-sort-by-number
8148 Sort by article number (@code{gnus-summary-sort-by-number}).
8151 @kindex C-c C-s C-a (Summary)
8152 @findex gnus-summary-sort-by-author
8153 Sort by author (@code{gnus-summary-sort-by-author}).
8156 @kindex C-c C-s C-s (Summary)
8157 @findex gnus-summary-sort-by-subject
8158 Sort by subject (@code{gnus-summary-sort-by-subject}).
8161 @kindex C-c C-s C-d (Summary)
8162 @findex gnus-summary-sort-by-date
8163 Sort by date (@code{gnus-summary-sort-by-date}).
8166 @kindex C-c C-s C-l (Summary)
8167 @findex gnus-summary-sort-by-lines
8168 Sort by lines (@code{gnus-summary-sort-by-lines}).
8171 @kindex C-c C-s C-c (Summary)
8172 @findex gnus-summary-sort-by-chars
8173 Sort by article length (@code{gnus-summary-sort-by-chars}).
8176 @kindex C-c C-s C-i (Summary)
8177 @findex gnus-summary-sort-by-score
8178 Sort by score (@code{gnus-summary-sort-by-score}).
8181 @kindex C-c C-s C-o (Summary)
8182 @findex gnus-summary-sort-by-original
8183 Sort using the default sorting method
8184 (@code{gnus-summary-sort-by-original}).
8187 These functions will work both when you use threading and when you don't
8188 use threading. In the latter case, all summary lines will be sorted,
8189 line by line. In the former case, sorting will be done on a
8190 root-by-root basis, which might not be what you were looking for. To
8191 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
8195 @node Finding the Parent
8196 @section Finding the Parent
8197 @cindex parent articles
8198 @cindex referring articles
8203 @findex gnus-summary-refer-parent-article
8204 If you'd like to read the parent of the current article, and it is not
8205 displayed in the summary buffer, you might still be able to. That is,
8206 if the current group is fetched by @sc{nntp}, the parent hasn't expired
8207 and the @code{References} in the current article are not mangled, you
8208 can just press @kbd{^} or @kbd{A r}
8209 (@code{gnus-summary-refer-parent-article}). If everything goes well,
8210 you'll get the parent. If the parent is already displayed in the
8211 summary buffer, point will just move to this article.
8213 If given a positive numerical prefix, fetch that many articles back into
8214 the ancestry. If given a negative numerical prefix, fetch just that
8215 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
8216 grandparent and the grandgrandparent of the current article. If you say
8217 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
8221 @findex gnus-summary-refer-references
8222 @kindex A R (Summary)
8223 Fetch all articles mentioned in the @code{References} header of the
8224 article (@code{gnus-summary-refer-references}).
8227 @findex gnus-summary-refer-thread
8228 @kindex A T (Summary)
8229 Display the full thread where the current article appears
8230 (@code{gnus-summary-refer-thread}). This command has to fetch all the
8231 headers in the current group to work, so it usually takes a while. If
8232 you do it often, you may consider setting @code{gnus-fetch-old-headers}
8233 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
8234 visible effects normally, but it'll make this command work a whole lot
8235 faster. Of course, it'll make group entry somewhat slow.
8237 @vindex gnus-refer-thread-limit
8238 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
8239 articles before the first displayed in the current group) headers to
8240 fetch when doing this command. The default is 200. If @code{t}, all
8241 the available headers will be fetched. This variable can be overridden
8242 by giving the @kbd{A T} command a numerical prefix.
8245 @findex gnus-summary-refer-article
8246 @kindex M-^ (Summary)
8248 @cindex fetching by Message-ID
8249 You can also ask the @sc{nntp} server for an arbitrary article, no
8250 matter what group it belongs to. @kbd{M-^}
8251 (@code{gnus-summary-refer-article}) will ask you for a
8252 @code{Message-ID}, which is one of those long, hard-to-read thingies
8253 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
8254 have to get it all exactly right. No fuzzy searches, I'm afraid.
8257 The current select method will be used when fetching by
8258 @code{Message-ID} from non-news select method, but you can override this
8259 by giving this command a prefix.
8261 @vindex gnus-refer-article-method
8262 If the group you are reading is located on a backend that does not
8263 support fetching by @code{Message-ID} very well (like @code{nnspool}),
8264 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
8265 would, perhaps, be best if the @sc{nntp} server you consult is the one
8266 updating the spool you are reading from, but that's not really
8269 It can also be a list of select methods, as well as the special symbol
8270 @code{current}, which means to use the current select method. If it
8271 is a list, Gnus will try all the methods in the list until it finds a
8274 Here's an example setting that will first try the current method, and
8275 then ask Deja if that fails:
8278 (setq gnus-refer-article-method
8280 (nnweb "refer" (nnweb-type dejanews))))
8283 Most of the mail backends support fetching by @code{Message-ID}, but do
8284 not do a particularly excellent job at it. That is, @code{nnmbox} and
8285 @code{nnbabyl} are able to locate articles from any groups, while
8286 @code{nnml} and @code{nnfolder} are only able to locate articles that
8287 have been posted to the current group. (Anything else would be too time
8288 consuming.) @code{nnmh} does not support this at all.
8291 @node Alternative Approaches
8292 @section Alternative Approaches
8294 Different people like to read news using different methods. This being
8295 Gnus, we offer a small selection of minor modes for the summary buffers.
8298 * Pick and Read:: First mark articles and then read them.
8299 * Binary Groups:: Auto-decode all articles.
8304 @subsection Pick and Read
8305 @cindex pick and read
8307 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
8308 a two-phased reading interface. The user first marks in a summary
8309 buffer the articles she wants to read. Then she starts reading the
8310 articles with just an article buffer displayed.
8312 @findex gnus-pick-mode
8313 @kindex M-x gnus-pick-mode
8314 Gnus provides a summary buffer minor mode that allows
8315 this---@code{gnus-pick-mode}. This basically means that a few process
8316 mark commands become one-keystroke commands to allow easy marking, and
8317 it provides one additional command for switching to the summary buffer.
8319 Here are the available keystrokes when using pick mode:
8324 @findex gnus-pick-article-or-thread
8325 Pick the article or thread on the current line
8326 (@code{gnus-pick-article-or-thread}). If the variable
8327 @code{gnus-thread-hide-subtree} is true, then this key selects the
8328 entire thread when used at the first article of the thread. Otherwise,
8329 it selects just the article. If given a numerical prefix, go to that
8330 thread or article and pick it. (The line number is normally displayed
8331 at the beginning of the summary pick lines.)
8334 @kindex SPACE (Pick)
8335 @findex gnus-pick-next-page
8336 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
8337 at the end of the buffer, start reading the picked articles.
8341 @findex gnus-pick-unmark-article-or-thread.
8342 Unpick the thread or article
8343 (@code{gnus-pick-unmark-article-or-thread}). If the variable
8344 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
8345 thread if used at the first article of the thread. Otherwise it unpicks
8346 just the article. You can give this key a numerical prefix to unpick
8347 the thread or article at that line.
8351 @findex gnus-pick-start-reading
8352 @vindex gnus-pick-display-summary
8353 Start reading the picked articles (@code{gnus-pick-start-reading}). If
8354 given a prefix, mark all unpicked articles as read first. If
8355 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
8356 will still be visible when you are reading.
8360 All the normal summary mode commands are still available in the
8361 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
8362 which is mapped to the same function
8363 @code{gnus-summary-tick-article-forward}.
8365 If this sounds like a good idea to you, you could say:
8368 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
8371 @vindex gnus-pick-mode-hook
8372 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
8374 @vindex gnus-mark-unpicked-articles-as-read
8375 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
8376 all unpicked articles as read. The default is @code{nil}.
8378 @vindex gnus-summary-pick-line-format
8379 The summary line format in pick mode is slightly different from the
8380 standard format. At the beginning of each line the line number is
8381 displayed. The pick mode line format is controlled by the
8382 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
8383 Variables}). It accepts the same format specs that
8384 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
8388 @subsection Binary Groups
8389 @cindex binary groups
8391 @findex gnus-binary-mode
8392 @kindex M-x gnus-binary-mode
8393 If you spend much time in binary groups, you may grow tired of hitting
8394 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
8395 is a minor mode for summary buffers that makes all ordinary Gnus article
8396 selection functions uudecode series of articles and display the result
8397 instead of just displaying the articles the normal way.
8400 @findex gnus-binary-show-article
8401 The only way, in fact, to see the actual articles is the @kbd{g}
8402 command, when you have turned on this mode
8403 (@code{gnus-binary-show-article}).
8405 @vindex gnus-binary-mode-hook
8406 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
8410 @section Tree Display
8413 @vindex gnus-use-trees
8414 If you don't like the normal Gnus summary display, you might try setting
8415 @code{gnus-use-trees} to @code{t}. This will create (by default) an
8416 additional @dfn{tree buffer}. You can execute all summary mode commands
8419 There are a few variables to customize the tree display, of course:
8422 @item gnus-tree-mode-hook
8423 @vindex gnus-tree-mode-hook
8424 A hook called in all tree mode buffers.
8426 @item gnus-tree-mode-line-format
8427 @vindex gnus-tree-mode-line-format
8428 A format string for the mode bar in the tree mode buffers (@pxref{Mode
8429 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
8430 of valid specs, @pxref{Summary Buffer Mode Line}.
8432 @item gnus-selected-tree-face
8433 @vindex gnus-selected-tree-face
8434 Face used for highlighting the selected article in the tree buffer. The
8435 default is @code{modeline}.
8437 @item gnus-tree-line-format
8438 @vindex gnus-tree-line-format
8439 A format string for the tree nodes. The name is a bit of a misnomer,
8440 though---it doesn't define a line, but just the node. The default value
8441 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
8442 the name of the poster. It is vital that all nodes are of the same
8443 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
8449 The name of the poster.
8451 The @code{From} header.
8453 The number of the article.
8455 The opening bracket.
8457 The closing bracket.
8462 @xref{Formatting Variables}.
8464 Variables related to the display are:
8467 @item gnus-tree-brackets
8468 @vindex gnus-tree-brackets
8469 This is used for differentiating between ``real'' articles and
8470 ``sparse'' articles. The format is @code{((@var{real-open} . @var{real-close})
8471 (@var{sparse-open} . @var{sparse-close}) (@var{dummy-open} . @var{dummy-close}))}, and the
8472 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
8474 @item gnus-tree-parent-child-edges
8475 @vindex gnus-tree-parent-child-edges
8476 This is a list that contains the characters used for connecting parent
8477 nodes to their children. The default is @code{(?- ?\\ ?|)}.
8481 @item gnus-tree-minimize-window
8482 @vindex gnus-tree-minimize-window
8483 If this variable is non-@code{nil}, Gnus will try to keep the tree
8484 buffer as small as possible to allow more room for the other Gnus
8485 windows. If this variable is a number, the tree buffer will never be
8486 higher than that number. The default is @code{t}. Note that if you
8487 have several windows displayed side-by-side in a frame and the tree
8488 buffer is one of these, minimizing the tree window will also resize all
8489 other windows displayed next to it.
8491 @item gnus-generate-tree-function
8492 @vindex gnus-generate-tree-function
8493 @findex gnus-generate-horizontal-tree
8494 @findex gnus-generate-vertical-tree
8495 The function that actually generates the thread tree. Two predefined
8496 functions are available: @code{gnus-generate-horizontal-tree} and
8497 @code{gnus-generate-vertical-tree} (which is the default).
8501 Here's an example from a horizontal tree buffer:
8504 @{***@}-(***)-[odd]-[Gun]
8514 Here's the same thread displayed in a vertical tree buffer:
8518 |--------------------------\-----\-----\
8519 (***) [Bjo] [Gun] [Gun]
8521 [odd] [Jan] [odd] (***) [Jor]
8523 [Gun] [Eri] [Eri] [odd]
8528 If you're using horizontal trees, it might be nice to display the trees
8529 side-by-side with the summary buffer. You could add something like the
8530 following to your @file{.gnus.el} file:
8533 (setq gnus-use-trees t
8534 gnus-generate-tree-function 'gnus-generate-horizontal-tree
8535 gnus-tree-minimize-window nil)
8536 (gnus-add-configuration
8540 (summary 0.75 point)
8545 @xref{Windows Configuration}.
8548 @node Mail Group Commands
8549 @section Mail Group Commands
8550 @cindex mail group commands
8552 Some commands only make sense in mail groups. If these commands are
8553 invalid in the current group, they will raise a hell and let you know.
8555 All these commands (except the expiry and edit commands) use the
8556 process/prefix convention (@pxref{Process/Prefix}).
8561 @kindex B e (Summary)
8562 @findex gnus-summary-expire-articles
8563 Expire all expirable articles in the group
8564 (@code{gnus-summary-expire-articles}).
8567 @kindex B M-C-e (Summary)
8568 @findex gnus-summary-expire-articles-now
8569 Delete all the expirable articles in the group
8570 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
8571 articles eligible for expiry in the current group will
8572 disappear forever into that big @file{/dev/null} in the sky.
8575 @kindex B DEL (Summary)
8576 @findex gnus-summary-delete-article
8577 @c @icon{gnus-summary-mail-delete}
8578 Delete the mail article. This is ``delete'' as in ``delete it from your
8579 disk forever and ever, never to return again.'' Use with caution.
8580 (@code{gnus-summary-delete-article}).
8583 @kindex B m (Summary)
8585 @findex gnus-summary-move-article
8586 @vindex gnus-preserve-marks
8587 Move the article from one mail group to another
8588 (@code{gnus-summary-move-article}). Marks will be preserved if
8589 @var{gnus-preserve-marks} is non-@code{nil} (which is the default).
8592 @kindex B c (Summary)
8594 @findex gnus-summary-copy-article
8595 @c @icon{gnus-summary-mail-copy}
8596 Copy the article from one group (mail group or not) to a mail group
8597 (@code{gnus-summary-copy-article}). Marks will be preserved if
8598 @var{gnus-preserve-marks} is non-@code{nil} (which is the default).
8601 @kindex B B (Summary)
8602 @cindex crosspost mail
8603 @findex gnus-summary-crosspost-article
8604 Crosspost the current article to some other group
8605 (@code{gnus-summary-crosspost-article}). This will create a new copy of
8606 the article in the other group, and the Xref headers of the article will
8607 be properly updated.
8610 @kindex B i (Summary)
8611 @findex gnus-summary-import-article
8612 Import an arbitrary file into the current mail newsgroup
8613 (@code{gnus-summary-import-article}). You will be prompted for a file
8614 name, a @code{From} header and a @code{Subject} header.
8617 @kindex B r (Summary)
8618 @findex gnus-summary-respool-article
8619 Respool the mail article (@code{gnus-summary-respool-article}).
8620 @code{gnus-summary-respool-default-method} will be used as the default
8621 select method when respooling. This variable is @code{nil} by default,
8622 which means that the current group select method will be used instead.
8623 Marks will be preserved if @var{gnus-preserve-marks} is non-@code{nil}
8624 (which is the default).
8628 @kindex B w (Summary)
8630 @findex gnus-summary-edit-article
8631 @kindex C-c C-c (Article)
8632 Edit the current article (@code{gnus-summary-edit-article}). To finish
8633 editing and make the changes permanent, type @kbd{C-c C-c}
8634 (@kbd{gnus-summary-edit-article-done}). If you give a prefix to the
8635 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
8638 @kindex B q (Summary)
8639 @findex gnus-summary-respool-query
8640 If you want to re-spool an article, you might be curious as to what group
8641 the article will end up in before you do the re-spooling. This command
8642 will tell you (@code{gnus-summary-respool-query}).
8645 @kindex B t (Summary)
8646 @findex gnus-summary-respool-trace
8647 Similarly, this command will display all fancy splitting patterns used
8648 when repooling, if any (@code{gnus-summary-respool-trace}).
8651 @kindex B p (Summary)
8652 @findex gnus-summary-article-posted-p
8653 Some people have a tendency to send you "courtesy" copies when they
8654 follow up to articles you have posted. These usually have a
8655 @code{Newsgroups} header in them, but not always. This command
8656 (@code{gnus-summary-article-posted-p}) will try to fetch the current
8657 article from your news server (or rather, from
8658 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
8659 report back whether it found the article or not. Even if it says that
8660 it didn't find the article, it may have been posted anyway---mail
8661 propagation is much faster than news propagation, and the news copy may
8662 just not have arrived yet.
8666 @vindex gnus-move-split-methods
8667 @cindex moving articles
8668 If you move (or copy) articles regularly, you might wish to have Gnus
8669 suggest where to put the articles. @code{gnus-move-split-methods} is a
8670 variable that uses the same syntax as @code{gnus-split-methods}
8671 (@pxref{Saving Articles}). You may customize that variable to create
8672 suggestions you find reasonable. (Note that
8673 @code{gnus-move-split-methods} uses group names where
8674 @code{gnus-split-methods} uses file names.)
8677 (setq gnus-move-split-methods
8678 '(("^From:.*Lars Magne" "nnml:junk")
8679 ("^Subject:.*gnus" "nnfolder:important")
8680 (".*" "nnml:misc")))
8684 @node Various Summary Stuff
8685 @section Various Summary Stuff
8688 * Summary Group Information:: Information oriented commands.
8689 * Searching for Articles:: Multiple article commands.
8690 * Summary Generation Commands:: (Re)generating the summary buffer.
8691 * Really Various Summary Commands:: Those pesky non-conformant commands.
8695 @vindex gnus-summary-mode-hook
8696 @item gnus-summary-mode-hook
8697 This hook is called when creating a summary mode buffer.
8699 @vindex gnus-summary-generate-hook
8700 @item gnus-summary-generate-hook
8701 This is called as the last thing before doing the threading and the
8702 generation of the summary buffer. It's quite convenient for customizing
8703 the threading variables based on what data the newsgroup has. This hook
8704 is called from the summary buffer after most summary buffer variables
8707 @vindex gnus-summary-prepare-hook
8708 @item gnus-summary-prepare-hook
8709 It is called after the summary buffer has been generated. You might use
8710 it to, for instance, highlight lines or modify the look of the buffer in
8711 some other ungodly manner. I don't care.
8713 @vindex gnus-summary-prepared-hook
8714 @item gnus-summary-prepared-hook
8715 A hook called as the very last thing after the summary buffer has been
8718 @vindex gnus-summary-ignore-duplicates
8719 @item gnus-summary-ignore-duplicates
8720 When Gnus discovers two articles that have the same @code{Message-ID},
8721 it has to do something drastic. No articles are allowed to have the
8722 same @code{Message-ID}, but this may happen when reading mail from some
8723 sources. Gnus allows you to customize what happens with this variable.
8724 If it is @code{nil} (which is the default), Gnus will rename the
8725 @code{Message-ID} (for display purposes only) and display the article as
8726 any other article. If this variable is @code{t}, it won't display the
8727 article---it'll be as if it never existed.
8729 @vindex gnus-alter-articles-to-read-function
8730 @item gnus-alter-articles-to-read-function
8731 This function, which takes two parameters (the group name and the list
8732 of articles to be selected), is called to allow the user to alter the
8733 list of articles to be selected.
8735 For instance, the following function adds the list of cached articles to
8736 the list in one particular group:
8739 (defun my-add-cached-articles (group articles)
8740 (if (string= group "some.group")
8741 (append gnus-newsgroup-cached articles)
8748 @node Summary Group Information
8749 @subsection Summary Group Information
8754 @kindex H f (Summary)
8755 @findex gnus-summary-fetch-faq
8756 @vindex gnus-group-faq-directory
8757 Try to fetch the FAQ (list of frequently asked questions) for the
8758 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
8759 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
8760 on a remote machine. This variable can also be a list of directories.
8761 In that case, giving a prefix to this command will allow you to choose
8762 between the various sites. @code{ange-ftp} or @code{efs} will probably
8763 be used for fetching the file.
8766 @kindex H d (Summary)
8767 @findex gnus-summary-describe-group
8768 Give a brief description of the current group
8769 (@code{gnus-summary-describe-group}). If given a prefix, force
8770 rereading the description from the server.
8773 @kindex H h (Summary)
8774 @findex gnus-summary-describe-briefly
8775 Give an extremely brief description of the most important summary
8776 keystrokes (@code{gnus-summary-describe-briefly}).
8779 @kindex H i (Summary)
8780 @findex gnus-info-find-node
8781 Go to the Gnus info node (@code{gnus-info-find-node}).
8785 @node Searching for Articles
8786 @subsection Searching for Articles
8791 @kindex M-s (Summary)
8792 @findex gnus-summary-search-article-forward
8793 Search through all subsequent articles for a regexp
8794 (@code{gnus-summary-search-article-forward}).
8797 @kindex M-r (Summary)
8798 @findex gnus-summary-search-article-backward
8799 Search through all previous articles for a regexp
8800 (@code{gnus-summary-search-article-backward}).
8804 @findex gnus-summary-execute-command
8805 This command will prompt you for a header, a regular expression to match
8806 on this field, and a command to be executed if the match is made
8807 (@code{gnus-summary-execute-command}). If the header is an empty
8808 string, the match is done on the entire article. If given a prefix,
8809 search backward instead.
8811 For instance, @kbd{& RET some.*string #} will put the process mark on
8812 all articles that have heads or bodies that match @samp{some.*string}.
8815 @kindex M-& (Summary)
8816 @findex gnus-summary-universal-argument
8817 Perform any operation on all articles that have been marked with
8818 the process mark (@code{gnus-summary-universal-argument}).
8821 @node Summary Generation Commands
8822 @subsection Summary Generation Commands
8827 @kindex Y g (Summary)
8828 @findex gnus-summary-prepare
8829 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
8832 @kindex Y c (Summary)
8833 @findex gnus-summary-insert-cached-articles
8834 Pull all cached articles (for the current group) into the summary buffer
8835 (@code{gnus-summary-insert-cached-articles}).
8840 @node Really Various Summary Commands
8841 @subsection Really Various Summary Commands
8847 @kindex C-d (Summary)
8848 @kindex A D (Summary)
8849 @findex gnus-summary-enter-digest-group
8850 If the current article is a collection of other articles (for instance,
8851 a digest), you might use this command to enter a group based on the that
8852 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
8853 guess what article type is currently displayed unless you give a prefix
8854 to this command, which forces a ``digest'' interpretation. Basically,
8855 whenever you see a message that is a collection of other messages of
8856 some format, you @kbd{C-d} and read these messages in a more convenient
8860 @kindex M-C-d (Summary)
8861 @findex gnus-summary-read-document
8862 This command is very similar to the one above, but lets you gather
8863 several documents into one biiig group
8864 (@code{gnus-summary-read-document}). It does this by opening several
8865 @code{nndoc} groups for each document, and then opening an
8866 @code{nnvirtual} group on top of these @code{nndoc} groups. This
8867 command understands the process/prefix convention
8868 (@pxref{Process/Prefix}).
8871 @kindex C-t (Summary)
8872 @findex gnus-summary-toggle-truncation
8873 Toggle truncation of summary lines
8874 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
8875 line centering function in the summary buffer, so it's not a good idea
8876 to have truncation switched off while reading articles.
8880 @findex gnus-summary-expand-window
8881 Expand the summary buffer window (@code{gnus-summary-expand-window}).
8882 If given a prefix, force an @code{article} window configuration.
8885 @kindex M-C-e (Summary)
8886 @findex gnus-summary-edit-parameters
8887 Edit the group parameters (@pxref{Group Parameters}) of the current
8888 group (@code{gnus-summary-edit-parameters}).
8891 @kindex M-C-a (Summary)
8892 @findex gnus-summary-customize-parameters
8893 Customize the group parameters (@pxref{Group Parameters}) of the current
8894 group (@code{gnus-summary-customize-parameters}).
8899 @node Exiting the Summary Buffer
8900 @section Exiting the Summary Buffer
8901 @cindex summary exit
8902 @cindex exiting groups
8904 Exiting from the summary buffer will normally update all info on the
8905 group and return you to the group buffer.
8911 @kindex Z Z (Summary)
8913 @findex gnus-summary-exit
8914 @vindex gnus-summary-exit-hook
8915 @vindex gnus-summary-prepare-exit-hook
8916 @c @icon{gnus-summary-exit}
8917 Exit the current group and update all information on the group
8918 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
8919 called before doing much of the exiting, which calls
8920 @code{gnus-summary-expire-articles} by default.
8921 @code{gnus-summary-exit-hook} is called after finishing the exit
8922 process. @code{gnus-group-no-more-groups-hook} is run when returning to
8923 group mode having no more (unread) groups.
8927 @kindex Z E (Summary)
8929 @findex gnus-summary-exit-no-update
8930 Exit the current group without updating any information on the group
8931 (@code{gnus-summary-exit-no-update}).
8935 @kindex Z c (Summary)
8937 @findex gnus-summary-catchup-and-exit
8938 @c @icon{gnus-summary-catchup-and-exit}
8939 Mark all unticked articles in the group as read and then exit
8940 (@code{gnus-summary-catchup-and-exit}).
8943 @kindex Z C (Summary)
8944 @findex gnus-summary-catchup-all-and-exit
8945 Mark all articles, even the ticked ones, as read and then exit
8946 (@code{gnus-summary-catchup-all-and-exit}).
8949 @kindex Z n (Summary)
8950 @findex gnus-summary-catchup-and-goto-next-group
8951 Mark all articles as read and go to the next group
8952 (@code{gnus-summary-catchup-and-goto-next-group}).
8955 @kindex Z R (Summary)
8956 @findex gnus-summary-reselect-current-group
8957 Exit this group, and then enter it again
8958 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
8959 all articles, both read and unread.
8963 @kindex Z G (Summary)
8964 @kindex M-g (Summary)
8965 @findex gnus-summary-rescan-group
8966 @c @icon{gnus-summary-mail-get}
8967 Exit the group, check for new articles in the group, and select the
8968 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
8969 articles, both read and unread.
8972 @kindex Z N (Summary)
8973 @findex gnus-summary-next-group
8974 Exit the group and go to the next group
8975 (@code{gnus-summary-next-group}).
8978 @kindex Z P (Summary)
8979 @findex gnus-summary-prev-group
8980 Exit the group and go to the previous group
8981 (@code{gnus-summary-prev-group}).
8984 @kindex Z s (Summary)
8985 @findex gnus-summary-save-newsrc
8986 Save the current number of read/marked articles in the dribble buffer
8987 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
8988 given a prefix, also save the @file{.newsrc} file(s). Using this
8989 command will make exit without updating (the @kbd{Q} command) worthless.
8992 @vindex gnus-exit-group-hook
8993 @code{gnus-exit-group-hook} is called when you exit the current group
8994 with an ``updating'' exit. For instance @kbd{Q}
8995 (@code{gnus-summary-exit-no-update}) does not call this hook.
8997 @findex gnus-summary-wake-up-the-dead
8998 @findex gnus-dead-summary-mode
8999 @vindex gnus-kill-summary-on-exit
9000 If you're in the habit of exiting groups, and then changing your mind
9001 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
9002 If you do that, Gnus won't kill the summary buffer when you exit it.
9003 (Quelle surprise!) Instead it will change the name of the buffer to
9004 something like @samp{*Dead Summary ... *} and install a minor mode
9005 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
9006 buffer, you'll find that all keys are mapped to a function called
9007 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
9008 summary buffer will result in a live, normal summary buffer.
9010 There will never be more than one dead summary buffer at any one time.
9012 @vindex gnus-use-cross-reference
9013 The data on the current group will be updated (which articles you have
9014 read, which articles you have replied to, etc.) when you exit the
9015 summary buffer. If the @code{gnus-use-cross-reference} variable is
9016 @code{t} (which is the default), articles that are cross-referenced to
9017 this group and are marked as read, will also be marked as read in the
9018 other subscribed groups they were cross-posted to. If this variable is
9019 neither @code{nil} nor @code{t}, the article will be marked as read in
9020 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
9023 @node Crosspost Handling
9024 @section Crosspost Handling
9028 Marking cross-posted articles as read ensures that you'll never have to
9029 read the same article more than once. Unless, of course, somebody has
9030 posted it to several groups separately. Posting the same article to
9031 several groups (not cross-posting) is called @dfn{spamming}, and you are
9032 by law required to send nasty-grams to anyone who perpetrates such a
9033 heinous crime. You may want to try NoCeM handling to filter out spam
9036 Remember: Cross-posting is kinda ok, but posting the same article
9037 separately to several groups is not. Massive cross-posting (aka.
9038 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
9039 @code{gnus-summary-mail-crosspost-complaint} command to complain about
9040 excessive crossposting (@pxref{Summary Mail Commands}).
9042 @cindex cross-posting
9045 One thing that may cause Gnus to not do the cross-posting thing
9046 correctly is if you use an @sc{nntp} server that supports @sc{xover}
9047 (which is very nice, because it speeds things up considerably) which
9048 does not include the @code{Xref} header in its @sc{nov} lines. This is
9049 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
9050 even with @sc{xover} by registering the @code{Xref} lines of all
9051 articles you actually read, but if you kill the articles, or just mark
9052 them as read without reading them, Gnus will not get a chance to snoop
9053 the @code{Xref} lines out of these articles, and will be unable to use
9054 the cross reference mechanism.
9056 @cindex LIST overview.fmt
9057 @cindex overview.fmt
9058 To check whether your @sc{nntp} server includes the @code{Xref} header
9059 in its overview files, try @samp{telnet your.nntp.server nntp},
9060 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
9061 overview.fmt}. This may not work, but if it does, and the last line you
9062 get does not read @samp{Xref:full}, then you should shout and whine at
9063 your news admin until she includes the @code{Xref} header in the
9066 @vindex gnus-nov-is-evil
9067 If you want Gnus to get the @code{Xref}s right all the time, you have to
9068 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
9073 For an alternative approach, @pxref{Duplicate Suppression}.
9076 @node Duplicate Suppression
9077 @section Duplicate Suppression
9079 By default, Gnus tries to make sure that you don't have to read the same
9080 article more than once by utilizing the crossposting mechanism
9081 (@pxref{Crosspost Handling}). However, that simple and efficient
9082 approach may not work satisfactory for some users for various
9087 The @sc{nntp} server may fail to generate the @code{Xref} header. This
9088 is evil and not very common.
9091 The @sc{nntp} server may fail to include the @code{Xref} header in the
9092 @file{.overview} data bases. This is evil and all too common, alas.
9095 You may be reading the same group (or several related groups) from
9096 different @sc{nntp} servers.
9099 You may be getting mail that duplicates articles posted to groups.
9102 I'm sure there are other situations where @code{Xref} handling fails as
9103 well, but these four are the most common situations.
9105 If, and only if, @code{Xref} handling fails for you, then you may
9106 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
9107 will remember the @code{Message-ID}s of all articles you have read or
9108 otherwise marked as read, and then, as if by magic, mark them as read
9109 all subsequent times you see them---in @emph{all} groups. Using this
9110 mechanism is quite likely to be somewhat inefficient, but not overly
9111 so. It's certainly preferable to reading the same articles more than
9114 Duplicate suppression is not a very subtle instrument. It's more like a
9115 sledge hammer than anything else. It works in a very simple
9116 fashion---if you have marked an article as read, it adds this Message-ID
9117 to a cache. The next time it sees this Message-ID, it will mark the
9118 article as read with the @samp{M} mark. It doesn't care what group it
9122 @item gnus-suppress-duplicates
9123 @vindex gnus-suppress-duplicates
9124 If non-@code{nil}, suppress duplicates.
9126 @item gnus-save-duplicate-list
9127 @vindex gnus-save-duplicate-list
9128 If non-@code{nil}, save the list of duplicates to a file. This will
9129 make startup and shutdown take longer, so the default is @code{nil}.
9130 However, this means that only duplicate articles read in a single Gnus
9131 session are suppressed.
9133 @item gnus-duplicate-list-length
9134 @vindex gnus-duplicate-list-length
9135 This variable says how many @code{Message-ID}s to keep in the duplicate
9136 suppression list. The default is 10000.
9138 @item gnus-duplicate-file
9139 @vindex gnus-duplicate-file
9140 The name of the file to store the duplicate suppression list in. The
9141 default is @file{~/News/suppression}.
9144 If you have a tendency to stop and start Gnus often, setting
9145 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
9146 you leave Gnus running for weeks on end, you may have it @code{nil}. On
9147 the other hand, saving the list makes startup and shutdown much slower,
9148 so that means that if you stop and start Gnus often, you should set
9149 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
9150 to you to figure out, I think.
9155 Gnus is able to verify PGP or S/MIME signed messages or decrypt PGP
9160 To verify or decrypt PGP messages, you have to install mailcrypt or
9166 @item mm-verify-option
9167 @vindex mm-verify-option
9168 Option of verifying signed parts. @code{never}, not verify;
9169 @code{always}, always verify; @code{known}, only verify known
9170 protocols. Otherwise, ask user.
9172 @item mm-decrypt-option
9173 @vindex mm-decrypt-option
9174 Option of decrypting encrypted parts. @code{never}, no decryption;
9175 @code{always}, always decrypt @code{known}, only decrypt known
9176 protocols. Otherwise, ask user.
9180 @node Article Buffer
9181 @chapter Article Buffer
9182 @cindex article buffer
9184 The articles are displayed in the article buffer, of which there is only
9185 one. All the summary buffers share the same article buffer unless you
9186 tell Gnus otherwise.
9189 * Hiding Headers:: Deciding what headers should be displayed.
9190 * Using MIME:: Pushing articles through @sc{mime} before reading them.
9191 * Customizing Articles:: Tailoring the look of the articles.
9192 * Article Keymap:: Keystrokes available in the article buffer.
9193 * Misc Article:: Other stuff.
9197 @node Hiding Headers
9198 @section Hiding Headers
9199 @cindex hiding headers
9200 @cindex deleting headers
9202 The top section of each article is the @dfn{head}. (The rest is the
9203 @dfn{body}, but you may have guessed that already.)
9205 @vindex gnus-show-all-headers
9206 There is a lot of useful information in the head: the name of the person
9207 who wrote the article, the date it was written and the subject of the
9208 article. That's well and nice, but there's also lots of information
9209 most people do not want to see---what systems the article has passed
9210 through before reaching you, the @code{Message-ID}, the
9211 @code{References}, etc. ad nauseum---and you'll probably want to get rid
9212 of some of those lines. If you want to keep all those lines in the
9213 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
9215 Gnus provides you with two variables for sifting headers:
9219 @item gnus-visible-headers
9220 @vindex gnus-visible-headers
9221 If this variable is non-@code{nil}, it should be a regular expression
9222 that says what headers you wish to keep in the article buffer. All
9223 headers that do not match this variable will be hidden.
9225 For instance, if you only want to see the name of the person who wrote
9226 the article and the subject, you'd say:
9229 (setq gnus-visible-headers "^From:\\|^Subject:")
9232 This variable can also be a list of regexps to match headers to
9235 @item gnus-ignored-headers
9236 @vindex gnus-ignored-headers
9237 This variable is the reverse of @code{gnus-visible-headers}. If this
9238 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
9239 should be a regular expression that matches all lines that you want to
9240 hide. All lines that do not match this variable will remain visible.
9242 For instance, if you just want to get rid of the @code{References} line
9243 and the @code{Xref} line, you might say:
9246 (setq gnus-ignored-headers "^References:\\|^Xref:")
9249 This variable can also be a list of regexps to match headers to
9252 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
9253 variable will have no effect.
9257 @vindex gnus-sorted-header-list
9258 Gnus can also sort the headers for you. (It does this by default.) You
9259 can control the sorting by setting the @code{gnus-sorted-header-list}
9260 variable. It is a list of regular expressions that says in what order
9261 the headers are to be displayed.
9263 For instance, if you want the name of the author of the article first,
9264 and then the subject, you might say something like:
9267 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
9270 Any headers that are to remain visible, but are not listed in this
9271 variable, will be displayed in random order after all the headers listed in this variable.
9273 @findex gnus-article-hide-boring-headers
9274 @vindex gnus-boring-article-headers
9275 You can hide further boring headers by setting
9276 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
9277 does depends on the @code{gnus-boring-article-headers} variable. It's a
9278 list, but this list doesn't actually contain header names. Instead is
9279 lists various @dfn{boring conditions} that Gnus can check and remove
9282 These conditions are:
9285 Remove all empty headers.
9287 Remove the @code{Followup-To} header if it is identical to the
9288 @code{Newsgroups} header.
9290 Remove the @code{Reply-To} header if it lists the same address as the
9293 Remove the @code{Newsgroups} header if it only contains the current group
9296 Remove the @code{To} header if it only contains the address identical to
9297 the current groups's @code{to-address} parameter.
9299 Remove the @code{Date} header if the article is less than three days
9302 Remove the @code{To} header if it is very long.
9304 Remove all @code{To} headers if there are more than one.
9307 To include these three elements, you could say something like;
9310 (setq gnus-boring-article-headers
9311 '(empty followup-to reply-to))
9314 This is also the default value for this variable.
9318 @section Using @sc{mime}
9321 Mime is a standard for waving your hands through the air, aimlessly,
9322 while people stand around yawning.
9324 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
9325 while all newsreaders die of fear.
9327 @sc{mime} may specify what character set the article uses, the encoding
9328 of the characters, and it also makes it possible to embed pictures and
9329 other naughty stuff in innocent-looking articles.
9331 @vindex gnus-display-mime-function
9332 @findex gnus-display-mime
9333 Gnus pushes @sc{mime} articles through @code{gnus-display-mime-function}
9334 to display the @sc{mime} parts. This is @code{gnus-display-mime} by
9335 default, which creates a bundle of clickable buttons that can be used to
9336 display, save and manipulate the @sc{mime} objects.
9338 The following commands are available when you have placed point over a
9342 @findex gnus-article-press-button
9344 @itemx BUTTON-2 (Article)
9345 Toggle displaying of the @sc{mime} object
9346 (@code{gnus-article-press-button}).
9348 @findex gnus-mime-view-part
9349 @item M-RET (Article)
9351 Prompt for a method, and then view the @sc{mime} object using this
9352 method (@code{gnus-mime-view-part}).
9354 @findex gnus-mime-save-part
9356 Prompt for a file name, and then save the @sc{mime} object
9357 (@code{gnus-mime-save-part}).
9359 @findex gnus-mime-copy-part
9361 Copy the @sc{mime} object to a fresh buffer and display this buffer
9362 (@code{gnus-mime-copy-part}).
9364 @findex gnus-mime-view-part-as-type
9366 View the @sc{mime} object as if it were a different @sc{mime} media type
9367 (@code{gnus-mime-view-part-as-type}).
9369 @findex gnus-mime-pipe-part
9371 Output the @sc{mime} object to a process (@code{gnus-mime-pipe-part}).
9373 @findex gnus-mime-inline-part
9375 Insert the contents of the @sc{mime} object into the buffer
9376 (@code{gnus-mime-inline-part}) as text/plain. If given a prefix, insert
9377 the raw contents without decoding. If given a numerical prefix, you can
9378 do semi-manual charset stuff (see
9379 @code{gnus-summary-show-article-charset-alist} in @pxref{Paging the
9382 @findex gnus-mime-action-on-part
9384 Interactively run an action on the @sc{mime} object
9385 (@code{gnus-mime-action-on-part}).
9389 Gnus will display some @sc{mime} objects automatically. The way Gnus
9390 determines which parts to do this with is described in the Emacs MIME
9393 It might be best to just use the toggling functions from the article
9394 buffer to avoid getting nasty surprises. (For instance, you enter the
9395 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
9396 decoded the sound file in the article and some horrible sing-a-long song
9397 comes screaming out your speakers, and you can't find the volume button,
9398 because there isn't one, and people are starting to look at you, and you
9399 try to stop the program, but you can't, and you can't find the program
9400 to control the volume, and everybody else in the room suddenly decides
9401 to look at you disdainfully, and you'll feel rather stupid.)
9403 Any similarity to real events and people is purely coincidental. Ahem.
9405 Also see @pxref{MIME Commands}.
9408 @node Customizing Articles
9409 @section Customizing Articles
9410 @cindex article customization
9412 A slew of functions for customizing how the articles are to look like
9413 exist. You can call these functions interactively, or you can have them
9414 called automatically when you select the articles.
9416 To have them called automatically, you should set the corresponding
9417 ``treatment'' variable. For instance, to have headers hidden, you'd set
9418 @code{gnus-treat-hide-headers}. Below is a list of variables that can
9419 be set, but first we discuss the values these variables can have.
9421 Note: Some values, while valid, make little sense. Check the list below
9422 for sensible values.
9426 @code{nil}: Don't do this treatment.
9429 @code{t}: Do this treatment on all body parts.
9432 @code{head}: Do the treatment on the headers.
9435 @code{last}: Do this treatment on the last part.
9438 An integer: Do this treatment on all body parts that have a length less
9442 A list of strings: Do this treatment on all body parts that are in
9443 articles that are read in groups that have names that match one of the
9444 regexps in the list.
9447 A list where the first element is not a string:
9449 The list is evaluated recursively. The first element of the list is a
9450 predicate. The following predicates are recognized: @code{or},
9451 @code{and}, @code{not} and @code{typep}. Here's an example:
9455 (typep "text/x-vcard"))
9460 You may have noticed that the word @dfn{part} is used here. This refers
9461 to the fact that some messages are @sc{mime} multipart articles that may
9462 be divided into several parts. Articles that are not multiparts are
9463 considered to contain just a single part.
9465 @vindex gnus-article-treat-types
9466 Are the treatments applied to all sorts of multipart parts? Yes, if you
9467 want to, but by default, only @samp{text/plain} parts are given the
9468 treatment. This is controlled by the @code{gnus-article-treat-types}
9469 variable, which is a list of regular expressions that are matched to the
9470 type of the part. This variable is ignored if the value of the
9471 controlling variable is a predicate list, as described above.
9473 The following treatment options are available. The easiest way to
9474 customize this is to examine the @code{gnus-article-treat} customization
9475 group. Values in parenthesis are suggested sensible values. Others are
9476 possible but those listed are probably sufficient for most people.
9479 @item gnus-treat-highlight-signature (t, last)
9480 @item gnus-treat-buttonize (t, integer)
9481 @item gnus-treat-buttonize-head (head)
9482 @item gnus-treat-emphasize (t, head, integer)
9483 @item gnus-treat-fill-article (t, integer)
9484 @item gnus-treat-strip-cr (t, integer)
9485 @item gnus-treat-hide-headers (head)
9486 @item gnus-treat-hide-boring-headers (head)
9487 @item gnus-treat-hide-signature (t, last)
9488 @item gnus-treat-hide-citation (t, integer)
9489 @item gnus-treat-hide-citation-maybe (t, integer)
9490 @item gnus-treat-strip-pgp (t, last, integer)
9491 @item gnus-treat-strip-pem (t, last, integer)
9492 @item gnus-treat-highlight-headers (head)
9493 @item gnus-treat-highlight-citation (t, integer)
9494 @item gnus-treat-highlight-signature (t, last, integer)
9495 @item gnus-treat-date-ut (head)
9496 @item gnus-treat-date-local (head)
9497 @item gnus-treat-date-english (head)
9498 @item gnus-treat-date-lapsed (head)
9499 @item gnus-treat-date-original (head)
9500 @item gnus-treat-date-iso8601 (head)
9501 @item gnus-treat-date-user-defined (head)
9502 @item gnus-treat-strip-headers-in-body (t, integer)
9503 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
9504 @item gnus-treat-strip-leading-blank-lines (t, integer)
9505 @item gnus-treat-strip-multiple-blank-lines (t, integer)
9506 @item gnus-treat-overstrike (t, integer)
9507 @item gnus-treat-display-xface (head)
9508 @item gnus-treat-display-smileys (t, integer)
9509 @item gnus-treat-display-picons (head)
9510 @item gnus-treat-capitalize-sentences (t, integer)
9511 @item gnus-treat-fill-long-lines (t, integer)
9512 @item gnus-treat-play-sounds
9513 @item gnus-treat-translate
9516 @vindex gnus-part-display-hook
9517 You can, of course, write your own functions to be called from
9518 @code{gnus-part-display-hook}. The functions are called narrowed to the
9519 part, and you can do anything you like, pretty much. There is no
9520 information that you have to keep in the buffer---you can change
9524 @node Article Keymap
9525 @section Article Keymap
9527 Most of the keystrokes in the summary buffer can also be used in the
9528 article buffer. They should behave as if you typed them in the summary
9529 buffer, which means that you don't actually have to have a summary
9530 buffer displayed while reading. You can do it all from the article
9533 A few additional keystrokes are available:
9538 @kindex SPACE (Article)
9539 @findex gnus-article-next-page
9540 Scroll forwards one page (@code{gnus-article-next-page}).
9543 @kindex DEL (Article)
9544 @findex gnus-article-prev-page
9545 Scroll backwards one page (@code{gnus-article-prev-page}).
9548 @kindex C-c ^ (Article)
9549 @findex gnus-article-refer-article
9550 If point is in the neighborhood of a @code{Message-ID} and you press
9551 @kbd{C-c ^}, Gnus will try to get that article from the server
9552 (@code{gnus-article-refer-article}).
9555 @kindex C-c C-m (Article)
9556 @findex gnus-article-mail
9557 Send a reply to the address near point (@code{gnus-article-mail}). If
9558 given a prefix, include the mail.
9562 @findex gnus-article-show-summary
9563 Reconfigure the buffers so that the summary buffer becomes visible
9564 (@code{gnus-article-show-summary}).
9568 @findex gnus-article-describe-briefly
9569 Give a very brief description of the available keystrokes
9570 (@code{gnus-article-describe-briefly}).
9573 @kindex TAB (Article)
9574 @findex gnus-article-next-button
9575 Go to the next button, if any (@code{gnus-article-next-button}). This
9576 only makes sense if you have buttonizing turned on.
9579 @kindex M-TAB (Article)
9580 @findex gnus-article-prev-button
9581 Go to the previous button, if any (@code{gnus-article-prev-button}).
9587 @section Misc Article
9591 @item gnus-single-article-buffer
9592 @vindex gnus-single-article-buffer
9593 If non-@code{nil}, use the same article buffer for all the groups.
9594 (This is the default.) If @code{nil}, each group will have its own
9597 @vindex gnus-article-decode-hook
9598 @item gnus-article-decode-hook
9600 Hook used to decode @sc{mime} articles. The default value is
9601 @code{(article-decode-charset article-decode-encoded-words)}
9603 @vindex gnus-article-prepare-hook
9604 @item gnus-article-prepare-hook
9605 This hook is called right after the article has been inserted into the
9606 article buffer. It is mainly intended for functions that do something
9607 depending on the contents; it should probably not be used for changing
9608 the contents of the article buffer.
9610 @item gnus-article-mode-hook
9611 @vindex gnus-article-mode-hook
9612 Hook called in article mode buffers.
9614 @item gnus-article-mode-syntax-table
9615 @vindex gnus-article-mode-syntax-table
9616 Syntax table used in article buffers. It is initialized from
9617 @code{text-mode-syntax-table}.
9619 @vindex gnus-article-mode-line-format
9620 @item gnus-article-mode-line-format
9621 This variable is a format string along the same lines as
9622 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}). It
9623 accepts the same format specifications as that variable, with two
9628 The @dfn{wash status} of the article. This is a short string with one
9629 character for each possible article wash operation that may have been
9632 The number of @sc{mime} parts in the article.
9635 @vindex gnus-break-pages
9637 @item gnus-break-pages
9638 Controls whether @dfn{page breaking} is to take place. If this variable
9639 is non-@code{nil}, the articles will be divided into pages whenever a
9640 page delimiter appears in the article. If this variable is @code{nil},
9641 paging will not be done.
9643 @item gnus-page-delimiter
9644 @vindex gnus-page-delimiter
9645 This is the delimiter mentioned above. By default, it is @samp{^L}
9650 @node Composing Messages
9651 @chapter Composing Messages
9652 @cindex composing messages
9655 @cindex sending mail
9661 @kindex C-c C-c (Post)
9662 All commands for posting and mailing will put you in a message buffer
9663 where you can edit the article all you like, before you send the
9664 article by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The
9665 Message Manual}. Where the message will be posted/mailed to depends
9666 on your setup (@pxref{Posting Server}).
9669 * Mail:: Mailing and replying.
9670 * Posting Server:: What server should you post via?
9671 * Mail and Post:: Mailing and posting at the same time.
9672 * Archived Messages:: Where Gnus stores the messages you've sent.
9673 * Posting Styles:: An easier way to specify who you are.
9674 * Drafts:: Postponing messages and rejected messages.
9675 * Rejected Articles:: What happens if the server doesn't like your article?
9676 * Using GPG:: How to use GPG and MML to sign and encrypt messages
9679 Also see @pxref{Canceling and Superseding} for information on how to
9680 remove articles you shouldn't have posted.
9686 Variables for customizing outgoing mail:
9689 @item gnus-uu-digest-headers
9690 @vindex gnus-uu-digest-headers
9691 List of regexps to match headers included in digested messages. The
9692 headers will be included in the sequence they are matched.
9694 @item gnus-add-to-list
9695 @vindex gnus-add-to-list
9696 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
9697 that have none when you do a @kbd{a}.
9702 @node Posting Server
9703 @section Posting Server
9705 When you press those magical @kbd{C-c C-c} keys to ship off your latest
9706 (extremely intelligent, of course) article, where does it go?
9708 Thank you for asking. I hate you.
9710 @vindex gnus-post-method
9712 It can be quite complicated. Normally, Gnus will post using the same
9713 select method as you're reading from (which might be convenient if
9714 you're reading lots of groups from different private servers).
9715 However. If the server you're reading from doesn't allow posting,
9716 just reading, you probably want to use some other server to post your
9717 (extremely intelligent and fabulously interesting) articles. You can
9718 then set the @code{gnus-post-method} to some other method:
9721 (setq gnus-post-method '(nnspool ""))
9724 Now, if you've done this, and then this server rejects your article, or
9725 this server is down, what do you do then? To override this variable you
9726 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
9727 the ``current'' server, to get back the default behaviour, for posting.
9729 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
9730 Gnus will prompt you for what method to use for posting.
9732 You can also set @code{gnus-post-method} to a list of select methods.
9733 If that's the case, Gnus will always prompt you for what method to use
9736 Finally, if you want to always post using the native select method,
9737 you can set this variable to @code{nil}.
9741 @section Mail and Post
9743 Here's a list of variables relevant to both mailing and
9747 @item gnus-mailing-list-groups
9748 @findex gnus-mailing-list-groups
9749 @cindex mailing lists
9751 If your news server offers groups that are really mailing lists
9752 gatewayed to the @sc{nntp} server, you can read those groups without
9753 problems, but you can't post/followup to them without some difficulty.
9754 One solution is to add a @code{to-address} to the group parameters
9755 (@pxref{Group Parameters}). An easier thing to do is set the
9756 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
9757 really are mailing lists. Then, at least, followups to the mailing
9758 lists will work most of the time. Posting to these groups (@kbd{a}) is
9759 still a pain, though.
9763 You may want to do spell-checking on messages that you send out. Or, if
9764 you don't want to spell-check by hand, you could add automatic
9765 spell-checking via the @code{ispell} package:
9768 @findex ispell-message
9770 (add-hook 'message-send-hook 'ispell-message)
9773 If you want to change the @code{ispell} dictionary based on what group
9774 you're in, you could say something like the following:
9777 (add-hook 'gnus-select-group-hook
9780 ((string-match "^de\\." gnus-newsgroup-name)
9781 (ispell-change-dictionary "deutsch"))
9783 (ispell-change-dictionary "english")))))
9786 Modify to suit your needs.
9789 @node Archived Messages
9790 @section Archived Messages
9791 @cindex archived messages
9792 @cindex sent messages
9794 Gnus provides a few different methods for storing the mail and news you
9795 send. The default method is to use the @dfn{archive virtual server} to
9796 store the messages. If you want to disable this completely, the
9797 @code{gnus-message-archive-group} variable should be @code{nil}, which
9800 @vindex gnus-message-archive-method
9801 @code{gnus-message-archive-method} says what virtual server Gnus is to
9802 use to store sent messages. The default is:
9806 (nnfolder-directory "~/Mail/archive")
9807 (nnfolder-active-file "~/Mail/archive/active")
9808 (nnfolder-get-new-mail nil)
9809 (nnfolder-inhibit-expiry t))
9812 You can, however, use any mail select method (@code{nnml},
9813 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
9814 for doing this sort of thing, though. If you don't like the default
9815 directory chosen, you could say something like:
9818 (setq gnus-message-archive-method
9819 '(nnfolder "archive"
9820 (nnfolder-inhibit-expiry t)
9821 (nnfolder-active-file "~/News/sent-mail/active")
9822 (nnfolder-directory "~/News/sent-mail/")))
9825 @vindex gnus-message-archive-group
9827 Gnus will insert @code{Gcc} headers in all outgoing messages that point
9828 to one or more group(s) on that server. Which group to use is
9829 determined by the @code{gnus-message-archive-group} variable.
9831 This variable can be used to do the following:
9835 Messages will be saved in that group.
9837 Note that you can include a select method in the group name, then the
9838 message will not be stored in the select method given by
9839 @code{gnus-message-archive-method}, but in the select method specified
9840 by the group name, instead. Suppose @code{gnus-message-archive-method}
9841 has the default value shown above. Then setting
9842 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
9843 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
9844 value @code{"nnml:foo"}, then outgoing messages will be stored in
9846 @item a list of strings
9847 Messages will be saved in all those groups.
9848 @item an alist of regexps, functions and forms
9849 When a key ``matches'', the result is used.
9851 No message archiving will take place. This is the default.
9856 Just saving to a single group called @samp{MisK}:
9858 (setq gnus-message-archive-group "MisK")
9861 Saving to two groups, @samp{MisK} and @samp{safe}:
9863 (setq gnus-message-archive-group '("MisK" "safe"))
9866 Save to different groups based on what group you are in:
9868 (setq gnus-message-archive-group
9869 '(("^alt" "sent-to-alt")
9870 ("mail" "sent-to-mail")
9871 (".*" "sent-to-misc")))
9876 (setq gnus-message-archive-group
9877 '((if (message-news-p)
9882 How about storing all news messages in one file, but storing all mail
9883 messages in one file per month:
9886 (setq gnus-message-archive-group
9887 '((if (message-news-p)
9889 (concat "mail." (format-time-string "%Y-%m")))))
9892 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
9893 use a different value for @code{gnus-message-archive-group} there.)
9895 Now, when you send a message off, it will be stored in the appropriate
9896 group. (If you want to disable storing for just one particular message,
9897 you can just remove the @code{Gcc} header that has been inserted.) The
9898 archive group will appear in the group buffer the next time you start
9899 Gnus, or the next time you press @kbd{F} in the group buffer. You can
9900 enter it and read the articles in it just like you'd read any other
9901 group. If the group gets really big and annoying, you can simply rename
9902 if (using @kbd{G r} in the group buffer) to something
9903 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
9904 continue to be stored in the old (now empty) group.
9906 That's the default method of archiving sent messages. Gnus offers a
9907 different way for the people who don't like the default method. In that
9908 case you should set @code{gnus-message-archive-group} to @code{nil};
9909 this will disable archiving.
9912 @item gnus-outgoing-message-group
9913 @vindex gnus-outgoing-message-group
9914 All outgoing messages will be put in this group. If you want to store
9915 all your outgoing mail and articles in the group @samp{nnml:archive},
9916 you set this variable to that value. This variable can also be a list of
9919 If you want to have greater control over what group to put each
9920 message in, you can set this variable to a function that checks the
9921 current newsgroup name and then returns a suitable group name (or list
9924 This variable can be used instead of @code{gnus-message-archive-group},
9925 but the latter is the preferred method.
9927 @item gnus-inews-mark-gcc-as-read
9928 @vindex gnus-inews-mark-gcc-as-read
9929 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
9934 @node Posting Styles
9935 @section Posting Styles
9936 @cindex posting styles
9939 All them variables, they make my head swim.
9941 So what if you want a different @code{Organization} and signature based
9942 on what groups you post to? And you post both from your home machine
9943 and your work machine, and you want different @code{From} lines, and so
9946 @vindex gnus-posting-styles
9947 One way to do stuff like that is to write clever hooks that change the
9948 variables you need to have changed. That's a bit boring, so somebody
9949 came up with the bright idea of letting the user specify these things in
9950 a handy alist. Here's an example of a @code{gnus-posting-styles}
9955 (signature "Peace and happiness")
9956 (organization "What me?"))
9958 (signature "Death to everybody"))
9959 ("comp.emacs.i-love-it"
9960 (organization "Emacs is it")))
9963 As you might surmise from this example, this alist consists of several
9964 @dfn{styles}. Each style will be applicable if the first element
9965 ``matches'', in some form or other. The entire alist will be iterated
9966 over, from the beginning towards the end, and each match will be
9967 applied, which means that attributes in later styles that match override
9968 the same attributes in earlier matching styles. So
9969 @samp{comp.programming.literate} will have the @samp{Death to everybody}
9970 signature and the @samp{What me?} @code{Organization} header.
9972 The first element in each style is called the @code{match}. If it's a
9973 string, then Gnus will try to regexp match it against the group name.
9974 If it is the symbol @code{header}, then Gnus will look for header (the
9975 next element in the match) in the original article , and compare that to
9976 the last regexp in the match. If it's a function symbol, that function
9977 will be called with no arguments. If it's a variable symbol, then the
9978 variable will be referenced. If it's a list, then that list will be
9979 @code{eval}ed. In any case, if this returns a non-@code{nil} value,
9980 then the style is said to @dfn{match}.
9982 Each style may contain a arbitrary amount of @dfn{attributes}. Each
9983 attribute consists of a @code{(@var{name} @var{value})} pair. The
9984 attribute name can be one of @code{signature}, @code{signature-file},
9985 @code{organization}, @code{address}, @code{name} or @code{body}. The
9986 attribute name can also be a string. In that case, this will be used as
9987 a header name, and the value will be inserted in the headers of the
9988 article; if the value is @code{nil}, the header name will be removed.
9989 If the attribute name is @code{eval}, the form is evaluated, and the
9990 result is thrown away.
9992 The attribute value can be a string (used verbatim), a function with
9993 zero arguments (the return value will be used), a variable (its value
9994 will be used) or a list (it will be @code{eval}ed and the return value
9995 will be used). The functions and sexps are called/@code{eval}ed in the
9996 message buffer that is being set up. The headers of the current article
9997 are available through the @code{message-reply-headers} variable.
9999 If you wish to check whether the message you are about to compose is
10000 meant to be a news article or a mail message, you can check the values
10001 of the @code{message-news-p} and @code{message-mail-p} functions.
10003 @findex message-mail-p
10004 @findex message-news-p
10006 So here's a new example:
10009 (setq gnus-posting-styles
10011 (signature-file "~/.signature")
10013 ("X-Home-Page" (getenv "WWW_HOME"))
10014 (organization "People's Front Against MWM"))
10016 (signature my-funny-signature-randomizer))
10017 ((equal (system-name) "gnarly")
10018 (signature my-quote-randomizer))
10020 (signature my-news-signature))
10021 (header "to" "larsi.*org"
10022 (Organization "Somewhere, Inc."))
10023 ((posting-from-work-p)
10024 (signature-file "~/.work-signature")
10025 (address "user@@bar.foo")
10026 (body "You are fired.\n\nSincerely, your boss.")
10027 (organization "Important Work, Inc"))
10029 (From (save-excursion
10030 (set-buffer gnus-article-buffer)
10031 (message-fetch-field "to"))))
10033 (signature-file "~/.mail-signature"))))
10036 The @samp{nnml:.*} rule means that you use the @code{To} address as the
10037 @code{From} address in all your outgoing replies, which might be handy
10038 if you fill many roles.
10045 If you are writing a message (mail or news) and suddenly remember that
10046 you have a steak in the oven (or some pesto in the food processor, you
10047 craaazy vegetarians), you'll probably wish there was a method to save
10048 the message you are writing so that you can continue editing it some
10049 other day, and send it when you feel its finished.
10051 Well, don't worry about it. Whenever you start composing a message of
10052 some sort using the Gnus mail and post commands, the buffer you get will
10053 automatically associate to an article in a special @dfn{draft} group.
10054 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
10055 article will be saved there. (Auto-save files also go to the draft
10059 @vindex nndraft-directory
10060 The draft group is a special group (which is implemented as an
10061 @code{nndraft} group, if you absolutely have to know) called
10062 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
10063 @code{nndraft} is to store its files. What makes this group special is
10064 that you can't tick any articles in it or mark any articles as
10065 read---all articles in the group are permanently unread.
10067 If the group doesn't exist, it will be created and you'll be subscribed
10068 to it. The only way to make it disappear from the Group buffer is to
10071 @c @findex gnus-dissociate-buffer-from-draft
10072 @c @kindex C-c M-d (Mail)
10073 @c @kindex C-c M-d (Post)
10074 @c @findex gnus-associate-buffer-with-draft
10075 @c @kindex C-c C-d (Mail)
10076 @c @kindex C-c C-d (Post)
10077 @c If you're writing some super-secret message that you later want to
10078 @c encode with PGP before sending, you may wish to turn the auto-saving
10079 @c (and association with the draft group) off. You never know who might be
10080 @c interested in reading all your extremely valuable and terribly horrible
10081 @c and interesting secrets. The @kbd{C-c M-d}
10082 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
10083 @c If you change your mind and want to turn the auto-saving back on again,
10084 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
10086 @c @vindex gnus-use-draft
10087 @c To leave association with the draft group off by default, set
10088 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
10090 @findex gnus-draft-edit-message
10091 @kindex D e (Draft)
10092 When you want to continue editing the article, you simply enter the
10093 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
10094 that. You will be placed in a buffer where you left off.
10096 Rejected articles will also be put in this draft group (@pxref{Rejected
10099 @findex gnus-draft-send-all-messages
10100 @findex gnus-draft-send-message
10101 If you have lots of rejected messages you want to post (or mail) without
10102 doing further editing, you can use the @kbd{D s} command
10103 (@code{gnus-draft-send-message}). This command understands the
10104 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
10105 command (@code{gnus-draft-send-all-messages}) will ship off all messages
10108 If you have some messages that you wish not to send, you can use the
10109 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
10110 as unsendable. This is a toggling command.
10113 @node Rejected Articles
10114 @section Rejected Articles
10115 @cindex rejected articles
10117 Sometimes a news server will reject an article. Perhaps the server
10118 doesn't like your face. Perhaps it just feels miserable. Perhaps
10119 @emph{there be demons}. Perhaps you have included too much cited text.
10120 Perhaps the disk is full. Perhaps the server is down.
10122 These situations are, of course, totally beyond the control of Gnus.
10123 (Gnus, of course, loves the way you look, always feels great, has angels
10124 fluttering around inside of it, doesn't care about how much cited text
10125 you include, never runs full and never goes down.) So Gnus saves these
10126 articles until some later time when the server feels better.
10128 The rejected articles will automatically be put in a special draft group
10129 (@pxref{Drafts}). When the server comes back up again, you'd then
10130 typically enter that group and send all the articles off.
10136 Gnus has an ALPHA support to GPG that's provided by @file{gpg.el}. See
10137 @code{mm-verify-option} and @code{mm-decrypt-option} to enable Gnus to
10138 verify or decrypt messages accordingly.
10140 To use this correctly with GPG, you'll need the following lisp code in your
10141 @file{~/.emacs} or @file{~/.gnus}:
10145 (setq mml2015-use 'gpg)
10146 (setq gpg-temp-directory (expand-file-name "~/.gnupg/tmp"))
10149 The @code{gpg-temp-directory} need to point to a directory with permissions set
10150 to 700, for your own safety.
10152 If you want to benefit of PGP2.6 compatibility, you might create a script named
10153 @file{gpg-2comp} with these instructions:
10157 exec gpg --rfc1991 "$@@"
10160 If you don't want to use such compatibility, you can add the following line to
10161 your @file{~/.emacs} or @file{~/.gnus}:
10164 (setq gpg-command-default-alist (quote ((gpg . "gpg") (gpg-2comp . "gpg"))))
10167 To sign or encrypt your message you may choose to use the MML Security
10168 menu or @kbd{C-c C-m s p} to sign your message using PGP/MIME, @kbd{C-c
10169 C-m s s} to sign your message using S/MIME. There's also @kbd{C-c C-m c
10170 p} to encrypt your message with PGP/MIME and @kbd{C-c C-m c s} to
10171 encrypt using S/MIME.
10173 Gnus will ask for your passphrase and then it will send your message, if
10174 you've typed it correctly.
10176 @node Select Methods
10177 @chapter Select Methods
10178 @cindex foreign groups
10179 @cindex select methods
10181 A @dfn{foreign group} is a group not read by the usual (or
10182 default) means. It could be, for instance, a group from a different
10183 @sc{nntp} server, it could be a virtual group, or it could be your own
10184 personal mail group.
10186 A foreign group (or any group, really) is specified by a @dfn{name} and
10187 a @dfn{select method}. To take the latter first, a select method is a
10188 list where the first element says what backend to use (e.g. @code{nntp},
10189 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
10190 name}. There may be additional elements in the select method, where the
10191 value may have special meaning for the backend in question.
10193 One could say that a select method defines a @dfn{virtual server}---so
10194 we do just that (@pxref{Server Buffer}).
10196 The @dfn{name} of the group is the name the backend will recognize the
10199 For instance, the group @samp{soc.motss} on the @sc{nntp} server
10200 @samp{some.where.edu} will have the name @samp{soc.motss} and select
10201 method @code{(nntp "some.where.edu")}. Gnus will call this group
10202 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
10203 backend just knows this group as @samp{soc.motss}.
10205 The different methods all have their peculiarities, of course.
10208 * Server Buffer:: Making and editing virtual servers.
10209 * Getting News:: Reading USENET news with Gnus.
10210 * Getting Mail:: Reading your personal mail with Gnus.
10211 * Browsing the Web:: Getting messages from a plethora of Web sources.
10212 * Other Sources:: Reading directories, files, SOUP packets.
10213 * Combined Groups:: Combining groups into one group.
10214 * Gnus Unplugged:: Reading news and mail offline.
10218 @node Server Buffer
10219 @section Server Buffer
10221 Traditionally, a @dfn{server} is a machine or a piece of software that
10222 one connects to, and then requests information from. Gnus does not
10223 connect directly to any real servers, but does all transactions through
10224 one backend or other. But that's just putting one layer more between
10225 the actual media and Gnus, so we might just as well say that each
10226 backend represents a virtual server.
10228 For instance, the @code{nntp} backend may be used to connect to several
10229 different actual @sc{nntp} servers, or, perhaps, to many different ports
10230 on the same actual @sc{nntp} server. You tell Gnus which backend to
10231 use, and what parameters to set by specifying a @dfn{select method}.
10233 These select method specifications can sometimes become quite
10234 complicated---say, for instance, that you want to read from the
10235 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
10236 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
10237 Anyway, if you had to specify that for each group that used this
10238 server, that would be too much work, so Gnus offers a way of naming
10239 select methods, which is what you do in the server buffer.
10241 To enter the server buffer, use the @kbd{^}
10242 (@code{gnus-group-enter-server-mode}) command in the group buffer.
10245 * Server Buffer Format:: You can customize the look of this buffer.
10246 * Server Commands:: Commands to manipulate servers.
10247 * Example Methods:: Examples server specifications.
10248 * Creating a Virtual Server:: An example session.
10249 * Server Variables:: Which variables to set.
10250 * Servers and Methods:: You can use server names as select methods.
10251 * Unavailable Servers:: Some servers you try to contact may be down.
10254 @vindex gnus-server-mode-hook
10255 @code{gnus-server-mode-hook} is run when creating the server buffer.
10258 @node Server Buffer Format
10259 @subsection Server Buffer Format
10260 @cindex server buffer format
10262 @vindex gnus-server-line-format
10263 You can change the look of the server buffer lines by changing the
10264 @code{gnus-server-line-format} variable. This is a @code{format}-like
10265 variable, with some simple extensions:
10270 How the news is fetched---the backend name.
10273 The name of this server.
10276 Where the news is to be fetched from---the address.
10279 The opened/closed/denied status of the server.
10282 @vindex gnus-server-mode-line-format
10283 The mode line can also be customized by using the
10284 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
10285 Formatting}). The following specs are understood:
10295 Also @pxref{Formatting Variables}.
10298 @node Server Commands
10299 @subsection Server Commands
10300 @cindex server commands
10306 @findex gnus-server-add-server
10307 Add a new server (@code{gnus-server-add-server}).
10311 @findex gnus-server-edit-server
10312 Edit a server (@code{gnus-server-edit-server}).
10315 @kindex SPACE (Server)
10316 @findex gnus-server-read-server
10317 Browse the current server (@code{gnus-server-read-server}).
10321 @findex gnus-server-exit
10322 Return to the group buffer (@code{gnus-server-exit}).
10326 @findex gnus-server-kill-server
10327 Kill the current server (@code{gnus-server-kill-server}).
10331 @findex gnus-server-yank-server
10332 Yank the previously killed server (@code{gnus-server-yank-server}).
10336 @findex gnus-server-copy-server
10337 Copy the current server (@code{gnus-server-copy-server}).
10341 @findex gnus-server-list-servers
10342 List all servers (@code{gnus-server-list-servers}).
10346 @findex gnus-server-scan-server
10347 Request that the server scan its sources for new articles
10348 (@code{gnus-server-scan-server}). This is mainly sensible with mail
10353 @findex gnus-server-regenerate-server
10354 Request that the server regenerate all its data structures
10355 (@code{gnus-server-regenerate-server}). This can be useful if you have
10356 a mail backend that has gotten out of sync.
10361 @node Example Methods
10362 @subsection Example Methods
10364 Most select methods are pretty simple and self-explanatory:
10367 (nntp "news.funet.fi")
10370 Reading directly from the spool is even simpler:
10376 As you can see, the first element in a select method is the name of the
10377 backend, and the second is the @dfn{address}, or @dfn{name}, if you
10380 After these two elements, there may be an arbitrary number of
10381 @code{(@var{variable} @var{form})} pairs.
10383 To go back to the first example---imagine that you want to read from
10384 port 15 on that machine. This is what the select method should
10388 (nntp "news.funet.fi" (nntp-port-number 15))
10391 You should read the documentation to each backend to find out what
10392 variables are relevant, but here's an @code{nnmh} example:
10394 @code{nnmh} is a mail backend that reads a spool-like structure. Say
10395 you have two structures that you wish to access: One is your private
10396 mail spool, and the other is a public one. Here's the possible spec for
10400 (nnmh "private" (nnmh-directory "~/private/mail/"))
10403 (This server is then called @samp{private}, but you may have guessed
10406 Here's the method for a public spool:
10410 (nnmh-directory "/usr/information/spool/")
10411 (nnmh-get-new-mail nil))
10417 If you are behind a firewall and only have access to the @sc{nntp}
10418 server from the firewall machine, you can instruct Gnus to @code{rlogin}
10419 on the firewall machine and telnet from there to the @sc{nntp} server.
10420 Doing this can be rather fiddly, but your virtual server definition
10421 should probably look something like this:
10425 (nntp-address "the.firewall.machine")
10426 (nntp-open-connection-function nntp-open-rlogin)
10427 (nntp-end-of-line "\n")
10428 (nntp-rlogin-parameters
10429 ("telnet" "the.real.nntp.host" "nntp")))
10432 If you want to use the wonderful @code{ssh} program to provide a
10433 compressed connection over the modem line, you could create a virtual
10434 server that would look something like this:
10438 (nntp-address "copper.uio.no")
10439 (nntp-rlogin-program "ssh")
10440 (nntp-open-connection-function nntp-open-rlogin)
10441 (nntp-end-of-line "\n")
10442 (nntp-rlogin-parameters
10443 ("telnet" "news.uio.no" "nntp")))
10446 This means that you have to have set up @code{ssh-agent} correctly to
10447 provide automatic authorization, of course. And to get a compressed
10448 connection, you have to have the @samp{Compression} option in the
10449 @code{ssh} @file{config} file.
10452 @node Creating a Virtual Server
10453 @subsection Creating a Virtual Server
10455 If you're saving lots of articles in the cache by using persistent
10456 articles, you may want to create a virtual server to read the cache.
10458 First you need to add a new server. The @kbd{a} command does that. It
10459 would probably be best to use @code{nnspool} to read the cache. You
10460 could also use @code{nnml} or @code{nnmh}, though.
10462 Type @kbd{a nnspool RET cache RET}.
10464 You should now have a brand new @code{nnspool} virtual server called
10465 @samp{cache}. You now need to edit it to have the right definitions.
10466 Type @kbd{e} to edit the server. You'll be entered into a buffer that
10467 will contain the following:
10477 (nnspool-spool-directory "~/News/cache/")
10478 (nnspool-nov-directory "~/News/cache/")
10479 (nnspool-active-file "~/News/cache/active"))
10482 Type @kbd{C-c C-c} to return to the server buffer. If you now press
10483 @kbd{RET} over this virtual server, you should be entered into a browse
10484 buffer, and you should be able to enter any of the groups displayed.
10487 @node Server Variables
10488 @subsection Server Variables
10490 One sticky point when defining variables (both on backends and in Emacs
10491 in general) is that some variables are typically initialized from other
10492 variables when the definition of the variables is being loaded. If you
10493 change the "base" variable after the variables have been loaded, you
10494 won't change the "derived" variables.
10496 This typically affects directory and file variables. For instance,
10497 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
10498 directory variables are initialized from that variable, so
10499 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
10500 new virtual @code{nnml} server, it will @emph{not} suffice to set just
10501 @code{nnml-directory}---you have to explicitly set all the file
10502 variables to be what you want them to be. For a complete list of
10503 variables for each backend, see each backend's section later in this
10504 manual, but here's an example @code{nnml} definition:
10508 (nnml-directory "~/my-mail/")
10509 (nnml-active-file "~/my-mail/active")
10510 (nnml-newsgroups-file "~/my-mail/newsgroups"))
10514 @node Servers and Methods
10515 @subsection Servers and Methods
10517 Wherever you would normally use a select method
10518 (e.g. @code{gnus-secondary-select-method}, in the group select method,
10519 when browsing a foreign server) you can use a virtual server name
10520 instead. This could potentially save lots of typing. And it's nice all
10524 @node Unavailable Servers
10525 @subsection Unavailable Servers
10527 If a server seems to be unreachable, Gnus will mark that server as
10528 @code{denied}. That means that any subsequent attempt to make contact
10529 with that server will just be ignored. ``It can't be opened,'' Gnus
10530 will tell you, without making the least effort to see whether that is
10531 actually the case or not.
10533 That might seem quite naughty, but it does make sense most of the time.
10534 Let's say you have 10 groups subscribed to on server
10535 @samp{nephelococcygia.com}. This server is located somewhere quite far
10536 away from you and the machine is quite slow, so it takes 1 minute just
10537 to find out that it refuses connection to you today. If Gnus were to
10538 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
10539 attempt to do that. Once it has gotten a single ``connection refused'',
10540 it will regard that server as ``down''.
10542 So, what happens if the machine was only feeling unwell temporarily?
10543 How do you test to see whether the machine has come up again?
10545 You jump to the server buffer (@pxref{Server Buffer}) and poke it
10546 with the following commands:
10552 @findex gnus-server-open-server
10553 Try to establish connection to the server on the current line
10554 (@code{gnus-server-open-server}).
10558 @findex gnus-server-close-server
10559 Close the connection (if any) to the server
10560 (@code{gnus-server-close-server}).
10564 @findex gnus-server-deny-server
10565 Mark the current server as unreachable
10566 (@code{gnus-server-deny-server}).
10569 @kindex M-o (Server)
10570 @findex gnus-server-open-all-servers
10571 Open the connections to all servers in the buffer
10572 (@code{gnus-server-open-all-servers}).
10575 @kindex M-c (Server)
10576 @findex gnus-server-close-all-servers
10577 Close the connections to all servers in the buffer
10578 (@code{gnus-server-close-all-servers}).
10582 @findex gnus-server-remove-denials
10583 Remove all marks to whether Gnus was denied connection from any servers
10584 (@code{gnus-server-remove-denials}).
10590 @section Getting News
10591 @cindex reading news
10592 @cindex news backends
10594 A newsreader is normally used for reading news. Gnus currently provides
10595 only two methods of getting news---it can read from an @sc{nntp} server,
10596 or it can read from a local spool.
10599 * NNTP:: Reading news from an @sc{nntp} server.
10600 * News Spool:: Reading news from the local spool.
10605 @subsection @sc{nntp}
10608 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
10609 You just specify @code{nntp} as method and the address of the @sc{nntp}
10610 server as the, uhm, address.
10612 If the @sc{nntp} server is located at a non-standard port, setting the
10613 third element of the select method to this port number should allow you
10614 to connect to the right port. You'll have to edit the group info for
10615 that (@pxref{Foreign Groups}).
10617 The name of the foreign group can be the same as a native group. In
10618 fact, you can subscribe to the same group from as many different servers
10619 you feel like. There will be no name collisions.
10621 The following variables can be used to create a virtual @code{nntp}
10626 @item nntp-server-opened-hook
10627 @vindex nntp-server-opened-hook
10628 @cindex @sc{mode reader}
10630 @cindex authentification
10631 @cindex nntp authentification
10632 @findex nntp-send-authinfo
10633 @findex nntp-send-mode-reader
10634 is run after a connection has been made. It can be used to send
10635 commands to the @sc{nntp} server after it has been contacted. By
10636 default it sends the command @code{MODE READER} to the server with the
10637 @code{nntp-send-mode-reader} function. This function should always be
10638 present in this hook.
10640 @item nntp-authinfo-function
10641 @vindex nntp-authinfo-function
10642 @findex nntp-send-authinfo
10643 @vindex nntp-authinfo-file
10644 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
10645 server. The default function is @code{nntp-send-authinfo}, which looks
10646 through your @file{~/.authinfo} (or whatever you've set the
10647 @code{nntp-authinfo-file} variable to) for applicable entries. If none
10648 are found, it will prompt you for a login name and a password. The
10649 format of the @file{~/.authinfo} file is (almost) the same as the
10650 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
10651 manual page, but here are the salient facts:
10655 The file contains one or more line, each of which define one server.
10658 Each line may contain an arbitrary number of token/value pairs.
10660 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
10661 @samp{default}. In addition Gnus introduces two new tokens, not present
10662 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
10663 @samp{force}. (This is the only way the @file{.authinfo} file format
10664 deviates from the @file{.netrc} file format.) @samp{port} is used to
10665 indicate what port on the server the credentials apply to and
10666 @samp{force} is explained below.
10670 Here's an example file:
10673 machine news.uio.no login larsi password geheimnis
10674 machine nntp.ifi.uio.no login larsi force yes
10677 The token/value pairs may appear in any order; @samp{machine} doesn't
10678 have to be first, for instance.
10680 In this example, both login name and password have been supplied for the
10681 former server, while the latter has only the login name listed, and the
10682 user will be prompted for the password. The latter also has the
10683 @samp{force} tag, which means that the authinfo will be sent to the
10684 @var{nntp} server upon connection; the default (i.e., when there is not
10685 @samp{force} tag) is to not send authinfo to the @var{nntp} server
10686 until the @var{nntp} server asks for it.
10688 You can also add @samp{default} lines that will apply to all servers
10689 that don't have matching @samp{machine} lines.
10695 This will force sending @samp{AUTHINFO} commands to all servers not
10696 previously mentioned.
10698 Remember to not leave the @file{~/.authinfo} file world-readable.
10700 @item nntp-server-action-alist
10701 @vindex nntp-server-action-alist
10702 This is a list of regexps to match on server types and actions to be
10703 taken when matches are made. For instance, if you want Gnus to beep
10704 every time you connect to innd, you could say something like:
10707 (setq nntp-server-action-alist
10708 '(("innd" (ding))))
10711 You probably don't want to do that, though.
10713 The default value is
10716 '(("nntpd 1\\.5\\.11t"
10717 (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
10720 This ensures that Gnus doesn't send the @code{MODE READER} command to
10721 nntpd 1.5.11t, since that command chokes that server, I've been told.
10723 @item nntp-maximum-request
10724 @vindex nntp-maximum-request
10725 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
10726 will collect headers by sending a series of @code{head} commands. To
10727 speed things up, the backend sends lots of these commands without
10728 waiting for reply, and then reads all the replies. This is controlled
10729 by the @code{nntp-maximum-request} variable, and is 400 by default. If
10730 your network is buggy, you should set this to 1.
10732 @item nntp-connection-timeout
10733 @vindex nntp-connection-timeout
10734 If you have lots of foreign @code{nntp} groups that you connect to
10735 regularly, you're sure to have problems with @sc{nntp} servers not
10736 responding properly, or being too loaded to reply within reasonable
10737 time. This is can lead to awkward problems, which can be helped
10738 somewhat by setting @code{nntp-connection-timeout}. This is an integer
10739 that says how many seconds the @code{nntp} backend should wait for a
10740 connection before giving up. If it is @code{nil}, which is the default,
10741 no timeouts are done.
10743 @c @item nntp-command-timeout
10744 @c @vindex nntp-command-timeout
10745 @c @cindex PPP connections
10746 @c @cindex dynamic IP addresses
10747 @c If you're running Gnus on a machine that has a dynamically assigned
10748 @c address, Gnus may become confused. If the address of your machine
10749 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
10750 @c waiting forever for replies from the server. To help with this
10751 @c unfortunate problem, you can set this command to a number. Gnus will
10752 @c then, if it sits waiting for a reply from the server longer than that
10753 @c number of seconds, shut down the connection, start a new one, and resend
10754 @c the command. This should hopefully be transparent to the user. A
10755 @c likely number is 30 seconds.
10757 @c @item nntp-retry-on-break
10758 @c @vindex nntp-retry-on-break
10759 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
10760 @c hangs. This will have much the same effect as the command timeout
10761 @c described above.
10763 @item nntp-server-hook
10764 @vindex nntp-server-hook
10765 This hook is run as the last step when connecting to an @sc{nntp}
10768 @findex nntp-open-rlogin
10769 @findex nntp-open-telnet
10770 @findex nntp-open-network-stream
10771 @item nntp-open-connection-function
10772 @vindex nntp-open-connection-function
10773 This function is used to connect to the remote system. Four pre-made
10774 functions are supplied:
10777 @item nntp-open-network-stream
10778 This is the default, and simply connects to some port or other on the
10781 @item nntp-open-rlogin
10782 Does an @samp{rlogin} on the
10783 remote system, and then does a @samp{telnet} to the @sc{nntp} server
10786 @code{nntp-open-rlogin}-related variables:
10790 @item nntp-rlogin-program
10791 @vindex nntp-rlogin-program
10792 Program used to log in on remote machines. The default is @samp{rsh},
10793 but @samp{ssh} is a popular alternative.
10795 @item nntp-rlogin-parameters
10796 @vindex nntp-rlogin-parameters
10797 This list will be used as the parameter list given to @code{rsh}.
10799 @item nntp-rlogin-user-name
10800 @vindex nntp-rlogin-user-name
10801 User name on the remote system.
10805 @item nntp-open-telnet
10806 Does a @samp{telnet} to the remote system and then another @samp{telnet}
10807 to get to the @sc{nntp} server.
10809 @code{nntp-open-telnet}-related variables:
10812 @item nntp-telnet-command
10813 @vindex nntp-telnet-command
10814 Command used to start @code{telnet}.
10816 @item nntp-telnet-switches
10817 @vindex nntp-telnet-switches
10818 List of strings to be used as the switches to the @code{telnet} command.
10820 @item nntp-telnet-user-name
10821 @vindex nntp-telnet-user-name
10822 User name for log in on the remote system.
10824 @item nntp-telnet-passwd
10825 @vindex nntp-telnet-passwd
10826 Password to use when logging in.
10828 @item nntp-telnet-parameters
10829 @vindex nntp-telnet-parameters
10830 A list of strings executed as a command after logging in
10833 @item nntp-telnet-shell-prompt
10834 @vindex nntp-telnet-shell-prompt
10835 Regexp matching the shell prompt on the remote machine. The default is
10836 @samp{bash\\|\$ *\r?$\\|> *\r?}.
10838 @item nntp-open-telnet-envuser
10839 @vindex nntp-open-telnet-envuser
10840 If non-@code{nil}, the @code{telnet} session (client and server both)
10841 will support the @code{ENVIRON} option and not prompt for login name.
10842 This works for Solaris @code{telnet}, for instance.
10846 @findex nntp-open-ssl-stream
10847 @item nntp-open-ssl-stream
10848 Opens a connection to a server over a @dfn{secure} channel. To use this
10849 you must have SSLay installed
10850 (@uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
10851 @file{ssl.el} (from the W3 distribution, for instance). You then
10852 define a server as follows:
10855 ;; Type `C-c C-c' after you've finished editing.
10857 ;; "snews" is port 563 and is predefined in our /etc/services
10859 (nntp "snews.bar.com"
10860 (nntp-open-connection-function nntp-open-ssl-stream)
10861 (nntp-port-number "snews")
10862 (nntp-address "snews.bar.com"))
10867 @item nntp-end-of-line
10868 @vindex nntp-end-of-line
10869 String to use as end-of-line marker when talking to the @sc{nntp}
10870 server. This is @samp{\r\n} by default, but should be @samp{\n} when
10871 using @code{rlogin} to talk to the server.
10873 @item nntp-rlogin-user-name
10874 @vindex nntp-rlogin-user-name
10875 User name on the remote system when using the @code{rlogin} connect
10879 @vindex nntp-address
10880 The address of the remote system running the @sc{nntp} server.
10882 @item nntp-port-number
10883 @vindex nntp-port-number
10884 Port number to connect to when using the @code{nntp-open-network-stream}
10887 @item nntp-buggy-select
10888 @vindex nntp-buggy-select
10889 Set this to non-@code{nil} if your select routine is buggy.
10891 @item nntp-nov-is-evil
10892 @vindex nntp-nov-is-evil
10893 If the @sc{nntp} server does not support @sc{nov}, you could set this
10894 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
10897 @item nntp-xover-commands
10898 @vindex nntp-xover-commands
10901 List of strings used as commands to fetch @sc{nov} lines from a
10902 server. The default value of this variable is @code{("XOVER"
10906 @vindex nntp-nov-gap
10907 @code{nntp} normally sends just one big request for @sc{nov} lines to
10908 the server. The server responds with one huge list of lines. However,
10909 if you have read articles 2-5000 in the group, and only want to read
10910 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
10911 lines that you will not need. This variable says how
10912 big a gap between two consecutive articles is allowed to be before the
10913 @code{XOVER} request is split into several request. Note that if your
10914 network is fast, setting this variable to a really small number means
10915 that fetching will probably be slower. If this variable is @code{nil},
10916 @code{nntp} will never split requests. The default is 5.
10918 @item nntp-prepare-server-hook
10919 @vindex nntp-prepare-server-hook
10920 A hook run before attempting to connect to an @sc{nntp} server.
10922 @item nntp-warn-about-losing-connection
10923 @vindex nntp-warn-about-losing-connection
10924 If this variable is non-@code{nil}, some noise will be made when a
10925 server closes connection.
10927 @item nntp-record-commands
10928 @vindex nntp-record-commands
10929 If non-@code{nil}, @code{nntp} will log all commands it sends to the
10930 @sc{nntp} server (along with a timestamp) in the @samp{*nntp-log*}
10931 buffer. This is useful if you are debugging a Gnus/@sc{nntp} connection
10932 that doesn't seem to work.
10938 @subsection News Spool
10942 Subscribing to a foreign group from the local spool is extremely easy,
10943 and might be useful, for instance, to speed up reading groups that
10944 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
10947 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
10948 anything else) as the address.
10950 If you have access to a local spool, you should probably use that as the
10951 native select method (@pxref{Finding the News}). It is normally faster
10952 than using an @code{nntp} select method, but might not be. It depends.
10953 You just have to try to find out what's best at your site.
10957 @item nnspool-inews-program
10958 @vindex nnspool-inews-program
10959 Program used to post an article.
10961 @item nnspool-inews-switches
10962 @vindex nnspool-inews-switches
10963 Parameters given to the inews program when posting an article.
10965 @item nnspool-spool-directory
10966 @vindex nnspool-spool-directory
10967 Where @code{nnspool} looks for the articles. This is normally
10968 @file{/usr/spool/news/}.
10970 @item nnspool-nov-directory
10971 @vindex nnspool-nov-directory
10972 Where @code{nnspool} will look for @sc{nov} files. This is normally
10973 @file{/usr/spool/news/over.view/}.
10975 @item nnspool-lib-dir
10976 @vindex nnspool-lib-dir
10977 Where the news lib dir is (@file{/usr/lib/news/} by default).
10979 @item nnspool-active-file
10980 @vindex nnspool-active-file
10981 The path to the active file.
10983 @item nnspool-newsgroups-file
10984 @vindex nnspool-newsgroups-file
10985 The path to the group descriptions file.
10987 @item nnspool-history-file
10988 @vindex nnspool-history-file
10989 The path to the news history file.
10991 @item nnspool-active-times-file
10992 @vindex nnspool-active-times-file
10993 The path to the active date file.
10995 @item nnspool-nov-is-evil
10996 @vindex nnspool-nov-is-evil
10997 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
11000 @item nnspool-sift-nov-with-sed
11001 @vindex nnspool-sift-nov-with-sed
11003 If non-@code{nil}, which is the default, use @code{sed} to get the
11004 relevant portion from the overview file. If nil, @code{nnspool} will
11005 load the entire file into a buffer and process it there.
11011 @section Getting Mail
11012 @cindex reading mail
11015 Reading mail with a newsreader---isn't that just plain WeIrD? But of
11019 * Mail in a Newsreader:: Important introductory notes.
11020 * Getting Started Reading Mail:: A simple cookbook example.
11021 * Splitting Mail:: How to create mail groups.
11022 * Mail Sources:: How to tell Gnus where to get mail from.
11023 * Mail Backend Variables:: Variables for customizing mail handling.
11024 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
11025 * Group Mail Splitting:: Use group customize to drive mail splitting.
11026 * Incorporating Old Mail:: What about the old mail you have?
11027 * Expiring Mail:: Getting rid of unwanted mail.
11028 * Washing Mail:: Removing gruft from the mail you get.
11029 * Duplicates:: Dealing with duplicated mail.
11030 * Not Reading Mail:: Using mail backends for reading other files.
11031 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
11035 @node Mail in a Newsreader
11036 @subsection Mail in a Newsreader
11038 If you are used to traditional mail readers, but have decided to switch
11039 to reading mail with Gnus, you may find yourself experiencing something
11040 of a culture shock.
11042 Gnus does not behave like traditional mail readers. If you want to make
11043 it behave that way, you can, but it's an uphill battle.
11045 Gnus, by default, handles all its groups using the same approach. This
11046 approach is very newsreaderly---you enter a group, see the new/unread
11047 messages, and when you read the messages, they get marked as read, and
11048 you don't see them any more. (Unless you explicitly ask for them.)
11050 In particular, you do not do anything explicitly to delete messages.
11052 Does this mean that all the messages that have been marked as read are
11053 deleted? How awful!
11055 But, no, it means that old messages are @dfn{expired} according to some
11056 scheme or other. For news messages, the expire process is controlled by
11057 the news administrator; for mail, the expire process is controlled by
11058 you. The expire process for mail is covered in depth in @pxref{Expiring
11061 What many Gnus users find, after using it a while for both news and
11062 mail, is that the transport mechanism has very little to do with how
11063 they want to treat a message.
11065 Many people subscribe to several mailing lists. These are transported
11066 via SMTP, and are therefore mail. But we might go for weeks without
11067 answering, or even reading these messages very carefully. We may not
11068 need to save them because if we should need to read one again, they are
11069 archived somewhere else.
11071 Some people have local news groups which have only a handful of readers.
11072 These are transported via @sc{nntp}, and are therefore news. But we may need
11073 to read and answer a large fraction of the messages very carefully in
11074 order to do our work. And there may not be an archive, so we may need
11075 to save the interesting messages the same way we would personal mail.
11077 The important distinction turns out to be not the transport mechanism,
11078 but other factors such as how interested we are in the subject matter,
11079 or how easy it is to retrieve the message if we need to read it again.
11081 Gnus provides many options for sorting mail into ``groups'' which behave
11082 like newsgroups, and for treating each group (whether mail or news)
11085 Some users never get comfortable using the Gnus (ahem) paradigm and wish
11086 that Gnus should grow up and be a male, er, mail reader. It is possible
11087 to whip Gnus into a more mailreaderly being, but, as said before, it's
11088 not easy. People who prefer proper mail readers should try @sc{vm}
11089 instead, which is an excellent, and proper, mail reader.
11091 I don't mean to scare anybody off, but I want to make it clear that you
11092 may be required to learn a new way of thinking about messages. After
11093 you've been subjected to The Gnus Way, you will come to love it. I can
11094 guarantee it. (At least the guy who sold me the Emacs Subliminal
11095 Brain-Washing Functions that I've put into Gnus did guarantee it. You
11096 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
11100 @node Getting Started Reading Mail
11101 @subsection Getting Started Reading Mail
11103 It's quite easy to use Gnus to read your new mail. You just plonk the
11104 mail backend of your choice into @code{gnus-secondary-select-methods},
11105 and things will happen automatically.
11107 For instance, if you want to use @code{nnml} (which is a "one file per
11108 mail" backend), you could put the following in your @file{.gnus} file:
11111 (setq gnus-secondary-select-methods
11112 '((nnml "private")))
11115 Now, the next time you start Gnus, this backend will be queried for new
11116 articles, and it will move all the messages in your spool file to its
11117 directory, which is @code{~/Mail/} by default. The new group that will
11118 be created (@samp{mail.misc}) will be subscribed, and you can read it
11119 like any other group.
11121 You will probably want to split the mail into several groups, though:
11124 (setq nnmail-split-methods
11125 '(("junk" "^From:.*Lars Ingebrigtsen")
11126 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
11130 This will result in three new @code{nnml} mail groups being created:
11131 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
11132 mail that doesn't fit into the first two groups will be placed in the
11135 This should be sufficient for reading mail with Gnus. You might want to
11136 give the other sections in this part of the manual a perusal, though.
11137 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
11140 @node Splitting Mail
11141 @subsection Splitting Mail
11142 @cindex splitting mail
11143 @cindex mail splitting
11145 @vindex nnmail-split-methods
11146 The @code{nnmail-split-methods} variable says how the incoming mail is
11147 to be split into groups.
11150 (setq nnmail-split-methods
11151 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
11152 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
11153 ("mail.other" "")))
11156 This variable is a list of lists, where the first element of each of
11157 these lists is the name of the mail group (they do not have to be called
11158 something beginning with @samp{mail}, by the way), and the second
11159 element is a regular expression used on the header of each mail to
11160 determine if it belongs in this mail group. The first string may
11161 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
11162 insert sub-expressions from the matched text. For instance:
11165 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
11168 The second element can also be a function. In that case, it will be
11169 called narrowed to the headers with the first element of the rule as the
11170 argument. It should return a non-@code{nil} value if it thinks that the
11171 mail belongs in that group.
11173 The last of these groups should always be a general one, and the regular
11174 expression should @emph{always} be @samp{} so that it matches any mails
11175 that haven't been matched by any of the other regexps. (These rules are
11176 processed from the beginning of the alist toward the end. The first
11177 rule to make a match will "win", unless you have crossposting enabled.
11178 In that case, all matching rules will "win".)
11180 If you like to tinker with this yourself, you can set this variable to a
11181 function of your choice. This function will be called without any
11182 arguments in a buffer narrowed to the headers of an incoming mail
11183 message. The function should return a list of group names that it
11184 thinks should carry this mail message.
11186 Note that the mail backends are free to maul the poor, innocent,
11187 incoming headers all they want to. They all add @code{Lines} headers;
11188 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
11189 @code{From<SPACE>} line to something else.
11191 @vindex nnmail-crosspost
11192 The mail backends all support cross-posting. If several regexps match,
11193 the mail will be ``cross-posted'' to all those groups.
11194 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
11195 that no articles are crossposted to the general (@samp{}) group.
11197 @vindex nnmail-crosspost-link-function
11200 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
11201 the crossposted articles. However, not all file systems support hard
11202 links. If that's the case for you, set
11203 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
11204 variable is @code{add-name-to-file} by default.)
11206 @kindex M-x nnmail-split-history
11207 @kindex nnmail-split-history
11208 If you wish to see where the previous mail split put the messages, you
11209 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
11210 where re-spooling messages would put the messages, you can use
11211 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
11214 Gnus gives you all the opportunity you could possibly want for shooting
11215 yourself in the foot. Let's say you create a group that will contain
11216 all the mail you get from your boss. And then you accidentally
11217 unsubscribe from the group. Gnus will still put all the mail from your
11218 boss in the unsubscribed group, and so, when your boss mails you ``Have
11219 that report ready by Monday or you're fired!'', you'll never see it and,
11220 come Tuesday, you'll still believe that you're gainfully employed while
11221 you really should be out collecting empty bottles to save up for next
11222 month's rent money.
11226 @subsection Mail Sources
11228 Mail can be gotten from many different sources---the mail spool, from a
11229 POP mail server, from a procmail directory, or from a maildir, for
11233 * Mail Source Specifiers:: How to specify what a mail source is.
11234 * Mail Source Customization:: Some variables that influence things.
11235 * Fetching Mail:: Using the mail source specifiers.
11239 @node Mail Source Specifiers
11240 @subsubsection Mail Source Specifiers
11242 @cindex mail server
11245 @cindex mail source
11247 You tell Gnus how to fetch mail by setting @code{mail-sources}
11248 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
11253 (pop :server "pop3.mailserver.com" :user "myname")
11256 As can be observed, a mail source specifier is a list where the first
11257 element is a @dfn{mail source type}, followed by an arbitrary number of
11258 @dfn{keywords}. Keywords that are not explicitly specified are given
11261 The following mail source types are available:
11265 Get mail from a single file; typically from the mail spool.
11271 The path of the file. Defaults to the value of the @code{MAIL}
11272 environment variable or @file{/usr/mail/spool/user-name}.
11275 An example file mail source:
11278 (file :path "/usr/spool/mail/user-name")
11281 Or using the default path:
11287 If the mail spool file is not located on the local machine, it's best to
11288 use POP or @sc{imap} or the like to fetch the mail. You can not use ange-ftp
11289 file names here---it has no way to lock the mail spool while moving the
11292 If it's impossible to set up a proper server, you can use ssh instead.
11296 '((file :prescript "ssh host bin/getmail >%t")))
11299 The @samp{getmail} script would look something like the following:
11303 # getmail - move mail from spool to stdout
11306 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
11308 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
11311 Alter this script to fit find the @samp{movemail} you want to use.
11315 Get mail from several files in a directory. This is typically used when
11316 you have procmail split the incoming mail into several files. Setting
11317 @code{nnmail-scan-directory-mail-source-once} to non-nil forces Gnus to
11318 scan the mail source only once. This is particularly useful if you want
11319 to scan mail groups at a specified level.
11325 The path of the directory where the files are. There is no default
11329 Only files ending with this suffix are used. The default is
11333 Only files that have this predicate return non-@code{nil} are returned.
11334 The default is @code{identity}. This is used as an additional
11335 filter---only files that have the right suffix @emph{and} satisfy this
11336 predicate are considered.
11340 Script run before/after fetching mail.
11344 An example directory mail source:
11347 (directory :path "/home/user-name/procmail-dir/"
11352 Get mail from a POP server.
11358 The name of the POP server. The default is taken from the
11359 @code{MAILHOST} environment variable.
11362 The port number of the POP server. This can be a number (eg,
11363 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
11364 string, it should be a service name as listed in @file{/etc/services} on
11365 Unix systems. The default is @samp{"pop3"}. On some systems you might
11366 need to specify it as @samp{"pop-3"} instead.
11369 The user name to give to the POP server. The default is the login
11373 The password to give to the POP server. If not specified, the user is
11377 The program to use to fetch mail from the POP server. This should be
11378 a @code{format}-like string. Here's an example:
11381 fetchmail %u@@%s -P %p %t
11384 The valid format specifier characters are:
11388 The name of the file the mail is to be moved to. This must always be
11389 included in this string.
11392 The name of the server.
11395 The port number of the server.
11398 The user name to use.
11401 The password to use.
11404 The values used for these specs are taken from the values you give the
11405 corresponding keywords.
11408 A script to be run before fetching the mail. The syntax is the same as
11409 the @code{:program} keyword. This can also be a function to be run.
11412 A script to be run after fetching the mail. The syntax is the same as
11413 the @code{:program} keyword. This can also be a function to be run.
11416 The function to use to fetch mail from the POP server. The function is
11417 called with one parameter---the name of the file where the mail should
11420 @item :authentication
11421 This can be either the symbol @code{password} or the symbol @code{apop}
11422 and says what authentication scheme to use. The default is
11427 If the @code{:program} and @code{:function} keywords aren't specified,
11428 @code{pop3-movemail} will be used.
11430 Here are some examples. Fetch from the default POP server, using the
11431 default user name, and default fetcher:
11437 Fetch from a named server with a named user and password:
11440 (pop :server "my.pop.server"
11441 :user "user-name" :password "secret")
11444 Use @samp{movemail} to move the mail:
11447 (pop :program "movemail po:%u %t %p")
11451 Get mail from a maildir. This is a type of mailbox that is supported by
11452 at least qmail and postfix, where each file in a special directory
11453 contains exactly one mail.
11459 The path of the directory where the mails are stored. The default is
11460 taken from the @code{MAILDIR} environment variable or
11463 The subdirectories of the Maildir. The default is
11464 @samp{("new" "cur")}.
11466 @c If you sometimes look at your mail through a pop3 daemon before fetching
11467 @c them with Gnus, you may also have to fetch your mails from the
11468 @c @code{cur} directory inside the maildir, like in the first example
11471 You can also get mails from remote hosts (because maildirs don't suffer
11472 from locking problems).
11476 Two example maildir mail sources:
11479 (maildir :path "/home/user-name/Maildir/" :subdirs ("cur" "new"))
11483 (maildir :path "/user@@remotehost.org:~/Maildir/" :subdirs ("new"))
11487 Get mail from a @sc{imap} server. If you don't want to use @sc{imap}
11488 as intended, as a network mail reading protocol (ie with nnimap), for
11489 some reason or other, Gnus let you treat it similar to a POP server
11490 and fetches articles from a given @sc{imap} mailbox. @xref{IMAP}, for
11497 The name of the @sc{imap} server. The default is taken from the
11498 @code{MAILHOST} environment variable.
11501 The port number of the @sc{imap} server. The default is @samp{143}, or
11502 @samp{993} for SSL connections.
11505 The user name to give to the @sc{imap} server. The default is the login
11509 The password to give to the @sc{imap} server. If not specified, the user is
11513 What stream to use for connecting to the server, this is one of the
11514 symbols in @code{imap-stream-alist}. Right now, this means
11515 @samp{kerberos4}, @samp{ssl} or the default @samp{network}.
11517 @item :authentication
11518 Which authenticator to use for authenticating to the server, this is one
11519 of the symbols in @code{imap-authenticator-alist}. Right now, this
11520 means @samp{kerberos4}, @samp{cram-md5}, @samp{anonymous} or the default
11524 When using the `shell' :stream, the contents of this variable is
11525 mapped into the `imap-shell-program' variable. This should be a
11526 @code{format}-like string (or list of strings). Here's an example:
11532 The valid format specifier characters are:
11536 The name of the server.
11539 User name from `imap-default-user'.
11542 The port number of the server.
11545 The values used for these specs are taken from the values you give the
11546 corresponding keywords.
11549 The name of the mailbox to get mail from. The default is @samp{INBOX}
11550 which normally is the mailbox which receive incoming mail.
11553 The predicate used to find articles to fetch. The default, @samp{UNSEEN
11554 UNDELETED}, is probably the best choice for most people, but if you
11555 sometimes peek in your mailbox with a @sc{imap} client and mark some
11556 articles as read (or; SEEN) you might want to set this to @samp{nil}.
11557 Then all articles in the mailbox is fetched, no matter what. For a
11558 complete list of predicates, see RFC 2060 §6.4.4.
11561 How to flag fetched articles on the server, the default @samp{\Deleted}
11562 will mark them as deleted, an alternative would be @samp{\Seen} which
11563 would simply mark them as read. These are the two most likely choices,
11564 but more flags are defined in RFC 2060 §2.3.2.
11567 If non-nil, don't remove all articles marked as deleted in the mailbox
11568 after finishing the fetch.
11572 An example @sc{imap} mail source:
11575 (imap :server "mail.mycorp.com" :stream kerberos4 :fetchflag "\\Seen")
11579 Get mail from a webmail server, such as www.hotmail.com,
11580 webmail.netscape.com, www.netaddress.com, www.my-deja.com.
11582 NOTE: Now mail.yahoo.com provides POP3 service, so @sc{pop} mail source
11585 NOTE: Webmail largely depends cookies. A "one-line-cookie" patch is
11586 required for url "4.0pre.46".
11588 WARNING: Mails may lost. NO WARRANTY.
11594 The type of the webmail server. The default is @code{hotmail}. The
11595 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
11598 The user name to give to the webmail server. The default is the login
11602 The password to give to the webmail server. If not specified, the user is
11606 If non-nil, only fetch unread articles and don't move them to trash
11607 folder after finishing the fetch.
11611 An example webmail source:
11614 (webmail :subtype 'hotmail :user "user-name" :password "secret")
11619 @item Common Keywords
11620 Common keywords can be used in any type of mail source.
11626 If non-nil, fetch the mail even when Gnus is unplugged. If you use
11627 directory source to get mail, you can specify it as in this example:
11631 '((directory :path "/home/pavel/.Spool/"
11636 Gnus will then fetch your mail even when you are unplugged. This is
11637 useful when you use local mail and news.
11642 @subsubsection Function Interface
11644 Some of the above keywords specify a Lisp function to be executed.
11645 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
11646 the value of the keyword while the function is executing. For example,
11647 consider the following mail-source setting:
11650 (setq mail-sources '((pop :user "jrl"
11651 :server "pophost" :function fetchfunc)))
11654 While the function @code{fetchfunc} is executing, the symbol @code{user}
11655 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
11656 @code{"pophost"}. The symbols @code{port}, @code{password},
11657 @code{program}, @code{prescript}, @code{postscript}, @code{function},
11658 and @code{authentication} are also bound (to their default values).
11660 See above for a list of keywords for each type of mail source.
11663 @node Mail Source Customization
11664 @subsubsection Mail Source Customization
11666 The following is a list of variables that influence how the mail is
11667 fetched. You would normally not need to set or change any of these
11671 @item mail-source-crash-box
11672 @vindex mail-source-crash-box
11673 File where mail will be stored while processing it. The default is
11674 @file{~/.emacs-mail-crash-box}.
11676 @item mail-source-delete-incoming
11677 @vindex mail-source-delete-incoming
11678 If non-@code{nil}, delete incoming files after handling them.
11680 @item mail-source-directory
11681 @vindex mail-source-directory
11682 Directory where files (if any) will be stored. The default is
11683 @file{~/Mail/}. At present, the only thing this is used for is to say
11684 where the incoming files will be stored if the previous variable is
11687 @item mail-source-incoming-file-prefix
11688 @vindex mail-source-incoming-file-prefix
11689 Prefix for file name for storing incoming mail. The default is
11690 @file{Incoming}, in which case files will end up with names like
11691 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
11692 relevant if @code{mail-source-delete-incoming} is @code{nil}.
11694 @item mail-source-default-file-modes
11695 @vindex mail-source-default-file-modes
11696 All new mail files will get this file mode. The default is 384.
11701 @node Fetching Mail
11702 @subsubsection Fetching Mail
11704 @vindex mail-sources
11705 @vindex nnmail-spool-file
11706 The way to actually tell Gnus where to get new mail from is to set
11707 @code{mail-sources} to a list of mail source specifiers
11708 (@pxref{Mail Source Specifiers}).
11710 If this variable (and the obsolescent @code{nnmail-spool-file}) is
11711 @code{nil}, the mail backends will never attempt to fetch mail by
11714 If you want to fetch mail both from your local spool as well as a POP
11715 mail server, you'd say something like:
11720 (pop :server "pop3.mail.server"
11721 :password "secret")))
11724 Or, if you don't want to use any of the keyword defaults:
11728 '((file :path "/var/spool/mail/user-name")
11729 (pop :server "pop3.mail.server"
11732 :password "secret")))
11736 When you use a mail backend, Gnus will slurp all your mail from your
11737 inbox and plonk it down in your home directory. Gnus doesn't move any
11738 mail if you're not using a mail backend---you have to do a lot of magic
11739 invocations first. At the time when you have finished drawing the
11740 pentagram, lightened the candles, and sacrificed the goat, you really
11741 shouldn't be too surprised when Gnus moves your mail.
11745 @node Mail Backend Variables
11746 @subsection Mail Backend Variables
11748 These variables are (for the most part) pertinent to all the various
11752 @vindex nnmail-read-incoming-hook
11753 @item nnmail-read-incoming-hook
11754 The mail backends all call this hook after reading new mail. You can
11755 use this hook to notify any mail watch programs, if you want to.
11757 @vindex nnmail-split-hook
11758 @item nnmail-split-hook
11759 @findex article-decode-encoded-words
11760 @findex RFC 1522 decoding
11761 @findex RFC 2047 decoding
11762 Hook run in the buffer where the mail headers of each message is kept
11763 just before the splitting based on these headers is done. The hook is
11764 free to modify the buffer contents in any way it sees fit---the buffer
11765 is discarded after the splitting has been done, and no changes performed
11766 in the buffer will show up in any files.
11767 @code{gnus-article-decode-encoded-words} is one likely function to add
11770 @vindex nnmail-pre-get-new-mail-hook
11771 @vindex nnmail-post-get-new-mail-hook
11772 @item nnmail-pre-get-new-mail-hook
11773 @itemx nnmail-post-get-new-mail-hook
11774 These are two useful hooks executed when treating new incoming
11775 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
11776 starting to handle the new mail) and
11777 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
11778 is done). Here's and example of using these two hooks to change the
11779 default file modes the new mail files get:
11782 (add-hook 'gnus-pre-get-new-mail-hook
11783 (lambda () (set-default-file-modes 511)))
11785 (add-hook 'gnus-post-get-new-mail-hook
11786 (lambda () (set-default-file-modes 551)))
11789 @item nnmail-use-long-file-names
11790 @vindex nnmail-use-long-file-names
11791 If non-@code{nil}, the mail backends will use long file and directory
11792 names. Groups like @samp{mail.misc} will end up in directories
11793 (assuming use of @code{nnml} backend) or files (assuming use of
11794 @code{nnfolder} backend) like @file{mail.misc}. If it is @code{nil},
11795 the same group will end up in @file{mail/misc}.
11797 @item nnmail-delete-file-function
11798 @vindex nnmail-delete-file-function
11799 @findex delete-file
11800 Function called to delete files. It is @code{delete-file} by default.
11802 @item nnmail-cache-accepted-message-ids
11803 @vindex nnmail-cache-accepted-message-ids
11804 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
11805 the backend (via @code{Gcc}, for instance) into the mail duplication
11806 discovery cache. The default is @code{nil}.
11811 @node Fancy Mail Splitting
11812 @subsection Fancy Mail Splitting
11813 @cindex mail splitting
11814 @cindex fancy mail splitting
11816 @vindex nnmail-split-fancy
11817 @findex nnmail-split-fancy
11818 If the rather simple, standard method for specifying how to split mail
11819 doesn't allow you to do what you want, you can set
11820 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
11821 play with the @code{nnmail-split-fancy} variable.
11823 Let's look at an example value of this variable first:
11826 ;; Messages from the mailer daemon are not crossposted to any of
11827 ;; the ordinary groups. Warnings are put in a separate group
11828 ;; from real errors.
11829 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
11831 ;; Non-error messages are crossposted to all relevant
11832 ;; groups, but we don't crosspost between the group for the
11833 ;; (ding) list and the group for other (ding) related mail.
11834 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
11835 ("subject" "ding" "ding.misc"))
11836 ;; Other mailing lists...
11837 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
11838 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
11839 ;; Both lists below have the same suffix, so prevent
11840 ;; cross-posting to mkpkg.list of messages posted only to
11841 ;; the bugs- list, but allow cross-posting when the
11842 ;; message was really cross-posted.
11843 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
11844 (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
11846 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
11847 ;; Unmatched mail goes to the catch all group.
11851 This variable has the format of a @dfn{split}. A split is a (possibly)
11852 recursive structure where each split may contain other splits. Here are
11853 the five possible split syntaxes:
11858 @samp{group}: If the split is a string, that will be taken as a group
11859 name. Normal regexp match expansion will be done. See below for
11863 @code{(@var{field} @var{value} @code{[-} @var{restrict}
11864 @code{[@dots{}]}@code{]} @var{split})}: If the split is a list, the
11865 first element of which is a string, then store the message as
11866 specified by @var{split}, if header @var{field} (a regexp) contains
11867 @var{value} (also a regexp). If @var{restrict} (yet another regexp)
11868 matches some string after @var{field} and before the end of the
11869 matched @var{value}, the @var{split} is ignored. If none of the
11870 @var{restrict} clauses match, @var{split} is processed.
11873 @code{(| @var{split}@dots{})}: If the split is a list, and the first
11874 element is @code{|} (vertical bar), then process each @var{split} until
11875 one of them matches. A @var{split} is said to match if it will cause
11876 the mail message to be stored in one or more groups.
11879 @code{(& @var{split}@dots{})}: If the split is a list, and the first
11880 element is @code{&}, then process all @var{split}s in the list.
11883 @code{junk}: If the split is the symbol @code{junk}, then don't save
11884 this message. Use with extreme caution.
11887 @code{(: @var{function} @var{arg1} @var{arg2} @dots{})}: If the split is
11888 a list, and the first element is @code{:}, then the second element will
11889 be called as a function with @var{args} given as arguments. The
11890 function should return a @var{split}.
11893 For instance, the following function could be used to split based on the
11894 body of the messages:
11897 (defun split-on-body ()
11899 (set-buffer " *nnmail incoming*")
11900 (goto-char (point-min))
11901 (when (re-search-forward "Some.*string" nil t)
11905 The @samp{" *nnmail incoming*"} is narrowed to the message in question
11906 when the @code{:} function is run.
11909 @code{(! @var{func} @var{split})}: If the split is a list, and the first
11910 element is @code{!}, then SPLIT will be processed, and FUNC will be
11911 called as a function with the result of SPLIT as argument. FUNC should
11915 @code{nil}: If the split is @code{nil}, it is ignored.
11919 In these splits, @var{field} must match a complete field name.
11920 @var{value} must match a complete word according to the fundamental mode
11921 syntax table. You can use @code{.*} in the regexps to match partial
11922 field names or words. In other words, all @var{value}'s are wrapped in
11923 @samp{\<} and @samp{\>} pairs.
11925 @vindex nnmail-split-abbrev-alist
11926 @var{field} and @var{value} can also be lisp symbols, in that case they
11927 are expanded as specified by the variable
11928 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
11929 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
11932 @vindex nnmail-split-fancy-syntax-table
11933 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
11934 when all this splitting is performed.
11936 If you want to have Gnus create groups dynamically based on some
11937 information in the headers (i.e., do @code{replace-match}-like
11938 substitutions in the group names), you can say things like:
11941 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
11944 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
11945 will be filed in @samp{mail.debian.foo}.
11947 If the string contains the element @samp{\&}, then the previously
11948 matched string will be substituted. Similarly, the elements @samp{\\1}
11949 up to @samp{\\9} will be substituted with the text matched by the
11950 groupings 1 through 9.
11952 @findex nnmail-split-fancy-with-parent
11953 @code{nnmail-split-fancy-with-parent} is a function which allows you to
11954 split followups into the same groups their parents are in. Sometimes
11955 you can't make splitting rules for all your mail. For example, your
11956 boss might send you personal mail regarding different projects you are
11957 working on, and as you can't tell your boss to put a distinguishing
11958 string into the subject line, you have to resort to manually moving the
11959 messages into the right group. With this function, you only have to do
11960 it once per thread.
11962 To use this feature, you have to set @code{nnmail-treat-duplicates} to a
11963 non-nil value. And then you can include
11964 @code{nnmail-split-fancy-with-parent} using the colon feature, like so:
11966 (setq nnmail-split-fancy
11967 '(| (: nnmail-split-fancy-with-parent)
11968 ;; other splits go here
11972 This feature works as follows: when @code{nnmail-treat-duplicates} is
11973 non-nil, Gnus records the message id of every message it sees in the
11974 file specified by the variable @code{nnmail-message-id-cache-file},
11975 together with the group it is in (the group is omitted for non-mail
11976 messages). When mail splitting is invoked, the function
11977 @code{nnmail-split-fancy-with-parent} then looks at the References (and
11978 In-Reply-To) header of each message to split and searches the file
11979 specified by @code{nnmail-message-id-cache-file} for the message ids.
11980 When it has found a parent, it returns the corresponding group name. It
11981 is recommended that you set @code{nnmail-message-id-cache-length} to a
11982 somewhat higher number than the default so that the message ids are
11983 still in the cache. (A value of 5000 appears to create a file some 300
11985 @vindex nnmail-cache-accepted-message-ids
11986 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
11987 also records the message ids of moved articles, so that the followup
11988 messages goes into the new group.
11991 @node Group Mail Splitting
11992 @subsection Group Mail Splitting
11993 @cindex mail splitting
11994 @cindex group mail splitting
11996 @findex gnus-group-split
11997 If you subscribe to dozens of mailing lists but you don't want to
11998 maintain mail splitting rules manually, group mail splitting is for you.
11999 You just have to set @var{to-list} and/or @var{to-address} in group
12000 parameters or group customization and set @code{nnmail-split-methods} to
12001 @code{gnus-group-split}. This splitting function will scan all groups
12002 for those parameters and split mail accordingly, i.e., messages posted
12003 from or to the addresses specified in the parameters @var{to-list} or
12004 @var{to-address} of a mail group will be stored in that group.
12006 Sometimes, mailing lists have multiple addresses, and you may want mail
12007 splitting to recognize them all: just set the @var{extra-aliases} group
12008 parameter to the list of additional addresses and it's done. If you'd
12009 rather use a regular expression, set @var{split-regexp}.
12011 All these parameters in a group will be used to create an
12012 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
12013 the @var{value} is a single regular expression that matches
12014 @var{to-list}, @var{to-address}, all of @var{extra-aliases} and all
12015 matches of @var{split-regexp}, and the @var{split} is the name of the
12016 group. @var{restrict}s are also supported: just set the
12017 @var{split-exclude} parameter to a list of regular expressions.
12019 If you can't get the right split to be generated using all these
12020 parameters, or you just need something fancier, you can set the
12021 parameter @var{split-spec} to an @code{nnmail-split-fancy} split. In
12022 this case, all other aforementioned parameters will be ignored by
12023 @code{gnus-group-split}. In particular, @var{split-spec} may be set to
12024 @code{nil}, in which case the group will be ignored by
12025 @code{gnus-group-split}.
12027 @vindex gnus-group-split-default-catch-all-group
12028 @code{gnus-group-split} will do cross-posting on all groups that match,
12029 by defining a single @code{&} fancy split containing one split for each
12030 group. If a message doesn't match any split, it will be stored in the
12031 group named in @code{gnus-group-split-default-catch-all-group}, unless
12032 some group has @var{split-spec} set to @code{catch-all}, in which case
12033 that group is used as the catch-all group. Even though this variable is
12034 often used just to name a group, it may also be set to an arbitrarily
12035 complex fancy split (after all, a group name is a fancy split), and this
12036 may be useful to split mail that doesn't go to any mailing list to
12037 personal mail folders. Note that this fancy split is added as the last
12038 element of a @code{|} split list that also contains a @code{&} split
12039 with the rules extracted from group parameters.
12041 It's time for an example. Assume the following group parameters have
12046 ((to-address . "bar@@femail.com")
12047 (split-regexp . ".*@@femail\\.com"))
12049 ((to-list . "foo@@nowhere.gov")
12050 (extra-aliases "foo@@localhost" "foo-redist@@home")
12051 (split-exclude "bugs-foo" "rambling-foo")
12052 (admin-address . "foo-request@@nowhere.gov"))
12054 ((split-spec . catch-all))
12057 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
12058 behave as if @code{nnmail-split-fancy} had been selected and variable
12059 @code{nnmail-split-fancy} had been set as follows:
12062 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
12063 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
12064 - "bugs-foo" - "rambling-foo" "mail.foo"))
12068 @findex gnus-group-split-fancy
12069 If you'd rather not use group splitting for all your mail groups, you
12070 may use it for only some of them, by using @code{nnmail-split-fancy}
12074 (: gnus-mlsplt-fancy GROUPS NO-CROSSPOST CATCH-ALL)
12077 @var{groups} may be a regular expression or a list of group names whose
12078 parameters will be scanned to generate the output split.
12079 @var{no-crosspost} can be used to disable cross-posting; in this case, a
12080 single @code{|} split will be output. @var{catch-all} is the fallback
12081 fancy split, used like @var{gnus-group-split-default-catch-all-group}.
12082 If @var{catch-all} is @code{nil}, or if @var{split-regexp} matches the
12083 empty string in any selected group, no catch-all split will be issued.
12084 Otherwise, if some group has @var{split-spec} set to @code{catch-all},
12085 this group will override the value of the @var{catch-all} argument.
12087 @findex gnus-group-split-setup
12088 Unfortunately, scanning all groups and their parameters can be quite
12089 slow, especially considering that it has to be done for every message.
12090 But don't despair! The function @code{gnus-group-split-setup} can be
12091 used to enable @code{gnus-group-split} in a much more efficient way. It
12092 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
12093 @code{nnmail-split-fancy} to the split produced by
12094 @code{gnus-group-split-fancy}. Thus, the group parameters are only
12095 scanned once, no matter how many messages are split.
12097 @findex gnus-group-split-update
12098 However, if you change group parameters, you'd have to update
12099 @code{nnmail-split-fancy} manually. You can do it by running
12100 @code{gnus-group-split-update}. If you'd rather have it updated
12101 automatically, just tell @code{gnus-group-split-setup} to do it for
12102 you. For example, add to your @file{.gnus}:
12105 (gnus-group-split-setup AUTO-UPDATE CATCH-ALL)
12108 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
12109 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
12110 have to worry about updating @code{nnmail-split-fancy} again. If you
12111 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
12112 @code{gnus-group-split-default-catch-all-group} will be set to its
12115 @vindex gnus-group-split-updated-hook
12116 Because you may want to change @code{nnmail-split-fancy} after it is set
12117 by @code{gnus-group-split-update}, this function will run
12118 @code{gnus-group-split-updated-hook} just before finishing.
12120 @node Incorporating Old Mail
12121 @subsection Incorporating Old Mail
12123 Most people have lots of old mail stored in various file formats. If
12124 you have set up Gnus to read mail using one of the spiffy Gnus mail
12125 backends, you'll probably wish to have that old mail incorporated into
12128 Doing so can be quite easy.
12130 To take an example: You're reading mail using @code{nnml}
12131 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
12132 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
12133 file filled with important, but old, mail. You want to move it into
12134 your @code{nnml} groups.
12140 Go to the group buffer.
12143 Type `G f' and give the path to the mbox file when prompted to create an
12144 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
12147 Type `SPACE' to enter the newly created group.
12150 Type `M P b' to process-mark all articles in this group's buffer
12151 (@pxref{Setting Process Marks}).
12154 Type `B r' to respool all the process-marked articles, and answer
12155 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
12158 All the mail messages in the mbox file will now also be spread out over
12159 all your @code{nnml} groups. Try entering them and check whether things
12160 have gone without a glitch. If things look ok, you may consider
12161 deleting the mbox file, but I wouldn't do that unless I was absolutely
12162 sure that all the mail has ended up where it should be.
12164 Respooling is also a handy thing to do if you're switching from one mail
12165 backend to another. Just respool all the mail in the old mail groups
12166 using the new mail backend.
12169 @node Expiring Mail
12170 @subsection Expiring Mail
12171 @cindex article expiry
12173 Traditional mail readers have a tendency to remove mail articles when
12174 you mark them as read, in some way. Gnus takes a fundamentally
12175 different approach to mail reading.
12177 Gnus basically considers mail just to be news that has been received in
12178 a rather peculiar manner. It does not think that it has the power to
12179 actually change the mail, or delete any mail messages. If you enter a
12180 mail group, and mark articles as ``read'', or kill them in some other
12181 fashion, the mail articles will still exist on the system. I repeat:
12182 Gnus will not delete your old, read mail. Unless you ask it to, of
12185 To make Gnus get rid of your unwanted mail, you have to mark the
12186 articles as @dfn{expirable}. This does not mean that the articles will
12187 disappear right away, however. In general, a mail article will be
12188 deleted from your system if, 1) it is marked as expirable, AND 2) it is
12189 more than one week old. If you do not mark an article as expirable, it
12190 will remain on your system until hell freezes over. This bears
12191 repeating one more time, with some spurious capitalizations: IF you do
12192 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
12194 @vindex gnus-auto-expirable-newsgroups
12195 You do not have to mark articles as expirable by hand. Groups that
12196 match the regular expression @code{gnus-auto-expirable-newsgroups} will
12197 have all articles that you read marked as expirable automatically. All
12198 articles marked as expirable have an @samp{E} in the first
12199 column in the summary buffer.
12201 By default, if you have auto expiry switched on, Gnus will mark all the
12202 articles you read as expirable, no matter if they were read or unread
12203 before. To avoid having articles marked as read marked as expirable
12204 automatically, you can put something like the following in your
12207 @vindex gnus-mark-article-hook
12209 (remove-hook 'gnus-mark-article-hook
12210 'gnus-summary-mark-read-and-unread-as-read)
12211 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
12214 Note that making a group auto-expirable doesn't mean that all read
12215 articles are expired---only the articles marked as expirable
12216 will be expired. Also note that using the @kbd{d} command won't make
12217 groups expirable---only semi-automatic marking of articles as read will
12218 mark the articles as expirable in auto-expirable groups.
12220 Let's say you subscribe to a couple of mailing lists, and you want the
12221 articles you have read to disappear after a while:
12224 (setq gnus-auto-expirable-newsgroups
12225 "mail.nonsense-list\\|mail.nice-list")
12228 Another way to have auto-expiry happen is to have the element
12229 @code{auto-expire} in the group parameters of the group.
12231 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
12232 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
12233 don't really mix very well.
12235 @vindex nnmail-expiry-wait
12236 The @code{nnmail-expiry-wait} variable supplies the default time an
12237 expirable article has to live. Gnus starts counting days from when the
12238 message @emph{arrived}, not from when it was sent. The default is seven
12241 Gnus also supplies a function that lets you fine-tune how long articles
12242 are to live, based on what group they are in. Let's say you want to
12243 have one month expiry period in the @samp{mail.private} group, a one day
12244 expiry period in the @samp{mail.junk} group, and a six day expiry period
12247 @vindex nnmail-expiry-wait-function
12249 (setq nnmail-expiry-wait-function
12251 (cond ((string= group "mail.private")
12253 ((string= group "mail.junk")
12255 ((string= group "important")
12261 The group names this function is fed are ``unadorned'' group
12262 names---no @samp{nnml:} prefixes and the like.
12264 The @code{nnmail-expiry-wait} variable and
12265 @code{nnmail-expiry-wait-function} function can either be a number (not
12266 necessarily an integer) or one of the symbols @code{immediate} or
12269 You can also use the @code{expiry-wait} group parameter to selectively
12270 change the expiry period (@pxref{Group Parameters}).
12272 @vindex nnmail-expiry-target
12273 The normal action taken when expiring articles is to delete them.
12274 However, in some circumstances it might make more sense to move them to
12275 other groups instead of deleting them. The variable @code{nnmail-expiry-target}
12276 (and the @code{expiry-target} group parameter) controls this. The
12277 variable supplies a default value for all groups, which can be
12278 overridden for specific groups by the group parameter.
12279 default value is @code{delete}, but this can also be a string (which
12280 should be the name of the group the message should be moved to), or a
12281 function (which will be called in a buffer narrowed to the message in
12282 question, and with the name of the group being moved from as its
12283 parameter) which should return a target -- either a group name or
12286 Here's an example for specifying a group name:
12288 (setq nnmail-expiry-target "nnml:expired")
12292 @vindex nnmail-keep-last-article
12293 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
12294 expire the final article in a mail newsgroup. This is to make life
12295 easier for procmail users.
12297 @vindex gnus-total-expirable-newsgroups
12298 By the way: That line up there, about Gnus never expiring non-expirable
12299 articles, is a lie. If you put @code{total-expire} in the group
12300 parameters, articles will not be marked as expirable, but all read
12301 articles will be put through the expiry process. Use with extreme
12302 caution. Even more dangerous is the
12303 @code{gnus-total-expirable-newsgroups} variable. All groups that match
12304 this regexp will have all read articles put through the expiry process,
12305 which means that @emph{all} old mail articles in the groups in question
12306 will be deleted after a while. Use with extreme caution, and don't come
12307 crying to me when you discover that the regexp you used matched the
12308 wrong group and all your important mail has disappeared. Be a
12309 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
12312 Most people make most of their mail groups total-expirable, though.
12314 @vindex gnus-inhibit-user-auto-expire
12315 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
12316 commands will not mark an article as expirable, even if the group has
12317 auto-expire turned on.
12321 @subsection Washing Mail
12322 @cindex mail washing
12323 @cindex list server brain damage
12324 @cindex incoming mail treatment
12326 Mailers and list servers are notorious for doing all sorts of really,
12327 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
12328 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
12329 end of all lines passing through our server, so let's do that!!!!1!''
12330 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
12331 considered to be self-evident were not discussed. So. Here we are.
12333 Case in point: The German version of Microsoft Exchange adds @samp{AW:
12334 } to the subjects of replies instead of @samp{Re: }. I could pretend to
12335 be shocked and dismayed by this, but I haven't got the energy. It is to
12338 Gnus provides a plethora of functions for washing articles while
12339 displaying them, but it might be nicer to do the filtering before
12340 storing the mail to disc. For that purpose, we have three hooks and
12341 various functions that can be put in these hooks.
12344 @item nnmail-prepare-incoming-hook
12345 @vindex nnmail-prepare-incoming-hook
12346 This hook is called before doing anything with the mail and is meant for
12347 grand, sweeping gestures. It is called in a buffer that contains all
12348 the new, incoming mail. Functions to be used include:
12351 @item nnheader-ms-strip-cr
12352 @findex nnheader-ms-strip-cr
12353 Remove trailing carriage returns from each line. This is default on
12354 Emacs running on MS machines.
12358 @item nnmail-prepare-incoming-header-hook
12359 @vindex nnmail-prepare-incoming-header-hook
12360 This hook is called narrowed to each header. It can be used when
12361 cleaning up the headers. Functions that can be used include:
12364 @item nnmail-remove-leading-whitespace
12365 @findex nnmail-remove-leading-whitespace
12366 Clear leading white space that ``helpful'' listservs have added to the
12367 headers to make them look nice. Aaah.
12369 @item nnmail-remove-list-identifiers
12370 @findex nnmail-remove-list-identifiers
12371 Some list servers add an identifier---for example, @samp{(idm)}---to the
12372 beginning of all @code{Subject} headers. I'm sure that's nice for
12373 people who use stone age mail readers. This function will remove
12374 strings that match the @code{nnmail-list-identifiers} regexp, which can
12375 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
12378 For instance, if you want to remove the @samp{(idm)} and the
12379 @samp{nagnagnag} identifiers:
12382 (setq nnmail-list-identifiers
12383 '("(idm)" "nagnagnag"))
12386 This can also be done non-destructively with
12387 @code{gnus-list-identifiers}, @xref{Article Hiding}.
12389 @item nnmail-remove-tabs
12390 @findex nnmail-remove-tabs
12391 Translate all @samp{TAB} characters into @samp{SPACE} characters.
12393 @item nnmail-fix-eudora-headers
12394 @findex nnmail-fix-eudora-headers
12396 Eudora produces broken @code{References} headers, but OK
12397 @code{In-Reply-To} headers. This function will get rid of the
12398 @code{References} headers.
12402 @item nnmail-prepare-incoming-message-hook
12403 @vindex nnmail-prepare-incoming-message-hook
12404 This hook is called narrowed to each message. Functions to be used
12408 @item article-de-quoted-unreadable
12409 @findex article-de-quoted-unreadable
12410 Decode Quoted Readable encoding.
12417 @subsection Duplicates
12419 @vindex nnmail-treat-duplicates
12420 @vindex nnmail-message-id-cache-length
12421 @vindex nnmail-message-id-cache-file
12422 @cindex duplicate mails
12423 If you are a member of a couple of mailing lists, you will sometimes
12424 receive two copies of the same mail. This can be quite annoying, so
12425 @code{nnmail} checks for and treats any duplicates it might find. To do
12426 this, it keeps a cache of old @code{Message-ID}s---
12427 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
12428 default. The approximate maximum number of @code{Message-ID}s stored
12429 there is controlled by the @code{nnmail-message-id-cache-length}
12430 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
12431 stored.) If all this sounds scary to you, you can set
12432 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
12433 default), and @code{nnmail} won't delete duplicate mails. Instead it
12434 will insert a warning into the head of the mail saying that it thinks
12435 that this is a duplicate of a different message.
12437 This variable can also be a function. If that's the case, the function
12438 will be called from a buffer narrowed to the message in question with
12439 the @code{Message-ID} as a parameter. The function must return either
12440 @code{nil}, @code{warn}, or @code{delete}.
12442 You can turn this feature off completely by setting the variable to
12445 If you want all the duplicate mails to be put into a special
12446 @dfn{duplicates} group, you could do that using the normal mail split
12450 (setq nnmail-split-fancy
12451 '(| ;; Messages duplicates go to a separate group.
12452 ("gnus-warning" "duplication of message" "duplicate")
12453 ;; Message from daemons, postmaster, and the like to another.
12454 (any mail "mail.misc")
12461 (setq nnmail-split-methods
12462 '(("duplicates" "^Gnus-Warning:")
12467 Here's a neat feature: If you know that the recipient reads her mail
12468 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
12469 @code{delete}, you can send her as many insults as you like, just by
12470 using a @code{Message-ID} of a mail that you know that she's already
12471 received. Think of all the fun! She'll never see any of it! Whee!
12474 @node Not Reading Mail
12475 @subsection Not Reading Mail
12477 If you start using any of the mail backends, they have the annoying
12478 habit of assuming that you want to read mail with them. This might not
12479 be unreasonable, but it might not be what you want.
12481 If you set @code{mail-sources} and @code{nnmail-spool-file} to
12482 @code{nil}, none of the backends will ever attempt to read incoming
12483 mail, which should help.
12485 @vindex nnbabyl-get-new-mail
12486 @vindex nnmbox-get-new-mail
12487 @vindex nnml-get-new-mail
12488 @vindex nnmh-get-new-mail
12489 @vindex nnfolder-get-new-mail
12490 This might be too much, if, for instance, you are reading mail quite
12491 happily with @code{nnml} and just want to peek at some old @sc{rmail}
12492 file you have stashed away with @code{nnbabyl}. All backends have
12493 variables called backend-@code{get-new-mail}. If you want to disable
12494 the @code{nnbabyl} mail reading, you edit the virtual server for the
12495 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
12497 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
12498 narrowed to the article to be saved before saving it when reading
12502 @node Choosing a Mail Backend
12503 @subsection Choosing a Mail Backend
12505 Gnus will read the mail spool when you activate a mail group. The mail
12506 file is first copied to your home directory. What happens after that
12507 depends on what format you want to store your mail in.
12509 There are five different mail backends in the standard Gnus, and more
12510 backends are available separately. The mail backend most people use
12511 (because it is the fastest and most flexible) is @code{nnml}
12512 (@pxref{Mail Spool}).
12515 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
12516 * Rmail Babyl:: Emacs programs use the rmail babyl format.
12517 * Mail Spool:: Store your mail in a private spool?
12518 * MH Spool:: An mhspool-like backend.
12519 * Mail Folders:: Having one file for each group.
12520 * Comparing Mail Backends:: An in-depth looks at pros and cons.
12524 @node Unix Mail Box
12525 @subsubsection Unix Mail Box
12527 @cindex unix mail box
12529 @vindex nnmbox-active-file
12530 @vindex nnmbox-mbox-file
12531 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
12532 mail. @code{nnmbox} will add extra headers to each mail article to say
12533 which group it belongs in.
12535 Virtual server settings:
12538 @item nnmbox-mbox-file
12539 @vindex nnmbox-mbox-file
12540 The name of the mail box in the user's home directory.
12542 @item nnmbox-active-file
12543 @vindex nnmbox-active-file
12544 The name of the active file for the mail box.
12546 @item nnmbox-get-new-mail
12547 @vindex nnmbox-get-new-mail
12548 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
12554 @subsubsection Rmail Babyl
12558 @vindex nnbabyl-active-file
12559 @vindex nnbabyl-mbox-file
12560 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
12561 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
12562 mail article to say which group it belongs in.
12564 Virtual server settings:
12567 @item nnbabyl-mbox-file
12568 @vindex nnbabyl-mbox-file
12569 The name of the rmail mbox file.
12571 @item nnbabyl-active-file
12572 @vindex nnbabyl-active-file
12573 The name of the active file for the rmail box.
12575 @item nnbabyl-get-new-mail
12576 @vindex nnbabyl-get-new-mail
12577 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
12582 @subsubsection Mail Spool
12584 @cindex mail @sc{nov} spool
12586 The @dfn{nnml} spool mail format isn't compatible with any other known
12587 format. It should be used with some caution.
12589 @vindex nnml-directory
12590 If you use this backend, Gnus will split all incoming mail into files,
12591 one file for each mail, and put the articles into the corresponding
12592 directories under the directory specified by the @code{nnml-directory}
12593 variable. The default value is @file{~/Mail/}.
12595 You do not have to create any directories beforehand; Gnus will take
12598 If you have a strict limit as to how many files you are allowed to store
12599 in your account, you should not use this backend. As each mail gets its
12600 own file, you might very well occupy thousands of inodes within a few
12601 weeks. If this is no problem for you, and it isn't a problem for you
12602 having your friendly systems administrator walking around, madly,
12603 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
12604 know that this is probably the fastest format to use. You do not have
12605 to trudge through a big mbox file just to read your new mail.
12607 @code{nnml} is probably the slowest backend when it comes to article
12608 splitting. It has to create lots of files, and it also generates
12609 @sc{nov} databases for the incoming mails. This makes it the fastest
12610 backend when it comes to reading mail.
12612 Virtual server settings:
12615 @item nnml-directory
12616 @vindex nnml-directory
12617 All @code{nnml} directories will be placed under this directory.
12619 @item nnml-active-file
12620 @vindex nnml-active-file
12621 The active file for the @code{nnml} server.
12623 @item nnml-newsgroups-file
12624 @vindex nnml-newsgroups-file
12625 The @code{nnml} group descriptions file. @xref{Newsgroups File
12628 @item nnml-get-new-mail
12629 @vindex nnml-get-new-mail
12630 If non-@code{nil}, @code{nnml} will read incoming mail.
12632 @item nnml-nov-is-evil
12633 @vindex nnml-nov-is-evil
12634 If non-@code{nil}, this backend will ignore any @sc{nov} files.
12636 @item nnml-nov-file-name
12637 @vindex nnml-nov-file-name
12638 The name of the @sc{nov} files. The default is @file{.overview}.
12640 @item nnml-prepare-save-mail-hook
12641 @vindex nnml-prepare-save-mail-hook
12642 Hook run narrowed to an article before saving.
12646 @findex nnml-generate-nov-databases
12647 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
12648 you can do a complete update by typing @kbd{M-x
12649 nnml-generate-nov-databases}. This command will trawl through the
12650 entire @code{nnml} hierarchy, looking at each and every article, so it
12651 might take a while to complete. A better interface to this
12652 functionality can be found in the server buffer (@pxref{Server
12657 @subsubsection MH Spool
12659 @cindex mh-e mail spool
12661 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
12662 @sc{nov} databases and it doesn't keep an active file. This makes
12663 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
12664 makes it easier to write procmail scripts for.
12666 Virtual server settings:
12669 @item nnmh-directory
12670 @vindex nnmh-directory
12671 All @code{nnmh} directories will be located under this directory.
12673 @item nnmh-get-new-mail
12674 @vindex nnmh-get-new-mail
12675 If non-@code{nil}, @code{nnmh} will read incoming mail.
12678 @vindex nnmh-be-safe
12679 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
12680 sure that the articles in the folder are actually what Gnus thinks they
12681 are. It will check date stamps and stat everything in sight, so
12682 setting this to @code{t} will mean a serious slow-down. If you never
12683 use anything but Gnus to read the @code{nnmh} articles, you do not have
12684 to set this variable to @code{t}.
12689 @subsubsection Mail Folders
12691 @cindex mbox folders
12692 @cindex mail folders
12694 @code{nnfolder} is a backend for storing each mail group in a separate
12695 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
12696 will add extra headers to keep track of article numbers and arrival
12699 Virtual server settings:
12702 @item nnfolder-directory
12703 @vindex nnfolder-directory
12704 All the @code{nnfolder} mail boxes will be stored under this directory.
12706 @item nnfolder-active-file
12707 @vindex nnfolder-active-file
12708 The name of the active file.
12710 @item nnfolder-newsgroups-file
12711 @vindex nnfolder-newsgroups-file
12712 The name of the group descriptions file. @xref{Newsgroups File Format}.
12714 @item nnfolder-get-new-mail
12715 @vindex nnfolder-get-new-mail
12716 If non-@code{nil}, @code{nnfolder} will read incoming mail.
12718 @item nnfolder-save-buffer-hook
12719 @vindex nnfolder-save-buffer-hook
12720 @cindex backup files
12721 Hook run before saving the folders. Note that Emacs does the normal
12722 backup renaming of files even with the @code{nnfolder} buffers. If you
12723 wish to switch this off, you could say something like the following in
12724 your @file{.emacs} file:
12727 (defun turn-off-backup ()
12728 (set (make-local-variable 'backup-inhibited) t))
12730 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
12733 @item nnfolder-delete-mail-hook
12734 @vindex nnfolder-delete-mail-hook
12735 Hook run in a buffer narrowed to the message that is to be deleted.
12736 This function can be used to copy the message to somewhere else, or to
12737 extract some information from it before removing it.
12739 @item nnfolder-nov-is-evil
12740 @vindex nnfolder-nov-is-evil
12741 If non-@code{nil}, this backend will ignore any @sc{nov} files.
12746 @findex nnfolder-generate-active-file
12747 @kindex M-x nnfolder-generate-active-file
12748 If you have lots of @code{nnfolder}-like files you'd like to read with
12749 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
12750 command to make @code{nnfolder} aware of all likely files in
12751 @code{nnfolder-directory}. This only works if you use long file names,
12754 @node Comparing Mail Backends
12755 @subsubsection Comparing Mail Backends
12757 First, just for terminology, the @dfn{backend} is the common word for a
12758 low-level access method---a transport, if you will, by which something
12759 is acquired. The sense is that one's mail has to come from somewhere,
12760 and so selection of a suitable backend is required in order to get that
12761 mail within spitting distance of Gnus.
12763 The same concept exists for Usenet itself: Though access to articles is
12764 typically done by @sc{nntp} these days, once upon a midnight dreary, everyone
12765 in the world got at Usenet by running a reader on the machine where the
12766 articles lay (the machine which today we call an @sc{nntp} server), and
12767 access was by the reader stepping into the articles' directory spool
12768 area directly. One can still select between either the @code{nntp} or
12769 @code{nnspool} backends, to select between these methods, if one happens
12770 actually to live on the server (or can see its spool directly, anyway,
12773 The goal in selecting a mail backend is to pick one which
12774 simultaneously represents a suitable way of dealing with the original
12775 format plus leaving mail in a form that is convenient to use in the
12776 future. Here are some high and low points on each:
12781 UNIX systems have historically had a single, very common, and well-
12782 defined format. All messages arrive in a single @dfn{spool file}, and
12783 they are delineated by a line whose regular expression matches
12784 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
12785 to make it clear in this instance that this is not the RFC-specified
12786 @samp{From:} header.) Because Emacs and therefore Gnus emanate
12787 historically from the Unix environment, it is simplest if one does not
12788 mess a great deal with the original mailbox format, so if one chooses
12789 this backend, Gnus' primary activity in getting mail from the real spool
12790 area to Gnus' preferred directory is simply to copy it, with no
12791 (appreciable) format change in the process. It is the ``dumbest'' way
12792 to move mail into availability in the Gnus environment. This makes it
12793 fast to move into place, but slow to parse, when Gnus has to look at
12798 Once upon a time, there was the DEC-10 and DEC-20, running operating
12799 systems called TOPS and related things, and the usual (only?) mail
12800 reading environment was a thing called Babyl. I don't know what format
12801 was used for mail landing on the system, but Babyl had its own internal
12802 format to which mail was converted, primarily involving creating a
12803 spool-file-like entity with a scheme for inserting Babyl-specific
12804 headers and status bits above the top of each message in the file.
12805 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
12806 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
12807 to understand the mail files folks already had in existence. Gnus (and
12808 VM, for that matter) continue to support this format because it's
12809 perceived as having some good qualities in those mailer-specific
12810 headers/status bits stuff. RMAIL itself still exists as well, of
12811 course, and is still maintained by Stallman.
12813 Both of the above forms leave your mail in a single file on your
12814 filesystem, and they must parse that entire file each time you take a
12819 @code{nnml} is the backend which smells the most as though you were
12820 actually operating with an @code{nnspool}-accessed Usenet system. (In
12821 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
12822 lo these years ago.) One's mail is taken from the original spool file,
12823 and is then cut up into individual message files, 1:1. It maintains a
12824 Usenet-style active file (analogous to what one finds in an INN- or
12825 CNews-based news system in (for instance) @file{/var/lib/news/active},
12826 or what is returned via the @samp{NNTP LIST} verb) and also creates
12827 @dfn{overview} files for efficient group entry, as has been defined for
12828 @sc{nntp} servers for some years now. It is slower in mail-splitting,
12829 due to the creation of lots of files, updates to the @code{nnml} active
12830 file, and additions to overview files on a per-message basis, but it is
12831 extremely fast on access because of what amounts to the indexing support
12832 provided by the active file and overviews.
12834 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
12835 resource which defines available places in the filesystem to put new
12836 files. Sysadmins take a dim view of heavy inode occupation within
12837 tight, shared filesystems. But if you live on a personal machine where
12838 the filesystem is your own and space is not at a premium, @code{nnml}
12841 It is also problematic using this backend if you are living in a
12842 FAT16-based Windows world, since much space will be wasted on all these
12847 The Rand MH mail-reading system has been around UNIX systems for a very
12848 long time; it operates by splitting one's spool file of messages into
12849 individual files, but with little or no indexing support -- @code{nnmh}
12850 is considered to be semantically equivalent to ``@code{nnml} without
12851 active file or overviews''. This is arguably the worst choice, because
12852 one gets the slowness of individual file creation married to the
12853 slowness of access parsing when learning what's new in one's groups.
12857 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
12858 method described above) on a per-group basis. That is, @code{nnmbox}
12859 itself puts *all* one's mail in one file; @code{nnfolder} provides a
12860 little bit of optimization to this so that each of one's mail groups has
12861 a Unix mail box file. It's faster than @code{nnmbox} because each group
12862 can be parsed separately, and still provides the simple Unix mail box
12863 format requiring minimal effort in moving the mail around. In addition,
12864 it maintains an ``active'' file making it much faster for Gnus to figure
12865 out how many messages there are in each separate group.
12867 If you have groups that are expected to have a massive amount of
12868 messages, @code{nnfolder} is not the best choice, but if you receive
12869 only a moderate amount of mail, @code{nnfolder} is probably the most
12870 friendly mail backend all over.
12875 @node Browsing the Web
12876 @section Browsing the Web
12878 @cindex browsing the web
12882 Web-based discussion forums are getting more and more popular. On many
12883 subjects, the web-based forums have become the most important forums,
12884 eclipsing the importance of mailing lists and news groups. The reason
12885 is easy to understand---they are friendly to new users; you just point
12886 and click, and there's the discussion. With mailing lists, you have to
12887 go through a cumbersome subscription procedure, and most people don't
12888 even know what a news group is.
12890 The problem with this scenario is that web browsers are not very good at
12891 being newsreaders. They do not keep track of what articles you've read;
12892 they do not allow you to score on subjects you're interested in; they do
12893 not allow off-line browsing; they require you to click around and drive
12894 you mad in the end.
12896 So---if web browsers suck at reading discussion forums, why not use Gnus
12899 Gnus has been getting a bit of a collection of backends for providing
12900 interfaces to these sources.
12903 * Web Searches:: Creating groups from articles that match a string.
12904 * Slashdot:: Reading the Slashdot comments.
12905 * Ultimate:: The Ultimate Bulletin Board systems.
12906 * Web Archive:: Reading mailing list archived on web.
12907 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
12910 All the web sources require Emacs/w3 and the url library to work.
12912 The main caveat with all these web sources is that they probably won't
12913 work for a very long time. Gleaning information from the @sc{html} data
12914 is guesswork at best, and when the layout is altered, the Gnus backend
12915 will fail. If you have reasonably new versions of these backends,
12916 though, you should be ok.
12918 One thing all these Web methods have in common is that the Web sources
12919 are often down, unavailable or just plain too slow to be fun. In those
12920 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
12921 Unplugged}) handle downloading articles, and then you can read them at
12922 leisure from your local disk. No more World Wide Wait for you.
12926 @subsection Web Searches
12930 @cindex InReference
12931 @cindex Usenet searches
12932 @cindex searching the Usenet
12934 It's, like, too neat to search the Usenet for articles that match a
12935 string, but it, like, totally @emph{sucks}, like, totally, to use one of
12936 those, like, Web browsers, and you, like, have to, rilly, like, look at
12937 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
12938 searches without having to use a browser.
12940 The @code{nnweb} backend allows an easy interface to the mighty search
12941 engine. You create an @code{nnweb} group, enter a search pattern, and
12942 then enter the group and read the articles like you would any normal
12943 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
12944 Groups}) will do this in an easy-to-use fashion.
12946 @code{nnweb} groups don't really lend themselves to being solid
12947 groups---they have a very fleeting idea of article numbers. In fact,
12948 each time you enter an @code{nnweb} group (not even changing the search
12949 pattern), you are likely to get the articles ordered in a different
12950 manner. Not even using duplicate suppression (@pxref{Duplicate
12951 Suppression}) will help, since @code{nnweb} doesn't even know the
12952 @code{Message-ID} of the articles before reading them using some search
12953 engines (DejaNews, for instance). The only possible way to keep track
12954 of which articles you've read is by scoring on the @code{Date}
12955 header---mark all articles posted before the last date you read the
12958 If the search engine changes its output substantially, @code{nnweb}
12959 won't be able to parse it and will fail. One could hardly fault the Web
12960 providers if they were to do this---their @emph{raison d'être} is to
12961 make money off of advertisements, not to provide services to the
12962 community. Since @code{nnweb} washes the ads off all the articles, one
12963 might think that the providers might be somewhat miffed. We'll see.
12965 You must have the @code{url} and @code{w3} package installed to be able
12966 to use @code{nnweb}.
12968 Virtual server variables:
12973 What search engine type is being used. The currently supported types
12974 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
12978 @vindex nnweb-search
12979 The search string to feed to the search engine.
12981 @item nnweb-max-hits
12982 @vindex nnweb-max-hits
12983 Advisory maximum number of hits per search to display. The default is
12986 @item nnweb-type-definition
12987 @vindex nnweb-type-definition
12988 Type-to-definition alist. This alist says what @code{nnweb} should do
12989 with the various search engine types. The following elements must be
12994 Function to decode the article and provide something that Gnus
12998 Function to create an article number to message header and URL alist.
13001 Function to send the search string to the search engine.
13004 The address the aforementioned function should send the search string
13008 Format string URL to fetch an article by @code{Message-ID}.
13015 @subsection Slashdot
13019 Slashdot (@uref{http://slashdot.org/}) is a popular news site, with
13020 lively discussion following the news articles. @code{nnslashdot} will
13021 let you read this forum in a convenient manner.
13023 The easiest way to read this source is to put something like the
13024 following in your @file{.gnus.el} file:
13027 (setq gnus-secondary-select-methods
13028 '((nnslashdot "")))
13031 This will make Gnus query the @code{nnslashdot} backend for new comments
13032 and groups. The @kbd{F} command will subscribe each new news article as
13033 a new Gnus group, and you can read the comments by entering these
13034 groups. (Note that the default subscription method is to subscribe new
13035 groups as zombies. Other methods are available (@pxref{Subscription
13038 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
13039 command is the most handy tool (@pxref{Foreign Groups}).
13041 When following up to @code{nnslashdot} comments (or posting new
13042 comments), some light @sc{html}izations will be performed. In
13043 particular, text quoted with @samp{> } will be quoted with
13044 @code{blockquote} instead, and signatures will have @code{br} added to
13045 the end of each line. Other than that, you can just write @sc{html}
13046 directly into the message buffer. Note that Slashdot filters out some
13049 The following variables can be altered to change its behavior:
13052 @item nnslashdot-threaded
13053 Whether @code{nnslashdot} should display threaded groups or not. The
13054 default is @code{t}. To be able to display threads, @code{nnslashdot}
13055 has to retrieve absolutely all comments in a group upon entry. If a
13056 threaded display is not required, @code{nnslashdot} will only retrieve
13057 the comments that are actually wanted by the user. Threading is nicer,
13058 but much, much slower than untreaded.
13060 @item nnslashdot-login-name
13061 @vindex nnslashdot-login-name
13062 The login name to use when posting.
13064 @item nnslashdot-password
13065 @vindex nnslashdot-password
13066 The password to use when posting.
13068 @item nnslashdot-directory
13069 @vindex nnslashdot-directory
13070 Where @code{nnslashdot} will store its files. The default value is
13071 @samp{~/News/slashdot/}.
13073 @item nnslashdot-active-url
13074 @vindex nnslashdot-active-url
13075 The @sc{url} format string that will be used to fetch the information on
13076 news articles and comments. The default is
13077 @samp{http://slashdot.org/search.pl?section=&min=%d}.
13079 @item nnslashdot-comments-url
13080 @vindex nnslashdot-comments-url
13081 The @sc{url} format string that will be used to fetch comments. The
13083 @samp{http://slashdot.org/comments.pl?sid=%s&threshold=%d&commentsort=%d&mode=flat&startat=%d}.
13085 @item nnslashdot-article-url
13086 @vindex nnslashdot-article-url
13087 The @sc{url} format string that will be used to fetch the news article. The
13089 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
13091 @item nnslashdot-threshold
13092 @vindex nnslashdot-threshold
13093 The score threshold. The default is -1.
13095 @item nnslashdot-group-number
13096 @vindex nnslashdot-group-number
13097 The number of old groups, in addition to the ten latest, to keep
13098 updated. The default is 0.
13105 @subsection Ultimate
13107 @cindex Ultimate Bulletin Board
13109 The Ultimate Bulletin Board (@uref{http://www.ultimatebb.com/}) is
13110 probably the most popular Web bulletin board system used. It has a
13111 quite regular and nice interface, and it's possible to get the
13112 information Gnus needs to keep groups updated.
13114 The easiest way to get started with @code{nnultimate} is to say
13115 something like the following in the group buffer: @kbd{B nnultimate RET
13116 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @sc{url}
13117 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
13118 you're interested in; there's quite a list of them on the Ultimate web
13119 site.) Then subscribe to the groups you're interested in from the
13120 server buffer, and read them from the group buffer.
13122 The following @code{nnultimate} variables can be altered:
13125 @item nnultimate-directory
13126 @vindex nnultimate-directory
13127 The directory where @code{nnultimate} stores its files. The default is
13128 @samp{~/News/ultimate/}.
13133 @subsection Web Archive
13135 @cindex Web Archive
13137 Some mailing lists only have archives on Web servers, such as
13138 @uref{http://www.egroups.com/} and
13139 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
13140 interface, and it's possible to get the information Gnus needs to keep
13143 The easiest way to get started with @code{nnwarchive} is to say
13144 something like the following in the group buffer: @kbd{M-x
13145 gnus-group-make-warchive-group RET an_egroup RET egroups RET
13146 www.egroups.com RET your@@email.address RET}. (Substitute the
13147 @sc{an_egroup} with the mailing list you subscribed, the
13148 @sc{your@@email.address} with your email address.), or to browse the
13149 backend by @kbd{B nnwarchive RET mail-archive RET}.
13151 The following @code{nnwarchive} variables can be altered:
13154 @item nnwarchive-directory
13155 @vindex nnwarchive-directory
13156 The directory where @code{nnwarchive} stores its files. The default is
13157 @samp{~/News/warchive/}.
13159 @item nnwarchive-login
13160 @vindex nnwarchive-login
13161 The account name on the web server.
13163 @item nnwarchive-passwd
13164 @vindex nnwarchive-passwd
13165 The password for your account on the web server.
13169 @node Customizing w3
13170 @subsection Customizing w3
13176 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
13177 pages. Emacs/w3 is documented in its own manual, but there are some
13178 things that may be more relevant for Gnus users.
13180 For instance, a common question is how to make Emacs/w3 follow links
13181 using the @code{browse-url} functions (which will call some external web
13182 browser like Netscape). Here's one way:
13185 (eval-after-load "w3"
13187 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
13188 (defun w3-fetch (&optional url target)
13189 (interactive (list (w3-read-url-with-default)))
13190 (if (eq major-mode 'gnus-article-mode)
13192 (w3-fetch-orig url target)))))
13195 Put that in your @file{.emacs} file, and hitting links in w3-rendered
13196 @sc{html} in the Gnus article buffers will use @code{browse-url} to
13200 @node Other Sources
13201 @section Other Sources
13203 Gnus can do more than just read news or mail. The methods described
13204 below allow Gnus to view directories and files as if they were
13208 * Directory Groups:: You can read a directory as if it was a newsgroup.
13209 * Anything Groups:: Dired? Who needs dired?
13210 * Document Groups:: Single files can be the basis of a group.
13211 * SOUP:: Reading @sc{soup} packets ``offline''.
13212 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
13213 * IMAP:: Using Gnus as a @sc{imap} client.
13217 @node Directory Groups
13218 @subsection Directory Groups
13220 @cindex directory groups
13222 If you have a directory that has lots of articles in separate files in
13223 it, you might treat it as a newsgroup. The files have to have numerical
13226 This might be an opportune moment to mention @code{ange-ftp} (and its
13227 successor @code{efs}), that most wonderful of all wonderful Emacs
13228 packages. When I wrote @code{nndir}, I didn't think much about it---a
13229 backend to read directories. Big deal.
13231 @code{ange-ftp} changes that picture dramatically. For instance, if you
13232 enter the @code{ange-ftp} file name
13233 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
13234 @code{ange-ftp} or @code{efs} will actually allow you to read this
13235 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
13237 @code{nndir} will use @sc{nov} files if they are present.
13239 @code{nndir} is a ``read-only'' backend---you can't delete or expire
13240 articles with this method. You can use @code{nnmh} or @code{nnml} for
13241 whatever you use @code{nndir} for, so you could switch to any of those
13242 methods if you feel the need to have a non-read-only @code{nndir}.
13245 @node Anything Groups
13246 @subsection Anything Groups
13249 From the @code{nndir} backend (which reads a single spool-like
13250 directory), it's just a hop and a skip to @code{nneething}, which
13251 pretends that any arbitrary directory is a newsgroup. Strange, but
13254 When @code{nneething} is presented with a directory, it will scan this
13255 directory and assign article numbers to each file. When you enter such
13256 a group, @code{nneething} must create ``headers'' that Gnus can use.
13257 After all, Gnus is a newsreader, in case you're forgetting.
13258 @code{nneething} does this in a two-step process. First, it snoops each
13259 file in question. If the file looks like an article (i.e., the first
13260 few lines look like headers), it will use this as the head. If this is
13261 just some arbitrary file without a head (e.g. a C source file),
13262 @code{nneething} will cobble up a header out of thin air. It will use
13263 file ownership, name and date and do whatever it can with these
13266 All this should happen automatically for you, and you will be presented
13267 with something that looks very much like a newsgroup. Totally like a
13268 newsgroup, to be precise. If you select an article, it will be displayed
13269 in the article buffer, just as usual.
13271 If you select a line that represents a directory, Gnus will pop you into
13272 a new summary buffer for this @code{nneething} group. And so on. You can
13273 traverse the entire disk this way, if you feel like, but remember that
13274 Gnus is not dired, really, and does not intend to be, either.
13276 There are two overall modes to this action---ephemeral or solid. When
13277 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
13278 will not store information on what files you have read, and what files
13279 are new, and so on. If you create a solid @code{nneething} group the
13280 normal way with @kbd{G m}, Gnus will store a mapping table between
13281 article numbers and file names, and you can treat this group like any
13282 other groups. When you activate a solid @code{nneething} group, you will
13283 be told how many unread articles it contains, etc., etc.
13288 @item nneething-map-file-directory
13289 @vindex nneething-map-file-directory
13290 All the mapping files for solid @code{nneething} groups will be stored
13291 in this directory, which defaults to @file{~/.nneething/}.
13293 @item nneething-exclude-files
13294 @vindex nneething-exclude-files
13295 All files that match this regexp will be ignored. Nice to use to exclude
13296 auto-save files and the like, which is what it does by default.
13298 @item nneething-include-files
13299 @vindex nneething-include-files
13300 Regexp saying what files to include in the group. If this variable is
13301 non-@code{nil}, only files matching this regexp will be included.
13303 @item nneething-map-file
13304 @vindex nneething-map-file
13305 Name of the map files.
13309 @node Document Groups
13310 @subsection Document Groups
13312 @cindex documentation group
13315 @code{nndoc} is a cute little thing that will let you read a single file
13316 as a newsgroup. Several files types are supported:
13323 The babyl (rmail) mail box.
13328 The standard Unix mbox file.
13330 @cindex MMDF mail box
13332 The MMDF mail box format.
13335 Several news articles appended into a file.
13338 @cindex rnews batch files
13339 The rnews batch transport format.
13340 @cindex forwarded messages
13343 Forwarded articles.
13346 Netscape mail boxes.
13349 MIME multipart messages.
13351 @item standard-digest
13352 The standard (RFC 1153) digest format.
13355 Non-standard digest format---matches most things, but does it badly.
13358 You can also use the special ``file type'' @code{guess}, which means
13359 that @code{nndoc} will try to guess what file type it is looking at.
13360 @code{digest} means that @code{nndoc} should guess what digest type the
13363 @code{nndoc} will not try to change the file or insert any extra headers into
13364 it---it will simply, like, let you use the file as the basis for a
13365 group. And that's it.
13367 If you have some old archived articles that you want to insert into your
13368 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
13369 that. Say you have an old @file{RMAIL} file with mail that you now want
13370 to split into your new @code{nnml} groups. You look at that file using
13371 @code{nndoc} (using the @kbd{G f} command in the group buffer
13372 (@pxref{Foreign Groups})), set the process mark on all the articles in
13373 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
13374 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
13375 file is now also stored in lots of @code{nnml} directories, and you can
13376 delete that pesky @file{RMAIL} file. If you have the guts!
13378 Virtual server variables:
13381 @item nndoc-article-type
13382 @vindex nndoc-article-type
13383 This should be one of @code{mbox}, @code{babyl}, @code{digest},
13384 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
13385 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
13386 @code{slack-digest}, @code{clari-briefs}, @code{nsmail} or @code{guess}.
13388 @item nndoc-post-type
13389 @vindex nndoc-post-type
13390 This variable says whether Gnus is to consider the group a news group or
13391 a mail group. There are two valid values: @code{mail} (the default)
13396 * Document Server Internals:: How to add your own document types.
13400 @node Document Server Internals
13401 @subsubsection Document Server Internals
13403 Adding new document types to be recognized by @code{nndoc} isn't
13404 difficult. You just have to whip up a definition of what the document
13405 looks like, write a predicate function to recognize that document type,
13406 and then hook into @code{nndoc}.
13408 First, here's an example document type definition:
13412 (article-begin . "^\^A\^A\^A\^A\n")
13413 (body-end . "^\^A\^A\^A\^A\n"))
13416 The definition is simply a unique @dfn{name} followed by a series of
13417 regexp pseudo-variable settings. Below are the possible
13418 variables---don't be daunted by the number of variables; most document
13419 types can be defined with very few settings:
13422 @item first-article
13423 If present, @code{nndoc} will skip past all text until it finds
13424 something that match this regexp. All text before this will be
13427 @item article-begin
13428 This setting has to be present in all document type definitions. It
13429 says what the beginning of each article looks like.
13431 @item head-begin-function
13432 If present, this should be a function that moves point to the head of
13435 @item nndoc-head-begin
13436 If present, this should be a regexp that matches the head of the
13439 @item nndoc-head-end
13440 This should match the end of the head of the article. It defaults to
13441 @samp{^$}---the empty line.
13443 @item body-begin-function
13444 If present, this function should move point to the beginning of the body
13448 This should match the beginning of the body of the article. It defaults
13451 @item body-end-function
13452 If present, this function should move point to the end of the body of
13456 If present, this should match the end of the body of the article.
13459 If present, this should match the end of the file. All text after this
13460 regexp will be totally ignored.
13464 So, using these variables @code{nndoc} is able to dissect a document
13465 file into a series of articles, each with a head and a body. However, a
13466 few more variables are needed since not all document types are all that
13467 news-like---variables needed to transform the head or the body into
13468 something that's palatable for Gnus:
13471 @item prepare-body-function
13472 If present, this function will be called when requesting an article. It
13473 will be called with point at the start of the body, and is useful if the
13474 document has encoded some parts of its contents.
13476 @item article-transform-function
13477 If present, this function is called when requesting an article. It's
13478 meant to be used for more wide-ranging transformation of both head and
13479 body of the article.
13481 @item generate-head-function
13482 If present, this function is called to generate a head that Gnus can
13483 understand. It is called with the article number as a parameter, and is
13484 expected to generate a nice head for the article in question. It is
13485 called when requesting the headers of all articles.
13489 Let's look at the most complicated example I can come up with---standard
13494 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
13495 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
13496 (prepare-body-function . nndoc-unquote-dashes)
13497 (body-end-function . nndoc-digest-body-end)
13498 (head-end . "^ ?$")
13499 (body-begin . "^ ?\n")
13500 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
13501 (subtype digest guess))
13504 We see that all text before a 70-width line of dashes is ignored; all
13505 text after a line that starts with that @samp{^End of} is also ignored;
13506 each article begins with a 30-width line of dashes; the line separating
13507 the head from the body may contain a single space; and that the body is
13508 run through @code{nndoc-unquote-dashes} before being delivered.
13510 To hook your own document definition into @code{nndoc}, use the
13511 @code{nndoc-add-type} function. It takes two parameters---the first is
13512 the definition itself and the second (optional) parameter says where in
13513 the document type definition alist to put this definition. The alist is
13514 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
13515 is of @code{mmdf} type, and so on. These type predicates should return
13516 @code{nil} if the document is not of the correct type; @code{t} if it is
13517 of the correct type; and a number if the document might be of the
13518 correct type. A high number means high probability; a low number means
13519 low probability with @samp{0} being the lowest valid number.
13527 In the PC world people often talk about ``offline'' newsreaders. These
13528 are thingies that are combined reader/news transport monstrosities.
13529 With built-in modem programs. Yecchh!
13531 Of course, us Unix Weenie types of human beans use things like
13532 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
13533 transport things like Ghod intended. And then we just use normal
13536 However, it can sometimes be convenient to do something that's a bit
13537 easier on the brain if you have a very slow modem, and you're not really
13538 that interested in doing things properly.
13540 A file format called @sc{soup} has been developed for transporting news
13541 and mail from servers to home machines and back again. It can be a bit
13544 First some terminology:
13549 This is the machine that is connected to the outside world and where you
13550 get news and/or mail from.
13553 This is the machine that you want to do the actual reading and responding
13554 on. It is typically not connected to the rest of the world in any way.
13557 Something that contains messages and/or commands. There are two kinds
13561 @item message packets
13562 These are packets made at the server, and typically contain lots of
13563 messages for you to read. These are called @file{SoupoutX.tgz} by
13564 default, where @var{x} is a number.
13566 @item response packets
13567 These are packets made at the home machine, and typically contains
13568 replies that you've written. These are called @file{SoupinX.tgz} by
13569 default, where @var{x} is a number.
13579 You log in on the server and create a @sc{soup} packet. You can either
13580 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
13581 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
13582 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
13585 You transfer the packet home. Rail, boat, car or modem will do fine.
13588 You put the packet in your home directory.
13591 You fire up Gnus on your home machine using the @code{nnsoup} backend as
13592 the native or secondary server.
13595 You read articles and mail and answer and followup to the things you
13596 want (@pxref{SOUP Replies}).
13599 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
13603 You transfer this packet to the server.
13606 You use Gnus to mail this packet out with the @kbd{G s s} command.
13609 You then repeat until you die.
13613 So you basically have a bipartite system---you use @code{nnsoup} for
13614 reading and Gnus for packing/sending these @sc{soup} packets.
13617 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
13618 * SOUP Groups:: A backend for reading @sc{soup} packets.
13619 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
13623 @node SOUP Commands
13624 @subsubsection SOUP Commands
13626 These are commands for creating and manipulating @sc{soup} packets.
13630 @kindex G s b (Group)
13631 @findex gnus-group-brew-soup
13632 Pack all unread articles in the current group
13633 (@code{gnus-group-brew-soup}). This command understands the
13634 process/prefix convention.
13637 @kindex G s w (Group)
13638 @findex gnus-soup-save-areas
13639 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
13642 @kindex G s s (Group)
13643 @findex gnus-soup-send-replies
13644 Send all replies from the replies packet
13645 (@code{gnus-soup-send-replies}).
13648 @kindex G s p (Group)
13649 @findex gnus-soup-pack-packet
13650 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
13653 @kindex G s r (Group)
13654 @findex nnsoup-pack-replies
13655 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
13658 @kindex O s (Summary)
13659 @findex gnus-soup-add-article
13660 This summary-mode command adds the current article to a @sc{soup} packet
13661 (@code{gnus-soup-add-article}). It understands the process/prefix
13662 convention (@pxref{Process/Prefix}).
13667 There are a few variables to customize where Gnus will put all these
13672 @item gnus-soup-directory
13673 @vindex gnus-soup-directory
13674 Directory where Gnus will save intermediate files while composing
13675 @sc{soup} packets. The default is @file{~/SoupBrew/}.
13677 @item gnus-soup-replies-directory
13678 @vindex gnus-soup-replies-directory
13679 This is what Gnus will use as a temporary directory while sending our
13680 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
13682 @item gnus-soup-prefix-file
13683 @vindex gnus-soup-prefix-file
13684 Name of the file where Gnus stores the last used prefix. The default is
13685 @samp{gnus-prefix}.
13687 @item gnus-soup-packer
13688 @vindex gnus-soup-packer
13689 A format string command for packing a @sc{soup} packet. The default is
13690 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
13692 @item gnus-soup-unpacker
13693 @vindex gnus-soup-unpacker
13694 Format string command for unpacking a @sc{soup} packet. The default is
13695 @samp{gunzip -c %s | tar xvf -}.
13697 @item gnus-soup-packet-directory
13698 @vindex gnus-soup-packet-directory
13699 Where Gnus will look for reply packets. The default is @file{~/}.
13701 @item gnus-soup-packet-regexp
13702 @vindex gnus-soup-packet-regexp
13703 Regular expression matching @sc{soup} reply packets in
13704 @code{gnus-soup-packet-directory}.
13710 @subsubsection @sc{soup} Groups
13713 @code{nnsoup} is the backend for reading @sc{soup} packets. It will
13714 read incoming packets, unpack them, and put them in a directory where
13715 you can read them at leisure.
13717 These are the variables you can use to customize its behavior:
13721 @item nnsoup-tmp-directory
13722 @vindex nnsoup-tmp-directory
13723 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
13724 directory. (@file{/tmp/} by default.)
13726 @item nnsoup-directory
13727 @vindex nnsoup-directory
13728 @code{nnsoup} then moves each message and index file to this directory.
13729 The default is @file{~/SOUP/}.
13731 @item nnsoup-replies-directory
13732 @vindex nnsoup-replies-directory
13733 All replies will be stored in this directory before being packed into a
13734 reply packet. The default is @file{~/SOUP/replies/"}.
13736 @item nnsoup-replies-format-type
13737 @vindex nnsoup-replies-format-type
13738 The @sc{soup} format of the replies packets. The default is @samp{?n}
13739 (rnews), and I don't think you should touch that variable. I probably
13740 shouldn't even have documented it. Drats! Too late!
13742 @item nnsoup-replies-index-type
13743 @vindex nnsoup-replies-index-type
13744 The index type of the replies packet. The default is @samp{?n}, which
13745 means ``none''. Don't fiddle with this one either!
13747 @item nnsoup-active-file
13748 @vindex nnsoup-active-file
13749 Where @code{nnsoup} stores lots of information. This is not an ``active
13750 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
13751 this file or mess it up in any way, you're dead. The default is
13752 @file{~/SOUP/active}.
13754 @item nnsoup-packer
13755 @vindex nnsoup-packer
13756 Format string command for packing a reply @sc{soup} packet. The default
13757 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
13759 @item nnsoup-unpacker
13760 @vindex nnsoup-unpacker
13761 Format string command for unpacking incoming @sc{soup} packets. The
13762 default is @samp{gunzip -c %s | tar xvf -}.
13764 @item nnsoup-packet-directory
13765 @vindex nnsoup-packet-directory
13766 Where @code{nnsoup} will look for incoming packets. The default is
13769 @item nnsoup-packet-regexp
13770 @vindex nnsoup-packet-regexp
13771 Regular expression matching incoming @sc{soup} packets. The default is
13774 @item nnsoup-always-save
13775 @vindex nnsoup-always-save
13776 If non-@code{nil}, save the replies buffer after each posted message.
13782 @subsubsection SOUP Replies
13784 Just using @code{nnsoup} won't mean that your postings and mailings end
13785 up in @sc{soup} reply packets automagically. You have to work a bit
13786 more for that to happen.
13788 @findex nnsoup-set-variables
13789 The @code{nnsoup-set-variables} command will set the appropriate
13790 variables to ensure that all your followups and replies end up in the
13793 In specific, this is what it does:
13796 (setq message-send-news-function 'nnsoup-request-post)
13797 (setq message-send-mail-function 'nnsoup-request-mail)
13800 And that's it, really. If you only want news to go into the @sc{soup}
13801 system you just use the first line. If you only want mail to be
13802 @sc{soup}ed you use the second.
13805 @node Mail-To-News Gateways
13806 @subsection Mail-To-News Gateways
13807 @cindex mail-to-news gateways
13810 If your local @code{nntp} server doesn't allow posting, for some reason
13811 or other, you can post using one of the numerous mail-to-news gateways.
13812 The @code{nngateway} backend provides the interface.
13814 Note that you can't read anything from this backend---it can only be
13820 @item nngateway-address
13821 @vindex nngateway-address
13822 This is the address of the mail-to-news gateway.
13824 @item nngateway-header-transformation
13825 @vindex nngateway-header-transformation
13826 News headers often have to be transformed in some odd way or other
13827 for the mail-to-news gateway to accept it. This variable says what
13828 transformation should be called, and defaults to
13829 @code{nngateway-simple-header-transformation}. The function is called
13830 narrowed to the headers to be transformed and with one parameter---the
13833 This default function just inserts a new @code{To} header based on the
13834 @code{Newsgroups} header and the gateway address.
13835 For instance, an article with this @code{Newsgroups} header:
13838 Newsgroups: alt.religion.emacs
13841 will get this @code{From} header inserted:
13844 To: alt-religion-emacs@@GATEWAY
13847 The following pre-defined functions exist:
13849 @findex nngateway-simple-header-transformation
13852 @item nngateway-simple-header-transformation
13853 Creates a @code{To} header that looks like
13854 @var{newsgroup}@@@code{nngateway-address}.
13856 @findex nngateway-mail2news-header-transformation
13858 @item nngateway-mail2news-header-transformation
13859 Creates a @code{To} header that looks like
13860 @code{nngateway-address}.
13865 (setq gnus-post-method
13866 '(nngateway "mail2news@@replay.com"
13867 (nngateway-header-transformation
13868 nngateway-mail2news-header-transformation)))
13876 So, to use this, simply say something like:
13879 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
13885 @subsection @sc{imap}
13889 @sc{imap} is a network protocol for reading mail (or news, or ...),
13890 think of it as a modernized @sc{nntp}. Connecting to a @sc{imap}
13891 server is much similar to connecting to a news server, you just
13892 specify the network address of the server.
13894 @sc{imap} has two properties. First, @sc{imap} can do everything that
13895 POP can, it can hence be viewed as POP++. Secondly, @sc{imap} is a
13896 mail storage protocol, similar to @sc{nntp} being a news storage
13897 protocol. (@sc{imap} offers more features than @sc{nntp} because news
13898 is more or less read-only whereas mail is read-write.)
13900 If you want to use @sc{imap} as POP++, use an imap entry in
13901 mail-sources. With this, Gnus will fetch mails from the @sc{imap}
13902 server and store them on the local disk. This is not the usage
13903 described in this section. @xref{Mail Sources}.
13905 If you want to use @sc{imap} as a mail storage protocol, use an nnimap
13906 entry in gnus-secondary-select-methods. With this, Gnus will
13907 manipulate mails stored on the @sc{imap} server. This is the kind of
13908 usage explained in this section.
13910 A server configuration in @code{~/.gnus} with a few @sc{imap} servers
13911 might look something like this:
13914 (setq gnus-secondary-select-methods
13915 '((nnimap "simpleserver") ; no special configuration
13916 ; perhaps a ssh port forwarded server:
13918 (nnimap-address "localhost")
13919 (nnimap-server-port 1430))
13920 ; a UW server running on localhost
13922 (nnimap-server-port 143)
13923 (nnimap-address "localhost")
13924 (nnimap-list-pattern ("INBOX" "mail/*")))
13925 ; anonymous public cyrus server:
13926 (nnimap "cyrus.andrew.cmu.edu"
13927 (nnimap-authenticator anonymous)
13928 (nnimap-list-pattern "archive.*")
13929 (nnimap-stream network))
13930 ; a ssl server on a non-standard port:
13932 (nnimap-address "vic20.somewhere.com")
13933 (nnimap-server-port 9930)
13934 (nnimap-stream ssl))))
13937 The following variables can be used to create a virtual @code{nnimap}
13942 @item nnimap-address
13943 @vindex nnimap-address
13945 The address of the remote @sc{imap} server. Defaults to the virtual
13946 server name if not specified.
13948 @item nnimap-server-port
13949 @vindex nnimap-server-port
13950 Port on server to contact. Defaults to port 143, or 993 for SSL.
13952 Note that this should be a integer, example server specification:
13955 (nnimap "mail.server.com"
13956 (nnimap-server-port 4711))
13959 @item nnimap-list-pattern
13960 @vindex nnimap-list-pattern
13961 String or list of strings of mailboxes to limit available groups to.
13962 This is used when the server has very many mailboxes and you're only
13963 interested in a few -- some servers export your home directory via
13964 @sc{imap}, you'll probably want to limit the mailboxes to those in
13965 @file{~/Mail/*} then.
13967 The string can also be a cons of REFERENCE and the string as above, what
13968 REFERENCE is used for is server specific, but on the University of
13969 Washington server it's a directory that will be concatenated with the
13972 Example server specification:
13975 (nnimap "mail.server.com"
13976 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
13977 ("~friend/Mail/" . "list/*"))))
13980 @item nnimap-stream
13981 @vindex nnimap-stream
13982 The type of stream used to connect to your server. By default, nnimap
13983 will detect and automatically use all of the below, with the exception
13984 of SSL. (SSL is being replaced by STARTTLS, which can be automatically
13985 detected, but it's not widely deployed yet).
13987 Example server specification:
13990 (nnimap "mail.server.com"
13991 (nnimap-stream ssl))
13994 Please note that the value of @code{nnimap-stream} is a symbol!
13998 @dfn{gssapi:} Connect with GSSAPI (usually kerberos 5). Require the
13999 @samp{imtest} program.
14001 @dfn{kerberos4:} Connect with kerberos 4. Require the @samp{imtest} program.
14003 @dfn{starttls:} Connect via the STARTTLS extension (similar to
14004 SSL). Require the external library @samp{starttls.el} and program
14007 @dfn{ssl:} Connect through SSL. Require OpenSSL (the
14008 program @samp{openssl}) or SSLeay (@samp{s_client}).
14010 @dfn{shell:} Use a shell command to start @sc{imap} connection.
14012 @dfn{network:} Plain, TCP/IP network connection.
14015 @vindex imap-kerberos4-program
14016 The @samp{imtest} program is shipped with Cyrus IMAPD, nnimap support
14017 both @samp{imtest} version 1.5.x and version 1.6.x. The variable
14018 @code{imap-kerberos4-program} contain parameters to pass to the imtest
14021 @vindex imap-ssl-program
14022 For SSL connections, the OpenSSL program is available from
14023 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
14024 and nnimap support it too - altough the most recent versions of
14025 SSLeay, 0.9.x, are known to have serious bugs making it
14026 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
14027 work. The variable @code{imap-ssl-program} contain parameters to pass
14030 @vindex imap-shell-program
14031 @vindex imap-shell-host
14032 For @sc{imap} connections using the @code{shell} stream, the variable
14033 @code{imap-shell-program} specify what program to call.
14035 @item nnimap-authenticator
14036 @vindex nnimap-authenticator
14038 The authenticator used to connect to the server. By default, nnimap
14039 will use the most secure authenticator your server is capable of.
14041 Example server specification:
14044 (nnimap "mail.server.com"
14045 (nnimap-authenticator anonymous))
14048 Please note that the value of @code{nnimap-authenticator} is a symbol!
14052 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Require
14053 external program @code{imtest}.
14055 @dfn{kerberos4:} Kerberos authentication. Require external program
14058 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Require
14059 external library @code{digest-md5.el}.
14061 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
14063 @dfn{login:} Plain-text username/password via LOGIN.
14065 @dfn{anonymous:} Login as `anonymous', supplying your emailadress as password.
14068 @item nnimap-expunge-on-close
14070 @vindex nnimap-expunge-on-close
14071 Unlike Parmenides the @sc{imap} designers has decided that things that
14072 doesn't exist actually does exist. More specifically, @sc{imap} has
14073 this concept of marking articles @code{Deleted} which doesn't actually
14074 delete them, and this (marking them @code{Deleted}, that is) is what
14075 nnimap does when you delete a article in Gnus (with @kbd{G DEL} or
14078 Since the articles aren't really removed when we mark them with the
14079 @code{Deleted} flag we'll need a way to actually delete them. Feel like
14080 running in circles yet?
14082 Traditionally, nnimap has removed all articles marked as @code{Deleted}
14083 when closing a mailbox but this is now configurable by this server
14086 The possible options are:
14091 The default behavior, delete all articles marked as "Deleted" when
14094 Never actually delete articles. Currently there is no way of showing
14095 the articles marked for deletion in nnimap, but other @sc{imap} clients
14096 may allow you to do this. If you ever want to run the EXPUNGE command
14097 manually, @xref{Expunging mailboxes}.
14099 When closing mailboxes, nnimap will ask if you wish to expunge deleted
14104 @item nnimap-authinfo-file
14105 @vindex nnimap-authinfo-file
14107 A file containing credentials used to log in on servers. The format
14108 is (almost) the same as the @code{ftp} @file{~/.netrc} file. See
14109 `nntp-authinfo-file' for exact syntax.
14111 A file containing credentials used to log in on servers. The format is
14112 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
14113 variable @code{nntp-authinfo-file} for exact syntax; also see
14119 * Splitting in IMAP:: Splitting mail with nnimap.
14120 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
14121 * Expunging mailboxes:: Equivalent of a "compress mailbox" button.
14126 @node Splitting in IMAP
14127 @subsubsection Splitting in @sc{imap}
14128 @cindex splitting imap mail
14130 Splitting is something Gnus users has loved and used for years, and now
14131 the rest of the world is catching up. Yeah, dream on, not many
14132 @sc{imap} server has server side splitting and those that have splitting
14133 seem to use some non-standard protocol. This means that @sc{imap}
14134 support for Gnus has to do it's own splitting.
14138 Here are the variables of interest:
14142 @item nnimap-split-crosspost
14143 @cindex splitting, crosspost
14145 @vindex nnimap-split-crosspost
14147 If non-nil, do crossposting if several split methods match the mail. If
14148 nil, the first match in @code{nnimap-split-rule} found will be used.
14150 Nnmail equivalent: @code{nnmail-crosspost}.
14152 @item nnimap-split-inbox
14153 @cindex splitting, inbox
14155 @vindex nnimap-split-inbox
14157 A string or a list of strings that gives the name(s) of @sc{imap}
14158 mailboxes to split from. Defaults to nil, which means that splitting is
14162 (setq nnimap-split-inbox
14163 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
14166 No nnmail equivalent.
14168 @item nnimap-split-rule
14169 @cindex Splitting, rules
14170 @vindex nnimap-split-rule
14172 New mail found in @code{nnimap-split-inbox} will be split according to
14175 This variable contains a list of lists, where the first element in the
14176 sublist gives the name of the @sc{imap} mailbox to move articles
14177 matching the regexp in the second element in the sublist. Got that?
14178 Neither did I, we need examples.
14181 (setq nnimap-split-rule
14182 '(("INBOX.nnimap" "^Sender: owner-nnimap@@vic20.globalcom.se")
14183 ("INBOX.junk" "^Subject:.*MAKE MONEY")
14184 ("INBOX.private" "")))
14187 This will put all articles from the nnimap mailing list into mailbox
14188 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
14189 into INBOX.junk and everything else in INBOX.private.
14191 The first string may contain `\\1' forms, like the ones used by
14192 replace-match to insert sub-expressions from the matched text. For
14196 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
14199 The second element can also be a function. In that case, it will be
14200 called with the first element of the rule as the argument, in a buffer
14201 containing the headers of the article. It should return a non-nil value
14202 if it thinks that the mail belongs in that group.
14204 Nnmail users might recollect that the last regexp had to be empty to
14205 match all articles (like in the example above). This is not required in
14206 nnimap. Articles not matching any of the regexps will not be moved out
14207 of your inbox. (This might affect performance if you keep lots of
14208 unread articles in your inbox, since the splitting code would go over
14209 them every time you fetch new mail.)
14211 These rules are processed from the beginning of the alist toward the
14212 end. The first rule to make a match will "win", unless you have
14213 crossposting enabled. In that case, all matching rules will "win".
14215 This variable can also have a function as its value, the function will
14216 be called with the headers narrowed and should return a group where it
14217 thinks the article should be split to. See @code{nnimap-split-fancy}.
14219 The splitting code tries to create mailboxes if it need too.
14221 To allow for different split rules on different virtual servers, and
14222 even different split rules in different inboxes on the same server,
14223 the syntax of this variable have been extended along the lines of:
14226 (setq nnimap-split-rule
14227 '(("my1server" (".*" (("ding" "ding@@gnus.org")
14228 ("junk" "From:.*Simon")))
14229 ("my2server" ("INBOX" nnimap-split-fancy))
14230 ("my[34]server" (".*" (("private" "To:.*Simon")
14231 ("junk" my-junk-func)))))
14234 The virtual server name is in fact a regexp, so that the same rules
14235 may apply to several servers. In the example, the servers
14236 @code{my3server} and @code{my4server} both use the same rules.
14237 Similarly, the inbox string is also a regexp. The actual splitting
14238 rules are as before, either a function, or a list with group/regexp or
14239 group/function elements.
14241 Nnmail equivalent: @code{nnmail-split-methods}.
14243 @item nnimap-split-predicate
14245 @vindex nnimap-split-predicate
14247 Mail matching this predicate in @code{nnimap-split-inbox} will be
14248 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
14250 This might be useful if you use another @sc{imap} client to read mail in
14251 your inbox but would like Gnus to split all articles in the inbox
14252 regardless of readedness. Then you might change this to
14255 @item nnimap-split-fancy
14256 @cindex splitting, fancy
14257 @findex nnimap-split-fancy
14258 @vindex nnimap-split-fancy
14260 It's possible to set @code{nnimap-split-rule} to
14261 @code{nnmail-split-fancy} if you want to use fancy
14262 splitting. @xref{Fancy Mail Splitting}.
14264 However, to be able to have different fancy split rules for nnmail and
14265 nnimap backends you can set @code{nnimap-split-rule} to
14266 @code{nnimap-split-fancy} and define the nnimap specific fancy split
14267 rule in @code{nnimap-split-fancy}.
14272 (setq nnimap-split-rule 'nnimap-split-fancy
14273 nnimap-split-fancy ...)
14276 Nnmail equivalent: @code{nnmail-split-fancy}.
14280 @node Editing IMAP ACLs
14281 @subsubsection Editing @sc{imap} ACLs
14282 @cindex editing imap acls
14283 @cindex Access Control Lists
14284 @cindex Editing @sc{imap} ACLs
14286 @findex gnus-group-nnimap-edit-acl
14288 ACL stands for Access Control List. ACLs are used in @sc{imap} for
14289 limiting (or enabling) other users access to your mail boxes. Not all
14290 @sc{imap} servers support this, this function will give an error if it
14293 To edit a ACL for a mailbox, type @kbd{G l}
14294 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with a ACL
14295 editing window with detailed instructions.
14297 Some possible uses:
14301 Giving "anyone" the "lrs" rights (lookup, read, keep seen/unseen flags)
14302 on your mailing list mailboxes enables other users on the same server to
14303 follow the list without subscribing to it.
14305 At least with the Cyrus server, you are required to give the user
14306 "anyone" posting ("p") capabilities to have "plussing" work (that is,
14307 mail sent to user+mailbox@@domain ending up in the @sc{imap} mailbox
14311 @node Expunging mailboxes
14312 @subsubsection Expunging mailboxes
14316 @cindex Manual expunging
14318 @findex gnus-group-nnimap-expunge
14320 If you're using the @code{never} setting of @code{nnimap-expunge-close},
14321 you may want the option of expunging all deleted articles in a mailbox
14322 manually. This is exactly what @kbd{G x} does.
14324 Currently there is no way of showing deleted articles, you can just
14329 @node Combined Groups
14330 @section Combined Groups
14332 Gnus allows combining a mixture of all the other group types into bigger
14336 * Virtual Groups:: Combining articles from many groups.
14337 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
14341 @node Virtual Groups
14342 @subsection Virtual Groups
14344 @cindex virtual groups
14345 @cindex merging groups
14347 An @dfn{nnvirtual group} is really nothing more than a collection of
14350 For instance, if you are tired of reading many small groups, you can
14351 put them all in one big group, and then grow tired of reading one
14352 big, unwieldy group. The joys of computing!
14354 You specify @code{nnvirtual} as the method. The address should be a
14355 regexp to match component groups.
14357 All marks in the virtual group will stick to the articles in the
14358 component groups. So if you tick an article in a virtual group, the
14359 article will also be ticked in the component group from whence it came.
14360 (And vice versa---marks from the component groups will also be shown in
14361 the virtual group.)
14363 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
14364 newsgroups into one, big, happy newsgroup:
14367 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
14370 The component groups can be native or foreign; everything should work
14371 smoothly, but if your computer explodes, it was probably my fault.
14373 Collecting the same group from several servers might actually be a good
14374 idea if users have set the Distribution header to limit distribution.
14375 If you would like to read @samp{soc.motss} both from a server in Japan
14376 and a server in Norway, you could use the following as the group regexp:
14379 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
14382 (Remember, though, that if you're creating the group with @kbd{G m}, you
14383 shouldn't double the backslashes, and you should leave off the quote
14384 characters at the beginning and the end of the string.)
14386 This should work kinda smoothly---all articles from both groups should
14387 end up in this one, and there should be no duplicates. Threading (and
14388 the rest) will still work as usual, but there might be problems with the
14389 sequence of articles. Sorting on date might be an option here
14390 (@pxref{Selecting a Group}).
14392 One limitation, however---all groups included in a virtual
14393 group have to be alive (i.e., subscribed or unsubscribed). Killed or
14394 zombie groups can't be component groups for @code{nnvirtual} groups.
14396 @vindex nnvirtual-always-rescan
14397 If the @code{nnvirtual-always-rescan} is non-@code{nil},
14398 @code{nnvirtual} will always scan groups for unread articles when
14399 entering a virtual group. If this variable is @code{nil} (which is the
14400 default) and you read articles in a component group after the virtual
14401 group has been activated, the read articles from the component group
14402 will show up when you enter the virtual group. You'll also see this
14403 effect if you have two virtual groups that have a component group in
14404 common. If that's the case, you should set this variable to @code{t}.
14405 Or you can just tap @code{M-g} on the virtual group every time before
14406 you enter it---it'll have much the same effect.
14408 @code{nnvirtual} can have both mail and news groups as component groups.
14409 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
14410 has to ask the backend of the component group the article comes from
14411 whether it is a news or mail backend. However, when you do a @kbd{^},
14412 there is typically no sure way for the component backend to know this,
14413 and in that case @code{nnvirtual} tells Gnus that the article came from a
14414 not-news backend. (Just to be on the safe side.)
14416 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
14417 line from the article you respond to in these cases.
14421 @node Kibozed Groups
14422 @subsection Kibozed Groups
14426 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
14427 the news feed''. @code{nnkiboze} is a backend that will do this for
14428 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
14429 with useless requests! Oh happiness!
14431 @kindex G k (Group)
14432 To create a kibozed group, use the @kbd{G k} command in the group
14435 The address field of the @code{nnkiboze} method is, as with
14436 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
14437 @code{nnkiboze} group. That's where most similarities between @code{nnkiboze}
14438 and @code{nnvirtual} end.
14440 In addition to this regexp detailing component groups, an @code{nnkiboze} group
14441 must have a score file to say what articles are to be included in
14442 the group (@pxref{Scoring}).
14444 @kindex M-x nnkiboze-generate-groups
14445 @findex nnkiboze-generate-groups
14446 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
14447 @code{nnkiboze} groups you want to have. This command will take time. Lots of
14448 time. Oodles and oodles of time. Gnus has to fetch the headers from
14449 all the articles in all the component groups and run them through the
14450 scoring process to determine if there are any articles in the groups
14451 that are to be part of the @code{nnkiboze} groups.
14453 Please limit the number of component groups by using restrictive
14454 regexps. Otherwise your sysadmin may become annoyed with you, and the
14455 @sc{nntp} site may throw you off and never let you back in again.
14456 Stranger things have happened.
14458 @code{nnkiboze} component groups do not have to be alive---they can be dead,
14459 and they can be foreign. No restrictions.
14461 @vindex nnkiboze-directory
14462 The generation of an @code{nnkiboze} group means writing two files in
14463 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
14464 contains the @sc{nov} header lines for all the articles in the group,
14465 and the other is an additional @file{.newsrc} file to store information
14466 on what groups have been searched through to find component articles.
14468 Articles marked as read in the @code{nnkiboze} group will have
14469 their @sc{nov} lines removed from the @sc{nov} file.
14472 @node Gnus Unplugged
14473 @section Gnus Unplugged
14478 @cindex Gnus Unplugged
14480 In olden times (ca. February '88), people used to run their newsreaders
14481 on big machines with permanent connections to the net. News transport
14482 was dealt with by news servers, and all the newsreaders had to do was to
14483 read news. Believe it or not.
14485 Nowadays most people read news and mail at home, and use some sort of
14486 modem to connect to the net. To avoid running up huge phone bills, it
14487 would be nice to have a way to slurp down all the news and mail, hang up
14488 the phone, read for several hours, and then upload any responses you
14489 have to make. And then you repeat the procedure.
14491 Of course, you can use news servers for doing this as well. I've used
14492 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
14493 for some years, but doing that's a bore. Moving the news server
14494 functionality up to the newsreader makes sense if you're the only person
14495 reading news on a machine.
14497 Using Gnus as an ``offline'' newsreader is quite simple.
14501 First, set up Gnus as you would do if you were running it on a machine
14502 that has full connection to the net. Go ahead. I'll still be waiting
14506 Then, put the following magical incantation at the end of your
14507 @file{.gnus.el} file:
14514 That's it. Gnus is now an ``offline'' newsreader.
14516 Of course, to use it as such, you have to learn a few new commands.
14519 * Agent Basics:: How it all is supposed to work.
14520 * Agent Categories:: How to tell the Gnus Agent what to download.
14521 * Agent Commands:: New commands for all the buffers.
14522 * Agent Expiry:: How to make old articles go away.
14523 * Agent and IMAP:: How to use the Agent with IMAP.
14524 * Outgoing Messages:: What happens when you post/mail something?
14525 * Agent Variables:: Customizing is fun.
14526 * Example Setup:: An example @file{.gnus.el} file for offline people.
14527 * Batching Agents:: How to fetch news from a @code{cron} job.
14528 * Agent Caveats:: What you think it'll do and what it does.
14533 @subsection Agent Basics
14535 First, let's get some terminology out of the way.
14537 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
14538 connection to the net (and notified the Agent that this is the case).
14539 When the connection to the net is up again (and Gnus knows this), the
14540 Agent is @dfn{plugged}.
14542 The @dfn{local} machine is the one you're running on, and which isn't
14543 connected to the net continuously.
14545 @dfn{Downloading} means fetching things from the net to your local
14546 machine. @dfn{Uploading} is doing the opposite.
14548 Let's take a typical Gnus session using the Agent.
14553 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
14554 Agent in a disconnected state. You can read all the news that you have
14555 already fetched while in this mode.
14558 You then decide to see whether any new news has arrived. You connect
14559 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
14560 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
14561 as usual. To check for new mail in unplugged mode, see (@pxref{Mail
14562 Source Specifiers}).
14565 You can then read the new news immediately, or you can download the news
14566 onto your local machine. If you want to do the latter, you press @kbd{g}
14567 to check if there are any new news and then @kbd{J
14568 s} to fetch all the eligible articles in all the groups. (To let Gnus
14569 know which articles you want to download, @pxref{Agent Categories}.)
14572 After fetching the articles, you press @kbd{J j} to make Gnus become
14573 unplugged again, and you shut down the PPP thing (or whatever). And
14574 then you read the news offline.
14577 And then you go to step 2.
14580 Here are some things you should do the first time (or so) that you use
14586 Decide which servers should be covered by the Agent. If you have a mail
14587 backend, it would probably be nonsensical to have it covered by the
14588 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
14589 @kbd{J a} the server (or servers) that you wish to have covered by the
14590 Agent (@pxref{Server Agent Commands}). This will typically be only the
14591 primary select method, which is listed on the bottom in the buffer.
14594 Decide on download policy. @xref{Agent Categories}.
14601 @node Agent Categories
14602 @subsection Agent Categories
14604 One of the main reasons to integrate the news transport layer into the
14605 newsreader is to allow greater control over what articles to download.
14606 There's not much point in downloading huge amounts of articles, just to
14607 find out that you're not interested in reading any of them. It's better
14608 to be somewhat more conservative in choosing what to download, and then
14609 mark the articles for downloading manually if it should turn out that
14610 you're interested in the articles anyway.
14612 The main way to control what is to be downloaded is to create a
14613 @dfn{category} and then assign some (or all) groups to this category.
14614 Groups that do not belong in any other category belong to the
14615 @code{default} category. Gnus has its own buffer for creating and
14616 managing categories.
14619 * Category Syntax:: What a category looks like.
14620 * Category Buffer:: A buffer for maintaining categories.
14621 * Category Variables:: Customize'r'Us.
14625 @node Category Syntax
14626 @subsubsection Category Syntax
14628 A category consists of two things.
14632 A predicate which (generally) gives a rough outline of which articles
14633 are eligible for downloading; and
14636 a score rule which (generally) gives you a finer granularity when
14637 deciding what articles to download. (Note that this @dfn{download
14638 score} is not necessarily related to normal scores.)
14641 A predicate in its simplest form can be a single predicate such as
14642 @code{true} or @code{false}. These two will download every available
14643 article or nothing respectively. In the case of these two special
14644 predicates an additional score rule is superfluous.
14646 Predicates of @code{high} or @code{low} download articles in respect of
14647 their scores in relationship to @code{gnus-agent-high-score} and
14648 @code{gnus-agent-low-score} as described below.
14650 To gain even finer control of what is to be regarded eligible for
14651 download a predicate can consist of a number of predicates with logical
14652 operators sprinkled in between.
14654 Perhaps some examples are in order.
14656 Here's a simple predicate. (It's the default predicate, in fact, used
14657 for all groups that don't belong to any other category.)
14663 Quite simple, eh? This predicate is true if and only if the article is
14664 short (for some value of ``short'').
14666 Here's a more complex predicate:
14675 This means that an article should be downloaded if it has a high score,
14676 or if the score is not low and the article is not long. You get the
14679 The available logical operators are @code{or}, @code{and} and
14680 @code{not}. (If you prefer, you can use the more ``C''-ish operators
14681 @samp{|}, @code{&} and @code{!} instead.)
14683 The following predicates are pre-defined, but if none of these fit what
14684 you want to do, you can write your own.
14688 True iff the article is shorter than @code{gnus-agent-short-article}
14689 lines; default 100.
14692 True iff the article is longer than @code{gnus-agent-long-article}
14693 lines; default 200.
14696 True iff the article has a download score less than
14697 @code{gnus-agent-low-score}; default 0.
14700 True iff the article has a download score greater than
14701 @code{gnus-agent-high-score}; default 0.
14704 True iff the Gnus Agent guesses that the article is spam. The
14705 heuristics may change over time, but at present it just computes a
14706 checksum and sees whether articles match.
14715 If you want to create your own predicate function, here's what you have
14716 to know: The functions are called with no parameters, but the
14717 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
14720 For example, you could decide that you don't want to download articles
14721 that were posted more than a certain number of days ago (e.g. posted
14722 more than @code{gnus-agent-expire-days} ago) you might write a function
14723 something along the lines of the following:
14726 (defun my-article-old-p ()
14727 "Say whether an article is old."
14728 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
14729 (- (time-to-days (current-time)) gnus-agent-expire-days)))
14732 with the predicate then defined as:
14735 (not my-article-old-p)
14738 or you could append your predicate to the predefined
14739 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
14740 wherever. (Note: this would have to be at a point *after*
14741 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
14744 (setq gnus-category-predicate-alist
14745 (append gnus-category-predicate-alist
14746 '((old . my-article-old-p))))
14749 and simply specify your predicate as:
14755 If/when using something like the above, be aware that there are many
14756 misconfigured systems/mailers out there and so an article's date is not
14757 always a reliable indication of when it was posted. Hell, some people
14758 just don't give a damn.
14760 The above predicates apply to *all* the groups which belong to the
14761 category. However, if you wish to have a specific predicate for an
14762 individual group within a category, or you're just too lazy to set up a
14763 new category, you can enter a group's individual predicate in it's group
14764 parameters like so:
14767 (agent-predicate . short)
14770 This is the group parameter equivalent of the agent category default.
14771 Note that when specifying a single word predicate like this, the
14772 @code{agent-predicate} specification must be in dotted pair notation.
14774 The equivalent of the longer example from above would be:
14777 (agent-predicate or high (and (not low) (not long)))
14780 The outer parenthesis required in the category specification are not
14781 entered here as, not being in dotted pair notation, the value of the
14782 predicate is assumed to be a list.
14785 Now, the syntax of the download score is the same as the syntax of
14786 normal score files, except that all elements that require actually
14787 seeing the article itself are verboten. This means that only the
14788 following headers can be scored on: @code{Subject}, @code{From},
14789 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
14790 @code{Lines}, and @code{Xref}.
14792 As with predicates, the specification of the @code{download score rule}
14793 to use in respect of a group can be in either the category definition if
14794 it's to be applicable to all groups in therein, or a group's parameters
14795 if it's to be specific to that group.
14797 In both of these places the @code{download score rule} can take one of
14804 This has the same syntax as a normal gnus score file except only a
14805 subset of scoring keywords are available as mentioned above.
14811 Category specification
14815 ("Lars Ingebrigtsen" 1000000 nil s))
14821 Group Parameter specification
14824 (agent-score ("from"
14825 ("Lars Ingebrigtsen" 1000000 nil s))
14830 Again, note the omission of the outermost parenthesis here.
14836 These score files must *only* contain the permitted scoring keywords
14843 Category specification
14846 ("~/News/agent.SCORE")
14852 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
14856 Group Parameter specification
14859 (agent-score "~/News/agent.SCORE")
14862 Additional score files can be specified as above. Need I say anything
14867 Use @code{normal} score files
14869 If you don't want to maintain two sets of scoring rules for a group, and
14870 your desired @code{downloading} criteria for a group are the same as your
14871 @code{reading} criteria then you can tell the agent to refer to your
14872 @code{normal} score files when deciding what to download.
14874 These directives in either the category definition or a group's
14875 parameters will cause the agent to read in all the applicable score
14876 files for a group, *filtering out* those sections that do not
14877 relate to one of the permitted subset of scoring keywords.
14881 Category Specification
14888 Group Parameter specification
14891 (agent-score . file)
14896 @node Category Buffer
14897 @subsubsection Category Buffer
14899 You'd normally do all category maintenance from the category buffer.
14900 When you enter it for the first time (with the @kbd{J c} command from
14901 the group buffer), you'll only see the @code{default} category.
14903 The following commands are available in this buffer:
14907 @kindex q (Category)
14908 @findex gnus-category-exit
14909 Return to the group buffer (@code{gnus-category-exit}).
14912 @kindex k (Category)
14913 @findex gnus-category-kill
14914 Kill the current category (@code{gnus-category-kill}).
14917 @kindex c (Category)
14918 @findex gnus-category-copy
14919 Copy the current category (@code{gnus-category-copy}).
14922 @kindex a (Category)
14923 @findex gnus-category-add
14924 Add a new category (@code{gnus-category-add}).
14927 @kindex p (Category)
14928 @findex gnus-category-edit-predicate
14929 Edit the predicate of the current category
14930 (@code{gnus-category-edit-predicate}).
14933 @kindex g (Category)
14934 @findex gnus-category-edit-groups
14935 Edit the list of groups belonging to the current category
14936 (@code{gnus-category-edit-groups}).
14939 @kindex s (Category)
14940 @findex gnus-category-edit-score
14941 Edit the download score rule of the current category
14942 (@code{gnus-category-edit-score}).
14945 @kindex l (Category)
14946 @findex gnus-category-list
14947 List all the categories (@code{gnus-category-list}).
14951 @node Category Variables
14952 @subsubsection Category Variables
14955 @item gnus-category-mode-hook
14956 @vindex gnus-category-mode-hook
14957 Hook run in category buffers.
14959 @item gnus-category-line-format
14960 @vindex gnus-category-line-format
14961 Format of the lines in the category buffer (@pxref{Formatting
14962 Variables}). Valid elements are:
14966 The name of the category.
14969 The number of groups in the category.
14972 @item gnus-category-mode-line-format
14973 @vindex gnus-category-mode-line-format
14974 Format of the category mode line (@pxref{Mode Line Formatting}).
14976 @item gnus-agent-short-article
14977 @vindex gnus-agent-short-article
14978 Articles that have fewer lines than this are short. Default 100.
14980 @item gnus-agent-long-article
14981 @vindex gnus-agent-long-article
14982 Articles that have more lines than this are long. Default 200.
14984 @item gnus-agent-low-score
14985 @vindex gnus-agent-low-score
14986 Articles that have a score lower than this have a low score. Default
14989 @item gnus-agent-high-score
14990 @vindex gnus-agent-high-score
14991 Articles that have a score higher than this have a high score. Default
14997 @node Agent Commands
14998 @subsection Agent Commands
15000 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
15001 (@code{gnus-agent-toggle-plugged} command works in all modes, and
15002 toggles the plugged/unplugged state of the Gnus Agent.
15006 * Group Agent Commands::
15007 * Summary Agent Commands::
15008 * Server Agent Commands::
15011 You can run a complete batch fetch from the command line with the
15012 following incantation:
15014 @cindex gnus-agent-batch-fetch
15016 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
15021 @node Group Agent Commands
15022 @subsubsection Group Agent Commands
15026 @kindex J u (Agent Group)
15027 @findex gnus-agent-fetch-groups
15028 Fetch all eligible articles in the current group
15029 (@code{gnus-agent-fetch-groups}).
15032 @kindex J c (Agent Group)
15033 @findex gnus-enter-category-buffer
15034 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
15037 @kindex J s (Agent Group)
15038 @findex gnus-agent-fetch-session
15039 Fetch all eligible articles in all groups
15040 (@code{gnus-agent-fetch-session}).
15043 @kindex J S (Agent Group)
15044 @findex gnus-group-send-drafts
15045 Send all sendable messages in the draft group
15046 (@code{gnus-group-send-drafts}). @xref{Drafts}.
15049 @kindex J a (Agent Group)
15050 @findex gnus-agent-add-group
15051 Add the current group to an Agent category
15052 (@code{gnus-agent-add-group}). This command understands the
15053 process/prefix convention (@pxref{Process/Prefix}).
15056 @kindex J r (Agent Group)
15057 @findex gnus-agent-remove-group
15058 Remove the current group from its category, if any
15059 (@code{gnus-agent-remove-group}). This command understands the
15060 process/prefix convention (@pxref{Process/Prefix}).
15063 @kindex J Y (Agent Group)
15064 @findex gnus-agent-synchronize-flags
15065 Synchronize flags changed while unplugged with remote server, if any.
15071 @node Summary Agent Commands
15072 @subsubsection Summary Agent Commands
15076 @kindex J # (Agent Summary)
15077 @findex gnus-agent-mark-article
15078 Mark the article for downloading (@code{gnus-agent-mark-article}).
15081 @kindex J M-# (Agent Summary)
15082 @findex gnus-agent-unmark-article
15083 Remove the downloading mark from the article
15084 (@code{gnus-agent-unmark-article}).
15087 @kindex @@ (Agent Summary)
15088 @findex gnus-agent-toggle-mark
15089 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
15092 @kindex J c (Agent Summary)
15093 @findex gnus-agent-catchup
15094 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
15099 @node Server Agent Commands
15100 @subsubsection Server Agent Commands
15104 @kindex J a (Agent Server)
15105 @findex gnus-agent-add-server
15106 Add the current server to the list of servers covered by the Gnus Agent
15107 (@code{gnus-agent-add-server}).
15110 @kindex J r (Agent Server)
15111 @findex gnus-agent-remove-server
15112 Remove the current server from the list of servers covered by the Gnus
15113 Agent (@code{gnus-agent-remove-server}).
15119 @subsection Agent Expiry
15121 @vindex gnus-agent-expire-days
15122 @findex gnus-agent-expire
15123 @kindex M-x gnus-agent-expire
15124 @cindex Agent expiry
15125 @cindex Gnus Agent expiry
15128 @code{nnagent} doesn't handle expiry. Instead, there's a special
15129 @code{gnus-agent-expire} command that will expire all read articles that
15130 are older than @code{gnus-agent-expire-days} days. It can be run
15131 whenever you feel that you're running out of space. It's not
15132 particularly fast or efficient, and it's not a particularly good idea to
15133 interrupt it (with @kbd{C-g} or anything else) once you've started it.
15135 @vindex gnus-agent-expire-all
15136 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
15137 expire all articles---unread, read, ticked and dormant. If @code{nil}
15138 (which is the default), only read articles are eligible for expiry, and
15139 unread, ticked and dormant articles will be kept indefinitely.
15142 @node Agent and IMAP
15143 @subsection Agent and IMAP
15145 The Agent work with any Gnus backend, including nnimap. However,
15146 since there are some conceptual differences between @sc{nntp} and
15147 @sc{imap}, this section (should) provide you with some information to
15148 make Gnus Agent work smoother as a @sc{imap} Disconnected Mode client.
15150 The first thing to keep in mind is that all flags (read, ticked, etc)
15151 are kept on the @sc{imap} server, rather than in @code{.newsrc} as is the
15152 case for nntp. Thus Gnus need to remember flag changes when
15153 disconnected, and synchronize these flags when you plug back in.
15155 Gnus keep track of flag changes when reading nnimap groups under the
15156 Agent by default. When you plug back in, by default Gnus will check if
15157 you have any changed any flags and ask if you wish to synchronize these
15158 with the server. This behavior is customizable with
15159 @code{gnus-agent-synchronize-flags}.
15161 @vindex gnus-agent-synchronize-flags
15162 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
15163 never automatically synchronize flags. If it is @code{ask}, the
15164 default, the Agent will check if you made any changes and if so ask if
15165 you wish to synchronize these when you re-connect. If it has any other
15166 value, all flags will be synchronized automatically.
15168 If you do not wish to automatically synchronize flags when you
15169 re-connect, this can be done manually with the
15170 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
15171 in the group buffer by default.
15173 Some things are currently not implemented in the Agent that you'd might
15174 expect from a disconnected @sc{imap} client, including:
15179 Copying/moving articles into nnimap groups when unplugged.
15182 Creating/deleting nnimap groups when unplugged.
15186 Technical note: the synchronization algorithm does not work by "pushing"
15187 all local flags to the server, but rather incrementally update the
15188 server view of flags by changing only those flags that were changed by
15189 the user. Thus, if you set one flag on a article, quit the group and
15190 re-select the group and remove the flag; the flag will be set and
15191 removed from the server when you "synchronize". The queued flag
15192 operations can be found in the per-server @code{flags} file in the Agent
15193 directory. It's emptied when you synchronize flags.
15196 @node Outgoing Messages
15197 @subsection Outgoing Messages
15199 When Gnus is unplugged, all outgoing messages (both mail and news) are
15200 stored in the draft groups (@pxref{Drafts}). You can view them there
15201 after posting, and edit them at will.
15203 When Gnus is plugged again, you can send the messages either from the
15204 draft group with the special commands available there, or you can use
15205 the @kbd{J S} command in the group buffer to send all the sendable
15206 messages in the draft group.
15210 @node Agent Variables
15211 @subsection Agent Variables
15214 @item gnus-agent-directory
15215 @vindex gnus-agent-directory
15216 Where the Gnus Agent will store its files. The default is
15217 @file{~/News/agent/}.
15219 @item gnus-agent-handle-level
15220 @vindex gnus-agent-handle-level
15221 Groups on levels (@pxref{Group Levels}) higher than this variable will
15222 be ignored by the Agent. The default is @code{gnus-level-subscribed},
15223 which means that only subscribed group will be considered by the Agent
15226 @item gnus-agent-plugged-hook
15227 @vindex gnus-agent-plugged-hook
15228 Hook run when connecting to the network.
15230 @item gnus-agent-unplugged-hook
15231 @vindex gnus-agent-unplugged-hook
15232 Hook run when disconnecting from the network.
15237 @node Example Setup
15238 @subsection Example Setup
15240 If you don't want to read this manual, and you have a fairly standard
15241 setup, you may be able to use something like the following as your
15242 @file{.gnus.el} file to get started.
15245 ;;; Define how Gnus is to fetch news. We do this over @sc{nntp}
15246 ;;; from your ISP's server.
15247 (setq gnus-select-method '(nntp "news.your-isp.com"))
15249 ;;; Define how Gnus is to read your mail. We read mail from
15250 ;;; your ISP's POP server.
15251 (setq mail-sources '((pop :server "pop.your-isp.com")))
15253 ;;; Say how Gnus is to store the mail. We use nnml groups.
15254 (setq gnus-secondary-select-methods '((nnml "")))
15256 ;;; Make Gnus into an offline newsreader.
15260 That should be it, basically. Put that in your @file{~/.gnus.el} file,
15261 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
15264 If this is the first time you've run Gnus, you will be subscribed
15265 automatically to a few default newsgroups. You'll probably want to
15266 subscribe to more groups, and to do that, you have to query the
15267 @sc{nntp} server for a complete list of groups with the @kbd{A A}
15268 command. This usually takes quite a while, but you only have to do it
15271 After reading and parsing a while, you'll be presented with a list of
15272 groups. Subscribe to the ones you want to read with the @kbd{u}
15273 command. @kbd{l} to make all the killed groups disappear after you've
15274 subscribe to all the groups you want to read. (@kbd{A k} will bring
15275 back all the killed groups.)
15277 You can now read the groups at once, or you can download the articles
15278 with the @kbd{J s} command. And then read the rest of this manual to
15279 find out which of the other gazillion things you want to customize.
15282 @node Batching Agents
15283 @subsection Batching Agents
15285 Having the Gnus Agent fetch articles (and post whatever messages you've
15286 written) is quite easy once you've gotten things set up properly. The
15287 following shell script will do everything that is necessary:
15291 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
15295 @node Agent Caveats
15296 @subsection Agent Caveats
15298 The Gnus Agent doesn't seem to work like most other offline
15299 newsreaders. Here are some common questions that some imaginary people
15303 @item If I read an article while plugged, do they get entered into the
15308 @item If I read an article while plugged, and the article already exists
15309 in the Agent, will it get downloaded once more?
15315 In short, when Gnus is unplugged, it only looks into the locally stored
15316 articles; when it's plugged, it only talks to your ISP.
15323 Other people use @dfn{kill files}, but we here at Gnus Towers like
15324 scoring better than killing, so we'd rather switch than fight. They do
15325 something completely different as well, so sit up straight and pay
15328 @vindex gnus-summary-mark-below
15329 All articles have a default score (@code{gnus-summary-default-score}),
15330 which is 0 by default. This score may be raised or lowered either
15331 interactively or by score files. Articles that have a score lower than
15332 @code{gnus-summary-mark-below} are marked as read.
15334 Gnus will read any @dfn{score files} that apply to the current group
15335 before generating the summary buffer.
15337 There are several commands in the summary buffer that insert score
15338 entries based on the current article. You can, for instance, ask Gnus to
15339 lower or increase the score of all articles with a certain subject.
15341 There are two sorts of scoring entries: Permanent and temporary.
15342 Temporary score entries are self-expiring entries. Any entries that are
15343 temporary and have not been used for, say, a week, will be removed
15344 silently to help keep the sizes of the score files down.
15347 * Summary Score Commands:: Adding score entries for the current group.
15348 * Group Score Commands:: General score commands.
15349 * Score Variables:: Customize your scoring. (My, what terminology).
15350 * Score File Format:: What a score file may contain.
15351 * Score File Editing:: You can edit score files by hand as well.
15352 * Adaptive Scoring:: Big Sister Gnus knows what you read.
15353 * Home Score File:: How to say where new score entries are to go.
15354 * Followups To Yourself:: Having Gnus notice when people answer you.
15355 * Scoring Tips:: How to score effectively.
15356 * Reverse Scoring:: That problem child of old is not problem.
15357 * Global Score Files:: Earth-spanning, ear-splitting score files.
15358 * Kill Files:: They are still here, but they can be ignored.
15359 * Converting Kill Files:: Translating kill files to score files.
15360 * GroupLens:: Getting predictions on what you like to read.
15361 * Advanced Scoring:: Using logical expressions to build score rules.
15362 * Score Decays:: It can be useful to let scores wither away.
15366 @node Summary Score Commands
15367 @section Summary Score Commands
15368 @cindex score commands
15370 The score commands that alter score entries do not actually modify real
15371 score files. That would be too inefficient. Gnus maintains a cache of
15372 previously loaded score files, one of which is considered the
15373 @dfn{current score file alist}. The score commands simply insert
15374 entries into this list, and upon group exit, this list is saved.
15376 The current score file is by default the group's local score file, even
15377 if no such score file actually exists. To insert score commands into
15378 some other score file (e.g. @file{all.SCORE}), you must first make this
15379 score file the current one.
15381 General score commands that don't actually change the score file:
15386 @kindex V s (Summary)
15387 @findex gnus-summary-set-score
15388 Set the score of the current article (@code{gnus-summary-set-score}).
15391 @kindex V S (Summary)
15392 @findex gnus-summary-current-score
15393 Display the score of the current article
15394 (@code{gnus-summary-current-score}).
15397 @kindex V t (Summary)
15398 @findex gnus-score-find-trace
15399 Display all score rules that have been used on the current article
15400 (@code{gnus-score-find-trace}).
15403 @kindex V R (Summary)
15404 @findex gnus-summary-rescore
15405 Run the current summary through the scoring process
15406 (@code{gnus-summary-rescore}). This might be useful if you're playing
15407 around with your score files behind Gnus' back and want to see the
15408 effect you're having.
15411 @kindex V c (Summary)
15412 @findex gnus-score-change-score-file
15413 Make a different score file the current
15414 (@code{gnus-score-change-score-file}).
15417 @kindex V e (Summary)
15418 @findex gnus-score-edit-current-scores
15419 Edit the current score file (@code{gnus-score-edit-current-scores}).
15420 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
15424 @kindex V f (Summary)
15425 @findex gnus-score-edit-file
15426 Edit a score file and make this score file the current one
15427 (@code{gnus-score-edit-file}).
15430 @kindex V F (Summary)
15431 @findex gnus-score-flush-cache
15432 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
15433 after editing score files.
15436 @kindex V C (Summary)
15437 @findex gnus-score-customize
15438 Customize a score file in a visually pleasing manner
15439 (@code{gnus-score-customize}).
15443 The rest of these commands modify the local score file.
15448 @kindex V m (Summary)
15449 @findex gnus-score-set-mark-below
15450 Prompt for a score, and mark all articles with a score below this as
15451 read (@code{gnus-score-set-mark-below}).
15454 @kindex V x (Summary)
15455 @findex gnus-score-set-expunge-below
15456 Prompt for a score, and add a score rule to the current score file to
15457 expunge all articles below this score
15458 (@code{gnus-score-set-expunge-below}).
15461 The keystrokes for actually making score entries follow a very regular
15462 pattern, so there's no need to list all the commands. (Hundreds of
15465 @findex gnus-summary-increase-score
15466 @findex gnus-summary-lower-score
15470 The first key is either @kbd{I} (upper case i) for increasing the score
15471 or @kbd{L} for lowering the score.
15473 The second key says what header you want to score on. The following
15474 keys are available:
15478 Score on the author name.
15481 Score on the subject line.
15484 Score on the @code{Xref} line---i.e., the cross-posting line.
15487 Score on the @code{References} line.
15493 Score on the number of lines.
15496 Score on the @code{Message-ID} header.
15499 Score on followups---this matches the author name, and adds scores to
15500 the followups to this author.
15514 The third key is the match type. Which match types are valid depends on
15515 what headers you are scoring on.
15527 Substring matching.
15530 Fuzzy matching (@pxref{Fuzzy Matching}).
15559 Greater than number.
15564 The fourth and final key says whether this is a temporary (i.e., expiring)
15565 score entry, or a permanent (i.e., non-expiring) score entry, or whether
15566 it is to be done immediately, without adding to the score file.
15570 Temporary score entry.
15573 Permanent score entry.
15576 Immediately scoring.
15581 So, let's say you want to increase the score on the current author with
15582 exact matching permanently: @kbd{I a e p}. If you want to lower the
15583 score based on the subject line, using substring matching, and make a
15584 temporary score entry: @kbd{L s s t}. Pretty easy.
15586 To make things a bit more complicated, there are shortcuts. If you use
15587 a capital letter on either the second or third keys, Gnus will use
15588 defaults for the remaining one or two keystrokes. The defaults are
15589 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
15590 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
15592 These functions take both the numerical prefix and the symbolic prefix
15593 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
15594 (or increase) the score of the article. A symbolic prefix of @code{a}
15595 says to use the @file{all.SCORE} file for the command instead of the
15596 current score file.
15598 @vindex gnus-score-mimic-keymap
15599 The @code{gnus-score-mimic-keymap} says whether these commands will
15600 pretend they are keymaps or not.
15603 @node Group Score Commands
15604 @section Group Score Commands
15605 @cindex group score commands
15607 There aren't many of these as yet, I'm afraid.
15612 @kindex W f (Group)
15613 @findex gnus-score-flush-cache
15614 Gnus maintains a cache of score alists to avoid having to reload them
15615 all the time. This command will flush the cache
15616 (@code{gnus-score-flush-cache}).
15620 You can do scoring from the command line by saying something like:
15622 @findex gnus-batch-score
15623 @cindex batch scoring
15625 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
15629 @node Score Variables
15630 @section Score Variables
15631 @cindex score variables
15635 @item gnus-use-scoring
15636 @vindex gnus-use-scoring
15637 If @code{nil}, Gnus will not check for score files, and will not, in
15638 general, do any score-related work. This is @code{t} by default.
15640 @item gnus-kill-killed
15641 @vindex gnus-kill-killed
15642 If this variable is @code{nil}, Gnus will never apply score files to
15643 articles that have already been through the kill process. While this
15644 may save you lots of time, it also means that if you apply a kill file
15645 to a group, and then change the kill file and want to run it over you
15646 group again to kill more articles, it won't work. You have to set this
15647 variable to @code{t} to do that. (It is @code{t} by default.)
15649 @item gnus-kill-files-directory
15650 @vindex gnus-kill-files-directory
15651 All kill and score files will be stored in this directory, which is
15652 initialized from the @code{SAVEDIR} environment variable by default.
15653 This is @file{~/News/} by default.
15655 @item gnus-score-file-suffix
15656 @vindex gnus-score-file-suffix
15657 Suffix to add to the group name to arrive at the score file name
15658 (@samp{SCORE} by default.)
15660 @item gnus-score-uncacheable-files
15661 @vindex gnus-score-uncacheable-files
15662 @cindex score cache
15663 All score files are normally cached to avoid excessive re-loading of
15664 score files. However, if this might make your Emacs grow big and
15665 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
15666 @file{all.SCORE}, while it might be a good idea to not cache
15667 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
15668 variable is @samp{ADAPT$} by default, so no adaptive score files will
15671 @item gnus-save-score
15672 @vindex gnus-save-score
15673 If you have really complicated score files, and do lots of batch
15674 scoring, then you might set this variable to @code{t}. This will make
15675 Gnus save the scores into the @file{.newsrc.eld} file.
15677 If you do not set this to @code{t}, then manual scores (like those set
15678 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
15679 across group visits.
15681 @item gnus-score-interactive-default-score
15682 @vindex gnus-score-interactive-default-score
15683 Score used by all the interactive raise/lower commands to raise/lower
15684 score with. Default is 1000, which may seem excessive, but this is to
15685 ensure that the adaptive scoring scheme gets enough room to play with.
15686 We don't want the small changes from the adaptive scoring to overwrite
15687 manually entered data.
15689 @item gnus-summary-default-score
15690 @vindex gnus-summary-default-score
15691 Default score of an article, which is 0 by default.
15693 @item gnus-summary-expunge-below
15694 @vindex gnus-summary-expunge-below
15695 Don't display the summary lines of articles that have scores lower than
15696 this variable. This is @code{nil} by default, which means that no
15697 articles will be hidden. This variable is local to the summary buffers,
15698 and has to be set from @code{gnus-summary-mode-hook}.
15700 @item gnus-score-over-mark
15701 @vindex gnus-score-over-mark
15702 Mark (in the third column) used for articles with a score over the
15703 default. Default is @samp{+}.
15705 @item gnus-score-below-mark
15706 @vindex gnus-score-below-mark
15707 Mark (in the third column) used for articles with a score below the
15708 default. Default is @samp{-}.
15710 @item gnus-score-find-score-files-function
15711 @vindex gnus-score-find-score-files-function
15712 Function used to find score files for the current group. This function
15713 is called with the name of the group as the argument.
15715 Predefined functions available are:
15718 @item gnus-score-find-single
15719 @findex gnus-score-find-single
15720 Only apply the group's own score file.
15722 @item gnus-score-find-bnews
15723 @findex gnus-score-find-bnews
15724 Apply all score files that match, using bnews syntax. This is the
15725 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
15726 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
15727 @file{gnu.all.SCORE} would all apply. In short, the instances of
15728 @samp{all} in the score file names are translated into @samp{.*}, and
15729 then a regexp match is done.
15731 This means that if you have some score entries that you want to apply to
15732 all groups, then you put those entries in the @file{all.SCORE} file.
15734 The score files are applied in a semi-random order, although Gnus will
15735 try to apply the more general score files before the more specific score
15736 files. It does this by looking at the number of elements in the score
15737 file names---discarding the @samp{all} elements.
15739 @item gnus-score-find-hierarchical
15740 @findex gnus-score-find-hierarchical
15741 Apply all score files from all the parent groups. This means that you
15742 can't have score files like @file{all.SCORE}, but you can have
15743 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
15747 This variable can also be a list of functions. In that case, all these
15748 functions will be called with the group name as argument, and all the
15749 returned lists of score files will be applied. These functions can also
15750 return lists of score alists directly. In that case, the functions that
15751 return these non-file score alists should probably be placed before the
15752 ``real'' score file functions, to ensure that the last score file
15753 returned is the local score file. Phu.
15755 For example, to do hierarchical scoring but use a non-server-specific
15756 overall score file, you could use the value
15758 (list (lambda (group) ("all.SCORE")) 'gnus-score-find-hierarchical)
15761 @item gnus-score-expiry-days
15762 @vindex gnus-score-expiry-days
15763 This variable says how many days should pass before an unused score file
15764 entry is expired. If this variable is @code{nil}, no score file entries
15765 are expired. It's 7 by default.
15767 @item gnus-update-score-entry-dates
15768 @vindex gnus-update-score-entry-dates
15769 If this variable is non-@code{nil}, matching score entries will have
15770 their dates updated. (This is how Gnus controls expiry---all
15771 non-matching entries will become too old while matching entries will
15772 stay fresh and young.) However, if you set this variable to @code{nil},
15773 even matching entries will grow old and will have to face that oh-so
15776 @item gnus-score-after-write-file-function
15777 @vindex gnus-score-after-write-file-function
15778 Function called with the name of the score file just written.
15780 @item gnus-score-thread-simplify
15781 @vindex gnus-score-thread-simplify
15782 If this variable is non-@code{nil}, article subjects will be simplified
15783 for subject scoring purposes in the same manner as with
15784 threading---according to the current value of
15785 gnus-simplify-subject-functions. If the scoring entry uses
15786 @code{substring} or @code{exact} matching, the match will also be
15787 simplified in this manner.
15792 @node Score File Format
15793 @section Score File Format
15794 @cindex score file format
15796 A score file is an @code{emacs-lisp} file that normally contains just a
15797 single form. Casual users are not expected to edit these files;
15798 everything can be changed from the summary buffer.
15800 Anyway, if you'd like to dig into it yourself, here's an example:
15804 ("Lars Ingebrigtsen" -10000)
15806 ("larsi\\|lmi" -50000 nil R))
15808 ("Ding is Badd" nil 728373))
15810 ("alt.politics" -1000 728372 s))
15815 (mark-and-expunge -10)
15819 (files "/hom/larsi/News/gnu.SCORE")
15820 (exclude-files "all.SCORE")
15821 (local (gnus-newsgroup-auto-expire t)
15822 (gnus-summary-make-false-root empty))
15826 This example demonstrates most score file elements. For a different
15827 approach, see @pxref{Advanced Scoring}.
15829 Even though this looks much like lisp code, nothing here is actually
15830 @code{eval}ed. The lisp reader is used to read this form, though, so it
15831 has to be valid syntactically, if not semantically.
15833 Six keys are supported by this alist:
15838 If the key is a string, it is the name of the header to perform the
15839 match on. Scoring can only be performed on these eight headers:
15840 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
15841 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
15842 these headers, there are three strings to tell Gnus to fetch the entire
15843 article and do the match on larger parts of the article: @code{Body}
15844 will perform the match on the body of the article, @code{Head} will
15845 perform the match on the head of the article, and @code{All} will
15846 perform the match on the entire article. Note that using any of these
15847 last three keys will slow down group entry @emph{considerably}. The
15848 final ``header'' you can score on is @code{Followup}. These score
15849 entries will result in new score entries being added for all follow-ups
15850 to articles that matches these score entries.
15852 Following this key is a arbitrary number of score entries, where each
15853 score entry has one to four elements.
15857 The first element is the @dfn{match element}. On most headers this will
15858 be a string, but on the Lines and Chars headers, this must be an
15862 If the second element is present, it should be a number---the @dfn{score
15863 element}. This number should be an integer in the neginf to posinf
15864 interval. This number is added to the score of the article if the match
15865 is successful. If this element is not present, the
15866 @code{gnus-score-interactive-default-score} number will be used
15867 instead. This is 1000 by default.
15870 If the third element is present, it should be a number---the @dfn{date
15871 element}. This date says when the last time this score entry matched,
15872 which provides a mechanism for expiring the score entries. It this
15873 element is not present, the score entry is permanent. The date is
15874 represented by the number of days since December 31, 1 BCE.
15877 If the fourth element is present, it should be a symbol---the @dfn{type
15878 element}. This element specifies what function should be used to see
15879 whether this score entry matches the article. What match types that can
15880 be used depends on what header you wish to perform the match on.
15883 @item From, Subject, References, Xref, Message-ID
15884 For most header types, there are the @code{r} and @code{R} (regexp), as
15885 well as @code{s} and @code{S} (substring) types, and @code{e} and
15886 @code{E} (exact match), and @code{w} (word match) types. If this
15887 element is not present, Gnus will assume that substring matching should
15888 be used. @code{R}, @code{S}, and @code{E} differ from the others in
15889 that the matches will be done in a case-sensitive manner. All these
15890 one-letter types are really just abbreviations for the @code{regexp},
15891 @code{string}, @code{exact}, and @code{word} types, which you can use
15892 instead, if you feel like.
15895 These two headers use different match types: @code{<}, @code{>},
15896 @code{=}, @code{>=} and @code{<=}.
15898 These predicates are true if
15901 (PREDICATE HEADER MATCH)
15904 evaluates to non-@code{nil}. For instance, the advanced match
15905 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
15912 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
15913 the match, we get the score added if the article has less than 4 lines.
15914 (It's easy to get confused and think it's the other way around. But
15915 it's not. I think.)
15917 When matching on @code{Lines}, be careful because some backends (like
15918 @code{nndir}) do not generate @code{Lines} header, so every article ends
15919 up being marked as having 0 lines. This can lead to strange results if
15920 you happen to lower score of the articles with few lines.
15923 For the Date header we have three kinda silly match types:
15924 @code{before}, @code{at} and @code{after}. I can't really imagine this
15925 ever being useful, but, like, it would feel kinda silly not to provide
15926 this function. Just in case. You never know. Better safe than sorry.
15927 Once burnt, twice shy. Don't judge a book by its cover. Never not have
15928 sex on a first date. (I have been told that at least one person, and I
15929 quote, ``found this function indispensable'', however.)
15933 A more useful match type is @code{regexp}. With it, you can match the
15934 date string using a regular expression. The date is normalized to
15935 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
15936 you want to match all articles that have been posted on April 1st in
15937 every year, you could use @samp{....0401.........} as a match string,
15938 for instance. (Note that the date is kept in its original time zone, so
15939 this will match articles that were posted when it was April 1st where
15940 the article was posted from. Time zones are such wholesome fun for the
15943 @item Head, Body, All
15944 These three match keys use the same match types as the @code{From} (etc)
15948 This match key is somewhat special, in that it will match the
15949 @code{From} header, and affect the score of not only the matching
15950 articles, but also all followups to the matching articles. This allows
15951 you e.g. increase the score of followups to your own articles, or
15952 decrease the score of followups to the articles of some known
15953 trouble-maker. Uses the same match types as the @code{From} header
15954 uses. (Using this match key will lead to creation of @file{ADAPT}
15958 This match key works along the same lines as the @code{Followup} match
15959 key. If you say that you want to score on a (sub-)thread started by an
15960 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
15961 match. This will add a new @samp{thread} match for each article that
15962 has @var{x} in its @code{References} header. (These new @samp{thread}
15963 matches will use the @code{Message-ID}s of these matching articles.)
15964 This will ensure that you can raise/lower the score of an entire thread,
15965 even though some articles in the thread may not have complete
15966 @code{References} headers. Note that using this may lead to
15967 undeterministic scores of the articles in the thread. (Using this match
15968 key will lead to creation of @file{ADAPT} files.)
15972 @cindex Score File Atoms
15974 The value of this entry should be a number. Any articles with a score
15975 lower than this number will be marked as read.
15978 The value of this entry should be a number. Any articles with a score
15979 lower than this number will be removed from the summary buffer.
15981 @item mark-and-expunge
15982 The value of this entry should be a number. Any articles with a score
15983 lower than this number will be marked as read and removed from the
15986 @item thread-mark-and-expunge
15987 The value of this entry should be a number. All articles that belong to
15988 a thread that has a total score below this number will be marked as read
15989 and removed from the summary buffer. @code{gnus-thread-score-function}
15990 says how to compute the total score for a thread.
15993 The value of this entry should be any number of file names. These files
15994 are assumed to be score files as well, and will be loaded the same way
15997 @item exclude-files
15998 The clue of this entry should be any number of files. These files will
15999 not be loaded, even though they would normally be so, for some reason or
16003 The value of this entry will be @code{eval}el. This element will be
16004 ignored when handling global score files.
16007 Read-only score files will not be updated or saved. Global score files
16008 should feature this atom (@pxref{Global Score Files}). (Note:
16009 @dfn{Global} here really means @dfn{global}; not your personal
16010 apply-to-all-groups score files.)
16013 The value of this entry should be a number. Articles that do not have
16014 parents will get this number added to their scores. Imagine you follow
16015 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
16016 will only follow a few of the threads, also want to see any new threads.
16018 You can do this with the following two score file entries:
16022 (mark-and-expunge -100)
16025 When you enter the group the first time, you will only see the new
16026 threads. You then raise the score of the threads that you find
16027 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
16028 rest. Next time you enter the group, you will see new articles in the
16029 interesting threads, plus any new threads.
16031 I.e.---the orphan score atom is for high-volume groups where a few
16032 interesting threads which can't be found automatically by ordinary
16033 scoring rules exist.
16036 This entry controls the adaptive scoring. If it is @code{t}, the
16037 default adaptive scoring rules will be used. If it is @code{ignore}, no
16038 adaptive scoring will be performed on this group. If it is a list, this
16039 list will be used as the adaptive scoring rules. If it isn't present,
16040 or is something other than @code{t} or @code{ignore}, the default
16041 adaptive scoring rules will be used. If you want to use adaptive
16042 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
16043 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
16044 not want adaptive scoring. If you only want adaptive scoring in a few
16045 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
16046 insert @code{(adapt t)} in the score files of the groups where you want
16050 All adaptive score entries will go to the file named by this entry. It
16051 will also be applied when entering the group. This atom might be handy
16052 if you want to adapt on several groups at once, using the same adaptive
16053 file for a number of groups.
16056 @cindex local variables
16057 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
16058 Each @var{var} will be made buffer-local to the current summary buffer,
16059 and set to the value specified. This is a convenient, if somewhat
16060 strange, way of setting variables in some groups if you don't like hooks
16061 much. Note that the @var{value} won't be evaluated.
16065 @node Score File Editing
16066 @section Score File Editing
16068 You normally enter all scoring commands from the summary buffer, but you
16069 might feel the urge to edit them by hand as well, so we've supplied you
16070 with a mode for that.
16072 It's simply a slightly customized @code{emacs-lisp} mode, with these
16073 additional commands:
16078 @kindex C-c C-c (Score)
16079 @findex gnus-score-edit-done
16080 Save the changes you have made and return to the summary buffer
16081 (@code{gnus-score-edit-done}).
16084 @kindex C-c C-d (Score)
16085 @findex gnus-score-edit-insert-date
16086 Insert the current date in numerical format
16087 (@code{gnus-score-edit-insert-date}). This is really the day number, if
16088 you were wondering.
16091 @kindex C-c C-p (Score)
16092 @findex gnus-score-pretty-print
16093 The adaptive score files are saved in an unformatted fashion. If you
16094 intend to read one of these files, you want to @dfn{pretty print} it
16095 first. This command (@code{gnus-score-pretty-print}) does that for
16100 Type @kbd{M-x gnus-score-mode} to use this mode.
16102 @vindex gnus-score-mode-hook
16103 @code{gnus-score-menu-hook} is run in score mode buffers.
16105 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
16106 e} to begin editing score files.
16109 @node Adaptive Scoring
16110 @section Adaptive Scoring
16111 @cindex adaptive scoring
16113 If all this scoring is getting you down, Gnus has a way of making it all
16114 happen automatically---as if by magic. Or rather, as if by artificial
16115 stupidity, to be precise.
16117 @vindex gnus-use-adaptive-scoring
16118 When you read an article, or mark an article as read, or kill an
16119 article, you leave marks behind. On exit from the group, Gnus can sniff
16120 these marks and add score elements depending on what marks it finds.
16121 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
16122 @code{t} or @code{(line)}. If you want score adaptively on separate
16123 words appearing in the subjects, you should set this variable to
16124 @code{(word)}. If you want to use both adaptive methods, set this
16125 variable to @code{(word line)}.
16127 @vindex gnus-default-adaptive-score-alist
16128 To give you complete control over the scoring process, you can customize
16129 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
16130 might look something like this:
16133 (setq gnus-default-adaptive-score-alist
16134 '((gnus-unread-mark)
16135 (gnus-ticked-mark (from 4))
16136 (gnus-dormant-mark (from 5))
16137 (gnus-del-mark (from -4) (subject -1))
16138 (gnus-read-mark (from 4) (subject 2))
16139 (gnus-expirable-mark (from -1) (subject -1))
16140 (gnus-killed-mark (from -1) (subject -3))
16141 (gnus-kill-file-mark)
16142 (gnus-ancient-mark)
16143 (gnus-low-score-mark)
16144 (gnus-catchup-mark (from -1) (subject -1))))
16147 As you see, each element in this alist has a mark as a key (either a
16148 variable name or a ``real'' mark---a character). Following this key is
16149 a arbitrary number of header/score pairs. If there are no header/score
16150 pairs following the key, no adaptive scoring will be done on articles
16151 that have that key as the article mark. For instance, articles with
16152 @code{gnus-unread-mark} in the example above will not get adaptive score
16155 Each article can have only one mark, so just a single of these rules
16156 will be applied to each article.
16158 To take @code{gnus-del-mark} as an example---this alist says that all
16159 articles that have that mark (i.e., are marked with @samp{D}) will have a
16160 score entry added to lower based on the @code{From} header by -4, and
16161 lowered by @code{Subject} by -1. Change this to fit your prejudices.
16163 If you have marked 10 articles with the same subject with
16164 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
16165 That means that that subject will get a score of ten times -1, which
16166 should be, unless I'm much mistaken, -10.
16168 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
16169 the read articles will be marked with the @samp{E} mark. This'll
16170 probably make adaptive scoring slightly impossible, so auto-expiring and
16171 adaptive scoring doesn't really mix very well.
16173 The headers you can score on are @code{from}, @code{subject},
16174 @code{message-id}, @code{references}, @code{xref}, @code{lines},
16175 @code{chars} and @code{date}. In addition, you can score on
16176 @code{followup}, which will create an adaptive score entry that matches
16177 on the @code{References} header using the @code{Message-ID} of the
16178 current article, thereby matching the following thread.
16180 You can also score on @code{thread}, which will try to score all
16181 articles that appear in a thread. @code{thread} matches uses a
16182 @code{Message-ID} to match on the @code{References} header of the
16183 article. If the match is made, the @code{Message-ID} of the article is
16184 added to the @code{thread} rule. (Think about it. I'd recommend two
16185 aspirins afterwards.)
16187 If you use this scheme, you should set the score file atom @code{mark}
16188 to something small---like -300, perhaps, to avoid having small random
16189 changes result in articles getting marked as read.
16191 After using adaptive scoring for a week or so, Gnus should start to
16192 become properly trained and enhance the authors you like best, and kill
16193 the authors you like least, without you having to say so explicitly.
16195 You can control what groups the adaptive scoring is to be performed on
16196 by using the score files (@pxref{Score File Format}). This will also
16197 let you use different rules in different groups.
16199 @vindex gnus-adaptive-file-suffix
16200 The adaptive score entries will be put into a file where the name is the
16201 group name with @code{gnus-adaptive-file-suffix} appended. The default
16204 @vindex gnus-score-exact-adapt-limit
16205 When doing adaptive scoring, substring or fuzzy matching would probably
16206 give you the best results in most cases. However, if the header one
16207 matches is short, the possibility for false positives is great, so if
16208 the length of the match is less than
16209 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
16210 this variable is @code{nil}, exact matching will always be used to avoid
16213 @vindex gnus-default-adaptive-word-score-alist
16214 As mentioned above, you can adapt either on individual words or entire
16215 headers. If you adapt on words, the
16216 @code{gnus-default-adaptive-word-score-alist} variable says what score
16217 each instance of a word should add given a mark.
16220 (setq gnus-default-adaptive-word-score-alist
16221 `((,gnus-read-mark . 30)
16222 (,gnus-catchup-mark . -10)
16223 (,gnus-killed-mark . -20)
16224 (,gnus-del-mark . -15)))
16227 This is the default value. If you have adaption on words enabled, every
16228 word that appears in subjects of articles marked with
16229 @code{gnus-read-mark} will result in a score rule that increase the
16230 score with 30 points.
16232 @vindex gnus-default-ignored-adaptive-words
16233 @vindex gnus-ignored-adaptive-words
16234 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
16235 will be ignored. If you wish to add more words to be ignored, use the
16236 @code{gnus-ignored-adaptive-words} list instead.
16238 @vindex gnus-adaptive-word-length-limit
16239 Some may feel that short words shouldn't count when doing adaptive
16240 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
16241 an integer. Words shorter than this number will be ignored. This
16242 variable defaults til @code{nil}.
16244 @vindex gnus-adaptive-word-syntax-table
16245 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
16246 syntax table in effect. It is similar to the standard syntax table, but
16247 it considers numbers to be non-word-constituent characters.
16249 @vindex gnus-adaptive-word-minimum
16250 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
16251 word scoring process will never bring down the score of an article to
16252 below this number. The default is @code{nil}.
16254 @vindex gnus-adaptive-word-no-group-words
16255 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
16256 won't adaptively word score any of the words in the group name. Useful
16257 for groups like @samp{comp.editors.emacs}, where most of the subject
16258 lines contain the word @samp{emacs}.
16260 After using this scheme for a while, it might be nice to write a
16261 @code{gnus-psychoanalyze-user} command to go through the rules and see
16262 what words you like and what words you don't like. Or perhaps not.
16264 Note that the adaptive word scoring thing is highly experimental and is
16265 likely to change in the future. Initial impressions seem to indicate
16266 that it's totally useless as it stands. Some more work (involving more
16267 rigorous statistical methods) will have to be done to make this useful.
16270 @node Home Score File
16271 @section Home Score File
16273 The score file where new score file entries will go is called the
16274 @dfn{home score file}. This is normally (and by default) the score file
16275 for the group itself. For instance, the home score file for
16276 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
16278 However, this may not be what you want. It is often convenient to share
16279 a common home score file among many groups---all @samp{emacs} groups
16280 could perhaps use the same home score file.
16282 @vindex gnus-home-score-file
16283 The variable that controls this is @code{gnus-home-score-file}. It can
16288 A string. Then this file will be used as the home score file for all
16292 A function. The result of this function will be used as the home score
16293 file. The function will be called with the name of the group as the
16297 A list. The elements in this list can be:
16301 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
16302 group name, the @var{file-name} will be used as the home score file.
16305 A function. If the function returns non-nil, the result will be used as
16306 the home score file.
16309 A string. Use the string as the home score file.
16312 The list will be traversed from the beginning towards the end looking
16317 So, if you want to use just a single score file, you could say:
16320 (setq gnus-home-score-file
16321 "my-total-score-file.SCORE")
16324 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
16325 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
16327 @findex gnus-hierarchial-home-score-file
16329 (setq gnus-home-score-file
16330 'gnus-hierarchial-home-score-file)
16333 This is a ready-made function provided for your convenience.
16334 Other functions include
16337 @item gnus-current-home-score-file
16338 @findex gnus-current-home-score-file
16339 Return the ``current'' regular score file. This will make scoring
16340 commands add entry to the ``innermost'' matching score file.
16344 If you want to have one score file for the @samp{emacs} groups and
16345 another for the @samp{comp} groups, while letting all other groups use
16346 their own home score files:
16349 (setq gnus-home-score-file
16350 ;; All groups that match the regexp "\\.emacs"
16351 '(("\\.emacs" "emacs.SCORE")
16352 ;; All the comp groups in one score file
16353 ("^comp" "comp.SCORE")))
16356 @vindex gnus-home-adapt-file
16357 @code{gnus-home-adapt-file} works exactly the same way as
16358 @code{gnus-home-score-file}, but says what the home adaptive score file
16359 is instead. All new adaptive file entries will go into the file
16360 specified by this variable, and the same syntax is allowed.
16362 In addition to using @code{gnus-home-score-file} and
16363 @code{gnus-home-adapt-file}, you can also use group parameters
16364 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
16365 Parameters}) to achieve much the same. Group and topic parameters take
16366 precedence over this variable.
16369 @node Followups To Yourself
16370 @section Followups To Yourself
16372 Gnus offers two commands for picking out the @code{Message-ID} header in
16373 the current buffer. Gnus will then add a score rule that scores using
16374 this @code{Message-ID} on the @code{References} header of other
16375 articles. This will, in effect, increase the score of all articles that
16376 respond to the article in the current buffer. Quite useful if you want
16377 to easily note when people answer what you've said.
16381 @item gnus-score-followup-article
16382 @findex gnus-score-followup-article
16383 This will add a score to articles that directly follow up your own
16386 @item gnus-score-followup-thread
16387 @findex gnus-score-followup-thread
16388 This will add a score to all articles that appear in a thread ``below''
16392 @vindex message-sent-hook
16393 These two functions are both primarily meant to be used in hooks like
16394 @code{message-sent-hook}, like this:
16396 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
16400 If you look closely at your own @code{Message-ID}, you'll notice that
16401 the first two or three characters are always the same. Here's two of
16405 <x6u3u47icf.fsf@@eyesore.no>
16406 <x6sp9o7ibw.fsf@@eyesore.no>
16409 So ``my'' ident on this machine is @samp{x6}. This can be
16410 exploited---the following rule will raise the score on all followups to
16415 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
16419 Whether it's the first two or first three characters that are ``yours''
16420 is system-dependent.
16424 @section Scoring Tips
16425 @cindex scoring tips
16431 @cindex scoring crossposts
16432 If you want to lower the score of crossposts, the line to match on is
16433 the @code{Xref} header.
16435 ("xref" (" talk.politics.misc:" -1000))
16438 @item Multiple crossposts
16439 If you want to lower the score of articles that have been crossposted to
16440 more than, say, 3 groups:
16442 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
16445 @item Matching on the body
16446 This is generally not a very good idea---it takes a very long time.
16447 Gnus actually has to fetch each individual article from the server. But
16448 you might want to anyway, I guess. Even though there are three match
16449 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
16450 and stick with it in each score file. If you use any two, each article
16451 will be fetched @emph{twice}. If you want to match a bit on the
16452 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
16455 @item Marking as read
16456 You will probably want to mark articles that have scores below a certain
16457 number as read. This is most easily achieved by putting the following
16458 in your @file{all.SCORE} file:
16462 You may also consider doing something similar with @code{expunge}.
16464 @item Negated character classes
16465 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
16466 That will match newlines, which might lead to, well, The Unknown. Say
16467 @code{[^abcd\n]*} instead.
16471 @node Reverse Scoring
16472 @section Reverse Scoring
16473 @cindex reverse scoring
16475 If you want to keep just articles that have @samp{Sex with Emacs} in the
16476 subject header, and expunge all other articles, you could put something
16477 like this in your score file:
16481 ("Sex with Emacs" 2))
16486 So, you raise all articles that match @samp{Sex with Emacs} and mark the
16487 rest as read, and expunge them to boot.
16490 @node Global Score Files
16491 @section Global Score Files
16492 @cindex global score files
16494 Sure, other newsreaders have ``global kill files''. These are usually
16495 nothing more than a single kill file that applies to all groups, stored
16496 in the user's home directory. Bah! Puny, weak newsreaders!
16498 What I'm talking about here are Global Score Files. Score files from
16499 all over the world, from users everywhere, uniting all nations in one
16500 big, happy score file union! Ange-score! New and untested!
16502 @vindex gnus-global-score-files
16503 All you have to do to use other people's score files is to set the
16504 @code{gnus-global-score-files} variable. One entry for each score file,
16505 or each score file directory. Gnus will decide by itself what score
16506 files are applicable to which group.
16508 Say you want to use the score file
16509 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
16510 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
16513 (setq gnus-global-score-files
16514 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
16515 "/ftp@@ftp.some-where:/pub/score/"))
16518 @findex gnus-score-search-global-directories
16519 Simple, eh? Directory names must end with a @samp{/}. These
16520 directories are typically scanned only once during each Gnus session.
16521 If you feel the need to manually re-scan the remote directories, you can
16522 use the @code{gnus-score-search-global-directories} command.
16524 Note that, at present, using this option will slow down group entry
16525 somewhat. (That is---a lot.)
16527 If you want to start maintaining score files for other people to use,
16528 just put your score file up for anonymous ftp and announce it to the
16529 world. Become a retro-moderator! Participate in the retro-moderator
16530 wars sure to ensue, where retro-moderators battle it out for the
16531 sympathy of the people, luring them to use their score files on false
16532 premises! Yay! The net is saved!
16534 Here are some tips for the would-be retro-moderator, off the top of my
16540 Articles heavily crossposted are probably junk.
16542 To lower a single inappropriate article, lower by @code{Message-ID}.
16544 Particularly brilliant authors can be raised on a permanent basis.
16546 Authors that repeatedly post off-charter for the group can safely be
16547 lowered out of existence.
16549 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
16550 articles completely.
16553 Use expiring score entries to keep the size of the file down. You
16554 should probably have a long expiry period, though, as some sites keep
16555 old articles for a long time.
16558 ... I wonder whether other newsreaders will support global score files
16559 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
16560 Wave, xrn and 1stReader are bound to implement scoring. Should we start
16561 holding our breath yet?
16565 @section Kill Files
16568 Gnus still supports those pesky old kill files. In fact, the kill file
16569 entries can now be expiring, which is something I wrote before Daniel
16570 Quinlan thought of doing score files, so I've left the code in there.
16572 In short, kill processing is a lot slower (and I do mean @emph{a lot})
16573 than score processing, so it might be a good idea to rewrite your kill
16574 files into score files.
16576 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
16577 forms into this file, which means that you can use kill files as some
16578 sort of primitive hook function to be run on group entry, even though
16579 that isn't a very good idea.
16581 Normal kill files look like this:
16584 (gnus-kill "From" "Lars Ingebrigtsen")
16585 (gnus-kill "Subject" "ding")
16589 This will mark every article written by me as read, and remove the
16590 marked articles from the summary buffer. Very useful, you'll agree.
16592 Other programs use a totally different kill file syntax. If Gnus
16593 encounters what looks like a @code{rn} kill file, it will take a stab at
16596 Two summary functions for editing a GNUS kill file:
16601 @kindex M-k (Summary)
16602 @findex gnus-summary-edit-local-kill
16603 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
16606 @kindex M-K (Summary)
16607 @findex gnus-summary-edit-global-kill
16608 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
16611 Two group mode functions for editing the kill files:
16616 @kindex M-k (Group)
16617 @findex gnus-group-edit-local-kill
16618 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
16621 @kindex M-K (Group)
16622 @findex gnus-group-edit-global-kill
16623 Edit the general kill file (@code{gnus-group-edit-global-kill}).
16626 Kill file variables:
16629 @item gnus-kill-file-name
16630 @vindex gnus-kill-file-name
16631 A kill file for the group @samp{soc.motss} is normally called
16632 @file{soc.motss.KILL}. The suffix appended to the group name to get
16633 this file name is detailed by the @code{gnus-kill-file-name} variable.
16634 The ``global'' kill file (not in the score file sense of ``global'', of
16635 course) is just called @file{KILL}.
16637 @vindex gnus-kill-save-kill-file
16638 @item gnus-kill-save-kill-file
16639 If this variable is non-@code{nil}, Gnus will save the
16640 kill file after processing, which is necessary if you use expiring
16643 @item gnus-apply-kill-hook
16644 @vindex gnus-apply-kill-hook
16645 @findex gnus-apply-kill-file-unless-scored
16646 @findex gnus-apply-kill-file
16647 A hook called to apply kill files to a group. It is
16648 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
16649 kill file if you have a score file for the same group, you can set this
16650 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
16651 kill files to be processed, you should set this variable to @code{nil}.
16653 @item gnus-kill-file-mode-hook
16654 @vindex gnus-kill-file-mode-hook
16655 A hook called in kill-file mode buffers.
16660 @node Converting Kill Files
16661 @section Converting Kill Files
16663 @cindex converting kill files
16665 If you have loads of old kill files, you may want to convert them into
16666 score files. If they are ``regular'', you can use
16667 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
16670 The kill to score conversion package isn't included in Gnus by default.
16671 You can fetch it from
16672 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
16674 If your old kill files are very complex---if they contain more
16675 non-@code{gnus-kill} forms than not, you'll have to convert them by
16676 hand. Or just let them be as they are. Gnus will still use them as
16684 GroupLens is a collaborative filtering system that helps you work
16685 together with other people to find the quality news articles out of the
16686 huge volume of news articles generated every day.
16688 To accomplish this the GroupLens system combines your opinions about
16689 articles you have already read with the opinions of others who have done
16690 likewise and gives you a personalized prediction for each unread news
16691 article. Think of GroupLens as a matchmaker. GroupLens watches how you
16692 rate articles, and finds other people that rate articles the same way.
16693 Once it has found some people you agree with it tells you, in the form
16694 of a prediction, what they thought of the article. You can use this
16695 prediction to help you decide whether or not you want to read the
16699 * Using GroupLens:: How to make Gnus use GroupLens.
16700 * Rating Articles:: Letting GroupLens know how you rate articles.
16701 * Displaying Predictions:: Displaying predictions given by GroupLens.
16702 * GroupLens Variables:: Customizing GroupLens.
16706 @node Using GroupLens
16707 @subsection Using GroupLens
16709 To use GroupLens you must register a pseudonym with your local Better
16711 @uref{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
16712 better bit in town at the moment.
16714 Once you have registered you'll need to set a couple of variables.
16718 @item gnus-use-grouplens
16719 @vindex gnus-use-grouplens
16720 Setting this variable to a non-@code{nil} value will make Gnus hook into
16721 all the relevant GroupLens functions.
16723 @item grouplens-pseudonym
16724 @vindex grouplens-pseudonym
16725 This variable should be set to the pseudonym you got when registering
16726 with the Better Bit Bureau.
16728 @item grouplens-newsgroups
16729 @vindex grouplens-newsgroups
16730 A list of groups that you want to get GroupLens predictions for.
16734 That's the minimum of what you need to get up and running with GroupLens.
16735 Once you've registered, GroupLens will start giving you scores for
16736 articles based on the average of what other people think. But, to get
16737 the real benefit of GroupLens you need to start rating articles
16738 yourself. Then the scores GroupLens gives you will be personalized for
16739 you, based on how the people you usually agree with have already rated.
16742 @node Rating Articles
16743 @subsection Rating Articles
16745 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
16746 Where 1 means something like this article is a waste of bandwidth and 5
16747 means that the article was really good. The basic question to ask
16748 yourself is, "on a scale from 1 to 5 would I like to see more articles
16751 There are four ways to enter a rating for an article in GroupLens.
16756 @kindex r (GroupLens)
16757 @findex bbb-summary-rate-article
16758 This function will prompt you for a rating on a scale of one to five.
16761 @kindex k (GroupLens)
16762 @findex grouplens-score-thread
16763 This function will prompt you for a rating, and rate all the articles in
16764 the thread. This is really useful for some of those long running giant
16765 threads in rec.humor.
16769 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
16770 the score of the article you're reading.
16775 @kindex n (GroupLens)
16776 @findex grouplens-next-unread-article
16777 Rate the article and go to the next unread article.
16780 @kindex , (GroupLens)
16781 @findex grouplens-best-unread-article
16782 Rate the article and go to the next unread article with the highest score.
16786 If you want to give the current article a score of 4 and then go to the
16787 next article, just type @kbd{4 n}.
16790 @node Displaying Predictions
16791 @subsection Displaying Predictions
16793 GroupLens makes a prediction for you about how much you will like a
16794 news article. The predictions from GroupLens are on a scale from 1 to
16795 5, where 1 is the worst and 5 is the best. You can use the predictions
16796 from GroupLens in one of three ways controlled by the variable
16797 @code{gnus-grouplens-override-scoring}.
16799 @vindex gnus-grouplens-override-scoring
16800 There are three ways to display predictions in grouplens. You may
16801 choose to have the GroupLens scores contribute to, or override the
16802 regular gnus scoring mechanism. override is the default; however, some
16803 people prefer to see the Gnus scores plus the grouplens scores. To get
16804 the separate scoring behavior you need to set
16805 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
16806 GroupLens predictions combined with the grouplens scores set it to
16807 @code{'override} and to combine the scores set
16808 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
16809 the combine option you will also want to set the values for
16810 @code{grouplens-prediction-offset} and
16811 @code{grouplens-score-scale-factor}.
16813 @vindex grouplens-prediction-display
16814 In either case, GroupLens gives you a few choices for how you would like
16815 to see your predictions displayed. The display of predictions is
16816 controlled by the @code{grouplens-prediction-display} variable.
16818 The following are valid values for that variable.
16821 @item prediction-spot
16822 The higher the prediction, the further to the right an @samp{*} is
16825 @item confidence-interval
16826 A numeric confidence interval.
16828 @item prediction-bar
16829 The higher the prediction, the longer the bar.
16831 @item confidence-bar
16832 Numerical confidence.
16834 @item confidence-spot
16835 The spot gets bigger with more confidence.
16837 @item prediction-num
16838 Plain-old numeric value.
16840 @item confidence-plus-minus
16841 Prediction +/- confidence.
16846 @node GroupLens Variables
16847 @subsection GroupLens Variables
16851 @item gnus-summary-grouplens-line-format
16852 The summary line format used in GroupLens-enhanced summary buffers. It
16853 accepts the same specs as the normal summary line format (@pxref{Summary
16854 Buffer Lines}). The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
16857 @item grouplens-bbb-host
16858 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
16861 @item grouplens-bbb-port
16862 Port of the host running the bbbd server. The default is 9000.
16864 @item grouplens-score-offset
16865 Offset the prediction by this value. In other words, subtract the
16866 prediction value by this number to arrive at the effective score. The
16869 @item grouplens-score-scale-factor
16870 This variable allows the user to magnify the effect of GroupLens scores.
16871 The scale factor is applied after the offset. The default is 1.
16876 @node Advanced Scoring
16877 @section Advanced Scoring
16879 Scoring on Subjects and From headers is nice enough, but what if you're
16880 really interested in what a person has to say only when she's talking
16881 about a particular subject? Or what if you really don't want to
16882 read what person A has to say when she's following up to person B, but
16883 want to read what she says when she's following up to person C?
16885 By using advanced scoring rules you may create arbitrarily complex
16889 * Advanced Scoring Syntax:: A definition.
16890 * Advanced Scoring Examples:: What they look like.
16891 * Advanced Scoring Tips:: Getting the most out of it.
16895 @node Advanced Scoring Syntax
16896 @subsection Advanced Scoring Syntax
16898 Ordinary scoring rules have a string as the first element in the rule.
16899 Advanced scoring rules have a list as the first element. The second
16900 element is the score to be applied if the first element evaluated to a
16901 non-@code{nil} value.
16903 These lists may consist of three logical operators, one redirection
16904 operator, and various match operators.
16911 This logical operator will evaluate each of its arguments until it finds
16912 one that evaluates to @code{false}, and then it'll stop. If all arguments
16913 evaluate to @code{true} values, then this operator will return
16918 This logical operator will evaluate each of its arguments until it finds
16919 one that evaluates to @code{true}. If no arguments are @code{true},
16920 then this operator will return @code{false}.
16925 This logical operator only takes a single argument. It returns the
16926 logical negation of the value of its argument.
16930 There is an @dfn{indirection operator} that will make its arguments
16931 apply to the ancestors of the current article being scored. For
16932 instance, @code{1-} will make score rules apply to the parent of the
16933 current article. @code{2-} will make score rules apply to the
16934 grandparent of the current article. Alternatively, you can write
16935 @code{^^}, where the number of @code{^}s (carets) says how far back into
16936 the ancestry you want to go.
16938 Finally, we have the match operators. These are the ones that do the
16939 real work. Match operators are header name strings followed by a match
16940 and a match type. A typical match operator looks like @samp{("from"
16941 "Lars Ingebrigtsen" s)}. The header names are the same as when using
16942 simple scoring, and the match types are also the same.
16945 @node Advanced Scoring Examples
16946 @subsection Advanced Scoring Examples
16948 Let's say you want to increase the score of articles written by Lars
16949 when he's talking about Gnus:
16953 ("from" "Lars Ingebrigtsen")
16954 ("subject" "Gnus"))
16960 When he writes long articles, he sometimes has something nice to say:
16964 ("from" "Lars Ingebrigtsen")
16971 However, when he responds to things written by Reig Eigil Logge, you
16972 really don't want to read what he's written:
16976 ("from" "Lars Ingebrigtsen")
16977 (1- ("from" "Reig Eigir Logge")))
16981 Everybody that follows up Redmondo when he writes about disappearing
16982 socks should have their scores raised, but only when they talk about
16983 white socks. However, when Lars talks about socks, it's usually not
16990 ("from" "redmondo@@.*no" r)
16991 ("body" "disappearing.*socks" t)))
16992 (! ("from" "Lars Ingebrigtsen"))
16993 ("body" "white.*socks"))
16997 The possibilities are endless.
17000 @node Advanced Scoring Tips
17001 @subsection Advanced Scoring Tips
17003 The @code{&} and @code{|} logical operators do short-circuit logic.
17004 That is, they stop processing their arguments when it's clear what the
17005 result of the operation will be. For instance, if one of the arguments
17006 of an @code{&} evaluates to @code{false}, there's no point in evaluating
17007 the rest of the arguments. This means that you should put slow matches
17008 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
17009 @samp{subject}) first.
17011 The indirection arguments (@code{1-} and so on) will make their
17012 arguments work on previous generations of the thread. If you say
17023 Then that means "score on the from header of the grandparent of the
17024 current article". An indirection is quite fast, but it's better to say:
17030 ("subject" "Gnus")))
17037 (1- ("from" "Lars"))
17038 (1- ("subject" "Gnus")))
17043 @section Score Decays
17044 @cindex score decays
17047 You may find that your scores have a tendency to grow without
17048 bounds, especially if you're using adaptive scoring. If scores get too
17049 big, they lose all meaning---they simply max out and it's difficult to
17050 use them in any sensible way.
17052 @vindex gnus-decay-scores
17053 @findex gnus-decay-score
17054 @vindex gnus-decay-score-function
17055 Gnus provides a mechanism for decaying scores to help with this problem.
17056 When score files are loaded and @code{gnus-decay-scores} is
17057 non-@code{nil}, Gnus will run the score files through the decaying
17058 mechanism thereby lowering the scores of all non-permanent score rules.
17059 The decay itself if performed by the @code{gnus-decay-score-function}
17060 function, which is @code{gnus-decay-score} by default. Here's the
17061 definition of that function:
17064 (defun gnus-decay-score (score)
17066 This is done according to `gnus-score-decay-constant'
17067 and `gnus-score-decay-scale'."
17070 (* (if (< score 0) 1 -1)
17072 (max gnus-score-decay-constant
17074 gnus-score-decay-scale)))))))
17077 @vindex gnus-score-decay-scale
17078 @vindex gnus-score-decay-constant
17079 @code{gnus-score-decay-constant} is 3 by default and
17080 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
17084 Scores between -3 and 3 will be set to 0 when this function is called.
17087 Scores with magnitudes between 3 and 60 will be shrunk by 3.
17090 Scores with magnitudes greater than 60 will be shrunk by 5% of the
17094 If you don't like this decay function, write your own. It is called
17095 with the score to be decayed as its only parameter, and it should return
17096 the new score, which should be an integer.
17098 Gnus will try to decay scores once a day. If you haven't run Gnus for
17099 four days, Gnus will decay the scores four times, for instance.
17106 * Process/Prefix:: A convention used by many treatment commands.
17107 * Interactive:: Making Gnus ask you many questions.
17108 * Symbolic Prefixes:: How to supply some Gnus functions with options.
17109 * Formatting Variables:: You can specify what buffers should look like.
17110 * Windows Configuration:: Configuring the Gnus buffer windows.
17111 * Faces and Fonts:: How to change how faces look.
17112 * Compilation:: How to speed Gnus up.
17113 * Mode Lines:: Displaying information in the mode lines.
17114 * Highlighting and Menus:: Making buffers look all nice and cozy.
17115 * Buttons:: Get tendinitis in ten easy steps!
17116 * Daemons:: Gnus can do things behind your back.
17117 * NoCeM:: How to avoid spam and other fatty foods.
17118 * Undo:: Some actions can be undone.
17119 * Moderation:: What to do if you're a moderator.
17120 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
17121 * Fuzzy Matching:: What's the big fuzz?
17122 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
17123 * Various Various:: Things that are really various.
17127 @node Process/Prefix
17128 @section Process/Prefix
17129 @cindex process/prefix convention
17131 Many functions, among them functions for moving, decoding and saving
17132 articles, use what is known as the @dfn{Process/Prefix convention}.
17134 This is a method for figuring out what articles the user wants the
17135 command to be performed on.
17139 If the numeric prefix is N, perform the operation on the next N
17140 articles, starting with the current one. If the numeric prefix is
17141 negative, perform the operation on the previous N articles, starting
17142 with the current one.
17144 @vindex transient-mark-mode
17145 If @code{transient-mark-mode} in non-@code{nil} and the region is
17146 active, all articles in the region will be worked upon.
17148 If there is no numeric prefix, but some articles are marked with the
17149 process mark, perform the operation on the articles marked with
17152 If there is neither a numeric prefix nor any articles marked with the
17153 process mark, just perform the operation on the current article.
17155 Quite simple, really, but it needs to be made clear so that surprises
17158 Commands that react to the process mark will push the current list of
17159 process marked articles onto a stack and will then clear all process
17160 marked articles. You can restore the previous configuration with the
17161 @kbd{M P y} command (@pxref{Setting Process Marks}).
17163 @vindex gnus-summary-goto-unread
17164 One thing that seems to shock & horrify lots of people is that, for
17165 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
17166 Since each @kbd{d} (which marks the current article as read) by default
17167 goes to the next unread article after marking, this means that @kbd{3 d}
17168 will mark the next three unread articles as read, no matter what the
17169 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
17170 @code{nil} for a more straightforward action.
17172 Many commands do not use the process/prefix convention. All commands
17173 that do explicitly say so in this manual. To apply the process/prefix
17174 convention to commands that do not use it, you can use the @kbd{M-&}
17175 command. For instance, to mark all the articles in the group as
17176 expirable, you could say `M P b M-& E'.
17180 @section Interactive
17181 @cindex interaction
17185 @item gnus-novice-user
17186 @vindex gnus-novice-user
17187 If this variable is non-@code{nil}, you are either a newcomer to the
17188 World of Usenet, or you are very cautious, which is a nice thing to be,
17189 really. You will be given questions of the type ``Are you sure you want
17190 to do this?'' before doing anything dangerous. This is @code{t} by
17193 @item gnus-expert-user
17194 @vindex gnus-expert-user
17195 If this variable is non-@code{nil}, you will seldom be asked any
17196 questions by Gnus. It will simply assume you know what you're doing, no
17197 matter how strange.
17199 @item gnus-interactive-catchup
17200 @vindex gnus-interactive-catchup
17201 Require confirmation before catching up a group if non-@code{nil}. It
17202 is @code{t} by default.
17204 @item gnus-interactive-exit
17205 @vindex gnus-interactive-exit
17206 Require confirmation before exiting Gnus. This variable is @code{t} by
17211 @node Symbolic Prefixes
17212 @section Symbolic Prefixes
17213 @cindex symbolic prefixes
17215 Quite a lot of Emacs commands react to the (numeric) prefix. For
17216 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
17217 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
17218 rule of 900 to the current article.
17220 This is all nice and well, but what if you want to give a command some
17221 additional information? Well, what most commands do is interpret the
17222 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
17223 doesn't want a backup file to be created when saving the current buffer,
17224 for instance. But what if you want to save without making a backup
17225 file, and you want Emacs to flash lights and play a nice tune at the
17226 same time? You can't, and you're probably perfectly happy that way.
17228 @kindex M-i (Summary)
17229 @findex gnus-symbolic-argument
17230 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
17231 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
17232 character typed in is the value. You can stack as many @kbd{M-i}
17233 prefixes as you want. @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
17234 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b M-C-u} means
17235 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
17236 @code{b}''. You get the drift.
17238 Typing in symbolic prefixes to commands that don't accept them doesn't
17239 hurt, but it doesn't do any good either. Currently not many Gnus
17240 functions make use of the symbolic prefix.
17242 If you're interested in how Gnus implements this, @pxref{Extended
17246 @node Formatting Variables
17247 @section Formatting Variables
17248 @cindex formatting variables
17250 Throughout this manual you've probably noticed lots of variables called
17251 things like @code{gnus-group-line-format} and
17252 @code{gnus-summary-mode-line-format}. These control how Gnus is to
17253 output lines in the various buffers. There's quite a lot of them.
17254 Fortunately, they all use the same syntax, so there's not that much to
17257 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
17258 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
17259 lots of percentages everywhere.
17262 * Formatting Basics:: A formatting variable is basically a format string.
17263 * Mode Line Formatting:: Some rules about mode line formatting variables.
17264 * Advanced Formatting:: Modifying output in various ways.
17265 * User-Defined Specs:: Having Gnus call your own functions.
17266 * Formatting Fonts:: Making the formatting look colorful and nice.
17269 Currently Gnus uses the following formatting variables:
17270 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
17271 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
17272 @code{gnus-group-mode-line-format},
17273 @code{gnus-summary-mode-line-format},
17274 @code{gnus-article-mode-line-format},
17275 @code{gnus-server-mode-line-format}, and
17276 @code{gnus-summary-pick-line-format}.
17278 All these format variables can also be arbitrary elisp forms. In that
17279 case, they will be @code{eval}ed to insert the required lines.
17281 @kindex M-x gnus-update-format
17282 @findex gnus-update-format
17283 Gnus includes a command to help you while creating your own format
17284 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
17285 update the spec in question and pop you to a buffer where you can
17286 examine the resulting lisp code to be run to generate the line.
17290 @node Formatting Basics
17291 @subsection Formatting Basics
17293 Each @samp{%} element will be replaced by some string or other when the
17294 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
17295 spec, and pad with spaces to get a 5-character field''.
17297 As with normal C and Emacs Lisp formatting strings, the numerical
17298 modifier between the @samp{%} and the formatting type character will
17299 @dfn{pad} the output so that it is always at least that long.
17300 @samp{%5y} will make the field always (at least) five characters wide by
17301 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
17304 You may also wish to limit the length of the field to protect against
17305 particularly wide values. For that you can say @samp{%4,6y}, which
17306 means that the field will never be more than 6 characters wide and never
17307 less than 4 characters wide.
17310 @node Mode Line Formatting
17311 @subsection Mode Line Formatting
17313 Mode line formatting variables (e.g.,
17314 @code{gnus-summary-mode-line-format}) follow the same rules as other,
17315 buffer line oriented formatting variables (@pxref{Formatting Basics})
17316 with the following two differences:
17321 There must be no newline (@samp{\n}) at the end.
17324 The special @samp{%%b} spec can be used to display the buffer name.
17325 Well, it's no spec at all, really---@samp{%%} is just a way to quote
17326 @samp{%} to allow it to pass through the formatting machinery unmangled,
17327 so that Emacs receives @samp{%b}, which is something the Emacs mode line
17328 display interprets to mean ``show the buffer name''. For a full list of
17329 mode line specs Emacs understands, see the documentation of the
17330 @code{mode-line-format} variable.
17335 @node Advanced Formatting
17336 @subsection Advanced Formatting
17338 It is frequently useful to post-process the fields in some way.
17339 Padding, limiting, cutting off parts and suppressing certain values can
17340 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
17341 look like @samp{%~(cut 3)~(ignore "0")y}.
17343 These are the valid modifiers:
17348 Pad the field to the left with spaces until it reaches the required
17352 Pad the field to the right with spaces until it reaches the required
17357 Cut off characters from the left until it reaches the specified length.
17360 Cut off characters from the right until it reaches the specified
17365 Cut off the specified number of characters from the left.
17368 Cut off the specified number of characters from the right.
17371 Return an empty string if the field is equal to the specified value.
17374 Use the specified form as the field value when the @samp{@@} spec is
17378 Let's take an example. The @samp{%o} spec in the summary mode lines
17379 will return a date in compact ISO8601 format---@samp{19960809T230410}.
17380 This is quite a mouthful, so we want to shave off the century number and
17381 the time, leaving us with a six-character date. That would be
17382 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
17383 maxing, and we need the padding to ensure that the date is never less
17384 than 6 characters to make it look nice in columns.)
17386 Ignoring is done first; then cutting; then maxing; and then as the very
17387 last operation, padding.
17389 If you use lots of these advanced thingies, you'll find that Gnus gets
17390 quite slow. This can be helped enormously by running @kbd{M-x
17391 gnus-compile} when you are satisfied with the look of your lines.
17392 @xref{Compilation}.
17395 @node User-Defined Specs
17396 @subsection User-Defined Specs
17398 All the specs allow for inserting user defined specifiers---@samp{u}.
17399 The next character in the format string should be a letter. Gnus
17400 will call the function @code{gnus-user-format-function-}@samp{X}, where
17401 @samp{X} is the letter following @samp{%u}. The function will be passed
17402 a single parameter---what the parameter means depends on what buffer
17403 it's being called from. The function should return a string, which will
17404 be inserted into the buffer just like information from any other
17405 specifier. This function may also be called with dummy values, so it
17406 should protect against that.
17408 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
17409 much the same without defining new functions. Here's an example:
17410 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
17411 given here will be evaluated to yield the current line number, and then
17415 @node Formatting Fonts
17416 @subsection Formatting Fonts
17418 There are specs for highlighting, and these are shared by all the format
17419 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
17420 the special @code{mouse-face} property set, which means that it will be
17421 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
17424 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
17425 normal faces set using @code{gnus-face-0}, which is @code{bold} by
17426 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
17427 and so on. Create as many faces as you wish. The same goes for the
17428 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
17429 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
17431 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
17432 @code{balloon-help} property set to @code{gnus-balloon-face-0}. If you
17433 say @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The
17434 @code{gnus-balloon-face-*} variables should be either strings or symbols
17435 naming functions that return a string. Under @code{balloon-help-mode},
17436 when the mouse passes over text with this property set, a balloon window
17437 will appear and display the string. Please refer to the doc string of
17438 @code{balloon-help-mode} for more information on this.
17440 Here's an alternative recipe for the group buffer:
17443 ;; Create three face types.
17444 (setq gnus-face-1 'bold)
17445 (setq gnus-face-3 'italic)
17447 ;; We want the article count to be in
17448 ;; a bold and green face. So we create
17449 ;; a new face called `my-green-bold'.
17450 (copy-face 'bold 'my-green-bold)
17452 (set-face-foreground 'my-green-bold "ForestGreen")
17453 (setq gnus-face-2 'my-green-bold)
17455 ;; Set the new & fancy format.
17456 (setq gnus-group-line-format
17457 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
17460 I'm sure you'll be able to use this scheme to create totally unreadable
17461 and extremely vulgar displays. Have fun!
17463 Note that the @samp{%(} specs (and friends) do not make any sense on the
17464 mode-line variables.
17467 @node Windows Configuration
17468 @section Windows Configuration
17469 @cindex windows configuration
17471 No, there's nothing here about X, so be quiet.
17473 @vindex gnus-use-full-window
17474 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
17475 other windows and occupy the entire Emacs screen by itself. It is
17476 @code{t} by default.
17478 Setting this variable to @code{nil} kinda works, but there are
17479 glitches. Use at your own peril.
17481 @vindex gnus-buffer-configuration
17482 @code{gnus-buffer-configuration} describes how much space each Gnus
17483 buffer should be given. Here's an excerpt of this variable:
17486 ((group (vertical 1.0 (group 1.0 point)
17487 (if gnus-carpal (group-carpal 4))))
17488 (article (vertical 1.0 (summary 0.25 point)
17492 This is an alist. The @dfn{key} is a symbol that names some action or
17493 other. For instance, when displaying the group buffer, the window
17494 configuration function will use @code{group} as the key. A full list of
17495 possible names is listed below.
17497 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
17498 should occupy. To take the @code{article} split as an example -
17501 (article (vertical 1.0 (summary 0.25 point)
17505 This @dfn{split} says that the summary buffer should occupy 25% of upper
17506 half of the screen, and that it is placed over the article buffer. As
17507 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
17508 reaching for that calculator there). However, the special number
17509 @code{1.0} is used to signal that this buffer should soak up all the
17510 rest of the space available after the rest of the buffers have taken
17511 whatever they need. There should be only one buffer with the @code{1.0}
17512 size spec per split.
17514 Point will be put in the buffer that has the optional third element
17515 @code{point}. In a @code{frame} split, the last subsplit having a leaf
17516 split where the tag @code{frame-focus} is a member (i.e. is the third or
17517 fourth element in the list, depending on whether the @code{point} tag is
17518 present) gets focus.
17520 Here's a more complicated example:
17523 (article (vertical 1.0 (group 4)
17524 (summary 0.25 point)
17525 (if gnus-carpal (summary-carpal 4))
17529 If the size spec is an integer instead of a floating point number,
17530 then that number will be used to say how many lines a buffer should
17531 occupy, not a percentage.
17533 If the @dfn{split} looks like something that can be @code{eval}ed (to be
17534 precise---if the @code{car} of the split is a function or a subr), this
17535 split will be @code{eval}ed. If the result is non-@code{nil}, it will
17536 be used as a split. This means that there will be three buffers if
17537 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
17540 Not complicated enough for you? Well, try this on for size:
17543 (article (horizontal 1.0
17548 (summary 0.25 point)
17553 Whoops. Two buffers with the mystery 100% tag. And what's that
17554 @code{horizontal} thingie?
17556 If the first element in one of the split is @code{horizontal}, Gnus will
17557 split the window horizontally, giving you two windows side-by-side.
17558 Inside each of these strips you may carry on all you like in the normal
17559 fashion. The number following @code{horizontal} says what percentage of
17560 the screen is to be given to this strip.
17562 For each split, there @emph{must} be one element that has the 100% tag.
17563 The splitting is never accurate, and this buffer will eat any leftover
17564 lines from the splits.
17566 To be slightly more formal, here's a definition of what a valid split
17570 split = frame | horizontal | vertical | buffer | form
17571 frame = "(frame " size *split ")"
17572 horizontal = "(horizontal " size *split ")"
17573 vertical = "(vertical " size *split ")"
17574 buffer = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
17575 size = number | frame-params
17576 buffer-name = group | article | summary ...
17579 The limitations are that the @code{frame} split can only appear as the
17580 top-level split. @var{form} should be an Emacs Lisp form that should
17581 return a valid split. We see that each split is fully recursive, and
17582 may contain any number of @code{vertical} and @code{horizontal} splits.
17584 @vindex gnus-window-min-width
17585 @vindex gnus-window-min-height
17586 @cindex window height
17587 @cindex window width
17588 Finding the right sizes can be a bit complicated. No window may be less
17589 than @code{gnus-window-min-height} (default 1) characters high, and all
17590 windows must be at least @code{gnus-window-min-width} (default 1)
17591 characters wide. Gnus will try to enforce this before applying the
17592 splits. If you want to use the normal Emacs window width/height limit,
17593 you can just set these two variables to @code{nil}.
17595 If you're not familiar with Emacs terminology, @code{horizontal} and
17596 @code{vertical} splits may work the opposite way of what you'd expect.
17597 Windows inside a @code{horizontal} split are shown side-by-side, and
17598 windows within a @code{vertical} split are shown above each other.
17600 @findex gnus-configure-frame
17601 If you want to experiment with window placement, a good tip is to call
17602 @code{gnus-configure-frame} directly with a split. This is the function
17603 that does all the real work when splitting buffers. Below is a pretty
17604 nonsensical configuration with 5 windows; two for the group buffer and
17605 three for the article buffer. (I said it was nonsensical.) If you
17606 @code{eval} the statement below, you can get an idea of how that would
17607 look straight away, without going through the normal Gnus channels.
17608 Play with it until you're satisfied, and then use
17609 @code{gnus-add-configuration} to add your new creation to the buffer
17610 configuration list.
17613 (gnus-configure-frame
17617 (article 0.3 point))
17625 You might want to have several frames as well. No prob---just use the
17626 @code{frame} split:
17629 (gnus-configure-frame
17632 (summary 0.25 point frame-focus)
17634 (vertical ((height . 5) (width . 15)
17635 (user-position . t)
17636 (left . -1) (top . 1))
17641 This split will result in the familiar summary/article window
17642 configuration in the first (or ``main'') frame, while a small additional
17643 frame will be created where picons will be shown. As you can see,
17644 instead of the normal @code{1.0} top-level spec, each additional split
17645 should have a frame parameter alist as the size spec.
17646 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
17647 Reference Manual}. Under XEmacs, a frame property list will be
17648 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
17650 The list of all possible keys for @code{gnus-buffer-configuration} can
17651 be found in its default value.
17653 Note that the @code{message} key is used for both
17654 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
17655 it is desirable to distinguish between the two, something like this
17659 (message (horizontal 1.0
17660 (vertical 1.0 (message 1.0 point))
17662 (if (buffer-live-p gnus-summary-buffer)
17667 One common desire for a multiple frame split is to have a separate frame
17668 for composing mail and news while leaving the original frame intact. To
17669 accomplish that, something like the following can be done:
17672 (message (frame 1.0
17673 (if (not (buffer-live-p gnus-summary-buffer))
17674 (car (cdr (assoc 'group gnus-buffer-configuration)))
17675 (car (cdr (assoc 'summary gnus-buffer-configuration))))
17676 (vertical ((user-position . t) (top . 1) (left . 1)
17677 (name . "Message"))
17678 (message 1.0 point))))
17681 @findex gnus-add-configuration
17682 Since the @code{gnus-buffer-configuration} variable is so long and
17683 complicated, there's a function you can use to ease changing the config
17684 of a single setting: @code{gnus-add-configuration}. If, for instance,
17685 you want to change the @code{article} setting, you could say:
17688 (gnus-add-configuration
17689 '(article (vertical 1.0
17691 (summary .25 point)
17695 You'd typically stick these @code{gnus-add-configuration} calls in your
17696 @file{.gnus.el} file or in some startup hook---they should be run after
17697 Gnus has been loaded.
17699 @vindex gnus-always-force-window-configuration
17700 If all windows mentioned in the configuration are already visible, Gnus
17701 won't change the window configuration. If you always want to force the
17702 ``right'' window configuration, you can set
17703 @code{gnus-always-force-window-configuration} to non-@code{nil}.
17705 If you're using tree displays (@pxref{Tree Display}), and the tree
17706 window is displayed vertically next to another window, you may also want
17707 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
17710 @subsection Example Window Configurations
17714 Narrow left hand side occupied by group buffer. Right hand side split
17715 between summary buffer (top one-sixth) and article buffer (bottom).
17730 (gnus-add-configuration
17733 (vertical 25 (group 1.0))
17735 (summary 0.16 point)
17738 (gnus-add-configuration
17741 (vertical 25 (group 1.0))
17742 (vertical 1.0 (summary 1.0 point)))))
17748 @node Faces and Fonts
17749 @section Faces and Fonts
17754 Fiddling with fonts and faces used to be very difficult, but these days
17755 it is very simple. You simply say @kbd{M-x customize-face}, pick out
17756 the face you want to alter, and alter it via the standard Customize
17761 @section Compilation
17762 @cindex compilation
17763 @cindex byte-compilation
17765 @findex gnus-compile
17767 Remember all those line format specification variables?
17768 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
17769 on. Now, Gnus will of course heed whatever these variables are, but,
17770 unfortunately, changing them will mean a quite significant slow-down.
17771 (The default values of these variables have byte-compiled functions
17772 associated with them, while the user-generated versions do not, of
17775 To help with this, you can run @kbd{M-x gnus-compile} after you've
17776 fiddled around with the variables and feel that you're (kind of)
17777 satisfied. This will result in the new specs being byte-compiled, and
17778 you'll get top speed again. Gnus will save these compiled specs in the
17779 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
17780 this function, though---you should compile them yourself by sticking
17781 them into the @code{.gnus.el} file and byte-compiling that file.)
17785 @section Mode Lines
17788 @vindex gnus-updated-mode-lines
17789 @code{gnus-updated-mode-lines} says what buffers should keep their mode
17790 lines updated. It is a list of symbols. Supported symbols include
17791 @code{group}, @code{article}, @code{summary}, @code{server},
17792 @code{browse}, and @code{tree}. If the corresponding symbol is present,
17793 Gnus will keep that mode line updated with information that may be
17794 pertinent. If this variable is @code{nil}, screen refresh may be
17797 @cindex display-time
17799 @vindex gnus-mode-non-string-length
17800 By default, Gnus displays information on the current article in the mode
17801 lines of the summary and article buffers. The information Gnus wishes
17802 to display (e.g. the subject of the article) is often longer than the
17803 mode lines, and therefore have to be cut off at some point. The
17804 @code{gnus-mode-non-string-length} variable says how long the other
17805 elements on the line is (i.e., the non-info part). If you put
17806 additional elements on the mode line (e.g. a clock), you should modify
17809 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
17811 (add-hook 'display-time-hook
17812 (lambda () (setq gnus-mode-non-string-length
17814 (if line-number-mode 5 0)
17815 (if column-number-mode 4 0)
17816 (length display-time-string)))))
17819 If this variable is @code{nil} (which is the default), the mode line
17820 strings won't be chopped off, and they won't be padded either. Note
17821 that the default is unlikely to be desirable, as even the percentage
17822 complete in the buffer may be crowded off the mode line; the user should
17823 configure this variable appropriately for her configuration.
17826 @node Highlighting and Menus
17827 @section Highlighting and Menus
17829 @cindex highlighting
17832 @vindex gnus-visual
17833 The @code{gnus-visual} variable controls most of the Gnus-prettifying
17834 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
17835 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
17838 This variable can be a list of visual properties that are enabled. The
17839 following elements are valid, and are all included by default:
17842 @item group-highlight
17843 Do highlights in the group buffer.
17844 @item summary-highlight
17845 Do highlights in the summary buffer.
17846 @item article-highlight
17847 Do highlights in the article buffer.
17849 Turn on highlighting in all buffers.
17851 Create menus in the group buffer.
17853 Create menus in the summary buffers.
17855 Create menus in the article buffer.
17857 Create menus in the browse buffer.
17859 Create menus in the server buffer.
17861 Create menus in the score buffers.
17863 Create menus in all buffers.
17866 So if you only want highlighting in the article buffer and menus in all
17867 buffers, you could say something like:
17870 (setq gnus-visual '(article-highlight menu))
17873 If you want highlighting only and no menus whatsoever, you'd say:
17876 (setq gnus-visual '(highlight))
17879 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
17880 in all Gnus buffers.
17882 Other general variables that influence the look of all buffers include:
17885 @item gnus-mouse-face
17886 @vindex gnus-mouse-face
17887 This is the face (i.e., font) used for mouse highlighting in Gnus. No
17888 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
17892 There are hooks associated with the creation of all the different menus:
17896 @item gnus-article-menu-hook
17897 @vindex gnus-article-menu-hook
17898 Hook called after creating the article mode menu.
17900 @item gnus-group-menu-hook
17901 @vindex gnus-group-menu-hook
17902 Hook called after creating the group mode menu.
17904 @item gnus-summary-menu-hook
17905 @vindex gnus-summary-menu-hook
17906 Hook called after creating the summary mode menu.
17908 @item gnus-server-menu-hook
17909 @vindex gnus-server-menu-hook
17910 Hook called after creating the server mode menu.
17912 @item gnus-browse-menu-hook
17913 @vindex gnus-browse-menu-hook
17914 Hook called after creating the browse mode menu.
17916 @item gnus-score-menu-hook
17917 @vindex gnus-score-menu-hook
17918 Hook called after creating the score mode menu.
17929 Those new-fangled @dfn{mouse} contraptions is very popular with the
17930 young, hep kids who don't want to learn the proper way to do things
17931 these days. Why, I remember way back in the summer of '89, when I was
17932 using Emacs on a Tops 20 system. Three hundred users on one single
17933 machine, and every user was running Simula compilers. Bah!
17937 @vindex gnus-carpal
17938 Well, you can make Gnus display bufferfuls of buttons you can click to
17939 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
17940 really. Tell the chiropractor I sent you.
17945 @item gnus-carpal-mode-hook
17946 @vindex gnus-carpal-mode-hook
17947 Hook run in all carpal mode buffers.
17949 @item gnus-carpal-button-face
17950 @vindex gnus-carpal-button-face
17951 Face used on buttons.
17953 @item gnus-carpal-header-face
17954 @vindex gnus-carpal-header-face
17955 Face used on carpal buffer headers.
17957 @item gnus-carpal-group-buffer-buttons
17958 @vindex gnus-carpal-group-buffer-buttons
17959 Buttons in the group buffer.
17961 @item gnus-carpal-summary-buffer-buttons
17962 @vindex gnus-carpal-summary-buffer-buttons
17963 Buttons in the summary buffer.
17965 @item gnus-carpal-server-buffer-buttons
17966 @vindex gnus-carpal-server-buffer-buttons
17967 Buttons in the server buffer.
17969 @item gnus-carpal-browse-buffer-buttons
17970 @vindex gnus-carpal-browse-buffer-buttons
17971 Buttons in the browse buffer.
17974 All the @code{buttons} variables are lists. The elements in these list
17975 are either cons cells where the @code{car} contains a text to be displayed and
17976 the @code{cdr} contains a function symbol, or a simple string.
17984 Gnus, being larger than any program ever written (allegedly), does lots
17985 of strange stuff that you may wish to have done while you're not
17986 present. For instance, you may want it to check for new mail once in a
17987 while. Or you may want it to close down all connections to all servers
17988 when you leave Emacs idle. And stuff like that.
17990 Gnus will let you do stuff like that by defining various
17991 @dfn{handlers}. Each handler consists of three elements: A
17992 @var{function}, a @var{time}, and an @var{idle} parameter.
17994 Here's an example of a handler that closes connections when Emacs has
17995 been idle for thirty minutes:
17998 (gnus-demon-close-connections nil 30)
18001 Here's a handler that scans for PGP headers every hour when Emacs is
18005 (gnus-demon-scan-pgp 60 t)
18008 This @var{time} parameter and than @var{idle} parameter work together
18009 in a strange, but wonderful fashion. Basically, if @var{idle} is
18010 @code{nil}, then the function will be called every @var{time} minutes.
18012 If @var{idle} is @code{t}, then the function will be called after
18013 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
18014 the function will never be called. But once Emacs goes idle, the
18015 function will be called every @var{time} minutes.
18017 If @var{idle} is a number and @var{time} is a number, the function will
18018 be called every @var{time} minutes only when Emacs has been idle for
18019 @var{idle} minutes.
18021 If @var{idle} is a number and @var{time} is @code{nil}, the function
18022 will be called once every time Emacs has been idle for @var{idle}
18025 And if @var{time} is a string, it should look like @samp{07:31}, and
18026 the function will then be called once every day somewhere near that
18027 time. Modified by the @var{idle} parameter, of course.
18029 @vindex gnus-demon-timestep
18030 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
18031 seconds. This is 60 by default. If you change that variable,
18032 all the timings in the handlers will be affected.)
18034 So, if you want to add a handler, you could put something like this in
18035 your @file{.gnus} file:
18037 @findex gnus-demon-add-handler
18039 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
18042 @findex gnus-demon-add-nocem
18043 @findex gnus-demon-add-scanmail
18044 @findex gnus-demon-add-rescan
18045 @findex gnus-demon-add-scan-timestamps
18046 @findex gnus-demon-add-disconnection
18047 Some ready-made functions to do this have been created:
18048 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
18049 @code{gnus-demon-add-nntp-close-connection},
18050 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
18051 @code{gnus-demon-add-scanmail}. Just put those functions in your
18052 @file{.gnus} if you want those abilities.
18054 @findex gnus-demon-init
18055 @findex gnus-demon-cancel
18056 @vindex gnus-demon-handlers
18057 If you add handlers to @code{gnus-demon-handlers} directly, you should
18058 run @code{gnus-demon-init} to make the changes take hold. To cancel all
18059 daemons, you can use the @code{gnus-demon-cancel} function.
18061 Note that adding daemons can be pretty naughty if you over do it. Adding
18062 functions that scan all news and mail from all servers every two seconds
18063 is a sure-fire way of getting booted off any respectable system. So
18072 @dfn{Spamming} is posting the same article lots and lots of times.
18073 Spamming is bad. Spamming is evil.
18075 Spamming is usually canceled within a day or so by various anti-spamming
18076 agencies. These agencies usually also send out @dfn{NoCeM} messages.
18077 NoCeM is pronounced ``no see-'em'', and means what the name
18078 implies---these are messages that make the offending articles, like, go
18081 What use are these NoCeM messages if the articles are canceled anyway?
18082 Some sites do not honor cancel messages and some sites just honor cancels
18083 from a select few people. Then you may wish to make use of the NoCeM
18084 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
18086 Gnus can read and parse the messages in this group automatically, and
18087 this will make spam disappear.
18089 There are some variables to customize, of course:
18092 @item gnus-use-nocem
18093 @vindex gnus-use-nocem
18094 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
18097 @item gnus-nocem-groups
18098 @vindex gnus-nocem-groups
18099 Gnus will look for NoCeM messages in the groups in this list. The
18100 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
18101 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
18103 @item gnus-nocem-issuers
18104 @vindex gnus-nocem-issuers
18105 There are many people issuing NoCeM messages. This list says what
18106 people you want to listen to. The default is @code{("Automoose-1"
18107 "clewis@@ferret.ocunix.on.ca" "cosmo.roadkill" "SpamHippo"
18108 "hweede@@snafu.de")}; fine, upstanding citizens all of them.
18110 Known despammers that you can put in this list are listed at
18111 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
18113 You do not have to heed NoCeM messages from all these people---just the
18114 ones you want to listen to. You also don't have to accept all NoCeM
18115 messages from the people you like. Each NoCeM message has a @dfn{type}
18116 header that gives the message a (more or less, usually less) rigorous
18117 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
18118 @samp{binary}, and @samp{troll}. To specify this, you have to use
18119 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
18120 Each condition is either a string (which is a regexp that matches types
18121 you want to use) or a list on the form @code{(not @var{string})}, where
18122 @var{string} is a regexp that matches types you don't want to use.
18124 For instance, if you want all NoCeM messages from Chris Lewis except his
18125 @samp{troll} messages, you'd say:
18128 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
18131 On the other hand, if you just want nothing but his @samp{spam} and
18132 @samp{spew} messages, you'd say:
18135 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
18138 The specs are applied left-to-right.
18141 @item gnus-nocem-verifyer
18142 @vindex gnus-nocem-verifyer
18144 This should be a function for verifying that the NoCeM issuer is who she
18145 says she is. The default is @code{mc-verify}, which is a Mailcrypt
18146 function. If this is too slow and you don't care for verification
18147 (which may be dangerous), you can set this variable to @code{nil}.
18149 If you want signed NoCeM messages to be verified and unsigned messages
18150 not to be verified (but used anyway), you could do something like:
18153 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
18155 (defun my-gnus-mc-verify ()
18163 This might be dangerous, though.
18165 @item gnus-nocem-directory
18166 @vindex gnus-nocem-directory
18167 This is where Gnus will store its NoCeM cache files. The default is
18168 @file{~/News/NoCeM/}.
18170 @item gnus-nocem-expiry-wait
18171 @vindex gnus-nocem-expiry-wait
18172 The number of days before removing old NoCeM entries from the cache.
18173 The default is 15. If you make it shorter Gnus will be faster, but you
18174 might then see old spam.
18176 @item gnus-nocem-check-from
18177 @vindex gnus-nocem-check-from
18178 Non-@code{nil} means check for valid issuers in message bodies.
18179 Otherwise don't bother fetching articles unless their author matches a
18180 valid issuer; that is much faster if you are selective about the
18183 @item gnus-nocem-check-article-limit
18184 @vindex gnus-nocem-check-article-limit
18185 If non-@code{nil}, the maximum number of articles to check in any NoCeM
18186 group. NoCeM groups can be huge and very slow to process.
18190 Using NoCeM could potentially be a memory hog. If you have many living
18191 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
18192 big. If this is a problem, you should kill off all (or most) of your
18193 unsubscribed groups (@pxref{Subscription Commands}).
18200 It is very useful to be able to undo actions one has done. In normal
18201 Emacs buffers, it's easy enough---you just push the @code{undo} button.
18202 In Gnus buffers, however, it isn't that simple.
18204 The things Gnus displays in its buffer is of no value whatsoever to
18205 Gnus---it's all just data designed to look nice to the user.
18206 Killing a group in the group buffer with @kbd{C-k} makes the line
18207 disappear, but that's just a side-effect of the real action---the
18208 removal of the group in question from the internal Gnus structures.
18209 Undoing something like that can't be done by the normal Emacs
18210 @code{undo} function.
18212 Gnus tries to remedy this somewhat by keeping track of what the user
18213 does and coming up with actions that would reverse the actions the user
18214 takes. When the user then presses the @code{undo} key, Gnus will run
18215 the code to reverse the previous action, or the previous actions.
18216 However, not all actions are easily reversible, so Gnus currently offers
18217 a few key functions to be undoable. These include killing groups,
18218 yanking groups, and changing the list of read articles of groups.
18219 That's it, really. More functions may be added in the future, but each
18220 added function means an increase in data to be stored, so Gnus will
18221 never be totally undoable.
18223 @findex gnus-undo-mode
18224 @vindex gnus-use-undo
18226 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
18227 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
18228 default. The @kbd{M-C-_} key performs the @code{gnus-undo}
18229 command, which should feel kinda like the normal Emacs @code{undo}
18234 @section Moderation
18237 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
18238 It is not included in the standard Gnus package. Write a mail to
18239 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
18242 The moderation package is implemented as a minor mode for summary
18246 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
18249 in your @file{.gnus.el} file.
18251 If you are the moderator of @samp{rec.zoofle}, this is how it's
18256 You split your incoming mail by matching on
18257 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
18258 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
18261 You enter that group once in a while and post articles using the @kbd{e}
18262 (edit-and-post) or @kbd{s} (just send unedited) commands.
18265 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
18266 articles that weren't approved by you, you can cancel them with the
18270 To use moderation mode in these two groups, say:
18273 (setq gnus-moderated-list
18274 "^nnml:rec.zoofle$\\|^rec.zoofle$")
18278 @node XEmacs Enhancements
18279 @section XEmacs Enhancements
18282 XEmacs is able to display pictures and stuff, so Gnus has taken
18286 * Picons:: How to display pictures of what your reading.
18287 * Smileys:: Show all those happy faces the way they were meant to be shown.
18288 * Toolbar:: Click'n'drool.
18289 * XVarious:: Other XEmacsy Gnusey variables.
18302 So@dots{} You want to slow down your news reader even more! This is a
18303 good way to do so. Its also a great way to impress people staring
18304 over your shoulder as you read news.
18307 * Picon Basics:: What are picons and How do I get them.
18308 * Picon Requirements:: Don't go further if you aren't using XEmacs.
18309 * Easy Picons:: Displaying Picons---the easy way.
18310 * Hard Picons:: The way you should do it. You'll learn something.
18311 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
18316 @subsubsection Picon Basics
18318 What are Picons? To quote directly from the Picons Web site:
18327 @dfn{Picons} is short for ``personal icons''. They're small,
18328 constrained images used to represent users and domains on the net,
18329 organized into databases so that the appropriate image for a given
18330 e-mail address can be found. Besides users and domains, there are picon
18331 databases for Usenet newsgroups and weather forecasts. The picons are
18332 in either monochrome @code{XBM} format or color @code{XPM} and
18333 @code{GIF} formats.
18336 @vindex gnus-picons-piconsearch-url
18337 If you have a permanent connection to the Internet you can use Steve
18338 Kinzler's Picons Search engine by setting
18339 @code{gnus-picons-piconsearch-url} to the string @*
18340 @uref{http://www.cs.indiana.edu/picons/search.html}.
18342 @vindex gnus-picons-database
18343 Otherwise you need a local copy of his database. For instructions on
18344 obtaining and installing the picons databases, point your Web browser at @*
18345 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}. Gnus expects
18346 picons to be installed into a location pointed to by
18347 @code{gnus-picons-database}.
18350 @node Picon Requirements
18351 @subsubsection Picon Requirements
18353 To have Gnus display Picons for you, you must be running XEmacs
18354 19.13 or greater since all other versions of Emacs aren't yet able to
18357 Additionally, you must have @code{x} support compiled into XEmacs. To
18358 display color picons which are much nicer than the black & white one,
18359 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
18361 @vindex gnus-picons-convert-x-face
18362 If you want to display faces from @code{X-Face} headers, you should have
18363 the @code{xface} support compiled into XEmacs. Otherwise you must have
18364 the @code{netpbm} utilities installed, or munge the
18365 @code{gnus-picons-convert-x-face} variable to use something else.
18369 @subsubsection Easy Picons
18371 To enable displaying picons, simply put the following line in your
18372 @file{~/.gnus} file and start Gnus.
18375 (setq gnus-use-picons t)
18376 (setq gnus-treat-display-picons t)
18379 and make sure @code{gnus-picons-database} points to the directory
18380 containing the Picons databases.
18382 Alternatively if you want to use the web piconsearch engine add this:
18385 (setq gnus-picons-piconsearch-url
18386 "http://www.cs.indiana.edu:800/piconsearch")
18391 @subsubsection Hard Picons
18399 Gnus can display picons for you as you enter and leave groups and
18400 articles. It knows how to interact with three sections of the picons
18401 database. Namely, it can display the picons newsgroup pictures,
18402 author's face picture(s), and the authors domain. To enable this
18403 feature, you need to select where to get the picons from, and where to
18408 @item gnus-picons-database
18409 @vindex gnus-picons-database
18410 The location of the picons database. Should point to a directory
18411 containing the @file{news}, @file{domains}, @file{users} (and so on)
18412 subdirectories. This is only useful if
18413 @code{gnus-picons-piconsearch-url} is @code{nil}. Defaults to
18414 @file{/usr/local/faces/}.
18416 @item gnus-picons-piconsearch-url
18417 @vindex gnus-picons-piconsearch-url
18418 The URL for the web picons search engine. The only currently known
18419 engine is @uref{http://www.cs.indiana.edu:800/piconsearch}. To
18420 workaround network delays, icons will be fetched in the background. If
18421 this is @code{nil} 'the default), then picons are fetched from local
18422 database indicated by @code{gnus-picons-database}.
18424 @item gnus-picons-display-where
18425 @vindex gnus-picons-display-where
18426 Where the picon images should be displayed. It is @code{picons} by
18427 default (which by default maps to the buffer @samp{*Picons*}). Other
18428 valid places could be @code{article}, @code{summary}, or
18429 @samp{*scratch*} for all I care. Just make sure that you've made the
18430 buffer visible using the standard Gnus window configuration
18431 routines---@pxref{Windows Configuration}.
18433 @item gnus-picons-group-excluded-groups
18434 @vindex gnus-picons-group-excluded-groups
18435 Groups that are matched by this regexp won't have their group icons
18440 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
18441 window configuration for you to include the @code{picons} buffer.
18443 Now that you've made those decision, you need to add the following
18444 functions to the appropriate hooks so these pictures will get displayed
18447 @vindex gnus-picons-display-where
18449 @item gnus-article-display-picons
18450 @findex gnus-article-display-picons
18451 Looks up and displays the picons for the author and the author's domain
18452 in the @code{gnus-picons-display-where} buffer.
18454 @item gnus-picons-article-display-x-face
18455 @findex gnus-article-display-picons
18456 Decodes and displays the X-Face header if present.
18462 @node Picon Useless Configuration
18463 @subsubsection Picon Useless Configuration
18471 The following variables offer further control over how things are
18472 done, where things are located, and other useless stuff you really
18473 don't need to worry about.
18477 @item gnus-picons-news-directories
18478 @vindex gnus-picons-news-directories
18479 List of subdirectories to search in @code{gnus-picons-database} for
18480 newsgroups faces. @code{("news")} is the default.
18482 @item gnus-picons-user-directories
18483 @vindex gnus-picons-user-directories
18484 List of subdirectories to search in @code{gnus-picons-database} for user
18485 faces. @code{("local" "users" "usenix" "misc")} is the default.
18487 @item gnus-picons-domain-directories
18488 @vindex gnus-picons-domain-directories
18489 List of subdirectories to search in @code{gnus-picons-database} for
18490 domain name faces. Defaults to @code{("domains")}. Some people may
18491 want to add @samp{"unknown"} to this list.
18493 @item gnus-picons-convert-x-face
18494 @vindex gnus-picons-convert-x-face
18495 If you don't have @code{xface} support builtin XEmacs, this is the
18496 command to use to convert the @code{X-Face} header to an X bitmap
18497 (@code{xbm}). Defaults to @code{(format "@{ echo '/* Width=48,
18498 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
18499 gnus-picons-x-face-file-name)}
18501 @item gnus-picons-x-face-file-name
18502 @vindex gnus-picons-x-face-file-name
18503 Names a temporary file to store the @code{X-Face} bitmap in. Defaults
18504 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
18506 @item gnus-picons-has-modeline-p
18507 @vindex gnus-picons-has-modeline-p
18508 If you have set @code{gnus-picons-display-where} to @code{picons}, your
18509 XEmacs frame will become really cluttered. To alleviate this a bit you
18510 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
18511 remove the mode line from the Picons buffer. This is only useful if
18512 @code{gnus-picons-display-where} is @code{picons}.
18514 @item gnus-picons-refresh-before-display
18515 @vindex gnus-picons-refresh-before-display
18516 If non-nil, display the article buffer before computing the picons.
18517 Defaults to @code{nil}.
18519 @item gnus-picons-display-as-address
18520 @vindex gnus-picons-display-as-address
18521 If @code{t} display textual email addresses along with pictures.
18522 Defaults to @code{t}.
18524 @item gnus-picons-file-suffixes
18525 @vindex gnus-picons-file-suffixes
18526 Ordered list of suffixes on picon file names to try. Defaults to
18527 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
18529 @item gnus-picons-setup-hook
18530 @vindex gnus-picons-setup-hook
18531 Hook run in the picon buffer, if that is displayed.
18533 @item gnus-picons-display-article-move-p
18534 @vindex gnus-picons-display-article-move-p
18535 Whether to move point to first empty line when displaying picons. This
18536 has only an effect if `gnus-picons-display-where' has value `article'.
18538 If @code{nil}, display the picons in the @code{From} and
18539 @code{Newsgroups} lines. This is the default.
18541 @item gnus-picons-clear-cache-on-shutdown
18542 @vindex gnus-picons-clear-cache-on-shutdown
18543 Whether to clear the picons cache when exiting gnus. Gnus caches every
18544 picons it finds while it is running. This saves some time in the search
18545 process but eats some memory. If this variable is set to @code{nil},
18546 Gnus will never clear the cache itself; you will have to manually call
18547 @code{gnus-picons-clear-cache} to clear it. Otherwise the cache will be
18548 cleared every time you exit Gnus. Defaults to @code{t}.
18559 @subsection Smileys
18564 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
18569 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
18570 currently the only package that uses Smiley, it is documented here.
18572 In short---to use Smiley in Gnus, put the following in your
18573 @file{.gnus.el} file:
18576 (setq gnus-treat-display-smileys t)
18579 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
18580 the like---to pictures and displays those instead of the text smiley
18581 faces. The conversion is controlled by a list of regexps that matches
18582 text and maps that to file names.
18584 @vindex smiley-nosey-regexp-alist
18585 @vindex smiley-deformed-regexp-alist
18586 Smiley supplies two example conversion alists by default:
18587 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
18588 and so on), and @code{smiley-nosey-regexp-alist} (which matches
18589 @samp{:-)}, @samp{:-(} and so on).
18591 The alist used is specified by the @code{smiley-regexp-alist} variable,
18592 which defaults to the value of @code{smiley-deformed-regexp-alist}.
18594 The first item in each element is the regexp to be matched; the second
18595 element is the regexp match group that is to be replaced by the picture;
18596 and the third element is the name of the file to be displayed.
18598 The following variables customize where Smiley will look for these
18599 files, as well as the color to be used and stuff:
18603 @item smiley-data-directory
18604 @vindex smiley-data-directory
18605 Where Smiley will look for smiley faces files.
18607 @item smiley-flesh-color
18608 @vindex smiley-flesh-color
18609 Skin color. The default is @samp{yellow}, which is really racist.
18611 @item smiley-features-color
18612 @vindex smiley-features-color
18613 Color of the features of the face. The default is @samp{black}.
18615 @item smiley-tongue-color
18616 @vindex smiley-tongue-color
18617 Color of the tongue. The default is @samp{red}.
18619 @item smiley-circle-color
18620 @vindex smiley-circle-color
18621 Color of the circle around the face. The default is @samp{black}.
18623 @item smiley-mouse-face
18624 @vindex smiley-mouse-face
18625 Face used for mouse highlighting over the smiley face.
18631 @subsection Toolbar
18641 @item gnus-use-toolbar
18642 @vindex gnus-use-toolbar
18643 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
18644 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
18645 @code{right-toolbar}, or @code{left-toolbar}.
18647 @item gnus-group-toolbar
18648 @vindex gnus-group-toolbar
18649 The toolbar in the group buffer.
18651 @item gnus-summary-toolbar
18652 @vindex gnus-summary-toolbar
18653 The toolbar in the summary buffer.
18655 @item gnus-summary-mail-toolbar
18656 @vindex gnus-summary-mail-toolbar
18657 The toolbar in the summary buffer of mail groups.
18663 @subsection Various XEmacs Variables
18666 @item gnus-xmas-glyph-directory
18667 @vindex gnus-xmas-glyph-directory
18668 This is where Gnus will look for pictures. Gnus will normally
18669 auto-detect this directory, but you may set it manually if you have an
18670 unusual directory structure.
18672 @item gnus-xmas-logo-color-alist
18673 @vindex gnus-xmas-logo-color-alist
18674 This is an alist where the key is a type symbol and the values are the
18675 foreground and background color of the splash page glyph.
18677 @item gnus-xmas-logo-color-style
18678 @vindex gnus-xmas-logo-color-style
18679 This is the key used to look up the color in the alist described above.
18680 Valid values include @code{flame}, @code{pine}, @code{moss},
18681 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
18682 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
18684 @item gnus-xmas-modeline-glyph
18685 @vindex gnus-xmas-modeline-glyph
18686 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
18700 @node Fuzzy Matching
18701 @section Fuzzy Matching
18702 @cindex fuzzy matching
18704 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
18705 things like scoring, thread gathering and thread comparison.
18707 As opposed to regular expression matching, fuzzy matching is very fuzzy.
18708 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
18709 means, and the implementation has changed over time.
18711 Basically, it tries to remove all noise from lines before comparing.
18712 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
18713 out of the strings before comparing the results. This often leads to
18714 adequate results---even when faced with strings generated by text
18715 manglers masquerading as newsreaders.
18718 @node Thwarting Email Spam
18719 @section Thwarting Email Spam
18723 @cindex unsolicited commercial email
18725 In these last days of the Usenet, commercial vultures are hanging about
18726 and grepping through news like crazy to find email addresses they can
18727 foist off their scams and products to. As a reaction to this, many
18728 people have started putting nonsense addresses into their @code{From}
18729 lines. I think this is counterproductive---it makes it difficult for
18730 people to send you legitimate mail in response to things you write, as
18731 well as making it difficult to see who wrote what. This rewriting may
18732 perhaps be a bigger menace than the unsolicited commercial email itself
18735 The biggest problem I have with email spam is that it comes in under
18736 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
18737 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
18738 mail group, only to find two pyramid schemes, seven advertisements
18739 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
18740 and one mail asking me to repent and find some god.
18744 The way to deal with this is having Gnus split out all spam into a
18745 @samp{spam} mail group (@pxref{Splitting Mail}).
18747 First, pick one (1) valid mail address that you can be reached at, and
18748 put it in your @code{From} header of all your news articles. (I've
18749 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
18750 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
18751 sysadmin whether your sendmail installation accepts keywords in the local
18752 part of the mail address.)
18755 (setq message-default-news-headers
18756 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
18759 Then put the following split rule in @code{nnmail-split-fancy}
18760 (@pxref{Fancy Mail Splitting}):
18765 (to "larsi@@trym.ifi.uio.no"
18766 (| ("subject" "re:.*" "misc")
18767 ("references" ".*@@.*" "misc")
18773 This says that all mail to this address is suspect, but if it has a
18774 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
18775 header, it's probably ok. All the rest goes to the @samp{spam} group.
18776 (This idea probably comes from Tim Pierce.)
18778 In addition, many mail spammers talk directly to your @code{smtp} server
18779 and do not include your email address explicitly in the @code{To}
18780 header. Why they do this is unknown---perhaps it's to thwart this
18781 thwarting scheme? In any case, this is trivial to deal with---you just
18782 put anything not addressed to you in the @samp{spam} group by ending
18783 your fancy split rule in this way:
18788 (to "larsi" "misc")
18792 In my experience, this will sort virtually everything into the right
18793 group. You still have to check the @samp{spam} group from time to time to
18794 check for legitimate mail, though. If you feel like being a good net
18795 citizen, you can even send off complaints to the proper authorities on
18796 each unsolicited commercial email---at your leisure.
18798 If you are also a lazy net citizen, you will probably prefer complaining
18799 automatically with the @file{gnus-junk.el} package, available FOR FREE
18800 at @* @uref{http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html}.
18801 Since most e-mail spam is sent automatically, this may reconcile the
18802 cosmic balance somewhat.
18804 This works for me. It allows people an easy way to contact me (they can
18805 just press @kbd{r} in the usual way), and I'm not bothered at all with
18806 spam. It's a win-win situation. Forging @code{From} headers to point
18807 to non-existent domains is yucky, in my opinion.
18810 @node Various Various
18811 @section Various Various
18817 @item gnus-home-directory
18818 All Gnus path variables will be initialized from this variable, which
18819 defaults to @file{~/}.
18821 @item gnus-directory
18822 @vindex gnus-directory
18823 Most Gnus storage path variables will be initialized from this variable,
18824 which defaults to the @samp{SAVEDIR} environment variable, or
18825 @file{~/News/} if that variable isn't set.
18827 Note that Gnus is mostly loaded when the @file{.gnus.el} file is read.
18828 This means that other directory variables that are initialized from this
18829 variable won't be set properly if you set this variable in
18830 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
18832 @item gnus-default-directory
18833 @vindex gnus-default-directory
18834 Not related to the above variable at all---this variable says what the
18835 default directory of all Gnus buffers should be. If you issue commands
18836 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
18837 default directory. If this variable is @code{nil} (which is the
18838 default), the default directory will be the default directory of the
18839 buffer you were in when you started Gnus.
18842 @vindex gnus-verbose
18843 This variable is an integer between zero and ten. The higher the value,
18844 the more messages will be displayed. If this variable is zero, Gnus
18845 will never flash any messages, if it is seven (which is the default),
18846 most important messages will be shown, and if it is ten, Gnus won't ever
18847 shut up, but will flash so many messages it will make your head swim.
18849 @item gnus-verbose-backends
18850 @vindex gnus-verbose-backends
18851 This variable works the same way as @code{gnus-verbose}, but it applies
18852 to the Gnus backends instead of Gnus proper.
18854 @item nnheader-max-head-length
18855 @vindex nnheader-max-head-length
18856 When the backends read straight heads of articles, they all try to read
18857 as little as possible. This variable (default 4096) specifies
18858 the absolute max length the backends will try to read before giving up
18859 on finding a separator line between the head and the body. If this
18860 variable is @code{nil}, there is no upper read bound. If it is
18861 @code{t}, the backends won't try to read the articles piece by piece,
18862 but read the entire articles. This makes sense with some versions of
18863 @code{ange-ftp} or @code{efs}.
18865 @item nnheader-head-chop-length
18866 @vindex nnheader-head-chop-length
18867 This variable (default 2048) says how big a piece of each article to
18868 read when doing the operation described above.
18870 @item nnheader-file-name-translation-alist
18871 @vindex nnheader-file-name-translation-alist
18873 @cindex invalid characters in file names
18874 @cindex characters in file names
18875 This is an alist that says how to translate characters in file names.
18876 For instance, if @samp{:} is invalid as a file character in file names
18877 on your system (you OS/2 user you), you could say something like:
18880 (setq nnheader-file-name-translation-alist
18884 In fact, this is the default value for this variable on OS/2 and MS
18885 Windows (phooey) systems.
18887 @item gnus-hidden-properties
18888 @vindex gnus-hidden-properties
18889 This is a list of properties to use to hide ``invisible'' text. It is
18890 @code{(invisible t intangible t)} by default on most systems, which
18891 makes invisible text invisible and intangible.
18893 @item gnus-parse-headers-hook
18894 @vindex gnus-parse-headers-hook
18895 A hook called before parsing headers. It can be used, for instance, to
18896 gather statistics on the headers fetched, or perhaps you'd like to prune
18897 some headers. I don't see why you'd want that, though.
18899 @item gnus-shell-command-separator
18900 @vindex gnus-shell-command-separator
18901 String used to separate two shell commands. The default is @samp{;}.
18903 @item gnus-invalid-group-regexp
18904 @vindex gnus-invalid-group-regexp
18906 Regexp to match ``invalid'' group names when querying user for a group
18907 name. The default value catches some @strong{really} invalid group
18908 names who could possibly mess up Gnus internally (like allowing
18909 @samp{:} in a group name, which is normally used to delimit method and
18912 @sc{imap} users might want to allow @samp{/} in group names though.
18921 Well, that's the manual---you can get on with your life now. Keep in
18922 touch. Say hello to your cats from me.
18924 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
18926 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
18932 Not because of victories @*
18935 but for the common sunshine,@*
18937 the largess of the spring.
18941 but for the day's work done@*
18942 as well as I was able;@*
18943 not for a seat upon the dais@*
18944 but at the common table.@*
18949 @chapter Appendices
18952 * History:: How Gnus got where it is today.
18953 * On Writing Manuals:: Why this is not a beginner's guide.
18954 * Terminology:: We use really difficult, like, words here.
18955 * Customization:: Tailoring Gnus to your needs.
18956 * Troubleshooting:: What you might try if things do not work.
18957 * Gnus Reference Guide:: Rilly, rilly technical stuff.
18958 * Emacs for Heathens:: A short introduction to Emacsian terms.
18959 * Frequently Asked Questions:: A question-and-answer session.
18967 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
18968 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
18970 If you want to investigate the person responsible for this outrage,
18971 you can point your (feh!) web browser to
18972 @uref{http://quimby.gnus.org/}. This is also the primary
18973 distribution point for the new and spiffy versions of Gnus, and is
18974 known as The Site That Destroys Newsrcs And Drives People Mad.
18976 During the first extended alpha period of development, the new Gnus was
18977 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
18978 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
18979 (Besides, the ``Gnus'' in this abbreviation should probably be
18980 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
18981 appropriate name, don't you think?)
18983 In any case, after spending all that energy on coming up with a new and
18984 spunky name, we decided that the name was @emph{too} spunky, so we
18985 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
18986 ``@sc{gnus}''. New vs. old.
18989 * Gnus Versions:: What Gnus versions have been released.
18990 * Other Gnus Versions:: Other Gnus versions that also have been released.
18991 * Why?:: What's the point of Gnus?
18992 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
18993 * Conformity:: Gnus tries to conform to all standards.
18994 * Emacsen:: Gnus can be run on a few modern Emacsen.
18995 * Gnus Development:: How Gnus is developed.
18996 * Contributors:: Oodles of people.
18997 * New Features:: Pointers to some of the new stuff in Gnus.
19001 @node Gnus Versions
19002 @subsection Gnus Versions
19003 @cindex Pterodactyl Gnus
19005 @cindex September Gnus
19006 @cindex Quassia Gnus
19008 The first ``proper'' release of Gnus 5 was done in November 1995 when it
19009 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
19010 plus 15 Gnus 5.0 releases).
19012 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
19013 releases)) was released under the name ``Gnus 5.2'' (40 releases).
19015 On July 28th 1996 work on Red Gnus was begun, and it was released on
19016 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
19018 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
19019 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
19021 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
19022 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
19025 On the 26th of October 2000, Oort Gnus was begun.
19027 If you happen upon a version of Gnus that has a prefixed name --
19028 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
19029 ``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic. Don't let it know
19030 that you're frightened. Back away. Slowly. Whatever you do, don't
19031 run. Walk away, calmly, until you're out of its reach. Find a proper
19032 released version of Gnus and snuggle up to that instead.
19035 @node Other Gnus Versions
19036 @subsection Other Gnus Versions
19039 In addition to the versions of Gnus which have had their releases
19040 coordinated by Lars, one major development has been Semi-gnus from
19041 Japan. It's based on a library called @sc{semi}, which provides
19042 @sc{mime} capabilities.
19044 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
19045 Collectively, they are called ``Semi-gnus'', and different strains are
19046 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
19047 @sc{mime} and multilingualization things, especially important for
19054 What's the point of Gnus?
19056 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
19057 newsreader, that lets you do anything you can think of. That was my
19058 original motivation, but while working on Gnus, it has become clear to
19059 me that this generation of newsreaders really belong in the stone age.
19060 Newsreaders haven't developed much since the infancy of the net. If the
19061 volume continues to rise with the current rate of increase, all current
19062 newsreaders will be pretty much useless. How do you deal with
19063 newsgroups that have thousands of new articles each day? How do you
19064 keep track of millions of people who post?
19066 Gnus offers no real solutions to these questions, but I would very much
19067 like to see Gnus being used as a testing ground for new methods of
19068 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
19069 to separate the newsreader from the backends, Gnus now offers a simple
19070 interface for anybody who wants to write new backends for fetching mail
19071 and news from different sources. I have added hooks for customizations
19072 everywhere I could imagine it being useful. By doing so, I'm inviting
19073 every one of you to explore and invent.
19075 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
19076 @kbd{C-u 100 M-x all-hail-xemacs}.
19079 @node Compatibility
19080 @subsection Compatibility
19082 @cindex compatibility
19083 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
19084 bindings have been kept. More key bindings have been added, of course,
19085 but only in one or two obscure cases have old bindings been changed.
19090 @center In a cloud bones of steel.
19094 All commands have kept their names. Some internal functions have changed
19097 The @code{gnus-uu} package has changed drastically. @xref{Decoding
19100 One major compatibility question is the presence of several summary
19101 buffers. All variables relevant while reading a group are
19102 buffer-local to the summary buffer they belong in. Although many
19103 important variables have their values copied into their global
19104 counterparts whenever a command is executed in the summary buffer, this
19105 change might lead to incorrect values being used unless you are careful.
19107 All code that relies on knowledge of @sc{gnus} internals will probably
19108 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
19109 changing it in any way, as a matter of fact) is strictly verboten. Gnus
19110 maintains a hash table that points to the entries in this alist (which
19111 speeds up many functions), and changing the alist directly will lead to
19115 @cindex highlighting
19116 Old hilit19 code does not work at all. In fact, you should probably
19117 remove all hilit code from all Gnus hooks
19118 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
19119 Gnus provides various integrated functions for highlighting. These are
19120 faster and more accurate. To make life easier for everybody, Gnus will
19121 by default remove all hilit calls from all hilit hooks. Uncleanliness!
19124 Packages like @code{expire-kill} will no longer work. As a matter of
19125 fact, you should probably remove all old @sc{gnus} packages (and other
19126 code) when you start using Gnus. More likely than not, Gnus already
19127 does what you have written code to make @sc{gnus} do. (Snicker.)
19129 Even though old methods of doing things are still supported, only the
19130 new methods are documented in this manual. If you detect a new method of
19131 doing something while reading this manual, that does not mean you have
19132 to stop doing it the old way.
19134 Gnus understands all @sc{gnus} startup files.
19136 @kindex M-x gnus-bug
19138 @cindex reporting bugs
19140 Overall, a casual user who hasn't written much code that depends on
19141 @sc{gnus} internals should suffer no problems. If problems occur,
19142 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
19144 @vindex gnus-bug-create-help-buffer
19145 If you are in the habit of sending bug reports @emph{very} often, you
19146 may find the helpful help buffer annoying after a while. If so, set
19147 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
19152 @subsection Conformity
19154 No rebels without a clue here, ma'am. We conform to all standards known
19155 to (wo)man. Except for those standards and/or conventions we disagree
19162 There are no known breaches of this standard.
19166 There are no known breaches of this standard, either.
19168 @item Son-of-RFC 1036
19169 @cindex Son-of-RFC 1036
19170 We do have some breaches to this one.
19176 These are considered to be ``vanity headers'', while I consider them
19177 to be consumer information. After seeing so many badly formatted
19178 articles coming from @code{tin} and @code{Netscape} I know not to use
19179 either of those for posting articles. I would not have known that if
19180 it wasn't for the @code{X-Newsreader} header.
19185 USEFOR is an IETF working group writing a successor to RFC 1036, based
19186 on Son-of-RFC 1036. They have produced a number of drafts proposing
19187 various changes to the format of news articles. The Gnus towers will
19188 look into implementing the changes when the draft is accepted as an RFC.
19192 If you ever notice Gnus acting non-compliant with regards to the texts
19193 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
19198 @subsection Emacsen
19204 Gnus should work on :
19212 XEmacs 20.4 and up.
19216 This Gnus version will absolutely not work on any Emacsen older than
19217 that. Not reliably, at least. Older versions of Gnus may work on older
19220 There are some vague differences between Gnus on the various
19221 platforms---XEmacs features more graphics (a logo and a toolbar)---but
19222 other than that, things should look pretty much the same under all
19226 @node Gnus Development
19227 @subsection Gnus Development
19229 Gnus is developed in a two-phased cycle. The first phase involves much
19230 discussion on the @samp{ding@@gnus.org} mailing list, where people
19231 propose changes and new features, post patches and new backends. This
19232 phase is called the @dfn{alpha} phase, since the Gnusae released in this
19233 phase are @dfn{alpha releases}, or (perhaps more commonly in other
19234 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
19235 unstable and should not be used by casual users. Gnus alpha releases
19236 have names like ``Red Gnus'' and ``Quassia Gnus''.
19238 After futzing around for 50-100 alpha releases, Gnus is declared
19239 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
19240 and is called things like ``Gnus 5.6.32'' instead. Normal people are
19241 supposed to be able to use these, and these are mostly discussed on the
19242 @samp{gnu.emacs.gnus} newsgroup.
19245 @vindex mail-source-delete-incoming
19246 Some variable defaults differ between alpha Gnusae and released Gnusae.
19247 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
19248 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
19249 lossage of mail if an alpha release hiccups while handling the mail.
19251 The division of discussion between the ding mailing list and the Gnus
19252 newsgroup is not purely based on publicity concerns. It's true that
19253 having people write about the horrible things that an alpha Gnus release
19254 can do (sometimes) in a public forum may scare people off, but more
19255 importantly, talking about new experimental features that have been
19256 introduced may confuse casual users. New features are frequently
19257 introduced, fiddled with, and judged to be found wanting, and then
19258 either discarded or totally rewritten. People reading the mailing list
19259 usually keep up with these rapid changes, while people on the newsgroup
19260 can't be assumed to do so.
19265 @subsection Contributors
19266 @cindex contributors
19268 The new Gnus version couldn't have been done without the help of all the
19269 people on the (ding) mailing list. Every day for over a year I have
19270 gotten billions of nice bug reports from them, filling me with joy,
19271 every single one of them. Smooches. The people on the list have been
19272 tried beyond endurance, what with my ``oh, that's a neat idea <type
19273 type>, yup, I'll release it right away <ship off> no wait, that doesn't
19274 work at all <type type>, yup, I'll ship that one off right away <ship
19275 off> no, wait, that absolutely does not work'' policy for releases.
19276 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
19277 ``worser''? ``much worser''? ``worsest''?)
19279 I would like to take this opportunity to thank the Academy for... oops,
19285 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
19288 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
19289 nnwarchive and many, many other things connected with @sc{mime} and
19290 other types of en/decoding, as well as general bug fixing, new
19291 functionality and stuff.
19294 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
19295 well as numerous other things).
19298 Luis Fernandes---design and graphics.
19301 Justin Sheehy--the FAQ maintainer.
19304 Erik Naggum---help, ideas, support, code and stuff.
19307 Wes Hardaker---@file{gnus-picon.el} and the manual section on
19308 @dfn{picons} (@pxref{Picons}).
19311 Kim-Minh Kaplan---further work on the picon code.
19314 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
19315 (@pxref{GroupLens}).
19318 Sudish Joseph---innumerable bug fixes.
19321 Ilja Weis---@file{gnus-topic.el}.
19324 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
19327 Vladimir Alexiev---the refcard and reference booklets.
19330 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
19331 distribution by Felix Lee and JWZ.
19334 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
19337 Peter Mutsaers---orphan article scoring code.
19340 Ken Raeburn---POP mail support.
19343 Hallvard B Furuseth---various bits and pieces, especially dealing with
19347 Brian Edmonds---@file{gnus-bbdb.el}.
19350 David Moore---rewrite of @file{nnvirtual.el} and many other things.
19353 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
19356 François Pinard---many, many interesting and thorough bug reports, as
19357 well as autoconf support.
19361 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
19362 Borges, and Jost Krieger proof-reading parts of the manual.
19364 The following people have contributed many patches and suggestions:
19373 Jason L. Tibbitts, III,
19377 Also thanks to the following for patches and stuff:
19387 Alexei V. Barantsev,
19402 Massimo Campostrini,
19407 Jae-you Chung, @c ?
19408 James H. Cloos, Jr.,
19412 Andrew J. Cosgriff,
19415 Geoffrey T. Dairiki,
19421 Michael Welsh Duggan,
19426 Enami Tsugutomo, @c Enami
19430 Nelson Jose dos Santos Ferreira,
19438 Arne Georg Gleditsch,
19440 Michelangelo Grigni,
19444 Kenichi Handa, @c Handa
19446 Yoshiki Hayashi, @c ?
19448 Hisashige Kenji, @c Hisashige
19455 François Felix Ingrand,
19456 Tatsuya Ichikawa, @c ?
19457 Ishikawa Ichiro, @c Ishikawa
19459 Iwamuro Motonori, @c Iwamuro
19470 Peter Skov Knudsen,
19471 Shuhei Kobayashi, @c Kobayashi
19473 Koseki Yoshinori, @c Koseki
19474 Thor Kristoffersen,
19477 Seokchan Lee, @c Lee
19495 Morioka Tomohiko, @c Morioka
19496 Erik Toubro Nielsen,
19503 Masaharu Onishi, @c Onishi
19508 Jens-Ulrik Holger Petersen,
19512 John McClary Prevost,
19518 Lars Balker Rasmussen,
19523 Christian von Roques,
19526 Wolfgang Rupprecht,
19533 Philippe Schnoebelen,
19535 Randal L. Schwartz,
19549 Kiyokazu Suto, @c Suto
19554 Tozawa Akihiko, @c Tozawa
19570 Katsumi Yamaoka @c Yamaoka
19575 For a full overview of what each person has done, the ChangeLogs
19576 included in the Gnus alpha distributions should give ample reading
19577 (550kB and counting).
19579 Apologies to everybody that I've forgotten, of which there are many, I'm
19582 Gee, that's quite a list of people. I guess that must mean that there
19583 actually are people who are using Gnus. Who'd'a thunk it!
19587 @subsection New Features
19588 @cindex new features
19591 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
19592 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
19593 * Red Gnus:: Third time best---Gnus 5.4/5.5.
19594 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
19595 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
19598 These lists are, of course, just @emph{short} overviews of the
19599 @emph{most} important new features. No, really. There are tons more.
19600 Yes, we have feeping creaturism in full effect.
19603 @subsubsection (ding) Gnus
19605 New features in Gnus 5.0/5.1:
19610 The look of all buffers can be changed by setting format-like variables
19611 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
19614 Local spool and several @sc{nntp} servers can be used at once
19615 (@pxref{Select Methods}).
19618 You can combine groups into virtual groups (@pxref{Virtual Groups}).
19621 You can read a number of different mail formats (@pxref{Getting Mail}).
19622 All the mail backends implement a convenient mail expiry scheme
19623 (@pxref{Expiring Mail}).
19626 Gnus can use various strategies for gathering threads that have lost
19627 their roots (thereby gathering loose sub-threads into one thread) or it
19628 can go back and retrieve enough headers to build a complete thread
19629 (@pxref{Customizing Threading}).
19632 Killed groups can be displayed in the group buffer, and you can read
19633 them as well (@pxref{Listing Groups}).
19636 Gnus can do partial group updates---you do not have to retrieve the
19637 entire active file just to check for new articles in a few groups
19638 (@pxref{The Active File}).
19641 Gnus implements a sliding scale of subscribedness to groups
19642 (@pxref{Group Levels}).
19645 You can score articles according to any number of criteria
19646 (@pxref{Scoring}). You can even get Gnus to find out how to score
19647 articles for you (@pxref{Adaptive Scoring}).
19650 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
19651 manner, so it should be difficult to lose much data on what you have
19652 read if your machine should go down (@pxref{Auto Save}).
19655 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
19656 the @file{.emacs} file.
19659 You can set the process mark on both groups and articles and perform
19660 operations on all the marked items (@pxref{Process/Prefix}).
19663 You can grep through a subset of groups and create a group from the
19664 results (@pxref{Kibozed Groups}).
19667 You can list subsets of groups according to, well, anything
19668 (@pxref{Listing Groups}).
19671 You can browse foreign servers and subscribe to groups from those
19672 servers (@pxref{Browse Foreign Server}).
19675 Gnus can fetch articles, asynchronously, on a second connection to the
19676 server (@pxref{Asynchronous Fetching}).
19679 You can cache articles locally (@pxref{Article Caching}).
19682 The uudecode functions have been expanded and generalized
19683 (@pxref{Decoding Articles}).
19686 You can still post uuencoded articles, which was a little-known feature
19687 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
19690 Fetching parents (and other articles) now actually works without
19691 glitches (@pxref{Finding the Parent}).
19694 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
19697 Digests (and other files) can be used as the basis for groups
19698 (@pxref{Document Groups}).
19701 Articles can be highlighted and customized (@pxref{Customizing
19705 URLs and other external references can be buttonized (@pxref{Article
19709 You can do lots of strange stuff with the Gnus window & frame
19710 configuration (@pxref{Windows Configuration}).
19713 You can click on buttons instead of using the keyboard
19719 @node September Gnus
19720 @subsubsection September Gnus
19724 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
19728 New features in Gnus 5.2/5.3:
19733 A new message composition mode is used. All old customization variables
19734 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
19738 Gnus is now able to generate @dfn{sparse} threads---threads where
19739 missing articles are represented by empty nodes (@pxref{Customizing
19743 (setq gnus-build-sparse-threads 'some)
19747 Outgoing articles are stored on a special archive server
19748 (@pxref{Archived Messages}).
19751 Partial thread regeneration now happens when articles are
19755 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
19758 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
19761 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
19764 (setq gnus-use-trees t)
19768 An @code{nn}-like pick-and-read minor mode is available for the summary
19769 buffers (@pxref{Pick and Read}).
19772 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
19776 In binary groups you can use a special binary minor mode (@pxref{Binary
19780 Groups can be grouped in a folding topic hierarchy (@pxref{Group
19784 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
19788 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
19791 Groups can now have a score, and bubbling based on entry frequency
19792 is possible (@pxref{Group Score}).
19795 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
19799 Groups can be process-marked, and commands can be performed on
19800 groups of groups (@pxref{Marking Groups}).
19803 Caching is possible in virtual groups.
19806 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
19807 news batches, ClariNet briefs collections, and just about everything
19808 else (@pxref{Document Groups}).
19811 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
19815 The Gnus cache is much faster.
19818 Groups can be sorted according to many criteria (@pxref{Sorting
19822 New group parameters have been introduced to set list-addresses and
19823 expiry times (@pxref{Group Parameters}).
19826 All formatting specs allow specifying faces to be used
19827 (@pxref{Formatting Fonts}).
19830 There are several more commands for setting/removing/acting on process
19831 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
19834 The summary buffer can be limited to show parts of the available
19835 articles based on a wide range of criteria. These commands have been
19836 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
19839 Articles can be made persistent with the @kbd{*} command
19840 (@pxref{Persistent Articles}).
19843 All functions for hiding article elements are now toggles.
19846 Article headers can be buttonized (@pxref{Article Washing}).
19849 All mail backends support fetching articles by @code{Message-ID}.
19852 Duplicate mail can now be treated properly (@pxref{Duplicates}).
19855 All summary mode commands are available directly from the article
19856 buffer (@pxref{Article Keymap}).
19859 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
19863 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
19866 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
19871 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
19874 (setq gnus-use-nocem t)
19878 Groups can be made permanently visible (@pxref{Listing Groups}).
19881 (setq gnus-permanently-visible-groups "^nnml:")
19885 Many new hooks have been introduced to make customizing easier.
19888 Gnus respects the @code{Mail-Copies-To} header.
19891 Threads can be gathered by looking at the @code{References} header
19892 (@pxref{Customizing Threading}).
19895 (setq gnus-summary-thread-gathering-function
19896 'gnus-gather-threads-by-references)
19900 Read articles can be stored in a special backlog buffer to avoid
19901 refetching (@pxref{Article Backlog}).
19904 (setq gnus-keep-backlog 50)
19908 A clean copy of the current article is always stored in a separate
19909 buffer to allow easier treatment.
19912 Gnus can suggest where to save articles (@pxref{Saving Articles}).
19915 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
19919 (setq gnus-prompt-before-saving t)
19923 @code{gnus-uu} can view decoded files asynchronously while fetching
19924 articles (@pxref{Other Decode Variables}).
19927 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
19931 Filling in the article buffer now works properly on cited text
19932 (@pxref{Article Washing}).
19935 Hiding cited text adds buttons to toggle hiding, and how much
19936 cited text to hide is now customizable (@pxref{Article Hiding}).
19939 (setq gnus-cited-lines-visible 2)
19943 Boring headers can be hidden (@pxref{Article Hiding}).
19946 Default scoring values can now be set from the menu bar.
19949 Further syntax checking of outgoing articles have been added.
19955 @subsubsection Red Gnus
19957 New features in Gnus 5.4/5.5:
19961 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
19968 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
19971 Article prefetching functionality has been moved up into
19972 Gnus (@pxref{Asynchronous Fetching}).
19975 Scoring can now be performed with logical operators like @code{and},
19976 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
19980 Article washing status can be displayed in the
19981 article mode line (@pxref{Misc Article}).
19984 @file{gnus.el} has been split into many smaller files.
19987 Suppression of duplicate articles based on Message-ID can be done
19988 (@pxref{Duplicate Suppression}).
19991 (setq gnus-suppress-duplicates t)
19995 New variables for specifying what score and adapt files are to be
19996 considered home score and adapt files (@pxref{Home Score File}) have
20000 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
20001 Server Internals}).
20004 Groups can inherit group parameters from parent topics (@pxref{Topic
20008 Article editing has been revamped and is now actually usable.
20011 Signatures can be recognized in more intelligent fashions
20012 (@pxref{Article Signature}).
20015 Summary pick mode has been made to look more @code{nn}-like. Line
20016 numbers are displayed and the @kbd{.} command can be used to pick
20017 articles (@code{Pick and Read}).
20020 Commands for moving the @file{.newsrc.eld} from one server to
20021 another have been added (@pxref{Changing Servers}).
20024 There's a way now to specify that ``uninteresting'' fields be suppressed
20025 when generating lines in buffers (@pxref{Advanced Formatting}).
20028 Several commands in the group buffer can be undone with @kbd{M-C-_}
20032 Scoring can be done on words using the new score type @code{w}
20033 (@pxref{Score File Format}).
20036 Adaptive scoring can be done on a Subject word-by-word basis
20037 (@pxref{Adaptive Scoring}).
20040 (setq gnus-use-adaptive-scoring '(word))
20044 Scores can be decayed (@pxref{Score Decays}).
20047 (setq gnus-decay-scores t)
20051 Scoring can be performed using a regexp on the Date header. The Date is
20052 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
20055 A new command has been added to remove all data on articles from
20056 the native server (@pxref{Changing Servers}).
20059 A new command for reading collections of documents
20060 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
20061 (@pxref{Really Various Summary Commands}).
20064 Process mark sets can be pushed and popped (@pxref{Setting Process
20068 A new mail-to-news backend makes it possible to post even when the @sc{nntp}
20069 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
20072 A new backend for reading searches from Web search engines
20073 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
20074 (@pxref{Web Searches}).
20077 Groups inside topics can now be sorted using the standard sorting
20078 functions, and each topic can be sorted independently (@pxref{Topic
20082 Subsets of the groups can be sorted independently (@code{Sorting
20086 Cached articles can be pulled into the groups (@pxref{Summary Generation
20090 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
20095 Score files are now applied in a more reliable order (@pxref{Score
20099 Reports on where mail messages end up can be generated (@pxref{Splitting
20103 More hooks and functions have been added to remove junk from incoming
20104 mail before saving the mail (@pxref{Washing Mail}).
20107 Emphasized text can be properly fontisized:
20113 @subsubsection Quassia Gnus
20115 New features in Gnus 5.6:
20120 New functionality for using Gnus as an offline newsreader has been
20121 added. A plethora of new commands and modes have been added. See
20122 @pxref{Gnus Unplugged} for the full story.
20125 The @code{nndraft} backend has returned, but works differently than
20126 before. All Message buffers are now also articles in the @code{nndraft}
20127 group, which is created automatically.
20130 @code{gnus-alter-header-function} can now be used to alter header
20134 @code{gnus-summary-goto-article} now accept Message-ID's.
20137 A new Message command for deleting text in the body of a message
20138 outside the region: @kbd{C-c C-v}.
20141 You can now post to component group in @code{nnvirtual} groups with
20145 @code{nntp-rlogin-program}---new variable to ease customization.
20148 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
20149 re-highlighting of the article buffer.
20152 New element in @code{gnus-boring-article-headers}---@code{long-to}.
20155 @kbd{M-i} symbolic prefix command. See the section "Symbolic
20156 Prefixes" in the Gnus manual for details.
20159 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
20160 @kbd{a} to add the score rule to the "all.SCORE" file.
20163 @code{gnus-simplify-subject-functions} variable to allow greater
20164 control over simplification.
20167 @kbd{A T}---new command for fetching the current thread.
20170 @kbd{/ T}---new command for including the current thread in the
20174 @kbd{M-RET} is a new Message command for breaking cited text.
20177 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
20180 The @code{custom-face-lookup} function has been removed.
20181 If you used this function in your initialization files, you must
20182 rewrite them to use @code{face-spec-set} instead.
20185 Canceling now uses the current select method. Symbolic prefix
20186 @kbd{a} forces normal posting method.
20189 New command to translate M******** sm*rtq**t*s into proper
20193 For easier debugging of @code{nntp}, you can set
20194 @code{nntp-record-commands} to a non-@code{nil} value.
20197 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
20198 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
20201 A command for editing group parameters from the summary buffer
20205 A history of where mails have been split is available.
20208 A new article date command has been added---@code{article-date-iso8601}.
20211 Subjects can be simplified when threading by setting
20212 @code{gnus-score-thread-simplify}.
20215 A new function for citing in Message has been
20216 added---@code{message-cite-original-without-signature}.
20219 @code{article-strip-all-blank-lines}---new article command.
20222 A new Message command to kill to the end of the article has
20226 A minimum adaptive score can be specified by using the
20227 @code{gnus-adaptive-word-minimum} variable.
20230 The "lapsed date" article header can be kept continually
20231 updated by the @code{gnus-start-date-timer} command.
20234 Web listserv archives can be read with the @code{nnlistserv} backend.
20237 Old dejanews archives can now be read by @code{nnweb}.
20241 @node Pterodactyl Gnus
20242 @subsubsection Pterodactyl Gnus
20244 New features in Gnus 5.8:
20248 @item The mail-fetching functions have changed. See the manual for the
20249 many details. In particular, all procmail fetching variables are gone.
20251 If you used procmail like in
20254 (setq nnmail-use-procmail t)
20255 (setq nnmail-spool-file 'procmail)
20256 (setq nnmail-procmail-directory "~/mail/incoming/")
20257 (setq nnmail-procmail-suffix "\\.in")
20260 this now has changed to
20264 '((directory :path "~/mail/incoming/"
20268 More information is available in the info doc at Select Methods ->
20269 Getting Mail -> Mail Sources
20271 @item Gnus is now a MIME-capable reader. This affects many parts of
20272 Gnus, and adds a slew of new commands. See the manual for details.
20274 @item Gnus has also been multilingualized. This also affects too
20275 many parts of Gnus to summarize here, and adds many new variables.
20277 @item @code{gnus-auto-select-first} can now be a function to be
20278 called to position point.
20280 @item The user can now decide which extra headers should be included in
20281 summary buffers and NOV files.
20283 @item @code{gnus-article-display-hook} has been removed. Instead, a number
20284 of variables starting with @code{gnus-treat-} have been added.
20286 @item The Gnus posting styles have been redone again and now works in a
20287 subtly different manner.
20289 @item New web-based backends have been added: @code{nnslashdot},
20290 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
20291 again, to keep up with ever-changing layouts.
20293 @item Gnus can now read IMAP mail via @code{nnimap}.
20301 @section The Manual
20305 This manual was generated from a TeXinfo file and then run through
20306 either @code{texi2dvi}
20308 or my own home-brewed TeXinfo to \LaTeX\ transformer,
20309 and then run through @code{latex} and @code{dvips}
20311 to get what you hold in your hands now.
20313 The following conventions have been used:
20318 This is a @samp{string}
20321 This is a @kbd{keystroke}
20324 This is a @file{file}
20327 This is a @code{symbol}
20331 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
20335 (setq flargnoze "yes")
20338 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
20341 (setq flumphel 'yes)
20344 @samp{yes} and @code{yes} are two @emph{very} different things---don't
20345 ever get them confused.
20349 Of course, everything in this manual is of vital interest, so you should
20350 read it all. Several times. However, if you feel like skimming the
20351 manual, look for that gnu head you should see in the margin over
20352 there---it means that what's being discussed is of more importance than
20353 the rest of the stuff. (On the other hand, if everything is infinitely
20354 important, how can anything be more important than that? Just one more
20355 of the mysteries of this world, I guess.)
20361 @node On Writing Manuals
20362 @section On Writing Manuals
20364 I guess most manuals are written after-the-fact; documenting a program
20365 that's already there. This is not how this manual is written. When
20366 implementing something, I write the manual entry for that something
20367 straight away. I then see that it's difficult to explain the
20368 functionality, so I write how it's supposed to be, and then I change the
20369 implementation. Writing the documentation and writing the code goes
20372 This, of course, means that this manual has no, or little, flow. It
20373 documents absolutely everything in Gnus, but often not where you're
20374 looking for it. It is a reference manual, and not a guide to how to get
20377 That would be a totally different book, that should be written using the
20378 reference manual as source material. It would look quite differently.
20383 @section Terminology
20385 @cindex terminology
20390 This is what you are supposed to use this thing for---reading news.
20391 News is generally fetched from a nearby @sc{nntp} server, and is
20392 generally publicly available to everybody. If you post news, the entire
20393 world is likely to read just what you have written, and they'll all
20394 snigger mischievously. Behind your back.
20398 Everything that's delivered to you personally is mail. Some news/mail
20399 readers (like Gnus) blur the distinction between mail and news, but
20400 there is a difference. Mail is private. News is public. Mailing is
20401 not posting, and replying is not following up.
20405 Send a mail to the person who has written what you are reading.
20409 Post an article to the current newsgroup responding to the article you
20414 Gnus gets fed articles from a number of backends, both news and mail
20415 backends. Gnus does not handle the underlying media, so to speak---this
20416 is all done by the backends.
20420 Gnus will always use one method (and backend) as the @dfn{native}, or
20421 default, way of getting news.
20425 You can also have any number of foreign groups active at the same time.
20426 These are groups that use non-native non-secondary backends for getting
20431 Secondary backends are somewhere half-way between being native and being
20432 foreign, but they mostly act like they are native.
20436 A message that has been posted as news.
20439 @cindex mail message
20440 A message that has been mailed.
20444 A mail message or news article
20448 The top part of a message, where administrative information (etc.) is
20453 The rest of an article. Everything not in the head is in the
20458 A line from the head of an article.
20462 A collection of such lines, or a collection of heads. Or even a
20463 collection of @sc{nov} lines.
20467 When Gnus enters a group, it asks the backend for the headers of all
20468 unread articles in the group. Most servers support the News OverView
20469 format, which is more compact and much faster to read and parse than the
20470 normal @sc{head} format.
20474 Each group is subscribed at some @dfn{level} or other (1-9). The ones
20475 that have a lower level are ``more'' subscribed than the groups with a
20476 higher level. In fact, groups on levels 1-5 are considered
20477 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
20478 are @dfn{killed}. Commands for listing groups and scanning for new
20479 articles will all use the numeric prefix as @dfn{working level}.
20481 @item killed groups
20482 @cindex killed groups
20483 No information on killed groups is stored or updated, which makes killed
20484 groups much easier to handle than subscribed groups.
20486 @item zombie groups
20487 @cindex zombie groups
20488 Just like killed groups, only slightly less dead.
20491 @cindex active file
20492 The news server has to keep track of what articles it carries, and what
20493 groups exist. All this information in stored in the active file, which
20494 is rather large, as you might surmise.
20497 @cindex bogus groups
20498 A group that exists in the @file{.newsrc} file, but isn't known to the
20499 server (i.e., it isn't in the active file), is a @emph{bogus group}.
20500 This means that the group probably doesn't exist (any more).
20503 @cindex activating groups
20504 The act of asking the server for info on a group and computing the
20505 number of unread articles is called @dfn{activating the group}.
20506 Un-activated groups are listed with @samp{*} in the group buffer.
20510 A machine one can connect to and get news (or mail) from.
20512 @item select method
20513 @cindex select method
20514 A structure that specifies the backend, the server and the virtual
20517 @item virtual server
20518 @cindex virtual server
20519 A named select method. Since a select method defines all there is to
20520 know about connecting to a (physical) server, taking the thing as a
20521 whole is a virtual server.
20525 Taking a buffer and running it through a filter of some sort. The
20526 result will (more often than not) be cleaner and more pleasing than the
20529 @item ephemeral groups
20530 @cindex ephemeral groups
20531 Most groups store data on what articles you have read. @dfn{Ephemeral}
20532 groups are groups that will have no data stored---when you exit the
20533 group, it'll disappear into the aether.
20536 @cindex solid groups
20537 This is the opposite of ephemeral groups. All groups listed in the
20538 group buffer are solid groups.
20540 @item sparse articles
20541 @cindex sparse articles
20542 These are article placeholders shown in the summary buffer when
20543 @code{gnus-build-sparse-threads} has been switched on.
20547 To put responses to articles directly after the articles they respond
20548 to---in a hierarchical fashion.
20552 @cindex thread root
20553 The first article in a thread is the root. It is the ancestor of all
20554 articles in the thread.
20558 An article that has responses.
20562 An article that responds to a different article---its parent.
20566 A collection of messages in one file. The most common digest format is
20567 specified by RFC 1153.
20573 @node Customization
20574 @section Customization
20575 @cindex general customization
20577 All variables are properly documented elsewhere in this manual. This
20578 section is designed to give general pointers on how to customize Gnus
20579 for some quite common situations.
20582 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
20583 * Slow Terminal Connection:: You run a remote Emacs.
20584 * Little Disk Space:: You feel that having large setup files is icky.
20585 * Slow Machine:: You feel like buying a faster machine.
20589 @node Slow/Expensive Connection
20590 @subsection Slow/Expensive @sc{nntp} Connection
20592 If you run Emacs on a machine locally, and get your news from a machine
20593 over some very thin strings, you want to cut down on the amount of data
20594 Gnus has to get from the @sc{nntp} server.
20598 @item gnus-read-active-file
20599 Set this to @code{nil}, which will inhibit Gnus from requesting the
20600 entire active file from the server. This file is often v. large. You
20601 also have to set @code{gnus-check-new-newsgroups} and
20602 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
20603 doesn't suddenly decide to fetch the active file anyway.
20605 @item gnus-nov-is-evil
20606 This one has to be @code{nil}. If not, grabbing article headers from
20607 the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers
20608 support @sc{xover}; Gnus will detect this by itself.
20612 @node Slow Terminal Connection
20613 @subsection Slow Terminal Connection
20615 Let's say you use your home computer for dialing up the system that runs
20616 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
20617 possible) the amount of data sent over the wires.
20621 @item gnus-auto-center-summary
20622 Set this to @code{nil} to inhibit Gnus from re-centering the summary
20623 buffer all the time. If it is @code{vertical}, do only vertical
20624 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
20625 horizontal and vertical recentering.
20627 @item gnus-visible-headers
20628 Cut down on the headers included in the articles to the
20629 minimum. You can, in fact, make do without them altogether---most of the
20630 useful data is in the summary buffer, anyway. Set this variable to
20631 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
20633 Set this hook to all the available hiding commands:
20635 (setq gnus-treat-hide-headers 'head
20636 gnus-treat-hide-signature t
20637 gnus-treat-hide-citation t)
20640 @item gnus-use-full-window
20641 By setting this to @code{nil}, you can make all the windows smaller.
20642 While this doesn't really cut down much generally, it means that you
20643 have to see smaller portions of articles before deciding that you didn't
20644 want to read them anyway.
20646 @item gnus-thread-hide-subtree
20647 If this is non-@code{nil}, all threads in the summary buffer will be
20650 @item gnus-updated-mode-lines
20651 If this is @code{nil}, Gnus will not put information in the buffer mode
20652 lines, which might save some time.
20656 @node Little Disk Space
20657 @subsection Little Disk Space
20660 The startup files can get rather large, so you may want to cut their
20661 sizes a bit if you are running out of space.
20665 @item gnus-save-newsrc-file
20666 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
20667 only save @file{.newsrc.eld}. This means that you will not be able to
20668 use any other newsreaders than Gnus. This variable is @code{t} by
20671 @item gnus-read-newsrc-file
20672 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
20673 only read @file{.newsrc.eld}. This means that you will not be able to
20674 use any other newsreaders than Gnus. This variable is @code{t} by
20677 @item gnus-save-killed-list
20678 If this is @code{nil}, Gnus will not save the list of dead groups. You
20679 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
20680 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
20681 variable to @code{nil}. This variable is @code{t} by default.
20687 @subsection Slow Machine
20688 @cindex slow machine
20690 If you have a slow machine, or are just really impatient, there are a
20691 few things you can do to make Gnus run faster.
20693 Set @code{gnus-check-new-newsgroups} and
20694 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
20696 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
20697 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
20698 summary buffer faster.
20702 @node Troubleshooting
20703 @section Troubleshooting
20704 @cindex troubleshooting
20706 Gnus works @emph{so} well straight out of the box---I can't imagine any
20714 Make sure your computer is switched on.
20717 Make sure that you really load the current Gnus version. If you have
20718 been running @sc{gnus}, you need to exit Emacs and start it up again before
20722 Try doing an @kbd{M-x gnus-version}. If you get something that looks
20723 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded. If,
20724 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
20725 flee}, you have some old @file{.el} files lying around. Delete these.
20728 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
20732 @vindex max-lisp-eval-depth
20733 Gnus works on many recursive structures, and in some extreme (and very
20734 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
20735 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
20736 something like that.
20739 If all else fails, report the problem as a bug.
20742 @cindex reporting bugs
20744 @kindex M-x gnus-bug
20746 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
20747 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
20748 me the backtrace. I will fix bugs, but I can only fix them if you send
20749 me a precise description as to how to reproduce the bug.
20751 You really can never be too detailed in a bug report. Always use the
20752 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
20753 a 10Kb mail each time you use it, and even if you have sent me your
20754 environment 500 times before. I don't care. I want the full info each
20757 It is also important to remember that I have no memory whatsoever. If
20758 you send a bug report, and I send you a reply, and then you just send
20759 back ``No, it's not! Moron!'', I will have no idea what you are
20760 insulting me about. Always over-explain everything. It's much easier
20761 for all of us---if I don't have all the information I need, I will just
20762 mail you and ask for more info, and everything takes more time.
20764 If the problem you're seeing is very visual, and you can't quite explain
20765 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
20766 it somewhere it can be reached, and include the URL of the picture in
20769 If you just need help, you are better off asking on
20770 @samp{gnu.emacs.gnus}. I'm not very helpful.
20772 @cindex gnu.emacs.gnus
20773 @cindex ding mailing list
20774 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
20775 Write to @samp{ding-request@@gnus.org} to subscribe.
20779 @node Gnus Reference Guide
20780 @section Gnus Reference Guide
20782 It is my hope that other people will figure out smart stuff that Gnus
20783 can do, and that other people will write those smart things as well. To
20784 facilitate that I thought it would be a good idea to describe the inner
20785 workings of Gnus. And some of the not-so-inner workings, while I'm at
20788 You can never expect the internals of a program not to change, but I
20789 will be defining (in some details) the interface between Gnus and its
20790 backends (this is written in stone), the format of the score files
20791 (ditto), data structures (some are less likely to change than others)
20792 and general methods of operation.
20795 * Gnus Utility Functions:: Common functions and variable to use.
20796 * Backend Interface:: How Gnus communicates with the servers.
20797 * Score File Syntax:: A BNF definition of the score file standard.
20798 * Headers:: How Gnus stores headers internally.
20799 * Ranges:: A handy format for storing mucho numbers.
20800 * Group Info:: The group info format.
20801 * Extended Interactive:: Symbolic prefixes and stuff.
20802 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
20803 * Various File Formats:: Formats of files that Gnus use.
20807 @node Gnus Utility Functions
20808 @subsection Gnus Utility Functions
20809 @cindex Gnus utility functions
20810 @cindex utility functions
20812 @cindex internal variables
20814 When writing small functions to be run from hooks (and stuff), it's
20815 vital to have access to the Gnus internal functions and variables.
20816 Below is a list of the most common ones.
20820 @item gnus-newsgroup-name
20821 @vindex gnus-newsgroup-name
20822 This variable holds the name of the current newsgroup.
20824 @item gnus-find-method-for-group
20825 @findex gnus-find-method-for-group
20826 A function that returns the select method for @var{group}.
20828 @item gnus-group-real-name
20829 @findex gnus-group-real-name
20830 Takes a full (prefixed) Gnus group name, and returns the unprefixed
20833 @item gnus-group-prefixed-name
20834 @findex gnus-group-prefixed-name
20835 Takes an unprefixed group name and a select method, and returns the full
20836 (prefixed) Gnus group name.
20838 @item gnus-get-info
20839 @findex gnus-get-info
20840 Returns the group info list for @var{group}.
20842 @item gnus-group-unread
20843 @findex gnus-group-unread
20844 The number of unread articles in @var{group}, or @code{t} if that is
20848 @findex gnus-active
20849 The active entry for @var{group}.
20851 @item gnus-set-active
20852 @findex gnus-set-active
20853 Set the active entry for @var{group}.
20855 @item gnus-add-current-to-buffer-list
20856 @findex gnus-add-current-to-buffer-list
20857 Adds the current buffer to the list of buffers to be killed on Gnus
20860 @item gnus-continuum-version
20861 @findex gnus-continuum-version
20862 Takes a Gnus version string as a parameter and returns a floating point
20863 number. Earlier versions will always get a lower number than later
20866 @item gnus-group-read-only-p
20867 @findex gnus-group-read-only-p
20868 Says whether @var{group} is read-only or not.
20870 @item gnus-news-group-p
20871 @findex gnus-news-group-p
20872 Says whether @var{group} came from a news backend.
20874 @item gnus-ephemeral-group-p
20875 @findex gnus-ephemeral-group-p
20876 Says whether @var{group} is ephemeral or not.
20878 @item gnus-server-to-method
20879 @findex gnus-server-to-method
20880 Returns the select method corresponding to @var{server}.
20882 @item gnus-server-equal
20883 @findex gnus-server-equal
20884 Says whether two virtual servers are equal.
20886 @item gnus-group-native-p
20887 @findex gnus-group-native-p
20888 Says whether @var{group} is native or not.
20890 @item gnus-group-secondary-p
20891 @findex gnus-group-secondary-p
20892 Says whether @var{group} is secondary or not.
20894 @item gnus-group-foreign-p
20895 @findex gnus-group-foreign-p
20896 Says whether @var{group} is foreign or not.
20898 @item group-group-find-parameter
20899 @findex group-group-find-parameter
20900 Returns the parameter list of @var{group}. If given a second parameter,
20901 returns the value of that parameter for @var{group}.
20903 @item gnus-group-set-parameter
20904 @findex gnus-group-set-parameter
20905 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
20907 @item gnus-narrow-to-body
20908 @findex gnus-narrow-to-body
20909 Narrows the current buffer to the body of the article.
20911 @item gnus-check-backend-function
20912 @findex gnus-check-backend-function
20913 Takes two parameters, @var{function} and @var{group}. If the backend
20914 @var{group} comes from supports @var{function}, return non-@code{nil}.
20917 (gnus-check-backend-function "request-scan" "nnml:misc")
20921 @item gnus-read-method
20922 @findex gnus-read-method
20923 Prompts the user for a select method.
20928 @node Backend Interface
20929 @subsection Backend Interface
20931 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
20932 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
20933 server is a @dfn{backend} and some @dfn{backend variables}. As examples
20934 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
20935 examples of the latter we have @code{nntp-port-number} and
20936 @code{nnmbox-directory}.
20938 When Gnus asks for information from a backend---say @code{nntp}---on
20939 something, it will normally include a virtual server name in the
20940 function parameters. (If not, the backend should use the ``current''
20941 virtual server.) For instance, @code{nntp-request-list} takes a virtual
20942 server as its only (optional) parameter. If this virtual server hasn't
20943 been opened, the function should fail.
20945 Note that a virtual server name has no relation to some physical server
20946 name. Take this example:
20950 (nntp-address "ifi.uio.no")
20951 (nntp-port-number 4324))
20954 Here the virtual server name is @samp{odd-one} while the name of
20955 the physical server is @samp{ifi.uio.no}.
20957 The backends should be able to switch between several virtual servers.
20958 The standard backends implement this by keeping an alist of virtual
20959 server environments that they pull down/push up when needed.
20961 There are two groups of interface functions: @dfn{required functions},
20962 which must be present, and @dfn{optional functions}, which Gnus will
20963 always check for presence before attempting to call 'em.
20965 All these functions are expected to return data in the buffer
20966 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
20967 unfortunately named, but we'll have to live with it. When I talk about
20968 @dfn{resulting data}, I always refer to the data in that buffer. When I
20969 talk about @dfn{return value}, I talk about the function value returned by
20970 the function call. Functions that fail should return @code{nil} as the
20973 Some backends could be said to be @dfn{server-forming} backends, and
20974 some might be said not to be. The latter are backends that generally
20975 only operate on one group at a time, and have no concept of ``server''
20976 -- they have a group, and they deliver info on that group and nothing
20979 In the examples and definitions I will refer to the imaginary backend
20982 @cindex @code{nnchoke}
20985 * Required Backend Functions:: Functions that must be implemented.
20986 * Optional Backend Functions:: Functions that need not be implemented.
20987 * Error Messaging:: How to get messages and report errors.
20988 * Writing New Backends:: Extending old backends.
20989 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
20990 * Mail-like Backends:: Some tips on mail backends.
20994 @node Required Backend Functions
20995 @subsubsection Required Backend Functions
20999 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
21001 @var{articles} is either a range of article numbers or a list of
21002 @code{Message-ID}s. Current backends do not fully support either---only
21003 sequences (lists) of article numbers, and most backends do not support
21004 retrieval of @code{Message-ID}s. But they should try for both.
21006 The result data should either be HEADs or NOV lines, and the result
21007 value should either be @code{headers} or @code{nov} to reflect this.
21008 This might later be expanded to @code{various}, which will be a mixture
21009 of HEADs and NOV lines, but this is currently not supported by Gnus.
21011 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
21012 headers", in some meaning of the word. This is generally done by
21013 fetching (at most) @var{fetch-old} extra headers less than the smallest
21014 article number in @code{articles}, and filling the gaps as well. The
21015 presence of this parameter can be ignored if the backend finds it
21016 cumbersome to follow the request. If this is non-@code{nil} and not a
21017 number, do maximum fetches.
21019 Here's an example HEAD:
21022 221 1056 Article retrieved.
21023 Path: ifi.uio.no!sturles
21024 From: sturles@@ifi.uio.no (Sturle Sunde)
21025 Newsgroups: ifi.discussion
21026 Subject: Re: Something very droll
21027 Date: 27 Oct 1994 14:02:57 +0100
21028 Organization: Dept. of Informatics, University of Oslo, Norway
21030 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
21031 References: <38jdmq$4qu@@visbur.ifi.uio.no>
21032 NNTP-Posting-Host: holmenkollen.ifi.uio.no
21036 So a @code{headers} return value would imply that there's a number of
21037 these in the data buffer.
21039 Here's a BNF definition of such a buffer:
21043 head = error / valid-head
21044 error-message = [ "4" / "5" ] 2number " " <error message> eol
21045 valid-head = valid-message *header "." eol
21046 valid-message = "221 " <number> " Article retrieved." eol
21047 header = <text> eol
21050 If the return value is @code{nov}, the data buffer should contain
21051 @dfn{network overview database} lines. These are basically fields
21055 nov-buffer = *nov-line
21056 nov-line = 8*9 [ field <TAB> ] eol
21057 field = <text except TAB>
21060 For a closer look at what should be in those fields,
21064 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
21066 @var{server} is here the virtual server name. @var{definitions} is a
21067 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
21069 If the server can't be opened, no error should be signaled. The backend
21070 may then choose to refuse further attempts at connecting to this
21071 server. In fact, it should do so.
21073 If the server is opened already, this function should return a
21074 non-@code{nil} value. There should be no data returned.
21077 @item (nnchoke-close-server &optional SERVER)
21079 Close connection to @var{server} and free all resources connected
21080 to it. Return @code{nil} if the server couldn't be closed for some
21083 There should be no data returned.
21086 @item (nnchoke-request-close)
21088 Close connection to all servers and free all resources that the backend
21089 have reserved. All buffers that have been created by that backend
21090 should be killed. (Not the @code{nntp-server-buffer}, though.) This
21091 function is generally only called when Gnus is shutting down.
21093 There should be no data returned.
21096 @item (nnchoke-server-opened &optional SERVER)
21098 If @var{server} is the current virtual server, and the connection to the
21099 physical server is alive, then this function should return a
21100 non-@code{nil} vlue. This function should under no circumstances
21101 attempt to reconnect to a server we have lost connection to.
21103 There should be no data returned.
21106 @item (nnchoke-status-message &optional SERVER)
21108 This function should return the last error message from @var{server}.
21110 There should be no data returned.
21113 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
21115 The result data from this function should be the article specified by
21116 @var{article}. This might either be a @code{Message-ID} or a number.
21117 It is optional whether to implement retrieval by @code{Message-ID}, but
21118 it would be nice if that were possible.
21120 If @var{to-buffer} is non-@code{nil}, the result data should be returned
21121 in this buffer instead of the normal data buffer. This is to make it
21122 possible to avoid copying large amounts of data from one buffer to
21123 another, while Gnus mainly requests articles to be inserted directly
21124 into its article buffer.
21126 If it is at all possible, this function should return a cons cell where
21127 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
21128 the article number. This will enable Gnus to find out what the real
21129 group and article numbers are when fetching articles by
21130 @code{Message-ID}. If this isn't possible, @code{t} should be returned
21131 on successful article retrieval.
21134 @item (nnchoke-request-group GROUP &optional SERVER FAST)
21136 Get data on @var{group}. This function also has the side effect of
21137 making @var{group} the current group.
21139 If @var{fast}, don't bother to return useful data, just make @var{group}
21142 Here's an example of some result data and a definition of the same:
21145 211 56 1000 1059 ifi.discussion
21148 The first number is the status, which should be 211. Next is the
21149 total number of articles in the group, the lowest article number, the
21150 highest article number, and finally the group name. Note that the total
21151 number of articles may be less than one might think while just
21152 considering the highest and lowest article numbers, but some articles
21153 may have been canceled. Gnus just discards the total-number, so
21154 whether one should take the bother to generate it properly (if that is a
21155 problem) is left as an exercise to the reader.
21158 group-status = [ error / info ] eol
21159 error = [ "4" / "5" ] 2<number> " " <Error message>
21160 info = "211 " 3* [ <number> " " ] <string>
21164 @item (nnchoke-close-group GROUP &optional SERVER)
21166 Close @var{group} and free any resources connected to it. This will be
21167 a no-op on most backends.
21169 There should be no data returned.
21172 @item (nnchoke-request-list &optional SERVER)
21174 Return a list of all groups available on @var{server}. And that means
21177 Here's an example from a server that only carries two groups:
21180 ifi.test 0000002200 0000002000 y
21181 ifi.discussion 3324 3300 n
21184 On each line we have a group name, then the highest article number in
21185 that group, the lowest article number, and finally a flag.
21188 active-file = *active-line
21189 active-line = name " " <number> " " <number> " " flags eol
21191 flags = "n" / "y" / "m" / "x" / "j" / "=" name
21194 The flag says whether the group is read-only (@samp{n}), is moderated
21195 (@samp{m}), is dead (@samp{x}), is aliased to some other group
21196 (@samp{=other-group}) or none of the above (@samp{y}).
21199 @item (nnchoke-request-post &optional SERVER)
21201 This function should post the current buffer. It might return whether
21202 the posting was successful or not, but that's not required. If, for
21203 instance, the posting is done asynchronously, it has generally not been
21204 completed by the time this function concludes. In that case, this
21205 function should set up some kind of sentinel to beep the user loud and
21206 clear if the posting could not be completed.
21208 There should be no result data from this function.
21213 @node Optional Backend Functions
21214 @subsubsection Optional Backend Functions
21218 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
21220 @var{groups} is a list of groups, and this function should request data
21221 on all those groups. How it does it is of no concern to Gnus, but it
21222 should attempt to do this in a speedy fashion.
21224 The return value of this function can be either @code{active} or
21225 @code{group}, which says what the format of the result data is. The
21226 former is in the same format as the data from
21227 @code{nnchoke-request-list}, while the latter is a buffer full of lines
21228 in the same format as @code{nnchoke-request-group} gives.
21231 group-buffer = *active-line / *group-status
21235 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
21237 A Gnus group info (@pxref{Group Info}) is handed to the backend for
21238 alterations. This comes in handy if the backend really carries all the
21239 information (as is the case with virtual and imap groups). This
21240 function should destructively alter the info to suit its needs, and
21241 should return the (altered) group info.
21243 There should be no result data from this function.
21246 @item (nnchoke-request-type GROUP &optional ARTICLE)
21248 When the user issues commands for ``sending news'' (@kbd{F} in the
21249 summary buffer, for instance), Gnus has to know whether the article the
21250 user is following up on is news or mail. This function should return
21251 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
21252 is mail and @code{unknown} if the type can't be decided. (The
21253 @var{article} parameter is necessary in @code{nnvirtual} groups which
21254 might very well combine mail groups and news groups.) Both @var{group}
21255 and @var{article} may be @code{nil}.
21257 There should be no result data from this function.
21260 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
21262 Set/remove/add marks on articles. Normally Gnus handles the article
21263 marks (such as read, ticked, expired etc) internally, and store them in
21264 @code{~/.newsrc.eld}. Some backends (such as @sc{imap}) however carry
21265 all information about the articles on the server, so Gnus need to
21266 propagate the mark information to the server.
21268 ACTION is a list of mark setting requests, having this format:
21271 (RANGE ACTION MARK)
21274 RANGE is a range of articles you wish to update marks on. ACTION is
21275 @code{set}, @code{add} or @code{del}, respectively used for removing all
21276 existing marks and setting them as specified, adding (preserving the
21277 marks not mentioned) mark and removing (preserving the marks not
21278 mentioned) marks. MARK is a list of marks; where each mark is a symbol.
21279 Currently used marks are @code{read}, @code{tick}, @code{reply},
21280 @code{expire}, @code{killed}, @code{dormant}, @code{save},
21281 @code{download} and @code{unsend}, but your backend should, if possible,
21282 not limit itself to these.
21284 Given contradictory actions, the last action in the list should be the
21285 effective one. That is, if your action contains a request to add the
21286 @code{tick} mark on article 1 and, later in the list, a request to
21287 remove the mark on the same article, the mark should in fact be removed.
21289 An example action list:
21292 (((5 12 30) 'del '(tick))
21293 ((10 . 90) 'add '(read expire))
21294 ((92 94) 'del '(read)))
21297 The function should return a range of articles it wasn't able to set the
21298 mark on (currently not used for anything).
21300 There should be no result data from this function.
21302 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
21304 If the user tries to set a mark that the backend doesn't like, this
21305 function may change the mark. Gnus will use whatever this function
21306 returns as the mark for @var{article} instead of the original
21307 @var{mark}. If the backend doesn't care, it must return the original
21308 @var{mark}, and not @code{nil} or any other type of garbage.
21310 The only use for this I can see is what @code{nnvirtual} does with
21311 it---if a component group is auto-expirable, marking an article as read
21312 in the virtual group should result in the article being marked as
21315 There should be no result data from this function.
21318 @item (nnchoke-request-scan &optional GROUP SERVER)
21320 This function may be called at any time (by Gnus or anything else) to
21321 request that the backend check for incoming articles, in one way or
21322 another. A mail backend will typically read the spool file or query the
21323 POP server when this function is invoked. The @var{group} doesn't have
21324 to be heeded---if the backend decides that it is too much work just
21325 scanning for a single group, it may do a total scan of all groups. It
21326 would be nice, however, to keep things local if that's practical.
21328 There should be no result data from this function.
21331 @item (nnchoke-request-group-description GROUP &optional SERVER)
21333 The result data from this function should be a description of
21337 description-line = name <TAB> description eol
21339 description = <text>
21342 @item (nnchoke-request-list-newsgroups &optional SERVER)
21344 The result data from this function should be the description of all
21345 groups available on the server.
21348 description-buffer = *description-line
21352 @item (nnchoke-request-newgroups DATE &optional SERVER)
21354 The result data from this function should be all groups that were
21355 created after @samp{date}, which is in normal human-readable date
21356 format. The data should be in the active buffer format.
21359 @item (nnchoke-request-create-group GROUP &optional SERVER)
21361 This function should create an empty group with name @var{group}.
21363 There should be no return data.
21366 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
21368 This function should run the expiry process on all articles in the
21369 @var{articles} range (which is currently a simple list of article
21370 numbers.) It is left up to the backend to decide how old articles
21371 should be before they are removed by this function. If @var{force} is
21372 non-@code{nil}, all @var{articles} should be deleted, no matter how new
21375 This function should return a list of articles that it did not/was not
21378 There should be no result data returned.
21381 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
21384 This function should move @var{article} (which is a number) from
21385 @var{group} by calling @var{accept-form}.
21387 This function should ready the article in question for moving by
21388 removing any header lines it has added to the article, and generally
21389 should ``tidy up'' the article. Then it should @code{eval}
21390 @var{accept-form} in the buffer where the ``tidy'' article is. This
21391 will do the actual copying. If this @code{eval} returns a
21392 non-@code{nil} value, the article should be removed.
21394 If @var{last} is @code{nil}, that means that there is a high likelihood
21395 that there will be more requests issued shortly, so that allows some
21398 The function should return a cons where the @code{car} is the group name and
21399 the @code{cdr} is the article number that the article was entered as.
21401 There should be no data returned.
21404 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
21406 This function takes the current buffer and inserts it into @var{group}.
21407 If @var{last} in @code{nil}, that means that there will be more calls to
21408 this function in short order.
21410 The function should return a cons where the @code{car} is the group name and
21411 the @code{cdr} is the article number that the article was entered as.
21413 There should be no data returned.
21416 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
21418 This function should remove @var{article} (which is a number) from
21419 @var{group} and insert @var{buffer} there instead.
21421 There should be no data returned.
21424 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
21426 This function should delete @var{group}. If @var{force}, it should
21427 really delete all the articles in the group, and then delete the group
21428 itself. (If there is such a thing as ``the group itself''.)
21430 There should be no data returned.
21433 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
21435 This function should rename @var{group} into @var{new-name}. All
21436 articles in @var{group} should move to @var{new-name}.
21438 There should be no data returned.
21443 @node Error Messaging
21444 @subsubsection Error Messaging
21446 @findex nnheader-report
21447 @findex nnheader-get-report
21448 The backends should use the function @code{nnheader-report} to report
21449 error conditions---they should not raise errors when they aren't able to
21450 perform a request. The first argument to this function is the backend
21451 symbol, and the rest are interpreted as arguments to @code{format} if
21452 there are multiple of them, or just a string if there is one of them.
21453 This function must always returns @code{nil}.
21456 (nnheader-report 'nnchoke "You did something totally bogus")
21458 (nnheader-report 'nnchoke "Could not request group %s" group)
21461 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
21462 @code{nil} back from a server, and this function returns the most
21463 recently reported message for the backend in question. This function
21464 takes one argument---the server symbol.
21466 Internally, these functions access @var{backend}@code{-status-string},
21467 so the @code{nnchoke} backend will have its error message stored in
21468 @code{nnchoke-status-string}.
21471 @node Writing New Backends
21472 @subsubsection Writing New Backends
21474 Many backends are quite similar. @code{nnml} is just like
21475 @code{nnspool}, but it allows you to edit the articles on the server.
21476 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
21477 and it doesn't maintain overview databases. @code{nndir} is just like
21478 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
21481 It would make sense if it were possible to ``inherit'' functions from
21482 backends when writing new backends. And, indeed, you can do that if you
21483 want to. (You don't have to if you don't want to, of course.)
21485 All the backends declare their public variables and functions by using a
21486 package called @code{nnoo}.
21488 To inherit functions from other backends (and allow other backends to
21489 inherit functions from the current backend), you should use the
21495 This macro declares the first parameter to be a child of the subsequent
21496 parameters. For instance:
21499 (nnoo-declare nndir
21503 @code{nndir} has declared here that it intends to inherit functions from
21504 both @code{nnml} and @code{nnmh}.
21507 This macro is equivalent to @code{defvar}, but registers the variable as
21508 a public server variable. Most state-oriented variables should be
21509 declared with @code{defvoo} instead of @code{defvar}.
21511 In addition to the normal @code{defvar} parameters, it takes a list of
21512 variables in the parent backends to map the variable to when executing
21513 a function in those backends.
21516 (defvoo nndir-directory nil
21517 "Where nndir will look for groups."
21518 nnml-current-directory nnmh-current-directory)
21521 This means that @code{nnml-current-directory} will be set to
21522 @code{nndir-directory} when an @code{nnml} function is called on behalf
21523 of @code{nndir}. (The same with @code{nnmh}.)
21525 @item nnoo-define-basics
21526 This macro defines some common functions that almost all backends should
21530 (nnoo-define-basics nndir)
21534 This macro is just like @code{defun} and takes the same parameters. In
21535 addition to doing the normal @code{defun} things, it registers the
21536 function as being public so that other backends can inherit it.
21538 @item nnoo-map-functions
21539 This macro allows mapping of functions from the current backend to
21540 functions from the parent backends.
21543 (nnoo-map-functions nndir
21544 (nnml-retrieve-headers 0 nndir-current-group 0 0)
21545 (nnmh-request-article 0 nndir-current-group 0 0))
21548 This means that when @code{nndir-retrieve-headers} is called, the first,
21549 third, and fourth parameters will be passed on to
21550 @code{nnml-retrieve-headers}, while the second parameter is set to the
21551 value of @code{nndir-current-group}.
21554 This macro allows importing functions from backends. It should be the
21555 last thing in the source file, since it will only define functions that
21556 haven't already been defined.
21562 nnmh-request-newgroups)
21566 This means that calls to @code{nndir-request-list} should just be passed
21567 on to @code{nnmh-request-list}, while all public functions from
21568 @code{nnml} that haven't been defined in @code{nndir} yet should be
21573 Below is a slightly shortened version of the @code{nndir} backend.
21576 ;;; nndir.el --- single directory newsgroup access for Gnus
21577 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
21581 (require 'nnheader)
21585 (eval-when-compile (require 'cl))
21587 (nnoo-declare nndir
21590 (defvoo nndir-directory nil
21591 "Where nndir will look for groups."
21592 nnml-current-directory nnmh-current-directory)
21594 (defvoo nndir-nov-is-evil nil
21595 "*Non-nil means that nndir will never retrieve NOV headers."
21598 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
21599 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
21600 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
21602 (defvoo nndir-status-string "" nil nnmh-status-string)
21603 (defconst nndir-version "nndir 1.0")
21605 ;;; Interface functions.
21607 (nnoo-define-basics nndir)
21609 (deffoo nndir-open-server (server &optional defs)
21610 (setq nndir-directory
21611 (or (cadr (assq 'nndir-directory defs))
21613 (unless (assq 'nndir-directory defs)
21614 (push `(nndir-directory ,server) defs))
21615 (push `(nndir-current-group
21616 ,(file-name-nondirectory (directory-file-name nndir-directory)))
21618 (push `(nndir-top-directory
21619 ,(file-name-directory (directory-file-name nndir-directory)))
21621 (nnoo-change-server 'nndir server defs))
21623 (nnoo-map-functions nndir
21624 (nnml-retrieve-headers 0 nndir-current-group 0 0)
21625 (nnmh-request-article 0 nndir-current-group 0 0)
21626 (nnmh-request-group nndir-current-group 0 0)
21627 (nnmh-close-group nndir-current-group 0))
21631 nnmh-status-message
21633 nnmh-request-newgroups))
21639 @node Hooking New Backends Into Gnus
21640 @subsubsection Hooking New Backends Into Gnus
21642 @vindex gnus-valid-select-methods
21643 Having Gnus start using your new backend is rather easy---you just
21644 declare it with the @code{gnus-declare-backend} functions. This will
21645 enter the backend into the @code{gnus-valid-select-methods} variable.
21647 @code{gnus-declare-backend} takes two parameters---the backend name and
21648 an arbitrary number of @dfn{abilities}.
21653 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
21656 The abilities can be:
21660 This is a mailish backend---followups should (probably) go via mail.
21662 This is a newsish backend---followups should (probably) go via news.
21664 This backend supports both mail and news.
21666 This is neither a post nor mail backend---it's something completely
21669 It supports respooling---or rather, it is able to modify its source
21670 articles and groups.
21672 The name of the server should be in the virtual server name. This is
21673 true for almost all backends.
21674 @item prompt-address
21675 The user should be prompted for an address when doing commands like
21676 @kbd{B} in the group buffer. This is true for backends like
21677 @code{nntp}, but not @code{nnmbox}, for instance.
21681 @node Mail-like Backends
21682 @subsubsection Mail-like Backends
21684 One of the things that separate the mail backends from the rest of the
21685 backends is the heavy dependence by the mail backends on common
21686 functions in @file{nnmail.el}. For instance, here's the definition of
21687 @code{nnml-request-scan}:
21690 (deffoo nnml-request-scan (&optional group server)
21691 (setq nnml-article-file-alist nil)
21692 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
21695 It simply calls @code{nnmail-get-new-mail} with a few parameters,
21696 and @code{nnmail} takes care of all the moving and splitting of the
21699 This function takes four parameters.
21703 This should be a symbol to designate which backend is responsible for
21706 @item exit-function
21707 This function should be called after the splitting has been performed.
21709 @item temp-directory
21710 Where the temporary files should be stored.
21713 This optional argument should be a group name if the splitting is to be
21714 performed for one group only.
21717 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
21718 save each article. @var{backend}@code{-active-number} will be called to
21719 find the article number assigned to this article.
21721 The function also uses the following variables:
21722 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
21723 this backend); and @var{backend}@code{-group-alist} and
21724 @var{backend}@code{-active-file} to generate the new active file.
21725 @var{backend}@code{-group-alist} should be a group-active alist, like
21729 (("a-group" (1 . 10))
21730 ("some-group" (34 . 39)))
21734 @node Score File Syntax
21735 @subsection Score File Syntax
21737 Score files are meant to be easily parseable, but yet extremely
21738 mallable. It was decided that something that had the same read syntax
21739 as an Emacs Lisp list would fit that spec.
21741 Here's a typical score file:
21745 ("win95" -10000 nil s)
21752 BNF definition of a score file:
21755 score-file = "" / "(" *element ")"
21756 element = rule / atom
21757 rule = string-rule / number-rule / date-rule
21758 string-rule = "(" quote string-header quote space *string-match ")"
21759 number-rule = "(" quote number-header quote space *number-match ")"
21760 date-rule = "(" quote date-header quote space *date-match ")"
21762 string-header = "subject" / "from" / "references" / "message-id" /
21763 "xref" / "body" / "head" / "all" / "followup"
21764 number-header = "lines" / "chars"
21765 date-header = "date"
21766 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
21767 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
21768 score = "nil" / <integer>
21769 date = "nil" / <natural number>
21770 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
21771 "r" / "regex" / "R" / "Regex" /
21772 "e" / "exact" / "E" / "Exact" /
21773 "f" / "fuzzy" / "F" / "Fuzzy"
21774 number-match = "(" <integer> [ "" / [ space score [ "" /
21775 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
21776 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
21777 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
21778 space date [ "" / [ space date-match-t ] ] ] ] ")"
21779 date-match-t = "nil" / "at" / "before" / "after"
21780 atom = "(" [ required-atom / optional-atom ] ")"
21781 required-atom = mark / expunge / mark-and-expunge / files /
21782 exclude-files / read-only / touched
21783 optional-atom = adapt / local / eval
21784 mark = "mark" space nil-or-number
21785 nil-or-number = "nil" / <integer>
21786 expunge = "expunge" space nil-or-number
21787 mark-and-expunge = "mark-and-expunge" space nil-or-number
21788 files = "files" *[ space <string> ]
21789 exclude-files = "exclude-files" *[ space <string> ]
21790 read-only = "read-only" [ space "nil" / space "t" ]
21791 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
21792 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
21793 local = "local" *[ space "(" <string> space <form> ")" ]
21794 eval = "eval" space <form>
21795 space = *[ " " / <TAB> / <NEWLINE> ]
21798 Any unrecognized elements in a score file should be ignored, but not
21801 As you can see, white space is needed, but the type and amount of white
21802 space is irrelevant. This means that formatting of the score file is
21803 left up to the programmer---if it's simpler to just spew it all out on
21804 one looong line, then that's ok.
21806 The meaning of the various atoms are explained elsewhere in this
21807 manual (@pxref{Score File Format}).
21811 @subsection Headers
21813 Internally Gnus uses a format for storing article headers that
21814 corresponds to the @sc{nov} format in a mysterious fashion. One could
21815 almost suspect that the author looked at the @sc{nov} specification and
21816 just shamelessly @emph{stole} the entire thing, and one would be right.
21818 @dfn{Header} is a severely overloaded term. ``Header'' is used in
21819 RFC 1036 to talk about lines in the head of an article (e.g.,
21820 @code{From}). It is used by many people as a synonym for
21821 ``head''---``the header and the body''. (That should be avoided, in my
21822 opinion.) And Gnus uses a format internally that it calls ``header'',
21823 which is what I'm talking about here. This is a 9-element vector,
21824 basically, with each header (ouch) having one slot.
21826 These slots are, in order: @code{number}, @code{subject}, @code{from},
21827 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
21828 @code{xref}, and @code{extra}. There are macros for accessing and
21829 setting these slots---they all have predictable names beginning with
21830 @code{mail-header-} and @code{mail-header-set-}, respectively.
21832 All these slots contain strings, except the @code{extra} slot, which
21833 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
21839 @sc{gnus} introduced a concept that I found so useful that I've started
21840 using it a lot and have elaborated on it greatly.
21842 The question is simple: If you have a large amount of objects that are
21843 identified by numbers (say, articles, to take a @emph{wild} example)
21844 that you want to qualify as being ``included'', a normal sequence isn't
21845 very useful. (A 200,000 length sequence is a bit long-winded.)
21847 The solution is as simple as the question: You just collapse the
21851 (1 2 3 4 5 6 10 11 12)
21854 is transformed into
21857 ((1 . 6) (10 . 12))
21860 To avoid having those nasty @samp{(13 . 13)} elements to denote a
21861 lonesome object, a @samp{13} is a valid element:
21864 ((1 . 6) 7 (10 . 12))
21867 This means that comparing two ranges to find out whether they are equal
21868 is slightly tricky:
21871 ((1 . 5) 7 8 (10 . 12))
21877 ((1 . 5) (7 . 8) (10 . 12))
21880 are equal. In fact, any non-descending list is a range:
21886 is a perfectly valid range, although a pretty long-winded one. This is
21893 and is equal to the previous range.
21895 Here's a BNF definition of ranges. Of course, one must remember the
21896 semantic requirement that the numbers are non-descending. (Any number
21897 of repetition of the same number is allowed, but apt to disappear in
21901 range = simple-range / normal-range
21902 simple-range = "(" number " . " number ")"
21903 normal-range = "(" start-contents ")"
21904 contents = "" / simple-range *[ " " contents ] /
21905 number *[ " " contents ]
21908 Gnus currently uses ranges to keep track of read articles and article
21909 marks. I plan on implementing a number of range operators in C if The
21910 Powers That Be are willing to let me. (I haven't asked yet, because I
21911 need to do some more thinking on what operators I need to make life
21912 totally range-based without ever having to convert back to normal
21917 @subsection Group Info
21919 Gnus stores all permanent info on groups in a @dfn{group info} list.
21920 This list is from three to six elements (or more) long and exhaustively
21921 describes the group.
21923 Here are two example group infos; one is a very simple group while the
21924 second is a more complex one:
21927 ("no.group" 5 ((1 . 54324)))
21929 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
21930 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
21932 ((auto-expire . t) (to-address . "ding@@gnus.org")))
21935 The first element is the @dfn{group name}---as Gnus knows the group,
21936 anyway. The second element is the @dfn{subscription level}, which
21937 normally is a small integer. (It can also be the @dfn{rank}, which is a
21938 cons cell where the @code{car} is the level and the @code{cdr} is the
21939 score.) The third element is a list of ranges of read articles. The
21940 fourth element is a list of lists of article marks of various kinds.
21941 The fifth element is the select method (or virtual server, if you like).
21942 The sixth element is a list of @dfn{group parameters}, which is what
21943 this section is about.
21945 Any of the last three elements may be missing if they are not required.
21946 In fact, the vast majority of groups will normally only have the first
21947 three elements, which saves quite a lot of cons cells.
21949 Here's a BNF definition of the group info format:
21952 info = "(" group space ralevel space read
21953 [ "" / [ space marks-list [ "" / [ space method [ "" /
21954 space parameters ] ] ] ] ] ")"
21955 group = quote <string> quote
21956 ralevel = rank / level
21957 level = <integer in the range of 1 to inf>
21958 rank = "(" level "." score ")"
21959 score = <integer in the range of 1 to inf>
21961 marks-lists = nil / "(" *marks ")"
21962 marks = "(" <string> range ")"
21963 method = "(" <string> *elisp-forms ")"
21964 parameters = "(" *elisp-forms ")"
21967 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
21968 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
21971 If you have a Gnus info and want to access the elements, Gnus offers a
21972 series of macros for getting/setting these elements.
21975 @item gnus-info-group
21976 @itemx gnus-info-set-group
21977 @findex gnus-info-group
21978 @findex gnus-info-set-group
21979 Get/set the group name.
21981 @item gnus-info-rank
21982 @itemx gnus-info-set-rank
21983 @findex gnus-info-rank
21984 @findex gnus-info-set-rank
21985 Get/set the group rank (@pxref{Group Score}).
21987 @item gnus-info-level
21988 @itemx gnus-info-set-level
21989 @findex gnus-info-level
21990 @findex gnus-info-set-level
21991 Get/set the group level.
21993 @item gnus-info-score
21994 @itemx gnus-info-set-score
21995 @findex gnus-info-score
21996 @findex gnus-info-set-score
21997 Get/set the group score (@pxref{Group Score}).
21999 @item gnus-info-read
22000 @itemx gnus-info-set-read
22001 @findex gnus-info-read
22002 @findex gnus-info-set-read
22003 Get/set the ranges of read articles.
22005 @item gnus-info-marks
22006 @itemx gnus-info-set-marks
22007 @findex gnus-info-marks
22008 @findex gnus-info-set-marks
22009 Get/set the lists of ranges of marked articles.
22011 @item gnus-info-method
22012 @itemx gnus-info-set-method
22013 @findex gnus-info-method
22014 @findex gnus-info-set-method
22015 Get/set the group select method.
22017 @item gnus-info-params
22018 @itemx gnus-info-set-params
22019 @findex gnus-info-params
22020 @findex gnus-info-set-params
22021 Get/set the group parameters.
22024 All the getter functions take one parameter---the info list. The setter
22025 functions take two parameters---the info list and the new value.
22027 The last three elements in the group info aren't mandatory, so it may be
22028 necessary to extend the group info before setting the element. If this
22029 is necessary, you can just pass on a non-@code{nil} third parameter to
22030 the three final setter functions to have this happen automatically.
22033 @node Extended Interactive
22034 @subsection Extended Interactive
22035 @cindex interactive
22036 @findex gnus-interactive
22038 Gnus extends the standard Emacs @code{interactive} specification
22039 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
22040 Prefixes}). Here's an example of how this is used:
22043 (defun gnus-summary-increase-score (&optional score symp)
22044 (interactive (gnus-interactive "P\ny"))
22049 The best thing to do would have been to implement
22050 @code{gnus-interactive} as a macro which would have returned an
22051 @code{interactive} form, but this isn't possible since Emacs checks
22052 whether a function is interactive or not by simply doing an @code{assq}
22053 on the lambda form. So, instead we have @code{gnus-interactive}
22054 function that takes a string and returns values that are usable to
22055 @code{interactive}.
22057 This function accepts (almost) all normal @code{interactive} specs, but
22062 @vindex gnus-current-prefix-symbol
22063 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
22067 @vindex gnus-current-prefix-symbols
22068 A list of the current symbolic prefixes---the
22069 @code{gnus-current-prefix-symbol} variable.
22072 The current article number---the @code{gnus-summary-article-number}
22076 The current article header---the @code{gnus-summary-article-header}
22080 The current group name---the @code{gnus-group-group-name}
22086 @node Emacs/XEmacs Code
22087 @subsection Emacs/XEmacs Code
22091 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
22092 platforms must be the primary one. I chose Emacs. Not because I don't
22093 like XEmacs or Mule, but because it comes first alphabetically.
22095 This means that Gnus will byte-compile under Emacs with nary a warning,
22096 while XEmacs will pump out gigabytes of warnings while byte-compiling.
22097 As I use byte-compilation warnings to help me root out trivial errors in
22098 Gnus, that's very useful.
22100 I've also consistently used Emacs function interfaces, but have used
22101 Gnusey aliases for the functions. To take an example: Emacs defines a
22102 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
22103 function. I then define a function called @code{gnus-run-at-time} that
22104 takes the same parameters as the Emacs @code{run-at-time}. When running
22105 Gnus under Emacs, the former function is just an alias for the latter.
22106 However, when running under XEmacs, the former is an alias for the
22107 following function:
22110 (defun gnus-xmas-run-at-time (time repeat function &rest args)
22114 (,function ,@@args))
22118 This sort of thing has been done for bunches of functions. Gnus does
22119 not redefine any native Emacs functions while running under XEmacs---it
22120 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
22123 In the cases where the XEmacs function interface was obviously cleaner,
22124 I used it instead. For example @code{gnus-region-active-p} is an alias
22125 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
22127 Of course, I could have chosen XEmacs as my native platform and done
22128 mapping functions the other way around. But I didn't. The performance
22129 hit these indirections impose on Gnus under XEmacs should be slight.
22132 @node Various File Formats
22133 @subsection Various File Formats
22136 * Active File Format:: Information on articles and groups available.
22137 * Newsgroups File Format:: Group descriptions.
22141 @node Active File Format
22142 @subsubsection Active File Format
22144 The active file lists all groups available on the server in
22145 question. It also lists the highest and lowest current article numbers
22148 Here's an excerpt from a typical active file:
22151 soc.motss 296030 293865 y
22152 alt.binaries.pictures.fractals 3922 3913 n
22153 comp.sources.unix 1605 1593 m
22154 comp.binaries.ibm.pc 5097 5089 y
22155 no.general 1000 900 y
22158 Here's a pseudo-BNF definition of this file:
22161 active = *group-line
22162 group-line = group space high-number space low-number space flag <NEWLINE>
22163 group = <non-white-space string>
22165 high-number = <non-negative integer>
22166 low-number = <positive integer>
22167 flag = "y" / "n" / "m" / "j" / "x" / "=" group
22170 For a full description of this file, see the manual pages for
22171 @samp{innd}, in particular @samp{active(5)}.
22174 @node Newsgroups File Format
22175 @subsubsection Newsgroups File Format
22177 The newsgroups file lists groups along with their descriptions. Not all
22178 groups on the server have to be listed, and not all groups in the file
22179 have to exist on the server. The file is meant purely as information to
22182 The format is quite simple; a group name, a tab, and the description.
22183 Here's the definition:
22187 line = group tab description <NEWLINE>
22188 group = <non-white-space string>
22190 description = <string>
22195 @node Emacs for Heathens
22196 @section Emacs for Heathens
22198 Believe it or not, but some people who use Gnus haven't really used
22199 Emacs much before they embarked on their journey on the Gnus Love Boat.
22200 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
22201 region'', and ``set @code{gnus-flargblossen} to an alist where the key
22202 is a regexp that is used for matching on the group name'' are magical
22203 phrases with little or no meaning, then this appendix is for you. If
22204 you are already familiar with Emacs, just ignore this and go fondle your
22208 * Keystrokes:: Entering text and executing commands.
22209 * Emacs Lisp:: The built-in Emacs programming language.
22214 @subsection Keystrokes
22218 Q: What is an experienced Emacs user?
22221 A: A person who wishes that the terminal had pedals.
22224 Yes, when you use Emacs, you are apt to use the control key, the shift
22225 key and the meta key a lot. This is very annoying to some people
22226 (notably @code{vi}le users), and the rest of us just love the hell out
22227 of it. Just give up and submit. Emacs really does stand for
22228 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
22229 may have heard from other disreputable sources (like the Emacs author).
22231 The shift keys are normally located near your pinky fingers, and are
22232 normally used to get capital letters and stuff. You probably use it all
22233 the time. The control key is normally marked ``CTRL'' or something like
22234 that. The meta key is, funnily enough, never marked as such on any
22235 keyboard. The one I'm currently at has a key that's marked ``Alt'',
22236 which is the meta key on this keyboard. It's usually located somewhere
22237 to the left hand side of the keyboard, usually on the bottom row.
22239 Now, us Emacs people don't say ``press the meta-control-m key'',
22240 because that's just too inconvenient. We say ``press the @kbd{M-C-m}
22241 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
22242 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
22243 down the control key, and hold it down while you press @kbd{k}''.
22244 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
22245 the control key and then press @kbd{k}''. Simple, ay?
22247 This is somewhat complicated by the fact that not all keyboards have a
22248 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
22249 means ``press escape, release escape, press @kbd{k}''. That's much more
22250 work than if you have a meta key, so if that's the case, I respectfully
22251 suggest you get a real keyboard with a meta key. You can't live without
22257 @subsection Emacs Lisp
22259 Emacs is the King of Editors because it's really a Lisp interpreter.
22260 Each and every key you tap runs some Emacs Lisp code snippet, and since
22261 Emacs Lisp is an interpreted language, that means that you can configure
22262 any key to run any arbitrary code. You just, like, do it.
22264 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
22265 functions. (These are byte-compiled for speed, but it's still
22266 interpreted.) If you decide that you don't like the way Gnus does
22267 certain things, it's trivial to have it do something a different way.
22268 (Well, at least if you know how to write Lisp code.) However, that's
22269 beyond the scope of this manual, so we are simply going to talk about
22270 some common constructs that you normally use in your @file{.emacs} file
22273 If you want to set the variable @code{gnus-florgbnize} to four (4), you
22274 write the following:
22277 (setq gnus-florgbnize 4)
22280 This function (really ``special form'') @code{setq} is the one that can
22281 set a variable to some value. This is really all you need to know. Now
22282 you can go and fill your @code{.emacs} file with lots of these to change
22285 If you have put that thing in your @code{.emacs} file, it will be read
22286 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
22287 start Emacs. If you want to change the variable right away, simply say
22288 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
22289 previous ``form'', which is a simple @code{setq} statement here.
22291 Go ahead---just try it, if you're located at your Emacs. After you
22292 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
22293 is the return value of the form you @code{eval}ed.
22297 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
22301 (setq gnus-read-active-file 'some)
22304 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
22305 @samp{nntp.ifi.uio.no}'', that means:
22308 (setq gnus-nntp-server "nntp.ifi.uio.no")
22311 So be careful not to mix up strings (the latter) with symbols (the
22312 former). The manual is unambiguous, but it can be confusing.
22315 @include gnus-faq.texi
22336 % LocalWords: Backend BNF mucho Backends backends detailmenu cindex kindex kbd
22337 % LocalWords: findex Gnusae vindex dfn dfn samp nntp setq nnspool nntpserver
22338 % LocalWords: nnmbox backend newusers Blllrph NEWGROUPS dingnusdingnusdingnus
22339 % LocalWords: pre fab rec comp nnslashdot regex ga ga sci nnml nnbabyl nnmh
22340 % LocalWords: nnfolder emph looong eld newsreaders defun init elc pxref