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.
668 * RSS:: Reading RDF site summary.
669 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
673 * Directory Groups:: You can read a directory as if it was a newsgroup.
674 * Anything Groups:: Dired? Who needs dired?
675 * Document Groups:: Single files can be the basis of a group.
676 * SOUP:: Reading @sc{soup} packets ``offline''.
677 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
678 * IMAP:: Using Gnus as a @sc{imap} client.
682 * Document Server Internals:: How to add your own document types.
686 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
687 * SOUP Groups:: A backend for reading @sc{soup} packets.
688 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
692 * Splitting in IMAP:: Splitting mail with nnimap.
693 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
694 * Expunging mailboxes:: Equivalent of a "compress mailbox" button.
698 * Virtual Groups:: Combining articles from many groups.
699 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
703 * Agent Basics:: How it all is supposed to work.
704 * Agent Categories:: How to tell the Gnus Agent what to download.
705 * Agent Commands:: New commands for all the buffers.
706 * Agent Expiry:: How to make old articles go away.
707 * Agent and IMAP:: How to use the Agent with IMAP.
708 * Outgoing Messages:: What happens when you post/mail something?
709 * Agent Variables:: Customizing is fun.
710 * Example Setup:: An example @file{.gnus.el} file for offline people.
711 * Batching Agents:: How to fetch news from a @code{cron} job.
712 * Agent Caveats:: What you think it'll do and what it does.
716 * Category Syntax:: What a category looks like.
717 * Category Buffer:: A buffer for maintaining categories.
718 * Category Variables:: Customize'r'Us.
722 * Group Agent Commands::
723 * Summary Agent Commands::
724 * Server Agent Commands::
728 * Summary Score Commands:: Adding score entries for the current group.
729 * Group Score Commands:: General score commands.
730 * Score Variables:: Customize your scoring. (My, what terminology).
731 * Score File Format:: What a score file may contain.
732 * Score File Editing:: You can edit score files by hand as well.
733 * Adaptive Scoring:: Big Sister Gnus knows what you read.
734 * Home Score File:: How to say where new score entries are to go.
735 * Followups To Yourself:: Having Gnus notice when people answer you.
736 * Scoring Tips:: How to score effectively.
737 * Reverse Scoring:: That problem child of old is not problem.
738 * Global Score Files:: Earth-spanning, ear-splitting score files.
739 * Kill Files:: They are still here, but they can be ignored.
740 * Converting Kill Files:: Translating kill files to score files.
741 * GroupLens:: Getting predictions on what you like to read.
742 * Advanced Scoring:: Using logical expressions to build score rules.
743 * Score Decays:: It can be useful to let scores wither away.
747 * Using GroupLens:: How to make Gnus use GroupLens.
748 * Rating Articles:: Letting GroupLens know how you rate articles.
749 * Displaying Predictions:: Displaying predictions given by GroupLens.
750 * GroupLens Variables:: Customizing GroupLens.
754 * Advanced Scoring Syntax:: A definition.
755 * Advanced Scoring Examples:: What they look like.
756 * Advanced Scoring Tips:: Getting the most out of it.
760 * Process/Prefix:: A convention used by many treatment commands.
761 * Interactive:: Making Gnus ask you many questions.
762 * Symbolic Prefixes:: How to supply some Gnus functions with options.
763 * Formatting Variables:: You can specify what buffers should look like.
764 * Windows Configuration:: Configuring the Gnus buffer windows.
765 * Faces and Fonts:: How to change how faces look.
766 * Compilation:: How to speed Gnus up.
767 * Mode Lines:: Displaying information in the mode lines.
768 * Highlighting and Menus:: Making buffers look all nice and cozy.
769 * Buttons:: Get tendinitis in ten easy steps!
770 * Daemons:: Gnus can do things behind your back.
771 * NoCeM:: How to avoid spam and other fatty foods.
772 * Undo:: Some actions can be undone.
773 * Moderation:: What to do if you're a moderator.
774 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
775 * Fuzzy Matching:: What's the big fuzz?
776 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
777 * Various Various:: Things that are really various.
781 * Formatting Basics:: A formatting variable is basically a format string.
782 * Mode Line Formatting:: Some rules about mode line formatting variables.
783 * Advanced Formatting:: Modifying output in various ways.
784 * User-Defined Specs:: Having Gnus call your own functions.
785 * Formatting Fonts:: Making the formatting look colorful and nice.
789 * Picons:: How to display pictures of what your reading.
790 * Smileys:: Show all those happy faces the way they were meant to be shown.
791 * Toolbar:: Click'n'drool.
792 * XVarious:: Other XEmacsy Gnusey variables.
796 * Picon Basics:: What are picons and How do I get them.
797 * Picon Requirements:: Don't go further if you aren't using XEmacs.
798 * Easy Picons:: Displaying Picons---the easy way.
799 * Hard Picons:: The way you should do it. You'll learn something.
800 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
804 * History:: How Gnus got where it is today.
805 * On Writing Manuals:: Why this is not a beginner's guide.
806 * Terminology:: We use really difficult, like, words here.
807 * Customization:: Tailoring Gnus to your needs.
808 * Troubleshooting:: What you might try if things do not work.
809 * Gnus Reference Guide:: Rilly, rilly technical stuff.
810 * Emacs for Heathens:: A short introduction to Emacsian terms.
811 * Frequently Asked Questions:: A question-and-answer session.
815 * Gnus Versions:: What Gnus versions have been released.
816 * Other Gnus Versions:: Other Gnus versions that also have been released.
817 * Why?:: What's the point of Gnus?
818 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
819 * Conformity:: Gnus tries to conform to all standards.
820 * Emacsen:: Gnus can be run on a few modern Emacsen.
821 * Gnus Development:: How Gnus is developed.
822 * Contributors:: Oodles of people.
823 * New Features:: Pointers to some of the new stuff in Gnus.
827 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
828 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
829 * Red Gnus:: Third time best---Gnus 5.4/5.5.
830 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
831 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
835 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
836 * Slow Terminal Connection:: You run a remote Emacs.
837 * Little Disk Space:: You feel that having large setup files is icky.
838 * Slow Machine:: You feel like buying a faster machine.
842 * Gnus Utility Functions:: Common functions and variable to use.
843 * Backend Interface:: How Gnus communicates with the servers.
844 * Score File Syntax:: A BNF definition of the score file standard.
845 * Headers:: How Gnus stores headers internally.
846 * Ranges:: A handy format for storing mucho numbers.
847 * Group Info:: The group info format.
848 * Extended Interactive:: Symbolic prefixes and stuff.
849 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
850 * Various File Formats:: Formats of files that Gnus use.
854 * Required Backend Functions:: Functions that must be implemented.
855 * Optional Backend Functions:: Functions that need not be implemented.
856 * Error Messaging:: How to get messages and report errors.
857 * Writing New Backends:: Extending old backends.
858 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
859 * Mail-like Backends:: Some tips on mail backends.
863 * Active File Format:: Information on articles and groups available.
864 * Newsgroups File Format:: Group descriptions.
868 * Keystrokes:: Entering text and executing commands.
869 * Emacs Lisp:: The built-in Emacs programming language.
875 @chapter Starting Gnus
880 If your system administrator has set things up properly, starting Gnus
881 and reading news is extremely easy---you just type @kbd{M-x gnus} in
884 @findex gnus-other-frame
885 @kindex M-x gnus-other-frame
886 If you want to start Gnus in a different frame, you can use the command
887 @kbd{M-x gnus-other-frame} instead.
889 If things do not go smoothly at startup, you have to twiddle some
890 variables in your @file{~/.gnus} file. This file is similar to
891 @file{~/.emacs}, but is read when gnus starts.
893 If you puzzle at any terms used in this manual, please refer to the
894 terminology section (@pxref{Terminology}).
897 * Finding the News:: Choosing a method for getting news.
898 * The First Time:: What does Gnus do the first time you start it?
899 * The Server is Down:: How can I read my mail then?
900 * Slave Gnusae:: You can have more than one Gnus active at a time.
901 * Fetching a Group:: Starting Gnus just to read a group.
902 * New Groups:: What is Gnus supposed to do with new groups?
903 * Startup Files:: Those pesky startup files---@file{.newsrc}.
904 * Auto Save:: Recovering from a crash.
905 * The Active File:: Reading the active file over a slow line Takes Time.
906 * Changing Servers:: You may want to move from one server to another.
907 * Startup Variables:: Other variables you might change.
911 @node Finding the News
912 @section Finding the News
915 @vindex gnus-select-method
917 The @code{gnus-select-method} variable says where Gnus should look for
918 news. This variable should be a list where the first element says
919 @dfn{how} and the second element says @dfn{where}. This method is your
920 native method. All groups not fetched with this method are
923 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
924 you want to get your daily dosage of news from, you'd say:
927 (setq gnus-select-method '(nntp "news.somewhere.edu"))
930 If you want to read directly from the local spool, say:
933 (setq gnus-select-method '(nnspool ""))
936 If you can use a local spool, you probably should, as it will almost
937 certainly be much faster.
939 @vindex gnus-nntpserver-file
941 @cindex @sc{nntp} server
942 If this variable is not set, Gnus will take a look at the
943 @code{NNTPSERVER} environment variable. If that variable isn't set,
944 Gnus will see whether @code{gnus-nntpserver-file}
945 (@file{/etc/nntpserver} by default) has any opinions on the matter. If
946 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server. That's a long shot, though.
948 @vindex gnus-nntp-server
949 If @code{gnus-nntp-server} is set, this variable will override
950 @code{gnus-select-method}. You should therefore set
951 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
953 @vindex gnus-secondary-servers
954 @vindex gnus-nntp-server
955 You can also make Gnus prompt you interactively for the name of an
956 @sc{nntp} server. If you give a non-numerical prefix to @code{gnus}
957 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
958 in the @code{gnus-secondary-servers} list (if any). You can also just
959 type in the name of any server you feel like visiting. (Note that this
960 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
961 gnus} later in the same Emacs session, Gnus will contact the same
964 @findex gnus-group-browse-foreign-server
966 However, if you use one @sc{nntp} server regularly and are just
967 interested in a couple of groups from a different server, you would be
968 better served by using the @kbd{B} command in the group buffer. It will
969 let you have a look at what groups are available, and you can subscribe
970 to any of the groups you want to. This also makes @file{.newsrc}
971 maintenance much tidier. @xref{Foreign Groups}.
973 @vindex gnus-secondary-select-methods
975 A slightly different approach to foreign groups is to set the
976 @code{gnus-secondary-select-methods} variable. The select methods
977 listed in this variable are in many ways just as native as the
978 @code{gnus-select-method} server. They will also be queried for active
979 files during startup (if that's required), and new newsgroups that
980 appear on these servers will be subscribed (or not) just as native
983 For instance, if you use the @code{nnmbox} backend to read your mail, you
984 would typically set this variable to
987 (setq gnus-secondary-select-methods '((nnmbox "")))
992 @section The First Time
993 @cindex first time usage
995 If no startup files exist, Gnus will try to determine what groups should
996 be subscribed by default.
998 @vindex gnus-default-subscribed-newsgroups
999 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
1000 will subscribe you to just those groups in that list, leaving the rest
1001 killed. Your system administrator should have set this variable to
1004 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
1005 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1006 here as @dfn{whatever Lars thinks you should read}.)
1008 You'll also be subscribed to the Gnus documentation group, which should
1009 help you with most common problems.
1011 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
1012 use the normal functions for handling new groups, and not do anything
1016 @node The Server is Down
1017 @section The Server is Down
1018 @cindex server errors
1020 If the default server is down, Gnus will understandably have some
1021 problems starting. However, if you have some mail groups in addition to
1022 the news groups, you may want to start Gnus anyway.
1024 Gnus, being the trusting sort of program, will ask whether to proceed
1025 without a native select method if that server can't be contacted. This
1026 will happen whether the server doesn't actually exist (i.e., you have
1027 given the wrong address) or the server has just momentarily taken ill
1028 for some reason or other. If you decide to continue and have no foreign
1029 groups, you'll find it difficult to actually do anything in the group
1030 buffer. But, hey, that's your problem. Blllrph!
1032 @findex gnus-no-server
1033 @kindex M-x gnus-no-server
1035 If you know that the server is definitely down, or you just want to read
1036 your mail without bothering with the server at all, you can use the
1037 @code{gnus-no-server} command to start Gnus. That might come in handy
1038 if you're in a hurry as well. This command will not attempt to contact
1039 your primary server---instead, it will just activate all groups on level
1040 1 and 2. (You should preferably keep no native groups on those two
1041 levels.) Also @pxref{Group Levels}.
1045 @section Slave Gnusae
1048 You might want to run more than one Emacs with more than one Gnus at the
1049 same time. If you are using different @file{.newsrc} files (e.g., if you
1050 are using the two different Gnusae to read from two different servers),
1051 that is no problem whatsoever. You just do it.
1053 The problem appears when you want to run two Gnusae that use the same
1054 @code{.newsrc} file.
1056 To work around that problem some, we here at the Think-Tank at the Gnus
1057 Towers have come up with a new concept: @dfn{Masters} and
1058 @dfn{slaves}. (We have applied for a patent on this concept, and have
1059 taken out a copyright on those words. If you wish to use those words in
1060 conjunction with each other, you have to send $1 per usage instance to
1061 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1062 Applications}) will be much more expensive, of course.)
1064 Anyway, you start one Gnus up the normal way with @kbd{M-x gnus} (or
1065 however you do it). Each subsequent slave Gnusae should be started with
1066 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1067 files, but instead save @dfn{slave files} that contain information only
1068 on what groups have been read in the slave session. When a master Gnus
1069 starts, it will read (and delete) these slave files, incorporating all
1070 information from them. (The slave files will be read in the sequence
1071 they were created, so the latest changes will have precedence.)
1073 Information from the slave files has, of course, precedence over the
1074 information in the normal (i.e., master) @code{.newsrc} file.
1077 @node Fetching a Group
1078 @section Fetching a Group
1079 @cindex fetching a group
1081 @findex gnus-fetch-group
1082 It is sometimes convenient to be able to just say ``I want to read this
1083 group and I don't care whether Gnus has been started or not''. This is
1084 perhaps more useful for people who write code than for users, but the
1085 command @code{gnus-fetch-group} provides this functionality in any case.
1086 It takes the group name as a parameter.
1092 @cindex subscription
1094 @vindex gnus-check-new-newsgroups
1095 If you are satisfied that you really never want to see any new groups,
1096 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1097 also save you some time at startup. Even if this variable is
1098 @code{nil}, you can always subscribe to the new groups just by pressing
1099 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1100 is @code{ask-server} by default. If you set this variable to
1101 @code{always}, then Gnus will query the backends for new groups even
1102 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1105 * Checking New Groups:: Determining what groups are new.
1106 * Subscription Methods:: What Gnus should do with new groups.
1107 * Filtering New Groups:: Making Gnus ignore certain new groups.
1111 @node Checking New Groups
1112 @subsection Checking New Groups
1114 Gnus normally determines whether a group is new or not by comparing the
1115 list of groups from the active file(s) with the lists of subscribed and
1116 dead groups. This isn't a particularly fast method. If
1117 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
1118 server for new groups since the last time. This is both faster and
1119 cheaper. This also means that you can get rid of the list of killed
1120 groups altogether, so you may set @code{gnus-save-killed-list} to
1121 @code{nil}, which will save time both at startup, at exit, and all over.
1122 Saves disk space, too. Why isn't this the default, then?
1123 Unfortunately, not all servers support this command.
1125 I bet I know what you're thinking now: How do I find out whether my
1126 server supports @code{ask-server}? No? Good, because I don't have a
1127 fail-safe answer. I would suggest just setting this variable to
1128 @code{ask-server} and see whether any new groups appear within the next
1129 few days. If any do, then it works. If none do, then it doesn't
1130 work. I could write a function to make Gnus guess whether the server
1131 supports @code{ask-server}, but it would just be a guess. So I won't.
1132 You could @code{telnet} to the server and say @code{HELP} and see
1133 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1134 it does, then it might work. (But there are servers that lists
1135 @samp{NEWGROUPS} without supporting the function properly.)
1137 This variable can also be a list of select methods. If so, Gnus will
1138 issue an @code{ask-server} command to each of the select methods, and
1139 subscribe them (or not) using the normal methods. This might be handy
1140 if you are monitoring a few servers for new groups. A side effect is
1141 that startup will take much longer, so you can meditate while waiting.
1142 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1145 @node Subscription Methods
1146 @subsection Subscription Methods
1148 @vindex gnus-subscribe-newsgroup-method
1149 What Gnus does when it encounters a new group is determined by the
1150 @code{gnus-subscribe-newsgroup-method} variable.
1152 This variable should contain a function. This function will be called
1153 with the name of the new group as the only parameter.
1155 Some handy pre-fab functions are:
1159 @item gnus-subscribe-zombies
1160 @vindex gnus-subscribe-zombies
1161 Make all new groups zombies. This is the default. You can browse the
1162 zombies later (with @kbd{A z}) and either kill them all off properly
1163 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1165 @item gnus-subscribe-randomly
1166 @vindex gnus-subscribe-randomly
1167 Subscribe all new groups in arbitrary order. This really means that all
1168 new groups will be added at ``the top'' of the group buffer.
1170 @item gnus-subscribe-alphabetically
1171 @vindex gnus-subscribe-alphabetically
1172 Subscribe all new groups in alphabetical order.
1174 @item gnus-subscribe-hierarchically
1175 @vindex gnus-subscribe-hierarchically
1176 Subscribe all new groups hierarchically. The difference between this
1177 function and @code{gnus-subscribe-alphabetically} is slight.
1178 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1179 alphabetical fashion, while this function will enter groups into its
1180 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1181 @samp{comp} hierarchy, this function will not mess that configuration
1182 up. Or something like that.
1184 @item gnus-subscribe-interactively
1185 @vindex gnus-subscribe-interactively
1186 Subscribe new groups interactively. This means that Gnus will ask
1187 you about @strong{all} new groups. The groups you choose to subscribe
1188 to will be subscribed hierarchically.
1190 @item gnus-subscribe-killed
1191 @vindex gnus-subscribe-killed
1192 Kill all new groups.
1194 @item gnus-subscribe-topics
1195 @vindex gnus-subscribe-topics
1196 Put the groups into the topic that has a matching @code{subscribe} topic
1197 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1198 topic parameter that looks like
1204 will mean that all groups that match that regex will be subscribed under
1207 If no topics match the groups, the groups will be subscribed in the
1212 @vindex gnus-subscribe-hierarchical-interactive
1213 A closely related variable is
1214 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1215 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
1216 hierarchical fashion whether to subscribe to new groups or not. Gnus
1217 will ask you for each sub-hierarchy whether you want to descend the
1220 One common mistake is to set the variable a few paragraphs above
1221 (@code{gnus-subscribe-newsgroup-method}) to
1222 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1223 will not work. This is ga-ga. So don't do it.
1226 @node Filtering New Groups
1227 @subsection Filtering New Groups
1229 A nice and portable way to control which new newsgroups should be
1230 subscribed (or ignored) is to put an @dfn{options} line at the start of
1231 the @file{.newsrc} file. Here's an example:
1234 options -n !alt.all !rec.all sci.all
1237 @vindex gnus-subscribe-options-newsgroup-method
1238 This line obviously belongs to a serious-minded intellectual scientific
1239 person (or she may just be plain old boring), because it says that all
1240 groups that have names beginning with @samp{alt} and @samp{rec} should
1241 be ignored, and all groups with names beginning with @samp{sci} should
1242 be subscribed. Gnus will not use the normal subscription method for
1243 subscribing these groups.
1244 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1245 variable defaults to @code{gnus-subscribe-alphabetically}.
1247 @vindex gnus-options-not-subscribe
1248 @vindex gnus-options-subscribe
1249 If you don't want to mess with your @file{.newsrc} file, you can just
1250 set the two variables @code{gnus-options-subscribe} and
1251 @code{gnus-options-not-subscribe}. These two variables do exactly the
1252 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1253 and if the new group matches the former, it will be unconditionally
1254 subscribed, and if it matches the latter, it will be ignored.
1256 @vindex gnus-auto-subscribed-groups
1257 Yet another variable that meddles here is
1258 @code{gnus-auto-subscribed-groups}. It works exactly like
1259 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
1260 thought it would be nice to have two of these. This variable is more
1261 meant for setting some ground rules, while the other variable is used
1262 more for user fiddling. By default this variable makes all new groups
1263 that come from mail backends (@code{nnml}, @code{nnbabyl},
1264 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed. If you
1265 don't like that, just set this variable to @code{nil}.
1267 New groups that match this regexp are subscribed using
1268 @code{gnus-subscribe-options-newsgroup-method}.
1271 @node Changing Servers
1272 @section Changing Servers
1273 @cindex changing servers
1275 Sometimes it is necessary to move from one @sc{nntp} server to another.
1276 This happens very rarely, but perhaps you change jobs, or one server is
1277 very flaky and you want to use another.
1279 Changing the server is pretty easy, right? You just change
1280 @code{gnus-select-method} to point to the new server?
1284 Article numbers are not (in any way) kept synchronized between different
1285 @sc{nntp} servers, and the only way Gnus keeps track of what articles
1286 you have read is by keeping track of article numbers. So when you
1287 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1290 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1291 file from one server to another. They all have one thing in
1292 common---they take a looong time to run. You don't want to use these
1293 functions more than absolutely necessary.
1295 @kindex M-x gnus-change-server
1296 @findex gnus-change-server
1297 If you have access to both servers, Gnus can request the headers for all
1298 the articles you have read and compare @code{Message-ID}s and map the
1299 article numbers of the read articles and article marks. The @kbd{M-x
1300 gnus-change-server} command will do this for all your native groups. It
1301 will prompt for the method you want to move to.
1303 @kindex M-x gnus-group-move-group-to-server
1304 @findex gnus-group-move-group-to-server
1305 You can also move individual groups with the @kbd{M-x
1306 gnus-group-move-group-to-server} command. This is useful if you want to
1307 move a (foreign) group from one server to another.
1309 @kindex M-x gnus-group-clear-data-on-native-groups
1310 @findex gnus-group-clear-data-on-native-groups
1311 If you don't have access to both the old and new server, all your marks
1312 and read ranges have become worthless. You can use the @kbd{M-x
1313 gnus-group-clear-data-on-native-groups} command to clear out all data
1314 that you have on your native groups. Use with caution.
1316 After changing servers, you @strong{must} move the cache hierarchy away,
1317 since the cached articles will have wrong article numbers, which will
1318 affect which articles Gnus thinks are read.
1322 @section Startup Files
1323 @cindex startup files
1328 Now, you all know about the @file{.newsrc} file. All subscription
1329 information is traditionally stored in this file.
1331 Things got a bit more complicated with @sc{gnus}. In addition to
1332 keeping the @file{.newsrc} file updated, it also used a file called
1333 @file{.newsrc.el} for storing all the information that didn't fit into
1334 the @file{.newsrc} file. (Actually, it also duplicated everything in
1335 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1336 files was the most recently saved, which enabled people to swap between
1337 @sc{gnus} and other newsreaders.
1339 That was kinda silly, so Gnus went one better: In addition to the
1340 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1341 @file{.newsrc.eld}. It will read whichever of these files that are most
1342 recent, but it will never write a @file{.newsrc.el} file. You should
1343 never delete the @file{.newsrc.eld} file---it contains much information
1344 not stored in the @file{.newsrc} file.
1346 @vindex gnus-save-newsrc-file
1347 @vindex gnus-read-newsrc-file
1348 You can turn off writing the @file{.newsrc} file by setting
1349 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1350 the file and save some space, as well as exiting from Gnus faster.
1351 However, this will make it impossible to use other newsreaders than
1352 Gnus. But hey, who would want to, right? Similarly, setting
1353 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
1354 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1355 convenient if you have a tendency to use Netscape once in a while.
1357 @vindex gnus-save-killed-list
1358 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1359 will not save the list of killed groups to the startup file. This will
1360 save both time (when starting and quitting) and space (on disk). It
1361 will also mean that Gnus has no record of what groups are new or old,
1362 so the automatic new groups subscription methods become meaningless.
1363 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1364 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1365 Groups}). This variable can also be a regular expression. If that's
1366 the case, remove all groups that do not match this regexp before
1367 saving. This can be useful in certain obscure situations that involve
1368 several servers where not all servers support @code{ask-server}.
1370 @vindex gnus-startup-file
1371 The @code{gnus-startup-file} variable says where the startup files are.
1372 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1373 file being whatever that one is, with a @samp{.eld} appended.
1375 @vindex gnus-save-newsrc-hook
1376 @vindex gnus-save-quick-newsrc-hook
1377 @vindex gnus-save-standard-newsrc-hook
1378 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1379 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1380 saving the @file{.newsrc.eld} file, and
1381 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1382 @file{.newsrc} file. The latter two are commonly used to turn version
1383 control on or off. Version control is on by default when saving the
1384 startup files. If you want to turn backup creation off, say something like:
1387 (defun turn-off-backup ()
1388 (set (make-local-variable 'backup-inhibited) t))
1390 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1391 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1394 @vindex gnus-init-file
1395 When Gnus starts, it will read the @code{gnus-site-init-file}
1396 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1397 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1398 and can be used to avoid cluttering your @file{~/.emacs} and
1399 @file{site-init} files with Gnus stuff. Gnus will also check for files
1400 with the same names as these, but with @file{.elc} and @file{.el}
1401 suffixes. In other words, if you have set @code{gnus-init-file} to
1402 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1403 and finally @file{~/.gnus} (in this order).
1409 @cindex dribble file
1412 Whenever you do something that changes the Gnus data (reading articles,
1413 catching up, killing/subscribing groups), the change is added to a
1414 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1415 Emacs way. If your Emacs should crash before you have saved the
1416 @file{.newsrc} files, all changes you have made can be recovered from
1419 If Gnus detects this file at startup, it will ask the user whether to
1420 read it. The auto save file is deleted whenever the real startup file is
1423 @vindex gnus-use-dribble-file
1424 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
1425 maintain a dribble buffer. The default is @code{t}.
1427 @vindex gnus-dribble-directory
1428 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1429 this variable is @code{nil}, which it is by default, Gnus will dribble
1430 into the directory where the @file{.newsrc} file is located. (This is
1431 normally the user's home directory.) The dribble file will get the same
1432 file permissions as the @code{.newsrc} file.
1434 @vindex gnus-always-read-dribble-file
1435 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1436 read the dribble file on startup without querying the user.
1439 @node The Active File
1440 @section The Active File
1442 @cindex ignored groups
1444 When Gnus starts, or indeed whenever it tries to determine whether new
1445 articles have arrived, it reads the active file. This is a very large
1446 file that lists all the active groups and articles on the server.
1448 @vindex gnus-ignored-newsgroups
1449 Before examining the active file, Gnus deletes all lines that match the
1450 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1451 any groups with bogus names, but you can use this variable to make Gnus
1452 ignore hierarchies you aren't ever interested in. However, this is not
1453 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1454 Groups} for an overview of other variables that can be used instead.
1457 @c @code{nil} by default, and will slow down active file handling somewhat
1458 @c if you set it to anything else.
1460 @vindex gnus-read-active-file
1462 The active file can be rather Huge, so if you have a slow network, you
1463 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
1464 reading the active file. This variable is @code{some} by default.
1466 Gnus will try to make do by getting information just on the groups that
1467 you actually subscribe to.
1469 Note that if you subscribe to lots and lots of groups, setting this
1470 variable to @code{nil} will probably make Gnus slower, not faster. At
1471 present, having this variable @code{nil} will slow Gnus down
1472 considerably, unless you read news over a 2400 baud modem.
1474 This variable can also have the value @code{some}. Gnus will then
1475 attempt to read active info only on the subscribed groups. On some
1476 servers this is quite fast (on sparkling, brand new INN servers that
1477 support the @code{LIST ACTIVE group} command), on others this isn't fast
1478 at all. In any case, @code{some} should be faster than @code{nil}, and
1479 is certainly faster than @code{t} over slow lines.
1481 Some news servers (old versions of Leafnode and old versions of INN, for
1482 instance) do not support the @code{LIST ACTIVE group}. For these
1483 servers, @code{nil} is probably the most efficient value for this
1486 If this variable is @code{nil}, Gnus will ask for group info in total
1487 lock-step, which isn't very fast. If it is @code{some} and you use an
1488 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
1489 read all the replies in one swoop. This will normally result in better
1490 performance, but if the server does not support the aforementioned
1491 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1493 If you think that starting up Gnus takes too long, try all the three
1494 different values for this variable and see what works best for you.
1496 In any case, if you use @code{some} or @code{nil}, you should definitely
1497 kill all groups that you aren't interested in to speed things up.
1499 Note that this variable also affects active file retrieval from
1500 secondary select methods.
1503 @node Startup Variables
1504 @section Startup Variables
1508 @item gnus-load-hook
1509 @vindex gnus-load-hook
1510 A hook run while Gnus is being loaded. Note that this hook will
1511 normally be run just once in each Emacs session, no matter how many
1512 times you start Gnus.
1514 @item gnus-before-startup-hook
1515 @vindex gnus-before-startup-hook
1516 A hook run after starting up Gnus successfully.
1518 @item gnus-startup-hook
1519 @vindex gnus-startup-hook
1520 A hook run as the very last thing after starting up Gnus
1522 @item gnus-started-hook
1523 @vindex gnus-started-hook
1524 A hook that is run as the very last thing after starting up Gnus
1527 @item gnus-setup-news-hook
1528 @vindex gnus-setup-news-hook
1529 A hook that is run after reading the @file{.newsrc} file(s), but before
1530 generating the group buffer.
1532 @item gnus-check-bogus-newsgroups
1533 @vindex gnus-check-bogus-newsgroups
1534 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1535 startup. A @dfn{bogus group} is a group that you have in your
1536 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1537 bogus groups can take quite a while, so to save time and resources it's
1538 best to leave this option off, and do the checking for bogus groups once
1539 in a while from the group buffer instead (@pxref{Group Maintenance}).
1541 @item gnus-inhibit-startup-message
1542 @vindex gnus-inhibit-startup-message
1543 If non-@code{nil}, the startup message won't be displayed. That way,
1544 your boss might not notice as easily that you are reading news instead
1545 of doing your job. Note that this variable is used before
1546 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1548 @item gnus-no-groups-message
1549 @vindex gnus-no-groups-message
1550 Message displayed by Gnus when no groups are available.
1552 @item gnus-play-startup-jingle
1553 @vindex gnus-play-startup-jingle
1554 If non-@code{nil}, play the Gnus jingle at startup.
1556 @item gnus-startup-jingle
1557 @vindex gnus-startup-jingle
1558 Jingle to be played if the above variable is non-@code{nil}. The
1559 default is @samp{Tuxedomoon.Jingle4.au}.
1565 @chapter Group Buffer
1566 @cindex group buffer
1568 The @dfn{group buffer} lists all (or parts) of the available groups. It
1569 is the first buffer shown when Gnus starts, and will never be killed as
1570 long as Gnus is active.
1574 \gnusfigure{The Group Buffer}{320}{
1575 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1576 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1577 \put(120,38){\vector(1,2){10}}
1578 \put(40,60){\makebox(0,0)[r]{Mode line}}
1579 \put(40,58){\vector(1,0){30}}
1580 \put(200,28){\makebox(0,0)[t]{Native select method}}
1581 \put(200,26){\vector(-1,2){15}}
1587 * Group Buffer Format:: Information listed and how you can change it.
1588 * Group Maneuvering:: Commands for moving in the group buffer.
1589 * Selecting a Group:: Actually reading news.
1590 * Group Data:: Changing the info for a group.
1591 * Subscription Commands:: Unsubscribing, killing, subscribing.
1592 * Group Levels:: Levels? What are those, then?
1593 * Group Score:: A mechanism for finding out what groups you like.
1594 * Marking Groups:: You can mark groups for later processing.
1595 * Foreign Groups:: Creating and editing groups.
1596 * Group Parameters:: Each group may have different parameters set.
1597 * Listing Groups:: Gnus can list various subsets of the groups.
1598 * Sorting Groups:: Re-arrange the group order.
1599 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1600 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1601 * Exiting Gnus:: Stop reading news and get some work done.
1602 * Group Topics:: A folding group mode divided into topics.
1603 * Misc Group Stuff:: Other stuff that you can to do.
1607 @node Group Buffer Format
1608 @section Group Buffer Format
1611 * Group Line Specification:: Deciding how the group buffer is to look.
1612 * Group Modeline Specification:: The group buffer modeline.
1613 * Group Highlighting:: Having nice colors in the group buffer.
1617 @node Group Line Specification
1618 @subsection Group Line Specification
1619 @cindex group buffer format
1621 The default format of the group buffer is nice and dull, but you can
1622 make it as exciting and ugly as you feel like.
1624 Here's a couple of example group lines:
1627 25: news.announce.newusers
1628 * 0: alt.fan.andrea-dworkin
1633 You can see that there are 25 unread articles in
1634 @samp{news.announce.newusers}. There are no unread articles, but some
1635 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1636 asterisk at the beginning of the line?).
1638 @vindex gnus-group-line-format
1639 You can change that format to whatever you want by fiddling with the
1640 @code{gnus-group-line-format} variable. This variable works along the
1641 lines of a @code{format} specification, which is pretty much the same as
1642 a @code{printf} specifications, for those of you who use (feh!) C.
1643 @xref{Formatting Variables}.
1645 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1647 There should always be a colon on the line; the cursor always moves to
1648 the colon after performing an operation. Nothing else is required---not
1649 even the group name. All displayed text is just window dressing, and is
1650 never examined by Gnus. Gnus stores all real information it needs using
1653 (Note that if you make a really strange, wonderful, spreadsheet-like
1654 layout, everybody will believe you are hard at work with the accounting
1655 instead of wasting time reading news.)
1657 Here's a list of all available format characters:
1662 An asterisk if the group only has marked articles.
1665 Whether the group is subscribed.
1668 Level of subscribedness.
1671 Number of unread articles.
1674 Number of dormant articles.
1677 Number of ticked articles.
1680 Number of read articles.
1683 Estimated total number of articles. (This is really @var{max-number}
1684 minus @var{min-number} plus 1.)
1687 Number of unread, unticked, non-dormant articles.
1690 Number of ticked and dormant articles.
1699 Newsgroup description.
1702 @samp{m} if moderated.
1705 @samp{(m)} if moderated.
1714 A string that looks like @samp{<%s:%n>} if a foreign select method is
1718 Indentation based on the level of the topic (@pxref{Group Topics}).
1721 @vindex gnus-group-uncollapsed-levels
1722 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1723 variable says how many levels to leave at the end of the group name.
1724 The default is 1---this will mean that group names like
1725 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1728 @vindex gnus-new-mail-mark
1730 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1734 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1737 A string that says when you last read the group (@pxref{Group
1741 User defined specifier. The next character in the format string should
1742 be a letter. Gnus will call the function
1743 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1744 following @samp{%u}. The function will be passed a single dummy
1745 parameter as argument. The function should return a string, which will
1746 be inserted into the buffer just like information from any other
1751 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1752 if no info is available---for instance, if it is a non-activated foreign
1753 group, or a bogus native group.
1756 @node Group Modeline Specification
1757 @subsection Group Modeline Specification
1758 @cindex group modeline
1760 @vindex gnus-group-mode-line-format
1761 The mode line can be changed by setting
1762 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1763 doesn't understand that many format specifiers:
1767 The native news server.
1769 The native select method.
1773 @node Group Highlighting
1774 @subsection Group Highlighting
1775 @cindex highlighting
1776 @cindex group highlighting
1778 @vindex gnus-group-highlight
1779 Highlighting in the group buffer is controlled by the
1780 @code{gnus-group-highlight} variable. This is an alist with elements
1781 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1782 something non-@code{nil}, the @var{face} will be used on the line.
1784 Here's an example value for this variable that might look nice if the
1788 (cond (window-system
1789 (setq custom-background-mode 'light)
1790 (defface my-group-face-1
1791 '((t (:foreground "Red" :bold t))) "First group face")
1792 (defface my-group-face-2
1793 '((t (:foreground "DarkSeaGreen4" :bold t))) "Second group face")
1794 (defface my-group-face-3
1795 '((t (:foreground "Green4" :bold t))) "Third group face")
1796 (defface my-group-face-4
1797 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1798 (defface my-group-face-5
1799 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1801 (setq gnus-group-highlight
1802 '(((> unread 200) . my-group-face-1)
1803 ((and (< level 3) (zerop unread)) . my-group-face-2)
1804 ((< level 3) . my-group-face-3)
1805 ((zerop unread) . my-group-face-4)
1806 (t . my-group-face-5)))
1809 Also @pxref{Faces and Fonts}.
1811 Variables that are dynamically bound when the forms are evaluated
1818 The number of unread articles in the group.
1822 Whether the group is a mail group.
1824 The level of the group.
1826 The score of the group.
1828 The number of ticked articles in the group.
1830 The total number of articles in the group. Or rather, MAX-NUMBER minus
1831 MIN-NUMBER plus one.
1833 When using the topic minor mode, this variable is bound to the current
1834 topic being inserted.
1837 When the forms are @code{eval}ed, point is at the beginning of the line
1838 of the group in question, so you can use many of the normal Gnus
1839 functions for snarfing info on the group.
1841 @vindex gnus-group-update-hook
1842 @findex gnus-group-highlight-line
1843 @code{gnus-group-update-hook} is called when a group line is changed.
1844 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1845 calls @code{gnus-group-highlight-line} by default.
1848 @node Group Maneuvering
1849 @section Group Maneuvering
1850 @cindex group movement
1852 All movement commands understand the numeric prefix and will behave as
1853 expected, hopefully.
1859 @findex gnus-group-next-unread-group
1860 Go to the next group that has unread articles
1861 (@code{gnus-group-next-unread-group}).
1867 @findex gnus-group-prev-unread-group
1868 Go to the previous group that has unread articles
1869 (@code{gnus-group-prev-unread-group}).
1873 @findex gnus-group-next-group
1874 Go to the next group (@code{gnus-group-next-group}).
1878 @findex gnus-group-prev-group
1879 Go to the previous group (@code{gnus-group-prev-group}).
1883 @findex gnus-group-next-unread-group-same-level
1884 Go to the next unread group on the same (or lower) level
1885 (@code{gnus-group-next-unread-group-same-level}).
1889 @findex gnus-group-prev-unread-group-same-level
1890 Go to the previous unread group on the same (or lower) level
1891 (@code{gnus-group-prev-unread-group-same-level}).
1894 Three commands for jumping to groups:
1900 @findex gnus-group-jump-to-group
1901 Jump to a group (and make it visible if it isn't already)
1902 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
1907 @findex gnus-group-best-unread-group
1908 Jump to the unread group with the lowest level
1909 (@code{gnus-group-best-unread-group}).
1913 @findex gnus-group-first-unread-group
1914 Jump to the first group with unread articles
1915 (@code{gnus-group-first-unread-group}).
1918 @vindex gnus-group-goto-unread
1919 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1920 commands will move to the next group, not the next unread group. Even
1921 the commands that say they move to the next unread group. The default
1925 @node Selecting a Group
1926 @section Selecting a Group
1927 @cindex group selection
1932 @kindex SPACE (Group)
1933 @findex gnus-group-read-group
1934 Select the current group, switch to the summary buffer and display the
1935 first unread article (@code{gnus-group-read-group}). If there are no
1936 unread articles in the group, or if you give a non-numerical prefix to
1937 this command, Gnus will offer to fetch all the old articles in this
1938 group from the server. If you give a numerical prefix @var{N}, @var{N}
1939 determines the number of articles Gnus will fetch. If @var{N} is
1940 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1941 negative, Gnus fetches the @code{abs(@var{N})} oldest articles.
1943 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
1944 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
1945 - 4 2 SPC} fetches the 42 oldest ones.
1947 When you are in the group (in the Summary buffer), you can type
1948 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
1953 @findex gnus-group-select-group
1954 Select the current group and switch to the summary buffer
1955 (@code{gnus-group-select-group}). Takes the same arguments as
1956 @code{gnus-group-read-group}---the only difference is that this command
1957 does not display the first unread article automatically upon group
1961 @kindex M-RET (Group)
1962 @findex gnus-group-quick-select-group
1963 This does the same as the command above, but tries to do it with the
1964 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
1965 scoring/killing will be performed, there will be no highlights and no
1966 expunging. This might be useful if you're in a real hurry and have to
1967 enter some humongous group. If you give a 0 prefix to this command
1968 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
1969 which is useful if you want to toggle threading before generating the
1970 summary buffer (@pxref{Summary Generation Commands}).
1973 @kindex M-SPACE (Group)
1974 @findex gnus-group-visible-select-group
1975 This is yet one more command that does the same as the @kbd{RET}
1976 command, but this one does it without expunging and hiding dormants
1977 (@code{gnus-group-visible-select-group}).
1980 @kindex M-C-RET (Group)
1981 @findex gnus-group-select-group-ephemerally
1982 Finally, this command selects the current group ephemerally without
1983 doing any processing of its contents
1984 (@code{gnus-group-select-group-ephemerally}). Even threading has been
1985 turned off. Everything you do in the group after selecting it in this
1986 manner will have no permanent effects.
1990 @vindex gnus-large-newsgroup
1991 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1992 to be a big group. This is 200 by default. If the group has more
1993 (unread and/or ticked) articles than this, Gnus will query the user
1994 before entering the group. The user can then specify how many articles
1995 should be fetched from the server. If the user specifies a negative
1996 number (@code{-n}), the @code{n} oldest articles will be fetched. If it
1997 is positive, the @code{n} articles that have arrived most recently will
2000 @vindex gnus-select-group-hook
2001 @vindex gnus-auto-select-first
2002 @code{gnus-auto-select-first} control whether any articles are selected
2003 automatically when entering a group with the @kbd{SPACE} command.
2008 Don't select any articles when entering the group. Just display the
2009 full summary buffer.
2012 Select the first unread article when entering the group.
2015 Select the highest scored article in the group when entering the
2020 This variable can also be a function. In that case, that function will
2021 be called to place point on a subject line, and/or select some article.
2022 Useful functions include:
2025 @item gnus-summary-first-unread-subject
2026 Place point on the subject line of the first unread article, but
2027 don't select the article.
2029 @item gnus-summary-first-unread-article
2030 Select the first unread article.
2032 @item gnus-summary-best-unread-article
2033 Select the highest-scored unread article.
2037 If you want to prevent automatic selection in some group (say, in a
2038 binary group with Huge articles) you can set this variable to @code{nil}
2039 in @code{gnus-select-group-hook}, which is called when a group is
2043 @node Subscription Commands
2044 @section Subscription Commands
2045 @cindex subscription
2053 @findex gnus-group-unsubscribe-current-group
2054 @c @icon{gnus-group-unsubscribe}
2055 Toggle subscription to the current group
2056 (@code{gnus-group-unsubscribe-current-group}).
2062 @findex gnus-group-unsubscribe-group
2063 Prompt for a group to subscribe, and then subscribe it. If it was
2064 subscribed already, unsubscribe it instead
2065 (@code{gnus-group-unsubscribe-group}).
2071 @findex gnus-group-kill-group
2072 @c @icon{gnus-group-kill-group}
2073 Kill the current group (@code{gnus-group-kill-group}).
2079 @findex gnus-group-yank-group
2080 Yank the last killed group (@code{gnus-group-yank-group}).
2083 @kindex C-x C-t (Group)
2084 @findex gnus-group-transpose-groups
2085 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2086 really a subscription command, but you can use it instead of a
2087 kill-and-yank sequence sometimes.
2093 @findex gnus-group-kill-region
2094 Kill all groups in the region (@code{gnus-group-kill-region}).
2098 @findex gnus-group-kill-all-zombies
2099 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2102 @kindex S C-k (Group)
2103 @findex gnus-group-kill-level
2104 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2105 These groups can't be yanked back after killing, so this command should
2106 be used with some caution. The only time where this command comes in
2107 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2108 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2109 kill off all unsubscribed groups that do not have message numbers in the
2110 @file{.newsrc} file.
2114 Also @pxref{Group Levels}.
2124 @findex gnus-group-catchup-current
2125 @vindex gnus-group-catchup-group-hook
2126 @c @icon{gnus-group-catchup-current}
2127 Mark all unticked articles in this group as read
2128 (@code{gnus-group-catchup-current}).
2129 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2134 @findex gnus-group-catchup-current-all
2135 Mark all articles in this group, even the ticked ones, as read
2136 (@code{gnus-group-catchup-current-all}).
2140 @findex gnus-group-clear-data
2141 Clear the data from the current group---nix out marks and the list of
2142 read articles (@code{gnus-group-clear-data}).
2144 @item M-x gnus-group-clear-data-on-native-groups
2145 @kindex M-x gnus-group-clear-data-on-native-groups
2146 @findex gnus-group-clear-data-on-native-groups
2147 If you have switched from one @sc{nntp} server to another, all your marks
2148 and read ranges have become worthless. You can use this command to
2149 clear out all data that you have on your native groups. Use with
2156 @section Group Levels
2160 All groups have a level of @dfn{subscribedness}. For instance, if a
2161 group is on level 2, it is more subscribed than a group on level 5. You
2162 can ask Gnus to just list groups on a given level or lower
2163 (@pxref{Listing Groups}), or to just check for new articles in groups on
2164 a given level or lower (@pxref{Scanning New Messages}).
2166 Remember: The higher the level of the group, the less important it is.
2172 @findex gnus-group-set-current-level
2173 Set the level of the current group. If a numeric prefix is given, the
2174 next @var{n} groups will have their levels set. The user will be
2175 prompted for a level.
2178 @vindex gnus-level-killed
2179 @vindex gnus-level-zombie
2180 @vindex gnus-level-unsubscribed
2181 @vindex gnus-level-subscribed
2182 Gnus considers groups from levels 1 to
2183 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2184 @code{gnus-level-subscribed} (exclusive) and
2185 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2186 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2187 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2188 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2189 same, but zombie and killed groups have no information on what articles
2190 you have read, etc, stored. This distinction between dead and living
2191 groups isn't done because it is nice or clever, it is done purely for
2192 reasons of efficiency.
2194 It is recommended that you keep all your mail groups (if any) on quite
2195 low levels (e.g. 1 or 2).
2197 Maybe the following description of the default behavior of Gnus helps to
2198 understand what these levels are all about. By default, Gnus shows you
2199 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2200 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2201 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2202 groups are hidden, in a way.
2204 Zombie and killed groups are similar to unsubscribed groups in that they
2205 are hidden by default. But they are different from subscribed and
2206 unsubscribed groups in that Gnus doesn't ask the news server for
2207 information (number of messages, number of unread messages) on zombie
2208 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2209 aren't interested in. If most groups are killed, Gnus is faster.
2211 Why does Gnus distinguish between zombie and killed groups? Well, when
2212 a new group arrives on the server, Gnus by default makes it a zombie
2213 group. This means that you are normally not bothered with new groups,
2214 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2215 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2216 list of killed groups.)
2218 If you want to play with the level variables, you should show some care.
2219 Set them once, and don't touch them ever again. Better yet, don't touch
2220 them at all unless you know exactly what you're doing.
2222 @vindex gnus-level-default-unsubscribed
2223 @vindex gnus-level-default-subscribed
2224 Two closely related variables are @code{gnus-level-default-subscribed}
2225 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2226 which are the levels that new groups will be put on if they are
2227 (un)subscribed. These two variables should, of course, be inside the
2228 relevant valid ranges.
2230 @vindex gnus-keep-same-level
2231 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2232 will only move to groups of the same level (or lower). In
2233 particular, going from the last article in one group to the next group
2234 will go to the next group of the same level (or lower). This might be
2235 handy if you want to read the most important groups before you read the
2238 If this variable is @code{best}, Gnus will make the next newsgroup the
2239 one with the best level.
2241 @vindex gnus-group-default-list-level
2242 All groups with a level less than or equal to
2243 @code{gnus-group-default-list-level} will be listed in the group buffer
2246 @vindex gnus-group-list-inactive-groups
2247 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2248 groups will be listed along with the unread groups. This variable is
2249 @code{t} by default. If it is @code{nil}, inactive groups won't be
2252 @vindex gnus-group-use-permanent-levels
2253 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2254 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2255 use this level as the ``work'' level.
2257 @vindex gnus-activate-level
2258 Gnus will normally just activate (i. e., query the server about) groups
2259 on level @code{gnus-activate-level} or less. If you don't want to
2260 activate unsubscribed groups, for instance, you might set this variable
2261 to 5. The default is 6.
2265 @section Group Score
2270 You would normally keep important groups on high levels, but that scheme
2271 is somewhat restrictive. Don't you wish you could have Gnus sort the
2272 group buffer according to how often you read groups, perhaps? Within
2275 This is what @dfn{group score} is for. You can have Gnus assign a score
2276 to each group through the mechanism described below. You can then sort
2277 the group buffer based on this score. Alternatively, you can sort on
2278 score and then level. (Taken together, the level and the score is
2279 called the @dfn{rank} of the group. A group that is on level 4 and has
2280 a score of 1 has a higher rank than a group on level 5 that has a score
2281 of 300. (The level is the most significant part and the score is the
2282 least significant part.))
2284 @findex gnus-summary-bubble-group
2285 If you want groups you read often to get higher scores than groups you
2286 read seldom you can add the @code{gnus-summary-bubble-group} function to
2287 the @code{gnus-summary-exit-hook} hook. This will result (after
2288 sorting) in a bubbling sort of action. If you want to see that in
2289 action after each summary exit, you can add
2290 @code{gnus-group-sort-groups-by-rank} or
2291 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2292 slow things down somewhat.
2295 @node Marking Groups
2296 @section Marking Groups
2297 @cindex marking groups
2299 If you want to perform some command on several groups, and they appear
2300 subsequently in the group buffer, you would normally just give a
2301 numerical prefix to the command. Most group commands will then do your
2302 bidding on those groups.
2304 However, if the groups are not in sequential order, you can still
2305 perform a command on several groups. You simply mark the groups first
2306 with the process mark and then execute the command.
2314 @findex gnus-group-mark-group
2315 Set the mark on the current group (@code{gnus-group-mark-group}).
2321 @findex gnus-group-unmark-group
2322 Remove the mark from the current group
2323 (@code{gnus-group-unmark-group}).
2327 @findex gnus-group-unmark-all-groups
2328 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2332 @findex gnus-group-mark-region
2333 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2337 @findex gnus-group-mark-buffer
2338 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2342 @findex gnus-group-mark-regexp
2343 Mark all groups that match some regular expression
2344 (@code{gnus-group-mark-regexp}).
2347 Also @pxref{Process/Prefix}.
2349 @findex gnus-group-universal-argument
2350 If you want to execute some command on all groups that have been marked
2351 with the process mark, you can use the @kbd{M-&}
2352 (@code{gnus-group-universal-argument}) command. It will prompt you for
2353 the command to be executed.
2356 @node Foreign Groups
2357 @section Foreign Groups
2358 @cindex foreign groups
2360 Below are some group mode commands for making and editing general foreign
2361 groups, as well as commands to ease the creation of a few
2362 special-purpose groups. All these commands insert the newly created
2363 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2370 @findex gnus-group-make-group
2371 @cindex making groups
2372 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2373 for a name, a method and possibly an @dfn{address}. For an easier way
2374 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
2378 @findex gnus-group-rename-group
2379 @cindex renaming groups
2380 Rename the current group to something else
2381 (@code{gnus-group-rename-group}). This is valid only on some
2382 groups---mail groups mostly. This command might very well be quite slow
2388 @findex gnus-group-customize
2389 Customize the group parameters (@code{gnus-group-customize}).
2393 @findex gnus-group-edit-group-method
2394 @cindex renaming groups
2395 Enter a buffer where you can edit the select method of the current
2396 group (@code{gnus-group-edit-group-method}).
2400 @findex gnus-group-edit-group-parameters
2401 Enter a buffer where you can edit the group parameters
2402 (@code{gnus-group-edit-group-parameters}).
2406 @findex gnus-group-edit-group
2407 Enter a buffer where you can edit the group info
2408 (@code{gnus-group-edit-group}).
2412 @findex gnus-group-make-directory-group
2414 Make a directory group (@pxref{Directory Groups}). You will be prompted
2415 for a directory name (@code{gnus-group-make-directory-group}).
2420 @findex gnus-group-make-help-group
2421 Make the Gnus help group (@code{gnus-group-make-help-group}).
2425 @cindex (ding) archive
2426 @cindex archive group
2427 @findex gnus-group-make-archive-group
2428 @vindex gnus-group-archive-directory
2429 @vindex gnus-group-recent-archive-directory
2430 Make a Gnus archive group (@code{gnus-group-make-archive-group}). By
2431 default a group pointing to the most recent articles will be created
2432 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2433 group will be created from @code{gnus-group-archive-directory}.
2437 @findex gnus-group-make-kiboze-group
2439 Make a kiboze group. You will be prompted for a name, for a regexp to
2440 match groups to be ``included'' in the kiboze group, and a series of
2441 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2442 @xref{Kibozed Groups}.
2446 @findex gnus-group-enter-directory
2448 Read an arbitrary directory as if it were a newsgroup with the
2449 @code{nneething} backend (@code{gnus-group-enter-directory}).
2450 @xref{Anything Groups}.
2454 @findex gnus-group-make-doc-group
2455 @cindex ClariNet Briefs
2457 Make a group based on some file or other
2458 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2459 command, you will be prompted for a file name and a file type.
2460 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
2461 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
2462 @code{rfc934}, @code{rfc822-forward}, @code{nsmail} and @code{forward}.
2463 If you run this command without a prefix, Gnus will guess at the file
2464 type. @xref{Document Groups}.
2468 @vindex gnus-useful-groups
2469 @findex gnus-group-make-useful-group
2470 Create one of the groups mentioned in @code{gnus-useful-groups}
2471 (@code{gnus-group-make-useful-group}).
2475 @findex gnus-group-make-web-group
2480 Make an ephemeral group based on a web search
2481 (@code{gnus-group-make-web-group}). If you give a prefix to this
2482 command, make a solid group instead. You will be prompted for the
2483 search engine type and the search string. Valid search engine types
2484 include @code{dejanews}, @code{altavista} and @code{reference}.
2485 @xref{Web Searches}.
2487 If you use the @code{dejanews} search engine, you can limit the search
2488 to a particular group by using a match string like
2489 @samp{~g alt.sysadmin.recovery shaving}.
2492 @kindex G DEL (Group)
2493 @findex gnus-group-delete-group
2494 This function will delete the current group
2495 (@code{gnus-group-delete-group}). If given a prefix, this function will
2496 actually delete all the articles in the group, and forcibly remove the
2497 group itself from the face of the Earth. Use a prefix only if you are
2498 absolutely sure of what you are doing. This command can't be used on
2499 read-only groups (like @code{nntp} group), though.
2503 @findex gnus-group-make-empty-virtual
2504 Make a new, fresh, empty @code{nnvirtual} group
2505 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2509 @findex gnus-group-add-to-virtual
2510 Add the current group to an @code{nnvirtual} group
2511 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2514 @xref{Select Methods}, for more information on the various select
2517 @vindex gnus-activate-foreign-newsgroups
2518 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2519 Gnus will check all foreign groups with this level or lower at startup.
2520 This might take quite a while, especially if you subscribe to lots of
2521 groups from different @sc{nntp} servers. Also @pxref{Group Levels};
2522 @code{gnus-activate-level} also affects activation of foreign
2526 @node Group Parameters
2527 @section Group Parameters
2528 @cindex group parameters
2530 The group parameters store information local to a particular group.
2531 Here's an example group parameter list:
2534 ((to-address . "ding@@gnus.org")
2538 We see that each element consists of a "dotted pair"---the thing before
2539 the dot is the key, while the thing after the dot is the value. All the
2540 parameters have this form @emph{except} local variable specs, which are
2541 not dotted pairs, but proper lists.
2543 Some parameters have correspondant customizable variables, each of which
2544 is an alist of regexps and values.
2546 The following group parameters can be used:
2551 Address used by when doing followups and new posts.
2554 (to-address . "some@@where.com")
2557 This is primarily useful in mail groups that represent closed mailing
2558 lists---mailing lists where it's expected that everybody that writes to
2559 the mailing list is subscribed to it. Since using this parameter
2560 ensures that the mail only goes to the mailing list itself, it means
2561 that members won't receive two copies of your followups.
2563 Using @code{to-address} will actually work whether the group is foreign
2564 or not. Let's say there's a group on the server that is called
2565 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2566 the articles from a mail-to-news gateway. Posting directly to this
2567 group is therefore impossible---you have to send mail to the mailing
2568 list address instead.
2570 See also @code{gnus-parameter-to-address-alist}.
2574 Address used when doing @kbd{a} in that group.
2577 (to-list . "some@@where.com")
2580 It is totally ignored
2581 when doing a followup---except that if it is present in a news group,
2582 you'll get mail group semantics when doing @kbd{f}.
2584 If you do an @kbd{a} command in a mail group and you have neither a
2585 @code{to-list} group parameter nor a @code{to-address} group parameter,
2586 then a @code{to-list} group parameter will be added automatically upon
2587 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2588 @vindex gnus-add-to-list
2590 If you do an @kbd{a} command in a mail group and you don't have a
2591 @code{to-list} group parameter, one will be added automatically upon
2592 sending the message.
2594 See also @code{gnus-parameter-to-list-alist}.
2598 If the group parameter list has the element @code{(visible . t)},
2599 that group will always be visible in the Group buffer, regardless
2600 of whether it has any unread articles.
2602 @item broken-reply-to
2603 @cindex broken-reply-to
2604 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2605 headers in this group are to be ignored. This can be useful if you're
2606 reading a mailing list group where the listserv has inserted
2607 @code{Reply-To} headers that point back to the listserv itself. This is
2608 broken behavior. So there!
2612 Elements like @code{(to-group . "some.group.name")} means that all
2613 posts in that group will be sent to @code{some.group.name}.
2617 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2618 will treat all responses as if they were responses to news articles.
2619 This can be useful if you have a mail group that's really a mirror of a
2624 If @code{(gcc-self . t)} is present in the group parameter list, newly
2625 composed messages will be @code{Gcc}'d to the current group. If
2626 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2627 generated, if @code{(gcc-self . "string")} is present, this string will
2628 be inserted literally as a @code{gcc} header. This parameter takes
2629 precedence over any default @code{Gcc} rules as described later
2630 (@pxref{Archived Messages}).
2634 If the group parameter has an element that looks like @code{(auto-expire
2635 . t)}, all articles read will be marked as expirable. For an
2636 alternative approach, @pxref{Expiring Mail}.
2638 See also @code{gnus-auto-expirable-newsgroups}.
2641 @cindex total-expire
2642 If the group parameter has an element that looks like
2643 @code{(total-expire . t)}, all read articles will be put through the
2644 expiry process, even if they are not marked as expirable. Use with
2645 caution. Unread, ticked and dormant articles are not eligible for
2648 See also @code{gnus-total-expirable-newsgroups}.
2652 @vindex nnmail-expiry-wait-function
2653 If the group parameter has an element that looks like @code{(expiry-wait
2654 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2655 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2656 The value can either be a number of days (not necessarily an integer) or
2657 the symbols @code{never} or @code{immediate}.
2660 @cindex score file group parameter
2661 Elements that look like @code{(score-file . "file")} will make
2662 @file{file} into the current score file for the group in question. All
2663 interactive score entries will be put into this file.
2666 @cindex adapt file group parameter
2667 Elements that look like @code{(adapt-file . "file")} will make
2668 @file{file} into the current adaptive file for the group in question.
2669 All adaptive score entries will be put into this file.
2672 When unsubscribing from a mailing list you should never send the
2673 unsubscription notice to the mailing list itself. Instead, you'd send
2674 messages to the administrative address. This parameter allows you to
2675 put the admin address somewhere convenient.
2678 Elements that look like @code{(display . MODE)} say which articles to
2679 display on entering the group. Valid values are:
2683 Display all articles, both read and unread.
2686 Display the default visible articles, which normally includes unread and
2691 Elements that look like @code{(comment . "This is a comment")}
2692 are arbitrary comments on the group. They are currently ignored by
2693 Gnus, but provide a place for you to store information on particular
2697 Elements that look like @code{(charset . iso-8859-1)} will make
2698 @code{iso-8859-1} the default charset; that is, the charset that will be
2699 used for all articles that do not specify a charset.
2701 See also @code{gnus-group-charset-alist}.
2703 @item ignored-charsets
2704 Elements that look like @code{(ignored-charsets x-known iso-8859-1)}
2705 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2706 default charset will be used for decoding articles.
2708 See also @code{gnus-group-ignored-charsets-alist}.
2711 You can store additional posting style information for this group only
2712 here (@pxref{Posting Styles}). The format is that of an entry in the
2713 @code{gnus-posting-styles} alist, except that there's no regexp matching
2714 the group name (of course). Style elements in this group parameter will
2715 take precedence over the ones found in @code{gnus-posting-styles}.
2717 For instance, if you want a funky name and signature in this group only,
2718 instead of hacking @code{gnus-posting-styles}, you could put something
2719 like this in the group parameters:
2724 (signature "Funky Signature"))
2728 An item like @code{(banner . "regex")} causes any part of an article
2729 that matches the regular expression "regex" to be stripped. Instead of
2730 "regex", you can also use the symbol @code{signature} which strips the
2731 last signature or any of the elements of the alist
2732 @code{gnus-article-banner-alist}.
2734 @item (@var{variable} @var{form})
2735 You can use the group parameters to set variables local to the group you
2736 are entering. If you want to turn threading off in @samp{news.answers},
2737 you could put @code{(gnus-show-threads nil)} in the group parameters of
2738 that group. @code{gnus-show-threads} will be made into a local variable
2739 in the summary buffer you enter, and the form @code{nil} will be
2740 @code{eval}ed there.
2742 This can also be used as a group-specific hook function, if you'd like.
2743 If you want to hear a beep when you enter a group, you could put
2744 something like @code{(dummy-variable (ding))} in the parameters of that
2745 group. @code{dummy-variable} will be set to the result of the
2746 @code{(ding)} form, but who cares?
2750 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
2751 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
2752 presents you with a Customize-like interface. The latter helps avoid
2753 silly Lisp errors.) You might also be interested in reading about topic
2754 parameters (@pxref{Topic Parameters}).
2757 @node Listing Groups
2758 @section Listing Groups
2759 @cindex group listing
2761 These commands all list various slices of the groups available.
2769 @findex gnus-group-list-groups
2770 List all groups that have unread articles
2771 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
2772 command will list only groups of level ARG and lower. By default, it
2773 only lists groups of level five (i. e.,
2774 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2781 @findex gnus-group-list-all-groups
2782 List all groups, whether they have unread articles or not
2783 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
2784 this command will list only groups of level ARG and lower. By default,
2785 it lists groups of level seven or lower (i.e., just subscribed and
2786 unsubscribed groups).
2790 @findex gnus-group-list-level
2791 List all unread groups on a specific level
2792 (@code{gnus-group-list-level}). If given a prefix, also list the groups
2793 with no unread articles.
2797 @findex gnus-group-list-killed
2798 List all killed groups (@code{gnus-group-list-killed}). If given a
2799 prefix argument, really list all groups that are available, but aren't
2800 currently (un)subscribed. This could entail reading the active file
2805 @findex gnus-group-list-zombies
2806 List all zombie groups (@code{gnus-group-list-zombies}).
2810 @findex gnus-group-list-matching
2811 List all unread, subscribed groups with names that match a regexp
2812 (@code{gnus-group-list-matching}).
2816 @findex gnus-group-list-all-matching
2817 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2821 @findex gnus-group-list-active
2822 List absolutely all groups in the active file(s) of the
2823 server(s) you are connected to (@code{gnus-group-list-active}). This
2824 might very well take quite a while. It might actually be a better idea
2825 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2826 thing to match on. Also note that this command may list groups that
2827 don't exist (yet)---these will be listed as if they were killed groups.
2828 Take the output with some grains of salt.
2832 @findex gnus-group-apropos
2833 List all groups that have names that match a regexp
2834 (@code{gnus-group-apropos}).
2838 @findex gnus-group-description-apropos
2839 List all groups that have names or descriptions that match a regexp
2840 (@code{gnus-group-description-apropos}).
2844 @findex gnus-group-list-cached
2845 List all groups with cached articles (@code{gnus-group-list-cached}).
2849 @findex gnus-group-list-dormant
2850 List all groups with dormant articles (@code{gnus-group-list-dormant}).
2854 @findex gnus-group-list-limit
2855 List groups limited within the current selection
2856 (@code{gnus-group-list-limit}).
2860 @findex gnus-group-list-flush
2861 Flush groups from the current selection (@code{gnus-group-list-flush}).
2865 @findex gnus-group-list-plus
2866 List groups plus the current selection (@code{gnus-group-list-plus}).
2870 @vindex gnus-permanently-visible-groups
2871 @cindex visible group parameter
2872 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2873 always be shown, whether they have unread articles or not. You can also
2874 add the @code{visible} element to the group parameters in question to
2875 get the same effect.
2877 @vindex gnus-list-groups-with-ticked-articles
2878 Groups that have just ticked articles in it are normally listed in the
2879 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
2880 @code{nil}, these groups will be treated just like totally empty
2881 groups. It is @code{t} by default.
2884 @node Sorting Groups
2885 @section Sorting Groups
2886 @cindex sorting groups
2888 @kindex C-c C-s (Group)
2889 @findex gnus-group-sort-groups
2890 @vindex gnus-group-sort-function
2891 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2892 group buffer according to the function(s) given by the
2893 @code{gnus-group-sort-function} variable. Available sorting functions
2898 @item gnus-group-sort-by-alphabet
2899 @findex gnus-group-sort-by-alphabet
2900 Sort the group names alphabetically. This is the default.
2902 @item gnus-group-sort-by-real-name
2903 @findex gnus-group-sort-by-real-name
2904 Sort the group alphabetically on the real (unprefixed) group names.
2906 @item gnus-group-sort-by-level
2907 @findex gnus-group-sort-by-level
2908 Sort by group level.
2910 @item gnus-group-sort-by-score
2911 @findex gnus-group-sort-by-score
2912 Sort by group score. @xref{Group Score}.
2914 @item gnus-group-sort-by-rank
2915 @findex gnus-group-sort-by-rank
2916 Sort by group score and then the group level. The level and the score
2917 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
2919 @item gnus-group-sort-by-unread
2920 @findex gnus-group-sort-by-unread
2921 Sort by number of unread articles.
2923 @item gnus-group-sort-by-method
2924 @findex gnus-group-sort-by-method
2925 Sort alphabetically on the select method.
2927 @item gnus-group-sort-by-server
2928 @findex gnus-group-sort-by-server
2929 Sort alphabetically on the Gnus server name.
2934 @code{gnus-group-sort-function} can also be a list of sorting
2935 functions. In that case, the most significant sort key function must be
2939 There are also a number of commands for sorting directly according to
2940 some sorting criteria:
2944 @kindex G S a (Group)
2945 @findex gnus-group-sort-groups-by-alphabet
2946 Sort the group buffer alphabetically by group name
2947 (@code{gnus-group-sort-groups-by-alphabet}).
2950 @kindex G S u (Group)
2951 @findex gnus-group-sort-groups-by-unread
2952 Sort the group buffer by the number of unread articles
2953 (@code{gnus-group-sort-groups-by-unread}).
2956 @kindex G S l (Group)
2957 @findex gnus-group-sort-groups-by-level
2958 Sort the group buffer by group level
2959 (@code{gnus-group-sort-groups-by-level}).
2962 @kindex G S v (Group)
2963 @findex gnus-group-sort-groups-by-score
2964 Sort the group buffer by group score
2965 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
2968 @kindex G S r (Group)
2969 @findex gnus-group-sort-groups-by-rank
2970 Sort the group buffer by group rank
2971 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
2974 @kindex G S m (Group)
2975 @findex gnus-group-sort-groups-by-method
2976 Sort the group buffer alphabetically by backend name
2977 (@code{gnus-group-sort-groups-by-method}).
2981 All the commands below obey the process/prefix convention
2982 (@pxref{Process/Prefix}).
2984 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
2985 commands will sort in reverse order.
2987 You can also sort a subset of the groups:
2991 @kindex G P a (Group)
2992 @findex gnus-group-sort-selected-groups-by-alphabet
2993 Sort the groups alphabetically by group name
2994 (@code{gnus-group-sort-selected-groups-by-alphabet}).
2997 @kindex G P u (Group)
2998 @findex gnus-group-sort-selected-groups-by-unread
2999 Sort the groups by the number of unread articles
3000 (@code{gnus-group-sort-selected-groups-by-unread}).
3003 @kindex G P l (Group)
3004 @findex gnus-group-sort-selected-groups-by-level
3005 Sort the groups by group level
3006 (@code{gnus-group-sort-selected-groups-by-level}).
3009 @kindex G P v (Group)
3010 @findex gnus-group-sort-selected-groups-by-score
3011 Sort the groups by group score
3012 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3015 @kindex G P r (Group)
3016 @findex gnus-group-sort-selected-groups-by-rank
3017 Sort the groups by group rank
3018 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3021 @kindex G P m (Group)
3022 @findex gnus-group-sort-selected-groups-by-method
3023 Sort the groups alphabetically by backend name
3024 (@code{gnus-group-sort-selected-groups-by-method}).
3028 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3032 @node Group Maintenance
3033 @section Group Maintenance
3034 @cindex bogus groups
3039 @findex gnus-group-check-bogus-groups
3040 Find bogus groups and delete them
3041 (@code{gnus-group-check-bogus-groups}).
3045 @findex gnus-group-find-new-groups
3046 Find new groups and process them (@code{gnus-group-find-new-groups}).
3047 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3048 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3049 to query the server for new groups, and subscribe the new groups as
3053 @kindex C-c C-x (Group)
3054 @findex gnus-group-expire-articles
3055 Run all expirable articles in the current group through the expiry
3056 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3057 all expirable articles in the group that have been around for a while.
3058 (@pxref{Expiring Mail}).
3061 @kindex C-c M-C-x (Group)
3062 @findex gnus-group-expire-all-groups
3063 Run all expirable articles in all groups through the expiry process
3064 (@code{gnus-group-expire-all-groups}).
3069 @node Browse Foreign Server
3070 @section Browse Foreign Server
3071 @cindex foreign servers
3072 @cindex browsing servers
3077 @findex gnus-group-browse-foreign-server
3078 You will be queried for a select method and a server name. Gnus will
3079 then attempt to contact this server and let you browse the groups there
3080 (@code{gnus-group-browse-foreign-server}).
3083 @findex gnus-browse-mode
3084 A new buffer with a list of available groups will appear. This buffer
3085 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3086 a lot) like a normal group buffer.
3088 Here's a list of keystrokes available in the browse mode:
3093 @findex gnus-group-next-group
3094 Go to the next group (@code{gnus-group-next-group}).
3098 @findex gnus-group-prev-group
3099 Go to the previous group (@code{gnus-group-prev-group}).
3102 @kindex SPACE (Browse)
3103 @findex gnus-browse-read-group
3104 Enter the current group and display the first article
3105 (@code{gnus-browse-read-group}).
3108 @kindex RET (Browse)
3109 @findex gnus-browse-select-group
3110 Enter the current group (@code{gnus-browse-select-group}).
3114 @findex gnus-browse-unsubscribe-current-group
3115 Unsubscribe to the current group, or, as will be the case here,
3116 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3122 @findex gnus-browse-exit
3123 Exit browse mode (@code{gnus-browse-exit}).
3127 @findex gnus-browse-describe-briefly
3128 Describe browse mode briefly (well, there's not much to describe, is
3129 there) (@code{gnus-browse-describe-briefly}).
3134 @section Exiting Gnus
3135 @cindex exiting Gnus
3137 Yes, Gnus is ex(c)iting.
3142 @findex gnus-group-suspend
3143 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
3144 but it kills all buffers except the Group buffer. I'm not sure why this
3145 is a gain, but then who am I to judge?
3149 @findex gnus-group-exit
3150 @c @icon{gnus-group-exit}
3151 Quit Gnus (@code{gnus-group-exit}).
3155 @findex gnus-group-quit
3156 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3157 The dribble file will be saved, though (@pxref{Auto Save}).
3160 @vindex gnus-exit-gnus-hook
3161 @vindex gnus-suspend-gnus-hook
3162 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
3163 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
3164 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3169 If you wish to completely unload Gnus and all its adherents, you can use
3170 the @code{gnus-unload} command. This command is also very handy when
3171 trying to customize meta-variables.
3176 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3177 numbly heavy and herself fall into a hazy trance as the boy sitting
3178 behind her drew repeated lines with his pencil across the back of her
3184 @section Group Topics
3187 If you read lots and lots of groups, it might be convenient to group
3188 them hierarchically according to topics. You put your Emacs groups over
3189 here, your sex groups over there, and the rest (what, two groups or so?)
3190 you put in some misc section that you never bother with anyway. You can
3191 even group the Emacs sex groups as a sub-topic to either the Emacs
3192 groups or the sex groups---or both! Go wild!
3196 \gnusfigure{Group Topics}{400}{
3197 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
3208 2: alt.religion.emacs
3211 0: comp.talk.emacs.recovery
3213 8: comp.binaries.fractals
3214 13: comp.sources.unix
3217 @findex gnus-topic-mode
3219 To get this @emph{fab} functionality you simply turn on (ooh!) the
3220 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3221 is a toggling command.)
3223 Go ahead, just try it. I'll still be here when you get back. La de
3224 dum... Nice tune, that... la la la... What, you're back? Yes, and now
3225 press @kbd{l}. There. All your groups are now listed under
3226 @samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and
3229 If you want this permanently enabled, you should add that minor mode to
3230 the hook for the group mode:
3233 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3237 * Topic Variables:: How to customize the topics the Lisp Way.
3238 * Topic Commands:: Interactive E-Z commands.
3239 * Topic Sorting:: Sorting each topic individually.
3240 * Topic Topology:: A map of the world.
3241 * Topic Parameters:: Parameters that apply to all groups in a topic.
3245 @node Topic Variables
3246 @subsection Topic Variables
3247 @cindex topic variables
3249 Now, if you select a topic, it will fold/unfold that topic, which is
3250 really neat, I think.
3252 @vindex gnus-topic-line-format
3253 The topic lines themselves are created according to the
3254 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3267 Number of groups in the topic.
3269 Number of unread articles in the topic.
3271 Number of unread articles in the topic and all its subtopics.
3274 @vindex gnus-topic-indent-level
3275 Each sub-topic (and the groups in the sub-topics) will be indented with
3276 @code{gnus-topic-indent-level} times the topic level number of spaces.
3279 @vindex gnus-topic-mode-hook
3280 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3282 @vindex gnus-topic-display-empty-topics
3283 The @code{gnus-topic-display-empty-topics} says whether to display even
3284 topics that have no unread articles in them. The default is @code{t}.
3287 @node Topic Commands
3288 @subsection Topic Commands
3289 @cindex topic commands
3291 When the topic minor mode is turned on, a new @kbd{T} submap will be
3292 available. In addition, a few of the standard keys change their
3293 definitions slightly.
3299 @findex gnus-topic-create-topic
3300 Prompt for a new topic name and create it
3301 (@code{gnus-topic-create-topic}).
3305 @findex gnus-topic-move-group
3306 Move the current group to some other topic
3307 (@code{gnus-topic-move-group}). This command uses the process/prefix
3308 convention (@pxref{Process/Prefix}).
3312 @findex gnus-topic-jump-to-topic
3313 Go to a topic (@code{gnus-topic-jump-to-topic}).
3317 @findex gnus-topic-copy-group
3318 Copy the current group to some other topic
3319 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3320 convention (@pxref{Process/Prefix}).
3324 @findex gnus-topic-hide-topic
3325 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3326 a prefix, hide the topic permanently.
3330 @findex gnus-topic-show-topic
3331 Show the current topic (@code{gnus-topic-show-topic}). If given
3332 a prefix, show the topic permanently.
3336 @findex gnus-topic-remove-group
3337 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3338 This command is mainly useful if you have the same group in several
3339 topics and wish to remove it from one of the topics. You may also
3340 remove a group from all topics, but in that case, Gnus will add it to
3341 the root topic the next time you start Gnus. In fact, all new groups
3342 (which, naturally, don't belong to any topic) will show up in the root
3345 This command uses the process/prefix convention
3346 (@pxref{Process/Prefix}).
3350 @findex gnus-topic-move-matching
3351 Move all groups that match some regular expression to a topic
3352 (@code{gnus-topic-move-matching}).
3356 @findex gnus-topic-copy-matching
3357 Copy all groups that match some regular expression to a topic
3358 (@code{gnus-topic-copy-matching}).
3362 @findex gnus-topic-toggle-display-empty-topics
3363 Toggle hiding empty topics
3364 (@code{gnus-topic-toggle-display-empty-topics}).
3368 @findex gnus-topic-mark-topic
3369 Mark all groups in the current topic with the process mark
3370 (@code{gnus-topic-mark-topic}).
3373 @kindex T M-# (Topic)
3374 @findex gnus-topic-unmark-topic
3375 Remove the process mark from all groups in the current topic
3376 (@code{gnus-topic-unmark-topic}).
3380 @kindex T TAB (Topic)
3382 @findex gnus-topic-indent
3383 ``Indent'' the current topic so that it becomes a sub-topic of the
3384 previous topic (@code{gnus-topic-indent}). If given a prefix,
3385 ``un-indent'' the topic instead.
3388 @kindex M-TAB (Topic)
3389 @findex gnus-topic-unindent
3390 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3391 parent of its current parent (@code{gnus-topic-unindent}).
3395 @findex gnus-topic-select-group
3397 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3398 When you perform this command on a group, you'll enter the group, as
3399 usual. When done on a topic line, the topic will be folded (if it was
3400 visible) or unfolded (if it was folded already). So it's basically a
3401 toggling command on topics. In addition, if you give a numerical
3402 prefix, group on that level (and lower) will be displayed.
3405 @kindex C-c C-x (Topic)
3406 @findex gnus-topic-expire-articles
3407 Run all expirable articles in the current group or topic through the
3408 expiry process (if any)
3409 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3413 @findex gnus-topic-kill-group
3414 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3415 topic will be removed along with the topic.
3419 @findex gnus-topic-yank-group
3420 Yank the previously killed group or topic
3421 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3426 @findex gnus-topic-rename
3427 Rename a topic (@code{gnus-topic-rename}).
3430 @kindex T DEL (Topic)
3431 @findex gnus-topic-delete
3432 Delete an empty topic (@code{gnus-topic-delete}).
3436 @findex gnus-topic-list-active
3437 List all groups that Gnus knows about in a topics-ified way
3438 (@code{gnus-topic-list-active}).
3442 @findex gnus-topic-edit-parameters
3443 @cindex group parameters
3444 @cindex topic parameters
3446 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3447 @xref{Topic Parameters}.
3453 @subsection Topic Sorting
3454 @cindex topic sorting
3456 You can sort the groups in each topic individually with the following
3462 @kindex T S a (Topic)
3463 @findex gnus-topic-sort-groups-by-alphabet
3464 Sort the current topic alphabetically by group name
3465 (@code{gnus-topic-sort-groups-by-alphabet}).
3468 @kindex T S u (Topic)
3469 @findex gnus-topic-sort-groups-by-unread
3470 Sort the current topic by the number of unread articles
3471 (@code{gnus-topic-sort-groups-by-unread}).
3474 @kindex T S l (Topic)
3475 @findex gnus-topic-sort-groups-by-level
3476 Sort the current topic by group level
3477 (@code{gnus-topic-sort-groups-by-level}).
3480 @kindex T S v (Topic)
3481 @findex gnus-topic-sort-groups-by-score
3482 Sort the current topic by group score
3483 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
3486 @kindex T S r (Topic)
3487 @findex gnus-topic-sort-groups-by-rank
3488 Sort the current topic by group rank
3489 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
3492 @kindex T S m (Topic)
3493 @findex gnus-topic-sort-groups-by-method
3494 Sort the current topic alphabetically by backend name
3495 (@code{gnus-topic-sort-groups-by-method}).
3499 @xref{Sorting Groups}, for more information about group sorting.
3502 @node Topic Topology
3503 @subsection Topic Topology
3504 @cindex topic topology
3507 So, let's have a look at an example group buffer:
3513 2: alt.religion.emacs
3516 0: comp.talk.emacs.recovery
3518 8: comp.binaries.fractals
3519 13: comp.sources.unix
3522 So, here we have one top-level topic (@samp{Gnus}), two topics under
3523 that, and one sub-topic under one of the sub-topics. (There is always
3524 just one (1) top-level topic). This topology can be expressed as
3529 (("Emacs -- I wuw it!" visible)
3530 (("Naughty Emacs" visible)))
3534 @vindex gnus-topic-topology
3535 This is in fact how the variable @code{gnus-topic-topology} would look
3536 for the display above. That variable is saved in the @file{.newsrc.eld}
3537 file, and shouldn't be messed with manually---unless you really want
3538 to. Since this variable is read from the @file{.newsrc.eld} file,
3539 setting it in any other startup files will have no effect.
3541 This topology shows what topics are sub-topics of what topics (right),
3542 and which topics are visible. Two settings are currently
3543 allowed---@code{visible} and @code{invisible}.
3546 @node Topic Parameters
3547 @subsection Topic Parameters
3548 @cindex topic parameters
3550 All groups in a topic will inherit group parameters from the parent (and
3551 ancestor) topic parameters. All valid group parameters are valid topic
3552 parameters (@pxref{Group Parameters}).
3554 In addition, the following parameters are only valid as topic
3559 When subscribing new groups by topic (@pxref{Subscription Methods}), the
3560 @code{subscribe} topic parameter says what groups go in what topic. Its
3561 value should be a regexp to match the groups that should go in that
3566 Group parameters (of course) override topic parameters, and topic
3567 parameters in sub-topics override topic parameters in super-topics. You
3568 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
3569 verb, although you may feel free to disagree with me here.)
3575 2: alt.religion.emacs
3579 0: comp.talk.emacs.recovery
3581 8: comp.binaries.fractals
3582 13: comp.sources.unix
3586 The @samp{Emacs} topic has the topic parameter @code{(score-file
3587 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
3588 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
3589 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
3590 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
3591 . "religion.SCORE")}.
3593 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
3594 will get the @file{relief.SCORE} home score file. If you enter the same
3595 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
3596 score file. If you enter the group @samp{alt.religion.emacs}, you'll
3597 get the @file{religion.SCORE} home score file.
3599 This seems rather simple and self-evident, doesn't it? Well, yes. But
3600 there are some problems, especially with the @code{total-expiry}
3601 parameter. Say you have a mail group in two topics; one with
3602 @code{total-expiry} and one without. What happens when you do @kbd{M-x
3603 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
3604 of these topics you mean to expire articles from, so anything may
3605 happen. In fact, I hereby declare that it is @dfn{undefined} what
3606 happens. You just have to be careful if you do stuff like that.
3609 @node Misc Group Stuff
3610 @section Misc Group Stuff
3613 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
3614 * Group Information:: Information and help on groups and Gnus.
3615 * Group Timestamp:: Making Gnus keep track of when you last read a group.
3616 * File Commands:: Reading and writing the Gnus files.
3623 @findex gnus-group-enter-server-mode
3624 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3625 @xref{Server Buffer}.
3629 @findex gnus-group-post-news
3630 Post an article to a group (@code{gnus-group-post-news}). If given a
3631 prefix, the current group name will be used as the default.
3635 @findex gnus-group-mail
3636 Mail a message somewhere (@code{gnus-group-mail}).
3640 Variables for the group buffer:
3644 @item gnus-group-mode-hook
3645 @vindex gnus-group-mode-hook
3646 is called after the group buffer has been
3649 @item gnus-group-prepare-hook
3650 @vindex gnus-group-prepare-hook
3651 is called after the group buffer is
3652 generated. It may be used to modify the buffer in some strange,
3655 @item gnus-group-prepared-hook
3656 @vindex gnus-group-prepare-hook
3657 is called as the very last thing after the group buffer has been
3658 generated. It may be used to move point around, for instance.
3660 @item gnus-permanently-visible-groups
3661 @vindex gnus-permanently-visible-groups
3662 Groups matching this regexp will always be listed in the group buffer,
3663 whether they are empty or not.
3665 @item gnus-group-name-charset-method-alist
3666 @vindex gnus-group-name-charset-method-alist
3667 An alist of method and the charset for group names. It is used to show
3668 non-ASCII group names.
3672 (setq gnus-group-name-charset-method-alist
3673 '(((nntp "news.com.cn") . cn-gb-2312)))
3676 @item gnus-group-name-charset-group-alist
3677 @vindex gnus-group-name-charset-group-alist
3678 An alist of regexp of group name and the charset for group names.
3679 It is used to show non-ASCII group names.
3683 (setq gnus-group-name-charset-group-alist
3684 '(("\\.com\\.cn:" . cn-gb-2312)))
3689 @node Scanning New Messages
3690 @subsection Scanning New Messages
3691 @cindex new messages
3692 @cindex scanning new news
3698 @findex gnus-group-get-new-news
3699 @c @icon{gnus-group-get-new-news}
3700 Check the server(s) for new articles. If the numerical prefix is used,
3701 this command will check only groups of level @var{arg} and lower
3702 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
3703 command will force a total re-reading of the active file(s) from the
3708 @findex gnus-group-get-new-news-this-group
3709 @vindex gnus-goto-next-group-when-activating
3710 @c @icon{gnus-group-get-new-news-this-group}
3711 Check whether new articles have arrived in the current group
3712 (@code{gnus-group-get-new-news-this-group}).
3713 @code{gnus-goto-next-group-when-activating} says whether this command is
3714 to move point to the next group or not. It is @code{t} by default.
3716 @findex gnus-activate-all-groups
3717 @cindex activating groups
3719 @kindex C-c M-g (Group)
3720 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3725 @findex gnus-group-restart
3726 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
3727 file(s), closes the connection to all servers, clears up all run-time
3728 Gnus variables, and then starts Gnus all over again.
3732 @vindex gnus-get-new-news-hook
3733 @code{gnus-get-new-news-hook} is run just before checking for new news.
3735 @vindex gnus-after-getting-new-news-hook
3736 @code{gnus-after-getting-new-news-hook} is run after checking for new
3740 @node Group Information
3741 @subsection Group Information
3742 @cindex group information
3743 @cindex information on groups
3750 @findex gnus-group-fetch-faq
3751 @vindex gnus-group-faq-directory
3754 Try to fetch the FAQ for the current group
3755 (@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from
3756 @code{gnus-group-faq-directory}, which is usually a directory on a
3757 remote machine. This variable can also be a list of directories. In
3758 that case, giving a prefix to this command will allow you to choose
3759 between the various sites. @code{ange-ftp} (or @code{efs}) will be used
3760 for fetching the file.
3762 If fetching from the first site is unsuccessful, Gnus will attempt to go
3763 through @code{gnus-group-faq-directory} and try to open them one by one.
3767 @c @icon{gnus-group-describe-group}
3769 @kindex C-c C-d (Group)
3770 @cindex describing groups
3771 @cindex group description
3772 @findex gnus-group-describe-group
3773 Describe the current group (@code{gnus-group-describe-group}). If given
3774 a prefix, force Gnus to re-read the description from the server.
3778 @findex gnus-group-describe-all-groups
3779 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
3780 prefix, force Gnus to re-read the description file from the server.
3787 @findex gnus-version
3788 Display current Gnus version numbers (@code{gnus-version}).
3792 @findex gnus-group-describe-briefly
3793 Give a very short help message (@code{gnus-group-describe-briefly}).
3796 @kindex C-c C-i (Group)
3799 @findex gnus-info-find-node
3800 Go to the Gnus info node (@code{gnus-info-find-node}).
3804 @node Group Timestamp
3805 @subsection Group Timestamp
3807 @cindex group timestamps
3809 It can be convenient to let Gnus keep track of when you last read a
3810 group. To set the ball rolling, you should add
3811 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3814 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3817 After doing this, each time you enter a group, it'll be recorded.
3819 This information can be displayed in various ways---the easiest is to
3820 use the @samp{%d} spec in the group line format:
3823 (setq gnus-group-line-format
3824 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3827 This will result in lines looking like:
3830 * 0: mail.ding 19961002T012943
3831 0: custom 19961002T012713
3834 As you can see, the date is displayed in compact ISO 8601 format. This
3835 may be a bit too much, so to just display the date, you could say
3839 (setq gnus-group-line-format
3840 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3845 @subsection File Commands
3846 @cindex file commands
3852 @findex gnus-group-read-init-file
3853 @vindex gnus-init-file
3854 @cindex reading init file
3855 Re-read the init file (@code{gnus-init-file}, which defaults to
3856 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3860 @findex gnus-group-save-newsrc
3861 @cindex saving .newsrc
3862 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3863 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
3864 file(s) whether Gnus thinks it is necessary or not.
3867 @c @kindex Z (Group)
3868 @c @findex gnus-group-clear-dribble
3869 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3874 @node Summary Buffer
3875 @chapter Summary Buffer
3876 @cindex summary buffer
3878 A line for each article is displayed in the summary buffer. You can
3879 move around, read articles, post articles and reply to articles.
3881 The most common way to a summary buffer is to select a group from the
3882 group buffer (@pxref{Selecting a Group}).
3884 You can have as many summary buffers open as you wish.
3887 * Summary Buffer Format:: Deciding how the summary buffer is to look.
3888 * Summary Maneuvering:: Moving around the summary buffer.
3889 * Choosing Articles:: Reading articles.
3890 * Paging the Article:: Scrolling the current article.
3891 * Reply Followup and Post:: Posting articles.
3892 * Marking Articles:: Marking articles as read, expirable, etc.
3893 * Limiting:: You can limit the summary buffer.
3894 * Threading:: How threads are made.
3895 * Sorting the Summary Buffer:: How articles and threads are sorted.
3896 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
3897 * Article Caching:: You may store articles in a cache.
3898 * Persistent Articles:: Making articles expiry-resistant.
3899 * Article Backlog:: Having already read articles hang around.
3900 * Saving Articles:: Ways of customizing article saving.
3901 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
3902 * Article Treatment:: The article buffer can be mangled at will.
3903 * MIME Commands:: Doing MIMEy things with the articles.
3904 * Charsets:: Character set issues.
3905 * Article Commands:: Doing various things with the article buffer.
3906 * Summary Sorting:: Sorting the summary buffer in various ways.
3907 * Finding the Parent:: No child support? Get the parent.
3908 * Alternative Approaches:: Reading using non-default summaries.
3909 * Tree Display:: A more visual display of threads.
3910 * Mail Group Commands:: Some commands can only be used in mail groups.
3911 * Various Summary Stuff:: What didn't fit anywhere else.
3912 * Exiting the Summary Buffer:: Returning to the Group buffer,
3913 or reselecting the current group.
3914 * Crosspost Handling:: How crossposted articles are dealt with.
3915 * Duplicate Suppression:: An alternative when crosspost handling fails.
3916 * Security:: Decrypt and Verify.
3920 @node Summary Buffer Format
3921 @section Summary Buffer Format
3922 @cindex summary buffer format
3926 \gnusfigure{The Summary Buffer}{180}{
3927 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3928 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3934 * Summary Buffer Lines:: You can specify how summary lines should look.
3935 * To From Newsgroups:: How to not display your own name.
3936 * Summary Buffer Mode Line:: You can say how the mode line should look.
3937 * Summary Highlighting:: Making the summary buffer all pretty and nice.
3940 @findex mail-extract-address-components
3941 @findex gnus-extract-address-components
3942 @vindex gnus-extract-address-components
3943 Gnus will use the value of the @code{gnus-extract-address-components}
3944 variable as a function for getting the name and address parts of a
3945 @code{From} header. Two pre-defined functions exist:
3946 @code{gnus-extract-address-components}, which is the default, quite
3947 fast, and too simplistic solution; and
3948 @code{mail-extract-address-components}, which works very nicely, but is
3949 slower. The default function will return the wrong answer in 5% of the
3950 cases. If this is unacceptable to you, use the other function instead:
3953 (setq gnus-extract-address-components
3954 'mail-extract-address-components)
3957 @vindex gnus-summary-same-subject
3958 @code{gnus-summary-same-subject} is a string indicating that the current
3959 article has the same subject as the previous. This string will be used
3960 with those specs that require it. The default is @code{""}.
3963 @node Summary Buffer Lines
3964 @subsection Summary Buffer Lines
3966 @vindex gnus-summary-line-format
3967 You can change the format of the lines in the summary buffer by changing
3968 the @code{gnus-summary-line-format} variable. It works along the same
3969 lines as a normal @code{format} string, with some extensions
3970 (@pxref{Formatting Variables}).
3972 There should always be a colon on the line; the cursor always moves to
3973 the colon after performing an operation.
3975 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3977 The following format specification characters are understood:
3983 Subject string. List identifiers stripped,
3984 @code{gnus-list-identifies}. @xref{Article Hiding}.
3986 Subject if the article is the root of the thread or the previous article
3987 had a different subject, @code{gnus-summary-same-subject} otherwise.
3988 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3990 Full @code{From} header.
3992 The name (from the @code{From} header).
3994 The name, code @code{To} header or the @code{Newsgroups} header
3995 (@pxref{To From Newsgroups}).
3997 The name (from the @code{From} header). This differs from the @code{n}
3998 spec in that it uses the function designated by the
3999 @code{gnus-extract-address-components} variable, which is slower, but
4000 may be more thorough.
4002 The address (from the @code{From} header). This works the same way as
4005 Number of lines in the article.
4007 Number of characters in the article. This specifier is not supported in some
4008 methods (like nnfolder).
4010 Indentation based on thread level (@pxref{Customizing Threading}).
4012 Nothing if the article is a root and lots of spaces if it isn't (it
4013 pushes everything after it off the screen).
4015 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4016 for adopted articles (@pxref{Customizing Threading}).
4018 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4019 for adopted articles.
4021 One space for each thread level.
4023 Twenty minus thread level spaces.
4028 This misleadingly named specifier is the @dfn{secondary mark}. This
4029 mark will say whether the article has been replied to, has been cached,
4033 Score as a number (@pxref{Scoring}).
4035 @vindex gnus-summary-zcore-fuzz
4036 Zcore, @samp{+} if above the default level and @samp{-} if below the
4037 default level. If the difference between
4038 @code{gnus-summary-default-score} and the score is less than
4039 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4047 The @code{Date} in @code{DD-MMM} format.
4049 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4055 Number of articles in the current sub-thread. Using this spec will slow
4056 down summary buffer generation somewhat.
4058 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4059 article has any children.
4065 User defined specifier. The next character in the format string should
4066 be a letter. Gnus will call the function
4067 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
4068 following @samp{%u}. The function will be passed the current header as
4069 argument. The function should return a string, which will be inserted
4070 into the summary just like information from any other summary specifier.
4073 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4074 have to be handled with care. For reasons of efficiency, Gnus will
4075 compute what column these characters will end up in, and ``hard-code''
4076 that. This means that it is invalid to have these specs after a
4077 variable-length spec. Well, you might not be arrested, but your summary
4078 buffer will look strange, which is bad enough.
4080 The smart choice is to have these specs as far to the left as possible.
4081 (Isn't that the case with everything, though? But I digress.)
4083 This restriction may disappear in later versions of Gnus.
4086 @node To From Newsgroups
4087 @subsection To From Newsgroups
4091 In some groups (particularly in archive groups), the @code{From} header
4092 isn't very interesting, since all the articles there are written by
4093 you. To display the information in the @code{To} or @code{Newsgroups}
4094 headers instead, you need to decide three things: What information to
4095 gather; where to display it; and when to display it.
4099 @vindex gnus-extra-headers
4100 The reading of extra header information is controlled by the
4101 @code{gnus-extra-headers}. This is a list of header symbols. For
4105 (setq gnus-extra-headers
4106 '(To Newsgroups X-Newsreader))
4109 This will result in Gnus trying to obtain these three headers, and
4110 storing it in header structures for later easy retrieval.
4113 @findex gnus-extra-header
4114 The value of these extra headers can be accessed via the
4115 @code{gnus-extra-header} function. Here's a format line spec that will
4116 access the @code{X-Newsreader} header:
4119 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4123 @vindex gnus-ignored-from-addresses
4124 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4125 summary line spec returns the @code{To}, @code{Newsreader} or
4126 @code{From} header. If this regexp matches the contents of the
4127 @code{From} header, the value of the @code{To} or @code{Newsreader}
4128 headers are used instead.
4132 @vindex nnmail-extra-headers
4133 A related variable is @code{nnmail-extra-headers}, which controls when
4134 to include extra headers when generating overview (@sc{nov}) files. If
4135 you have old overview files, you should regenerate them after changing
4138 @vindex gnus-summary-line-format
4139 You also have to instruct Gnus to display the data by changing the
4140 @code{%n} spec to the @code{%f} spec in the
4141 @code{gnus-summary-line-format} variable.
4143 In summary, you'd typically put something like the following in
4147 (setq gnus-extra-headers
4149 (setq nnmail-extra-headers gnus-extra-headers)
4150 (setq gnus-summary-line-format
4151 "%U%R%z%I%(%[%4L: %-20,20f%]%) %s\n")
4152 (setq gnus-ignored-from-addresses
4156 Now, this is mostly useful for mail groups, where you have control over
4157 the @sc{nov} files that are created. However, if you can persuade your
4164 to the end of her @file{overview.fmt} file, then you can use that just
4165 as you would the extra headers from the mail groups.
4168 @node Summary Buffer Mode Line
4169 @subsection Summary Buffer Mode Line
4171 @vindex gnus-summary-mode-line-format
4172 You can also change the format of the summary mode bar (@pxref{Mode Line
4173 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
4174 like. The default is @samp{Gnus: %%b [%A] %Z}.
4176 Here are the elements you can play with:
4182 Unprefixed group name.
4184 Current article number.
4186 Current article score.
4190 Number of unread articles in this group.
4192 Number of unread articles in this group that aren't displayed in the
4195 A string with the number of unread and unselected articles represented
4196 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4197 articles, and just as @samp{<%U more>} if there are just unread articles
4198 and no unselected ones.
4200 Shortish group name. For instance, @samp{rec.arts.anime} will be
4201 shortened to @samp{r.a.anime}.
4203 Subject of the current article.
4205 User-defined spec (@pxref{User-Defined Specs}).
4207 Name of the current score file (@pxref{Scoring}).
4209 Number of dormant articles (@pxref{Unread Articles}).
4211 Number of ticked articles (@pxref{Unread Articles}).
4213 Number of articles that have been marked as read in this session.
4215 Number of articles expunged by the score files.
4219 @node Summary Highlighting
4220 @subsection Summary Highlighting
4224 @item gnus-visual-mark-article-hook
4225 @vindex gnus-visual-mark-article-hook
4226 This hook is run after selecting an article. It is meant to be used for
4227 highlighting the article in some way. It is not run if
4228 @code{gnus-visual} is @code{nil}.
4230 @item gnus-summary-update-hook
4231 @vindex gnus-summary-update-hook
4232 This hook is called when a summary line is changed. It is not run if
4233 @code{gnus-visual} is @code{nil}.
4235 @item gnus-summary-selected-face
4236 @vindex gnus-summary-selected-face
4237 This is the face (or @dfn{font} as some people call it) used to
4238 highlight the current article in the summary buffer.
4240 @item gnus-summary-highlight
4241 @vindex gnus-summary-highlight
4242 Summary lines are highlighted according to this variable, which is a
4243 list where the elements are of the format @code{(@var{form}
4244 . @var{face})}. If you would, for instance, like ticked articles to be
4245 italic and high-scored articles to be bold, you could set this variable
4248 (((eq mark gnus-ticked-mark) . italic)
4249 ((> score default) . bold))
4251 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4252 @var{face} will be applied to the line.
4256 @node Summary Maneuvering
4257 @section Summary Maneuvering
4258 @cindex summary movement
4260 All the straight movement commands understand the numeric prefix and
4261 behave pretty much as you'd expect.
4263 None of these commands select articles.
4268 @kindex M-n (Summary)
4269 @kindex G M-n (Summary)
4270 @findex gnus-summary-next-unread-subject
4271 Go to the next summary line of an unread article
4272 (@code{gnus-summary-next-unread-subject}).
4276 @kindex M-p (Summary)
4277 @kindex G M-p (Summary)
4278 @findex gnus-summary-prev-unread-subject
4279 Go to the previous summary line of an unread article
4280 (@code{gnus-summary-prev-unread-subject}).
4283 @kindex G g (Summary)
4284 @findex gnus-summary-goto-subject
4285 Ask for an article number and then go to the summary line of that article
4286 without displaying the article (@code{gnus-summary-goto-subject}).
4289 If Gnus asks you to press a key to confirm going to the next group, you
4290 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4291 buffer, searching for the next group to read without actually returning
4292 to the group buffer.
4294 Variables related to summary movement:
4298 @vindex gnus-auto-select-next
4299 @item gnus-auto-select-next
4300 If you issue one of the movement commands (like @kbd{n}) and there are
4301 no more unread articles after the current one, Gnus will offer to go to
4302 the next group. If this variable is @code{t} and the next group is
4303 empty, Gnus will exit summary mode and return to the group buffer. If
4304 this variable is neither @code{t} nor @code{nil}, Gnus will select the
4305 next group, no matter whether it has any unread articles or not. As a
4306 special case, if this variable is @code{quietly}, Gnus will select the
4307 next group without asking for confirmation. If this variable is
4308 @code{almost-quietly}, the same will happen only if you are located on
4309 the last article in the group. Finally, if this variable is
4310 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
4311 without confirmation. Also @pxref{Group Levels}.
4313 @item gnus-auto-select-same
4314 @vindex gnus-auto-select-same
4315 If non-@code{nil}, all the movement commands will try to go to the next
4316 article with the same subject as the current. (@dfn{Same} here might
4317 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
4318 for details (@pxref{Customizing Threading}).) If there are no more
4319 articles with the same subject, go to the first unread article.
4321 This variable is not particularly useful if you use a threaded display.
4323 @item gnus-summary-check-current
4324 @vindex gnus-summary-check-current
4325 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4326 to the next (or previous) article if the current article is unread.
4327 Instead, they will choose the current article.
4329 @item gnus-auto-center-summary
4330 @vindex gnus-auto-center-summary
4331 If non-@code{nil}, Gnus will keep the point in the summary buffer
4332 centered at all times. This makes things quite tidy, but if you have a
4333 slow network connection, or simply do not like this un-Emacsism, you can
4334 set this variable to @code{nil} to get the normal Emacs scrolling
4335 action. This will also inhibit horizontal re-centering of the summary
4336 buffer, which might make it more inconvenient to read extremely long
4339 This variable can also be a number. In that case, center the window at
4340 the given number of lines from the top.
4345 @node Choosing Articles
4346 @section Choosing Articles
4347 @cindex selecting articles
4350 * Choosing Commands:: Commands for choosing articles.
4351 * Choosing Variables:: Variables that influence these commands.
4355 @node Choosing Commands
4356 @subsection Choosing Commands
4358 None of the following movement commands understand the numeric prefix,
4359 and they all select and display an article.
4361 If you want to fetch new articles or redisplay the group, see
4362 @ref{Exiting the Summary Buffer}.
4366 @kindex SPACE (Summary)
4367 @findex gnus-summary-next-page
4368 Select the current article, or, if that one's read already, the next
4369 unread article (@code{gnus-summary-next-page}).
4374 @kindex G n (Summary)
4375 @findex gnus-summary-next-unread-article
4376 @c @icon{gnus-summary-next-unread}
4377 Go to next unread article (@code{gnus-summary-next-unread-article}).
4382 @findex gnus-summary-prev-unread-article
4383 @c @icon{gnus-summary-prev-unread}
4384 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
4389 @kindex G N (Summary)
4390 @findex gnus-summary-next-article
4391 Go to the next article (@code{gnus-summary-next-article}).
4396 @kindex G P (Summary)
4397 @findex gnus-summary-prev-article
4398 Go to the previous article (@code{gnus-summary-prev-article}).
4401 @kindex G C-n (Summary)
4402 @findex gnus-summary-next-same-subject
4403 Go to the next article with the same subject
4404 (@code{gnus-summary-next-same-subject}).
4407 @kindex G C-p (Summary)
4408 @findex gnus-summary-prev-same-subject
4409 Go to the previous article with the same subject
4410 (@code{gnus-summary-prev-same-subject}).
4414 @kindex G f (Summary)
4416 @findex gnus-summary-first-unread-article
4417 Go to the first unread article
4418 (@code{gnus-summary-first-unread-article}).
4422 @kindex G b (Summary)
4424 @findex gnus-summary-best-unread-article
4425 Go to the article with the highest score
4426 (@code{gnus-summary-best-unread-article}).
4431 @kindex G l (Summary)
4432 @findex gnus-summary-goto-last-article
4433 Go to the previous article read (@code{gnus-summary-goto-last-article}).
4436 @kindex G o (Summary)
4437 @findex gnus-summary-pop-article
4439 @cindex article history
4440 Pop an article off the summary history and go to this article
4441 (@code{gnus-summary-pop-article}). This command differs from the
4442 command above in that you can pop as many previous articles off the
4443 history as you like, while @kbd{l} toggles the two last read articles.
4444 For a somewhat related issue (if you use these commands a lot),
4445 @pxref{Article Backlog}.
4450 @kindex G j (Summary)
4451 @findex gnus-summary-goto-article
4452 Ask for an article number or @code{Message-ID}, and then go to that
4453 article (@code{gnus-summary-goto-article}).
4458 @node Choosing Variables
4459 @subsection Choosing Variables
4461 Some variables relevant for moving and selecting articles:
4464 @item gnus-auto-extend-newsgroup
4465 @vindex gnus-auto-extend-newsgroup
4466 All the movement commands will try to go to the previous (or next)
4467 article, even if that article isn't displayed in the Summary buffer if
4468 this variable is non-@code{nil}. Gnus will then fetch the article from
4469 the server and display it in the article buffer.
4471 @item gnus-select-article-hook
4472 @vindex gnus-select-article-hook
4473 This hook is called whenever an article is selected. By default it
4474 exposes any threads hidden under the selected article.
4476 @item gnus-mark-article-hook
4477 @vindex gnus-mark-article-hook
4478 @findex gnus-summary-mark-unread-as-read
4479 @findex gnus-summary-mark-read-and-unread-as-read
4480 @findex gnus-unread-mark
4481 This hook is called whenever an article is selected. It is intended to
4482 be used for marking articles as read. The default value is
4483 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
4484 mark of almost any article you read to @code{gnus-unread-mark}. The
4485 only articles not affected by this function are ticked, dormant, and
4486 expirable articles. If you'd instead like to just have unread articles
4487 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
4488 instead. It will leave marks like @code{gnus-low-score-mark},
4489 @code{gnus-del-mark} (and so on) alone.
4494 @node Paging the Article
4495 @section Scrolling the Article
4496 @cindex article scrolling
4501 @kindex SPACE (Summary)
4502 @findex gnus-summary-next-page
4503 Pressing @kbd{SPACE} will scroll the current article forward one page,
4504 or, if you have come to the end of the current article, will choose the
4505 next article (@code{gnus-summary-next-page}).
4508 @kindex DEL (Summary)
4509 @findex gnus-summary-prev-page
4510 Scroll the current article back one page (@code{gnus-summary-prev-page}).
4513 @kindex RET (Summary)
4514 @findex gnus-summary-scroll-up
4515 Scroll the current article one line forward
4516 (@code{gnus-summary-scroll-up}).
4519 @kindex M-RET (Summary)
4520 @findex gnus-summary-scroll-down
4521 Scroll the current article one line backward
4522 (@code{gnus-summary-scroll-down}).
4526 @kindex A g (Summary)
4528 @findex gnus-summary-show-article
4529 @vindex gnus-summary-show-article-charset-alist
4530 (Re)fetch the current article (@code{gnus-summary-show-article}). If
4531 given a prefix, fetch the current article, but don't run any of the
4532 article treatment functions. This will give you a ``raw'' article, just
4533 the way it came from the server.
4535 If given a numerical prefix, you can do semi-manual charset stuff.
4536 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
4537 encoded in the @code{cn-gb-2312} charset. If you have
4540 (setq gnus-summary-show-article-charset-alist
4545 then you can say @kbd{C-u 1 g} to get the same effect.
4550 @kindex A < (Summary)
4551 @findex gnus-summary-beginning-of-article
4552 Scroll to the beginning of the article
4553 (@code{gnus-summary-beginning-of-article}).
4558 @kindex A > (Summary)
4559 @findex gnus-summary-end-of-article
4560 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
4564 @kindex A s (Summary)
4566 @findex gnus-summary-isearch-article
4567 Perform an isearch in the article buffer
4568 (@code{gnus-summary-isearch-article}).
4572 @findex gnus-summary-select-article-buffer
4573 Select the article buffer (@code{gnus-summary-select-article-buffer}).
4578 @node Reply Followup and Post
4579 @section Reply, Followup and Post
4582 * Summary Mail Commands:: Sending mail.
4583 * Summary Post Commands:: Sending news.
4584 * Summary Message Commands:: Other Message-related commands.
4585 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
4589 @node Summary Mail Commands
4590 @subsection Summary Mail Commands
4592 @cindex composing mail
4594 Commands for composing a mail message:
4600 @kindex S r (Summary)
4602 @findex gnus-summary-reply
4603 @c @icon{gnus-summary-mail-reply}
4604 @c @icon{gnus-summary-reply}
4605 Mail a reply to the author of the current article
4606 (@code{gnus-summary-reply}).
4611 @kindex S R (Summary)
4612 @findex gnus-summary-reply-with-original
4613 @c @icon{gnus-summary-reply-with-original}
4614 Mail a reply to the author of the current article and include the
4615 original message (@code{gnus-summary-reply-with-original}). This
4616 command uses the process/prefix convention.
4619 @kindex S w (Summary)
4620 @findex gnus-summary-wide-reply
4621 Mail a wide reply to the author of the current article
4622 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
4623 goes out to all people listed in the @code{To}, @code{From} (or
4624 @code{Reply-to}) and @code{Cc} headers.
4627 @kindex S W (Summary)
4628 @findex gnus-summary-wide-reply-with-original
4629 Mail a wide reply to the current article and include the original
4630 message (@code{gnus-summary-wide-reply-with-original}). This command uses
4631 the process/prefix convention.
4634 @kindex S v (Summary)
4635 @findex gnus-summary-very-wide-reply
4636 Mail a very wide reply to the author of the current article
4637 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
4638 that goes out to all people listed in the @code{To}, @code{From} (or
4639 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
4640 articles. This command uses the process/prefix convention.
4643 @kindex S W (Summary)
4644 @findex gnus-summary-wide-reply-with-original
4645 Mail a very wide reply to the current article and include the original
4646 message (@code{gnus-summary-wide-reply-with-original}). This command uses
4647 the process/prefix convention.
4651 @kindex S o m (Summary)
4652 @kindex C-c C-f (Summary)
4653 @findex gnus-summary-mail-forward
4654 @c @icon{gnus-summary-mail-forward}
4655 Forward the current article to some other person
4656 (@code{gnus-summary-mail-forward}). If no prefix is given, the message
4657 is forwarded according to the value of (@code{message-forward-as-mime})
4658 and (@code{message-forward-show-mml}); if the prefix is 1, decode the
4659 message and forward directly inline; if the prefix is 2, forward message
4660 as an rfc822 MIME section; if the prefix is 3, decode message and
4661 forward as an rfc822 MIME section; if the prefix is 4, forward message
4662 directly inline; otherwise, the message is forwarded as no prefix given
4663 but use the flipped value of (@code{message-forward-as-mime}). By
4664 default, the message is decoded and forwarded as an rfc822 MIME section.
4669 @kindex S m (Summary)
4670 @findex gnus-summary-mail-other-window
4671 @c @icon{gnus-summary-mail-originate}
4672 Send a mail to some other person
4673 (@code{gnus-summary-mail-other-window}).
4676 @kindex S D b (Summary)
4677 @findex gnus-summary-resend-bounced-mail
4678 @cindex bouncing mail
4679 If you have sent a mail, but the mail was bounced back to you for some
4680 reason (wrong address, transient failure), you can use this command to
4681 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
4682 will be popped into a mail buffer where you can edit the headers before
4683 sending the mail off again. If you give a prefix to this command, and
4684 the bounced mail is a reply to some other mail, Gnus will try to fetch
4685 that mail and display it for easy perusal of its headers. This might
4686 very well fail, though.
4689 @kindex S D r (Summary)
4690 @findex gnus-summary-resend-message
4691 Not to be confused with the previous command,
4692 @code{gnus-summary-resend-message} will prompt you for an address to
4693 send the current message off to, and then send it to that place. The
4694 headers of the message won't be altered---but lots of headers that say
4695 @code{Resent-To}, @code{Resent-From} and so on will be added. This
4696 means that you actually send a mail to someone that has a @code{To}
4697 header that (probably) points to yourself. This will confuse people.
4698 So, natcherly you'll only do that if you're really eVIl.
4700 This command is mainly used if you have several accounts and want to
4701 ship a mail to a different account of yours. (If you're both
4702 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4703 to the @code{root} account, you may want to resend it to
4704 @code{postmaster}. Ordnung muß sein!
4706 This command understands the process/prefix convention
4707 (@pxref{Process/Prefix}).
4710 @kindex S O m (Summary)
4711 @findex gnus-uu-digest-mail-forward
4712 Digest the current series (@pxref{Decoding Articles}) and forward the
4713 result using mail (@code{gnus-uu-digest-mail-forward}). This command
4714 uses the process/prefix convention (@pxref{Process/Prefix}).
4717 @kindex S M-c (Summary)
4718 @findex gnus-summary-mail-crosspost-complaint
4719 @cindex crossposting
4720 @cindex excessive crossposting
4721 Send a complaint about excessive crossposting to the author of the
4722 current article (@code{gnus-summary-mail-crosspost-complaint}).
4724 @findex gnus-crosspost-complaint
4725 This command is provided as a way to fight back against the current
4726 crossposting pandemic that's sweeping Usenet. It will compose a reply
4727 using the @code{gnus-crosspost-complaint} variable as a preamble. This
4728 command understands the process/prefix convention
4729 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
4733 Also @pxref{(message)Header Commands} for more information.
4736 @node Summary Post Commands
4737 @subsection Summary Post Commands
4739 @cindex composing news
4741 Commands for posting a news article:
4747 @kindex S p (Summary)
4748 @findex gnus-summary-post-news
4749 @c @icon{gnus-summary-post-news}
4750 Post an article to the current group
4751 (@code{gnus-summary-post-news}).
4756 @kindex S f (Summary)
4757 @findex gnus-summary-followup
4758 @c @icon{gnus-summary-followup}
4759 Post a followup to the current article (@code{gnus-summary-followup}).
4763 @kindex S F (Summary)
4765 @c @icon{gnus-summary-followup-with-original}
4766 @findex gnus-summary-followup-with-original
4767 Post a followup to the current article and include the original message
4768 (@code{gnus-summary-followup-with-original}). This command uses the
4769 process/prefix convention.
4772 @kindex S n (Summary)
4773 @findex gnus-summary-followup-to-mail
4774 Post a followup to the current article via news, even if you got the
4775 message through mail (@code{gnus-summary-followup-to-mail}).
4778 @kindex S N (Summary)
4779 @findex gnus-summary-followup-to-mail-with-original
4780 Post a followup to the current article via news, even if you got the
4781 message through mail and include the original message
4782 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
4783 the process/prefix convention.
4786 @kindex S o p (Summary)
4787 @findex gnus-summary-post-forward
4788 Forward the current article to a newsgroup
4789 (@code{gnus-summary-post-forward}).
4790 If no prefix is given, the message is forwarded according to the value
4791 of (@code{message-forward-as-mime}) and
4792 (@code{message-forward-show-mml}); if the prefix is 1, decode the
4793 message and forward directly inline; if the prefix is 2, forward message
4794 as an rfc822 MIME section; if the prefix is 3, decode message and
4795 forward as an rfc822 MIME section; if the prefix is 4, forward message
4796 directly inline; otherwise, the message is forwarded as no prefix given
4797 but use the flipped value of (@code{message-forward-as-mime}). By
4798 default, the message is decoded and forwarded as an rfc822 MIME section.
4801 @kindex S O p (Summary)
4802 @findex gnus-uu-digest-post-forward
4804 @cindex making digests
4805 Digest the current series and forward the result to a newsgroup
4806 (@code{gnus-uu-digest-mail-forward}). This command uses the
4807 process/prefix convention.
4810 @kindex S u (Summary)
4811 @findex gnus-uu-post-news
4812 @c @icon{gnus-uu-post-news}
4813 Uuencode a file, split it into parts, and post it as a series
4814 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
4817 Also @pxref{(message)Header Commands} for more information.
4820 @node Summary Message Commands
4821 @subsection Summary Message Commands
4825 @kindex S y (Summary)
4826 @findex gnus-summary-yank-message
4827 Yank the current article into an already existing Message composition
4828 buffer (@code{gnus-summary-yank-message}). This command prompts for
4829 what message buffer you want to yank into, and understands the
4830 process/prefix convention (@pxref{Process/Prefix}).
4835 @node Canceling and Superseding
4836 @subsection Canceling Articles
4837 @cindex canceling articles
4838 @cindex superseding articles
4840 Have you ever written something, and then decided that you really,
4841 really, really wish you hadn't posted that?
4843 Well, you can't cancel mail, but you can cancel posts.
4845 @findex gnus-summary-cancel-article
4847 @c @icon{gnus-summary-cancel-article}
4848 Find the article you wish to cancel (you can only cancel your own
4849 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
4850 c} (@code{gnus-summary-cancel-article}). Your article will be
4851 canceled---machines all over the world will be deleting your article.
4852 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4854 Be aware, however, that not all sites honor cancels, so your article may
4855 live on here and there, while most sites will delete the article in
4858 Gnus will use the ``current'' select method when canceling. If you
4859 want to use the standard posting method, use the @samp{a} symbolic
4860 prefix (@pxref{Symbolic Prefixes}).
4862 If you discover that you have made some mistakes and want to do some
4863 corrections, you can post a @dfn{superseding} article that will replace
4864 your original article.
4866 @findex gnus-summary-supersede-article
4868 Go to the original article and press @kbd{S s}
4869 (@code{gnus-summary-supersede-article}). You will be put in a buffer
4870 where you can edit the article all you want before sending it off the
4873 The same goes for superseding as for canceling, only more so: Some
4874 sites do not honor superseding. On those sites, it will appear that you
4875 have posted almost the same article twice.
4877 If you have just posted the article, and change your mind right away,
4878 there is a trick you can use to cancel/supersede the article without
4879 waiting for the article to appear on your site first. You simply return
4880 to the post buffer (which is called @code{*sent ...*}). There you will
4881 find the article you just posted, with all the headers intact. Change
4882 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4883 header by substituting one of those words for the word
4884 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
4885 you would do normally. The previous article will be
4886 canceled/superseded.
4888 Just remember, kids: There is no 'c' in 'supersede'.
4891 @node Marking Articles
4892 @section Marking Articles
4893 @cindex article marking
4894 @cindex article ticking
4897 There are several marks you can set on an article.
4899 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4900 neologism ohoy!) of the article. Alphabetic marks generally mean
4901 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4903 In addition, you also have marks that do not affect readedness.
4906 * Unread Articles:: Marks for unread articles.
4907 * Read Articles:: Marks for read articles.
4908 * Other Marks:: Marks that do not affect readedness.
4912 There's a plethora of commands for manipulating these marks:
4916 * Setting Marks:: How to set and remove marks.
4917 * Generic Marking Commands:: How to customize the marking.
4918 * Setting Process Marks:: How to mark articles for later processing.
4922 @node Unread Articles
4923 @subsection Unread Articles
4925 The following marks mark articles as (kinda) unread, in one form or
4930 @vindex gnus-ticked-mark
4931 Marked as ticked (@code{gnus-ticked-mark}).
4933 @dfn{Ticked articles} are articles that will remain visible always. If
4934 you see an article that you find interesting, or you want to put off
4935 reading it, or replying to it, until sometime later, you'd typically
4936 tick it. However, articles can be expired (from news servers by the
4937 news server software, Gnus itself never expires ticked messages), so if
4938 you want to keep an article forever, you'll have to make it persistent
4939 (@pxref{Persistent Articles}).
4942 @vindex gnus-dormant-mark
4943 Marked as dormant (@code{gnus-dormant-mark}).
4945 @dfn{Dormant articles} will only appear in the summary buffer if there
4946 are followups to it. If you want to see them even if they don't have
4947 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4948 Otherwise (except for the visibility issue), they are just like ticked
4952 @vindex gnus-unread-mark
4953 Marked as unread (@code{gnus-unread-mark}).
4955 @dfn{Unread articles} are articles that haven't been read at all yet.
4960 @subsection Read Articles
4961 @cindex expirable mark
4963 All the following marks mark articles as read.
4968 @vindex gnus-del-mark
4969 These are articles that the user has marked as read with the @kbd{d}
4970 command manually, more or less (@code{gnus-del-mark}).
4973 @vindex gnus-read-mark
4974 Articles that have actually been read (@code{gnus-read-mark}).
4977 @vindex gnus-ancient-mark
4978 Articles that were marked as read in previous sessions and are now
4979 @dfn{old} (@code{gnus-ancient-mark}).
4982 @vindex gnus-killed-mark
4983 Marked as killed (@code{gnus-killed-mark}).
4986 @vindex gnus-kill-file-mark
4987 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4990 @vindex gnus-low-score-mark
4991 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4994 @vindex gnus-catchup-mark
4995 Marked as read by a catchup (@code{gnus-catchup-mark}).
4998 @vindex gnus-canceled-mark
4999 Canceled article (@code{gnus-canceled-mark})
5002 @vindex gnus-souped-mark
5003 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
5006 @vindex gnus-sparse-mark
5007 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
5011 @vindex gnus-duplicate-mark
5012 Article marked as read by duplicate suppression
5013 (@code{gnus-duplicated-mark}). @xref{Duplicate Suppression}.
5017 All these marks just mean that the article is marked as read, really.
5018 They are interpreted differently when doing adaptive scoring, though.
5020 One more special mark, though:
5024 @vindex gnus-expirable-mark
5025 Marked as expirable (@code{gnus-expirable-mark}).
5027 Marking articles as @dfn{expirable} (or have them marked as such
5028 automatically) doesn't make much sense in normal groups---a user doesn't
5029 control expiring of news articles, but in mail groups, for instance,
5030 articles marked as @dfn{expirable} can be deleted by Gnus at
5036 @subsection Other Marks
5037 @cindex process mark
5040 There are some marks that have nothing to do with whether the article is
5046 You can set a bookmark in the current article. Say you are reading a
5047 long thesis on cats' urinary tracts, and have to go home for dinner
5048 before you've finished reading the thesis. You can then set a bookmark
5049 in the article, and Gnus will jump to this bookmark the next time it
5050 encounters the article. @xref{Setting Marks}.
5053 @vindex gnus-replied-mark
5054 All articles that you have replied to or made a followup to (i.e., have
5055 answered) will be marked with an @samp{A} in the second column
5056 (@code{gnus-replied-mark}).
5058 @vindex gnus-forwarded-mark
5059 All articles that you have forwarded will be marked with an @samp{O} in
5060 the second column (@code{gnus-forwarded-mark}).
5063 @vindex gnus-cached-mark
5064 Articles stored in the article cache will be marked with an @samp{*} in
5065 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
5068 @vindex gnus-saved-mark
5069 Articles ``saved'' (in some manner or other; not necessarily
5070 religiously) are marked with an @samp{S} in the second column
5071 (@code{gnus-saved-mark}).
5074 @vindex gnus-not-empty-thread-mark
5075 @vindex gnus-empty-thread-mark
5076 If the @samp{%e} spec is used, the presence of threads or not will be
5077 marked with @code{gnus-not-empty-thread-mark} and
5078 @code{gnus-empty-thread-mark} in the third column, respectively.
5081 @vindex gnus-process-mark
5082 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
5083 variety of commands react to the presence of the process mark. For
5084 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5085 all articles that have been marked with the process mark. Articles
5086 marked with the process mark have a @samp{#} in the second column.
5090 You might have noticed that most of these ``non-readedness'' marks
5091 appear in the second column by default. So if you have a cached, saved,
5092 replied article that you have process-marked, what will that look like?
5094 Nothing much. The precedence rules go as follows: process -> cache ->
5095 replied -> saved. So if the article is in the cache and is replied,
5096 you'll only see the cache mark and not the replied mark.
5100 @subsection Setting Marks
5101 @cindex setting marks
5103 All the marking commands understand the numeric prefix.
5108 @kindex M c (Summary)
5109 @kindex M-u (Summary)
5110 @findex gnus-summary-clear-mark-forward
5111 @cindex mark as unread
5112 Clear all readedness-marks from the current article
5113 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
5119 @kindex M t (Summary)
5120 @findex gnus-summary-tick-article-forward
5121 Tick the current article (@code{gnus-summary-tick-article-forward}).
5122 @xref{Article Caching}.
5127 @kindex M ? (Summary)
5128 @findex gnus-summary-mark-as-dormant
5129 Mark the current article as dormant
5130 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
5134 @kindex M d (Summary)
5136 @findex gnus-summary-mark-as-read-forward
5137 Mark the current article as read
5138 (@code{gnus-summary-mark-as-read-forward}).
5142 @findex gnus-summary-mark-as-read-backward
5143 Mark the current article as read and move point to the previous line
5144 (@code{gnus-summary-mark-as-read-backward}).
5149 @kindex M k (Summary)
5150 @findex gnus-summary-kill-same-subject-and-select
5151 Mark all articles that have the same subject as the current one as read,
5152 and then select the next unread article
5153 (@code{gnus-summary-kill-same-subject-and-select}).
5157 @kindex M K (Summary)
5158 @kindex C-k (Summary)
5159 @findex gnus-summary-kill-same-subject
5160 Mark all articles that have the same subject as the current one as read
5161 (@code{gnus-summary-kill-same-subject}).
5164 @kindex M C (Summary)
5165 @findex gnus-summary-catchup
5166 @c @icon{gnus-summary-catchup}
5167 Mark all unread articles as read (@code{gnus-summary-catchup}).
5170 @kindex M C-c (Summary)
5171 @findex gnus-summary-catchup-all
5172 Mark all articles in the group as read---even the ticked and dormant
5173 articles (@code{gnus-summary-catchup-all}).
5176 @kindex M H (Summary)
5177 @findex gnus-summary-catchup-to-here
5178 Catchup the current group to point
5179 (@code{gnus-summary-catchup-to-here}).
5182 @kindex C-w (Summary)
5183 @findex gnus-summary-mark-region-as-read
5184 Mark all articles between point and mark as read
5185 (@code{gnus-summary-mark-region-as-read}).
5188 @kindex M V k (Summary)
5189 @findex gnus-summary-kill-below
5190 Kill all articles with scores below the default score (or below the
5191 numeric prefix) (@code{gnus-summary-kill-below}).
5195 @kindex M e (Summary)
5197 @findex gnus-summary-mark-as-expirable
5198 Mark the current article as expirable
5199 (@code{gnus-summary-mark-as-expirable}).
5202 @kindex M b (Summary)
5203 @findex gnus-summary-set-bookmark
5204 Set a bookmark in the current article
5205 (@code{gnus-summary-set-bookmark}).
5208 @kindex M B (Summary)
5209 @findex gnus-summary-remove-bookmark
5210 Remove the bookmark from the current article
5211 (@code{gnus-summary-remove-bookmark}).
5214 @kindex M V c (Summary)
5215 @findex gnus-summary-clear-above
5216 Clear all marks from articles with scores over the default score (or
5217 over the numeric prefix) (@code{gnus-summary-clear-above}).
5220 @kindex M V u (Summary)
5221 @findex gnus-summary-tick-above
5222 Tick all articles with scores over the default score (or over the
5223 numeric prefix) (@code{gnus-summary-tick-above}).
5226 @kindex M V m (Summary)
5227 @findex gnus-summary-mark-above
5228 Prompt for a mark, and mark all articles with scores over the default
5229 score (or over the numeric prefix) with this mark
5230 (@code{gnus-summary-clear-above}).
5233 @vindex gnus-summary-goto-unread
5234 The @code{gnus-summary-goto-unread} variable controls what action should
5235 be taken after setting a mark. If non-@code{nil}, point will move to
5236 the next/previous unread article. If @code{nil}, point will just move
5237 one line up or down. As a special case, if this variable is
5238 @code{never}, all the marking commands as well as other commands (like
5239 @kbd{SPACE}) will move to the next article, whether it is unread or not.
5240 The default is @code{t}.
5243 @node Generic Marking Commands
5244 @subsection Generic Marking Commands
5246 Some people would like the command that ticks an article (@kbd{!}) go to
5247 the next article. Others would like it to go to the next unread
5248 article. Yet others would like it to stay on the current article. And
5249 even though I haven't heard of anybody wanting it to go to the
5250 previous (unread) article, I'm sure there are people that want that as
5253 Multiply these five behaviors with five different marking commands, and
5254 you get a potentially complex set of variable to control what each
5257 To sidestep that mess, Gnus provides commands that do all these
5258 different things. They can be found on the @kbd{M M} map in the summary
5259 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
5260 to list in this manual.
5262 While you can use these commands directly, most users would prefer
5263 altering the summary mode keymap. For instance, if you would like the
5264 @kbd{!} command to go to the next article instead of the next unread
5265 article, you could say something like:
5268 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
5269 (defun my-alter-summary-map ()
5270 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
5276 (defun my-alter-summary-map ()
5277 (local-set-key "!" "MM!n"))
5281 @node Setting Process Marks
5282 @subsection Setting Process Marks
5283 @cindex setting process marks
5290 @kindex M P p (Summary)
5291 @findex gnus-summary-mark-as-processable
5292 Mark the current article with the process mark
5293 (@code{gnus-summary-mark-as-processable}).
5294 @findex gnus-summary-unmark-as-processable
5298 @kindex M P u (Summary)
5299 @kindex M-# (Summary)
5300 Remove the process mark, if any, from the current article
5301 (@code{gnus-summary-unmark-as-processable}).
5304 @kindex M P U (Summary)
5305 @findex gnus-summary-unmark-all-processable
5306 Remove the process mark from all articles
5307 (@code{gnus-summary-unmark-all-processable}).
5310 @kindex M P i (Summary)
5311 @findex gnus-uu-invert-processable
5312 Invert the list of process marked articles
5313 (@code{gnus-uu-invert-processable}).
5316 @kindex M P R (Summary)
5317 @findex gnus-uu-mark-by-regexp
5318 Mark articles that have a @code{Subject} header that matches a regular
5319 expression (@code{gnus-uu-mark-by-regexp}).
5322 @kindex M P G (Summary)
5323 @findex gnus-uu-unmark-by-regexp
5324 Unmark articles that have a @code{Subject} header that matches a regular
5325 expression (@code{gnus-uu-unmark-by-regexp}).
5328 @kindex M P r (Summary)
5329 @findex gnus-uu-mark-region
5330 Mark articles in region (@code{gnus-uu-mark-region}).
5333 @kindex M P t (Summary)
5334 @findex gnus-uu-mark-thread
5335 Mark all articles in the current (sub)thread
5336 (@code{gnus-uu-mark-thread}).
5339 @kindex M P T (Summary)
5340 @findex gnus-uu-unmark-thread
5341 Unmark all articles in the current (sub)thread
5342 (@code{gnus-uu-unmark-thread}).
5345 @kindex M P v (Summary)
5346 @findex gnus-uu-mark-over
5347 Mark all articles that have a score above the prefix argument
5348 (@code{gnus-uu-mark-over}).
5351 @kindex M P s (Summary)
5352 @findex gnus-uu-mark-series
5353 Mark all articles in the current series (@code{gnus-uu-mark-series}).
5356 @kindex M P S (Summary)
5357 @findex gnus-uu-mark-sparse
5358 Mark all series that have already had some articles marked
5359 (@code{gnus-uu-mark-sparse}).
5362 @kindex M P a (Summary)
5363 @findex gnus-uu-mark-all
5364 Mark all articles in series order (@code{gnus-uu-mark-series}).
5367 @kindex M P b (Summary)
5368 @findex gnus-uu-mark-buffer
5369 Mark all articles in the buffer in the order they appear
5370 (@code{gnus-uu-mark-buffer}).
5373 @kindex M P k (Summary)
5374 @findex gnus-summary-kill-process-mark
5375 Push the current process mark set onto the stack and unmark all articles
5376 (@code{gnus-summary-kill-process-mark}).
5379 @kindex M P y (Summary)
5380 @findex gnus-summary-yank-process-mark
5381 Pop the previous process mark set from the stack and restore it
5382 (@code{gnus-summary-yank-process-mark}).
5385 @kindex M P w (Summary)
5386 @findex gnus-summary-save-process-mark
5387 Push the current process mark set onto the stack
5388 (@code{gnus-summary-save-process-mark}).
5392 Also see the @kbd{&} command in @pxref{Searching for Articles} for how to
5393 set process marks based on article body contents.
5400 It can be convenient to limit the summary buffer to just show some
5401 subset of the articles currently in the group. The effect most limit
5402 commands have is to remove a few (or many) articles from the summary
5405 All limiting commands work on subsets of the articles already fetched
5406 from the servers. None of these commands query the server for
5407 additional articles.
5413 @kindex / / (Summary)
5414 @findex gnus-summary-limit-to-subject
5415 Limit the summary buffer to articles that match some subject
5416 (@code{gnus-summary-limit-to-subject}).
5419 @kindex / a (Summary)
5420 @findex gnus-summary-limit-to-author
5421 Limit the summary buffer to articles that match some author
5422 (@code{gnus-summary-limit-to-author}).
5425 @kindex / x (Summary)
5426 @findex gnus-summary-limit-to-extra
5427 Limit the summary buffer to articles that match one of the ``extra''
5428 headers (@pxref{To From Newsgroups})
5429 (@code{gnus-summary-limit-to-extra}).
5433 @kindex / u (Summary)
5435 @findex gnus-summary-limit-to-unread
5436 Limit the summary buffer to articles not marked as read
5437 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
5438 buffer to articles strictly unread. This means that ticked and
5439 dormant articles will also be excluded.
5442 @kindex / m (Summary)
5443 @findex gnus-summary-limit-to-marks
5444 Ask for a mark and then limit to all articles that have been marked
5445 with that mark (@code{gnus-summary-limit-to-marks}).
5448 @kindex / t (Summary)
5449 @findex gnus-summary-limit-to-age
5450 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
5451 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
5452 articles younger than that number of days.
5455 @kindex / n (Summary)
5456 @findex gnus-summary-limit-to-articles
5457 Limit the summary buffer to the current article
5458 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
5459 convention (@pxref{Process/Prefix}).
5462 @kindex / w (Summary)
5463 @findex gnus-summary-pop-limit
5464 Pop the previous limit off the stack and restore it
5465 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
5469 @kindex / v (Summary)
5470 @findex gnus-summary-limit-to-score
5471 Limit the summary buffer to articles that have a score at or above some
5472 score (@code{gnus-summary-limit-to-score}).
5476 @kindex M S (Summary)
5477 @kindex / E (Summary)
5478 @findex gnus-summary-limit-include-expunged
5479 Include all expunged articles in the limit
5480 (@code{gnus-summary-limit-include-expunged}).
5483 @kindex / D (Summary)
5484 @findex gnus-summary-limit-include-dormant
5485 Include all dormant articles in the limit
5486 (@code{gnus-summary-limit-include-dormant}).
5489 @kindex / * (Summary)
5490 @findex gnus-summary-limit-include-cached
5491 Include all cached articles in the limit
5492 (@code{gnus-summary-limit-include-cached}).
5495 @kindex / d (Summary)
5496 @findex gnus-summary-limit-exclude-dormant
5497 Exclude all dormant articles from the limit
5498 (@code{gnus-summary-limit-exclude-dormant}).
5501 @kindex / M (Summary)
5502 @findex gnus-summary-limit-exclude-marks
5503 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
5506 @kindex / T (Summary)
5507 @findex gnus-summary-limit-include-thread
5508 Include all the articles in the current thread in the limit.
5511 @kindex / c (Summary)
5512 @findex gnus-summary-limit-exclude-childless-dormant
5513 Exclude all dormant articles that have no children from the limit
5514 (@code{gnus-summary-limit-exclude-childless-dormant}).
5517 @kindex / C (Summary)
5518 @findex gnus-summary-limit-mark-excluded-as-read
5519 Mark all excluded unread articles as read
5520 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
5521 also mark excluded ticked and dormant articles as read.
5529 @cindex article threading
5531 Gnus threads articles by default. @dfn{To thread} is to put responses
5532 to articles directly after the articles they respond to---in a
5533 hierarchical fashion.
5535 Threading is done by looking at the @code{References} headers of the
5536 articles. In a perfect world, this would be enough to build pretty
5537 trees, but unfortunately, the @code{References} header is often broken
5538 or simply missing. Weird news propagation exacerbates the problem,
5539 so one has to employ other heuristics to get pleasing results. A
5540 plethora of approaches exists, as detailed in horrible detail in
5541 @pxref{Customizing Threading}.
5543 First, a quick overview of the concepts:
5547 The top-most article in a thread; the first article in the thread.
5550 A tree-like article structure.
5553 A small(er) section of this tree-like structure.
5556 Threads often lose their roots due to article expiry, or due to the root
5557 already having been read in a previous session, and not displayed in the
5558 summary buffer. We then typically have many sub-threads that really
5559 belong to one thread, but are without connecting roots. These are
5560 called loose threads.
5562 @item thread gathering
5563 An attempt to gather loose threads into bigger threads.
5565 @item sparse threads
5566 A thread where the missing articles have been ``guessed'' at, and are
5567 displayed as empty lines in the summary buffer.
5573 * Customizing Threading:: Variables you can change to affect the threading.
5574 * Thread Commands:: Thread based commands in the summary buffer.
5578 @node Customizing Threading
5579 @subsection Customizing Threading
5580 @cindex customizing threading
5583 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
5584 * Filling In Threads:: Making the threads displayed look fuller.
5585 * More Threading:: Even more variables for fiddling with threads.
5586 * Low-Level Threading:: You thought it was over... but you were wrong!
5591 @subsubsection Loose Threads
5594 @cindex loose threads
5597 @item gnus-summary-make-false-root
5598 @vindex gnus-summary-make-false-root
5599 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
5600 and create a dummy root at the top. (Wait a minute. Root at the top?
5601 Yup.) Loose subtrees occur when the real root has expired, or you've
5602 read or killed the root in a previous session.
5604 When there is no real root of a thread, Gnus will have to fudge
5605 something. This variable says what fudging method Gnus should use.
5606 There are four possible values:
5610 \gnusfigure{The Summary Buffer}{390}{
5611 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
5612 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
5613 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
5614 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
5619 @cindex adopting articles
5624 Gnus will make the first of the orphaned articles the parent. This
5625 parent will adopt all the other articles. The adopted articles will be
5626 marked as such by pointy brackets (@samp{<>}) instead of the standard
5627 square brackets (@samp{[]}). This is the default method.
5630 @vindex gnus-summary-dummy-line-format
5631 Gnus will create a dummy summary line that will pretend to be the
5632 parent. This dummy line does not correspond to any real article, so
5633 selecting it will just select the first real article after the dummy
5634 article. @code{gnus-summary-dummy-line-format} is used to specify the
5635 format of the dummy roots. It accepts only one format spec: @samp{S},
5636 which is the subject of the article. @xref{Formatting Variables}.
5639 Gnus won't actually make any article the parent, but simply leave the
5640 subject field of all orphans except the first empty. (Actually, it will
5641 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
5645 Don't make any article parent at all. Just gather the threads and
5646 display them after one another.
5649 Don't gather loose threads.
5652 @item gnus-summary-gather-subject-limit
5653 @vindex gnus-summary-gather-subject-limit
5654 Loose threads are gathered by comparing subjects of articles. If this
5655 variable is @code{nil}, Gnus requires an exact match between the
5656 subjects of the loose threads before gathering them into one big
5657 super-thread. This might be too strict a requirement, what with the
5658 presence of stupid newsreaders that chop off long subject lines. If
5659 you think so, set this variable to, say, 20 to require that only the
5660 first 20 characters of the subjects have to match. If you set this
5661 variable to a really low number, you'll find that Gnus will gather
5662 everything in sight into one thread, which isn't very helpful.
5664 @cindex fuzzy article gathering
5665 If you set this variable to the special value @code{fuzzy}, Gnus will
5666 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
5669 @item gnus-simplify-subject-fuzzy-regexp
5670 @vindex gnus-simplify-subject-fuzzy-regexp
5671 This can either be a regular expression or list of regular expressions
5672 that match strings that will be removed from subjects if fuzzy subject
5673 simplification is used.
5675 @item gnus-simplify-ignored-prefixes
5676 @vindex gnus-simplify-ignored-prefixes
5677 If you set @code{gnus-summary-gather-subject-limit} to something as low
5678 as 10, you might consider setting this variable to something sensible:
5680 @c Written by Michael Ernst <mernst@cs.rice.edu>
5682 (setq gnus-simplify-ignored-prefixes
5688 "wanted" "followup" "summary\\( of\\)?"
5689 "help" "query" "problem" "question"
5690 "answer" "reference" "announce"
5691 "How can I" "How to" "Comparison of"
5696 (mapconcat 'identity
5697 '("for" "for reference" "with" "about")
5699 "\\)?\\]?:?[ \t]*"))
5702 All words that match this regexp will be removed before comparing two
5705 @item gnus-simplify-subject-functions
5706 @vindex gnus-simplify-subject-functions
5707 If non-@code{nil}, this variable overrides
5708 @code{gnus-summary-gather-subject-limit}. This variable should be a
5709 list of functions to apply to the @code{Subject} string iteratively to
5710 arrive at the simplified version of the string.
5712 Useful functions to put in this list include:
5715 @item gnus-simplify-subject-re
5716 @findex gnus-simplify-subject-re
5717 Strip the leading @samp{Re:}.
5719 @item gnus-simplify-subject-fuzzy
5720 @findex gnus-simplify-subject-fuzzy
5723 @item gnus-simplify-whitespace
5724 @findex gnus-simplify-whitespace
5725 Remove excessive whitespace.
5728 You may also write your own functions, of course.
5731 @item gnus-summary-gather-exclude-subject
5732 @vindex gnus-summary-gather-exclude-subject
5733 Since loose thread gathering is done on subjects only, that might lead
5734 to many false hits, especially with certain common subjects like
5735 @samp{} and @samp{(none)}. To make the situation slightly better,
5736 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
5737 what subjects should be excluded from the gathering process.@*
5738 The default is @samp{^ *$\\|^(none)$}.
5740 @item gnus-summary-thread-gathering-function
5741 @vindex gnus-summary-thread-gathering-function
5742 Gnus gathers threads by looking at @code{Subject} headers. This means
5743 that totally unrelated articles may end up in the same ``thread'', which
5744 is confusing. An alternate approach is to look at all the
5745 @code{Message-ID}s in all the @code{References} headers to find matches.
5746 This will ensure that no gathered threads ever include unrelated
5747 articles, but it also means that people who have posted with broken
5748 newsreaders won't be gathered properly. The choice is yours---plague or
5752 @item gnus-gather-threads-by-subject
5753 @findex gnus-gather-threads-by-subject
5754 This function is the default gathering function and looks at
5755 @code{Subject}s exclusively.
5757 @item gnus-gather-threads-by-references
5758 @findex gnus-gather-threads-by-references
5759 This function looks at @code{References} headers exclusively.
5762 If you want to test gathering by @code{References}, you could say
5766 (setq gnus-summary-thread-gathering-function
5767 'gnus-gather-threads-by-references)
5773 @node Filling In Threads
5774 @subsubsection Filling In Threads
5777 @item gnus-fetch-old-headers
5778 @vindex gnus-fetch-old-headers
5779 If non-@code{nil}, Gnus will attempt to build old threads by fetching
5780 more old headers---headers to articles marked as read. If you
5781 would like to display as few summary lines as possible, but still
5782 connect as many loose threads as possible, you should set this variable
5783 to @code{some} or a number. If you set it to a number, no more than
5784 that number of extra old headers will be fetched. In either case,
5785 fetching old headers only works if the backend you are using carries
5786 overview files---this would normally be @code{nntp}, @code{nnspool} and
5787 @code{nnml}. Also remember that if the root of the thread has been
5788 expired by the server, there's not much Gnus can do about that.
5790 This variable can also be set to @code{invisible}. This won't have any
5791 visible effects, but is useful if you use the @kbd{A T} command a lot
5792 (@pxref{Finding the Parent}).
5794 @item gnus-build-sparse-threads
5795 @vindex gnus-build-sparse-threads
5796 Fetching old headers can be slow. A low-rent similar effect can be
5797 gotten by setting this variable to @code{some}. Gnus will then look at
5798 the complete @code{References} headers of all articles and try to string
5799 together articles that belong in the same thread. This will leave
5800 @dfn{gaps} in the threading display where Gnus guesses that an article
5801 is missing from the thread. (These gaps appear like normal summary
5802 lines. If you select a gap, Gnus will try to fetch the article in
5803 question.) If this variable is @code{t}, Gnus will display all these
5804 ``gaps'' without regard for whether they are useful for completing the
5805 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
5806 off sparse leaf nodes that don't lead anywhere. This variable is
5807 @code{nil} by default.
5809 @item gnus-read-all-available-headers
5810 @vindex gnus-read-all-available-headers
5811 This is a rather obscure variable that few will find useful. It's
5812 intended for those non-news newsgroups where the backend has to fetch
5813 quite a lot to present the summary buffer, and where it's impossible to
5814 go back to parents of articles. This is mostly the case in the
5815 web-based groups, like the @code{nnultimate} groups.
5817 If you don't use those, then it's safe to leave this as the default
5818 @code{nil}. If you want to use this variable, it should be a regexp
5819 that matches the group name, or @code{t} for all groups.
5824 @node More Threading
5825 @subsubsection More Threading
5828 @item gnus-show-threads
5829 @vindex gnus-show-threads
5830 If this variable is @code{nil}, no threading will be done, and all of
5831 the rest of the variables here will have no effect. Turning threading
5832 off will speed group selection up a bit, but it is sure to make reading
5833 slower and more awkward.
5835 @item gnus-thread-hide-subtree
5836 @vindex gnus-thread-hide-subtree
5837 If non-@code{nil}, all threads will be hidden when the summary buffer is
5840 @item gnus-thread-expunge-below
5841 @vindex gnus-thread-expunge-below
5842 All threads that have a total score (as defined by
5843 @code{gnus-thread-score-function}) less than this number will be
5844 expunged. This variable is @code{nil} by default, which means that no
5845 threads are expunged.
5847 @item gnus-thread-hide-killed
5848 @vindex gnus-thread-hide-killed
5849 if you kill a thread and this variable is non-@code{nil}, the subtree
5852 @item gnus-thread-ignore-subject
5853 @vindex gnus-thread-ignore-subject
5854 Sometimes somebody changes the subject in the middle of a thread. If
5855 this variable is non-@code{nil}, which is the default, the subject
5856 change is ignored. If it is @code{nil}, a change in the subject will
5857 result in a new thread.
5859 @item gnus-thread-indent-level
5860 @vindex gnus-thread-indent-level
5861 This is a number that says how much each sub-thread should be indented.
5864 @item gnus-sort-gathered-threads-function
5865 @vindex gnus-sort-gathered-threads-function
5866 Sometimes, particularly with mailing lists, the order in which mails
5867 arrive locally is not necessarily the same as the order in which they
5868 arrived on the mailing list. Consequently, when sorting sub-threads
5869 using the default @code{gnus-thread-sort-by-number}, responses can end
5870 up appearing before the article to which they are responding to.
5871 Setting this variable to an alternate value
5872 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
5873 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
5874 more logical sub-thread ordering in such instances.
5879 @node Low-Level Threading
5880 @subsubsection Low-Level Threading
5884 @item gnus-parse-headers-hook
5885 @vindex gnus-parse-headers-hook
5886 Hook run before parsing any headers.
5888 @item gnus-alter-header-function
5889 @vindex gnus-alter-header-function
5890 If non-@code{nil}, this function will be called to allow alteration of
5891 article header structures. The function is called with one parameter,
5892 the article header vector, which it may alter in any way. For instance,
5893 if you have a mail-to-news gateway which alters the @code{Message-ID}s
5894 in systematic ways (by adding prefixes and such), you can use this
5895 variable to un-scramble the @code{Message-ID}s so that they are more
5896 meaningful. Here's one example:
5899 (setq gnus-alter-header-function 'my-alter-message-id)
5901 (defun my-alter-message-id (header)
5902 (let ((id (mail-header-id header)))
5904 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
5906 (concat (match-string 1 id) "@@" (match-string 2 id))
5913 @node Thread Commands
5914 @subsection Thread Commands
5915 @cindex thread commands
5921 @kindex T k (Summary)
5922 @kindex M-C-k (Summary)
5923 @findex gnus-summary-kill-thread
5924 Mark all articles in the current (sub-)thread as read
5925 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
5926 remove all marks instead. If the prefix argument is negative, tick
5931 @kindex T l (Summary)
5932 @kindex M-C-l (Summary)
5933 @findex gnus-summary-lower-thread
5934 Lower the score of the current (sub-)thread
5935 (@code{gnus-summary-lower-thread}).
5938 @kindex T i (Summary)
5939 @findex gnus-summary-raise-thread
5940 Increase the score of the current (sub-)thread
5941 (@code{gnus-summary-raise-thread}).
5944 @kindex T # (Summary)
5945 @findex gnus-uu-mark-thread
5946 Set the process mark on the current (sub-)thread
5947 (@code{gnus-uu-mark-thread}).
5950 @kindex T M-# (Summary)
5951 @findex gnus-uu-unmark-thread
5952 Remove the process mark from the current (sub-)thread
5953 (@code{gnus-uu-unmark-thread}).
5956 @kindex T T (Summary)
5957 @findex gnus-summary-toggle-threads
5958 Toggle threading (@code{gnus-summary-toggle-threads}).
5961 @kindex T s (Summary)
5962 @findex gnus-summary-show-thread
5963 Expose the (sub-)thread hidden under the current article, if any
5964 (@code{gnus-summary-show-thread}).
5967 @kindex T h (Summary)
5968 @findex gnus-summary-hide-thread
5969 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5972 @kindex T S (Summary)
5973 @findex gnus-summary-show-all-threads
5974 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5977 @kindex T H (Summary)
5978 @findex gnus-summary-hide-all-threads
5979 Hide all threads (@code{gnus-summary-hide-all-threads}).
5982 @kindex T t (Summary)
5983 @findex gnus-summary-rethread-current
5984 Re-thread the current article's thread
5985 (@code{gnus-summary-rethread-current}). This works even when the
5986 summary buffer is otherwise unthreaded.
5989 @kindex T ^ (Summary)
5990 @findex gnus-summary-reparent-thread
5991 Make the current article the child of the marked (or previous) article
5992 (@code{gnus-summary-reparent-thread}).
5996 The following commands are thread movement commands. They all
5997 understand the numeric prefix.
6002 @kindex T n (Summary)
6004 @kindex M-C-n (Summary)
6006 @kindex M-down (Summary)
6007 @findex gnus-summary-next-thread
6008 Go to the next thread (@code{gnus-summary-next-thread}).
6011 @kindex T p (Summary)
6013 @kindex M-C-p (Summary)
6015 @kindex M-up (Summary)
6016 @findex gnus-summary-prev-thread
6017 Go to the previous thread (@code{gnus-summary-prev-thread}).
6020 @kindex T d (Summary)
6021 @findex gnus-summary-down-thread
6022 Descend the thread (@code{gnus-summary-down-thread}).
6025 @kindex T u (Summary)
6026 @findex gnus-summary-up-thread
6027 Ascend the thread (@code{gnus-summary-up-thread}).
6030 @kindex T o (Summary)
6031 @findex gnus-summary-top-thread
6032 Go to the top of the thread (@code{gnus-summary-top-thread}).
6035 @vindex gnus-thread-operation-ignore-subject
6036 If you ignore subject while threading, you'll naturally end up with
6037 threads that have several different subjects in them. If you then issue
6038 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
6039 wish to kill the entire thread, but just those parts of the thread that
6040 have the same subject as the current article. If you like this idea,
6041 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
6042 is non-@code{nil} (which it is by default), subjects will be ignored
6043 when doing thread commands. If this variable is @code{nil}, articles in
6044 the same thread with different subjects will not be included in the
6045 operation in question. If this variable is @code{fuzzy}, only articles
6046 that have subjects fuzzily equal will be included (@pxref{Fuzzy
6050 @node Sorting the Summary Buffer
6051 @section Sorting the Summary Buffer
6053 @findex gnus-thread-sort-by-total-score
6054 @findex gnus-thread-sort-by-date
6055 @findex gnus-thread-sort-by-score
6056 @findex gnus-thread-sort-by-subject
6057 @findex gnus-thread-sort-by-author
6058 @findex gnus-thread-sort-by-number
6059 @vindex gnus-thread-sort-functions
6060 If you are using a threaded summary display, you can sort the threads by
6061 setting @code{gnus-thread-sort-functions}, which can be either a single
6062 function, a list of functions, or a list containing functions and
6063 @code{(not some-function)} elements.
6065 By default, sorting is done on article numbers. Ready-made sorting
6066 predicate functions include @code{gnus-thread-sort-by-number},
6067 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
6068 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
6069 @code{gnus-thread-sort-by-total-score}.
6071 Each function takes two threads and returns non-@code{nil} if the first
6072 thread should be sorted before the other. Note that sorting really is
6073 normally done by looking only at the roots of each thread.
6075 If you use more than one function, the primary sort key should be the
6076 last function in the list. You should probably always include
6077 @code{gnus-thread-sort-by-number} in the list of sorting
6078 functions---preferably first. This will ensure that threads that are
6079 equal with respect to the other sort criteria will be displayed in
6080 ascending article order.
6082 If you would like to sort by reverse score, then by subject, and finally
6083 by number, you could do something like:
6086 (setq gnus-thread-sort-functions
6087 '(gnus-thread-sort-by-number
6088 gnus-thread-sort-by-subject
6089 (not gnus-thread-sort-by-total-score)))
6092 The threads that have highest score will be displayed first in the
6093 summary buffer. When threads have the same score, they will be sorted
6094 alphabetically. The threads that have the same score and the same
6095 subject will be sorted by number, which is (normally) the sequence in
6096 which the articles arrived.
6098 If you want to sort by score and then reverse arrival order, you could
6102 (setq gnus-thread-sort-functions
6104 (not (gnus-thread-sort-by-number t1 t2)))
6105 gnus-thread-sort-by-score))
6108 @vindex gnus-thread-score-function
6109 The function in the @code{gnus-thread-score-function} variable (default
6110 @code{+}) is used for calculating the total score of a thread. Useful
6111 functions might be @code{max}, @code{min}, or squared means, or whatever
6114 @findex gnus-article-sort-functions
6115 @findex gnus-article-sort-by-date
6116 @findex gnus-article-sort-by-score
6117 @findex gnus-article-sort-by-subject
6118 @findex gnus-article-sort-by-author
6119 @findex gnus-article-sort-by-number
6120 If you are using an unthreaded display for some strange reason or other,
6121 you have to fiddle with the @code{gnus-article-sort-functions} variable.
6122 It is very similar to the @code{gnus-thread-sort-functions}, except that
6123 it uses slightly different functions for article comparison. Available
6124 sorting predicate functions are @code{gnus-article-sort-by-number},
6125 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
6126 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
6128 If you want to sort an unthreaded summary display by subject, you could
6132 (setq gnus-article-sort-functions
6133 '(gnus-article-sort-by-number
6134 gnus-article-sort-by-subject))
6139 @node Asynchronous Fetching
6140 @section Asynchronous Article Fetching
6141 @cindex asynchronous article fetching
6142 @cindex article pre-fetch
6145 If you read your news from an @sc{nntp} server that's far away, the
6146 network latencies may make reading articles a chore. You have to wait
6147 for a while after pressing @kbd{n} to go to the next article before the
6148 article appears. Why can't Gnus just go ahead and fetch the article
6149 while you are reading the previous one? Why not, indeed.
6151 First, some caveats. There are some pitfalls to using asynchronous
6152 article fetching, especially the way Gnus does it.
6154 Let's say you are reading article 1, which is short, and article 2 is
6155 quite long, and you are not interested in reading that. Gnus does not
6156 know this, so it goes ahead and fetches article 2. You decide to read
6157 article 3, but since Gnus is in the process of fetching article 2, the
6158 connection is blocked.
6160 To avoid these situations, Gnus will open two (count 'em two)
6161 connections to the server. Some people may think this isn't a very nice
6162 thing to do, but I don't see any real alternatives. Setting up that
6163 extra connection takes some time, so Gnus startup will be slower.
6165 Gnus will fetch more articles than you will read. This will mean that
6166 the link between your machine and the @sc{nntp} server will become more
6167 loaded than if you didn't use article pre-fetch. The server itself will
6168 also become more loaded---both with the extra article requests, and the
6171 Ok, so now you know that you shouldn't really use this thing... unless
6174 @vindex gnus-asynchronous
6175 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
6176 happen automatically.
6178 @vindex gnus-use-article-prefetch
6179 You can control how many articles are to be pre-fetched by setting
6180 @code{gnus-use-article-prefetch}. This is 30 by default, which means
6181 that when you read an article in the group, the backend will pre-fetch
6182 the next 30 articles. If this variable is @code{t}, the backend will
6183 pre-fetch all the articles it can without bound. If it is
6184 @code{nil}, no pre-fetching will be done.
6186 @vindex gnus-async-prefetch-article-p
6187 @findex gnus-async-read-p
6188 There are probably some articles that you don't want to pre-fetch---read
6189 articles, for instance. The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched. This function should
6190 return non-@code{nil} when the article in question is to be
6191 pre-fetched. The default is @code{gnus-async-read-p}, which returns
6192 @code{nil} on read articles. The function is called with an article
6193 data structure as the only parameter.
6195 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
6198 (defun my-async-short-unread-p (data)
6199 "Return non-nil for short, unread articles."
6200 (and (gnus-data-unread-p data)
6201 (< (mail-header-lines (gnus-data-header data))
6204 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
6207 These functions will be called many, many times, so they should
6208 preferably be short and sweet to avoid slowing down Gnus too much.
6209 It's probably a good idea to byte-compile things like this.
6211 @vindex gnus-prefetched-article-deletion-strategy
6212 Articles have to be removed from the asynch buffer sooner or later. The
6213 @code{gnus-prefetched-article-deletion-strategy} says when to remove
6214 articles. This is a list that may contain the following elements:
6218 Remove articles when they are read.
6221 Remove articles when exiting the group.
6224 The default value is @code{(read exit)}.
6226 @c @vindex gnus-use-header-prefetch
6227 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
6228 @c from the next group.
6231 @node Article Caching
6232 @section Article Caching
6233 @cindex article caching
6236 If you have an @emph{extremely} slow @sc{nntp} connection, you may
6237 consider turning article caching on. Each article will then be stored
6238 locally under your home directory. As you may surmise, this could
6239 potentially use @emph{huge} amounts of disk space, as well as eat up all
6240 your inodes so fast it will make your head swim. In vodka.
6242 Used carefully, though, it could be just an easier way to save articles.
6244 @vindex gnus-use-long-file-name
6245 @vindex gnus-cache-directory
6246 @vindex gnus-use-cache
6247 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
6248 all articles ticked or marked as dormant will then be copied
6249 over to your local cache (@code{gnus-cache-directory}). Whether this
6250 cache is flat or hierarchical is controlled by the
6251 @code{gnus-use-long-file-name} variable, as usual.
6253 When re-selecting a ticked or dormant article, it will be fetched from the
6254 cache instead of from the server. As articles in your cache will never
6255 expire, this might serve as a method of saving articles while still
6256 keeping them where they belong. Just mark all articles you want to save
6257 as dormant, and don't worry.
6259 When an article is marked as read, is it removed from the cache.
6261 @vindex gnus-cache-remove-articles
6262 @vindex gnus-cache-enter-articles
6263 The entering/removal of articles from the cache is controlled by the
6264 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
6265 variables. Both are lists of symbols. The first is @code{(ticked
6266 dormant)} by default, meaning that ticked and dormant articles will be
6267 put in the cache. The latter is @code{(read)} by default, meaning that
6268 articles marked as read are removed from the cache. Possibly
6269 symbols in these two lists are @code{ticked}, @code{dormant},
6270 @code{unread} and @code{read}.
6272 @findex gnus-jog-cache
6273 So where does the massive article-fetching and storing come into the
6274 picture? The @code{gnus-jog-cache} command will go through all
6275 subscribed newsgroups, request all unread articles, score them, and
6276 store them in the cache. You should only ever, ever ever ever, use this
6277 command if 1) your connection to the @sc{nntp} server is really, really,
6278 really slow and 2) you have a really, really, really huge disk.
6279 Seriously. One way to cut down on the number of articles downloaded is
6280 to score unwanted articles down and have them marked as read. They will
6281 not then be downloaded by this command.
6283 @vindex gnus-uncacheable-groups
6284 @vindex gnus-cacheable-groups
6285 It is likely that you do not want caching on all groups. For instance,
6286 if your @code{nnml} mail is located under your home directory, it makes no
6287 sense to cache it somewhere else under your home directory. Unless you
6288 feel that it's neat to use twice as much space.
6290 To limit the caching, you could set @code{gnus-cacheable-groups} to a
6291 regexp of groups to cache, @samp{^nntp} for instance, or set the
6292 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
6293 Both variables are @code{nil} by default. If a group matches both
6294 variables, the group is not cached.
6296 @findex gnus-cache-generate-nov-databases
6297 @findex gnus-cache-generate-active
6298 @vindex gnus-cache-active-file
6299 The cache stores information on what articles it contains in its active
6300 file (@code{gnus-cache-active-file}). If this file (or any other parts
6301 of the cache) becomes all messed up for some reason or other, Gnus
6302 offers two functions that will try to set things right. @kbd{M-x
6303 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
6304 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
6308 @node Persistent Articles
6309 @section Persistent Articles
6310 @cindex persistent articles
6312 Closely related to article caching, we have @dfn{persistent articles}.
6313 In fact, it's just a different way of looking at caching, and much more
6314 useful in my opinion.
6316 Say you're reading a newsgroup, and you happen on to some valuable gem
6317 that you want to keep and treasure forever. You'd normally just save it
6318 (using one of the many saving commands) in some file. The problem with
6319 that is that it's just, well, yucky. Ideally you'd prefer just having
6320 the article remain in the group where you found it forever; untouched by
6321 the expiry going on at the news server.
6323 This is what a @dfn{persistent article} is---an article that just won't
6324 be deleted. It's implemented using the normal cache functions, but
6325 you use two explicit commands for managing persistent articles:
6331 @findex gnus-cache-enter-article
6332 Make the current article persistent (@code{gnus-cache-enter-article}).
6335 @kindex M-* (Summary)
6336 @findex gnus-cache-remove-article
6337 Remove the current article from the persistent articles
6338 (@code{gnus-cache-remove-article}). This will normally delete the
6342 Both these commands understand the process/prefix convention.
6344 To avoid having all ticked articles (and stuff) entered into the cache,
6345 you should set @code{gnus-use-cache} to @code{passive} if you're just
6346 interested in persistent articles:
6349 (setq gnus-use-cache 'passive)
6353 @node Article Backlog
6354 @section Article Backlog
6356 @cindex article backlog
6358 If you have a slow connection, but the idea of using caching seems
6359 unappealing to you (and it is, really), you can help the situation some
6360 by switching on the @dfn{backlog}. This is where Gnus will buffer
6361 already read articles so that it doesn't have to re-fetch articles
6362 you've already read. This only helps if you are in the habit of
6363 re-selecting articles you've recently read, of course. If you never do
6364 that, turning the backlog on will slow Gnus down a little bit, and
6365 increase memory usage some.
6367 @vindex gnus-keep-backlog
6368 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
6369 at most @var{n} old articles in a buffer for later re-fetching. If this
6370 variable is non-@code{nil} and is not a number, Gnus will store
6371 @emph{all} read articles, which means that your Emacs will grow without
6372 bound before exploding and taking your machine down with you. I put
6373 that in there just to keep y'all on your toes.
6375 This variable is @code{nil} by default.
6378 @node Saving Articles
6379 @section Saving Articles
6380 @cindex saving articles
6382 Gnus can save articles in a number of ways. Below is the documentation
6383 for saving articles in a fairly straight-forward fashion (i.e., little
6384 processing of the article is done before it is saved). For a different
6385 approach (uudecoding, unsharing) you should use @code{gnus-uu}
6386 (@pxref{Decoding Articles}).
6388 @vindex gnus-save-all-headers
6389 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
6390 unwanted headers before saving the article.
6392 @vindex gnus-saved-headers
6393 If the preceding variable is @code{nil}, all headers that match the
6394 @code{gnus-saved-headers} regexp will be kept, while the rest will be
6395 deleted before saving.
6401 @kindex O o (Summary)
6403 @findex gnus-summary-save-article
6404 @c @icon{gnus-summary-save-article}
6405 Save the current article using the default article saver
6406 (@code{gnus-summary-save-article}).
6409 @kindex O m (Summary)
6410 @findex gnus-summary-save-article-mail
6411 Save the current article in mail format
6412 (@code{gnus-summary-save-article-mail}).
6415 @kindex O r (Summary)
6416 @findex gnus-summary-save-article-rmail
6417 Save the current article in rmail format
6418 (@code{gnus-summary-save-article-rmail}).
6421 @kindex O f (Summary)
6422 @findex gnus-summary-save-article-file
6423 @c @icon{gnus-summary-save-article-file}
6424 Save the current article in plain file format
6425 (@code{gnus-summary-save-article-file}).
6428 @kindex O F (Summary)
6429 @findex gnus-summary-write-article-file
6430 Write the current article in plain file format, overwriting any previous
6431 file contents (@code{gnus-summary-write-article-file}).
6434 @kindex O b (Summary)
6435 @findex gnus-summary-save-article-body-file
6436 Save the current article body in plain file format
6437 (@code{gnus-summary-save-article-body-file}).
6440 @kindex O h (Summary)
6441 @findex gnus-summary-save-article-folder
6442 Save the current article in mh folder format
6443 (@code{gnus-summary-save-article-folder}).
6446 @kindex O v (Summary)
6447 @findex gnus-summary-save-article-vm
6448 Save the current article in a VM folder
6449 (@code{gnus-summary-save-article-vm}).
6452 @kindex O p (Summary)
6453 @findex gnus-summary-pipe-output
6454 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
6455 the current article to a process (@code{gnus-summary-pipe-output}).
6458 @vindex gnus-prompt-before-saving
6459 All these commands use the process/prefix convention
6460 (@pxref{Process/Prefix}). If you save bunches of articles using these
6461 functions, you might get tired of being prompted for files to save each
6462 and every article in. The prompting action is controlled by
6463 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
6464 default, giving you that excessive prompting action you know and
6465 loathe. If you set this variable to @code{t} instead, you'll be prompted
6466 just once for each series of articles you save. If you like to really
6467 have Gnus do all your thinking for you, you can even set this variable
6468 to @code{nil}, which means that you will never be prompted for files to
6469 save articles in. Gnus will simply save all the articles in the default
6473 @vindex gnus-default-article-saver
6474 You can customize the @code{gnus-default-article-saver} variable to make
6475 Gnus do what you want it to. You can use any of the six ready-made
6476 functions below, or you can create your own.
6480 @item gnus-summary-save-in-rmail
6481 @findex gnus-summary-save-in-rmail
6482 @vindex gnus-rmail-save-name
6483 @findex gnus-plain-save-name
6484 This is the default format, @dfn{babyl}. Uses the function in the
6485 @code{gnus-rmail-save-name} variable to get a file name to save the
6486 article in. The default is @code{gnus-plain-save-name}.
6488 @item gnus-summary-save-in-mail
6489 @findex gnus-summary-save-in-mail
6490 @vindex gnus-mail-save-name
6491 Save in a Unix mail (mbox) file. Uses the function in the
6492 @code{gnus-mail-save-name} variable to get a file name to save the
6493 article in. The default is @code{gnus-plain-save-name}.
6495 @item gnus-summary-save-in-file
6496 @findex gnus-summary-save-in-file
6497 @vindex gnus-file-save-name
6498 @findex gnus-numeric-save-name
6499 Append the article straight to an ordinary file. Uses the function in
6500 the @code{gnus-file-save-name} variable to get a file name to save the
6501 article in. The default is @code{gnus-numeric-save-name}.
6503 @item gnus-summary-save-body-in-file
6504 @findex gnus-summary-save-body-in-file
6505 Append the article body to an ordinary file. Uses the function in the
6506 @code{gnus-file-save-name} variable to get a file name to save the
6507 article in. The default is @code{gnus-numeric-save-name}.
6509 @item gnus-summary-save-in-folder
6510 @findex gnus-summary-save-in-folder
6511 @findex gnus-folder-save-name
6512 @findex gnus-Folder-save-name
6513 @vindex gnus-folder-save-name
6516 Save the article to an MH folder using @code{rcvstore} from the MH
6517 library. Uses the function in the @code{gnus-folder-save-name} variable
6518 to get a file name to save the article in. The default is
6519 @code{gnus-folder-save-name}, but you can also use
6520 @code{gnus-Folder-save-name}, which creates capitalized names.
6522 @item gnus-summary-save-in-vm
6523 @findex gnus-summary-save-in-vm
6524 Save the article in a VM folder. You have to have the VM mail
6525 reader to use this setting.
6528 @vindex gnus-article-save-directory
6529 All of these functions, except for the last one, will save the article
6530 in the @code{gnus-article-save-directory}, which is initialized from the
6531 @code{SAVEDIR} environment variable. This is @file{~/News/} by
6534 As you can see above, the functions use different functions to find a
6535 suitable name of a file to save the article in. Below is a list of
6536 available functions that generate names:
6540 @item gnus-Numeric-save-name
6541 @findex gnus-Numeric-save-name
6542 File names like @file{~/News/Alt.andrea-dworkin/45}.
6544 @item gnus-numeric-save-name
6545 @findex gnus-numeric-save-name
6546 File names like @file{~/News/alt.andrea-dworkin/45}.
6548 @item gnus-Plain-save-name
6549 @findex gnus-Plain-save-name
6550 File names like @file{~/News/Alt.andrea-dworkin}.
6552 @item gnus-plain-save-name
6553 @findex gnus-plain-save-name
6554 File names like @file{~/News/alt.andrea-dworkin}.
6556 @item gnus-sender-save-name
6557 @findex gnus-sender-save-name
6558 File names like @file{~/News/larsi}.
6561 @vindex gnus-split-methods
6562 You can have Gnus suggest where to save articles by plonking a regexp into
6563 the @code{gnus-split-methods} alist. For instance, if you would like to
6564 save articles related to Gnus in the file @file{gnus-stuff}, and articles
6565 related to VM in @code{vm-stuff}, you could set this variable to something
6569 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
6570 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
6571 (my-choosing-function "../other-dir/my-stuff")
6572 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
6575 We see that this is a list where each element is a list that has two
6576 elements---the @dfn{match} and the @dfn{file}. The match can either be
6577 a string (in which case it is used as a regexp to match on the article
6578 head); it can be a symbol (which will be called as a function with the
6579 group name as a parameter); or it can be a list (which will be
6580 @code{eval}ed). If any of these actions have a non-@code{nil} result,
6581 the @dfn{file} will be used as a default prompt. In addition, the
6582 result of the operation itself will be used if the function or form
6583 called returns a string or a list of strings.
6585 You basically end up with a list of file names that might be used when
6586 saving the current article. (All ``matches'' will be used.) You will
6587 then be prompted for what you really want to use as a name, with file
6588 name completion over the results from applying this variable.
6590 This variable is @code{((gnus-article-archive-name))} by default, which
6591 means that Gnus will look at the articles it saves for an
6592 @code{Archive-name} line and use that as a suggestion for the file
6595 Here's an example function to clean up file names somewhat. If you have
6596 lots of mail groups called things like
6597 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
6598 these group names before creating the file name to save to. The
6599 following will do just that:
6602 (defun my-save-name (group)
6603 (when (string-match "^nnml:mail." group)
6604 (substring group (match-end 0))))
6606 (setq gnus-split-methods
6607 '((gnus-article-archive-name)
6612 @vindex gnus-use-long-file-name
6613 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
6614 @code{nil}, all the preceding functions will replace all periods
6615 (@samp{.}) in the group names with slashes (@samp{/})---which means that
6616 the functions will generate hierarchies of directories instead of having
6617 all the files in the top level directory
6618 (@file{~/News/alt/andrea-dworkin} instead of
6619 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
6620 on most systems. However, for historical reasons, this is @code{nil} on
6621 Xenix and usg-unix-v machines by default.
6623 This function also affects kill and score file names. If this variable
6624 is a list, and the list contains the element @code{not-score}, long file
6625 names will not be used for score files, if it contains the element
6626 @code{not-save}, long file names will not be used for saving, and if it
6627 contains the element @code{not-kill}, long file names will not be used
6630 If you'd like to save articles in a hierarchy that looks something like
6634 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
6635 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
6638 Then just save with @kbd{o}. You'd then read this hierarchy with
6639 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
6640 the top level directory as the argument (@file{~/News/}). Then just walk
6641 around to the groups/directories with @code{nneething}.
6644 @node Decoding Articles
6645 @section Decoding Articles
6646 @cindex decoding articles
6648 Sometime users post articles (or series of articles) that have been
6649 encoded in some way or other. Gnus can decode them for you.
6652 * Uuencoded Articles:: Uudecode articles.
6653 * Shell Archives:: Unshar articles.
6654 * PostScript Files:: Split PostScript.
6655 * Other Files:: Plain save and binhex.
6656 * Decoding Variables:: Variables for a happy decoding.
6657 * Viewing Files:: You want to look at the result of the decoding?
6661 @cindex article series
6662 All these functions use the process/prefix convention
6663 (@pxref{Process/Prefix}) for finding out what articles to work on, with
6664 the extension that a ``single article'' means ``a single series''. Gnus
6665 can find out by itself what articles belong to a series, decode all the
6666 articles and unpack/view/save the resulting file(s).
6668 Gnus guesses what articles are in the series according to the following
6669 simplish rule: The subjects must be (nearly) identical, except for the
6670 last two numbers of the line. (Spaces are largely ignored, however.)
6672 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
6673 will find all the articles that match the regexp @samp{^cat.gif
6674 ([0-9]+/[0-9]+).*$}.
6676 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
6677 series}, will not be properly recognized by any of the automatic viewing
6678 commands, and you have to mark the articles manually with @kbd{#}.
6681 @node Uuencoded Articles
6682 @subsection Uuencoded Articles
6684 @cindex uuencoded articles
6689 @kindex X u (Summary)
6690 @findex gnus-uu-decode-uu
6691 @c @icon{gnus-uu-decode-uu}
6692 Uudecodes the current series (@code{gnus-uu-decode-uu}).
6695 @kindex X U (Summary)
6696 @findex gnus-uu-decode-uu-and-save
6697 Uudecodes and saves the current series
6698 (@code{gnus-uu-decode-uu-and-save}).
6701 @kindex X v u (Summary)
6702 @findex gnus-uu-decode-uu-view
6703 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
6706 @kindex X v U (Summary)
6707 @findex gnus-uu-decode-uu-and-save-view
6708 Uudecodes, views and saves the current series
6709 (@code{gnus-uu-decode-uu-and-save-view}).
6713 Remember that these all react to the presence of articles marked with
6714 the process mark. If, for instance, you'd like to decode and save an
6715 entire newsgroup, you'd typically do @kbd{M P a}
6716 (@code{gnus-uu-mark-all}) and then @kbd{X U}
6717 (@code{gnus-uu-decode-uu-and-save}).
6719 All this is very much different from how @code{gnus-uu} worked with
6720 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
6721 the sun. This version of @code{gnus-uu} generally assumes that you mark
6722 articles in some way (@pxref{Setting Process Marks}) and then press
6725 @vindex gnus-uu-notify-files
6726 Note: When trying to decode articles that have names matching
6727 @code{gnus-uu-notify-files}, which is hard-coded to
6728 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
6729 automatically post an article on @samp{comp.unix.wizards} saying that
6730 you have just viewed the file in question. This feature can't be turned
6734 @node Shell Archives
6735 @subsection Shell Archives
6737 @cindex shell archives
6738 @cindex shared articles
6740 Shell archives (``shar files'') used to be a popular way to distribute
6741 sources, but it isn't used all that much today. In any case, we have
6742 some commands to deal with these:
6747 @kindex X s (Summary)
6748 @findex gnus-uu-decode-unshar
6749 Unshars the current series (@code{gnus-uu-decode-unshar}).
6752 @kindex X S (Summary)
6753 @findex gnus-uu-decode-unshar-and-save
6754 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
6757 @kindex X v s (Summary)
6758 @findex gnus-uu-decode-unshar-view
6759 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
6762 @kindex X v S (Summary)
6763 @findex gnus-uu-decode-unshar-and-save-view
6764 Unshars, views and saves the current series
6765 (@code{gnus-uu-decode-unshar-and-save-view}).
6769 @node PostScript Files
6770 @subsection PostScript Files
6776 @kindex X p (Summary)
6777 @findex gnus-uu-decode-postscript
6778 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
6781 @kindex X P (Summary)
6782 @findex gnus-uu-decode-postscript-and-save
6783 Unpack and save the current PostScript series
6784 (@code{gnus-uu-decode-postscript-and-save}).
6787 @kindex X v p (Summary)
6788 @findex gnus-uu-decode-postscript-view
6789 View the current PostScript series
6790 (@code{gnus-uu-decode-postscript-view}).
6793 @kindex X v P (Summary)
6794 @findex gnus-uu-decode-postscript-and-save-view
6795 View and save the current PostScript series
6796 (@code{gnus-uu-decode-postscript-and-save-view}).
6801 @subsection Other Files
6805 @kindex X o (Summary)
6806 @findex gnus-uu-decode-save
6807 Save the current series
6808 (@code{gnus-uu-decode-save}).
6811 @kindex X b (Summary)
6812 @findex gnus-uu-decode-binhex
6813 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
6814 doesn't really work yet.
6818 @node Decoding Variables
6819 @subsection Decoding Variables
6821 Adjective, not verb.
6824 * Rule Variables:: Variables that say how a file is to be viewed.
6825 * Other Decode Variables:: Other decode variables.
6826 * Uuencoding and Posting:: Variables for customizing uuencoding.
6830 @node Rule Variables
6831 @subsubsection Rule Variables
6832 @cindex rule variables
6834 Gnus uses @dfn{rule variables} to decide how to view a file. All these
6835 variables are of the form
6838 (list '(regexp1 command2)
6845 @item gnus-uu-user-view-rules
6846 @vindex gnus-uu-user-view-rules
6848 This variable is consulted first when viewing files. If you wish to use,
6849 for instance, @code{sox} to convert an @samp{.au} sound file, you could
6852 (setq gnus-uu-user-view-rules
6853 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
6856 @item gnus-uu-user-view-rules-end
6857 @vindex gnus-uu-user-view-rules-end
6858 This variable is consulted if Gnus couldn't make any matches from the
6859 user and default view rules.
6861 @item gnus-uu-user-archive-rules
6862 @vindex gnus-uu-user-archive-rules
6863 This variable can be used to say what commands should be used to unpack
6868 @node Other Decode Variables
6869 @subsubsection Other Decode Variables
6872 @vindex gnus-uu-grabbed-file-functions
6874 @item gnus-uu-grabbed-file-functions
6875 All functions in this list will be called right after each file has been
6876 successfully decoded---so that you can move or view files right away,
6877 and don't have to wait for all files to be decoded before you can do
6878 anything. Ready-made functions you can put in this list are:
6882 @item gnus-uu-grab-view
6883 @findex gnus-uu-grab-view
6886 @item gnus-uu-grab-move
6887 @findex gnus-uu-grab-move
6888 Move the file (if you're using a saving function.)
6891 @item gnus-uu-be-dangerous
6892 @vindex gnus-uu-be-dangerous
6893 Specifies what to do if unusual situations arise during decoding. If
6894 @code{nil}, be as conservative as possible. If @code{t}, ignore things
6895 that didn't work, and overwrite existing files. Otherwise, ask each
6898 @item gnus-uu-ignore-files-by-name
6899 @vindex gnus-uu-ignore-files-by-name
6900 Files with name matching this regular expression won't be viewed.
6902 @item gnus-uu-ignore-files-by-type
6903 @vindex gnus-uu-ignore-files-by-type
6904 Files with a @sc{mime} type matching this variable won't be viewed.
6905 Note that Gnus tries to guess what type the file is based on the name.
6906 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
6909 @item gnus-uu-tmp-dir
6910 @vindex gnus-uu-tmp-dir
6911 Where @code{gnus-uu} does its work.
6913 @item gnus-uu-do-not-unpack-archives
6914 @vindex gnus-uu-do-not-unpack-archives
6915 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
6916 looking for files to display.
6918 @item gnus-uu-view-and-save
6919 @vindex gnus-uu-view-and-save
6920 Non-@code{nil} means that the user will always be asked to save a file
6923 @item gnus-uu-ignore-default-view-rules
6924 @vindex gnus-uu-ignore-default-view-rules
6925 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
6928 @item gnus-uu-ignore-default-archive-rules
6929 @vindex gnus-uu-ignore-default-archive-rules
6930 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
6933 @item gnus-uu-kill-carriage-return
6934 @vindex gnus-uu-kill-carriage-return
6935 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
6938 @item gnus-uu-unmark-articles-not-decoded
6939 @vindex gnus-uu-unmark-articles-not-decoded
6940 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
6941 decoded articles as unread.
6943 @item gnus-uu-correct-stripped-uucode
6944 @vindex gnus-uu-correct-stripped-uucode
6945 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
6946 uuencoded files that have had trailing spaces deleted.
6948 @item gnus-uu-pre-uudecode-hook
6949 @vindex gnus-uu-pre-uudecode-hook
6950 Hook run before sending a message to @code{uudecode}.
6952 @item gnus-uu-view-with-metamail
6953 @vindex gnus-uu-view-with-metamail
6955 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
6956 commands defined by the rule variables and just fudge a @sc{mime}
6957 content type based on the file name. The result will be fed to
6958 @code{metamail} for viewing.
6960 @item gnus-uu-save-in-digest
6961 @vindex gnus-uu-save-in-digest
6962 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
6963 decoding, will save in digests. If this variable is @code{nil},
6964 @code{gnus-uu} will just save everything in a file without any
6965 embellishments. The digesting almost conforms to RFC 1153---no easy way
6966 to specify any meaningful volume and issue numbers were found, so I
6967 simply dropped them.
6972 @node Uuencoding and Posting
6973 @subsubsection Uuencoding and Posting
6977 @item gnus-uu-post-include-before-composing
6978 @vindex gnus-uu-post-include-before-composing
6979 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6980 before you compose the article. If this variable is @code{t}, you can
6981 either include an encoded file with @kbd{C-c C-i} or have one included
6982 for you when you post the article.
6984 @item gnus-uu-post-length
6985 @vindex gnus-uu-post-length
6986 Maximum length of an article. The encoded file will be split into how
6987 many articles it takes to post the entire file.
6989 @item gnus-uu-post-threaded
6990 @vindex gnus-uu-post-threaded
6991 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6992 thread. This may not be smart, as no other decoder I have seen is able
6993 to follow threads when collecting uuencoded articles. (Well, I have
6994 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6995 think that counts...) Default is @code{nil}.
6997 @item gnus-uu-post-separate-description
6998 @vindex gnus-uu-post-separate-description
6999 Non-@code{nil} means that the description will be posted in a separate
7000 article. The first article will typically be numbered (0/x). If this
7001 variable is @code{nil}, the description the user enters will be included
7002 at the beginning of the first article, which will be numbered (1/x).
7003 Default is @code{t}.
7009 @subsection Viewing Files
7010 @cindex viewing files
7011 @cindex pseudo-articles
7013 After decoding, if the file is some sort of archive, Gnus will attempt
7014 to unpack the archive and see if any of the files in the archive can be
7015 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
7016 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
7017 uncompress and de-tar the main file, and then view the two pictures.
7018 This unpacking process is recursive, so if the archive contains archives
7019 of archives, it'll all be unpacked.
7021 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
7022 extracted file into the summary buffer. If you go to these
7023 ``articles'', you will be prompted for a command to run (usually Gnus
7024 will make a suggestion), and then the command will be run.
7026 @vindex gnus-view-pseudo-asynchronously
7027 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
7028 until the viewing is done before proceeding.
7030 @vindex gnus-view-pseudos
7031 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
7032 the pseudo-articles into the summary buffer, but view them
7033 immediately. If this variable is @code{not-confirm}, the user won't even
7034 be asked for a confirmation before viewing is done.
7036 @vindex gnus-view-pseudos-separately
7037 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
7038 pseudo-article will be created for each file to be viewed. If
7039 @code{nil}, all files that use the same viewing command will be given as
7040 a list of parameters to that command.
7042 @vindex gnus-insert-pseudo-articles
7043 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
7044 pseudo-articles when decoding. It is @code{t} by default.
7046 So; there you are, reading your @emph{pseudo-articles} in your
7047 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
7048 Why isn't anything real anymore? How did we get here?
7051 @node Article Treatment
7052 @section Article Treatment
7054 Reading through this huge manual, you may have quite forgotten that the
7055 object of newsreaders is to actually, like, read what people have
7056 written. Reading articles. Unfortunately, people are quite bad at
7057 writing, so there are tons of functions and variables to make reading
7058 these articles easier.
7061 * Article Highlighting:: You want to make the article look like fruit salad.
7062 * Article Fontisizing:: Making emphasized text look nice.
7063 * Article Hiding:: You also want to make certain info go away.
7064 * Article Washing:: Lots of way-neat functions to make life better.
7065 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
7066 * Article Date:: Grumble, UT!
7067 * Article Signature:: What is a signature?
7068 * Article Miscellania:: Various other stuff.
7072 @node Article Highlighting
7073 @subsection Article Highlighting
7074 @cindex highlighting
7076 Not only do you want your article buffer to look like fruit salad, but
7077 you want it to look like technicolor fruit salad.
7082 @kindex W H a (Summary)
7083 @findex gnus-article-highlight
7084 @findex gnus-article-maybe-highlight
7085 Do much highlighting of the current article
7086 (@code{gnus-article-highlight}). This function highlights header, cited
7087 text, the signature, and adds buttons to the body and the head.
7090 @kindex W H h (Summary)
7091 @findex gnus-article-highlight-headers
7092 @vindex gnus-header-face-alist
7093 Highlight the headers (@code{gnus-article-highlight-headers}). The
7094 highlighting will be done according to the @code{gnus-header-face-alist}
7095 variable, which is a list where each element has the form
7096 @code{(@var{regexp} @var{name} @var{content})}.
7097 @var{regexp} is a regular expression for matching the
7098 header, @var{name} is the face used for highlighting the header name
7099 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
7100 the header value. The first match made will be used. Note that
7101 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
7104 @kindex W H c (Summary)
7105 @findex gnus-article-highlight-citation
7106 Highlight cited text (@code{gnus-article-highlight-citation}).
7108 Some variables to customize the citation highlights:
7111 @vindex gnus-cite-parse-max-size
7113 @item gnus-cite-parse-max-size
7114 If the article size if bigger than this variable (which is 25000 by
7115 default), no citation highlighting will be performed.
7117 @item gnus-cite-max-prefix
7118 @vindex gnus-cite-max-prefix
7119 Maximum possible length for a citation prefix (default 20).
7121 @item gnus-cite-face-list
7122 @vindex gnus-cite-face-list
7123 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
7124 When there are citations from multiple articles in the same message,
7125 Gnus will try to give each citation from each article its own face.
7126 This should make it easier to see who wrote what.
7128 @item gnus-supercite-regexp
7129 @vindex gnus-supercite-regexp
7130 Regexp matching normal Supercite attribution lines.
7132 @item gnus-supercite-secondary-regexp
7133 @vindex gnus-supercite-secondary-regexp
7134 Regexp matching mangled Supercite attribution lines.
7136 @item gnus-cite-minimum-match-count
7137 @vindex gnus-cite-minimum-match-count
7138 Minimum number of identical prefixes we have to see before we believe
7139 that it's a citation.
7141 @item gnus-cite-attribution-prefix
7142 @vindex gnus-cite-attribution-prefix
7143 Regexp matching the beginning of an attribution line.
7145 @item gnus-cite-attribution-suffix
7146 @vindex gnus-cite-attribution-suffix
7147 Regexp matching the end of an attribution line.
7149 @item gnus-cite-attribution-face
7150 @vindex gnus-cite-attribution-face
7151 Face used for attribution lines. It is merged with the face for the
7152 cited text belonging to the attribution.
7158 @kindex W H s (Summary)
7159 @vindex gnus-signature-separator
7160 @vindex gnus-signature-face
7161 @findex gnus-article-highlight-signature
7162 Highlight the signature (@code{gnus-article-highlight-signature}).
7163 Everything after @code{gnus-signature-separator} (@pxref{Article
7164 Signature}) in an article will be considered a signature and will be
7165 highlighted with @code{gnus-signature-face}, which is @code{italic} by
7170 @xref{Customizing Articles}, for how to highlight articles automatically.
7173 @node Article Fontisizing
7174 @subsection Article Fontisizing
7176 @cindex article emphasis
7178 @findex gnus-article-emphasize
7179 @kindex W e (Summary)
7180 People commonly add emphasis to words in news articles by writing things
7181 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
7182 this look nicer by running the article through the @kbd{W e}
7183 (@code{gnus-article-emphasize}) command.
7185 @vindex gnus-emphasis-alist
7186 How the emphasis is computed is controlled by the
7187 @code{gnus-emphasis-alist} variable. This is an alist where the first
7188 element is a regular expression to be matched. The second is a number
7189 that says what regular expression grouping is used to find the entire
7190 emphasized word. The third is a number that says what regexp grouping
7191 should be displayed and highlighted. (The text between these two
7192 groupings will be hidden.) The fourth is the face used for
7196 (setq gnus-emphasis-alist
7197 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
7198 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
7207 @vindex gnus-emphasis-underline
7208 @vindex gnus-emphasis-bold
7209 @vindex gnus-emphasis-italic
7210 @vindex gnus-emphasis-underline-bold
7211 @vindex gnus-emphasis-underline-italic
7212 @vindex gnus-emphasis-bold-italic
7213 @vindex gnus-emphasis-underline-bold-italic
7214 By default, there are seven rules, and they use the following faces:
7215 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
7216 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
7217 @code{gnus-emphasis-underline-italic},
7218 @code{gnus-emphasis-underline-bold}, and
7219 @code{gnus-emphasis-underline-bold-italic}.
7221 If you want to change these faces, you can either use @kbd{M-x
7222 customize}, or you can use @code{copy-face}. For instance, if you want
7223 to make @code{gnus-emphasis-italic} use a red face instead, you could
7227 (copy-face 'red 'gnus-emphasis-italic)
7230 @vindex gnus-group-highlight-words-alist
7232 If you want to highlight arbitrary words, you can use the
7233 @code{gnus-group-highlight-words-alist} variable, which uses the same
7234 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
7235 parameter (@pxref{Group Parameters}) can also be used.
7237 @xref{Customizing Articles}, for how to fontize articles automatically.
7240 @node Article Hiding
7241 @subsection Article Hiding
7242 @cindex article hiding
7244 Or rather, hiding certain things in each article. There usually is much
7245 too much cruft in most articles.
7250 @kindex W W a (Summary)
7251 @findex gnus-article-hide
7252 Do quite a lot of hiding on the article buffer
7253 (@kbd{gnus-article-hide}). In particular, this function will hide
7254 headers, PGP, cited text and the signature.
7257 @kindex W W h (Summary)
7258 @findex gnus-article-hide-headers
7259 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
7263 @kindex W W b (Summary)
7264 @findex gnus-article-hide-boring-headers
7265 Hide headers that aren't particularly interesting
7266 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
7269 @kindex W W s (Summary)
7270 @findex gnus-article-hide-signature
7271 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
7275 @kindex W W l (Summary)
7276 @findex gnus-article-hide-list-identifiers
7277 @vindex gnus-list-identifiers
7278 Strip list identifiers specified in @code{gnus-list-identifiers}. These
7279 are strings some mailing list servers add to the beginning of all
7280 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
7281 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
7282 may not contain @code{\\(..\\)}.
7286 @item gnus-list-identifiers
7287 @vindex gnus-list-identifiers
7288 A regular expression that matches list identifiers to be removed from
7289 subject. This can also be a list of regular expressions.
7294 @kindex W W p (Summary)
7295 @findex gnus-article-hide-pgp
7296 @vindex gnus-article-hide-pgp-hook
7297 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). The
7298 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
7299 signature has been hidden. For example, to automatically verify
7300 articles that have signatures in them do:
7302 ;;; Hide pgp cruft if any.
7304 (setq gnus-treat-strip-pgp t)
7306 ;;; After hiding pgp, verify the message;
7307 ;;; only happens if pgp signature is found.
7309 (add-hook 'gnus-article-hide-pgp-hook
7312 (set-buffer gnus-original-article-buffer)
7317 @kindex W W P (Summary)
7318 @findex gnus-article-hide-pem
7319 Hide @sc{pem} (privacy enhanced messages) cruft
7320 (@code{gnus-article-hide-pem}).
7323 @kindex W W B (Summary)
7324 @findex gnus-article-strip-banner
7327 @cindex stripping advertisements
7328 @cindex advertisements
7329 Strip the banner specified by the @code{banner} group parameter
7330 (@code{gnus-article-strip-banner}). This is mainly used to hide those
7331 annoying banners and/or signatures that some mailing lists and moderated
7332 groups adds to all the messages. The way to use this function is to add
7333 the @code{banner} group parameter (@pxref{Group Parameters}) to the
7334 group you want banners stripped from. The parameter either be a string,
7335 which will be interpreted as a regular expression matching text to be
7336 removed, or the symbol @code{signature}, meaning that the (last)
7337 signature should be removed, or other symbol, meaning that the
7338 corresponding regular expression in @code{gnus-article-banner-alist} is
7342 @kindex W W c (Summary)
7343 @findex gnus-article-hide-citation
7344 Hide citation (@code{gnus-article-hide-citation}). Some variables for
7345 customizing the hiding:
7349 @item gnus-cited-opened-text-button-line-format
7350 @itemx gnus-cited-closed-text-button-line-format
7351 @vindex gnus-cited-closed-text-button-line-format
7352 @vindex gnus-cited-opened-text-button-line-format
7353 Gnus adds buttons to show where the cited text has been hidden, and to
7354 allow toggle hiding the text. The format of the variable is specified
7355 by these format-like variable (@pxref{Formatting Variables}). These
7360 Starting point of the hidden text.
7362 Ending point of the hidden text.
7364 Number of characters in the hidden region.
7366 Number of lines of hidden text.
7369 @item gnus-cited-lines-visible
7370 @vindex gnus-cited-lines-visible
7371 The number of lines at the beginning of the cited text to leave
7372 shown. This can also be a cons cell with the number of lines at the top
7373 and bottom of the text, respectively, to remain visible.
7378 @kindex W W C-c (Summary)
7379 @findex gnus-article-hide-citation-maybe
7381 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
7382 following two variables:
7385 @item gnus-cite-hide-percentage
7386 @vindex gnus-cite-hide-percentage
7387 If the cited text is of a bigger percentage than this variable (default
7388 50), hide the cited text.
7390 @item gnus-cite-hide-absolute
7391 @vindex gnus-cite-hide-absolute
7392 The cited text must have at least this length (default 10) before it
7397 @kindex W W C (Summary)
7398 @findex gnus-article-hide-citation-in-followups
7399 Hide cited text in articles that aren't roots
7400 (@code{gnus-article-hide-citation-in-followups}). This isn't very
7401 useful as an interactive command, but might be a handy function to stick
7402 have happen automatically (@pxref{Customizing Articles}).
7406 All these ``hiding'' commands are toggles, but if you give a negative
7407 prefix to these commands, they will show what they have previously
7408 hidden. If you give a positive prefix, they will always hide.
7410 Also @pxref{Article Highlighting} for further variables for
7411 citation customization.
7413 @xref{Customizing Articles}, for how to hide article elements
7417 @node Article Washing
7418 @subsection Article Washing
7420 @cindex article washing
7422 We call this ``article washing'' for a really good reason. Namely, the
7423 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
7425 @dfn{Washing} is defined by us as ``changing something from something to
7426 something else'', but normally results in something looking better.
7429 @xref{Customizing Articles}, if you want to change how Gnus displays
7430 articles by default.
7435 This is not really washing, it's sort of the opposite of washing. If
7436 you type this, you see the article exactly as it exists on disk or on
7440 @kindex W l (Summary)
7441 @findex gnus-summary-stop-page-breaking
7442 Remove page breaks from the current article
7443 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
7447 @kindex W r (Summary)
7448 @findex gnus-summary-caesar-message
7449 @c @icon{gnus-summary-caesar-message}
7450 Do a Caesar rotate (rot13) on the article buffer
7451 (@code{gnus-summary-caesar-message}).
7452 Unreadable articles that tell you to read them with Caesar rotate or rot13.
7453 (Typically offensive jokes and such.)
7455 It's commonly called ``rot13'' because each letter is rotated 13
7456 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
7457 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
7458 is rumored to have employed this form of, uh, somewhat weak encryption.
7462 @kindex W t (Summary)
7464 @findex gnus-summary-toggle-header
7465 Toggle whether to display all headers in the article buffer
7466 (@code{gnus-summary-toggle-header}).
7469 @kindex W v (Summary)
7470 @findex gnus-summary-verbose-header
7471 Toggle whether to display all headers in the article buffer permanently
7472 (@code{gnus-summary-verbose-header}).
7475 @kindex W o (Summary)
7476 @findex gnus-article-treat-overstrike
7477 Treat overstrike (@code{gnus-article-treat-overstrike}).
7480 @kindex W d (Summary)
7481 @findex gnus-article-treat-dumbquotes
7482 @vindex gnus-article-dumbquotes-map
7484 @cindex M****s*** sm*rtq**t*s
7486 Treat M****s*** sm*rtq**t*s according to
7487 @code{gnus-article-dumbquotes-map}
7488 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
7489 whether a character is a sm*rtq**t* or not, so it should only be used
7492 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
7493 an attempt to provide more quoting characters. If you see something
7494 like @code{\222} or @code{\264} where you're expecting some kind of
7495 apostrophe or quotation mark, then try this wash.
7498 @kindex W w (Summary)
7499 @findex gnus-article-fill-cited-article
7500 Do word wrap (@code{gnus-article-fill-cited-article}).
7502 You can give the command a numerical prefix to specify the width to use
7506 @kindex W Q (Summary)
7507 @findex gnus-article-fill-long-lines
7508 Fill long lines (@code{gnus-article-fill-long-lines}).
7511 @kindex W C (Summary)
7512 @findex gnus-article-capitalize-sentences
7513 Capitalize the first word in each sentence
7514 (@code{gnus-article-capitalize-sentences}).
7517 @kindex W c (Summary)
7518 @findex gnus-article-remove-cr
7519 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
7520 (this takes care of DOS line endings), and then translate any remaining
7521 CRs into LF (this takes care of Mac line endings)
7522 (@code{gnus-article-remove-cr}).
7525 @kindex W q (Summary)
7526 @findex gnus-article-de-quoted-unreadable
7527 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
7528 Quoted-Printable is one common @sc{mime} encoding employed when sending
7529 non-ASCII (i. e., 8-bit) articles. It typically makes strings like
7530 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
7531 readable to me. Note that the this is usually done automatically by
7532 Gnus if the message in question has a @code{Content-Transfer-Encoding}
7533 header that says that this encoding has been done.
7536 @kindex W 6 (Summary)
7537 @findex gnus-article-de-base64-unreadable
7538 Treat base64 (@code{gnus-article-de-base64-unreadable}).
7539 Base64 is one common @sc{mime} encoding employed when sending non-ASCII
7540 (i. e., 8-bit) articles. Note that the this is usually done
7541 automatically by Gnus if the message in question has a
7542 @code{Content-Transfer-Encoding} header that says that this encoding has
7546 @kindex W Z (Summary)
7547 @findex gnus-article-decode-HZ
7548 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
7549 common encoding employed when sending Chinese articles. It typically
7550 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
7553 @kindex W h (Summary)
7554 @findex gnus-article-wash-html
7555 Treat HTML (@code{gnus-article-wash-html}).
7556 Note that the this is usually done automatically by Gnus if the message
7557 in question has a @code{Content-Type} header that says that this type
7561 @kindex W f (Summary)
7563 @findex gnus-article-display-x-face
7564 @findex gnus-article-x-face-command
7565 @vindex gnus-article-x-face-command
7566 @vindex gnus-article-x-face-too-ugly
7573 Look for and display any X-Face headers
7574 (@code{gnus-article-display-x-face}). The command executed by this
7575 function is given by the @code{gnus-article-x-face-command} variable.
7576 If this variable is a string, this string will be executed in a
7577 sub-shell. If it is a function, this function will be called with the
7578 face as the argument. If the @code{gnus-article-x-face-too-ugly} (which
7579 is a regexp) matches the @code{From} header, the face will not be shown.
7580 The default action under Emacs is to fork off the @code{display}
7581 program@footnote{@code{display} is from the ImageMagick package. For the
7582 @code{uncompface} and @code{icontopbm} programs look for a package
7583 like `compface' or `faces-xface' on a GNU/Linux system.}
7584 to view the face. Under XEmacs or Emacs 21+ with suitable image
7585 support, the default action is to display the face before the
7586 @code{From} header. (It's nicer if XEmacs has been compiled with X-Face
7587 support---that will make display somewhat faster. If there's no native
7588 X-Face support, Gnus will try to convert the @code{X-Face} header using
7589 external programs from the @code{pbmplus} package and
7590 friends.@footnote{On a GNU/Linux system look for packages with names
7591 like @code{netpbm} or @code{libgr-progs}.}) If you
7592 want to have this function in the display hook, it should probably come
7596 @kindex W b (Summary)
7597 @findex gnus-article-add-buttons
7598 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
7599 @xref{Article Buttons}.
7602 @kindex W B (Summary)
7603 @findex gnus-article-add-buttons-to-head
7604 Add clickable buttons to the article headers
7605 (@code{gnus-article-add-buttons-to-head}).
7608 @kindex W W H (Summary)
7609 @findex gnus-article-strip-headers-from-body
7610 Strip headers like the @code{X-No-Archive} header from the beginning of
7611 article bodies (@code{gnus-article-strip-headers-from-body}).
7614 @kindex W E l (Summary)
7615 @findex gnus-article-strip-leading-blank-lines
7616 Remove all blank lines from the beginning of the article
7617 (@code{gnus-article-strip-leading-blank-lines}).
7620 @kindex W E m (Summary)
7621 @findex gnus-article-strip-multiple-blank-lines
7622 Replace all blank lines with empty lines and then all multiple empty
7623 lines with a single empty line.
7624 (@code{gnus-article-strip-multiple-blank-lines}).
7627 @kindex W E t (Summary)
7628 @findex gnus-article-remove-trailing-blank-lines
7629 Remove all blank lines at the end of the article
7630 (@code{gnus-article-remove-trailing-blank-lines}).
7633 @kindex W E a (Summary)
7634 @findex gnus-article-strip-blank-lines
7635 Do all the three commands above
7636 (@code{gnus-article-strip-blank-lines}).
7639 @kindex W E A (Summary)
7640 @findex gnus-article-strip-all-blank-lines
7641 Remove all blank lines
7642 (@code{gnus-article-strip-all-blank-lines}).
7645 @kindex W E s (Summary)
7646 @findex gnus-article-strip-leading-space
7647 Remove all white space from the beginning of all lines of the article
7648 body (@code{gnus-article-strip-leading-space}).
7651 @kindex W E e (Summary)
7652 @findex gnus-article-strip-trailing-space
7653 Remove all white space from the end of all lines of the article
7654 body (@code{gnus-article-strip-trailing-space}).
7658 @xref{Customizing Articles}, for how to wash articles automatically.
7661 @node Article Buttons
7662 @subsection Article Buttons
7665 People often include references to other stuff in articles, and it would
7666 be nice if Gnus could just fetch whatever it is that people talk about
7667 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
7668 button on these references.
7670 Gnus adds @dfn{buttons} to certain standard references by default:
7671 Well-formed URLs, mail addresses and Message-IDs. This is controlled by
7672 two variables, one that handles article bodies and one that handles
7677 @item gnus-button-alist
7678 @vindex gnus-button-alist
7679 This is an alist where each entry has this form:
7682 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
7688 All text that match this regular expression will be considered an
7689 external reference. Here's a typical regexp that matches embedded URLs:
7690 @samp{<URL:\\([^\n\r>]*\\)>}.
7693 Gnus has to know which parts of the matches is to be highlighted. This
7694 is a number that says what sub-expression of the regexp is to be
7695 highlighted. If you want it all highlighted, you use 0 here.
7698 This form will be @code{eval}ed, and if the result is non-@code{nil},
7699 this is considered a match. This is useful if you want extra sifting to
7700 avoid false matches.
7703 This function will be called when you click on this button.
7706 As with @var{button-par}, this is a sub-expression number, but this one
7707 says which part of the match is to be sent as data to @var{function}.
7711 So the full entry for buttonizing URLs is then
7714 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
7717 @item gnus-header-button-alist
7718 @vindex gnus-header-button-alist
7719 This is just like the other alist, except that it is applied to the
7720 article head only, and that each entry has an additional element that is
7721 used to say what headers to apply the buttonize coding to:
7724 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
7727 @var{header} is a regular expression.
7729 @item gnus-button-url-regexp
7730 @vindex gnus-button-url-regexp
7731 A regular expression that matches embedded URLs. It is used in the
7732 default values of the variables above.
7734 @item gnus-article-button-face
7735 @vindex gnus-article-button-face
7736 Face used on buttons.
7738 @item gnus-article-mouse-face
7739 @vindex gnus-article-mouse-face
7740 Face used when the mouse cursor is over a button.
7744 @xref{Customizing Articles}, for how to buttonize articles automatically.
7748 @subsection Article Date
7750 The date is most likely generated in some obscure timezone you've never
7751 heard of, so it's quite nice to be able to find out what the time was
7752 when the article was sent.
7757 @kindex W T u (Summary)
7758 @findex gnus-article-date-ut
7759 Display the date in UT (aka. GMT, aka ZULU)
7760 (@code{gnus-article-date-ut}).
7763 @kindex W T i (Summary)
7764 @findex gnus-article-date-iso8601
7766 Display the date in international format, aka. ISO 8601
7767 (@code{gnus-article-date-iso8601}).
7770 @kindex W T l (Summary)
7771 @findex gnus-article-date-local
7772 Display the date in the local timezone (@code{gnus-article-date-local}).
7775 @kindex W T p (Summary)
7776 @findex gnus-article-date-english
7777 Display the date in a format that's easily pronounceable in English
7778 (@code{gnus-article-date-english}).
7781 @kindex W T s (Summary)
7782 @vindex gnus-article-time-format
7783 @findex gnus-article-date-user
7784 @findex format-time-string
7785 Display the date using a user-defined format
7786 (@code{gnus-article-date-user}). The format is specified by the
7787 @code{gnus-article-time-format} variable, and is a string that's passed
7788 to @code{format-time-string}. See the documentation of that variable
7789 for a list of possible format specs.
7792 @kindex W T e (Summary)
7793 @findex gnus-article-date-lapsed
7794 @findex gnus-start-date-timer
7795 @findex gnus-stop-date-timer
7796 Say how much time has elapsed between the article was posted and now
7797 (@code{gnus-article-date-lapsed}). It looks something like:
7800 X-Sent: 9 years, 6 weeks, 4 days, 9 hours, 3 minutes, 28 seconds ago
7803 The value of @code{gnus-article-date-lapsed-new-header} determines
7804 whether this header will just be added below the old Date one, or will
7807 An advantage of using Gnus to read mail is that it converts simple bugs
7808 into wonderful absurdities.
7810 If you want to have this line updated continually, you can put
7813 (gnus-start-date-timer)
7816 in your @file{.gnus.el} file, or you can run it off of some hook. If
7817 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
7821 @kindex W T o (Summary)
7822 @findex gnus-article-date-original
7823 Display the original date (@code{gnus-article-date-original}). This can
7824 be useful if you normally use some other conversion function and are
7825 worried that it might be doing something totally wrong. Say, claiming
7826 that the article was posted in 1854. Although something like that is
7827 @emph{totally} impossible. Don't you trust me? *titter*
7831 @xref{Customizing Articles}, for how to display the date in your
7832 preferred format automatically.
7835 @node Article Signature
7836 @subsection Article Signature
7838 @cindex article signature
7840 @vindex gnus-signature-separator
7841 Each article is divided into two parts---the head and the body. The
7842 body can be divided into a signature part and a text part. The variable
7843 that says what is to be considered a signature is
7844 @code{gnus-signature-separator}. This is normally the standard
7845 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
7846 non-standard signature separators, so this variable can also be a list
7847 of regular expressions to be tested, one by one. (Searches are done
7848 from the end of the body towards the beginning.) One likely value is:
7851 (setq gnus-signature-separator
7852 '("^-- $" ; The standard
7853 "^-- *$" ; A common mangling
7854 "^-------*$" ; Many people just use a looong
7855 ; line of dashes. Shame!
7856 "^ *--------*$" ; Double-shame!
7857 "^________*$" ; Underscores are also popular
7858 "^========*$")) ; Pervert!
7861 The more permissive you are, the more likely it is that you'll get false
7864 @vindex gnus-signature-limit
7865 @code{gnus-signature-limit} provides a limit to what is considered a
7866 signature when displaying articles.
7870 If it is an integer, no signature may be longer (in characters) than
7873 If it is a floating point number, no signature may be longer (in lines)
7876 If it is a function, the function will be called without any parameters,
7877 and if it returns @code{nil}, there is no signature in the buffer.
7879 If it is a string, it will be used as a regexp. If it matches, the text
7880 in question is not a signature.
7883 This variable can also be a list where the elements may be of the types
7884 listed above. Here's an example:
7887 (setq gnus-signature-limit
7888 '(200.0 "^---*Forwarded article"))
7891 This means that if there are more than 200 lines after the signature
7892 separator, or the text after the signature separator is matched by
7893 the regular expression @samp{^---*Forwarded article}, then it isn't a
7894 signature after all.
7897 @node Article Miscellania
7898 @subsection Article Miscellania
7902 @kindex A t (Summary)
7903 @findex gnus-article-babel
7904 Translate the article from one language to another
7905 (@code{gnus-article-babel}).
7911 @section @sc{mime} Commands
7912 @cindex MIME decoding
7914 @cindex viewing attachments
7916 The following commands all understand the numerical prefix. For
7917 instance, @kbd{3 b} means ``view the third @sc{mime} part''.
7923 @kindex K v (Summary)
7924 View the @sc{mime} part.
7927 @kindex K o (Summary)
7928 Save the @sc{mime} part.
7931 @kindex K c (Summary)
7932 Copy the @sc{mime} part.
7935 @kindex K e (Summary)
7936 View the @sc{mime} part externally.
7939 @kindex K i (Summary)
7940 View the @sc{mime} part internally.
7943 @kindex K | (Summary)
7944 Pipe the @sc{mime} part to an external command.
7947 The rest of these @sc{mime} commands do not use the numerical prefix in
7952 @kindex K b (Summary)
7953 Make all the @sc{mime} parts have buttons in front of them. This is
7954 mostly useful if you wish to save (or perform other actions) on inlined
7958 @kindex K m (Summary)
7959 @findex gnus-summary-repair-multipart
7960 Some multipart messages are transmitted with missing or faulty headers.
7961 This command will attempt to ``repair'' these messages so that they can
7962 be viewed in a more pleasant manner
7963 (@code{gnus-summary-repair-multipart}).
7966 @kindex X m (Summary)
7967 @findex gnus-summary-save-parts
7968 Save all parts matching a @sc{mime} type to a directory
7969 (@code{gnus-summary-save-parts}). Understands the process/prefix
7970 convention (@pxref{Process/Prefix}).
7973 @kindex M-t (Summary)
7974 @findex gnus-summary-display-buttonized
7975 Toggle the buttonized display of the article buffer
7976 (@code{gnus-summary-toggle-display-buttonized}).
7979 @kindex W M w (Summary)
7980 Decode RFC 2047-encoded words in the article headers
7981 (@code{gnus-article-decode-mime-words}).
7984 @kindex W M c (Summary)
7985 Decode encoded article bodies as well as charsets
7986 (@code{gnus-article-decode-charset}).
7988 This command looks in the @code{Content-Type} header to determine the
7989 charset. If there is no such header in the article, you can give it a
7990 prefix, which will prompt for the charset to decode as. In regional
7991 groups where people post using some common encoding (but do not include
7992 MIME headers), you can set the @code{charset} group/topic parameter to
7993 the required charset (@pxref{Group Parameters}).
7996 @kindex W M v (Summary)
7997 View all the @sc{mime} parts in the current article
7998 (@code{gnus-mime-view-all-parts}).
8005 @item gnus-ignored-mime-types
8006 @vindex gnus-ignored-mime-types
8007 This is a list of regexps. @sc{mime} types that match a regexp from
8008 this list will be completely ignored by Gnus. The default value is
8011 To have all Vcards be ignored, you'd say something like this:
8014 (setq gnus-ignored-mime-types
8018 @item gnus-unbuttonized-mime-types
8019 @vindex gnus-unbuttonized-mime-types
8020 This is a list of regexps. @sc{mime} types that match a regexp from
8021 this list won't have @sc{mime} buttons inserted unless they aren't
8022 displayed. The default value is @code{(".*/.*")}.
8024 @item gnus-article-mime-part-function
8025 @vindex gnus-article-mime-part-function
8026 For each @sc{mime} part, this function will be called with the @sc{mime}
8027 handle as the parameter. The function is meant to be used to allow
8028 users to gather information from the article (e. g., add Vcard info to
8029 the bbdb database) or to do actions based on parts (e. g., automatically
8030 save all jpegs into some directory).
8032 Here's an example function the does the latter:
8035 (defun my-save-all-jpeg-parts (handle)
8036 (when (equal (car (mm-handle-type handle)) "image/jpeg")
8038 (insert (mm-get-part handle))
8039 (write-region (point-min) (point-max)
8040 (read-file-name "Save jpeg to: ")))))
8041 (setq gnus-article-mime-part-function
8042 'my-save-all-jpeg-parts)
8045 @vindex gnus-mime-multipart-functions
8046 @item gnus-mime-multipart-functions
8047 Alist of @sc{mime} multipart types and functions to handle them.
8056 People use different charsets, and we have @sc{mime} to let us know what
8057 charsets they use. Or rather, we wish we had. Many people use
8058 newsreaders and mailers that do not understand or use @sc{mime}, and
8059 just send out messages without saying what character sets they use. To
8060 help a bit with this, some local news hierarchies have policies that say
8061 what character set is the default. For instance, the @samp{fj}
8062 hierarchy uses @code{iso-2022-jp-2}.
8064 @vindex gnus-group-charset-alist
8065 This knowledge is encoded in the @code{gnus-group-charset-alist}
8066 variable, which is an alist of regexps (to match full group names) and
8067 default charsets to be used when reading these groups.
8069 In addition, some people do use soi-disant @sc{mime}-aware agents that
8070 aren't. These blithely mark messages as being in @code{iso-8859-1} even
8071 if they really are in @code{koi-8}. To help here, the
8072 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
8073 charsets that are listed here will be ignored. The variable can be set
8074 on a group-by-group basis using the group parameters (@pxref{Group
8075 Parameters}). The default value is @code{(unknown-8bit)}, which is
8076 something some agents insist on having in there.
8078 @vindex gnus-group-posting-charset-alist
8079 When posting, @code{gnus-group-posting-charset-alist} is used to
8080 determine which charsets should not be encoded using the @sc{mime}
8081 encodings. For instance, some hierarchies discourage using
8082 quoted-printable header encoding.
8084 This variable is an alist of regexps and permitted unencoded charsets
8085 for posting. Each element of the alist has the form @code{(}@var{test
8086 header body-list}@code{)}, where:
8090 is either a regular expression matching the newsgroup header or a
8093 is the charset which may be left unencoded in the header (@code{nil}
8094 means encode all charsets),
8096 is a list of charsets which may be encoded using 8bit content-transfer
8097 encoding in the body, or one of the special values @code{nil} (always
8098 encode using quoted-printable) or @code{t} (always use 8bit).
8105 @cindex coding system aliases
8106 @cindex preferred charset
8108 Other charset tricks that may be useful, although not Gnus-specific:
8110 If there are several @sc{mime} charsets that encode the same Emacs
8111 charset, you can choose what charset to use by saying the following:
8114 (put-charset-property 'cyrillic-iso8859-5
8115 'preferred-coding-system 'koi8-r)
8118 This means that Russian will be encoded using @code{koi8-r} instead of
8119 the default @code{iso-8859-5} @sc{mime} charset.
8121 If you want to read messages in @code{koi8-u}, you can cheat and say
8124 (define-coding-system-alias 'koi8-u 'koi8-r)
8127 This will almost do the right thing.
8129 And finally, to read charsets like @code{windows-1251}, you can say
8133 (codepage-setup 1251)
8134 (define-coding-system-alias 'windows-1251 'cp1251)
8138 @node Article Commands
8139 @section Article Commands
8146 @kindex A P (Summary)
8147 @vindex gnus-ps-print-hook
8148 @findex gnus-summary-print-article
8149 Generate and print a PostScript image of the article buffer
8150 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be
8151 run just before printing the buffer.
8156 @node Summary Sorting
8157 @section Summary Sorting
8158 @cindex summary sorting
8160 You can have the summary buffer sorted in various ways, even though I
8161 can't really see why you'd want that.
8166 @kindex C-c C-s C-n (Summary)
8167 @findex gnus-summary-sort-by-number
8168 Sort by article number (@code{gnus-summary-sort-by-number}).
8171 @kindex C-c C-s C-a (Summary)
8172 @findex gnus-summary-sort-by-author
8173 Sort by author (@code{gnus-summary-sort-by-author}).
8176 @kindex C-c C-s C-s (Summary)
8177 @findex gnus-summary-sort-by-subject
8178 Sort by subject (@code{gnus-summary-sort-by-subject}).
8181 @kindex C-c C-s C-d (Summary)
8182 @findex gnus-summary-sort-by-date
8183 Sort by date (@code{gnus-summary-sort-by-date}).
8186 @kindex C-c C-s C-l (Summary)
8187 @findex gnus-summary-sort-by-lines
8188 Sort by lines (@code{gnus-summary-sort-by-lines}).
8191 @kindex C-c C-s C-c (Summary)
8192 @findex gnus-summary-sort-by-chars
8193 Sort by article length (@code{gnus-summary-sort-by-chars}).
8196 @kindex C-c C-s C-i (Summary)
8197 @findex gnus-summary-sort-by-score
8198 Sort by score (@code{gnus-summary-sort-by-score}).
8201 @kindex C-c C-s C-o (Summary)
8202 @findex gnus-summary-sort-by-original
8203 Sort using the default sorting method
8204 (@code{gnus-summary-sort-by-original}).
8207 These functions will work both when you use threading and when you don't
8208 use threading. In the latter case, all summary lines will be sorted,
8209 line by line. In the former case, sorting will be done on a
8210 root-by-root basis, which might not be what you were looking for. To
8211 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
8215 @node Finding the Parent
8216 @section Finding the Parent
8217 @cindex parent articles
8218 @cindex referring articles
8223 @findex gnus-summary-refer-parent-article
8224 If you'd like to read the parent of the current article, and it is not
8225 displayed in the summary buffer, you might still be able to. That is,
8226 if the current group is fetched by @sc{nntp}, the parent hasn't expired
8227 and the @code{References} in the current article are not mangled, you
8228 can just press @kbd{^} or @kbd{A r}
8229 (@code{gnus-summary-refer-parent-article}). If everything goes well,
8230 you'll get the parent. If the parent is already displayed in the
8231 summary buffer, point will just move to this article.
8233 If given a positive numerical prefix, fetch that many articles back into
8234 the ancestry. If given a negative numerical prefix, fetch just that
8235 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
8236 grandparent and the grandgrandparent of the current article. If you say
8237 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
8241 @findex gnus-summary-refer-references
8242 @kindex A R (Summary)
8243 Fetch all articles mentioned in the @code{References} header of the
8244 article (@code{gnus-summary-refer-references}).
8247 @findex gnus-summary-refer-thread
8248 @kindex A T (Summary)
8249 Display the full thread where the current article appears
8250 (@code{gnus-summary-refer-thread}). This command has to fetch all the
8251 headers in the current group to work, so it usually takes a while. If
8252 you do it often, you may consider setting @code{gnus-fetch-old-headers}
8253 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
8254 visible effects normally, but it'll make this command work a whole lot
8255 faster. Of course, it'll make group entry somewhat slow.
8257 @vindex gnus-refer-thread-limit
8258 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
8259 articles before the first displayed in the current group) headers to
8260 fetch when doing this command. The default is 200. If @code{t}, all
8261 the available headers will be fetched. This variable can be overridden
8262 by giving the @kbd{A T} command a numerical prefix.
8265 @findex gnus-summary-refer-article
8266 @kindex M-^ (Summary)
8268 @cindex fetching by Message-ID
8269 You can also ask the @sc{nntp} server for an arbitrary article, no
8270 matter what group it belongs to. @kbd{M-^}
8271 (@code{gnus-summary-refer-article}) will ask you for a
8272 @code{Message-ID}, which is one of those long, hard-to-read thingies
8273 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
8274 have to get it all exactly right. No fuzzy searches, I'm afraid.
8277 The current select method will be used when fetching by
8278 @code{Message-ID} from non-news select method, but you can override this
8279 by giving this command a prefix.
8281 @vindex gnus-refer-article-method
8282 If the group you are reading is located on a backend that does not
8283 support fetching by @code{Message-ID} very well (like @code{nnspool}),
8284 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
8285 would, perhaps, be best if the @sc{nntp} server you consult is the one
8286 updating the spool you are reading from, but that's not really
8289 It can also be a list of select methods, as well as the special symbol
8290 @code{current}, which means to use the current select method. If it
8291 is a list, Gnus will try all the methods in the list until it finds a
8294 Here's an example setting that will first try the current method, and
8295 then ask Deja if that fails:
8298 (setq gnus-refer-article-method
8300 (nnweb "refer" (nnweb-type dejanews))))
8303 Most of the mail backends support fetching by @code{Message-ID}, but do
8304 not do a particularly excellent job at it. That is, @code{nnmbox} and
8305 @code{nnbabyl} are able to locate articles from any groups, while
8306 @code{nnml} and @code{nnfolder} are only able to locate articles that
8307 have been posted to the current group. (Anything else would be too time
8308 consuming.) @code{nnmh} does not support this at all.
8311 @node Alternative Approaches
8312 @section Alternative Approaches
8314 Different people like to read news using different methods. This being
8315 Gnus, we offer a small selection of minor modes for the summary buffers.
8318 * Pick and Read:: First mark articles and then read them.
8319 * Binary Groups:: Auto-decode all articles.
8324 @subsection Pick and Read
8325 @cindex pick and read
8327 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
8328 a two-phased reading interface. The user first marks in a summary
8329 buffer the articles she wants to read. Then she starts reading the
8330 articles with just an article buffer displayed.
8332 @findex gnus-pick-mode
8333 @kindex M-x gnus-pick-mode
8334 Gnus provides a summary buffer minor mode that allows
8335 this---@code{gnus-pick-mode}. This basically means that a few process
8336 mark commands become one-keystroke commands to allow easy marking, and
8337 it provides one additional command for switching to the summary buffer.
8339 Here are the available keystrokes when using pick mode:
8344 @findex gnus-pick-article-or-thread
8345 Pick the article or thread on the current line
8346 (@code{gnus-pick-article-or-thread}). If the variable
8347 @code{gnus-thread-hide-subtree} is true, then this key selects the
8348 entire thread when used at the first article of the thread. Otherwise,
8349 it selects just the article. If given a numerical prefix, go to that
8350 thread or article and pick it. (The line number is normally displayed
8351 at the beginning of the summary pick lines.)
8354 @kindex SPACE (Pick)
8355 @findex gnus-pick-next-page
8356 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
8357 at the end of the buffer, start reading the picked articles.
8361 @findex gnus-pick-unmark-article-or-thread.
8362 Unpick the thread or article
8363 (@code{gnus-pick-unmark-article-or-thread}). If the variable
8364 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
8365 thread if used at the first article of the thread. Otherwise it unpicks
8366 just the article. You can give this key a numerical prefix to unpick
8367 the thread or article at that line.
8371 @findex gnus-pick-start-reading
8372 @vindex gnus-pick-display-summary
8373 Start reading the picked articles (@code{gnus-pick-start-reading}). If
8374 given a prefix, mark all unpicked articles as read first. If
8375 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
8376 will still be visible when you are reading.
8380 All the normal summary mode commands are still available in the
8381 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
8382 which is mapped to the same function
8383 @code{gnus-summary-tick-article-forward}.
8385 If this sounds like a good idea to you, you could say:
8388 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
8391 @vindex gnus-pick-mode-hook
8392 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
8394 @vindex gnus-mark-unpicked-articles-as-read
8395 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
8396 all unpicked articles as read. The default is @code{nil}.
8398 @vindex gnus-summary-pick-line-format
8399 The summary line format in pick mode is slightly different from the
8400 standard format. At the beginning of each line the line number is
8401 displayed. The pick mode line format is controlled by the
8402 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
8403 Variables}). It accepts the same format specs that
8404 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
8408 @subsection Binary Groups
8409 @cindex binary groups
8411 @findex gnus-binary-mode
8412 @kindex M-x gnus-binary-mode
8413 If you spend much time in binary groups, you may grow tired of hitting
8414 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
8415 is a minor mode for summary buffers that makes all ordinary Gnus article
8416 selection functions uudecode series of articles and display the result
8417 instead of just displaying the articles the normal way.
8420 @findex gnus-binary-show-article
8421 The only way, in fact, to see the actual articles is the @kbd{g}
8422 command, when you have turned on this mode
8423 (@code{gnus-binary-show-article}).
8425 @vindex gnus-binary-mode-hook
8426 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
8430 @section Tree Display
8433 @vindex gnus-use-trees
8434 If you don't like the normal Gnus summary display, you might try setting
8435 @code{gnus-use-trees} to @code{t}. This will create (by default) an
8436 additional @dfn{tree buffer}. You can execute all summary mode commands
8439 There are a few variables to customize the tree display, of course:
8442 @item gnus-tree-mode-hook
8443 @vindex gnus-tree-mode-hook
8444 A hook called in all tree mode buffers.
8446 @item gnus-tree-mode-line-format
8447 @vindex gnus-tree-mode-line-format
8448 A format string for the mode bar in the tree mode buffers (@pxref{Mode
8449 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
8450 of valid specs, @pxref{Summary Buffer Mode Line}.
8452 @item gnus-selected-tree-face
8453 @vindex gnus-selected-tree-face
8454 Face used for highlighting the selected article in the tree buffer. The
8455 default is @code{modeline}.
8457 @item gnus-tree-line-format
8458 @vindex gnus-tree-line-format
8459 A format string for the tree nodes. The name is a bit of a misnomer,
8460 though---it doesn't define a line, but just the node. The default value
8461 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
8462 the name of the poster. It is vital that all nodes are of the same
8463 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
8469 The name of the poster.
8471 The @code{From} header.
8473 The number of the article.
8475 The opening bracket.
8477 The closing bracket.
8482 @xref{Formatting Variables}.
8484 Variables related to the display are:
8487 @item gnus-tree-brackets
8488 @vindex gnus-tree-brackets
8489 This is used for differentiating between ``real'' articles and
8490 ``sparse'' articles. The format is @code{((@var{real-open} . @var{real-close})
8491 (@var{sparse-open} . @var{sparse-close}) (@var{dummy-open} . @var{dummy-close}))}, and the
8492 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
8494 @item gnus-tree-parent-child-edges
8495 @vindex gnus-tree-parent-child-edges
8496 This is a list that contains the characters used for connecting parent
8497 nodes to their children. The default is @code{(?- ?\\ ?|)}.
8501 @item gnus-tree-minimize-window
8502 @vindex gnus-tree-minimize-window
8503 If this variable is non-@code{nil}, Gnus will try to keep the tree
8504 buffer as small as possible to allow more room for the other Gnus
8505 windows. If this variable is a number, the tree buffer will never be
8506 higher than that number. The default is @code{t}. Note that if you
8507 have several windows displayed side-by-side in a frame and the tree
8508 buffer is one of these, minimizing the tree window will also resize all
8509 other windows displayed next to it.
8511 @item gnus-generate-tree-function
8512 @vindex gnus-generate-tree-function
8513 @findex gnus-generate-horizontal-tree
8514 @findex gnus-generate-vertical-tree
8515 The function that actually generates the thread tree. Two predefined
8516 functions are available: @code{gnus-generate-horizontal-tree} and
8517 @code{gnus-generate-vertical-tree} (which is the default).
8521 Here's an example from a horizontal tree buffer:
8524 @{***@}-(***)-[odd]-[Gun]
8534 Here's the same thread displayed in a vertical tree buffer:
8538 |--------------------------\-----\-----\
8539 (***) [Bjo] [Gun] [Gun]
8541 [odd] [Jan] [odd] (***) [Jor]
8543 [Gun] [Eri] [Eri] [odd]
8548 If you're using horizontal trees, it might be nice to display the trees
8549 side-by-side with the summary buffer. You could add something like the
8550 following to your @file{.gnus.el} file:
8553 (setq gnus-use-trees t
8554 gnus-generate-tree-function 'gnus-generate-horizontal-tree
8555 gnus-tree-minimize-window nil)
8556 (gnus-add-configuration
8560 (summary 0.75 point)
8565 @xref{Windows Configuration}.
8568 @node Mail Group Commands
8569 @section Mail Group Commands
8570 @cindex mail group commands
8572 Some commands only make sense in mail groups. If these commands are
8573 invalid in the current group, they will raise a hell and let you know.
8575 All these commands (except the expiry and edit commands) use the
8576 process/prefix convention (@pxref{Process/Prefix}).
8581 @kindex B e (Summary)
8582 @findex gnus-summary-expire-articles
8583 Run all expirable articles in the current group through the expiry
8584 process (@code{gnus-summary-expire-articles}). That is, delete all
8585 expirable articles in the group that have been around for a while.
8586 (@pxref{Expiring Mail}).
8589 @kindex B M-C-e (Summary)
8590 @findex gnus-summary-expire-articles-now
8591 Delete all the expirable articles in the group
8592 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
8593 articles eligible for expiry in the current group will
8594 disappear forever into that big @file{/dev/null} in the sky.
8597 @kindex B DEL (Summary)
8598 @findex gnus-summary-delete-article
8599 @c @icon{gnus-summary-mail-delete}
8600 Delete the mail article. This is ``delete'' as in ``delete it from your
8601 disk forever and ever, never to return again.'' Use with caution.
8602 (@code{gnus-summary-delete-article}).
8605 @kindex B m (Summary)
8607 @findex gnus-summary-move-article
8608 @vindex gnus-preserve-marks
8609 Move the article from one mail group to another
8610 (@code{gnus-summary-move-article}). Marks will be preserved if
8611 @var{gnus-preserve-marks} is non-@code{nil} (which is the default).
8614 @kindex B c (Summary)
8616 @findex gnus-summary-copy-article
8617 @c @icon{gnus-summary-mail-copy}
8618 Copy the article from one group (mail group or not) to a mail group
8619 (@code{gnus-summary-copy-article}). Marks will be preserved if
8620 @var{gnus-preserve-marks} is non-@code{nil} (which is the default).
8623 @kindex B B (Summary)
8624 @cindex crosspost mail
8625 @findex gnus-summary-crosspost-article
8626 Crosspost the current article to some other group
8627 (@code{gnus-summary-crosspost-article}). This will create a new copy of
8628 the article in the other group, and the Xref headers of the article will
8629 be properly updated.
8632 @kindex B i (Summary)
8633 @findex gnus-summary-import-article
8634 Import an arbitrary file into the current mail newsgroup
8635 (@code{gnus-summary-import-article}). You will be prompted for a file
8636 name, a @code{From} header and a @code{Subject} header.
8639 @kindex B r (Summary)
8640 @findex gnus-summary-respool-article
8641 Respool the mail article (@code{gnus-summary-respool-article}).
8642 @code{gnus-summary-respool-default-method} will be used as the default
8643 select method when respooling. This variable is @code{nil} by default,
8644 which means that the current group select method will be used instead.
8645 Marks will be preserved if @var{gnus-preserve-marks} is non-@code{nil}
8646 (which is the default).
8650 @kindex B w (Summary)
8652 @findex gnus-summary-edit-article
8653 @kindex C-c C-c (Article)
8654 Edit the current article (@code{gnus-summary-edit-article}). To finish
8655 editing and make the changes permanent, type @kbd{C-c C-c}
8656 (@kbd{gnus-summary-edit-article-done}). If you give a prefix to the
8657 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
8660 @kindex B q (Summary)
8661 @findex gnus-summary-respool-query
8662 If you want to re-spool an article, you might be curious as to what group
8663 the article will end up in before you do the re-spooling. This command
8664 will tell you (@code{gnus-summary-respool-query}).
8667 @kindex B t (Summary)
8668 @findex gnus-summary-respool-trace
8669 Similarly, this command will display all fancy splitting patterns used
8670 when repooling, if any (@code{gnus-summary-respool-trace}).
8673 @kindex B p (Summary)
8674 @findex gnus-summary-article-posted-p
8675 Some people have a tendency to send you "courtesy" copies when they
8676 follow up to articles you have posted. These usually have a
8677 @code{Newsgroups} header in them, but not always. This command
8678 (@code{gnus-summary-article-posted-p}) will try to fetch the current
8679 article from your news server (or rather, from
8680 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
8681 report back whether it found the article or not. Even if it says that
8682 it didn't find the article, it may have been posted anyway---mail
8683 propagation is much faster than news propagation, and the news copy may
8684 just not have arrived yet.
8688 @vindex gnus-move-split-methods
8689 @cindex moving articles
8690 If you move (or copy) articles regularly, you might wish to have Gnus
8691 suggest where to put the articles. @code{gnus-move-split-methods} is a
8692 variable that uses the same syntax as @code{gnus-split-methods}
8693 (@pxref{Saving Articles}). You may customize that variable to create
8694 suggestions you find reasonable. (Note that
8695 @code{gnus-move-split-methods} uses group names where
8696 @code{gnus-split-methods} uses file names.)
8699 (setq gnus-move-split-methods
8700 '(("^From:.*Lars Magne" "nnml:junk")
8701 ("^Subject:.*gnus" "nnfolder:important")
8702 (".*" "nnml:misc")))
8706 @node Various Summary Stuff
8707 @section Various Summary Stuff
8710 * Summary Group Information:: Information oriented commands.
8711 * Searching for Articles:: Multiple article commands.
8712 * Summary Generation Commands:: (Re)generating the summary buffer.
8713 * Really Various Summary Commands:: Those pesky non-conformant commands.
8717 @vindex gnus-summary-mode-hook
8718 @item gnus-summary-mode-hook
8719 This hook is called when creating a summary mode buffer.
8721 @vindex gnus-summary-generate-hook
8722 @item gnus-summary-generate-hook
8723 This is called as the last thing before doing the threading and the
8724 generation of the summary buffer. It's quite convenient for customizing
8725 the threading variables based on what data the newsgroup has. This hook
8726 is called from the summary buffer after most summary buffer variables
8729 @vindex gnus-summary-prepare-hook
8730 @item gnus-summary-prepare-hook
8731 It is called after the summary buffer has been generated. You might use
8732 it to, for instance, highlight lines or modify the look of the buffer in
8733 some other ungodly manner. I don't care.
8735 @vindex gnus-summary-prepared-hook
8736 @item gnus-summary-prepared-hook
8737 A hook called as the very last thing after the summary buffer has been
8740 @vindex gnus-summary-ignore-duplicates
8741 @item gnus-summary-ignore-duplicates
8742 When Gnus discovers two articles that have the same @code{Message-ID},
8743 it has to do something drastic. No articles are allowed to have the
8744 same @code{Message-ID}, but this may happen when reading mail from some
8745 sources. Gnus allows you to customize what happens with this variable.
8746 If it is @code{nil} (which is the default), Gnus will rename the
8747 @code{Message-ID} (for display purposes only) and display the article as
8748 any other article. If this variable is @code{t}, it won't display the
8749 article---it'll be as if it never existed.
8751 @vindex gnus-alter-articles-to-read-function
8752 @item gnus-alter-articles-to-read-function
8753 This function, which takes two parameters (the group name and the list
8754 of articles to be selected), is called to allow the user to alter the
8755 list of articles to be selected.
8757 For instance, the following function adds the list of cached articles to
8758 the list in one particular group:
8761 (defun my-add-cached-articles (group articles)
8762 (if (string= group "some.group")
8763 (append gnus-newsgroup-cached articles)
8770 @node Summary Group Information
8771 @subsection Summary Group Information
8776 @kindex H f (Summary)
8777 @findex gnus-summary-fetch-faq
8778 @vindex gnus-group-faq-directory
8779 Try to fetch the FAQ (list of frequently asked questions) for the
8780 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
8781 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
8782 on a remote machine. This variable can also be a list of directories.
8783 In that case, giving a prefix to this command will allow you to choose
8784 between the various sites. @code{ange-ftp} or @code{efs} will probably
8785 be used for fetching the file.
8788 @kindex H d (Summary)
8789 @findex gnus-summary-describe-group
8790 Give a brief description of the current group
8791 (@code{gnus-summary-describe-group}). If given a prefix, force
8792 rereading the description from the server.
8795 @kindex H h (Summary)
8796 @findex gnus-summary-describe-briefly
8797 Give an extremely brief description of the most important summary
8798 keystrokes (@code{gnus-summary-describe-briefly}).
8801 @kindex H i (Summary)
8802 @findex gnus-info-find-node
8803 Go to the Gnus info node (@code{gnus-info-find-node}).
8807 @node Searching for Articles
8808 @subsection Searching for Articles
8813 @kindex M-s (Summary)
8814 @findex gnus-summary-search-article-forward
8815 Search through all subsequent articles for a regexp
8816 (@code{gnus-summary-search-article-forward}).
8819 @kindex M-r (Summary)
8820 @findex gnus-summary-search-article-backward
8821 Search through all previous articles for a regexp
8822 (@code{gnus-summary-search-article-backward}).
8826 @findex gnus-summary-execute-command
8827 This command will prompt you for a header, a regular expression to match
8828 on this field, and a command to be executed if the match is made
8829 (@code{gnus-summary-execute-command}). If the header is an empty
8830 string, the match is done on the entire article. If given a prefix,
8831 search backward instead.
8833 For instance, @kbd{& RET some.*string #} will put the process mark on
8834 all articles that have heads or bodies that match @samp{some.*string}.
8837 @kindex M-& (Summary)
8838 @findex gnus-summary-universal-argument
8839 Perform any operation on all articles that have been marked with
8840 the process mark (@code{gnus-summary-universal-argument}).
8843 @node Summary Generation Commands
8844 @subsection Summary Generation Commands
8849 @kindex Y g (Summary)
8850 @findex gnus-summary-prepare
8851 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
8854 @kindex Y c (Summary)
8855 @findex gnus-summary-insert-cached-articles
8856 Pull all cached articles (for the current group) into the summary buffer
8857 (@code{gnus-summary-insert-cached-articles}).
8862 @node Really Various Summary Commands
8863 @subsection Really Various Summary Commands
8869 @kindex C-d (Summary)
8870 @kindex A D (Summary)
8871 @findex gnus-summary-enter-digest-group
8872 If the current article is a collection of other articles (for instance,
8873 a digest), you might use this command to enter a group based on the that
8874 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
8875 guess what article type is currently displayed unless you give a prefix
8876 to this command, which forces a ``digest'' interpretation. Basically,
8877 whenever you see a message that is a collection of other messages of
8878 some format, you @kbd{C-d} and read these messages in a more convenient
8882 @kindex M-C-d (Summary)
8883 @findex gnus-summary-read-document
8884 This command is very similar to the one above, but lets you gather
8885 several documents into one biiig group
8886 (@code{gnus-summary-read-document}). It does this by opening several
8887 @code{nndoc} groups for each document, and then opening an
8888 @code{nnvirtual} group on top of these @code{nndoc} groups. This
8889 command understands the process/prefix convention
8890 (@pxref{Process/Prefix}).
8893 @kindex C-t (Summary)
8894 @findex gnus-summary-toggle-truncation
8895 Toggle truncation of summary lines
8896 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
8897 line centering function in the summary buffer, so it's not a good idea
8898 to have truncation switched off while reading articles.
8902 @findex gnus-summary-expand-window
8903 Expand the summary buffer window (@code{gnus-summary-expand-window}).
8904 If given a prefix, force an @code{article} window configuration.
8907 @kindex M-C-e (Summary)
8908 @findex gnus-summary-edit-parameters
8909 Edit the group parameters (@pxref{Group Parameters}) of the current
8910 group (@code{gnus-summary-edit-parameters}).
8913 @kindex M-C-a (Summary)
8914 @findex gnus-summary-customize-parameters
8915 Customize the group parameters (@pxref{Group Parameters}) of the current
8916 group (@code{gnus-summary-customize-parameters}).
8921 @node Exiting the Summary Buffer
8922 @section Exiting the Summary Buffer
8923 @cindex summary exit
8924 @cindex exiting groups
8926 Exiting from the summary buffer will normally update all info on the
8927 group and return you to the group buffer.
8933 @kindex Z Z (Summary)
8935 @findex gnus-summary-exit
8936 @vindex gnus-summary-exit-hook
8937 @vindex gnus-summary-prepare-exit-hook
8938 @c @icon{gnus-summary-exit}
8939 Exit the current group and update all information on the group
8940 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
8941 called before doing much of the exiting, which calls
8942 @code{gnus-summary-expire-articles} by default.
8943 @code{gnus-summary-exit-hook} is called after finishing the exit
8944 process. @code{gnus-group-no-more-groups-hook} is run when returning to
8945 group mode having no more (unread) groups.
8949 @kindex Z E (Summary)
8951 @findex gnus-summary-exit-no-update
8952 Exit the current group without updating any information on the group
8953 (@code{gnus-summary-exit-no-update}).
8957 @kindex Z c (Summary)
8959 @findex gnus-summary-catchup-and-exit
8960 @c @icon{gnus-summary-catchup-and-exit}
8961 Mark all unticked articles in the group as read and then exit
8962 (@code{gnus-summary-catchup-and-exit}).
8965 @kindex Z C (Summary)
8966 @findex gnus-summary-catchup-all-and-exit
8967 Mark all articles, even the ticked ones, as read and then exit
8968 (@code{gnus-summary-catchup-all-and-exit}).
8971 @kindex Z n (Summary)
8972 @findex gnus-summary-catchup-and-goto-next-group
8973 Mark all articles as read and go to the next group
8974 (@code{gnus-summary-catchup-and-goto-next-group}).
8977 @kindex Z R (Summary)
8978 @findex gnus-summary-reselect-current-group
8979 Exit this group, and then enter it again
8980 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
8981 all articles, both read and unread.
8985 @kindex Z G (Summary)
8986 @kindex M-g (Summary)
8987 @findex gnus-summary-rescan-group
8988 @c @icon{gnus-summary-mail-get}
8989 Exit the group, check for new articles in the group, and select the
8990 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
8991 articles, both read and unread.
8994 @kindex Z N (Summary)
8995 @findex gnus-summary-next-group
8996 Exit the group and go to the next group
8997 (@code{gnus-summary-next-group}).
9000 @kindex Z P (Summary)
9001 @findex gnus-summary-prev-group
9002 Exit the group and go to the previous group
9003 (@code{gnus-summary-prev-group}).
9006 @kindex Z s (Summary)
9007 @findex gnus-summary-save-newsrc
9008 Save the current number of read/marked articles in the dribble buffer
9009 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
9010 given a prefix, also save the @file{.newsrc} file(s). Using this
9011 command will make exit without updating (the @kbd{Q} command) worthless.
9014 @vindex gnus-exit-group-hook
9015 @code{gnus-exit-group-hook} is called when you exit the current group
9016 with an ``updating'' exit. For instance @kbd{Q}
9017 (@code{gnus-summary-exit-no-update}) does not call this hook.
9019 @findex gnus-summary-wake-up-the-dead
9020 @findex gnus-dead-summary-mode
9021 @vindex gnus-kill-summary-on-exit
9022 If you're in the habit of exiting groups, and then changing your mind
9023 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
9024 If you do that, Gnus won't kill the summary buffer when you exit it.
9025 (Quelle surprise!) Instead it will change the name of the buffer to
9026 something like @samp{*Dead Summary ... *} and install a minor mode
9027 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
9028 buffer, you'll find that all keys are mapped to a function called
9029 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
9030 summary buffer will result in a live, normal summary buffer.
9032 There will never be more than one dead summary buffer at any one time.
9034 @vindex gnus-use-cross-reference
9035 The data on the current group will be updated (which articles you have
9036 read, which articles you have replied to, etc.) when you exit the
9037 summary buffer. If the @code{gnus-use-cross-reference} variable is
9038 @code{t} (which is the default), articles that are cross-referenced to
9039 this group and are marked as read, will also be marked as read in the
9040 other subscribed groups they were cross-posted to. If this variable is
9041 neither @code{nil} nor @code{t}, the article will be marked as read in
9042 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
9045 @node Crosspost Handling
9046 @section Crosspost Handling
9050 Marking cross-posted articles as read ensures that you'll never have to
9051 read the same article more than once. Unless, of course, somebody has
9052 posted it to several groups separately. Posting the same article to
9053 several groups (not cross-posting) is called @dfn{spamming}, and you are
9054 by law required to send nasty-grams to anyone who perpetrates such a
9055 heinous crime. You may want to try NoCeM handling to filter out spam
9058 Remember: Cross-posting is kinda ok, but posting the same article
9059 separately to several groups is not. Massive cross-posting (aka.
9060 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
9061 @code{gnus-summary-mail-crosspost-complaint} command to complain about
9062 excessive crossposting (@pxref{Summary Mail Commands}).
9064 @cindex cross-posting
9067 One thing that may cause Gnus to not do the cross-posting thing
9068 correctly is if you use an @sc{nntp} server that supports @sc{xover}
9069 (which is very nice, because it speeds things up considerably) which
9070 does not include the @code{Xref} header in its @sc{nov} lines. This is
9071 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
9072 even with @sc{xover} by registering the @code{Xref} lines of all
9073 articles you actually read, but if you kill the articles, or just mark
9074 them as read without reading them, Gnus will not get a chance to snoop
9075 the @code{Xref} lines out of these articles, and will be unable to use
9076 the cross reference mechanism.
9078 @cindex LIST overview.fmt
9079 @cindex overview.fmt
9080 To check whether your @sc{nntp} server includes the @code{Xref} header
9081 in its overview files, try @samp{telnet your.nntp.server nntp},
9082 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
9083 overview.fmt}. This may not work, but if it does, and the last line you
9084 get does not read @samp{Xref:full}, then you should shout and whine at
9085 your news admin until she includes the @code{Xref} header in the
9088 @vindex gnus-nov-is-evil
9089 If you want Gnus to get the @code{Xref}s right all the time, you have to
9090 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
9095 For an alternative approach, @pxref{Duplicate Suppression}.
9098 @node Duplicate Suppression
9099 @section Duplicate Suppression
9101 By default, Gnus tries to make sure that you don't have to read the same
9102 article more than once by utilizing the crossposting mechanism
9103 (@pxref{Crosspost Handling}). However, that simple and efficient
9104 approach may not work satisfactory for some users for various
9109 The @sc{nntp} server may fail to generate the @code{Xref} header. This
9110 is evil and not very common.
9113 The @sc{nntp} server may fail to include the @code{Xref} header in the
9114 @file{.overview} data bases. This is evil and all too common, alas.
9117 You may be reading the same group (or several related groups) from
9118 different @sc{nntp} servers.
9121 You may be getting mail that duplicates articles posted to groups.
9124 I'm sure there are other situations where @code{Xref} handling fails as
9125 well, but these four are the most common situations.
9127 If, and only if, @code{Xref} handling fails for you, then you may
9128 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
9129 will remember the @code{Message-ID}s of all articles you have read or
9130 otherwise marked as read, and then, as if by magic, mark them as read
9131 all subsequent times you see them---in @emph{all} groups. Using this
9132 mechanism is quite likely to be somewhat inefficient, but not overly
9133 so. It's certainly preferable to reading the same articles more than
9136 Duplicate suppression is not a very subtle instrument. It's more like a
9137 sledge hammer than anything else. It works in a very simple
9138 fashion---if you have marked an article as read, it adds this Message-ID
9139 to a cache. The next time it sees this Message-ID, it will mark the
9140 article as read with the @samp{M} mark. It doesn't care what group it
9144 @item gnus-suppress-duplicates
9145 @vindex gnus-suppress-duplicates
9146 If non-@code{nil}, suppress duplicates.
9148 @item gnus-save-duplicate-list
9149 @vindex gnus-save-duplicate-list
9150 If non-@code{nil}, save the list of duplicates to a file. This will
9151 make startup and shutdown take longer, so the default is @code{nil}.
9152 However, this means that only duplicate articles read in a single Gnus
9153 session are suppressed.
9155 @item gnus-duplicate-list-length
9156 @vindex gnus-duplicate-list-length
9157 This variable says how many @code{Message-ID}s to keep in the duplicate
9158 suppression list. The default is 10000.
9160 @item gnus-duplicate-file
9161 @vindex gnus-duplicate-file
9162 The name of the file to store the duplicate suppression list in. The
9163 default is @file{~/News/suppression}.
9166 If you have a tendency to stop and start Gnus often, setting
9167 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
9168 you leave Gnus running for weeks on end, you may have it @code{nil}. On
9169 the other hand, saving the list makes startup and shutdown much slower,
9170 so that means that if you stop and start Gnus often, you should set
9171 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
9172 to you to figure out, I think.
9177 Gnus is able to verify PGP or S/MIME signed messages or decrypt PGP
9182 To verify or decrypt PGP messages, you have to install mailcrypt or
9188 @item mm-verify-option
9189 @vindex mm-verify-option
9190 Option of verifying signed parts. @code{never}, not verify;
9191 @code{always}, always verify; @code{known}, only verify known
9192 protocols. Otherwise, ask user.
9194 @item mm-decrypt-option
9195 @vindex mm-decrypt-option
9196 Option of decrypting encrypted parts. @code{never}, no decryption;
9197 @code{always}, always decrypt @code{known}, only decrypt known
9198 protocols. Otherwise, ask user.
9202 @node Article Buffer
9203 @chapter Article Buffer
9204 @cindex article buffer
9206 The articles are displayed in the article buffer, of which there is only
9207 one. All the summary buffers share the same article buffer unless you
9208 tell Gnus otherwise.
9211 * Hiding Headers:: Deciding what headers should be displayed.
9212 * Using MIME:: Pushing articles through @sc{mime} before reading them.
9213 * Customizing Articles:: Tailoring the look of the articles.
9214 * Article Keymap:: Keystrokes available in the article buffer.
9215 * Misc Article:: Other stuff.
9219 @node Hiding Headers
9220 @section Hiding Headers
9221 @cindex hiding headers
9222 @cindex deleting headers
9224 The top section of each article is the @dfn{head}. (The rest is the
9225 @dfn{body}, but you may have guessed that already.)
9227 @vindex gnus-show-all-headers
9228 There is a lot of useful information in the head: the name of the person
9229 who wrote the article, the date it was written and the subject of the
9230 article. That's well and nice, but there's also lots of information
9231 most people do not want to see---what systems the article has passed
9232 through before reaching you, the @code{Message-ID}, the
9233 @code{References}, etc. ad nauseum---and you'll probably want to get rid
9234 of some of those lines. If you want to keep all those lines in the
9235 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
9237 Gnus provides you with two variables for sifting headers:
9241 @item gnus-visible-headers
9242 @vindex gnus-visible-headers
9243 If this variable is non-@code{nil}, it should be a regular expression
9244 that says what headers you wish to keep in the article buffer. All
9245 headers that do not match this variable will be hidden.
9247 For instance, if you only want to see the name of the person who wrote
9248 the article and the subject, you'd say:
9251 (setq gnus-visible-headers "^From:\\|^Subject:")
9254 This variable can also be a list of regexps to match headers to
9257 @item gnus-ignored-headers
9258 @vindex gnus-ignored-headers
9259 This variable is the reverse of @code{gnus-visible-headers}. If this
9260 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
9261 should be a regular expression that matches all lines that you want to
9262 hide. All lines that do not match this variable will remain visible.
9264 For instance, if you just want to get rid of the @code{References} line
9265 and the @code{Xref} line, you might say:
9268 (setq gnus-ignored-headers "^References:\\|^Xref:")
9271 This variable can also be a list of regexps to match headers to
9274 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
9275 variable will have no effect.
9279 @vindex gnus-sorted-header-list
9280 Gnus can also sort the headers for you. (It does this by default.) You
9281 can control the sorting by setting the @code{gnus-sorted-header-list}
9282 variable. It is a list of regular expressions that says in what order
9283 the headers are to be displayed.
9285 For instance, if you want the name of the author of the article first,
9286 and then the subject, you might say something like:
9289 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
9292 Any headers that are to remain visible, but are not listed in this
9293 variable, will be displayed in random order after all the headers listed in this variable.
9295 @findex gnus-article-hide-boring-headers
9296 @vindex gnus-boring-article-headers
9297 You can hide further boring headers by setting
9298 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
9299 does depends on the @code{gnus-boring-article-headers} variable. It's a
9300 list, but this list doesn't actually contain header names. Instead is
9301 lists various @dfn{boring conditions} that Gnus can check and remove
9304 These conditions are:
9307 Remove all empty headers.
9309 Remove the @code{Followup-To} header if it is identical to the
9310 @code{Newsgroups} header.
9312 Remove the @code{Reply-To} header if it lists the same address as the
9315 Remove the @code{Newsgroups} header if it only contains the current group
9318 Remove the @code{To} header if it only contains the address identical to
9319 the current groups's @code{to-address} parameter.
9321 Remove the @code{Date} header if the article is less than three days
9324 Remove the @code{To} header if it is very long.
9326 Remove all @code{To} headers if there are more than one.
9329 To include these three elements, you could say something like;
9332 (setq gnus-boring-article-headers
9333 '(empty followup-to reply-to))
9336 This is also the default value for this variable.
9340 @section Using @sc{mime}
9343 Mime is a standard for waving your hands through the air, aimlessly,
9344 while people stand around yawning.
9346 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
9347 while all newsreaders die of fear.
9349 @sc{mime} may specify what character set the article uses, the encoding
9350 of the characters, and it also makes it possible to embed pictures and
9351 other naughty stuff in innocent-looking articles.
9353 @vindex gnus-display-mime-function
9354 @findex gnus-display-mime
9355 Gnus pushes @sc{mime} articles through @code{gnus-display-mime-function}
9356 to display the @sc{mime} parts. This is @code{gnus-display-mime} by
9357 default, which creates a bundle of clickable buttons that can be used to
9358 display, save and manipulate the @sc{mime} objects.
9360 The following commands are available when you have placed point over a
9364 @findex gnus-article-press-button
9366 @itemx BUTTON-2 (Article)
9367 Toggle displaying of the @sc{mime} object
9368 (@code{gnus-article-press-button}).
9370 @findex gnus-mime-view-part
9371 @item M-RET (Article)
9373 Prompt for a method, and then view the @sc{mime} object using this
9374 method (@code{gnus-mime-view-part}).
9376 @findex gnus-mime-save-part
9378 Prompt for a file name, and then save the @sc{mime} object
9379 (@code{gnus-mime-save-part}).
9381 @findex gnus-mime-copy-part
9383 Copy the @sc{mime} object to a fresh buffer and display this buffer
9384 (@code{gnus-mime-copy-part}).
9386 @findex gnus-mime-view-part-as-type
9388 View the @sc{mime} object as if it were a different @sc{mime} media type
9389 (@code{gnus-mime-view-part-as-type}).
9391 @findex gnus-mime-pipe-part
9393 Output the @sc{mime} object to a process (@code{gnus-mime-pipe-part}).
9395 @findex gnus-mime-inline-part
9397 Insert the contents of the @sc{mime} object into the buffer
9398 (@code{gnus-mime-inline-part}) as text/plain. If given a prefix, insert
9399 the raw contents without decoding. If given a numerical prefix, you can
9400 do semi-manual charset stuff (see
9401 @code{gnus-summary-show-article-charset-alist} in @pxref{Paging the
9404 @findex gnus-mime-action-on-part
9406 Interactively run an action on the @sc{mime} object
9407 (@code{gnus-mime-action-on-part}).
9411 Gnus will display some @sc{mime} objects automatically. The way Gnus
9412 determines which parts to do this with is described in the Emacs MIME
9415 It might be best to just use the toggling functions from the article
9416 buffer to avoid getting nasty surprises. (For instance, you enter the
9417 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
9418 decoded the sound file in the article and some horrible sing-a-long song
9419 comes screaming out your speakers, and you can't find the volume button,
9420 because there isn't one, and people are starting to look at you, and you
9421 try to stop the program, but you can't, and you can't find the program
9422 to control the volume, and everybody else in the room suddenly decides
9423 to look at you disdainfully, and you'll feel rather stupid.)
9425 Any similarity to real events and people is purely coincidental. Ahem.
9427 Also see @pxref{MIME Commands}.
9430 @node Customizing Articles
9431 @section Customizing Articles
9432 @cindex article customization
9434 A slew of functions for customizing how the articles are to look like
9435 exist. You can call these functions interactively, or you can have them
9436 called automatically when you select the articles.
9438 To have them called automatically, you should set the corresponding
9439 ``treatment'' variable. For instance, to have headers hidden, you'd set
9440 @code{gnus-treat-hide-headers}. Below is a list of variables that can
9441 be set, but first we discuss the values these variables can have.
9443 Note: Some values, while valid, make little sense. Check the list below
9444 for sensible values.
9448 @code{nil}: Don't do this treatment.
9451 @code{t}: Do this treatment on all body parts.
9454 @code{head}: Do the treatment on the headers.
9457 @code{last}: Do this treatment on the last part.
9460 An integer: Do this treatment on all body parts that have a length less
9464 A list of strings: Do this treatment on all body parts that are in
9465 articles that are read in groups that have names that match one of the
9466 regexps in the list.
9469 A list where the first element is not a string:
9471 The list is evaluated recursively. The first element of the list is a
9472 predicate. The following predicates are recognized: @code{or},
9473 @code{and}, @code{not} and @code{typep}. Here's an example:
9477 (typep "text/x-vcard"))
9482 You may have noticed that the word @dfn{part} is used here. This refers
9483 to the fact that some messages are @sc{mime} multipart articles that may
9484 be divided into several parts. Articles that are not multiparts are
9485 considered to contain just a single part.
9487 @vindex gnus-article-treat-types
9488 Are the treatments applied to all sorts of multipart parts? Yes, if you
9489 want to, but by default, only @samp{text/plain} parts are given the
9490 treatment. This is controlled by the @code{gnus-article-treat-types}
9491 variable, which is a list of regular expressions that are matched to the
9492 type of the part. This variable is ignored if the value of the
9493 controlling variable is a predicate list, as described above.
9495 The following treatment options are available. The easiest way to
9496 customize this is to examine the @code{gnus-article-treat} customization
9497 group. Values in parenthesis are suggested sensible values. Others are
9498 possible but those listed are probably sufficient for most people.
9501 @item gnus-treat-highlight-signature (t, last)
9502 @item gnus-treat-buttonize (t, integer)
9503 @item gnus-treat-buttonize-head (head)
9504 @item gnus-treat-emphasize (t, head, integer)
9505 @item gnus-treat-fill-article (t, integer)
9506 @item gnus-treat-strip-cr (t, integer)
9507 @item gnus-treat-hide-headers (head)
9508 @item gnus-treat-hide-boring-headers (head)
9509 @item gnus-treat-hide-signature (t, last)
9510 @item gnus-treat-hide-citation (t, integer)
9511 @item gnus-treat-hide-citation-maybe (t, integer)
9512 @item gnus-treat-strip-pgp (t, last, integer)
9513 @item gnus-treat-strip-pem (t, last, integer)
9514 @item gnus-treat-highlight-headers (head)
9515 @item gnus-treat-highlight-citation (t, integer)
9516 @item gnus-treat-highlight-signature (t, last, integer)
9517 @item gnus-treat-date-ut (head)
9518 @item gnus-treat-date-local (head)
9519 @item gnus-treat-date-english (head)
9520 @item gnus-treat-date-lapsed (head)
9521 @item gnus-treat-date-original (head)
9522 @item gnus-treat-date-iso8601 (head)
9523 @item gnus-treat-date-user-defined (head)
9524 @item gnus-treat-strip-headers-in-body (t, integer)
9525 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
9526 @item gnus-treat-strip-leading-blank-lines (t, integer)
9527 @item gnus-treat-strip-multiple-blank-lines (t, integer)
9528 @item gnus-treat-overstrike (t, integer)
9529 @item gnus-treat-display-xface (head)
9530 @item gnus-treat-display-smileys (t, integer)
9531 @item gnus-treat-display-picons (head)
9532 @item gnus-treat-capitalize-sentences (t, integer)
9533 @item gnus-treat-fill-long-lines (t, integer)
9534 @item gnus-treat-play-sounds
9535 @item gnus-treat-translate
9538 @vindex gnus-part-display-hook
9539 You can, of course, write your own functions to be called from
9540 @code{gnus-part-display-hook}. The functions are called narrowed to the
9541 part, and you can do anything you like, pretty much. There is no
9542 information that you have to keep in the buffer---you can change
9546 @node Article Keymap
9547 @section Article Keymap
9549 Most of the keystrokes in the summary buffer can also be used in the
9550 article buffer. They should behave as if you typed them in the summary
9551 buffer, which means that you don't actually have to have a summary
9552 buffer displayed while reading. You can do it all from the article
9555 A few additional keystrokes are available:
9560 @kindex SPACE (Article)
9561 @findex gnus-article-next-page
9562 Scroll forwards one page (@code{gnus-article-next-page}).
9565 @kindex DEL (Article)
9566 @findex gnus-article-prev-page
9567 Scroll backwards one page (@code{gnus-article-prev-page}).
9570 @kindex C-c ^ (Article)
9571 @findex gnus-article-refer-article
9572 If point is in the neighborhood of a @code{Message-ID} and you press
9573 @kbd{C-c ^}, Gnus will try to get that article from the server
9574 (@code{gnus-article-refer-article}).
9577 @kindex C-c C-m (Article)
9578 @findex gnus-article-mail
9579 Send a reply to the address near point (@code{gnus-article-mail}). If
9580 given a prefix, include the mail.
9584 @findex gnus-article-show-summary
9585 Reconfigure the buffers so that the summary buffer becomes visible
9586 (@code{gnus-article-show-summary}).
9590 @findex gnus-article-describe-briefly
9591 Give a very brief description of the available keystrokes
9592 (@code{gnus-article-describe-briefly}).
9595 @kindex TAB (Article)
9596 @findex gnus-article-next-button
9597 Go to the next button, if any (@code{gnus-article-next-button}). This
9598 only makes sense if you have buttonizing turned on.
9601 @kindex M-TAB (Article)
9602 @findex gnus-article-prev-button
9603 Go to the previous button, if any (@code{gnus-article-prev-button}).
9609 @section Misc Article
9613 @item gnus-single-article-buffer
9614 @vindex gnus-single-article-buffer
9615 If non-@code{nil}, use the same article buffer for all the groups.
9616 (This is the default.) If @code{nil}, each group will have its own
9619 @vindex gnus-article-decode-hook
9620 @item gnus-article-decode-hook
9622 Hook used to decode @sc{mime} articles. The default value is
9623 @code{(article-decode-charset article-decode-encoded-words)}
9625 @vindex gnus-article-prepare-hook
9626 @item gnus-article-prepare-hook
9627 This hook is called right after the article has been inserted into the
9628 article buffer. It is mainly intended for functions that do something
9629 depending on the contents; it should probably not be used for changing
9630 the contents of the article buffer.
9632 @item gnus-article-mode-hook
9633 @vindex gnus-article-mode-hook
9634 Hook called in article mode buffers.
9636 @item gnus-article-mode-syntax-table
9637 @vindex gnus-article-mode-syntax-table
9638 Syntax table used in article buffers. It is initialized from
9639 @code{text-mode-syntax-table}.
9641 @vindex gnus-article-mode-line-format
9642 @item gnus-article-mode-line-format
9643 This variable is a format string along the same lines as
9644 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}). It
9645 accepts the same format specifications as that variable, with two
9650 The @dfn{wash status} of the article. This is a short string with one
9651 character for each possible article wash operation that may have been
9654 The number of @sc{mime} parts in the article.
9657 @vindex gnus-break-pages
9659 @item gnus-break-pages
9660 Controls whether @dfn{page breaking} is to take place. If this variable
9661 is non-@code{nil}, the articles will be divided into pages whenever a
9662 page delimiter appears in the article. If this variable is @code{nil},
9663 paging will not be done.
9665 @item gnus-page-delimiter
9666 @vindex gnus-page-delimiter
9667 This is the delimiter mentioned above. By default, it is @samp{^L}
9672 @node Composing Messages
9673 @chapter Composing Messages
9674 @cindex composing messages
9677 @cindex sending mail
9683 @kindex C-c C-c (Post)
9684 All commands for posting and mailing will put you in a message buffer
9685 where you can edit the article all you like, before you send the
9686 article by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The
9687 Message Manual}. Where the message will be posted/mailed to depends
9688 on your setup (@pxref{Posting Server}).
9691 * Mail:: Mailing and replying.
9692 * Posting Server:: What server should you post via?
9693 * Mail and Post:: Mailing and posting at the same time.
9694 * Archived Messages:: Where Gnus stores the messages you've sent.
9695 * Posting Styles:: An easier way to specify who you are.
9696 * Drafts:: Postponing messages and rejected messages.
9697 * Rejected Articles:: What happens if the server doesn't like your article?
9698 * Using GPG:: How to use GPG and MML to sign and encrypt messages
9701 Also see @pxref{Canceling and Superseding} for information on how to
9702 remove articles you shouldn't have posted.
9708 Variables for customizing outgoing mail:
9711 @item gnus-uu-digest-headers
9712 @vindex gnus-uu-digest-headers
9713 List of regexps to match headers included in digested messages. The
9714 headers will be included in the sequence they are matched.
9716 @item gnus-add-to-list
9717 @vindex gnus-add-to-list
9718 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
9719 that have none when you do a @kbd{a}.
9724 @node Posting Server
9725 @section Posting Server
9727 When you press those magical @kbd{C-c C-c} keys to ship off your latest
9728 (extremely intelligent, of course) article, where does it go?
9730 Thank you for asking. I hate you.
9732 @vindex gnus-post-method
9734 It can be quite complicated. Normally, Gnus will post using the same
9735 select method as you're reading from (which might be convenient if
9736 you're reading lots of groups from different private servers).
9737 However. If the server you're reading from doesn't allow posting,
9738 just reading, you probably want to use some other server to post your
9739 (extremely intelligent and fabulously interesting) articles. You can
9740 then set the @code{gnus-post-method} to some other method:
9743 (setq gnus-post-method '(nnspool ""))
9746 Now, if you've done this, and then this server rejects your article, or
9747 this server is down, what do you do then? To override this variable you
9748 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
9749 the ``current'' server, to get back the default behaviour, for posting.
9751 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
9752 Gnus will prompt you for what method to use for posting.
9754 You can also set @code{gnus-post-method} to a list of select methods.
9755 If that's the case, Gnus will always prompt you for what method to use
9758 Finally, if you want to always post using the native select method,
9759 you can set this variable to @code{nil}.
9763 @section Mail and Post
9765 Here's a list of variables relevant to both mailing and
9769 @item gnus-mailing-list-groups
9770 @findex gnus-mailing-list-groups
9771 @cindex mailing lists
9773 If your news server offers groups that are really mailing lists
9774 gatewayed to the @sc{nntp} server, you can read those groups without
9775 problems, but you can't post/followup to them without some difficulty.
9776 One solution is to add a @code{to-address} to the group parameters
9777 (@pxref{Group Parameters}). An easier thing to do is set the
9778 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
9779 really are mailing lists. Then, at least, followups to the mailing
9780 lists will work most of the time. Posting to these groups (@kbd{a}) is
9781 still a pain, though.
9785 You may want to do spell-checking on messages that you send out. Or, if
9786 you don't want to spell-check by hand, you could add automatic
9787 spell-checking via the @code{ispell} package:
9790 @findex ispell-message
9792 (add-hook 'message-send-hook 'ispell-message)
9795 If you want to change the @code{ispell} dictionary based on what group
9796 you're in, you could say something like the following:
9799 (add-hook 'gnus-select-group-hook
9803 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
9804 (ispell-change-dictionary "deutsch"))
9806 (ispell-change-dictionary "english")))))
9809 Modify to suit your needs.
9812 @node Archived Messages
9813 @section Archived Messages
9814 @cindex archived messages
9815 @cindex sent messages
9817 Gnus provides a few different methods for storing the mail and news you
9818 send. The default method is to use the @dfn{archive virtual server} to
9819 store the messages. If you want to disable this completely, the
9820 @code{gnus-message-archive-group} variable should be @code{nil}, which
9823 @vindex gnus-message-archive-method
9824 @code{gnus-message-archive-method} says what virtual server Gnus is to
9825 use to store sent messages. The default is:
9829 (nnfolder-directory "~/Mail/archive")
9830 (nnfolder-active-file "~/Mail/archive/active")
9831 (nnfolder-get-new-mail nil)
9832 (nnfolder-inhibit-expiry t))
9835 You can, however, use any mail select method (@code{nnml},
9836 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
9837 for doing this sort of thing, though. If you don't like the default
9838 directory chosen, you could say something like:
9841 (setq gnus-message-archive-method
9842 '(nnfolder "archive"
9843 (nnfolder-inhibit-expiry t)
9844 (nnfolder-active-file "~/News/sent-mail/active")
9845 (nnfolder-directory "~/News/sent-mail/")))
9848 @vindex gnus-message-archive-group
9850 Gnus will insert @code{Gcc} headers in all outgoing messages that point
9851 to one or more group(s) on that server. Which group to use is
9852 determined by the @code{gnus-message-archive-group} variable.
9854 This variable can be used to do the following:
9858 Messages will be saved in that group.
9860 Note that you can include a select method in the group name, then the
9861 message will not be stored in the select method given by
9862 @code{gnus-message-archive-method}, but in the select method specified
9863 by the group name, instead. Suppose @code{gnus-message-archive-method}
9864 has the default value shown above. Then setting
9865 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
9866 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
9867 value @code{"nnml:foo"}, then outgoing messages will be stored in
9869 @item a list of strings
9870 Messages will be saved in all those groups.
9871 @item an alist of regexps, functions and forms
9872 When a key ``matches'', the result is used.
9874 No message archiving will take place. This is the default.
9879 Just saving to a single group called @samp{MisK}:
9881 (setq gnus-message-archive-group "MisK")
9884 Saving to two groups, @samp{MisK} and @samp{safe}:
9886 (setq gnus-message-archive-group '("MisK" "safe"))
9889 Save to different groups based on what group you are in:
9891 (setq gnus-message-archive-group
9892 '(("^alt" "sent-to-alt")
9893 ("mail" "sent-to-mail")
9894 (".*" "sent-to-misc")))
9899 (setq gnus-message-archive-group
9900 '((if (message-news-p)
9905 How about storing all news messages in one file, but storing all mail
9906 messages in one file per month:
9909 (setq gnus-message-archive-group
9910 '((if (message-news-p)
9912 (concat "mail." (format-time-string "%Y-%m")))))
9915 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
9916 use a different value for @code{gnus-message-archive-group} there.)
9918 Now, when you send a message off, it will be stored in the appropriate
9919 group. (If you want to disable storing for just one particular message,
9920 you can just remove the @code{Gcc} header that has been inserted.) The
9921 archive group will appear in the group buffer the next time you start
9922 Gnus, or the next time you press @kbd{F} in the group buffer. You can
9923 enter it and read the articles in it just like you'd read any other
9924 group. If the group gets really big and annoying, you can simply rename
9925 if (using @kbd{G r} in the group buffer) to something
9926 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
9927 continue to be stored in the old (now empty) group.
9929 That's the default method of archiving sent messages. Gnus offers a
9930 different way for the people who don't like the default method. In that
9931 case you should set @code{gnus-message-archive-group} to @code{nil};
9932 this will disable archiving.
9935 @item gnus-outgoing-message-group
9936 @vindex gnus-outgoing-message-group
9937 All outgoing messages will be put in this group. If you want to store
9938 all your outgoing mail and articles in the group @samp{nnml:archive},
9939 you set this variable to that value. This variable can also be a list of
9942 If you want to have greater control over what group to put each
9943 message in, you can set this variable to a function that checks the
9944 current newsgroup name and then returns a suitable group name (or list
9947 This variable can be used instead of @code{gnus-message-archive-group},
9948 but the latter is the preferred method.
9950 @item gnus-inews-mark-gcc-as-read
9951 @vindex gnus-inews-mark-gcc-as-read
9952 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
9957 @node Posting Styles
9958 @section Posting Styles
9959 @cindex posting styles
9962 All them variables, they make my head swim.
9964 So what if you want a different @code{Organization} and signature based
9965 on what groups you post to? And you post both from your home machine
9966 and your work machine, and you want different @code{From} lines, and so
9969 @vindex gnus-posting-styles
9970 One way to do stuff like that is to write clever hooks that change the
9971 variables you need to have changed. That's a bit boring, so somebody
9972 came up with the bright idea of letting the user specify these things in
9973 a handy alist. Here's an example of a @code{gnus-posting-styles}
9978 (signature "Peace and happiness")
9979 (organization "What me?"))
9981 (signature "Death to everybody"))
9982 ("comp.emacs.i-love-it"
9983 (organization "Emacs is it")))
9986 As you might surmise from this example, this alist consists of several
9987 @dfn{styles}. Each style will be applicable if the first element
9988 ``matches'', in some form or other. The entire alist will be iterated
9989 over, from the beginning towards the end, and each match will be
9990 applied, which means that attributes in later styles that match override
9991 the same attributes in earlier matching styles. So
9992 @samp{comp.programming.literate} will have the @samp{Death to everybody}
9993 signature and the @samp{What me?} @code{Organization} header.
9995 The first element in each style is called the @code{match}. If it's a
9996 string, then Gnus will try to regexp match it against the group name.
9997 If it is the symbol @code{header}, then Gnus will look for header (the
9998 next element in the match) in the original article , and compare that to
9999 the last regexp in the match. If it's a function symbol, that function
10000 will be called with no arguments. If it's a variable symbol, then the
10001 variable will be referenced. If it's a list, then that list will be
10002 @code{eval}ed. In any case, if this returns a non-@code{nil} value,
10003 then the style is said to @dfn{match}.
10005 Each style may contain a arbitrary amount of @dfn{attributes}. Each
10006 attribute consists of a @code{(@var{name} @var{value})} pair. The
10007 attribute name can be one of @code{signature}, @code{signature-file},
10008 @code{organization}, @code{address}, @code{name} or @code{body}. The
10009 attribute name can also be a string. In that case, this will be used as
10010 a header name, and the value will be inserted in the headers of the
10011 article; if the value is @code{nil}, the header name will be removed.
10012 If the attribute name is @code{eval}, the form is evaluated, and the
10013 result is thrown away.
10015 The attribute value can be a string (used verbatim), a function with
10016 zero arguments (the return value will be used), a variable (its value
10017 will be used) or a list (it will be @code{eval}ed and the return value
10018 will be used). The functions and sexps are called/@code{eval}ed in the
10019 message buffer that is being set up. The headers of the current article
10020 are available through the @code{message-reply-headers} variable.
10022 If you wish to check whether the message you are about to compose is
10023 meant to be a news article or a mail message, you can check the values
10024 of the @code{message-news-p} and @code{message-mail-p} functions.
10026 @findex message-mail-p
10027 @findex message-news-p
10029 So here's a new example:
10032 (setq gnus-posting-styles
10034 (signature-file "~/.signature")
10036 ("X-Home-Page" (getenv "WWW_HOME"))
10037 (organization "People's Front Against MWM"))
10039 (signature my-funny-signature-randomizer))
10040 ((equal (system-name) "gnarly")
10041 (signature my-quote-randomizer))
10043 (signature my-news-signature))
10044 (header "to" "larsi.*org"
10045 (Organization "Somewhere, Inc."))
10046 ((posting-from-work-p)
10047 (signature-file "~/.work-signature")
10048 (address "user@@bar.foo")
10049 (body "You are fired.\n\nSincerely, your boss.")
10050 (organization "Important Work, Inc"))
10052 (From (save-excursion
10053 (set-buffer gnus-article-buffer)
10054 (message-fetch-field "to"))))
10056 (signature-file "~/.mail-signature"))))
10059 The @samp{nnml:.*} rule means that you use the @code{To} address as the
10060 @code{From} address in all your outgoing replies, which might be handy
10061 if you fill many roles.
10068 If you are writing a message (mail or news) and suddenly remember that
10069 you have a steak in the oven (or some pesto in the food processor, you
10070 craaazy vegetarians), you'll probably wish there was a method to save
10071 the message you are writing so that you can continue editing it some
10072 other day, and send it when you feel its finished.
10074 Well, don't worry about it. Whenever you start composing a message of
10075 some sort using the Gnus mail and post commands, the buffer you get will
10076 automatically associate to an article in a special @dfn{draft} group.
10077 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
10078 article will be saved there. (Auto-save files also go to the draft
10082 @vindex nndraft-directory
10083 The draft group is a special group (which is implemented as an
10084 @code{nndraft} group, if you absolutely have to know) called
10085 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
10086 @code{nndraft} is to store its files. What makes this group special is
10087 that you can't tick any articles in it or mark any articles as
10088 read---all articles in the group are permanently unread.
10090 If the group doesn't exist, it will be created and you'll be subscribed
10091 to it. The only way to make it disappear from the Group buffer is to
10094 @c @findex gnus-dissociate-buffer-from-draft
10095 @c @kindex C-c M-d (Mail)
10096 @c @kindex C-c M-d (Post)
10097 @c @findex gnus-associate-buffer-with-draft
10098 @c @kindex C-c C-d (Mail)
10099 @c @kindex C-c C-d (Post)
10100 @c If you're writing some super-secret message that you later want to
10101 @c encode with PGP before sending, you may wish to turn the auto-saving
10102 @c (and association with the draft group) off. You never know who might be
10103 @c interested in reading all your extremely valuable and terribly horrible
10104 @c and interesting secrets. The @kbd{C-c M-d}
10105 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
10106 @c If you change your mind and want to turn the auto-saving back on again,
10107 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
10109 @c @vindex gnus-use-draft
10110 @c To leave association with the draft group off by default, set
10111 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
10113 @findex gnus-draft-edit-message
10114 @kindex D e (Draft)
10115 When you want to continue editing the article, you simply enter the
10116 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
10117 that. You will be placed in a buffer where you left off.
10119 Rejected articles will also be put in this draft group (@pxref{Rejected
10122 @findex gnus-draft-send-all-messages
10123 @findex gnus-draft-send-message
10124 If you have lots of rejected messages you want to post (or mail) without
10125 doing further editing, you can use the @kbd{D s} command
10126 (@code{gnus-draft-send-message}). This command understands the
10127 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
10128 command (@code{gnus-draft-send-all-messages}) will ship off all messages
10131 If you have some messages that you wish not to send, you can use the
10132 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
10133 as unsendable. This is a toggling command.
10136 @node Rejected Articles
10137 @section Rejected Articles
10138 @cindex rejected articles
10140 Sometimes a news server will reject an article. Perhaps the server
10141 doesn't like your face. Perhaps it just feels miserable. Perhaps
10142 @emph{there be demons}. Perhaps you have included too much cited text.
10143 Perhaps the disk is full. Perhaps the server is down.
10145 These situations are, of course, totally beyond the control of Gnus.
10146 (Gnus, of course, loves the way you look, always feels great, has angels
10147 fluttering around inside of it, doesn't care about how much cited text
10148 you include, never runs full and never goes down.) So Gnus saves these
10149 articles until some later time when the server feels better.
10151 The rejected articles will automatically be put in a special draft group
10152 (@pxref{Drafts}). When the server comes back up again, you'd then
10153 typically enter that group and send all the articles off.
10159 Gnus has an ALPHA support to GPG that's provided by @file{gpg.el}. See
10160 @code{mm-verify-option} and @code{mm-decrypt-option} to enable Gnus to
10161 verify or decrypt messages accordingly.
10163 To use this correctly with GPG, you'll need the following lisp code in your
10164 @file{~/.emacs} or @file{~/.gnus}:
10168 (setq mml2015-use 'gpg)
10169 (setq gpg-temp-directory (expand-file-name "~/.gnupg/tmp"))
10172 The @code{gpg-temp-directory} need to point to a directory with permissions set
10173 to 700, for your own safety.
10175 If you want to benefit of PGP2.6 compatibility, you might create a script named
10176 @file{gpg-2comp} with these instructions:
10180 exec gpg --rfc1991 "$@@"
10183 If you don't want to use such compatibility, you can add the following line to
10184 your @file{~/.emacs} or @file{~/.gnus}:
10187 (setq gpg-command-default-alist (quote ((gpg . "gpg") (gpg-2comp . "gpg"))))
10190 To sign or encrypt your message you may choose to use the MML Security
10191 menu or @kbd{C-c C-m s p} to sign your message using PGP/MIME, @kbd{C-c
10192 C-m s s} to sign your message using S/MIME. There's also @kbd{C-c C-m c
10193 p} to encrypt your message with PGP/MIME and @kbd{C-c C-m c s} to
10194 encrypt using S/MIME.
10196 Gnus will ask for your passphrase and then it will send your message, if
10197 you've typed it correctly.
10199 @node Select Methods
10200 @chapter Select Methods
10201 @cindex foreign groups
10202 @cindex select methods
10204 A @dfn{foreign group} is a group not read by the usual (or
10205 default) means. It could be, for instance, a group from a different
10206 @sc{nntp} server, it could be a virtual group, or it could be your own
10207 personal mail group.
10209 A foreign group (or any group, really) is specified by a @dfn{name} and
10210 a @dfn{select method}. To take the latter first, a select method is a
10211 list where the first element says what backend to use (e.g. @code{nntp},
10212 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
10213 name}. There may be additional elements in the select method, where the
10214 value may have special meaning for the backend in question.
10216 One could say that a select method defines a @dfn{virtual server}---so
10217 we do just that (@pxref{Server Buffer}).
10219 The @dfn{name} of the group is the name the backend will recognize the
10222 For instance, the group @samp{soc.motss} on the @sc{nntp} server
10223 @samp{some.where.edu} will have the name @samp{soc.motss} and select
10224 method @code{(nntp "some.where.edu")}. Gnus will call this group
10225 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
10226 backend just knows this group as @samp{soc.motss}.
10228 The different methods all have their peculiarities, of course.
10231 * Server Buffer:: Making and editing virtual servers.
10232 * Getting News:: Reading USENET news with Gnus.
10233 * Getting Mail:: Reading your personal mail with Gnus.
10234 * Browsing the Web:: Getting messages from a plethora of Web sources.
10235 * Other Sources:: Reading directories, files, SOUP packets.
10236 * Combined Groups:: Combining groups into one group.
10237 * Gnus Unplugged:: Reading news and mail offline.
10241 @node Server Buffer
10242 @section Server Buffer
10244 Traditionally, a @dfn{server} is a machine or a piece of software that
10245 one connects to, and then requests information from. Gnus does not
10246 connect directly to any real servers, but does all transactions through
10247 one backend or other. But that's just putting one layer more between
10248 the actual media and Gnus, so we might just as well say that each
10249 backend represents a virtual server.
10251 For instance, the @code{nntp} backend may be used to connect to several
10252 different actual @sc{nntp} servers, or, perhaps, to many different ports
10253 on the same actual @sc{nntp} server. You tell Gnus which backend to
10254 use, and what parameters to set by specifying a @dfn{select method}.
10256 These select method specifications can sometimes become quite
10257 complicated---say, for instance, that you want to read from the
10258 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
10259 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
10260 Anyway, if you had to specify that for each group that used this
10261 server, that would be too much work, so Gnus offers a way of naming
10262 select methods, which is what you do in the server buffer.
10264 To enter the server buffer, use the @kbd{^}
10265 (@code{gnus-group-enter-server-mode}) command in the group buffer.
10268 * Server Buffer Format:: You can customize the look of this buffer.
10269 * Server Commands:: Commands to manipulate servers.
10270 * Example Methods:: Examples server specifications.
10271 * Creating a Virtual Server:: An example session.
10272 * Server Variables:: Which variables to set.
10273 * Servers and Methods:: You can use server names as select methods.
10274 * Unavailable Servers:: Some servers you try to contact may be down.
10277 @vindex gnus-server-mode-hook
10278 @code{gnus-server-mode-hook} is run when creating the server buffer.
10281 @node Server Buffer Format
10282 @subsection Server Buffer Format
10283 @cindex server buffer format
10285 @vindex gnus-server-line-format
10286 You can change the look of the server buffer lines by changing the
10287 @code{gnus-server-line-format} variable. This is a @code{format}-like
10288 variable, with some simple extensions:
10293 How the news is fetched---the backend name.
10296 The name of this server.
10299 Where the news is to be fetched from---the address.
10302 The opened/closed/denied status of the server.
10305 @vindex gnus-server-mode-line-format
10306 The mode line can also be customized by using the
10307 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
10308 Formatting}). The following specs are understood:
10318 Also @pxref{Formatting Variables}.
10321 @node Server Commands
10322 @subsection Server Commands
10323 @cindex server commands
10329 @findex gnus-server-add-server
10330 Add a new server (@code{gnus-server-add-server}).
10334 @findex gnus-server-edit-server
10335 Edit a server (@code{gnus-server-edit-server}).
10338 @kindex SPACE (Server)
10339 @findex gnus-server-read-server
10340 Browse the current server (@code{gnus-server-read-server}).
10344 @findex gnus-server-exit
10345 Return to the group buffer (@code{gnus-server-exit}).
10349 @findex gnus-server-kill-server
10350 Kill the current server (@code{gnus-server-kill-server}).
10354 @findex gnus-server-yank-server
10355 Yank the previously killed server (@code{gnus-server-yank-server}).
10359 @findex gnus-server-copy-server
10360 Copy the current server (@code{gnus-server-copy-server}).
10364 @findex gnus-server-list-servers
10365 List all servers (@code{gnus-server-list-servers}).
10369 @findex gnus-server-scan-server
10370 Request that the server scan its sources for new articles
10371 (@code{gnus-server-scan-server}). This is mainly sensible with mail
10376 @findex gnus-server-regenerate-server
10377 Request that the server regenerate all its data structures
10378 (@code{gnus-server-regenerate-server}). This can be useful if you have
10379 a mail backend that has gotten out of sync.
10384 @node Example Methods
10385 @subsection Example Methods
10387 Most select methods are pretty simple and self-explanatory:
10390 (nntp "news.funet.fi")
10393 Reading directly from the spool is even simpler:
10399 As you can see, the first element in a select method is the name of the
10400 backend, and the second is the @dfn{address}, or @dfn{name}, if you
10403 After these two elements, there may be an arbitrary number of
10404 @code{(@var{variable} @var{form})} pairs.
10406 To go back to the first example---imagine that you want to read from
10407 port 15 on that machine. This is what the select method should
10411 (nntp "news.funet.fi" (nntp-port-number 15))
10414 You should read the documentation to each backend to find out what
10415 variables are relevant, but here's an @code{nnmh} example:
10417 @code{nnmh} is a mail backend that reads a spool-like structure. Say
10418 you have two structures that you wish to access: One is your private
10419 mail spool, and the other is a public one. Here's the possible spec for
10423 (nnmh "private" (nnmh-directory "~/private/mail/"))
10426 (This server is then called @samp{private}, but you may have guessed
10429 Here's the method for a public spool:
10433 (nnmh-directory "/usr/information/spool/")
10434 (nnmh-get-new-mail nil))
10440 If you are behind a firewall and only have access to the @sc{nntp}
10441 server from the firewall machine, you can instruct Gnus to @code{rlogin}
10442 on the firewall machine and telnet from there to the @sc{nntp} server.
10443 Doing this can be rather fiddly, but your virtual server definition
10444 should probably look something like this:
10448 (nntp-address "the.firewall.machine")
10449 (nntp-open-connection-function nntp-open-rlogin)
10450 (nntp-end-of-line "\n")
10451 (nntp-rlogin-parameters
10452 ("telnet" "the.real.nntp.host" "nntp")))
10455 If you want to use the wonderful @code{ssh} program to provide a
10456 compressed connection over the modem line, you could create a virtual
10457 server that would look something like this:
10461 (nntp-address "copper.uio.no")
10462 (nntp-rlogin-program "ssh")
10463 (nntp-open-connection-function nntp-open-rlogin)
10464 (nntp-end-of-line "\n")
10465 (nntp-rlogin-parameters
10466 ("telnet" "news.uio.no" "nntp")))
10469 This means that you have to have set up @code{ssh-agent} correctly to
10470 provide automatic authorization, of course. And to get a compressed
10471 connection, you have to have the @samp{Compression} option in the
10472 @code{ssh} @file{config} file.
10475 @node Creating a Virtual Server
10476 @subsection Creating a Virtual Server
10478 If you're saving lots of articles in the cache by using persistent
10479 articles, you may want to create a virtual server to read the cache.
10481 First you need to add a new server. The @kbd{a} command does that. It
10482 would probably be best to use @code{nnspool} to read the cache. You
10483 could also use @code{nnml} or @code{nnmh}, though.
10485 Type @kbd{a nnspool RET cache RET}.
10487 You should now have a brand new @code{nnspool} virtual server called
10488 @samp{cache}. You now need to edit it to have the right definitions.
10489 Type @kbd{e} to edit the server. You'll be entered into a buffer that
10490 will contain the following:
10500 (nnspool-spool-directory "~/News/cache/")
10501 (nnspool-nov-directory "~/News/cache/")
10502 (nnspool-active-file "~/News/cache/active"))
10505 Type @kbd{C-c C-c} to return to the server buffer. If you now press
10506 @kbd{RET} over this virtual server, you should be entered into a browse
10507 buffer, and you should be able to enter any of the groups displayed.
10510 @node Server Variables
10511 @subsection Server Variables
10513 One sticky point when defining variables (both on backends and in Emacs
10514 in general) is that some variables are typically initialized from other
10515 variables when the definition of the variables is being loaded. If you
10516 change the "base" variable after the variables have been loaded, you
10517 won't change the "derived" variables.
10519 This typically affects directory and file variables. For instance,
10520 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
10521 directory variables are initialized from that variable, so
10522 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
10523 new virtual @code{nnml} server, it will @emph{not} suffice to set just
10524 @code{nnml-directory}---you have to explicitly set all the file
10525 variables to be what you want them to be. For a complete list of
10526 variables for each backend, see each backend's section later in this
10527 manual, but here's an example @code{nnml} definition:
10531 (nnml-directory "~/my-mail/")
10532 (nnml-active-file "~/my-mail/active")
10533 (nnml-newsgroups-file "~/my-mail/newsgroups"))
10537 @node Servers and Methods
10538 @subsection Servers and Methods
10540 Wherever you would normally use a select method
10541 (e.g. @code{gnus-secondary-select-method}, in the group select method,
10542 when browsing a foreign server) you can use a virtual server name
10543 instead. This could potentially save lots of typing. And it's nice all
10547 @node Unavailable Servers
10548 @subsection Unavailable Servers
10550 If a server seems to be unreachable, Gnus will mark that server as
10551 @code{denied}. That means that any subsequent attempt to make contact
10552 with that server will just be ignored. ``It can't be opened,'' Gnus
10553 will tell you, without making the least effort to see whether that is
10554 actually the case or not.
10556 That might seem quite naughty, but it does make sense most of the time.
10557 Let's say you have 10 groups subscribed to on server
10558 @samp{nephelococcygia.com}. This server is located somewhere quite far
10559 away from you and the machine is quite slow, so it takes 1 minute just
10560 to find out that it refuses connection to you today. If Gnus were to
10561 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
10562 attempt to do that. Once it has gotten a single ``connection refused'',
10563 it will regard that server as ``down''.
10565 So, what happens if the machine was only feeling unwell temporarily?
10566 How do you test to see whether the machine has come up again?
10568 You jump to the server buffer (@pxref{Server Buffer}) and poke it
10569 with the following commands:
10575 @findex gnus-server-open-server
10576 Try to establish connection to the server on the current line
10577 (@code{gnus-server-open-server}).
10581 @findex gnus-server-close-server
10582 Close the connection (if any) to the server
10583 (@code{gnus-server-close-server}).
10587 @findex gnus-server-deny-server
10588 Mark the current server as unreachable
10589 (@code{gnus-server-deny-server}).
10592 @kindex M-o (Server)
10593 @findex gnus-server-open-all-servers
10594 Open the connections to all servers in the buffer
10595 (@code{gnus-server-open-all-servers}).
10598 @kindex M-c (Server)
10599 @findex gnus-server-close-all-servers
10600 Close the connections to all servers in the buffer
10601 (@code{gnus-server-close-all-servers}).
10605 @findex gnus-server-remove-denials
10606 Remove all marks to whether Gnus was denied connection from any servers
10607 (@code{gnus-server-remove-denials}).
10613 @section Getting News
10614 @cindex reading news
10615 @cindex news backends
10617 A newsreader is normally used for reading news. Gnus currently provides
10618 only two methods of getting news---it can read from an @sc{nntp} server,
10619 or it can read from a local spool.
10622 * NNTP:: Reading news from an @sc{nntp} server.
10623 * News Spool:: Reading news from the local spool.
10628 @subsection @sc{nntp}
10631 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
10632 You just specify @code{nntp} as method and the address of the @sc{nntp}
10633 server as the, uhm, address.
10635 If the @sc{nntp} server is located at a non-standard port, setting the
10636 third element of the select method to this port number should allow you
10637 to connect to the right port. You'll have to edit the group info for
10638 that (@pxref{Foreign Groups}).
10640 The name of the foreign group can be the same as a native group. In
10641 fact, you can subscribe to the same group from as many different servers
10642 you feel like. There will be no name collisions.
10644 The following variables can be used to create a virtual @code{nntp}
10649 @item nntp-server-opened-hook
10650 @vindex nntp-server-opened-hook
10651 @cindex @sc{mode reader}
10653 @cindex authentification
10654 @cindex nntp authentification
10655 @findex nntp-send-authinfo
10656 @findex nntp-send-mode-reader
10657 is run after a connection has been made. It can be used to send
10658 commands to the @sc{nntp} server after it has been contacted. By
10659 default it sends the command @code{MODE READER} to the server with the
10660 @code{nntp-send-mode-reader} function. This function should always be
10661 present in this hook.
10663 @item nntp-authinfo-function
10664 @vindex nntp-authinfo-function
10665 @findex nntp-send-authinfo
10666 @vindex nntp-authinfo-file
10667 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
10668 server. The default function is @code{nntp-send-authinfo}, which looks
10669 through your @file{~/.authinfo} (or whatever you've set the
10670 @code{nntp-authinfo-file} variable to) for applicable entries. If none
10671 are found, it will prompt you for a login name and a password. The
10672 format of the @file{~/.authinfo} file is (almost) the same as the
10673 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
10674 manual page, but here are the salient facts:
10678 The file contains one or more line, each of which define one server.
10681 Each line may contain an arbitrary number of token/value pairs.
10683 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
10684 @samp{default}. In addition Gnus introduces two new tokens, not present
10685 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
10686 @samp{force}. (This is the only way the @file{.authinfo} file format
10687 deviates from the @file{.netrc} file format.) @samp{port} is used to
10688 indicate what port on the server the credentials apply to and
10689 @samp{force} is explained below.
10693 Here's an example file:
10696 machine news.uio.no login larsi password geheimnis
10697 machine nntp.ifi.uio.no login larsi force yes
10700 The token/value pairs may appear in any order; @samp{machine} doesn't
10701 have to be first, for instance.
10703 In this example, both login name and password have been supplied for the
10704 former server, while the latter has only the login name listed, and the
10705 user will be prompted for the password. The latter also has the
10706 @samp{force} tag, which means that the authinfo will be sent to the
10707 @var{nntp} server upon connection; the default (i.e., when there is not
10708 @samp{force} tag) is to not send authinfo to the @var{nntp} server
10709 until the @var{nntp} server asks for it.
10711 You can also add @samp{default} lines that will apply to all servers
10712 that don't have matching @samp{machine} lines.
10718 This will force sending @samp{AUTHINFO} commands to all servers not
10719 previously mentioned.
10721 Remember to not leave the @file{~/.authinfo} file world-readable.
10723 @item nntp-server-action-alist
10724 @vindex nntp-server-action-alist
10725 This is a list of regexps to match on server types and actions to be
10726 taken when matches are made. For instance, if you want Gnus to beep
10727 every time you connect to innd, you could say something like:
10730 (setq nntp-server-action-alist
10731 '(("innd" (ding))))
10734 You probably don't want to do that, though.
10736 The default value is
10739 '(("nntpd 1\\.5\\.11t"
10740 (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
10743 This ensures that Gnus doesn't send the @code{MODE READER} command to
10744 nntpd 1.5.11t, since that command chokes that server, I've been told.
10746 @item nntp-maximum-request
10747 @vindex nntp-maximum-request
10748 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
10749 will collect headers by sending a series of @code{head} commands. To
10750 speed things up, the backend sends lots of these commands without
10751 waiting for reply, and then reads all the replies. This is controlled
10752 by the @code{nntp-maximum-request} variable, and is 400 by default. If
10753 your network is buggy, you should set this to 1.
10755 @item nntp-connection-timeout
10756 @vindex nntp-connection-timeout
10757 If you have lots of foreign @code{nntp} groups that you connect to
10758 regularly, you're sure to have problems with @sc{nntp} servers not
10759 responding properly, or being too loaded to reply within reasonable
10760 time. This is can lead to awkward problems, which can be helped
10761 somewhat by setting @code{nntp-connection-timeout}. This is an integer
10762 that says how many seconds the @code{nntp} backend should wait for a
10763 connection before giving up. If it is @code{nil}, which is the default,
10764 no timeouts are done.
10766 @c @item nntp-command-timeout
10767 @c @vindex nntp-command-timeout
10768 @c @cindex PPP connections
10769 @c @cindex dynamic IP addresses
10770 @c If you're running Gnus on a machine that has a dynamically assigned
10771 @c address, Gnus may become confused. If the address of your machine
10772 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
10773 @c waiting forever for replies from the server. To help with this
10774 @c unfortunate problem, you can set this command to a number. Gnus will
10775 @c then, if it sits waiting for a reply from the server longer than that
10776 @c number of seconds, shut down the connection, start a new one, and resend
10777 @c the command. This should hopefully be transparent to the user. A
10778 @c likely number is 30 seconds.
10780 @c @item nntp-retry-on-break
10781 @c @vindex nntp-retry-on-break
10782 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
10783 @c hangs. This will have much the same effect as the command timeout
10784 @c described above.
10786 @item nntp-server-hook
10787 @vindex nntp-server-hook
10788 This hook is run as the last step when connecting to an @sc{nntp}
10791 @findex nntp-open-rlogin
10792 @findex nntp-open-telnet
10793 @findex nntp-open-network-stream
10794 @item nntp-open-connection-function
10795 @vindex nntp-open-connection-function
10796 This function is used to connect to the remote system. Four pre-made
10797 functions are supplied:
10800 @item nntp-open-network-stream
10801 This is the default, and simply connects to some port or other on the
10804 @item nntp-open-rlogin
10805 Does an @samp{rlogin} on the
10806 remote system, and then does a @samp{telnet} to the @sc{nntp} server
10809 @code{nntp-open-rlogin}-related variables:
10813 @item nntp-rlogin-program
10814 @vindex nntp-rlogin-program
10815 Program used to log in on remote machines. The default is @samp{rsh},
10816 but @samp{ssh} is a popular alternative.
10818 @item nntp-rlogin-parameters
10819 @vindex nntp-rlogin-parameters
10820 This list will be used as the parameter list given to @code{rsh}.
10822 @item nntp-rlogin-user-name
10823 @vindex nntp-rlogin-user-name
10824 User name on the remote system.
10828 @item nntp-open-telnet
10829 Does a @samp{telnet} to the remote system and then another @samp{telnet}
10830 to get to the @sc{nntp} server.
10832 @code{nntp-open-telnet}-related variables:
10835 @item nntp-telnet-command
10836 @vindex nntp-telnet-command
10837 Command used to start @code{telnet}.
10839 @item nntp-telnet-switches
10840 @vindex nntp-telnet-switches
10841 List of strings to be used as the switches to the @code{telnet} command.
10843 @item nntp-telnet-user-name
10844 @vindex nntp-telnet-user-name
10845 User name for log in on the remote system.
10847 @item nntp-telnet-passwd
10848 @vindex nntp-telnet-passwd
10849 Password to use when logging in.
10851 @item nntp-telnet-parameters
10852 @vindex nntp-telnet-parameters
10853 A list of strings executed as a command after logging in
10856 @item nntp-telnet-shell-prompt
10857 @vindex nntp-telnet-shell-prompt
10858 Regexp matching the shell prompt on the remote machine. The default is
10859 @samp{bash\\|\$ *\r?$\\|> *\r?}.
10861 @item nntp-open-telnet-envuser
10862 @vindex nntp-open-telnet-envuser
10863 If non-@code{nil}, the @code{telnet} session (client and server both)
10864 will support the @code{ENVIRON} option and not prompt for login name.
10865 This works for Solaris @code{telnet}, for instance.
10869 @findex nntp-open-ssl-stream
10870 @item nntp-open-ssl-stream
10871 Opens a connection to a server over a @dfn{secure} channel. To use this
10872 you must have SSLay installed
10873 (@uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
10874 @file{ssl.el} (from the W3 distribution, for instance). You then
10875 define a server as follows:
10878 ;; Type `C-c C-c' after you've finished editing.
10880 ;; "snews" is port 563 and is predefined in our /etc/services
10882 (nntp "snews.bar.com"
10883 (nntp-open-connection-function nntp-open-ssl-stream)
10884 (nntp-port-number "snews")
10885 (nntp-address "snews.bar.com"))
10890 @item nntp-end-of-line
10891 @vindex nntp-end-of-line
10892 String to use as end-of-line marker when talking to the @sc{nntp}
10893 server. This is @samp{\r\n} by default, but should be @samp{\n} when
10894 using @code{rlogin} to talk to the server.
10896 @item nntp-rlogin-user-name
10897 @vindex nntp-rlogin-user-name
10898 User name on the remote system when using the @code{rlogin} connect
10902 @vindex nntp-address
10903 The address of the remote system running the @sc{nntp} server.
10905 @item nntp-port-number
10906 @vindex nntp-port-number
10907 Port number to connect to when using the @code{nntp-open-network-stream}
10910 @item nntp-buggy-select
10911 @vindex nntp-buggy-select
10912 Set this to non-@code{nil} if your select routine is buggy.
10914 @item nntp-nov-is-evil
10915 @vindex nntp-nov-is-evil
10916 If the @sc{nntp} server does not support @sc{nov}, you could set this
10917 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
10920 @item nntp-xover-commands
10921 @vindex nntp-xover-commands
10924 List of strings used as commands to fetch @sc{nov} lines from a
10925 server. The default value of this variable is @code{("XOVER"
10929 @vindex nntp-nov-gap
10930 @code{nntp} normally sends just one big request for @sc{nov} lines to
10931 the server. The server responds with one huge list of lines. However,
10932 if you have read articles 2-5000 in the group, and only want to read
10933 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
10934 lines that you will not need. This variable says how
10935 big a gap between two consecutive articles is allowed to be before the
10936 @code{XOVER} request is split into several request. Note that if your
10937 network is fast, setting this variable to a really small number means
10938 that fetching will probably be slower. If this variable is @code{nil},
10939 @code{nntp} will never split requests. The default is 5.
10941 @item nntp-prepare-server-hook
10942 @vindex nntp-prepare-server-hook
10943 A hook run before attempting to connect to an @sc{nntp} server.
10945 @item nntp-warn-about-losing-connection
10946 @vindex nntp-warn-about-losing-connection
10947 If this variable is non-@code{nil}, some noise will be made when a
10948 server closes connection.
10950 @item nntp-record-commands
10951 @vindex nntp-record-commands
10952 If non-@code{nil}, @code{nntp} will log all commands it sends to the
10953 @sc{nntp} server (along with a timestamp) in the @samp{*nntp-log*}
10954 buffer. This is useful if you are debugging a Gnus/@sc{nntp} connection
10955 that doesn't seem to work.
10961 @subsection News Spool
10965 Subscribing to a foreign group from the local spool is extremely easy,
10966 and might be useful, for instance, to speed up reading groups that
10967 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
10970 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
10971 anything else) as the address.
10973 If you have access to a local spool, you should probably use that as the
10974 native select method (@pxref{Finding the News}). It is normally faster
10975 than using an @code{nntp} select method, but might not be. It depends.
10976 You just have to try to find out what's best at your site.
10980 @item nnspool-inews-program
10981 @vindex nnspool-inews-program
10982 Program used to post an article.
10984 @item nnspool-inews-switches
10985 @vindex nnspool-inews-switches
10986 Parameters given to the inews program when posting an article.
10988 @item nnspool-spool-directory
10989 @vindex nnspool-spool-directory
10990 Where @code{nnspool} looks for the articles. This is normally
10991 @file{/usr/spool/news/}.
10993 @item nnspool-nov-directory
10994 @vindex nnspool-nov-directory
10995 Where @code{nnspool} will look for @sc{nov} files. This is normally
10996 @file{/usr/spool/news/over.view/}.
10998 @item nnspool-lib-dir
10999 @vindex nnspool-lib-dir
11000 Where the news lib dir is (@file{/usr/lib/news/} by default).
11002 @item nnspool-active-file
11003 @vindex nnspool-active-file
11004 The path to the active file.
11006 @item nnspool-newsgroups-file
11007 @vindex nnspool-newsgroups-file
11008 The path to the group descriptions file.
11010 @item nnspool-history-file
11011 @vindex nnspool-history-file
11012 The path to the news history file.
11014 @item nnspool-active-times-file
11015 @vindex nnspool-active-times-file
11016 The path to the active date file.
11018 @item nnspool-nov-is-evil
11019 @vindex nnspool-nov-is-evil
11020 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
11023 @item nnspool-sift-nov-with-sed
11024 @vindex nnspool-sift-nov-with-sed
11026 If non-@code{nil}, which is the default, use @code{sed} to get the
11027 relevant portion from the overview file. If nil, @code{nnspool} will
11028 load the entire file into a buffer and process it there.
11034 @section Getting Mail
11035 @cindex reading mail
11038 Reading mail with a newsreader---isn't that just plain WeIrD? But of
11042 * Mail in a Newsreader:: Important introductory notes.
11043 * Getting Started Reading Mail:: A simple cookbook example.
11044 * Splitting Mail:: How to create mail groups.
11045 * Mail Sources:: How to tell Gnus where to get mail from.
11046 * Mail Backend Variables:: Variables for customizing mail handling.
11047 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
11048 * Group Mail Splitting:: Use group customize to drive mail splitting.
11049 * Incorporating Old Mail:: What about the old mail you have?
11050 * Expiring Mail:: Getting rid of unwanted mail.
11051 * Washing Mail:: Removing gruft from the mail you get.
11052 * Duplicates:: Dealing with duplicated mail.
11053 * Not Reading Mail:: Using mail backends for reading other files.
11054 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
11058 @node Mail in a Newsreader
11059 @subsection Mail in a Newsreader
11061 If you are used to traditional mail readers, but have decided to switch
11062 to reading mail with Gnus, you may find yourself experiencing something
11063 of a culture shock.
11065 Gnus does not behave like traditional mail readers. If you want to make
11066 it behave that way, you can, but it's an uphill battle.
11068 Gnus, by default, handles all its groups using the same approach. This
11069 approach is very newsreaderly---you enter a group, see the new/unread
11070 messages, and when you read the messages, they get marked as read, and
11071 you don't see them any more. (Unless you explicitly ask for them.)
11073 In particular, you do not do anything explicitly to delete messages.
11075 Does this mean that all the messages that have been marked as read are
11076 deleted? How awful!
11078 But, no, it means that old messages are @dfn{expired} according to some
11079 scheme or other. For news messages, the expire process is controlled by
11080 the news administrator; for mail, the expire process is controlled by
11081 you. The expire process for mail is covered in depth in @pxref{Expiring
11084 What many Gnus users find, after using it a while for both news and
11085 mail, is that the transport mechanism has very little to do with how
11086 they want to treat a message.
11088 Many people subscribe to several mailing lists. These are transported
11089 via SMTP, and are therefore mail. But we might go for weeks without
11090 answering, or even reading these messages very carefully. We may not
11091 need to save them because if we should need to read one again, they are
11092 archived somewhere else.
11094 Some people have local news groups which have only a handful of readers.
11095 These are transported via @sc{nntp}, and are therefore news. But we may need
11096 to read and answer a large fraction of the messages very carefully in
11097 order to do our work. And there may not be an archive, so we may need
11098 to save the interesting messages the same way we would personal mail.
11100 The important distinction turns out to be not the transport mechanism,
11101 but other factors such as how interested we are in the subject matter,
11102 or how easy it is to retrieve the message if we need to read it again.
11104 Gnus provides many options for sorting mail into ``groups'' which behave
11105 like newsgroups, and for treating each group (whether mail or news)
11108 Some users never get comfortable using the Gnus (ahem) paradigm and wish
11109 that Gnus should grow up and be a male, er, mail reader. It is possible
11110 to whip Gnus into a more mailreaderly being, but, as said before, it's
11111 not easy. People who prefer proper mail readers should try @sc{vm}
11112 instead, which is an excellent, and proper, mail reader.
11114 I don't mean to scare anybody off, but I want to make it clear that you
11115 may be required to learn a new way of thinking about messages. After
11116 you've been subjected to The Gnus Way, you will come to love it. I can
11117 guarantee it. (At least the guy who sold me the Emacs Subliminal
11118 Brain-Washing Functions that I've put into Gnus did guarantee it. You
11119 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
11123 @node Getting Started Reading Mail
11124 @subsection Getting Started Reading Mail
11126 It's quite easy to use Gnus to read your new mail. You just plonk the
11127 mail backend of your choice into @code{gnus-secondary-select-methods},
11128 and things will happen automatically.
11130 For instance, if you want to use @code{nnml} (which is a "one file per
11131 mail" backend), you could put the following in your @file{.gnus} file:
11134 (setq gnus-secondary-select-methods
11135 '((nnml "private")))
11138 Now, the next time you start Gnus, this backend will be queried for new
11139 articles, and it will move all the messages in your spool file to its
11140 directory, which is @code{~/Mail/} by default. The new group that will
11141 be created (@samp{mail.misc}) will be subscribed, and you can read it
11142 like any other group.
11144 You will probably want to split the mail into several groups, though:
11147 (setq nnmail-split-methods
11148 '(("junk" "^From:.*Lars Ingebrigtsen")
11149 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
11153 This will result in three new @code{nnml} mail groups being created:
11154 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
11155 mail that doesn't fit into the first two groups will be placed in the
11158 This should be sufficient for reading mail with Gnus. You might want to
11159 give the other sections in this part of the manual a perusal, though.
11160 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
11163 @node Splitting Mail
11164 @subsection Splitting Mail
11165 @cindex splitting mail
11166 @cindex mail splitting
11168 @vindex nnmail-split-methods
11169 The @code{nnmail-split-methods} variable says how the incoming mail is
11170 to be split into groups.
11173 (setq nnmail-split-methods
11174 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
11175 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
11176 ("mail.other" "")))
11179 This variable is a list of lists, where the first element of each of
11180 these lists is the name of the mail group (they do not have to be called
11181 something beginning with @samp{mail}, by the way), and the second
11182 element is a regular expression used on the header of each mail to
11183 determine if it belongs in this mail group. The first string may
11184 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
11185 insert sub-expressions from the matched text. For instance:
11188 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
11191 The second element can also be a function. In that case, it will be
11192 called narrowed to the headers with the first element of the rule as the
11193 argument. It should return a non-@code{nil} value if it thinks that the
11194 mail belongs in that group.
11196 The last of these groups should always be a general one, and the regular
11197 expression should @emph{always} be @samp{} so that it matches any mails
11198 that haven't been matched by any of the other regexps. (These rules are
11199 processed from the beginning of the alist toward the end. The first
11200 rule to make a match will "win", unless you have crossposting enabled.
11201 In that case, all matching rules will "win".)
11203 If you like to tinker with this yourself, you can set this variable to a
11204 function of your choice. This function will be called without any
11205 arguments in a buffer narrowed to the headers of an incoming mail
11206 message. The function should return a list of group names that it
11207 thinks should carry this mail message.
11209 Note that the mail backends are free to maul the poor, innocent,
11210 incoming headers all they want to. They all add @code{Lines} headers;
11211 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
11212 @code{From<SPACE>} line to something else.
11214 @vindex nnmail-crosspost
11215 The mail backends all support cross-posting. If several regexps match,
11216 the mail will be ``cross-posted'' to all those groups.
11217 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
11218 that no articles are crossposted to the general (@samp{}) group.
11220 @vindex nnmail-crosspost-link-function
11223 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
11224 the crossposted articles. However, not all file systems support hard
11225 links. If that's the case for you, set
11226 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
11227 variable is @code{add-name-to-file} by default.)
11229 @kindex M-x nnmail-split-history
11230 @kindex nnmail-split-history
11231 If you wish to see where the previous mail split put the messages, you
11232 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
11233 where re-spooling messages would put the messages, you can use
11234 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
11237 Gnus gives you all the opportunity you could possibly want for shooting
11238 yourself in the foot. Let's say you create a group that will contain
11239 all the mail you get from your boss. And then you accidentally
11240 unsubscribe from the group. Gnus will still put all the mail from your
11241 boss in the unsubscribed group, and so, when your boss mails you ``Have
11242 that report ready by Monday or you're fired!'', you'll never see it and,
11243 come Tuesday, you'll still believe that you're gainfully employed while
11244 you really should be out collecting empty bottles to save up for next
11245 month's rent money.
11249 @subsection Mail Sources
11251 Mail can be gotten from many different sources---the mail spool, from a
11252 POP mail server, from a procmail directory, or from a maildir, for
11256 * Mail Source Specifiers:: How to specify what a mail source is.
11257 * Mail Source Customization:: Some variables that influence things.
11258 * Fetching Mail:: Using the mail source specifiers.
11262 @node Mail Source Specifiers
11263 @subsubsection Mail Source Specifiers
11265 @cindex mail server
11268 @cindex mail source
11270 You tell Gnus how to fetch mail by setting @code{mail-sources}
11271 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
11276 (pop :server "pop3.mailserver.com" :user "myname")
11279 As can be observed, a mail source specifier is a list where the first
11280 element is a @dfn{mail source type}, followed by an arbitrary number of
11281 @dfn{keywords}. Keywords that are not explicitly specified are given
11284 The following mail source types are available:
11288 Get mail from a single file; typically from the mail spool.
11294 The path of the file. Defaults to the value of the @code{MAIL}
11295 environment variable or @file{/usr/mail/spool/user-name}.
11298 An example file mail source:
11301 (file :path "/usr/spool/mail/user-name")
11304 Or using the default path:
11310 If the mail spool file is not located on the local machine, it's best to
11311 use POP or @sc{imap} or the like to fetch the mail. You can not use ange-ftp
11312 file names here---it has no way to lock the mail spool while moving the
11315 If it's impossible to set up a proper server, you can use ssh instead.
11319 '((file :prescript "ssh host bin/getmail >%t")))
11322 The @samp{getmail} script would look something like the following:
11326 # getmail - move mail from spool to stdout
11329 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
11331 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
11334 Alter this script to fit find the @samp{movemail} you want to use.
11338 Get mail from several files in a directory. This is typically used when
11339 you have procmail split the incoming mail into several files. Setting
11340 @code{nnmail-scan-directory-mail-source-once} to non-nil forces Gnus to
11341 scan the mail source only once. This is particularly useful if you want
11342 to scan mail groups at a specified level.
11348 The path of the directory where the files are. There is no default
11352 Only files ending with this suffix are used. The default is
11356 Only files that have this predicate return non-@code{nil} are returned.
11357 The default is @code{identity}. This is used as an additional
11358 filter---only files that have the right suffix @emph{and} satisfy this
11359 predicate are considered.
11363 Script run before/after fetching mail.
11367 An example directory mail source:
11370 (directory :path "/home/user-name/procmail-dir/"
11375 Get mail from a POP server.
11381 The name of the POP server. The default is taken from the
11382 @code{MAILHOST} environment variable.
11385 The port number of the POP server. This can be a number (eg,
11386 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
11387 string, it should be a service name as listed in @file{/etc/services} on
11388 Unix systems. The default is @samp{"pop3"}. On some systems you might
11389 need to specify it as @samp{"pop-3"} instead.
11392 The user name to give to the POP server. The default is the login
11396 The password to give to the POP server. If not specified, the user is
11400 The program to use to fetch mail from the POP server. This should be
11401 a @code{format}-like string. Here's an example:
11404 fetchmail %u@@%s -P %p %t
11407 The valid format specifier characters are:
11411 The name of the file the mail is to be moved to. This must always be
11412 included in this string.
11415 The name of the server.
11418 The port number of the server.
11421 The user name to use.
11424 The password to use.
11427 The values used for these specs are taken from the values you give the
11428 corresponding keywords.
11431 A script to be run before fetching the mail. The syntax is the same as
11432 the @code{:program} keyword. This can also be a function to be run.
11435 A script to be run after fetching the mail. The syntax is the same as
11436 the @code{:program} keyword. This can also be a function to be run.
11439 The function to use to fetch mail from the POP server. The function is
11440 called with one parameter---the name of the file where the mail should
11443 @item :authentication
11444 This can be either the symbol @code{password} or the symbol @code{apop}
11445 and says what authentication scheme to use. The default is
11450 If the @code{:program} and @code{:function} keywords aren't specified,
11451 @code{pop3-movemail} will be used.
11453 Here are some examples. Fetch from the default POP server, using the
11454 default user name, and default fetcher:
11460 Fetch from a named server with a named user and password:
11463 (pop :server "my.pop.server"
11464 :user "user-name" :password "secret")
11467 Use @samp{movemail} to move the mail:
11470 (pop :program "movemail po:%u %t %p")
11474 Get mail from a maildir. This is a type of mailbox that is supported by
11475 at least qmail and postfix, where each file in a special directory
11476 contains exactly one mail.
11482 The path of the directory where the mails are stored. The default is
11483 taken from the @code{MAILDIR} environment variable or
11486 The subdirectories of the Maildir. The default is
11487 @samp{("new" "cur")}.
11489 @c If you sometimes look at your mail through a pop3 daemon before fetching
11490 @c them with Gnus, you may also have to fetch your mails from the
11491 @c @code{cur} directory inside the maildir, like in the first example
11494 You can also get mails from remote hosts (because maildirs don't suffer
11495 from locking problems).
11499 Two example maildir mail sources:
11502 (maildir :path "/home/user-name/Maildir/" :subdirs ("cur" "new"))
11506 (maildir :path "/user@@remotehost.org:~/Maildir/" :subdirs ("new"))
11510 Get mail from a @sc{imap} server. If you don't want to use @sc{imap}
11511 as intended, as a network mail reading protocol (ie with nnimap), for
11512 some reason or other, Gnus let you treat it similar to a POP server
11513 and fetches articles from a given @sc{imap} mailbox. @xref{IMAP}, for
11520 The name of the @sc{imap} server. The default is taken from the
11521 @code{MAILHOST} environment variable.
11524 The port number of the @sc{imap} server. The default is @samp{143}, or
11525 @samp{993} for SSL connections.
11528 The user name to give to the @sc{imap} server. The default is the login
11532 The password to give to the @sc{imap} server. If not specified, the user is
11536 What stream to use for connecting to the server, this is one of the
11537 symbols in @code{imap-stream-alist}. Right now, this means
11538 @samp{kerberos4}, @samp{ssl} or the default @samp{network}.
11540 @item :authentication
11541 Which authenticator to use for authenticating to the server, this is one
11542 of the symbols in @code{imap-authenticator-alist}. Right now, this
11543 means @samp{kerberos4}, @samp{cram-md5}, @samp{anonymous} or the default
11547 When using the `shell' :stream, the contents of this variable is
11548 mapped into the `imap-shell-program' variable. This should be a
11549 @code{format}-like string (or list of strings). Here's an example:
11555 The valid format specifier characters are:
11559 The name of the server.
11562 User name from `imap-default-user'.
11565 The port number of the server.
11568 The values used for these specs are taken from the values you give the
11569 corresponding keywords.
11572 The name of the mailbox to get mail from. The default is @samp{INBOX}
11573 which normally is the mailbox which receive incoming mail.
11576 The predicate used to find articles to fetch. The default, @samp{UNSEEN
11577 UNDELETED}, is probably the best choice for most people, but if you
11578 sometimes peek in your mailbox with a @sc{imap} client and mark some
11579 articles as read (or; SEEN) you might want to set this to @samp{nil}.
11580 Then all articles in the mailbox is fetched, no matter what. For a
11581 complete list of predicates, see RFC 2060 §6.4.4.
11584 How to flag fetched articles on the server, the default @samp{\Deleted}
11585 will mark them as deleted, an alternative would be @samp{\Seen} which
11586 would simply mark them as read. These are the two most likely choices,
11587 but more flags are defined in RFC 2060 §2.3.2.
11590 If non-nil, don't remove all articles marked as deleted in the mailbox
11591 after finishing the fetch.
11595 An example @sc{imap} mail source:
11598 (imap :server "mail.mycorp.com" :stream kerberos4 :fetchflag "\\Seen")
11602 Get mail from a webmail server, such as www.hotmail.com,
11603 webmail.netscape.com, www.netaddress.com, www.my-deja.com.
11605 NOTE: Now mail.yahoo.com provides POP3 service, so @sc{pop} mail source
11608 NOTE: Webmail largely depends cookies. A "one-line-cookie" patch is
11609 required for url "4.0pre.46".
11611 WARNING: Mails may lost. NO WARRANTY.
11617 The type of the webmail server. The default is @code{hotmail}. The
11618 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
11621 The user name to give to the webmail server. The default is the login
11625 The password to give to the webmail server. If not specified, the user is
11629 If non-nil, only fetch unread articles and don't move them to trash
11630 folder after finishing the fetch.
11634 An example webmail source:
11637 (webmail :subtype 'hotmail :user "user-name" :password "secret")
11642 @item Common Keywords
11643 Common keywords can be used in any type of mail source.
11649 If non-nil, fetch the mail even when Gnus is unplugged. If you use
11650 directory source to get mail, you can specify it as in this example:
11654 '((directory :path "/home/pavel/.Spool/"
11659 Gnus will then fetch your mail even when you are unplugged. This is
11660 useful when you use local mail and news.
11665 @subsubsection Function Interface
11667 Some of the above keywords specify a Lisp function to be executed.
11668 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
11669 the value of the keyword while the function is executing. For example,
11670 consider the following mail-source setting:
11673 (setq mail-sources '((pop :user "jrl"
11674 :server "pophost" :function fetchfunc)))
11677 While the function @code{fetchfunc} is executing, the symbol @code{user}
11678 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
11679 @code{"pophost"}. The symbols @code{port}, @code{password},
11680 @code{program}, @code{prescript}, @code{postscript}, @code{function},
11681 and @code{authentication} are also bound (to their default values).
11683 See above for a list of keywords for each type of mail source.
11686 @node Mail Source Customization
11687 @subsubsection Mail Source Customization
11689 The following is a list of variables that influence how the mail is
11690 fetched. You would normally not need to set or change any of these
11694 @item mail-source-crash-box
11695 @vindex mail-source-crash-box
11696 File where mail will be stored while processing it. The default is
11697 @file{~/.emacs-mail-crash-box}.
11699 @item mail-source-delete-incoming
11700 @vindex mail-source-delete-incoming
11701 If non-@code{nil}, delete incoming files after handling them.
11703 @item mail-source-directory
11704 @vindex mail-source-directory
11705 Directory where files (if any) will be stored. The default is
11706 @file{~/Mail/}. At present, the only thing this is used for is to say
11707 where the incoming files will be stored if the previous variable is
11710 @item mail-source-incoming-file-prefix
11711 @vindex mail-source-incoming-file-prefix
11712 Prefix for file name for storing incoming mail. The default is
11713 @file{Incoming}, in which case files will end up with names like
11714 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
11715 relevant if @code{mail-source-delete-incoming} is @code{nil}.
11717 @item mail-source-default-file-modes
11718 @vindex mail-source-default-file-modes
11719 All new mail files will get this file mode. The default is 384.
11724 @node Fetching Mail
11725 @subsubsection Fetching Mail
11727 @vindex mail-sources
11728 @vindex nnmail-spool-file
11729 The way to actually tell Gnus where to get new mail from is to set
11730 @code{mail-sources} to a list of mail source specifiers
11731 (@pxref{Mail Source Specifiers}).
11733 If this variable (and the obsolescent @code{nnmail-spool-file}) is
11734 @code{nil}, the mail backends will never attempt to fetch mail by
11737 If you want to fetch mail both from your local spool as well as a POP
11738 mail server, you'd say something like:
11743 (pop :server "pop3.mail.server"
11744 :password "secret")))
11747 Or, if you don't want to use any of the keyword defaults:
11751 '((file :path "/var/spool/mail/user-name")
11752 (pop :server "pop3.mail.server"
11755 :password "secret")))
11759 When you use a mail backend, Gnus will slurp all your mail from your
11760 inbox and plonk it down in your home directory. Gnus doesn't move any
11761 mail if you're not using a mail backend---you have to do a lot of magic
11762 invocations first. At the time when you have finished drawing the
11763 pentagram, lightened the candles, and sacrificed the goat, you really
11764 shouldn't be too surprised when Gnus moves your mail.
11768 @node Mail Backend Variables
11769 @subsection Mail Backend Variables
11771 These variables are (for the most part) pertinent to all the various
11775 @vindex nnmail-read-incoming-hook
11776 @item nnmail-read-incoming-hook
11777 The mail backends all call this hook after reading new mail. You can
11778 use this hook to notify any mail watch programs, if you want to.
11780 @vindex nnmail-split-hook
11781 @item nnmail-split-hook
11782 @findex article-decode-encoded-words
11783 @findex RFC 1522 decoding
11784 @findex RFC 2047 decoding
11785 Hook run in the buffer where the mail headers of each message is kept
11786 just before the splitting based on these headers is done. The hook is
11787 free to modify the buffer contents in any way it sees fit---the buffer
11788 is discarded after the splitting has been done, and no changes performed
11789 in the buffer will show up in any files.
11790 @code{gnus-article-decode-encoded-words} is one likely function to add
11793 @vindex nnmail-pre-get-new-mail-hook
11794 @vindex nnmail-post-get-new-mail-hook
11795 @item nnmail-pre-get-new-mail-hook
11796 @itemx nnmail-post-get-new-mail-hook
11797 These are two useful hooks executed when treating new incoming
11798 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
11799 starting to handle the new mail) and
11800 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
11801 is done). Here's and example of using these two hooks to change the
11802 default file modes the new mail files get:
11805 (add-hook 'gnus-pre-get-new-mail-hook
11806 (lambda () (set-default-file-modes 511)))
11808 (add-hook 'gnus-post-get-new-mail-hook
11809 (lambda () (set-default-file-modes 551)))
11812 @item nnmail-use-long-file-names
11813 @vindex nnmail-use-long-file-names
11814 If non-@code{nil}, the mail backends will use long file and directory
11815 names. Groups like @samp{mail.misc} will end up in directories
11816 (assuming use of @code{nnml} backend) or files (assuming use of
11817 @code{nnfolder} backend) like @file{mail.misc}. If it is @code{nil},
11818 the same group will end up in @file{mail/misc}.
11820 @item nnmail-delete-file-function
11821 @vindex nnmail-delete-file-function
11822 @findex delete-file
11823 Function called to delete files. It is @code{delete-file} by default.
11825 @item nnmail-cache-accepted-message-ids
11826 @vindex nnmail-cache-accepted-message-ids
11827 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
11828 the backend (via @code{Gcc}, for instance) into the mail duplication
11829 discovery cache. The default is @code{nil}.
11834 @node Fancy Mail Splitting
11835 @subsection Fancy Mail Splitting
11836 @cindex mail splitting
11837 @cindex fancy mail splitting
11839 @vindex nnmail-split-fancy
11840 @findex nnmail-split-fancy
11841 If the rather simple, standard method for specifying how to split mail
11842 doesn't allow you to do what you want, you can set
11843 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
11844 play with the @code{nnmail-split-fancy} variable.
11846 Let's look at an example value of this variable first:
11849 ;; Messages from the mailer daemon are not crossposted to any of
11850 ;; the ordinary groups. Warnings are put in a separate group
11851 ;; from real errors.
11852 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
11854 ;; Non-error messages are crossposted to all relevant
11855 ;; groups, but we don't crosspost between the group for the
11856 ;; (ding) list and the group for other (ding) related mail.
11857 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
11858 ("subject" "ding" "ding.misc"))
11859 ;; Other mailing lists...
11860 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
11861 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
11862 ;; Both lists below have the same suffix, so prevent
11863 ;; cross-posting to mkpkg.list of messages posted only to
11864 ;; the bugs- list, but allow cross-posting when the
11865 ;; message was really cross-posted.
11866 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
11867 (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
11869 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
11870 ;; Unmatched mail goes to the catch all group.
11874 This variable has the format of a @dfn{split}. A split is a (possibly)
11875 recursive structure where each split may contain other splits. Here are
11876 the five possible split syntaxes:
11881 @samp{group}: If the split is a string, that will be taken as a group
11882 name. Normal regexp match expansion will be done. See below for
11886 @code{(@var{field} @var{value} @code{[-} @var{restrict}
11887 @code{[@dots{}]}@code{]} @var{split})}: If the split is a list, the
11888 first element of which is a string, then store the message as
11889 specified by @var{split}, if header @var{field} (a regexp) contains
11890 @var{value} (also a regexp). If @var{restrict} (yet another regexp)
11891 matches some string after @var{field} and before the end of the
11892 matched @var{value}, the @var{split} is ignored. If none of the
11893 @var{restrict} clauses match, @var{split} is processed.
11896 @code{(| @var{split}@dots{})}: If the split is a list, and the first
11897 element is @code{|} (vertical bar), then process each @var{split} until
11898 one of them matches. A @var{split} is said to match if it will cause
11899 the mail message to be stored in one or more groups.
11902 @code{(& @var{split}@dots{})}: If the split is a list, and the first
11903 element is @code{&}, then process all @var{split}s in the list.
11906 @code{junk}: If the split is the symbol @code{junk}, then don't save
11907 this message. Use with extreme caution.
11910 @code{(: @var{function} @var{arg1} @var{arg2} @dots{})}: If the split is
11911 a list, and the first element is @code{:}, then the second element will
11912 be called as a function with @var{args} given as arguments. The
11913 function should return a @var{split}.
11916 For instance, the following function could be used to split based on the
11917 body of the messages:
11920 (defun split-on-body ()
11922 (set-buffer " *nnmail incoming*")
11923 (goto-char (point-min))
11924 (when (re-search-forward "Some.*string" nil t)
11928 The @samp{" *nnmail incoming*"} is narrowed to the message in question
11929 when the @code{:} function is run.
11932 @code{(! @var{func} @var{split})}: If the split is a list, and the first
11933 element is @code{!}, then SPLIT will be processed, and FUNC will be
11934 called as a function with the result of SPLIT as argument. FUNC should
11938 @code{nil}: If the split is @code{nil}, it is ignored.
11942 In these splits, @var{field} must match a complete field name.
11943 @var{value} must match a complete word according to the fundamental mode
11944 syntax table. You can use @code{.*} in the regexps to match partial
11945 field names or words. In other words, all @var{value}'s are wrapped in
11946 @samp{\<} and @samp{\>} pairs.
11948 @vindex nnmail-split-abbrev-alist
11949 @var{field} and @var{value} can also be lisp symbols, in that case they
11950 are expanded as specified by the variable
11951 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
11952 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
11955 @vindex nnmail-split-fancy-syntax-table
11956 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
11957 when all this splitting is performed.
11959 If you want to have Gnus create groups dynamically based on some
11960 information in the headers (i.e., do @code{replace-match}-like
11961 substitutions in the group names), you can say things like:
11964 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
11967 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
11968 will be filed in @samp{mail.debian.foo}.
11970 If the string contains the element @samp{\&}, then the previously
11971 matched string will be substituted. Similarly, the elements @samp{\\1}
11972 up to @samp{\\9} will be substituted with the text matched by the
11973 groupings 1 through 9.
11975 @findex nnmail-split-fancy-with-parent
11976 @code{nnmail-split-fancy-with-parent} is a function which allows you to
11977 split followups into the same groups their parents are in. Sometimes
11978 you can't make splitting rules for all your mail. For example, your
11979 boss might send you personal mail regarding different projects you are
11980 working on, and as you can't tell your boss to put a distinguishing
11981 string into the subject line, you have to resort to manually moving the
11982 messages into the right group. With this function, you only have to do
11983 it once per thread.
11985 To use this feature, you have to set @code{nnmail-treat-duplicates} to a
11986 non-nil value. And then you can include
11987 @code{nnmail-split-fancy-with-parent} using the colon feature, like so:
11989 (setq nnmail-split-fancy
11990 '(| (: nnmail-split-fancy-with-parent)
11991 ;; other splits go here
11995 This feature works as follows: when @code{nnmail-treat-duplicates} is
11996 non-nil, Gnus records the message id of every message it sees in the
11997 file specified by the variable @code{nnmail-message-id-cache-file},
11998 together with the group it is in (the group is omitted for non-mail
11999 messages). When mail splitting is invoked, the function
12000 @code{nnmail-split-fancy-with-parent} then looks at the References (and
12001 In-Reply-To) header of each message to split and searches the file
12002 specified by @code{nnmail-message-id-cache-file} for the message ids.
12003 When it has found a parent, it returns the corresponding group name. It
12004 is recommended that you set @code{nnmail-message-id-cache-length} to a
12005 somewhat higher number than the default so that the message ids are
12006 still in the cache. (A value of 5000 appears to create a file some 300
12008 @vindex nnmail-cache-accepted-message-ids
12009 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
12010 also records the message ids of moved articles, so that the followup
12011 messages goes into the new group.
12014 @node Group Mail Splitting
12015 @subsection Group Mail Splitting
12016 @cindex mail splitting
12017 @cindex group mail splitting
12019 @findex gnus-group-split
12020 If you subscribe to dozens of mailing lists but you don't want to
12021 maintain mail splitting rules manually, group mail splitting is for you.
12022 You just have to set @var{to-list} and/or @var{to-address} in group
12023 parameters or group customization and set @code{nnmail-split-methods} to
12024 @code{gnus-group-split}. This splitting function will scan all groups
12025 for those parameters and split mail accordingly, i.e., messages posted
12026 from or to the addresses specified in the parameters @var{to-list} or
12027 @var{to-address} of a mail group will be stored in that group.
12029 Sometimes, mailing lists have multiple addresses, and you may want mail
12030 splitting to recognize them all: just set the @var{extra-aliases} group
12031 parameter to the list of additional addresses and it's done. If you'd
12032 rather use a regular expression, set @var{split-regexp}.
12034 All these parameters in a group will be used to create an
12035 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
12036 the @var{value} is a single regular expression that matches
12037 @var{to-list}, @var{to-address}, all of @var{extra-aliases} and all
12038 matches of @var{split-regexp}, and the @var{split} is the name of the
12039 group. @var{restrict}s are also supported: just set the
12040 @var{split-exclude} parameter to a list of regular expressions.
12042 If you can't get the right split to be generated using all these
12043 parameters, or you just need something fancier, you can set the
12044 parameter @var{split-spec} to an @code{nnmail-split-fancy} split. In
12045 this case, all other aforementioned parameters will be ignored by
12046 @code{gnus-group-split}. In particular, @var{split-spec} may be set to
12047 @code{nil}, in which case the group will be ignored by
12048 @code{gnus-group-split}.
12050 @vindex gnus-group-split-default-catch-all-group
12051 @code{gnus-group-split} will do cross-posting on all groups that match,
12052 by defining a single @code{&} fancy split containing one split for each
12053 group. If a message doesn't match any split, it will be stored in the
12054 group named in @code{gnus-group-split-default-catch-all-group}, unless
12055 some group has @var{split-spec} set to @code{catch-all}, in which case
12056 that group is used as the catch-all group. Even though this variable is
12057 often used just to name a group, it may also be set to an arbitrarily
12058 complex fancy split (after all, a group name is a fancy split), and this
12059 may be useful to split mail that doesn't go to any mailing list to
12060 personal mail folders. Note that this fancy split is added as the last
12061 element of a @code{|} split list that also contains a @code{&} split
12062 with the rules extracted from group parameters.
12064 It's time for an example. Assume the following group parameters have
12069 ((to-address . "bar@@femail.com")
12070 (split-regexp . ".*@@femail\\.com"))
12072 ((to-list . "foo@@nowhere.gov")
12073 (extra-aliases "foo@@localhost" "foo-redist@@home")
12074 (split-exclude "bugs-foo" "rambling-foo")
12075 (admin-address . "foo-request@@nowhere.gov"))
12077 ((split-spec . catch-all))
12080 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
12081 behave as if @code{nnmail-split-fancy} had been selected and variable
12082 @code{nnmail-split-fancy} had been set as follows:
12085 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
12086 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
12087 - "bugs-foo" - "rambling-foo" "mail.foo"))
12091 @findex gnus-group-split-fancy
12092 If you'd rather not use group splitting for all your mail groups, you
12093 may use it for only some of them, by using @code{nnmail-split-fancy}
12097 (: gnus-mlsplt-fancy GROUPS NO-CROSSPOST CATCH-ALL)
12100 @var{groups} may be a regular expression or a list of group names whose
12101 parameters will be scanned to generate the output split.
12102 @var{no-crosspost} can be used to disable cross-posting; in this case, a
12103 single @code{|} split will be output. @var{catch-all} is the fallback
12104 fancy split, used like @var{gnus-group-split-default-catch-all-group}.
12105 If @var{catch-all} is @code{nil}, or if @var{split-regexp} matches the
12106 empty string in any selected group, no catch-all split will be issued.
12107 Otherwise, if some group has @var{split-spec} set to @code{catch-all},
12108 this group will override the value of the @var{catch-all} argument.
12110 @findex gnus-group-split-setup
12111 Unfortunately, scanning all groups and their parameters can be quite
12112 slow, especially considering that it has to be done for every message.
12113 But don't despair! The function @code{gnus-group-split-setup} can be
12114 used to enable @code{gnus-group-split} in a much more efficient way. It
12115 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
12116 @code{nnmail-split-fancy} to the split produced by
12117 @code{gnus-group-split-fancy}. Thus, the group parameters are only
12118 scanned once, no matter how many messages are split.
12120 @findex gnus-group-split-update
12121 However, if you change group parameters, you'd have to update
12122 @code{nnmail-split-fancy} manually. You can do it by running
12123 @code{gnus-group-split-update}. If you'd rather have it updated
12124 automatically, just tell @code{gnus-group-split-setup} to do it for
12125 you. For example, add to your @file{.gnus}:
12128 (gnus-group-split-setup AUTO-UPDATE CATCH-ALL)
12131 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
12132 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
12133 have to worry about updating @code{nnmail-split-fancy} again. If you
12134 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
12135 @code{gnus-group-split-default-catch-all-group} will be set to its
12138 @vindex gnus-group-split-updated-hook
12139 Because you may want to change @code{nnmail-split-fancy} after it is set
12140 by @code{gnus-group-split-update}, this function will run
12141 @code{gnus-group-split-updated-hook} just before finishing.
12143 @node Incorporating Old Mail
12144 @subsection Incorporating Old Mail
12146 Most people have lots of old mail stored in various file formats. If
12147 you have set up Gnus to read mail using one of the spiffy Gnus mail
12148 backends, you'll probably wish to have that old mail incorporated into
12151 Doing so can be quite easy.
12153 To take an example: You're reading mail using @code{nnml}
12154 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
12155 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
12156 file filled with important, but old, mail. You want to move it into
12157 your @code{nnml} groups.
12163 Go to the group buffer.
12166 Type `G f' and give the path to the mbox file when prompted to create an
12167 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
12170 Type `SPACE' to enter the newly created group.
12173 Type `M P b' to process-mark all articles in this group's buffer
12174 (@pxref{Setting Process Marks}).
12177 Type `B r' to respool all the process-marked articles, and answer
12178 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
12181 All the mail messages in the mbox file will now also be spread out over
12182 all your @code{nnml} groups. Try entering them and check whether things
12183 have gone without a glitch. If things look ok, you may consider
12184 deleting the mbox file, but I wouldn't do that unless I was absolutely
12185 sure that all the mail has ended up where it should be.
12187 Respooling is also a handy thing to do if you're switching from one mail
12188 backend to another. Just respool all the mail in the old mail groups
12189 using the new mail backend.
12192 @node Expiring Mail
12193 @subsection Expiring Mail
12194 @cindex article expiry
12196 Traditional mail readers have a tendency to remove mail articles when
12197 you mark them as read, in some way. Gnus takes a fundamentally
12198 different approach to mail reading.
12200 Gnus basically considers mail just to be news that has been received in
12201 a rather peculiar manner. It does not think that it has the power to
12202 actually change the mail, or delete any mail messages. If you enter a
12203 mail group, and mark articles as ``read'', or kill them in some other
12204 fashion, the mail articles will still exist on the system. I repeat:
12205 Gnus will not delete your old, read mail. Unless you ask it to, of
12208 To make Gnus get rid of your unwanted mail, you have to mark the
12209 articles as @dfn{expirable}. This does not mean that the articles will
12210 disappear right away, however. In general, a mail article will be
12211 deleted from your system if, 1) it is marked as expirable, AND 2) it is
12212 more than one week old. If you do not mark an article as expirable, it
12213 will remain on your system until hell freezes over. This bears
12214 repeating one more time, with some spurious capitalizations: IF you do
12215 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
12217 @vindex gnus-auto-expirable-newsgroups
12218 You do not have to mark articles as expirable by hand. Groups that
12219 match the regular expression @code{gnus-auto-expirable-newsgroups} will
12220 have all articles that you read marked as expirable automatically. All
12221 articles marked as expirable have an @samp{E} in the first
12222 column in the summary buffer.
12224 By default, if you have auto expiry switched on, Gnus will mark all the
12225 articles you read as expirable, no matter if they were read or unread
12226 before. To avoid having articles marked as read marked as expirable
12227 automatically, you can put something like the following in your
12230 @vindex gnus-mark-article-hook
12232 (remove-hook 'gnus-mark-article-hook
12233 'gnus-summary-mark-read-and-unread-as-read)
12234 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
12237 Note that making a group auto-expirable doesn't mean that all read
12238 articles are expired---only the articles marked as expirable
12239 will be expired. Also note that using the @kbd{d} command won't make
12240 articles expirable---only semi-automatic marking of articles as read will
12241 mark the articles as expirable in auto-expirable groups.
12243 Let's say you subscribe to a couple of mailing lists, and you want the
12244 articles you have read to disappear after a while:
12247 (setq gnus-auto-expirable-newsgroups
12248 "mail.nonsense-list\\|mail.nice-list")
12251 Another way to have auto-expiry happen is to have the element
12252 @code{auto-expire} in the group parameters of the group.
12254 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
12255 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
12256 don't really mix very well.
12258 @vindex nnmail-expiry-wait
12259 The @code{nnmail-expiry-wait} variable supplies the default time an
12260 expirable article has to live. Gnus starts counting days from when the
12261 message @emph{arrived}, not from when it was sent. The default is seven
12264 Gnus also supplies a function that lets you fine-tune how long articles
12265 are to live, based on what group they are in. Let's say you want to
12266 have one month expiry period in the @samp{mail.private} group, a one day
12267 expiry period in the @samp{mail.junk} group, and a six day expiry period
12270 @vindex nnmail-expiry-wait-function
12272 (setq nnmail-expiry-wait-function
12274 (cond ((string= group "mail.private")
12276 ((string= group "mail.junk")
12278 ((string= group "important")
12284 The group names this function is fed are ``unadorned'' group
12285 names---no @samp{nnml:} prefixes and the like.
12287 The @code{nnmail-expiry-wait} variable and
12288 @code{nnmail-expiry-wait-function} function can either be a number (not
12289 necessarily an integer) or one of the symbols @code{immediate} or
12292 You can also use the @code{expiry-wait} group parameter to selectively
12293 change the expiry period (@pxref{Group Parameters}).
12295 @vindex nnmail-expiry-target
12296 The normal action taken when expiring articles is to delete them.
12297 However, in some circumstances it might make more sense to move them to
12298 other groups instead of deleting them. The variable @code{nnmail-expiry-target}
12299 (and the @code{expiry-target} group parameter) controls this. The
12300 variable supplies a default value for all groups, which can be
12301 overridden for specific groups by the group parameter.
12302 default value is @code{delete}, but this can also be a string (which
12303 should be the name of the group the message should be moved to), or a
12304 function (which will be called in a buffer narrowed to the message in
12305 question, and with the name of the group being moved from as its
12306 parameter) which should return a target -- either a group name or
12309 Here's an example for specifying a group name:
12311 (setq nnmail-expiry-target "nnml:expired")
12315 @vindex nnmail-keep-last-article
12316 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
12317 expire the final article in a mail newsgroup. This is to make life
12318 easier for procmail users.
12320 @vindex gnus-total-expirable-newsgroups
12321 By the way: That line up there, about Gnus never expiring non-expirable
12322 articles, is a lie. If you put @code{total-expire} in the group
12323 parameters, articles will not be marked as expirable, but all read
12324 articles will be put through the expiry process. Use with extreme
12325 caution. Even more dangerous is the
12326 @code{gnus-total-expirable-newsgroups} variable. All groups that match
12327 this regexp will have all read articles put through the expiry process,
12328 which means that @emph{all} old mail articles in the groups in question
12329 will be deleted after a while. Use with extreme caution, and don't come
12330 crying to me when you discover that the regexp you used matched the
12331 wrong group and all your important mail has disappeared. Be a
12332 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
12335 Most people make most of their mail groups total-expirable, though.
12337 @vindex gnus-inhibit-user-auto-expire
12338 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
12339 commands will not mark an article as expirable, even if the group has
12340 auto-expire turned on.
12344 @subsection Washing Mail
12345 @cindex mail washing
12346 @cindex list server brain damage
12347 @cindex incoming mail treatment
12349 Mailers and list servers are notorious for doing all sorts of really,
12350 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
12351 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
12352 end of all lines passing through our server, so let's do that!!!!1!''
12353 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
12354 considered to be self-evident were not discussed. So. Here we are.
12356 Case in point: The German version of Microsoft Exchange adds @samp{AW:
12357 } to the subjects of replies instead of @samp{Re: }. I could pretend to
12358 be shocked and dismayed by this, but I haven't got the energy. It is to
12361 Gnus provides a plethora of functions for washing articles while
12362 displaying them, but it might be nicer to do the filtering before
12363 storing the mail to disc. For that purpose, we have three hooks and
12364 various functions that can be put in these hooks.
12367 @item nnmail-prepare-incoming-hook
12368 @vindex nnmail-prepare-incoming-hook
12369 This hook is called before doing anything with the mail and is meant for
12370 grand, sweeping gestures. It is called in a buffer that contains all
12371 the new, incoming mail. Functions to be used include:
12374 @item nnheader-ms-strip-cr
12375 @findex nnheader-ms-strip-cr
12376 Remove trailing carriage returns from each line. This is default on
12377 Emacs running on MS machines.
12381 @item nnmail-prepare-incoming-header-hook
12382 @vindex nnmail-prepare-incoming-header-hook
12383 This hook is called narrowed to each header. It can be used when
12384 cleaning up the headers. Functions that can be used include:
12387 @item nnmail-remove-leading-whitespace
12388 @findex nnmail-remove-leading-whitespace
12389 Clear leading white space that ``helpful'' listservs have added to the
12390 headers to make them look nice. Aaah.
12392 @item nnmail-remove-list-identifiers
12393 @findex nnmail-remove-list-identifiers
12394 Some list servers add an identifier---for example, @samp{(idm)}---to the
12395 beginning of all @code{Subject} headers. I'm sure that's nice for
12396 people who use stone age mail readers. This function will remove
12397 strings that match the @code{nnmail-list-identifiers} regexp, which can
12398 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
12401 For instance, if you want to remove the @samp{(idm)} and the
12402 @samp{nagnagnag} identifiers:
12405 (setq nnmail-list-identifiers
12406 '("(idm)" "nagnagnag"))
12409 This can also be done non-destructively with
12410 @code{gnus-list-identifiers}, @xref{Article Hiding}.
12412 @item nnmail-remove-tabs
12413 @findex nnmail-remove-tabs
12414 Translate all @samp{TAB} characters into @samp{SPACE} characters.
12416 @item nnmail-fix-eudora-headers
12417 @findex nnmail-fix-eudora-headers
12419 Eudora produces broken @code{References} headers, but OK
12420 @code{In-Reply-To} headers. This function will get rid of the
12421 @code{References} headers.
12425 @item nnmail-prepare-incoming-message-hook
12426 @vindex nnmail-prepare-incoming-message-hook
12427 This hook is called narrowed to each message. Functions to be used
12431 @item article-de-quoted-unreadable
12432 @findex article-de-quoted-unreadable
12433 Decode Quoted Readable encoding.
12440 @subsection Duplicates
12442 @vindex nnmail-treat-duplicates
12443 @vindex nnmail-message-id-cache-length
12444 @vindex nnmail-message-id-cache-file
12445 @cindex duplicate mails
12446 If you are a member of a couple of mailing lists, you will sometimes
12447 receive two copies of the same mail. This can be quite annoying, so
12448 @code{nnmail} checks for and treats any duplicates it might find. To do
12449 this, it keeps a cache of old @code{Message-ID}s---
12450 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
12451 default. The approximate maximum number of @code{Message-ID}s stored
12452 there is controlled by the @code{nnmail-message-id-cache-length}
12453 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
12454 stored.) If all this sounds scary to you, you can set
12455 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
12456 default), and @code{nnmail} won't delete duplicate mails. Instead it
12457 will insert a warning into the head of the mail saying that it thinks
12458 that this is a duplicate of a different message.
12460 This variable can also be a function. If that's the case, the function
12461 will be called from a buffer narrowed to the message in question with
12462 the @code{Message-ID} as a parameter. The function must return either
12463 @code{nil}, @code{warn}, or @code{delete}.
12465 You can turn this feature off completely by setting the variable to
12468 If you want all the duplicate mails to be put into a special
12469 @dfn{duplicates} group, you could do that using the normal mail split
12473 (setq nnmail-split-fancy
12474 '(| ;; Messages duplicates go to a separate group.
12475 ("gnus-warning" "duplication of message" "duplicate")
12476 ;; Message from daemons, postmaster, and the like to another.
12477 (any mail "mail.misc")
12484 (setq nnmail-split-methods
12485 '(("duplicates" "^Gnus-Warning:")
12490 Here's a neat feature: If you know that the recipient reads her mail
12491 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
12492 @code{delete}, you can send her as many insults as you like, just by
12493 using a @code{Message-ID} of a mail that you know that she's already
12494 received. Think of all the fun! She'll never see any of it! Whee!
12497 @node Not Reading Mail
12498 @subsection Not Reading Mail
12500 If you start using any of the mail backends, they have the annoying
12501 habit of assuming that you want to read mail with them. This might not
12502 be unreasonable, but it might not be what you want.
12504 If you set @code{mail-sources} and @code{nnmail-spool-file} to
12505 @code{nil}, none of the backends will ever attempt to read incoming
12506 mail, which should help.
12508 @vindex nnbabyl-get-new-mail
12509 @vindex nnmbox-get-new-mail
12510 @vindex nnml-get-new-mail
12511 @vindex nnmh-get-new-mail
12512 @vindex nnfolder-get-new-mail
12513 This might be too much, if, for instance, you are reading mail quite
12514 happily with @code{nnml} and just want to peek at some old @sc{rmail}
12515 file you have stashed away with @code{nnbabyl}. All backends have
12516 variables called backend-@code{get-new-mail}. If you want to disable
12517 the @code{nnbabyl} mail reading, you edit the virtual server for the
12518 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
12520 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
12521 narrowed to the article to be saved before saving it when reading
12525 @node Choosing a Mail Backend
12526 @subsection Choosing a Mail Backend
12528 Gnus will read the mail spool when you activate a mail group. The mail
12529 file is first copied to your home directory. What happens after that
12530 depends on what format you want to store your mail in.
12532 There are five different mail backends in the standard Gnus, and more
12533 backends are available separately. The mail backend most people use
12534 (because it is the fastest and most flexible) is @code{nnml}
12535 (@pxref{Mail Spool}).
12538 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
12539 * Rmail Babyl:: Emacs programs use the rmail babyl format.
12540 * Mail Spool:: Store your mail in a private spool?
12541 * MH Spool:: An mhspool-like backend.
12542 * Mail Folders:: Having one file for each group.
12543 * Comparing Mail Backends:: An in-depth looks at pros and cons.
12547 @node Unix Mail Box
12548 @subsubsection Unix Mail Box
12550 @cindex unix mail box
12552 @vindex nnmbox-active-file
12553 @vindex nnmbox-mbox-file
12554 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
12555 mail. @code{nnmbox} will add extra headers to each mail article to say
12556 which group it belongs in.
12558 Virtual server settings:
12561 @item nnmbox-mbox-file
12562 @vindex nnmbox-mbox-file
12563 The name of the mail box in the user's home directory. Default is
12566 @item nnmbox-active-file
12567 @vindex nnmbox-active-file
12568 The name of the active file for the mail box. Default is
12569 @file{~/.mbox-active}.
12571 @item nnmbox-get-new-mail
12572 @vindex nnmbox-get-new-mail
12573 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
12574 into groups. Default is @code{t}.
12579 @subsubsection Rmail Babyl
12583 @vindex nnbabyl-active-file
12584 @vindex nnbabyl-mbox-file
12585 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
12586 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
12587 mail article to say which group it belongs in.
12589 Virtual server settings:
12592 @item nnbabyl-mbox-file
12593 @vindex nnbabyl-mbox-file
12594 The name of the rmail mbox file. The default is @file{~/RMAIL}
12596 @item nnbabyl-active-file
12597 @vindex nnbabyl-active-file
12598 The name of the active file for the rmail box. The default is
12599 @file{~/.rmail-active}
12601 @item nnbabyl-get-new-mail
12602 @vindex nnbabyl-get-new-mail
12603 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
12609 @subsubsection Mail Spool
12611 @cindex mail @sc{nov} spool
12613 The @dfn{nnml} spool mail format isn't compatible with any other known
12614 format. It should be used with some caution.
12616 @vindex nnml-directory
12617 If you use this backend, Gnus will split all incoming mail into files,
12618 one file for each mail, and put the articles into the corresponding
12619 directories under the directory specified by the @code{nnml-directory}
12620 variable. The default value is @file{~/Mail/}.
12622 You do not have to create any directories beforehand; Gnus will take
12625 If you have a strict limit as to how many files you are allowed to store
12626 in your account, you should not use this backend. As each mail gets its
12627 own file, you might very well occupy thousands of inodes within a few
12628 weeks. If this is no problem for you, and it isn't a problem for you
12629 having your friendly systems administrator walking around, madly,
12630 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
12631 know that this is probably the fastest format to use. You do not have
12632 to trudge through a big mbox file just to read your new mail.
12634 @code{nnml} is probably the slowest backend when it comes to article
12635 splitting. It has to create lots of files, and it also generates
12636 @sc{nov} databases for the incoming mails. This makes it the fastest
12637 backend when it comes to reading mail.
12639 Virtual server settings:
12642 @item nnml-directory
12643 @vindex nnml-directory
12644 All @code{nnml} directories will be placed under this directory.
12645 The default is the value of `message-directory' (whose default value is
12648 @item nnml-active-file
12649 @vindex nnml-active-file
12650 The active file for the @code{nnml} server. The default is
12651 @file{~/Mail/active"}.
12653 @item nnml-newsgroups-file
12654 @vindex nnml-newsgroups-file
12655 The @code{nnml} group descriptions file. @xref{Newsgroups File
12656 Format}. The default is @file{~/Mail/newsgroups"}.
12658 @item nnml-get-new-mail
12659 @vindex nnml-get-new-mail
12660 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
12663 @item nnml-nov-is-evil
12664 @vindex nnml-nov-is-evil
12665 If non-@code{nil}, this backend will ignore any @sc{nov} files. The
12666 default is @code{nil}
12668 @item nnml-nov-file-name
12669 @vindex nnml-nov-file-name
12670 The name of the @sc{nov} files. The default is @file{.overview}.
12672 @item nnml-prepare-save-mail-hook
12673 @vindex nnml-prepare-save-mail-hook
12674 Hook run narrowed to an article before saving.
12678 @findex nnml-generate-nov-databases
12679 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
12680 you can do a complete update by typing @kbd{M-x
12681 nnml-generate-nov-databases}. This command will trawl through the
12682 entire @code{nnml} hierarchy, looking at each and every article, so it
12683 might take a while to complete. A better interface to this
12684 functionality can be found in the server buffer (@pxref{Server
12689 @subsubsection MH Spool
12691 @cindex mh-e mail spool
12693 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
12694 @sc{nov} databases and it doesn't keep an active file. This makes
12695 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
12696 makes it easier to write procmail scripts for.
12698 Virtual server settings:
12701 @item nnmh-directory
12702 @vindex nnmh-directory
12703 All @code{nnmh} directories will be located under this directory. The
12704 default is the value of @code{message-directory} (whose default is
12707 @item nnmh-get-new-mail
12708 @vindex nnmh-get-new-mail
12709 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
12713 @vindex nnmh-be-safe
12714 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
12715 sure that the articles in the folder are actually what Gnus thinks they
12716 are. It will check date stamps and stat everything in sight, so
12717 setting this to @code{t} will mean a serious slow-down. If you never
12718 use anything but Gnus to read the @code{nnmh} articles, you do not have
12719 to set this variable to @code{t}. The default is @code{nil}.
12724 @subsubsection Mail Folders
12726 @cindex mbox folders
12727 @cindex mail folders
12729 @code{nnfolder} is a backend for storing each mail group in a separate
12730 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
12731 will add extra headers to keep track of article numbers and arrival
12734 Virtual server settings:
12737 @item nnfolder-directory
12738 @vindex nnfolder-directory
12739 All the @code{nnfolder} mail boxes will be stored under this directory.
12740 The default is the value of @code{message-directory} (whose default is
12743 @item nnfolder-active-file
12744 @vindex nnfolder-active-file
12745 The name of the active file. The default is @file{~/Mail/active}.
12747 @item nnfolder-newsgroups-file
12748 @vindex nnfolder-newsgroups-file
12749 The name of the group descriptions file. @xref{Newsgroups File
12750 Format}. The default is @file{~/Mail/newsgroups"}
12752 @item nnfolder-get-new-mail
12753 @vindex nnfolder-get-new-mail
12754 If non-@code{nil}, @code{nnfolder} will read incoming mail. The default
12757 @item nnfolder-save-buffer-hook
12758 @vindex nnfolder-save-buffer-hook
12759 @cindex backup files
12760 Hook run before saving the folders. Note that Emacs does the normal
12761 backup renaming of files even with the @code{nnfolder} buffers. If you
12762 wish to switch this off, you could say something like the following in
12763 your @file{.emacs} file:
12766 (defun turn-off-backup ()
12767 (set (make-local-variable 'backup-inhibited) t))
12769 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
12772 @item nnfolder-delete-mail-hook
12773 @vindex nnfolder-delete-mail-hook
12774 Hook run in a buffer narrowed to the message that is to be deleted.
12775 This function can be used to copy the message to somewhere else, or to
12776 extract some information from it before removing it.
12778 @item nnfolder-nov-is-evil
12779 @vindex nnfolder-nov-is-evil
12780 If non-@code{nil}, this backend will ignore any @sc{nov} files. The
12781 default is @code{nil}.
12786 @findex nnfolder-generate-active-file
12787 @kindex M-x nnfolder-generate-active-file
12788 If you have lots of @code{nnfolder}-like files you'd like to read with
12789 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
12790 command to make @code{nnfolder} aware of all likely files in
12791 @code{nnfolder-directory}. This only works if you use long file names,
12794 @node Comparing Mail Backends
12795 @subsubsection Comparing Mail Backends
12797 First, just for terminology, the @dfn{backend} is the common word for a
12798 low-level access method---a transport, if you will, by which something
12799 is acquired. The sense is that one's mail has to come from somewhere,
12800 and so selection of a suitable backend is required in order to get that
12801 mail within spitting distance of Gnus.
12803 The same concept exists for Usenet itself: Though access to articles is
12804 typically done by @sc{nntp} these days, once upon a midnight dreary, everyone
12805 in the world got at Usenet by running a reader on the machine where the
12806 articles lay (the machine which today we call an @sc{nntp} server), and
12807 access was by the reader stepping into the articles' directory spool
12808 area directly. One can still select between either the @code{nntp} or
12809 @code{nnspool} backends, to select between these methods, if one happens
12810 actually to live on the server (or can see its spool directly, anyway,
12813 The goal in selecting a mail backend is to pick one which
12814 simultaneously represents a suitable way of dealing with the original
12815 format plus leaving mail in a form that is convenient to use in the
12816 future. Here are some high and low points on each:
12821 UNIX systems have historically had a single, very common, and well-
12822 defined format. All messages arrive in a single @dfn{spool file}, and
12823 they are delineated by a line whose regular expression matches
12824 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
12825 to make it clear in this instance that this is not the RFC-specified
12826 @samp{From:} header.) Because Emacs and therefore Gnus emanate
12827 historically from the Unix environment, it is simplest if one does not
12828 mess a great deal with the original mailbox format, so if one chooses
12829 this backend, Gnus' primary activity in getting mail from the real spool
12830 area to Gnus' preferred directory is simply to copy it, with no
12831 (appreciable) format change in the process. It is the ``dumbest'' way
12832 to move mail into availability in the Gnus environment. This makes it
12833 fast to move into place, but slow to parse, when Gnus has to look at
12838 Once upon a time, there was the DEC-10 and DEC-20, running operating
12839 systems called TOPS and related things, and the usual (only?) mail
12840 reading environment was a thing called Babyl. I don't know what format
12841 was used for mail landing on the system, but Babyl had its own internal
12842 format to which mail was converted, primarily involving creating a
12843 spool-file-like entity with a scheme for inserting Babyl-specific
12844 headers and status bits above the top of each message in the file.
12845 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
12846 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
12847 to understand the mail files folks already had in existence. Gnus (and
12848 VM, for that matter) continue to support this format because it's
12849 perceived as having some good qualities in those mailer-specific
12850 headers/status bits stuff. RMAIL itself still exists as well, of
12851 course, and is still maintained by Stallman.
12853 Both of the above forms leave your mail in a single file on your
12854 filesystem, and they must parse that entire file each time you take a
12859 @code{nnml} is the backend which smells the most as though you were
12860 actually operating with an @code{nnspool}-accessed Usenet system. (In
12861 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
12862 lo these years ago.) One's mail is taken from the original spool file,
12863 and is then cut up into individual message files, 1:1. It maintains a
12864 Usenet-style active file (analogous to what one finds in an INN- or
12865 CNews-based news system in (for instance) @file{/var/lib/news/active},
12866 or what is returned via the @samp{NNTP LIST} verb) and also creates
12867 @dfn{overview} files for efficient group entry, as has been defined for
12868 @sc{nntp} servers for some years now. It is slower in mail-splitting,
12869 due to the creation of lots of files, updates to the @code{nnml} active
12870 file, and additions to overview files on a per-message basis, but it is
12871 extremely fast on access because of what amounts to the indexing support
12872 provided by the active file and overviews.
12874 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
12875 resource which defines available places in the filesystem to put new
12876 files. Sysadmins take a dim view of heavy inode occupation within
12877 tight, shared filesystems. But if you live on a personal machine where
12878 the filesystem is your own and space is not at a premium, @code{nnml}
12881 It is also problematic using this backend if you are living in a
12882 FAT16-based Windows world, since much space will be wasted on all these
12887 The Rand MH mail-reading system has been around UNIX systems for a very
12888 long time; it operates by splitting one's spool file of messages into
12889 individual files, but with little or no indexing support -- @code{nnmh}
12890 is considered to be semantically equivalent to ``@code{nnml} without
12891 active file or overviews''. This is arguably the worst choice, because
12892 one gets the slowness of individual file creation married to the
12893 slowness of access parsing when learning what's new in one's groups.
12897 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
12898 method described above) on a per-group basis. That is, @code{nnmbox}
12899 itself puts *all* one's mail in one file; @code{nnfolder} provides a
12900 little bit of optimization to this so that each of one's mail groups has
12901 a Unix mail box file. It's faster than @code{nnmbox} because each group
12902 can be parsed separately, and still provides the simple Unix mail box
12903 format requiring minimal effort in moving the mail around. In addition,
12904 it maintains an ``active'' file making it much faster for Gnus to figure
12905 out how many messages there are in each separate group.
12907 If you have groups that are expected to have a massive amount of
12908 messages, @code{nnfolder} is not the best choice, but if you receive
12909 only a moderate amount of mail, @code{nnfolder} is probably the most
12910 friendly mail backend all over.
12915 @node Browsing the Web
12916 @section Browsing the Web
12918 @cindex browsing the web
12922 Web-based discussion forums are getting more and more popular. On many
12923 subjects, the web-based forums have become the most important forums,
12924 eclipsing the importance of mailing lists and news groups. The reason
12925 is easy to understand---they are friendly to new users; you just point
12926 and click, and there's the discussion. With mailing lists, you have to
12927 go through a cumbersome subscription procedure, and most people don't
12928 even know what a news group is.
12930 The problem with this scenario is that web browsers are not very good at
12931 being newsreaders. They do not keep track of what articles you've read;
12932 they do not allow you to score on subjects you're interested in; they do
12933 not allow off-line browsing; they require you to click around and drive
12934 you mad in the end.
12936 So---if web browsers suck at reading discussion forums, why not use Gnus
12939 Gnus has been getting a bit of a collection of backends for providing
12940 interfaces to these sources.
12943 * Web Searches:: Creating groups from articles that match a string.
12944 * Slashdot:: Reading the Slashdot comments.
12945 * Ultimate:: The Ultimate Bulletin Board systems.
12946 * Web Archive:: Reading mailing list archived on web.
12947 * RSS:: Reading RDF site summary.
12948 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
12951 All the web sources require Emacs/w3 and the url library to work.
12953 The main caveat with all these web sources is that they probably won't
12954 work for a very long time. Gleaning information from the @sc{html} data
12955 is guesswork at best, and when the layout is altered, the Gnus backend
12956 will fail. If you have reasonably new versions of these backends,
12957 though, you should be ok.
12959 One thing all these Web methods have in common is that the Web sources
12960 are often down, unavailable or just plain too slow to be fun. In those
12961 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
12962 Unplugged}) handle downloading articles, and then you can read them at
12963 leisure from your local disk. No more World Wide Wait for you.
12967 @subsection Web Searches
12971 @cindex InReference
12972 @cindex Usenet searches
12973 @cindex searching the Usenet
12975 It's, like, too neat to search the Usenet for articles that match a
12976 string, but it, like, totally @emph{sucks}, like, totally, to use one of
12977 those, like, Web browsers, and you, like, have to, rilly, like, look at
12978 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
12979 searches without having to use a browser.
12981 The @code{nnweb} backend allows an easy interface to the mighty search
12982 engine. You create an @code{nnweb} group, enter a search pattern, and
12983 then enter the group and read the articles like you would any normal
12984 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
12985 Groups}) will do this in an easy-to-use fashion.
12987 @code{nnweb} groups don't really lend themselves to being solid
12988 groups---they have a very fleeting idea of article numbers. In fact,
12989 each time you enter an @code{nnweb} group (not even changing the search
12990 pattern), you are likely to get the articles ordered in a different
12991 manner. Not even using duplicate suppression (@pxref{Duplicate
12992 Suppression}) will help, since @code{nnweb} doesn't even know the
12993 @code{Message-ID} of the articles before reading them using some search
12994 engines (DejaNews, for instance). The only possible way to keep track
12995 of which articles you've read is by scoring on the @code{Date}
12996 header---mark all articles posted before the last date you read the
12999 If the search engine changes its output substantially, @code{nnweb}
13000 won't be able to parse it and will fail. One could hardly fault the Web
13001 providers if they were to do this---their @emph{raison d'être} is to
13002 make money off of advertisements, not to provide services to the
13003 community. Since @code{nnweb} washes the ads off all the articles, one
13004 might think that the providers might be somewhat miffed. We'll see.
13006 You must have the @code{url} and @code{w3} package installed to be able
13007 to use @code{nnweb}.
13009 Virtual server variables:
13014 What search engine type is being used. The currently supported types
13015 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
13019 @vindex nnweb-search
13020 The search string to feed to the search engine.
13022 @item nnweb-max-hits
13023 @vindex nnweb-max-hits
13024 Advisory maximum number of hits per search to display. The default is
13027 @item nnweb-type-definition
13028 @vindex nnweb-type-definition
13029 Type-to-definition alist. This alist says what @code{nnweb} should do
13030 with the various search engine types. The following elements must be
13035 Function to decode the article and provide something that Gnus
13039 Function to create an article number to message header and URL alist.
13042 Function to send the search string to the search engine.
13045 The address the aforementioned function should send the search string
13049 Format string URL to fetch an article by @code{Message-ID}.
13056 @subsection Slashdot
13060 Slashdot (@uref{http://slashdot.org/}) is a popular news site, with
13061 lively discussion following the news articles. @code{nnslashdot} will
13062 let you read this forum in a convenient manner.
13064 The easiest way to read this source is to put something like the
13065 following in your @file{.gnus.el} file:
13068 (setq gnus-secondary-select-methods
13069 '((nnslashdot "")))
13072 This will make Gnus query the @code{nnslashdot} backend for new comments
13073 and groups. The @kbd{F} command will subscribe each new news article as
13074 a new Gnus group, and you can read the comments by entering these
13075 groups. (Note that the default subscription method is to subscribe new
13076 groups as zombies. Other methods are available (@pxref{Subscription
13079 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
13080 command is the most handy tool (@pxref{Foreign Groups}).
13082 When following up to @code{nnslashdot} comments (or posting new
13083 comments), some light @sc{html}izations will be performed. In
13084 particular, text quoted with @samp{> } will be quoted with
13085 @code{blockquote} instead, and signatures will have @code{br} added to
13086 the end of each line. Other than that, you can just write @sc{html}
13087 directly into the message buffer. Note that Slashdot filters out some
13090 The following variables can be altered to change its behavior:
13093 @item nnslashdot-threaded
13094 Whether @code{nnslashdot} should display threaded groups or not. The
13095 default is @code{t}. To be able to display threads, @code{nnslashdot}
13096 has to retrieve absolutely all comments in a group upon entry. If a
13097 threaded display is not required, @code{nnslashdot} will only retrieve
13098 the comments that are actually wanted by the user. Threading is nicer,
13099 but much, much slower than untreaded.
13101 @item nnslashdot-login-name
13102 @vindex nnslashdot-login-name
13103 The login name to use when posting.
13105 @item nnslashdot-password
13106 @vindex nnslashdot-password
13107 The password to use when posting.
13109 @item nnslashdot-directory
13110 @vindex nnslashdot-directory
13111 Where @code{nnslashdot} will store its files. The default value is
13112 @samp{~/News/slashdot/}.
13114 @item nnslashdot-active-url
13115 @vindex nnslashdot-active-url
13116 The @sc{url} format string that will be used to fetch the information on
13117 news articles and comments. The default is
13118 @samp{http://slashdot.org/search.pl?section=&min=%d}.
13120 @item nnslashdot-comments-url
13121 @vindex nnslashdot-comments-url
13122 The @sc{url} format string that will be used to fetch comments. The
13124 @samp{http://slashdot.org/comments.pl?sid=%s&threshold=%d&commentsort=%d&mode=flat&startat=%d}.
13126 @item nnslashdot-article-url
13127 @vindex nnslashdot-article-url
13128 The @sc{url} format string that will be used to fetch the news article. The
13130 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
13132 @item nnslashdot-threshold
13133 @vindex nnslashdot-threshold
13134 The score threshold. The default is -1.
13136 @item nnslashdot-group-number
13137 @vindex nnslashdot-group-number
13138 The number of old groups, in addition to the ten latest, to keep
13139 updated. The default is 0.
13146 @subsection Ultimate
13148 @cindex Ultimate Bulletin Board
13150 The Ultimate Bulletin Board (@uref{http://www.ultimatebb.com/}) is
13151 probably the most popular Web bulletin board system used. It has a
13152 quite regular and nice interface, and it's possible to get the
13153 information Gnus needs to keep groups updated.
13155 The easiest way to get started with @code{nnultimate} is to say
13156 something like the following in the group buffer: @kbd{B nnultimate RET
13157 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @sc{url}
13158 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
13159 you're interested in; there's quite a list of them on the Ultimate web
13160 site.) Then subscribe to the groups you're interested in from the
13161 server buffer, and read them from the group buffer.
13163 The following @code{nnultimate} variables can be altered:
13166 @item nnultimate-directory
13167 @vindex nnultimate-directory
13168 The directory where @code{nnultimate} stores its files. The default is
13169 @samp{~/News/ultimate/}.
13174 @subsection Web Archive
13176 @cindex Web Archive
13178 Some mailing lists only have archives on Web servers, such as
13179 @uref{http://www.egroups.com/} and
13180 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
13181 interface, and it's possible to get the information Gnus needs to keep
13184 The easiest way to get started with @code{nnwarchive} is to say
13185 something like the following in the group buffer: @kbd{M-x
13186 gnus-group-make-warchive-group RET an_egroup RET egroups RET
13187 www.egroups.com RET your@@email.address RET}. (Substitute the
13188 @sc{an_egroup} with the mailing list you subscribed, the
13189 @sc{your@@email.address} with your email address.), or to browse the
13190 backend by @kbd{B nnwarchive RET mail-archive RET}.
13192 The following @code{nnwarchive} variables can be altered:
13195 @item nnwarchive-directory
13196 @vindex nnwarchive-directory
13197 The directory where @code{nnwarchive} stores its files. The default is
13198 @samp{~/News/warchive/}.
13200 @item nnwarchive-login
13201 @vindex nnwarchive-login
13202 The account name on the web server.
13204 @item nnwarchive-passwd
13205 @vindex nnwarchive-passwd
13206 The password for your account on the web server.
13214 Some sites have RDF site summary (RSS)
13215 @uref{http://purl.org/rss/1.0/spec}. It has a quite regular and nice
13216 interface, and it's possible to get the information Gnus needs to keep
13219 The easiest way to get started with @code{nnrss} is to say something
13220 like the following in the group buffer: @kbd{B nnrss RET RET}, then
13223 The following @code{nnrss} variables can be altered:
13226 @item nnrss-directory
13227 @vindex nnrss-directory
13228 The directory where @code{nnrss} stores its files. The default is
13229 @samp{~/News/rss/}.
13233 @node Customizing w3
13234 @subsection Customizing w3
13240 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
13241 pages. Emacs/w3 is documented in its own manual, but there are some
13242 things that may be more relevant for Gnus users.
13244 For instance, a common question is how to make Emacs/w3 follow links
13245 using the @code{browse-url} functions (which will call some external web
13246 browser like Netscape). Here's one way:
13249 (eval-after-load "w3"
13251 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
13252 (defun w3-fetch (&optional url target)
13253 (interactive (list (w3-read-url-with-default)))
13254 (if (eq major-mode 'gnus-article-mode)
13256 (w3-fetch-orig url target)))))
13259 Put that in your @file{.emacs} file, and hitting links in w3-rendered
13260 @sc{html} in the Gnus article buffers will use @code{browse-url} to
13264 @node Other Sources
13265 @section Other Sources
13267 Gnus can do more than just read news or mail. The methods described
13268 below allow Gnus to view directories and files as if they were
13272 * Directory Groups:: You can read a directory as if it was a newsgroup.
13273 * Anything Groups:: Dired? Who needs dired?
13274 * Document Groups:: Single files can be the basis of a group.
13275 * SOUP:: Reading @sc{soup} packets ``offline''.
13276 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
13277 * IMAP:: Using Gnus as a @sc{imap} client.
13281 @node Directory Groups
13282 @subsection Directory Groups
13284 @cindex directory groups
13286 If you have a directory that has lots of articles in separate files in
13287 it, you might treat it as a newsgroup. The files have to have numerical
13290 This might be an opportune moment to mention @code{ange-ftp} (and its
13291 successor @code{efs}), that most wonderful of all wonderful Emacs
13292 packages. When I wrote @code{nndir}, I didn't think much about it---a
13293 backend to read directories. Big deal.
13295 @code{ange-ftp} changes that picture dramatically. For instance, if you
13296 enter the @code{ange-ftp} file name
13297 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
13298 @code{ange-ftp} or @code{efs} will actually allow you to read this
13299 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
13301 @code{nndir} will use @sc{nov} files if they are present.
13303 @code{nndir} is a ``read-only'' backend---you can't delete or expire
13304 articles with this method. You can use @code{nnmh} or @code{nnml} for
13305 whatever you use @code{nndir} for, so you could switch to any of those
13306 methods if you feel the need to have a non-read-only @code{nndir}.
13309 @node Anything Groups
13310 @subsection Anything Groups
13313 From the @code{nndir} backend (which reads a single spool-like
13314 directory), it's just a hop and a skip to @code{nneething}, which
13315 pretends that any arbitrary directory is a newsgroup. Strange, but
13318 When @code{nneething} is presented with a directory, it will scan this
13319 directory and assign article numbers to each file. When you enter such
13320 a group, @code{nneething} must create ``headers'' that Gnus can use.
13321 After all, Gnus is a newsreader, in case you're forgetting.
13322 @code{nneething} does this in a two-step process. First, it snoops each
13323 file in question. If the file looks like an article (i.e., the first
13324 few lines look like headers), it will use this as the head. If this is
13325 just some arbitrary file without a head (e.g. a C source file),
13326 @code{nneething} will cobble up a header out of thin air. It will use
13327 file ownership, name and date and do whatever it can with these
13330 All this should happen automatically for you, and you will be presented
13331 with something that looks very much like a newsgroup. Totally like a
13332 newsgroup, to be precise. If you select an article, it will be displayed
13333 in the article buffer, just as usual.
13335 If you select a line that represents a directory, Gnus will pop you into
13336 a new summary buffer for this @code{nneething} group. And so on. You can
13337 traverse the entire disk this way, if you feel like, but remember that
13338 Gnus is not dired, really, and does not intend to be, either.
13340 There are two overall modes to this action---ephemeral or solid. When
13341 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
13342 will not store information on what files you have read, and what files
13343 are new, and so on. If you create a solid @code{nneething} group the
13344 normal way with @kbd{G m}, Gnus will store a mapping table between
13345 article numbers and file names, and you can treat this group like any
13346 other groups. When you activate a solid @code{nneething} group, you will
13347 be told how many unread articles it contains, etc., etc.
13352 @item nneething-map-file-directory
13353 @vindex nneething-map-file-directory
13354 All the mapping files for solid @code{nneething} groups will be stored
13355 in this directory, which defaults to @file{~/.nneething/}.
13357 @item nneething-exclude-files
13358 @vindex nneething-exclude-files
13359 All files that match this regexp will be ignored. Nice to use to exclude
13360 auto-save files and the like, which is what it does by default.
13362 @item nneething-include-files
13363 @vindex nneething-include-files
13364 Regexp saying what files to include in the group. If this variable is
13365 non-@code{nil}, only files matching this regexp will be included.
13367 @item nneething-map-file
13368 @vindex nneething-map-file
13369 Name of the map files.
13373 @node Document Groups
13374 @subsection Document Groups
13376 @cindex documentation group
13379 @code{nndoc} is a cute little thing that will let you read a single file
13380 as a newsgroup. Several files types are supported:
13387 The babyl (rmail) mail box.
13392 The standard Unix mbox file.
13394 @cindex MMDF mail box
13396 The MMDF mail box format.
13399 Several news articles appended into a file.
13402 @cindex rnews batch files
13403 The rnews batch transport format.
13404 @cindex forwarded messages
13407 Forwarded articles.
13410 Netscape mail boxes.
13413 MIME multipart messages.
13415 @item standard-digest
13416 The standard (RFC 1153) digest format.
13419 Non-standard digest format---matches most things, but does it badly.
13422 You can also use the special ``file type'' @code{guess}, which means
13423 that @code{nndoc} will try to guess what file type it is looking at.
13424 @code{digest} means that @code{nndoc} should guess what digest type the
13427 @code{nndoc} will not try to change the file or insert any extra headers into
13428 it---it will simply, like, let you use the file as the basis for a
13429 group. And that's it.
13431 If you have some old archived articles that you want to insert into your
13432 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
13433 that. Say you have an old @file{RMAIL} file with mail that you now want
13434 to split into your new @code{nnml} groups. You look at that file using
13435 @code{nndoc} (using the @kbd{G f} command in the group buffer
13436 (@pxref{Foreign Groups})), set the process mark on all the articles in
13437 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
13438 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
13439 file is now also stored in lots of @code{nnml} directories, and you can
13440 delete that pesky @file{RMAIL} file. If you have the guts!
13442 Virtual server variables:
13445 @item nndoc-article-type
13446 @vindex nndoc-article-type
13447 This should be one of @code{mbox}, @code{babyl}, @code{digest},
13448 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
13449 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
13450 @code{slack-digest}, @code{clari-briefs}, @code{nsmail} or @code{guess}.
13452 @item nndoc-post-type
13453 @vindex nndoc-post-type
13454 This variable says whether Gnus is to consider the group a news group or
13455 a mail group. There are two valid values: @code{mail} (the default)
13460 * Document Server Internals:: How to add your own document types.
13464 @node Document Server Internals
13465 @subsubsection Document Server Internals
13467 Adding new document types to be recognized by @code{nndoc} isn't
13468 difficult. You just have to whip up a definition of what the document
13469 looks like, write a predicate function to recognize that document type,
13470 and then hook into @code{nndoc}.
13472 First, here's an example document type definition:
13476 (article-begin . "^\^A\^A\^A\^A\n")
13477 (body-end . "^\^A\^A\^A\^A\n"))
13480 The definition is simply a unique @dfn{name} followed by a series of
13481 regexp pseudo-variable settings. Below are the possible
13482 variables---don't be daunted by the number of variables; most document
13483 types can be defined with very few settings:
13486 @item first-article
13487 If present, @code{nndoc} will skip past all text until it finds
13488 something that match this regexp. All text before this will be
13491 @item article-begin
13492 This setting has to be present in all document type definitions. It
13493 says what the beginning of each article looks like.
13495 @item head-begin-function
13496 If present, this should be a function that moves point to the head of
13499 @item nndoc-head-begin
13500 If present, this should be a regexp that matches the head of the
13503 @item nndoc-head-end
13504 This should match the end of the head of the article. It defaults to
13505 @samp{^$}---the empty line.
13507 @item body-begin-function
13508 If present, this function should move point to the beginning of the body
13512 This should match the beginning of the body of the article. It defaults
13515 @item body-end-function
13516 If present, this function should move point to the end of the body of
13520 If present, this should match the end of the body of the article.
13523 If present, this should match the end of the file. All text after this
13524 regexp will be totally ignored.
13528 So, using these variables @code{nndoc} is able to dissect a document
13529 file into a series of articles, each with a head and a body. However, a
13530 few more variables are needed since not all document types are all that
13531 news-like---variables needed to transform the head or the body into
13532 something that's palatable for Gnus:
13535 @item prepare-body-function
13536 If present, this function will be called when requesting an article. It
13537 will be called with point at the start of the body, and is useful if the
13538 document has encoded some parts of its contents.
13540 @item article-transform-function
13541 If present, this function is called when requesting an article. It's
13542 meant to be used for more wide-ranging transformation of both head and
13543 body of the article.
13545 @item generate-head-function
13546 If present, this function is called to generate a head that Gnus can
13547 understand. It is called with the article number as a parameter, and is
13548 expected to generate a nice head for the article in question. It is
13549 called when requesting the headers of all articles.
13553 Let's look at the most complicated example I can come up with---standard
13558 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
13559 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
13560 (prepare-body-function . nndoc-unquote-dashes)
13561 (body-end-function . nndoc-digest-body-end)
13562 (head-end . "^ ?$")
13563 (body-begin . "^ ?\n")
13564 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
13565 (subtype digest guess))
13568 We see that all text before a 70-width line of dashes is ignored; all
13569 text after a line that starts with that @samp{^End of} is also ignored;
13570 each article begins with a 30-width line of dashes; the line separating
13571 the head from the body may contain a single space; and that the body is
13572 run through @code{nndoc-unquote-dashes} before being delivered.
13574 To hook your own document definition into @code{nndoc}, use the
13575 @code{nndoc-add-type} function. It takes two parameters---the first is
13576 the definition itself and the second (optional) parameter says where in
13577 the document type definition alist to put this definition. The alist is
13578 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
13579 is of @code{mmdf} type, and so on. These type predicates should return
13580 @code{nil} if the document is not of the correct type; @code{t} if it is
13581 of the correct type; and a number if the document might be of the
13582 correct type. A high number means high probability; a low number means
13583 low probability with @samp{0} being the lowest valid number.
13591 In the PC world people often talk about ``offline'' newsreaders. These
13592 are thingies that are combined reader/news transport monstrosities.
13593 With built-in modem programs. Yecchh!
13595 Of course, us Unix Weenie types of human beans use things like
13596 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
13597 transport things like Ghod intended. And then we just use normal
13600 However, it can sometimes be convenient to do something that's a bit
13601 easier on the brain if you have a very slow modem, and you're not really
13602 that interested in doing things properly.
13604 A file format called @sc{soup} has been developed for transporting news
13605 and mail from servers to home machines and back again. It can be a bit
13608 First some terminology:
13613 This is the machine that is connected to the outside world and where you
13614 get news and/or mail from.
13617 This is the machine that you want to do the actual reading and responding
13618 on. It is typically not connected to the rest of the world in any way.
13621 Something that contains messages and/or commands. There are two kinds
13625 @item message packets
13626 These are packets made at the server, and typically contain lots of
13627 messages for you to read. These are called @file{SoupoutX.tgz} by
13628 default, where @var{x} is a number.
13630 @item response packets
13631 These are packets made at the home machine, and typically contains
13632 replies that you've written. These are called @file{SoupinX.tgz} by
13633 default, where @var{x} is a number.
13643 You log in on the server and create a @sc{soup} packet. You can either
13644 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
13645 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
13646 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
13649 You transfer the packet home. Rail, boat, car or modem will do fine.
13652 You put the packet in your home directory.
13655 You fire up Gnus on your home machine using the @code{nnsoup} backend as
13656 the native or secondary server.
13659 You read articles and mail and answer and followup to the things you
13660 want (@pxref{SOUP Replies}).
13663 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
13667 You transfer this packet to the server.
13670 You use Gnus to mail this packet out with the @kbd{G s s} command.
13673 You then repeat until you die.
13677 So you basically have a bipartite system---you use @code{nnsoup} for
13678 reading and Gnus for packing/sending these @sc{soup} packets.
13681 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
13682 * SOUP Groups:: A backend for reading @sc{soup} packets.
13683 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
13687 @node SOUP Commands
13688 @subsubsection SOUP Commands
13690 These are commands for creating and manipulating @sc{soup} packets.
13694 @kindex G s b (Group)
13695 @findex gnus-group-brew-soup
13696 Pack all unread articles in the current group
13697 (@code{gnus-group-brew-soup}). This command understands the
13698 process/prefix convention.
13701 @kindex G s w (Group)
13702 @findex gnus-soup-save-areas
13703 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
13706 @kindex G s s (Group)
13707 @findex gnus-soup-send-replies
13708 Send all replies from the replies packet
13709 (@code{gnus-soup-send-replies}).
13712 @kindex G s p (Group)
13713 @findex gnus-soup-pack-packet
13714 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
13717 @kindex G s r (Group)
13718 @findex nnsoup-pack-replies
13719 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
13722 @kindex O s (Summary)
13723 @findex gnus-soup-add-article
13724 This summary-mode command adds the current article to a @sc{soup} packet
13725 (@code{gnus-soup-add-article}). It understands the process/prefix
13726 convention (@pxref{Process/Prefix}).
13731 There are a few variables to customize where Gnus will put all these
13736 @item gnus-soup-directory
13737 @vindex gnus-soup-directory
13738 Directory where Gnus will save intermediate files while composing
13739 @sc{soup} packets. The default is @file{~/SoupBrew/}.
13741 @item gnus-soup-replies-directory
13742 @vindex gnus-soup-replies-directory
13743 This is what Gnus will use as a temporary directory while sending our
13744 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
13746 @item gnus-soup-prefix-file
13747 @vindex gnus-soup-prefix-file
13748 Name of the file where Gnus stores the last used prefix. The default is
13749 @samp{gnus-prefix}.
13751 @item gnus-soup-packer
13752 @vindex gnus-soup-packer
13753 A format string command for packing a @sc{soup} packet. The default is
13754 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
13756 @item gnus-soup-unpacker
13757 @vindex gnus-soup-unpacker
13758 Format string command for unpacking a @sc{soup} packet. The default is
13759 @samp{gunzip -c %s | tar xvf -}.
13761 @item gnus-soup-packet-directory
13762 @vindex gnus-soup-packet-directory
13763 Where Gnus will look for reply packets. The default is @file{~/}.
13765 @item gnus-soup-packet-regexp
13766 @vindex gnus-soup-packet-regexp
13767 Regular expression matching @sc{soup} reply packets in
13768 @code{gnus-soup-packet-directory}.
13774 @subsubsection @sc{soup} Groups
13777 @code{nnsoup} is the backend for reading @sc{soup} packets. It will
13778 read incoming packets, unpack them, and put them in a directory where
13779 you can read them at leisure.
13781 These are the variables you can use to customize its behavior:
13785 @item nnsoup-tmp-directory
13786 @vindex nnsoup-tmp-directory
13787 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
13788 directory. (@file{/tmp/} by default.)
13790 @item nnsoup-directory
13791 @vindex nnsoup-directory
13792 @code{nnsoup} then moves each message and index file to this directory.
13793 The default is @file{~/SOUP/}.
13795 @item nnsoup-replies-directory
13796 @vindex nnsoup-replies-directory
13797 All replies will be stored in this directory before being packed into a
13798 reply packet. The default is @file{~/SOUP/replies/"}.
13800 @item nnsoup-replies-format-type
13801 @vindex nnsoup-replies-format-type
13802 The @sc{soup} format of the replies packets. The default is @samp{?n}
13803 (rnews), and I don't think you should touch that variable. I probably
13804 shouldn't even have documented it. Drats! Too late!
13806 @item nnsoup-replies-index-type
13807 @vindex nnsoup-replies-index-type
13808 The index type of the replies packet. The default is @samp{?n}, which
13809 means ``none''. Don't fiddle with this one either!
13811 @item nnsoup-active-file
13812 @vindex nnsoup-active-file
13813 Where @code{nnsoup} stores lots of information. This is not an ``active
13814 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
13815 this file or mess it up in any way, you're dead. The default is
13816 @file{~/SOUP/active}.
13818 @item nnsoup-packer
13819 @vindex nnsoup-packer
13820 Format string command for packing a reply @sc{soup} packet. The default
13821 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
13823 @item nnsoup-unpacker
13824 @vindex nnsoup-unpacker
13825 Format string command for unpacking incoming @sc{soup} packets. The
13826 default is @samp{gunzip -c %s | tar xvf -}.
13828 @item nnsoup-packet-directory
13829 @vindex nnsoup-packet-directory
13830 Where @code{nnsoup} will look for incoming packets. The default is
13833 @item nnsoup-packet-regexp
13834 @vindex nnsoup-packet-regexp
13835 Regular expression matching incoming @sc{soup} packets. The default is
13838 @item nnsoup-always-save
13839 @vindex nnsoup-always-save
13840 If non-@code{nil}, save the replies buffer after each posted message.
13846 @subsubsection SOUP Replies
13848 Just using @code{nnsoup} won't mean that your postings and mailings end
13849 up in @sc{soup} reply packets automagically. You have to work a bit
13850 more for that to happen.
13852 @findex nnsoup-set-variables
13853 The @code{nnsoup-set-variables} command will set the appropriate
13854 variables to ensure that all your followups and replies end up in the
13857 In specific, this is what it does:
13860 (setq message-send-news-function 'nnsoup-request-post)
13861 (setq message-send-mail-function 'nnsoup-request-mail)
13864 And that's it, really. If you only want news to go into the @sc{soup}
13865 system you just use the first line. If you only want mail to be
13866 @sc{soup}ed you use the second.
13869 @node Mail-To-News Gateways
13870 @subsection Mail-To-News Gateways
13871 @cindex mail-to-news gateways
13874 If your local @code{nntp} server doesn't allow posting, for some reason
13875 or other, you can post using one of the numerous mail-to-news gateways.
13876 The @code{nngateway} backend provides the interface.
13878 Note that you can't read anything from this backend---it can only be
13884 @item nngateway-address
13885 @vindex nngateway-address
13886 This is the address of the mail-to-news gateway.
13888 @item nngateway-header-transformation
13889 @vindex nngateway-header-transformation
13890 News headers often have to be transformed in some odd way or other
13891 for the mail-to-news gateway to accept it. This variable says what
13892 transformation should be called, and defaults to
13893 @code{nngateway-simple-header-transformation}. The function is called
13894 narrowed to the headers to be transformed and with one parameter---the
13897 This default function just inserts a new @code{To} header based on the
13898 @code{Newsgroups} header and the gateway address.
13899 For instance, an article with this @code{Newsgroups} header:
13902 Newsgroups: alt.religion.emacs
13905 will get this @code{From} header inserted:
13908 To: alt-religion-emacs@@GATEWAY
13911 The following pre-defined functions exist:
13913 @findex nngateway-simple-header-transformation
13916 @item nngateway-simple-header-transformation
13917 Creates a @code{To} header that looks like
13918 @var{newsgroup}@@@code{nngateway-address}.
13920 @findex nngateway-mail2news-header-transformation
13922 @item nngateway-mail2news-header-transformation
13923 Creates a @code{To} header that looks like
13924 @code{nngateway-address}.
13929 (setq gnus-post-method
13930 '(nngateway "mail2news@@replay.com"
13931 (nngateway-header-transformation
13932 nngateway-mail2news-header-transformation)))
13940 So, to use this, simply say something like:
13943 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
13949 @subsection @sc{imap}
13953 @sc{imap} is a network protocol for reading mail (or news, or ...),
13954 think of it as a modernized @sc{nntp}. Connecting to a @sc{imap}
13955 server is much similar to connecting to a news server, you just
13956 specify the network address of the server.
13958 @sc{imap} has two properties. First, @sc{imap} can do everything that
13959 POP can, it can hence be viewed as POP++. Secondly, @sc{imap} is a
13960 mail storage protocol, similar to @sc{nntp} being a news storage
13961 protocol. (@sc{imap} offers more features than @sc{nntp} because news
13962 is more or less read-only whereas mail is read-write.)
13964 If you want to use @sc{imap} as POP++, use an imap entry in
13965 mail-sources. With this, Gnus will fetch mails from the @sc{imap}
13966 server and store them on the local disk. This is not the usage
13967 described in this section. @xref{Mail Sources}.
13969 If you want to use @sc{imap} as a mail storage protocol, use an nnimap
13970 entry in gnus-secondary-select-methods. With this, Gnus will
13971 manipulate mails stored on the @sc{imap} server. This is the kind of
13972 usage explained in this section.
13974 A server configuration in @code{~/.gnus} with a few @sc{imap} servers
13975 might look something like this:
13978 (setq gnus-secondary-select-methods
13979 '((nnimap "simpleserver") ; no special configuration
13980 ; perhaps a ssh port forwarded server:
13982 (nnimap-address "localhost")
13983 (nnimap-server-port 1430))
13984 ; a UW server running on localhost
13986 (nnimap-server-port 143)
13987 (nnimap-address "localhost")
13988 (nnimap-list-pattern ("INBOX" "mail/*")))
13989 ; anonymous public cyrus server:
13990 (nnimap "cyrus.andrew.cmu.edu"
13991 (nnimap-authenticator anonymous)
13992 (nnimap-list-pattern "archive.*")
13993 (nnimap-stream network))
13994 ; a ssl server on a non-standard port:
13996 (nnimap-address "vic20.somewhere.com")
13997 (nnimap-server-port 9930)
13998 (nnimap-stream ssl))))
14001 The following variables can be used to create a virtual @code{nnimap}
14006 @item nnimap-address
14007 @vindex nnimap-address
14009 The address of the remote @sc{imap} server. Defaults to the virtual
14010 server name if not specified.
14012 @item nnimap-server-port
14013 @vindex nnimap-server-port
14014 Port on server to contact. Defaults to port 143, or 993 for SSL.
14016 Note that this should be a integer, example server specification:
14019 (nnimap "mail.server.com"
14020 (nnimap-server-port 4711))
14023 @item nnimap-list-pattern
14024 @vindex nnimap-list-pattern
14025 String or list of strings of mailboxes to limit available groups to.
14026 This is used when the server has very many mailboxes and you're only
14027 interested in a few -- some servers export your home directory via
14028 @sc{imap}, you'll probably want to limit the mailboxes to those in
14029 @file{~/Mail/*} then.
14031 The string can also be a cons of REFERENCE and the string as above, what
14032 REFERENCE is used for is server specific, but on the University of
14033 Washington server it's a directory that will be concatenated with the
14036 Example server specification:
14039 (nnimap "mail.server.com"
14040 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
14041 ("~friend/Mail/" . "list/*"))))
14044 @item nnimap-stream
14045 @vindex nnimap-stream
14046 The type of stream used to connect to your server. By default, nnimap
14047 will detect and automatically use all of the below, with the exception
14048 of SSL. (SSL is being replaced by STARTTLS, which can be automatically
14049 detected, but it's not widely deployed yet).
14051 Example server specification:
14054 (nnimap "mail.server.com"
14055 (nnimap-stream ssl))
14058 Please note that the value of @code{nnimap-stream} is a symbol!
14062 @dfn{gssapi:} Connect with GSSAPI (usually kerberos 5). Require the
14063 @samp{imtest} program.
14065 @dfn{kerberos4:} Connect with kerberos 4. Require the @samp{imtest} program.
14067 @dfn{starttls:} Connect via the STARTTLS extension (similar to
14068 SSL). Require the external library @samp{starttls.el} and program
14071 @dfn{ssl:} Connect through SSL. Require OpenSSL (the
14072 program @samp{openssl}) or SSLeay (@samp{s_client}).
14074 @dfn{shell:} Use a shell command to start @sc{imap} connection.
14076 @dfn{network:} Plain, TCP/IP network connection.
14079 @vindex imap-kerberos4-program
14080 The @samp{imtest} program is shipped with Cyrus IMAPD, nnimap support
14081 both @samp{imtest} version 1.5.x and version 1.6.x. The variable
14082 @code{imap-kerberos4-program} contain parameters to pass to the imtest
14085 @vindex imap-ssl-program
14086 For SSL connections, the OpenSSL program is available from
14087 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
14088 and nnimap support it too - altough the most recent versions of
14089 SSLeay, 0.9.x, are known to have serious bugs making it
14090 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
14091 work. The variable @code{imap-ssl-program} contain parameters to pass
14094 @vindex imap-shell-program
14095 @vindex imap-shell-host
14096 For @sc{imap} connections using the @code{shell} stream, the variable
14097 @code{imap-shell-program} specify what program to call.
14099 @item nnimap-authenticator
14100 @vindex nnimap-authenticator
14102 The authenticator used to connect to the server. By default, nnimap
14103 will use the most secure authenticator your server is capable of.
14105 Example server specification:
14108 (nnimap "mail.server.com"
14109 (nnimap-authenticator anonymous))
14112 Please note that the value of @code{nnimap-authenticator} is a symbol!
14116 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Require
14117 external program @code{imtest}.
14119 @dfn{kerberos4:} Kerberos authentication. Require external program
14122 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Require
14123 external library @code{digest-md5.el}.
14125 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
14127 @dfn{login:} Plain-text username/password via LOGIN.
14129 @dfn{anonymous:} Login as `anonymous', supplying your emailadress as password.
14132 @item nnimap-expunge-on-close
14134 @vindex nnimap-expunge-on-close
14135 Unlike Parmenides the @sc{imap} designers has decided that things that
14136 doesn't exist actually does exist. More specifically, @sc{imap} has
14137 this concept of marking articles @code{Deleted} which doesn't actually
14138 delete them, and this (marking them @code{Deleted}, that is) is what
14139 nnimap does when you delete a article in Gnus (with @kbd{G DEL} or
14142 Since the articles aren't really removed when we mark them with the
14143 @code{Deleted} flag we'll need a way to actually delete them. Feel like
14144 running in circles yet?
14146 Traditionally, nnimap has removed all articles marked as @code{Deleted}
14147 when closing a mailbox but this is now configurable by this server
14150 The possible options are:
14155 The default behavior, delete all articles marked as "Deleted" when
14158 Never actually delete articles. Currently there is no way of showing
14159 the articles marked for deletion in nnimap, but other @sc{imap} clients
14160 may allow you to do this. If you ever want to run the EXPUNGE command
14161 manually, @xref{Expunging mailboxes}.
14163 When closing mailboxes, nnimap will ask if you wish to expunge deleted
14168 @item nnimap-authinfo-file
14169 @vindex nnimap-authinfo-file
14171 A file containing credentials used to log in on servers. The format
14172 is (almost) the same as the @code{ftp} @file{~/.netrc} file. See
14173 `nntp-authinfo-file' for exact syntax.
14175 A file containing credentials used to log in on servers. The format is
14176 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
14177 variable @code{nntp-authinfo-file} for exact syntax; also see
14183 * Splitting in IMAP:: Splitting mail with nnimap.
14184 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
14185 * Expunging mailboxes:: Equivalent of a "compress mailbox" button.
14190 @node Splitting in IMAP
14191 @subsubsection Splitting in @sc{imap}
14192 @cindex splitting imap mail
14194 Splitting is something Gnus users has loved and used for years, and now
14195 the rest of the world is catching up. Yeah, dream on, not many
14196 @sc{imap} server has server side splitting and those that have splitting
14197 seem to use some non-standard protocol. This means that @sc{imap}
14198 support for Gnus has to do it's own splitting.
14202 Here are the variables of interest:
14206 @item nnimap-split-crosspost
14207 @cindex splitting, crosspost
14209 @vindex nnimap-split-crosspost
14211 If non-nil, do crossposting if several split methods match the mail. If
14212 nil, the first match in @code{nnimap-split-rule} found will be used.
14214 Nnmail equivalent: @code{nnmail-crosspost}.
14216 @item nnimap-split-inbox
14217 @cindex splitting, inbox
14219 @vindex nnimap-split-inbox
14221 A string or a list of strings that gives the name(s) of @sc{imap}
14222 mailboxes to split from. Defaults to nil, which means that splitting is
14226 (setq nnimap-split-inbox
14227 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
14230 No nnmail equivalent.
14232 @item nnimap-split-rule
14233 @cindex Splitting, rules
14234 @vindex nnimap-split-rule
14236 New mail found in @code{nnimap-split-inbox} will be split according to
14239 This variable contains a list of lists, where the first element in the
14240 sublist gives the name of the @sc{imap} mailbox to move articles
14241 matching the regexp in the second element in the sublist. Got that?
14242 Neither did I, we need examples.
14245 (setq nnimap-split-rule
14246 '(("INBOX.nnimap" "^Sender: owner-nnimap@@vic20.globalcom.se")
14247 ("INBOX.junk" "^Subject:.*MAKE MONEY")
14248 ("INBOX.private" "")))
14251 This will put all articles from the nnimap mailing list into mailbox
14252 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
14253 into INBOX.junk and everything else in INBOX.private.
14255 The first string may contain `\\1' forms, like the ones used by
14256 replace-match to insert sub-expressions from the matched text. For
14260 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
14263 The second element can also be a function. In that case, it will be
14264 called with the first element of the rule as the argument, in a buffer
14265 containing the headers of the article. It should return a non-nil value
14266 if it thinks that the mail belongs in that group.
14268 Nnmail users might recollect that the last regexp had to be empty to
14269 match all articles (like in the example above). This is not required in
14270 nnimap. Articles not matching any of the regexps will not be moved out
14271 of your inbox. (This might affect performance if you keep lots of
14272 unread articles in your inbox, since the splitting code would go over
14273 them every time you fetch new mail.)
14275 These rules are processed from the beginning of the alist toward the
14276 end. The first rule to make a match will "win", unless you have
14277 crossposting enabled. In that case, all matching rules will "win".
14279 This variable can also have a function as its value, the function will
14280 be called with the headers narrowed and should return a group where it
14281 thinks the article should be split to. See @code{nnimap-split-fancy}.
14283 The splitting code tries to create mailboxes if it need too.
14285 To allow for different split rules on different virtual servers, and
14286 even different split rules in different inboxes on the same server,
14287 the syntax of this variable have been extended along the lines of:
14290 (setq nnimap-split-rule
14291 '(("my1server" (".*" (("ding" "ding@@gnus.org")
14292 ("junk" "From:.*Simon")))
14293 ("my2server" ("INBOX" nnimap-split-fancy))
14294 ("my[34]server" (".*" (("private" "To:.*Simon")
14295 ("junk" my-junk-func)))))
14298 The virtual server name is in fact a regexp, so that the same rules
14299 may apply to several servers. In the example, the servers
14300 @code{my3server} and @code{my4server} both use the same rules.
14301 Similarly, the inbox string is also a regexp. The actual splitting
14302 rules are as before, either a function, or a list with group/regexp or
14303 group/function elements.
14305 Nnmail equivalent: @code{nnmail-split-methods}.
14307 @item nnimap-split-predicate
14309 @vindex nnimap-split-predicate
14311 Mail matching this predicate in @code{nnimap-split-inbox} will be
14312 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
14314 This might be useful if you use another @sc{imap} client to read mail in
14315 your inbox but would like Gnus to split all articles in the inbox
14316 regardless of readedness. Then you might change this to
14319 @item nnimap-split-fancy
14320 @cindex splitting, fancy
14321 @findex nnimap-split-fancy
14322 @vindex nnimap-split-fancy
14324 It's possible to set @code{nnimap-split-rule} to
14325 @code{nnmail-split-fancy} if you want to use fancy
14326 splitting. @xref{Fancy Mail Splitting}.
14328 However, to be able to have different fancy split rules for nnmail and
14329 nnimap backends you can set @code{nnimap-split-rule} to
14330 @code{nnimap-split-fancy} and define the nnimap specific fancy split
14331 rule in @code{nnimap-split-fancy}.
14336 (setq nnimap-split-rule 'nnimap-split-fancy
14337 nnimap-split-fancy ...)
14340 Nnmail equivalent: @code{nnmail-split-fancy}.
14344 @node Editing IMAP ACLs
14345 @subsubsection Editing @sc{imap} ACLs
14346 @cindex editing imap acls
14347 @cindex Access Control Lists
14348 @cindex Editing @sc{imap} ACLs
14350 @findex gnus-group-nnimap-edit-acl
14352 ACL stands for Access Control List. ACLs are used in @sc{imap} for
14353 limiting (or enabling) other users access to your mail boxes. Not all
14354 @sc{imap} servers support this, this function will give an error if it
14357 To edit a ACL for a mailbox, type @kbd{G l}
14358 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with a ACL
14359 editing window with detailed instructions.
14361 Some possible uses:
14365 Giving "anyone" the "lrs" rights (lookup, read, keep seen/unseen flags)
14366 on your mailing list mailboxes enables other users on the same server to
14367 follow the list without subscribing to it.
14369 At least with the Cyrus server, you are required to give the user
14370 "anyone" posting ("p") capabilities to have "plussing" work (that is,
14371 mail sent to user+mailbox@@domain ending up in the @sc{imap} mailbox
14375 @node Expunging mailboxes
14376 @subsubsection Expunging mailboxes
14380 @cindex Manual expunging
14382 @findex gnus-group-nnimap-expunge
14384 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
14385 you may want the option of expunging all deleted articles in a mailbox
14386 manually. This is exactly what @kbd{G x} does.
14388 Currently there is no way of showing deleted articles, you can just
14393 @node Combined Groups
14394 @section Combined Groups
14396 Gnus allows combining a mixture of all the other group types into bigger
14400 * Virtual Groups:: Combining articles from many groups.
14401 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
14405 @node Virtual Groups
14406 @subsection Virtual Groups
14408 @cindex virtual groups
14409 @cindex merging groups
14411 An @dfn{nnvirtual group} is really nothing more than a collection of
14414 For instance, if you are tired of reading many small groups, you can
14415 put them all in one big group, and then grow tired of reading one
14416 big, unwieldy group. The joys of computing!
14418 You specify @code{nnvirtual} as the method. The address should be a
14419 regexp to match component groups.
14421 All marks in the virtual group will stick to the articles in the
14422 component groups. So if you tick an article in a virtual group, the
14423 article will also be ticked in the component group from whence it came.
14424 (And vice versa---marks from the component groups will also be shown in
14425 the virtual group.)
14427 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
14428 newsgroups into one, big, happy newsgroup:
14431 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
14434 The component groups can be native or foreign; everything should work
14435 smoothly, but if your computer explodes, it was probably my fault.
14437 Collecting the same group from several servers might actually be a good
14438 idea if users have set the Distribution header to limit distribution.
14439 If you would like to read @samp{soc.motss} both from a server in Japan
14440 and a server in Norway, you could use the following as the group regexp:
14443 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
14446 (Remember, though, that if you're creating the group with @kbd{G m}, you
14447 shouldn't double the backslashes, and you should leave off the quote
14448 characters at the beginning and the end of the string.)
14450 This should work kinda smoothly---all articles from both groups should
14451 end up in this one, and there should be no duplicates. Threading (and
14452 the rest) will still work as usual, but there might be problems with the
14453 sequence of articles. Sorting on date might be an option here
14454 (@pxref{Selecting a Group}).
14456 One limitation, however---all groups included in a virtual
14457 group have to be alive (i.e., subscribed or unsubscribed). Killed or
14458 zombie groups can't be component groups for @code{nnvirtual} groups.
14460 @vindex nnvirtual-always-rescan
14461 If the @code{nnvirtual-always-rescan} is non-@code{nil},
14462 @code{nnvirtual} will always scan groups for unread articles when
14463 entering a virtual group. If this variable is @code{nil} (which is the
14464 default) and you read articles in a component group after the virtual
14465 group has been activated, the read articles from the component group
14466 will show up when you enter the virtual group. You'll also see this
14467 effect if you have two virtual groups that have a component group in
14468 common. If that's the case, you should set this variable to @code{t}.
14469 Or you can just tap @code{M-g} on the virtual group every time before
14470 you enter it---it'll have much the same effect.
14472 @code{nnvirtual} can have both mail and news groups as component groups.
14473 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
14474 has to ask the backend of the component group the article comes from
14475 whether it is a news or mail backend. However, when you do a @kbd{^},
14476 there is typically no sure way for the component backend to know this,
14477 and in that case @code{nnvirtual} tells Gnus that the article came from a
14478 not-news backend. (Just to be on the safe side.)
14480 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
14481 line from the article you respond to in these cases.
14485 @node Kibozed Groups
14486 @subsection Kibozed Groups
14490 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
14491 the news feed''. @code{nnkiboze} is a backend that will do this for
14492 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
14493 with useless requests! Oh happiness!
14495 @kindex G k (Group)
14496 To create a kibozed group, use the @kbd{G k} command in the group
14499 The address field of the @code{nnkiboze} method is, as with
14500 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
14501 @code{nnkiboze} group. That's where most similarities between @code{nnkiboze}
14502 and @code{nnvirtual} end.
14504 In addition to this regexp detailing component groups, an @code{nnkiboze} group
14505 must have a score file to say what articles are to be included in
14506 the group (@pxref{Scoring}).
14508 @kindex M-x nnkiboze-generate-groups
14509 @findex nnkiboze-generate-groups
14510 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
14511 @code{nnkiboze} groups you want to have. This command will take time. Lots of
14512 time. Oodles and oodles of time. Gnus has to fetch the headers from
14513 all the articles in all the component groups and run them through the
14514 scoring process to determine if there are any articles in the groups
14515 that are to be part of the @code{nnkiboze} groups.
14517 Please limit the number of component groups by using restrictive
14518 regexps. Otherwise your sysadmin may become annoyed with you, and the
14519 @sc{nntp} site may throw you off and never let you back in again.
14520 Stranger things have happened.
14522 @code{nnkiboze} component groups do not have to be alive---they can be dead,
14523 and they can be foreign. No restrictions.
14525 @vindex nnkiboze-directory
14526 The generation of an @code{nnkiboze} group means writing two files in
14527 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
14528 contains the @sc{nov} header lines for all the articles in the group,
14529 and the other is an additional @file{.newsrc} file to store information
14530 on what groups have been searched through to find component articles.
14532 Articles marked as read in the @code{nnkiboze} group will have
14533 their @sc{nov} lines removed from the @sc{nov} file.
14536 @node Gnus Unplugged
14537 @section Gnus Unplugged
14542 @cindex Gnus Unplugged
14544 In olden times (ca. February '88), people used to run their newsreaders
14545 on big machines with permanent connections to the net. News transport
14546 was dealt with by news servers, and all the newsreaders had to do was to
14547 read news. Believe it or not.
14549 Nowadays most people read news and mail at home, and use some sort of
14550 modem to connect to the net. To avoid running up huge phone bills, it
14551 would be nice to have a way to slurp down all the news and mail, hang up
14552 the phone, read for several hours, and then upload any responses you
14553 have to make. And then you repeat the procedure.
14555 Of course, you can use news servers for doing this as well. I've used
14556 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
14557 for some years, but doing that's a bore. Moving the news server
14558 functionality up to the newsreader makes sense if you're the only person
14559 reading news on a machine.
14561 Using Gnus as an ``offline'' newsreader is quite simple.
14565 First, set up Gnus as you would do if you were running it on a machine
14566 that has full connection to the net. Go ahead. I'll still be waiting
14570 Then, put the following magical incantation at the end of your
14571 @file{.gnus.el} file:
14578 That's it. Gnus is now an ``offline'' newsreader.
14580 Of course, to use it as such, you have to learn a few new commands.
14583 * Agent Basics:: How it all is supposed to work.
14584 * Agent Categories:: How to tell the Gnus Agent what to download.
14585 * Agent Commands:: New commands for all the buffers.
14586 * Agent Expiry:: How to make old articles go away.
14587 * Agent and IMAP:: How to use the Agent with IMAP.
14588 * Outgoing Messages:: What happens when you post/mail something?
14589 * Agent Variables:: Customizing is fun.
14590 * Example Setup:: An example @file{.gnus.el} file for offline people.
14591 * Batching Agents:: How to fetch news from a @code{cron} job.
14592 * Agent Caveats:: What you think it'll do and what it does.
14597 @subsection Agent Basics
14599 First, let's get some terminology out of the way.
14601 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
14602 connection to the net (and notified the Agent that this is the case).
14603 When the connection to the net is up again (and Gnus knows this), the
14604 Agent is @dfn{plugged}.
14606 The @dfn{local} machine is the one you're running on, and which isn't
14607 connected to the net continuously.
14609 @dfn{Downloading} means fetching things from the net to your local
14610 machine. @dfn{Uploading} is doing the opposite.
14612 Let's take a typical Gnus session using the Agent.
14617 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
14618 Agent in a disconnected state. You can read all the news that you have
14619 already fetched while in this mode.
14622 You then decide to see whether any new news has arrived. You connect
14623 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
14624 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
14625 as usual. To check for new mail in unplugged mode, see (@pxref{Mail
14626 Source Specifiers}).
14629 You can then read the new news immediately, or you can download the news
14630 onto your local machine. If you want to do the latter, you press @kbd{g}
14631 to check if there are any new news and then @kbd{J
14632 s} to fetch all the eligible articles in all the groups. (To let Gnus
14633 know which articles you want to download, @pxref{Agent Categories}.)
14636 After fetching the articles, you press @kbd{J j} to make Gnus become
14637 unplugged again, and you shut down the PPP thing (or whatever). And
14638 then you read the news offline.
14641 And then you go to step 2.
14644 Here are some things you should do the first time (or so) that you use
14650 Decide which servers should be covered by the Agent. If you have a mail
14651 backend, it would probably be nonsensical to have it covered by the
14652 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
14653 @kbd{J a} the server (or servers) that you wish to have covered by the
14654 Agent (@pxref{Server Agent Commands}). This will typically be only the
14655 primary select method, which is listed on the bottom in the buffer.
14658 Decide on download policy. @xref{Agent Categories}.
14665 @node Agent Categories
14666 @subsection Agent Categories
14668 One of the main reasons to integrate the news transport layer into the
14669 newsreader is to allow greater control over what articles to download.
14670 There's not much point in downloading huge amounts of articles, just to
14671 find out that you're not interested in reading any of them. It's better
14672 to be somewhat more conservative in choosing what to download, and then
14673 mark the articles for downloading manually if it should turn out that
14674 you're interested in the articles anyway.
14676 The main way to control what is to be downloaded is to create a
14677 @dfn{category} and then assign some (or all) groups to this category.
14678 Groups that do not belong in any other category belong to the
14679 @code{default} category. Gnus has its own buffer for creating and
14680 managing categories.
14683 * Category Syntax:: What a category looks like.
14684 * Category Buffer:: A buffer for maintaining categories.
14685 * Category Variables:: Customize'r'Us.
14689 @node Category Syntax
14690 @subsubsection Category Syntax
14692 A category consists of two things.
14696 A predicate which (generally) gives a rough outline of which articles
14697 are eligible for downloading; and
14700 a score rule which (generally) gives you a finer granularity when
14701 deciding what articles to download. (Note that this @dfn{download
14702 score} is not necessarily related to normal scores.)
14705 A predicate in its simplest form can be a single predicate such as
14706 @code{true} or @code{false}. These two will download every available
14707 article or nothing respectively. In the case of these two special
14708 predicates an additional score rule is superfluous.
14710 Predicates of @code{high} or @code{low} download articles in respect of
14711 their scores in relationship to @code{gnus-agent-high-score} and
14712 @code{gnus-agent-low-score} as described below.
14714 To gain even finer control of what is to be regarded eligible for
14715 download a predicate can consist of a number of predicates with logical
14716 operators sprinkled in between.
14718 Perhaps some examples are in order.
14720 Here's a simple predicate. (It's the default predicate, in fact, used
14721 for all groups that don't belong to any other category.)
14727 Quite simple, eh? This predicate is true if and only if the article is
14728 short (for some value of ``short'').
14730 Here's a more complex predicate:
14739 This means that an article should be downloaded if it has a high score,
14740 or if the score is not low and the article is not long. You get the
14743 The available logical operators are @code{or}, @code{and} and
14744 @code{not}. (If you prefer, you can use the more ``C''-ish operators
14745 @samp{|}, @code{&} and @code{!} instead.)
14747 The following predicates are pre-defined, but if none of these fit what
14748 you want to do, you can write your own.
14752 True iff the article is shorter than @code{gnus-agent-short-article}
14753 lines; default 100.
14756 True iff the article is longer than @code{gnus-agent-long-article}
14757 lines; default 200.
14760 True iff the article has a download score less than
14761 @code{gnus-agent-low-score}; default 0.
14764 True iff the article has a download score greater than
14765 @code{gnus-agent-high-score}; default 0.
14768 True iff the Gnus Agent guesses that the article is spam. The
14769 heuristics may change over time, but at present it just computes a
14770 checksum and sees whether articles match.
14779 If you want to create your own predicate function, here's what you have
14780 to know: The functions are called with no parameters, but the
14781 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
14784 For example, you could decide that you don't want to download articles
14785 that were posted more than a certain number of days ago (e.g. posted
14786 more than @code{gnus-agent-expire-days} ago) you might write a function
14787 something along the lines of the following:
14790 (defun my-article-old-p ()
14791 "Say whether an article is old."
14792 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
14793 (- (time-to-days (current-time)) gnus-agent-expire-days)))
14796 with the predicate then defined as:
14799 (not my-article-old-p)
14802 or you could append your predicate to the predefined
14803 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
14804 wherever. (Note: this would have to be at a point *after*
14805 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
14808 (setq gnus-category-predicate-alist
14809 (append gnus-category-predicate-alist
14810 '((old . my-article-old-p))))
14813 and simply specify your predicate as:
14819 If/when using something like the above, be aware that there are many
14820 misconfigured systems/mailers out there and so an article's date is not
14821 always a reliable indication of when it was posted. Hell, some people
14822 just don't give a damn.
14824 The above predicates apply to *all* the groups which belong to the
14825 category. However, if you wish to have a specific predicate for an
14826 individual group within a category, or you're just too lazy to set up a
14827 new category, you can enter a group's individual predicate in it's group
14828 parameters like so:
14831 (agent-predicate . short)
14834 This is the group parameter equivalent of the agent category default.
14835 Note that when specifying a single word predicate like this, the
14836 @code{agent-predicate} specification must be in dotted pair notation.
14838 The equivalent of the longer example from above would be:
14841 (agent-predicate or high (and (not low) (not long)))
14844 The outer parenthesis required in the category specification are not
14845 entered here as, not being in dotted pair notation, the value of the
14846 predicate is assumed to be a list.
14849 Now, the syntax of the download score is the same as the syntax of
14850 normal score files, except that all elements that require actually
14851 seeing the article itself are verboten. This means that only the
14852 following headers can be scored on: @code{Subject}, @code{From},
14853 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
14854 @code{Lines}, and @code{Xref}.
14856 As with predicates, the specification of the @code{download score rule}
14857 to use in respect of a group can be in either the category definition if
14858 it's to be applicable to all groups in therein, or a group's parameters
14859 if it's to be specific to that group.
14861 In both of these places the @code{download score rule} can take one of
14868 This has the same syntax as a normal gnus score file except only a
14869 subset of scoring keywords are available as mentioned above.
14875 Category specification
14879 ("Lars Ingebrigtsen" 1000000 nil s))
14885 Group Parameter specification
14888 (agent-score ("from"
14889 ("Lars Ingebrigtsen" 1000000 nil s))
14894 Again, note the omission of the outermost parenthesis here.
14900 These score files must *only* contain the permitted scoring keywords
14907 Category specification
14910 ("~/News/agent.SCORE")
14916 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
14920 Group Parameter specification
14923 (agent-score "~/News/agent.SCORE")
14926 Additional score files can be specified as above. Need I say anything
14931 Use @code{normal} score files
14933 If you don't want to maintain two sets of scoring rules for a group, and
14934 your desired @code{downloading} criteria for a group are the same as your
14935 @code{reading} criteria then you can tell the agent to refer to your
14936 @code{normal} score files when deciding what to download.
14938 These directives in either the category definition or a group's
14939 parameters will cause the agent to read in all the applicable score
14940 files for a group, *filtering out* those sections that do not
14941 relate to one of the permitted subset of scoring keywords.
14945 Category Specification
14952 Group Parameter specification
14955 (agent-score . file)
14960 @node Category Buffer
14961 @subsubsection Category Buffer
14963 You'd normally do all category maintenance from the category buffer.
14964 When you enter it for the first time (with the @kbd{J c} command from
14965 the group buffer), you'll only see the @code{default} category.
14967 The following commands are available in this buffer:
14971 @kindex q (Category)
14972 @findex gnus-category-exit
14973 Return to the group buffer (@code{gnus-category-exit}).
14976 @kindex k (Category)
14977 @findex gnus-category-kill
14978 Kill the current category (@code{gnus-category-kill}).
14981 @kindex c (Category)
14982 @findex gnus-category-copy
14983 Copy the current category (@code{gnus-category-copy}).
14986 @kindex a (Category)
14987 @findex gnus-category-add
14988 Add a new category (@code{gnus-category-add}).
14991 @kindex p (Category)
14992 @findex gnus-category-edit-predicate
14993 Edit the predicate of the current category
14994 (@code{gnus-category-edit-predicate}).
14997 @kindex g (Category)
14998 @findex gnus-category-edit-groups
14999 Edit the list of groups belonging to the current category
15000 (@code{gnus-category-edit-groups}).
15003 @kindex s (Category)
15004 @findex gnus-category-edit-score
15005 Edit the download score rule of the current category
15006 (@code{gnus-category-edit-score}).
15009 @kindex l (Category)
15010 @findex gnus-category-list
15011 List all the categories (@code{gnus-category-list}).
15015 @node Category Variables
15016 @subsubsection Category Variables
15019 @item gnus-category-mode-hook
15020 @vindex gnus-category-mode-hook
15021 Hook run in category buffers.
15023 @item gnus-category-line-format
15024 @vindex gnus-category-line-format
15025 Format of the lines in the category buffer (@pxref{Formatting
15026 Variables}). Valid elements are:
15030 The name of the category.
15033 The number of groups in the category.
15036 @item gnus-category-mode-line-format
15037 @vindex gnus-category-mode-line-format
15038 Format of the category mode line (@pxref{Mode Line Formatting}).
15040 @item gnus-agent-short-article
15041 @vindex gnus-agent-short-article
15042 Articles that have fewer lines than this are short. Default 100.
15044 @item gnus-agent-long-article
15045 @vindex gnus-agent-long-article
15046 Articles that have more lines than this are long. Default 200.
15048 @item gnus-agent-low-score
15049 @vindex gnus-agent-low-score
15050 Articles that have a score lower than this have a low score. Default
15053 @item gnus-agent-high-score
15054 @vindex gnus-agent-high-score
15055 Articles that have a score higher than this have a high score. Default
15061 @node Agent Commands
15062 @subsection Agent Commands
15064 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
15065 (@code{gnus-agent-toggle-plugged} command works in all modes, and
15066 toggles the plugged/unplugged state of the Gnus Agent.
15070 * Group Agent Commands::
15071 * Summary Agent Commands::
15072 * Server Agent Commands::
15075 You can run a complete batch fetch from the command line with the
15076 following incantation:
15078 @cindex gnus-agent-batch-fetch
15080 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
15085 @node Group Agent Commands
15086 @subsubsection Group Agent Commands
15090 @kindex J u (Agent Group)
15091 @findex gnus-agent-fetch-groups
15092 Fetch all eligible articles in the current group
15093 (@code{gnus-agent-fetch-groups}).
15096 @kindex J c (Agent Group)
15097 @findex gnus-enter-category-buffer
15098 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
15101 @kindex J s (Agent Group)
15102 @findex gnus-agent-fetch-session
15103 Fetch all eligible articles in all groups
15104 (@code{gnus-agent-fetch-session}).
15107 @kindex J S (Agent Group)
15108 @findex gnus-group-send-drafts
15109 Send all sendable messages in the draft group
15110 (@code{gnus-group-send-drafts}). @xref{Drafts}.
15113 @kindex J a (Agent Group)
15114 @findex gnus-agent-add-group
15115 Add the current group to an Agent category
15116 (@code{gnus-agent-add-group}). This command understands the
15117 process/prefix convention (@pxref{Process/Prefix}).
15120 @kindex J r (Agent Group)
15121 @findex gnus-agent-remove-group
15122 Remove the current group from its category, if any
15123 (@code{gnus-agent-remove-group}). This command understands the
15124 process/prefix convention (@pxref{Process/Prefix}).
15127 @kindex J Y (Agent Group)
15128 @findex gnus-agent-synchronize-flags
15129 Synchronize flags changed while unplugged with remote server, if any.
15135 @node Summary Agent Commands
15136 @subsubsection Summary Agent Commands
15140 @kindex J # (Agent Summary)
15141 @findex gnus-agent-mark-article
15142 Mark the article for downloading (@code{gnus-agent-mark-article}).
15145 @kindex J M-# (Agent Summary)
15146 @findex gnus-agent-unmark-article
15147 Remove the downloading mark from the article
15148 (@code{gnus-agent-unmark-article}).
15151 @kindex @@ (Agent Summary)
15152 @findex gnus-agent-toggle-mark
15153 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
15156 @kindex J c (Agent Summary)
15157 @findex gnus-agent-catchup
15158 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
15163 @node Server Agent Commands
15164 @subsubsection Server Agent Commands
15168 @kindex J a (Agent Server)
15169 @findex gnus-agent-add-server
15170 Add the current server to the list of servers covered by the Gnus Agent
15171 (@code{gnus-agent-add-server}).
15174 @kindex J r (Agent Server)
15175 @findex gnus-agent-remove-server
15176 Remove the current server from the list of servers covered by the Gnus
15177 Agent (@code{gnus-agent-remove-server}).
15183 @subsection Agent Expiry
15185 @vindex gnus-agent-expire-days
15186 @findex gnus-agent-expire
15187 @kindex M-x gnus-agent-expire
15188 @cindex Agent expiry
15189 @cindex Gnus Agent expiry
15192 @code{nnagent} doesn't handle expiry. Instead, there's a special
15193 @code{gnus-agent-expire} command that will expire all read articles that
15194 are older than @code{gnus-agent-expire-days} days. It can be run
15195 whenever you feel that you're running out of space. It's not
15196 particularly fast or efficient, and it's not a particularly good idea to
15197 interrupt it (with @kbd{C-g} or anything else) once you've started it.
15199 @vindex gnus-agent-expire-all
15200 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
15201 expire all articles---unread, read, ticked and dormant. If @code{nil}
15202 (which is the default), only read articles are eligible for expiry, and
15203 unread, ticked and dormant articles will be kept indefinitely.
15206 @node Agent and IMAP
15207 @subsection Agent and IMAP
15209 The Agent work with any Gnus backend, including nnimap. However,
15210 since there are some conceptual differences between @sc{nntp} and
15211 @sc{imap}, this section (should) provide you with some information to
15212 make Gnus Agent work smoother as a @sc{imap} Disconnected Mode client.
15214 The first thing to keep in mind is that all flags (read, ticked, etc)
15215 are kept on the @sc{imap} server, rather than in @code{.newsrc} as is the
15216 case for nntp. Thus Gnus need to remember flag changes when
15217 disconnected, and synchronize these flags when you plug back in.
15219 Gnus keep track of flag changes when reading nnimap groups under the
15220 Agent by default. When you plug back in, by default Gnus will check if
15221 you have any changed any flags and ask if you wish to synchronize these
15222 with the server. This behavior is customizable with
15223 @code{gnus-agent-synchronize-flags}.
15225 @vindex gnus-agent-synchronize-flags
15226 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
15227 never automatically synchronize flags. If it is @code{ask}, the
15228 default, the Agent will check if you made any changes and if so ask if
15229 you wish to synchronize these when you re-connect. If it has any other
15230 value, all flags will be synchronized automatically.
15232 If you do not wish to automatically synchronize flags when you
15233 re-connect, this can be done manually with the
15234 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
15235 in the group buffer by default.
15237 Some things are currently not implemented in the Agent that you'd might
15238 expect from a disconnected @sc{imap} client, including:
15243 Copying/moving articles into nnimap groups when unplugged.
15246 Creating/deleting nnimap groups when unplugged.
15250 Technical note: the synchronization algorithm does not work by "pushing"
15251 all local flags to the server, but rather incrementally update the
15252 server view of flags by changing only those flags that were changed by
15253 the user. Thus, if you set one flag on a article, quit the group and
15254 re-select the group and remove the flag; the flag will be set and
15255 removed from the server when you "synchronize". The queued flag
15256 operations can be found in the per-server @code{flags} file in the Agent
15257 directory. It's emptied when you synchronize flags.
15260 @node Outgoing Messages
15261 @subsection Outgoing Messages
15263 When Gnus is unplugged, all outgoing messages (both mail and news) are
15264 stored in the draft groups (@pxref{Drafts}). You can view them there
15265 after posting, and edit them at will.
15267 When Gnus is plugged again, you can send the messages either from the
15268 draft group with the special commands available there, or you can use
15269 the @kbd{J S} command in the group buffer to send all the sendable
15270 messages in the draft group.
15274 @node Agent Variables
15275 @subsection Agent Variables
15278 @item gnus-agent-directory
15279 @vindex gnus-agent-directory
15280 Where the Gnus Agent will store its files. The default is
15281 @file{~/News/agent/}.
15283 @item gnus-agent-handle-level
15284 @vindex gnus-agent-handle-level
15285 Groups on levels (@pxref{Group Levels}) higher than this variable will
15286 be ignored by the Agent. The default is @code{gnus-level-subscribed},
15287 which means that only subscribed group will be considered by the Agent
15290 @item gnus-agent-plugged-hook
15291 @vindex gnus-agent-plugged-hook
15292 Hook run when connecting to the network.
15294 @item gnus-agent-unplugged-hook
15295 @vindex gnus-agent-unplugged-hook
15296 Hook run when disconnecting from the network.
15301 @node Example Setup
15302 @subsection Example Setup
15304 If you don't want to read this manual, and you have a fairly standard
15305 setup, you may be able to use something like the following as your
15306 @file{.gnus.el} file to get started.
15309 ;;; Define how Gnus is to fetch news. We do this over @sc{nntp}
15310 ;;; from your ISP's server.
15311 (setq gnus-select-method '(nntp "news.your-isp.com"))
15313 ;;; Define how Gnus is to read your mail. We read mail from
15314 ;;; your ISP's POP server.
15315 (setq mail-sources '((pop :server "pop.your-isp.com")))
15317 ;;; Say how Gnus is to store the mail. We use nnml groups.
15318 (setq gnus-secondary-select-methods '((nnml "")))
15320 ;;; Make Gnus into an offline newsreader.
15324 That should be it, basically. Put that in your @file{~/.gnus.el} file,
15325 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
15328 If this is the first time you've run Gnus, you will be subscribed
15329 automatically to a few default newsgroups. You'll probably want to
15330 subscribe to more groups, and to do that, you have to query the
15331 @sc{nntp} server for a complete list of groups with the @kbd{A A}
15332 command. This usually takes quite a while, but you only have to do it
15335 After reading and parsing a while, you'll be presented with a list of
15336 groups. Subscribe to the ones you want to read with the @kbd{u}
15337 command. @kbd{l} to make all the killed groups disappear after you've
15338 subscribe to all the groups you want to read. (@kbd{A k} will bring
15339 back all the killed groups.)
15341 You can now read the groups at once, or you can download the articles
15342 with the @kbd{J s} command. And then read the rest of this manual to
15343 find out which of the other gazillion things you want to customize.
15346 @node Batching Agents
15347 @subsection Batching Agents
15349 Having the Gnus Agent fetch articles (and post whatever messages you've
15350 written) is quite easy once you've gotten things set up properly. The
15351 following shell script will do everything that is necessary:
15355 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
15359 @node Agent Caveats
15360 @subsection Agent Caveats
15362 The Gnus Agent doesn't seem to work like most other offline
15363 newsreaders. Here are some common questions that some imaginary people
15367 @item If I read an article while plugged, do they get entered into the
15372 @item If I read an article while plugged, and the article already exists
15373 in the Agent, will it get downloaded once more?
15379 In short, when Gnus is unplugged, it only looks into the locally stored
15380 articles; when it's plugged, it only talks to your ISP.
15387 Other people use @dfn{kill files}, but we here at Gnus Towers like
15388 scoring better than killing, so we'd rather switch than fight. They do
15389 something completely different as well, so sit up straight and pay
15392 @vindex gnus-summary-mark-below
15393 All articles have a default score (@code{gnus-summary-default-score}),
15394 which is 0 by default. This score may be raised or lowered either
15395 interactively or by score files. Articles that have a score lower than
15396 @code{gnus-summary-mark-below} are marked as read.
15398 Gnus will read any @dfn{score files} that apply to the current group
15399 before generating the summary buffer.
15401 There are several commands in the summary buffer that insert score
15402 entries based on the current article. You can, for instance, ask Gnus to
15403 lower or increase the score of all articles with a certain subject.
15405 There are two sorts of scoring entries: Permanent and temporary.
15406 Temporary score entries are self-expiring entries. Any entries that are
15407 temporary and have not been used for, say, a week, will be removed
15408 silently to help keep the sizes of the score files down.
15411 * Summary Score Commands:: Adding score entries for the current group.
15412 * Group Score Commands:: General score commands.
15413 * Score Variables:: Customize your scoring. (My, what terminology).
15414 * Score File Format:: What a score file may contain.
15415 * Score File Editing:: You can edit score files by hand as well.
15416 * Adaptive Scoring:: Big Sister Gnus knows what you read.
15417 * Home Score File:: How to say where new score entries are to go.
15418 * Followups To Yourself:: Having Gnus notice when people answer you.
15419 * Scoring Tips:: How to score effectively.
15420 * Reverse Scoring:: That problem child of old is not problem.
15421 * Global Score Files:: Earth-spanning, ear-splitting score files.
15422 * Kill Files:: They are still here, but they can be ignored.
15423 * Converting Kill Files:: Translating kill files to score files.
15424 * GroupLens:: Getting predictions on what you like to read.
15425 * Advanced Scoring:: Using logical expressions to build score rules.
15426 * Score Decays:: It can be useful to let scores wither away.
15430 @node Summary Score Commands
15431 @section Summary Score Commands
15432 @cindex score commands
15434 The score commands that alter score entries do not actually modify real
15435 score files. That would be too inefficient. Gnus maintains a cache of
15436 previously loaded score files, one of which is considered the
15437 @dfn{current score file alist}. The score commands simply insert
15438 entries into this list, and upon group exit, this list is saved.
15440 The current score file is by default the group's local score file, even
15441 if no such score file actually exists. To insert score commands into
15442 some other score file (e.g. @file{all.SCORE}), you must first make this
15443 score file the current one.
15445 General score commands that don't actually change the score file:
15450 @kindex V s (Summary)
15451 @findex gnus-summary-set-score
15452 Set the score of the current article (@code{gnus-summary-set-score}).
15455 @kindex V S (Summary)
15456 @findex gnus-summary-current-score
15457 Display the score of the current article
15458 (@code{gnus-summary-current-score}).
15461 @kindex V t (Summary)
15462 @findex gnus-score-find-trace
15463 Display all score rules that have been used on the current article
15464 (@code{gnus-score-find-trace}).
15467 @kindex V R (Summary)
15468 @findex gnus-summary-rescore
15469 Run the current summary through the scoring process
15470 (@code{gnus-summary-rescore}). This might be useful if you're playing
15471 around with your score files behind Gnus' back and want to see the
15472 effect you're having.
15475 @kindex V c (Summary)
15476 @findex gnus-score-change-score-file
15477 Make a different score file the current
15478 (@code{gnus-score-change-score-file}).
15481 @kindex V e (Summary)
15482 @findex gnus-score-edit-current-scores
15483 Edit the current score file (@code{gnus-score-edit-current-scores}).
15484 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
15488 @kindex V f (Summary)
15489 @findex gnus-score-edit-file
15490 Edit a score file and make this score file the current one
15491 (@code{gnus-score-edit-file}).
15494 @kindex V F (Summary)
15495 @findex gnus-score-flush-cache
15496 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
15497 after editing score files.
15500 @kindex V C (Summary)
15501 @findex gnus-score-customize
15502 Customize a score file in a visually pleasing manner
15503 (@code{gnus-score-customize}).
15507 The rest of these commands modify the local score file.
15512 @kindex V m (Summary)
15513 @findex gnus-score-set-mark-below
15514 Prompt for a score, and mark all articles with a score below this as
15515 read (@code{gnus-score-set-mark-below}).
15518 @kindex V x (Summary)
15519 @findex gnus-score-set-expunge-below
15520 Prompt for a score, and add a score rule to the current score file to
15521 expunge all articles below this score
15522 (@code{gnus-score-set-expunge-below}).
15525 The keystrokes for actually making score entries follow a very regular
15526 pattern, so there's no need to list all the commands. (Hundreds of
15529 @findex gnus-summary-increase-score
15530 @findex gnus-summary-lower-score
15534 The first key is either @kbd{I} (upper case i) for increasing the score
15535 or @kbd{L} for lowering the score.
15537 The second key says what header you want to score on. The following
15538 keys are available:
15542 Score on the author name.
15545 Score on the subject line.
15548 Score on the @code{Xref} line---i.e., the cross-posting line.
15551 Score on the @code{References} line.
15557 Score on the number of lines.
15560 Score on the @code{Message-ID} header.
15563 Score on followups---this matches the author name, and adds scores to
15564 the followups to this author.
15578 The third key is the match type. Which match types are valid depends on
15579 what headers you are scoring on.
15591 Substring matching.
15594 Fuzzy matching (@pxref{Fuzzy Matching}).
15623 Greater than number.
15628 The fourth and final key says whether this is a temporary (i.e., expiring)
15629 score entry, or a permanent (i.e., non-expiring) score entry, or whether
15630 it is to be done immediately, without adding to the score file.
15634 Temporary score entry.
15637 Permanent score entry.
15640 Immediately scoring.
15645 So, let's say you want to increase the score on the current author with
15646 exact matching permanently: @kbd{I a e p}. If you want to lower the
15647 score based on the subject line, using substring matching, and make a
15648 temporary score entry: @kbd{L s s t}. Pretty easy.
15650 To make things a bit more complicated, there are shortcuts. If you use
15651 a capital letter on either the second or third keys, Gnus will use
15652 defaults for the remaining one or two keystrokes. The defaults are
15653 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
15654 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
15656 These functions take both the numerical prefix and the symbolic prefix
15657 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
15658 (or increase) the score of the article. A symbolic prefix of @code{a}
15659 says to use the @file{all.SCORE} file for the command instead of the
15660 current score file.
15662 @vindex gnus-score-mimic-keymap
15663 The @code{gnus-score-mimic-keymap} says whether these commands will
15664 pretend they are keymaps or not.
15667 @node Group Score Commands
15668 @section Group Score Commands
15669 @cindex group score commands
15671 There aren't many of these as yet, I'm afraid.
15676 @kindex W f (Group)
15677 @findex gnus-score-flush-cache
15678 Gnus maintains a cache of score alists to avoid having to reload them
15679 all the time. This command will flush the cache
15680 (@code{gnus-score-flush-cache}).
15684 You can do scoring from the command line by saying something like:
15686 @findex gnus-batch-score
15687 @cindex batch scoring
15689 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
15693 @node Score Variables
15694 @section Score Variables
15695 @cindex score variables
15699 @item gnus-use-scoring
15700 @vindex gnus-use-scoring
15701 If @code{nil}, Gnus will not check for score files, and will not, in
15702 general, do any score-related work. This is @code{t} by default.
15704 @item gnus-kill-killed
15705 @vindex gnus-kill-killed
15706 If this variable is @code{nil}, Gnus will never apply score files to
15707 articles that have already been through the kill process. While this
15708 may save you lots of time, it also means that if you apply a kill file
15709 to a group, and then change the kill file and want to run it over you
15710 group again to kill more articles, it won't work. You have to set this
15711 variable to @code{t} to do that. (It is @code{t} by default.)
15713 @item gnus-kill-files-directory
15714 @vindex gnus-kill-files-directory
15715 All kill and score files will be stored in this directory, which is
15716 initialized from the @code{SAVEDIR} environment variable by default.
15717 This is @file{~/News/} by default.
15719 @item gnus-score-file-suffix
15720 @vindex gnus-score-file-suffix
15721 Suffix to add to the group name to arrive at the score file name
15722 (@samp{SCORE} by default.)
15724 @item gnus-score-uncacheable-files
15725 @vindex gnus-score-uncacheable-files
15726 @cindex score cache
15727 All score files are normally cached to avoid excessive re-loading of
15728 score files. However, if this might make your Emacs grow big and
15729 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
15730 @file{all.SCORE}, while it might be a good idea to not cache
15731 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
15732 variable is @samp{ADAPT$} by default, so no adaptive score files will
15735 @item gnus-save-score
15736 @vindex gnus-save-score
15737 If you have really complicated score files, and do lots of batch
15738 scoring, then you might set this variable to @code{t}. This will make
15739 Gnus save the scores into the @file{.newsrc.eld} file.
15741 If you do not set this to @code{t}, then manual scores (like those set
15742 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
15743 across group visits.
15745 @item gnus-score-interactive-default-score
15746 @vindex gnus-score-interactive-default-score
15747 Score used by all the interactive raise/lower commands to raise/lower
15748 score with. Default is 1000, which may seem excessive, but this is to
15749 ensure that the adaptive scoring scheme gets enough room to play with.
15750 We don't want the small changes from the adaptive scoring to overwrite
15751 manually entered data.
15753 @item gnus-summary-default-score
15754 @vindex gnus-summary-default-score
15755 Default score of an article, which is 0 by default.
15757 @item gnus-summary-expunge-below
15758 @vindex gnus-summary-expunge-below
15759 Don't display the summary lines of articles that have scores lower than
15760 this variable. This is @code{nil} by default, which means that no
15761 articles will be hidden. This variable is local to the summary buffers,
15762 and has to be set from @code{gnus-summary-mode-hook}.
15764 @item gnus-score-over-mark
15765 @vindex gnus-score-over-mark
15766 Mark (in the third column) used for articles with a score over the
15767 default. Default is @samp{+}.
15769 @item gnus-score-below-mark
15770 @vindex gnus-score-below-mark
15771 Mark (in the third column) used for articles with a score below the
15772 default. Default is @samp{-}.
15774 @item gnus-score-find-score-files-function
15775 @vindex gnus-score-find-score-files-function
15776 Function used to find score files for the current group. This function
15777 is called with the name of the group as the argument.
15779 Predefined functions available are:
15782 @item gnus-score-find-single
15783 @findex gnus-score-find-single
15784 Only apply the group's own score file.
15786 @item gnus-score-find-bnews
15787 @findex gnus-score-find-bnews
15788 Apply all score files that match, using bnews syntax. This is the
15789 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
15790 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
15791 @file{gnu.all.SCORE} would all apply. In short, the instances of
15792 @samp{all} in the score file names are translated into @samp{.*}, and
15793 then a regexp match is done.
15795 This means that if you have some score entries that you want to apply to
15796 all groups, then you put those entries in the @file{all.SCORE} file.
15798 The score files are applied in a semi-random order, although Gnus will
15799 try to apply the more general score files before the more specific score
15800 files. It does this by looking at the number of elements in the score
15801 file names---discarding the @samp{all} elements.
15803 @item gnus-score-find-hierarchical
15804 @findex gnus-score-find-hierarchical
15805 Apply all score files from all the parent groups. This means that you
15806 can't have score files like @file{all.SCORE}, but you can have
15807 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
15811 This variable can also be a list of functions. In that case, all these
15812 functions will be called with the group name as argument, and all the
15813 returned lists of score files will be applied. These functions can also
15814 return lists of score alists directly. In that case, the functions that
15815 return these non-file score alists should probably be placed before the
15816 ``real'' score file functions, to ensure that the last score file
15817 returned is the local score file. Phu.
15819 For example, to do hierarchical scoring but use a non-server-specific
15820 overall score file, you could use the value
15822 (list (lambda (group) ("all.SCORE")) 'gnus-score-find-hierarchical)
15825 @item gnus-score-expiry-days
15826 @vindex gnus-score-expiry-days
15827 This variable says how many days should pass before an unused score file
15828 entry is expired. If this variable is @code{nil}, no score file entries
15829 are expired. It's 7 by default.
15831 @item gnus-update-score-entry-dates
15832 @vindex gnus-update-score-entry-dates
15833 If this variable is non-@code{nil}, matching score entries will have
15834 their dates updated. (This is how Gnus controls expiry---all
15835 non-matching entries will become too old while matching entries will
15836 stay fresh and young.) However, if you set this variable to @code{nil},
15837 even matching entries will grow old and will have to face that oh-so
15840 @item gnus-score-after-write-file-function
15841 @vindex gnus-score-after-write-file-function
15842 Function called with the name of the score file just written.
15844 @item gnus-score-thread-simplify
15845 @vindex gnus-score-thread-simplify
15846 If this variable is non-@code{nil}, article subjects will be simplified
15847 for subject scoring purposes in the same manner as with
15848 threading---according to the current value of
15849 gnus-simplify-subject-functions. If the scoring entry uses
15850 @code{substring} or @code{exact} matching, the match will also be
15851 simplified in this manner.
15856 @node Score File Format
15857 @section Score File Format
15858 @cindex score file format
15860 A score file is an @code{emacs-lisp} file that normally contains just a
15861 single form. Casual users are not expected to edit these files;
15862 everything can be changed from the summary buffer.
15864 Anyway, if you'd like to dig into it yourself, here's an example:
15868 ("Lars Ingebrigtsen" -10000)
15870 ("larsi\\|lmi" -50000 nil R))
15872 ("Ding is Badd" nil 728373))
15874 ("alt.politics" -1000 728372 s))
15879 (mark-and-expunge -10)
15883 (files "/hom/larsi/News/gnu.SCORE")
15884 (exclude-files "all.SCORE")
15885 (local (gnus-newsgroup-auto-expire t)
15886 (gnus-summary-make-false-root empty))
15890 This example demonstrates most score file elements. For a different
15891 approach, see @pxref{Advanced Scoring}.
15893 Even though this looks much like lisp code, nothing here is actually
15894 @code{eval}ed. The lisp reader is used to read this form, though, so it
15895 has to be valid syntactically, if not semantically.
15897 Six keys are supported by this alist:
15902 If the key is a string, it is the name of the header to perform the
15903 match on. Scoring can only be performed on these eight headers:
15904 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
15905 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
15906 these headers, there are three strings to tell Gnus to fetch the entire
15907 article and do the match on larger parts of the article: @code{Body}
15908 will perform the match on the body of the article, @code{Head} will
15909 perform the match on the head of the article, and @code{All} will
15910 perform the match on the entire article. Note that using any of these
15911 last three keys will slow down group entry @emph{considerably}. The
15912 final ``header'' you can score on is @code{Followup}. These score
15913 entries will result in new score entries being added for all follow-ups
15914 to articles that matches these score entries.
15916 Following this key is a arbitrary number of score entries, where each
15917 score entry has one to four elements.
15921 The first element is the @dfn{match element}. On most headers this will
15922 be a string, but on the Lines and Chars headers, this must be an
15926 If the second element is present, it should be a number---the @dfn{score
15927 element}. This number should be an integer in the neginf to posinf
15928 interval. This number is added to the score of the article if the match
15929 is successful. If this element is not present, the
15930 @code{gnus-score-interactive-default-score} number will be used
15931 instead. This is 1000 by default.
15934 If the third element is present, it should be a number---the @dfn{date
15935 element}. This date says when the last time this score entry matched,
15936 which provides a mechanism for expiring the score entries. It this
15937 element is not present, the score entry is permanent. The date is
15938 represented by the number of days since December 31, 1 BCE.
15941 If the fourth element is present, it should be a symbol---the @dfn{type
15942 element}. This element specifies what function should be used to see
15943 whether this score entry matches the article. What match types that can
15944 be used depends on what header you wish to perform the match on.
15947 @item From, Subject, References, Xref, Message-ID
15948 For most header types, there are the @code{r} and @code{R} (regexp), as
15949 well as @code{s} and @code{S} (substring) types, and @code{e} and
15950 @code{E} (exact match), and @code{w} (word match) types. If this
15951 element is not present, Gnus will assume that substring matching should
15952 be used. @code{R}, @code{S}, and @code{E} differ from the others in
15953 that the matches will be done in a case-sensitive manner. All these
15954 one-letter types are really just abbreviations for the @code{regexp},
15955 @code{string}, @code{exact}, and @code{word} types, which you can use
15956 instead, if you feel like.
15959 These two headers use different match types: @code{<}, @code{>},
15960 @code{=}, @code{>=} and @code{<=}.
15962 These predicates are true if
15965 (PREDICATE HEADER MATCH)
15968 evaluates to non-@code{nil}. For instance, the advanced match
15969 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
15976 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
15977 the match, we get the score added if the article has less than 4 lines.
15978 (It's easy to get confused and think it's the other way around. But
15979 it's not. I think.)
15981 When matching on @code{Lines}, be careful because some backends (like
15982 @code{nndir}) do not generate @code{Lines} header, so every article ends
15983 up being marked as having 0 lines. This can lead to strange results if
15984 you happen to lower score of the articles with few lines.
15987 For the Date header we have three kinda silly match types:
15988 @code{before}, @code{at} and @code{after}. I can't really imagine this
15989 ever being useful, but, like, it would feel kinda silly not to provide
15990 this function. Just in case. You never know. Better safe than sorry.
15991 Once burnt, twice shy. Don't judge a book by its cover. Never not have
15992 sex on a first date. (I have been told that at least one person, and I
15993 quote, ``found this function indispensable'', however.)
15997 A more useful match type is @code{regexp}. With it, you can match the
15998 date string using a regular expression. The date is normalized to
15999 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
16000 you want to match all articles that have been posted on April 1st in
16001 every year, you could use @samp{....0401.........} as a match string,
16002 for instance. (Note that the date is kept in its original time zone, so
16003 this will match articles that were posted when it was April 1st where
16004 the article was posted from. Time zones are such wholesome fun for the
16007 @item Head, Body, All
16008 These three match keys use the same match types as the @code{From} (etc)
16012 This match key is somewhat special, in that it will match the
16013 @code{From} header, and affect the score of not only the matching
16014 articles, but also all followups to the matching articles. This allows
16015 you e.g. increase the score of followups to your own articles, or
16016 decrease the score of followups to the articles of some known
16017 trouble-maker. Uses the same match types as the @code{From} header
16018 uses. (Using this match key will lead to creation of @file{ADAPT}
16022 This match key works along the same lines as the @code{Followup} match
16023 key. If you say that you want to score on a (sub-)thread started by an
16024 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
16025 match. This will add a new @samp{thread} match for each article that
16026 has @var{x} in its @code{References} header. (These new @samp{thread}
16027 matches will use the @code{Message-ID}s of these matching articles.)
16028 This will ensure that you can raise/lower the score of an entire thread,
16029 even though some articles in the thread may not have complete
16030 @code{References} headers. Note that using this may lead to
16031 undeterministic scores of the articles in the thread. (Using this match
16032 key will lead to creation of @file{ADAPT} files.)
16036 @cindex Score File Atoms
16038 The value of this entry should be a number. Any articles with a score
16039 lower than this number will be marked as read.
16042 The value of this entry should be a number. Any articles with a score
16043 lower than this number will be removed from the summary buffer.
16045 @item mark-and-expunge
16046 The value of this entry should be a number. Any articles with a score
16047 lower than this number will be marked as read and removed from the
16050 @item thread-mark-and-expunge
16051 The value of this entry should be a number. All articles that belong to
16052 a thread that has a total score below this number will be marked as read
16053 and removed from the summary buffer. @code{gnus-thread-score-function}
16054 says how to compute the total score for a thread.
16057 The value of this entry should be any number of file names. These files
16058 are assumed to be score files as well, and will be loaded the same way
16061 @item exclude-files
16062 The clue of this entry should be any number of files. These files will
16063 not be loaded, even though they would normally be so, for some reason or
16067 The value of this entry will be @code{eval}el. This element will be
16068 ignored when handling global score files.
16071 Read-only score files will not be updated or saved. Global score files
16072 should feature this atom (@pxref{Global Score Files}). (Note:
16073 @dfn{Global} here really means @dfn{global}; not your personal
16074 apply-to-all-groups score files.)
16077 The value of this entry should be a number. Articles that do not have
16078 parents will get this number added to their scores. Imagine you follow
16079 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
16080 will only follow a few of the threads, also want to see any new threads.
16082 You can do this with the following two score file entries:
16086 (mark-and-expunge -100)
16089 When you enter the group the first time, you will only see the new
16090 threads. You then raise the score of the threads that you find
16091 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
16092 rest. Next time you enter the group, you will see new articles in the
16093 interesting threads, plus any new threads.
16095 I.e.---the orphan score atom is for high-volume groups where a few
16096 interesting threads which can't be found automatically by ordinary
16097 scoring rules exist.
16100 This entry controls the adaptive scoring. If it is @code{t}, the
16101 default adaptive scoring rules will be used. If it is @code{ignore}, no
16102 adaptive scoring will be performed on this group. If it is a list, this
16103 list will be used as the adaptive scoring rules. If it isn't present,
16104 or is something other than @code{t} or @code{ignore}, the default
16105 adaptive scoring rules will be used. If you want to use adaptive
16106 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
16107 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
16108 not want adaptive scoring. If you only want adaptive scoring in a few
16109 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
16110 insert @code{(adapt t)} in the score files of the groups where you want
16114 All adaptive score entries will go to the file named by this entry. It
16115 will also be applied when entering the group. This atom might be handy
16116 if you want to adapt on several groups at once, using the same adaptive
16117 file for a number of groups.
16120 @cindex local variables
16121 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
16122 Each @var{var} will be made buffer-local to the current summary buffer,
16123 and set to the value specified. This is a convenient, if somewhat
16124 strange, way of setting variables in some groups if you don't like hooks
16125 much. Note that the @var{value} won't be evaluated.
16129 @node Score File Editing
16130 @section Score File Editing
16132 You normally enter all scoring commands from the summary buffer, but you
16133 might feel the urge to edit them by hand as well, so we've supplied you
16134 with a mode for that.
16136 It's simply a slightly customized @code{emacs-lisp} mode, with these
16137 additional commands:
16142 @kindex C-c C-c (Score)
16143 @findex gnus-score-edit-done
16144 Save the changes you have made and return to the summary buffer
16145 (@code{gnus-score-edit-done}).
16148 @kindex C-c C-d (Score)
16149 @findex gnus-score-edit-insert-date
16150 Insert the current date in numerical format
16151 (@code{gnus-score-edit-insert-date}). This is really the day number, if
16152 you were wondering.
16155 @kindex C-c C-p (Score)
16156 @findex gnus-score-pretty-print
16157 The adaptive score files are saved in an unformatted fashion. If you
16158 intend to read one of these files, you want to @dfn{pretty print} it
16159 first. This command (@code{gnus-score-pretty-print}) does that for
16164 Type @kbd{M-x gnus-score-mode} to use this mode.
16166 @vindex gnus-score-mode-hook
16167 @code{gnus-score-menu-hook} is run in score mode buffers.
16169 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
16170 e} to begin editing score files.
16173 @node Adaptive Scoring
16174 @section Adaptive Scoring
16175 @cindex adaptive scoring
16177 If all this scoring is getting you down, Gnus has a way of making it all
16178 happen automatically---as if by magic. Or rather, as if by artificial
16179 stupidity, to be precise.
16181 @vindex gnus-use-adaptive-scoring
16182 When you read an article, or mark an article as read, or kill an
16183 article, you leave marks behind. On exit from the group, Gnus can sniff
16184 these marks and add score elements depending on what marks it finds.
16185 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
16186 @code{t} or @code{(line)}. If you want score adaptively on separate
16187 words appearing in the subjects, you should set this variable to
16188 @code{(word)}. If you want to use both adaptive methods, set this
16189 variable to @code{(word line)}.
16191 @vindex gnus-default-adaptive-score-alist
16192 To give you complete control over the scoring process, you can customize
16193 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
16194 might look something like this:
16197 (setq gnus-default-adaptive-score-alist
16198 '((gnus-unread-mark)
16199 (gnus-ticked-mark (from 4))
16200 (gnus-dormant-mark (from 5))
16201 (gnus-del-mark (from -4) (subject -1))
16202 (gnus-read-mark (from 4) (subject 2))
16203 (gnus-expirable-mark (from -1) (subject -1))
16204 (gnus-killed-mark (from -1) (subject -3))
16205 (gnus-kill-file-mark)
16206 (gnus-ancient-mark)
16207 (gnus-low-score-mark)
16208 (gnus-catchup-mark (from -1) (subject -1))))
16211 As you see, each element in this alist has a mark as a key (either a
16212 variable name or a ``real'' mark---a character). Following this key is
16213 a arbitrary number of header/score pairs. If there are no header/score
16214 pairs following the key, no adaptive scoring will be done on articles
16215 that have that key as the article mark. For instance, articles with
16216 @code{gnus-unread-mark} in the example above will not get adaptive score
16219 Each article can have only one mark, so just a single of these rules
16220 will be applied to each article.
16222 To take @code{gnus-del-mark} as an example---this alist says that all
16223 articles that have that mark (i.e., are marked with @samp{D}) will have a
16224 score entry added to lower based on the @code{From} header by -4, and
16225 lowered by @code{Subject} by -1. Change this to fit your prejudices.
16227 If you have marked 10 articles with the same subject with
16228 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
16229 That means that that subject will get a score of ten times -1, which
16230 should be, unless I'm much mistaken, -10.
16232 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
16233 the read articles will be marked with the @samp{E} mark. This'll
16234 probably make adaptive scoring slightly impossible, so auto-expiring and
16235 adaptive scoring doesn't really mix very well.
16237 The headers you can score on are @code{from}, @code{subject},
16238 @code{message-id}, @code{references}, @code{xref}, @code{lines},
16239 @code{chars} and @code{date}. In addition, you can score on
16240 @code{followup}, which will create an adaptive score entry that matches
16241 on the @code{References} header using the @code{Message-ID} of the
16242 current article, thereby matching the following thread.
16244 You can also score on @code{thread}, which will try to score all
16245 articles that appear in a thread. @code{thread} matches uses a
16246 @code{Message-ID} to match on the @code{References} header of the
16247 article. If the match is made, the @code{Message-ID} of the article is
16248 added to the @code{thread} rule. (Think about it. I'd recommend two
16249 aspirins afterwards.)
16251 If you use this scheme, you should set the score file atom @code{mark}
16252 to something small---like -300, perhaps, to avoid having small random
16253 changes result in articles getting marked as read.
16255 After using adaptive scoring for a week or so, Gnus should start to
16256 become properly trained and enhance the authors you like best, and kill
16257 the authors you like least, without you having to say so explicitly.
16259 You can control what groups the adaptive scoring is to be performed on
16260 by using the score files (@pxref{Score File Format}). This will also
16261 let you use different rules in different groups.
16263 @vindex gnus-adaptive-file-suffix
16264 The adaptive score entries will be put into a file where the name is the
16265 group name with @code{gnus-adaptive-file-suffix} appended. The default
16268 @vindex gnus-score-exact-adapt-limit
16269 When doing adaptive scoring, substring or fuzzy matching would probably
16270 give you the best results in most cases. However, if the header one
16271 matches is short, the possibility for false positives is great, so if
16272 the length of the match is less than
16273 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
16274 this variable is @code{nil}, exact matching will always be used to avoid
16277 @vindex gnus-default-adaptive-word-score-alist
16278 As mentioned above, you can adapt either on individual words or entire
16279 headers. If you adapt on words, the
16280 @code{gnus-default-adaptive-word-score-alist} variable says what score
16281 each instance of a word should add given a mark.
16284 (setq gnus-default-adaptive-word-score-alist
16285 `((,gnus-read-mark . 30)
16286 (,gnus-catchup-mark . -10)
16287 (,gnus-killed-mark . -20)
16288 (,gnus-del-mark . -15)))
16291 This is the default value. If you have adaption on words enabled, every
16292 word that appears in subjects of articles marked with
16293 @code{gnus-read-mark} will result in a score rule that increase the
16294 score with 30 points.
16296 @vindex gnus-default-ignored-adaptive-words
16297 @vindex gnus-ignored-adaptive-words
16298 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
16299 will be ignored. If you wish to add more words to be ignored, use the
16300 @code{gnus-ignored-adaptive-words} list instead.
16302 @vindex gnus-adaptive-word-length-limit
16303 Some may feel that short words shouldn't count when doing adaptive
16304 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
16305 an integer. Words shorter than this number will be ignored. This
16306 variable defaults til @code{nil}.
16308 @vindex gnus-adaptive-word-syntax-table
16309 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
16310 syntax table in effect. It is similar to the standard syntax table, but
16311 it considers numbers to be non-word-constituent characters.
16313 @vindex gnus-adaptive-word-minimum
16314 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
16315 word scoring process will never bring down the score of an article to
16316 below this number. The default is @code{nil}.
16318 @vindex gnus-adaptive-word-no-group-words
16319 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
16320 won't adaptively word score any of the words in the group name. Useful
16321 for groups like @samp{comp.editors.emacs}, where most of the subject
16322 lines contain the word @samp{emacs}.
16324 After using this scheme for a while, it might be nice to write a
16325 @code{gnus-psychoanalyze-user} command to go through the rules and see
16326 what words you like and what words you don't like. Or perhaps not.
16328 Note that the adaptive word scoring thing is highly experimental and is
16329 likely to change in the future. Initial impressions seem to indicate
16330 that it's totally useless as it stands. Some more work (involving more
16331 rigorous statistical methods) will have to be done to make this useful.
16334 @node Home Score File
16335 @section Home Score File
16337 The score file where new score file entries will go is called the
16338 @dfn{home score file}. This is normally (and by default) the score file
16339 for the group itself. For instance, the home score file for
16340 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
16342 However, this may not be what you want. It is often convenient to share
16343 a common home score file among many groups---all @samp{emacs} groups
16344 could perhaps use the same home score file.
16346 @vindex gnus-home-score-file
16347 The variable that controls this is @code{gnus-home-score-file}. It can
16352 A string. Then this file will be used as the home score file for all
16356 A function. The result of this function will be used as the home score
16357 file. The function will be called with the name of the group as the
16361 A list. The elements in this list can be:
16365 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
16366 group name, the @var{file-name} will be used as the home score file.
16369 A function. If the function returns non-nil, the result will be used as
16370 the home score file.
16373 A string. Use the string as the home score file.
16376 The list will be traversed from the beginning towards the end looking
16381 So, if you want to use just a single score file, you could say:
16384 (setq gnus-home-score-file
16385 "my-total-score-file.SCORE")
16388 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
16389 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
16391 @findex gnus-hierarchial-home-score-file
16393 (setq gnus-home-score-file
16394 'gnus-hierarchial-home-score-file)
16397 This is a ready-made function provided for your convenience.
16398 Other functions include
16401 @item gnus-current-home-score-file
16402 @findex gnus-current-home-score-file
16403 Return the ``current'' regular score file. This will make scoring
16404 commands add entry to the ``innermost'' matching score file.
16408 If you want to have one score file for the @samp{emacs} groups and
16409 another for the @samp{comp} groups, while letting all other groups use
16410 their own home score files:
16413 (setq gnus-home-score-file
16414 ;; All groups that match the regexp "\\.emacs"
16415 '(("\\.emacs" "emacs.SCORE")
16416 ;; All the comp groups in one score file
16417 ("^comp" "comp.SCORE")))
16420 @vindex gnus-home-adapt-file
16421 @code{gnus-home-adapt-file} works exactly the same way as
16422 @code{gnus-home-score-file}, but says what the home adaptive score file
16423 is instead. All new adaptive file entries will go into the file
16424 specified by this variable, and the same syntax is allowed.
16426 In addition to using @code{gnus-home-score-file} and
16427 @code{gnus-home-adapt-file}, you can also use group parameters
16428 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
16429 Parameters}) to achieve much the same. Group and topic parameters take
16430 precedence over this variable.
16433 @node Followups To Yourself
16434 @section Followups To Yourself
16436 Gnus offers two commands for picking out the @code{Message-ID} header in
16437 the current buffer. Gnus will then add a score rule that scores using
16438 this @code{Message-ID} on the @code{References} header of other
16439 articles. This will, in effect, increase the score of all articles that
16440 respond to the article in the current buffer. Quite useful if you want
16441 to easily note when people answer what you've said.
16445 @item gnus-score-followup-article
16446 @findex gnus-score-followup-article
16447 This will add a score to articles that directly follow up your own
16450 @item gnus-score-followup-thread
16451 @findex gnus-score-followup-thread
16452 This will add a score to all articles that appear in a thread ``below''
16456 @vindex message-sent-hook
16457 These two functions are both primarily meant to be used in hooks like
16458 @code{message-sent-hook}, like this:
16460 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
16464 If you look closely at your own @code{Message-ID}, you'll notice that
16465 the first two or three characters are always the same. Here's two of
16469 <x6u3u47icf.fsf@@eyesore.no>
16470 <x6sp9o7ibw.fsf@@eyesore.no>
16473 So ``my'' ident on this machine is @samp{x6}. This can be
16474 exploited---the following rule will raise the score on all followups to
16479 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
16483 Whether it's the first two or first three characters that are ``yours''
16484 is system-dependent.
16488 @section Scoring Tips
16489 @cindex scoring tips
16495 @cindex scoring crossposts
16496 If you want to lower the score of crossposts, the line to match on is
16497 the @code{Xref} header.
16499 ("xref" (" talk.politics.misc:" -1000))
16502 @item Multiple crossposts
16503 If you want to lower the score of articles that have been crossposted to
16504 more than, say, 3 groups:
16506 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
16509 @item Matching on the body
16510 This is generally not a very good idea---it takes a very long time.
16511 Gnus actually has to fetch each individual article from the server. But
16512 you might want to anyway, I guess. Even though there are three match
16513 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
16514 and stick with it in each score file. If you use any two, each article
16515 will be fetched @emph{twice}. If you want to match a bit on the
16516 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
16519 @item Marking as read
16520 You will probably want to mark articles that have scores below a certain
16521 number as read. This is most easily achieved by putting the following
16522 in your @file{all.SCORE} file:
16526 You may also consider doing something similar with @code{expunge}.
16528 @item Negated character classes
16529 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
16530 That will match newlines, which might lead to, well, The Unknown. Say
16531 @code{[^abcd\n]*} instead.
16535 @node Reverse Scoring
16536 @section Reverse Scoring
16537 @cindex reverse scoring
16539 If you want to keep just articles that have @samp{Sex with Emacs} in the
16540 subject header, and expunge all other articles, you could put something
16541 like this in your score file:
16545 ("Sex with Emacs" 2))
16550 So, you raise all articles that match @samp{Sex with Emacs} and mark the
16551 rest as read, and expunge them to boot.
16554 @node Global Score Files
16555 @section Global Score Files
16556 @cindex global score files
16558 Sure, other newsreaders have ``global kill files''. These are usually
16559 nothing more than a single kill file that applies to all groups, stored
16560 in the user's home directory. Bah! Puny, weak newsreaders!
16562 What I'm talking about here are Global Score Files. Score files from
16563 all over the world, from users everywhere, uniting all nations in one
16564 big, happy score file union! Ange-score! New and untested!
16566 @vindex gnus-global-score-files
16567 All you have to do to use other people's score files is to set the
16568 @code{gnus-global-score-files} variable. One entry for each score file,
16569 or each score file directory. Gnus will decide by itself what score
16570 files are applicable to which group.
16572 Say you want to use the score file
16573 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
16574 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
16577 (setq gnus-global-score-files
16578 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
16579 "/ftp@@ftp.some-where:/pub/score/"))
16582 @findex gnus-score-search-global-directories
16583 Simple, eh? Directory names must end with a @samp{/}. These
16584 directories are typically scanned only once during each Gnus session.
16585 If you feel the need to manually re-scan the remote directories, you can
16586 use the @code{gnus-score-search-global-directories} command.
16588 Note that, at present, using this option will slow down group entry
16589 somewhat. (That is---a lot.)
16591 If you want to start maintaining score files for other people to use,
16592 just put your score file up for anonymous ftp and announce it to the
16593 world. Become a retro-moderator! Participate in the retro-moderator
16594 wars sure to ensue, where retro-moderators battle it out for the
16595 sympathy of the people, luring them to use their score files on false
16596 premises! Yay! The net is saved!
16598 Here are some tips for the would-be retro-moderator, off the top of my
16604 Articles heavily crossposted are probably junk.
16606 To lower a single inappropriate article, lower by @code{Message-ID}.
16608 Particularly brilliant authors can be raised on a permanent basis.
16610 Authors that repeatedly post off-charter for the group can safely be
16611 lowered out of existence.
16613 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
16614 articles completely.
16617 Use expiring score entries to keep the size of the file down. You
16618 should probably have a long expiry period, though, as some sites keep
16619 old articles for a long time.
16622 ... I wonder whether other newsreaders will support global score files
16623 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
16624 Wave, xrn and 1stReader are bound to implement scoring. Should we start
16625 holding our breath yet?
16629 @section Kill Files
16632 Gnus still supports those pesky old kill files. In fact, the kill file
16633 entries can now be expiring, which is something I wrote before Daniel
16634 Quinlan thought of doing score files, so I've left the code in there.
16636 In short, kill processing is a lot slower (and I do mean @emph{a lot})
16637 than score processing, so it might be a good idea to rewrite your kill
16638 files into score files.
16640 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
16641 forms into this file, which means that you can use kill files as some
16642 sort of primitive hook function to be run on group entry, even though
16643 that isn't a very good idea.
16645 Normal kill files look like this:
16648 (gnus-kill "From" "Lars Ingebrigtsen")
16649 (gnus-kill "Subject" "ding")
16653 This will mark every article written by me as read, and remove the
16654 marked articles from the summary buffer. Very useful, you'll agree.
16656 Other programs use a totally different kill file syntax. If Gnus
16657 encounters what looks like a @code{rn} kill file, it will take a stab at
16660 Two summary functions for editing a GNUS kill file:
16665 @kindex M-k (Summary)
16666 @findex gnus-summary-edit-local-kill
16667 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
16670 @kindex M-K (Summary)
16671 @findex gnus-summary-edit-global-kill
16672 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
16675 Two group mode functions for editing the kill files:
16680 @kindex M-k (Group)
16681 @findex gnus-group-edit-local-kill
16682 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
16685 @kindex M-K (Group)
16686 @findex gnus-group-edit-global-kill
16687 Edit the general kill file (@code{gnus-group-edit-global-kill}).
16690 Kill file variables:
16693 @item gnus-kill-file-name
16694 @vindex gnus-kill-file-name
16695 A kill file for the group @samp{soc.motss} is normally called
16696 @file{soc.motss.KILL}. The suffix appended to the group name to get
16697 this file name is detailed by the @code{gnus-kill-file-name} variable.
16698 The ``global'' kill file (not in the score file sense of ``global'', of
16699 course) is just called @file{KILL}.
16701 @vindex gnus-kill-save-kill-file
16702 @item gnus-kill-save-kill-file
16703 If this variable is non-@code{nil}, Gnus will save the
16704 kill file after processing, which is necessary if you use expiring
16707 @item gnus-apply-kill-hook
16708 @vindex gnus-apply-kill-hook
16709 @findex gnus-apply-kill-file-unless-scored
16710 @findex gnus-apply-kill-file
16711 A hook called to apply kill files to a group. It is
16712 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
16713 kill file if you have a score file for the same group, you can set this
16714 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
16715 kill files to be processed, you should set this variable to @code{nil}.
16717 @item gnus-kill-file-mode-hook
16718 @vindex gnus-kill-file-mode-hook
16719 A hook called in kill-file mode buffers.
16724 @node Converting Kill Files
16725 @section Converting Kill Files
16727 @cindex converting kill files
16729 If you have loads of old kill files, you may want to convert them into
16730 score files. If they are ``regular'', you can use
16731 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
16734 The kill to score conversion package isn't included in Gnus by default.
16735 You can fetch it from
16736 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
16738 If your old kill files are very complex---if they contain more
16739 non-@code{gnus-kill} forms than not, you'll have to convert them by
16740 hand. Or just let them be as they are. Gnus will still use them as
16748 GroupLens is a collaborative filtering system that helps you work
16749 together with other people to find the quality news articles out of the
16750 huge volume of news articles generated every day.
16752 To accomplish this the GroupLens system combines your opinions about
16753 articles you have already read with the opinions of others who have done
16754 likewise and gives you a personalized prediction for each unread news
16755 article. Think of GroupLens as a matchmaker. GroupLens watches how you
16756 rate articles, and finds other people that rate articles the same way.
16757 Once it has found some people you agree with it tells you, in the form
16758 of a prediction, what they thought of the article. You can use this
16759 prediction to help you decide whether or not you want to read the
16763 * Using GroupLens:: How to make Gnus use GroupLens.
16764 * Rating Articles:: Letting GroupLens know how you rate articles.
16765 * Displaying Predictions:: Displaying predictions given by GroupLens.
16766 * GroupLens Variables:: Customizing GroupLens.
16770 @node Using GroupLens
16771 @subsection Using GroupLens
16773 To use GroupLens you must register a pseudonym with your local Better
16775 @uref{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
16776 better bit in town at the moment.
16778 Once you have registered you'll need to set a couple of variables.
16782 @item gnus-use-grouplens
16783 @vindex gnus-use-grouplens
16784 Setting this variable to a non-@code{nil} value will make Gnus hook into
16785 all the relevant GroupLens functions.
16787 @item grouplens-pseudonym
16788 @vindex grouplens-pseudonym
16789 This variable should be set to the pseudonym you got when registering
16790 with the Better Bit Bureau.
16792 @item grouplens-newsgroups
16793 @vindex grouplens-newsgroups
16794 A list of groups that you want to get GroupLens predictions for.
16798 That's the minimum of what you need to get up and running with GroupLens.
16799 Once you've registered, GroupLens will start giving you scores for
16800 articles based on the average of what other people think. But, to get
16801 the real benefit of GroupLens you need to start rating articles
16802 yourself. Then the scores GroupLens gives you will be personalized for
16803 you, based on how the people you usually agree with have already rated.
16806 @node Rating Articles
16807 @subsection Rating Articles
16809 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
16810 Where 1 means something like this article is a waste of bandwidth and 5
16811 means that the article was really good. The basic question to ask
16812 yourself is, "on a scale from 1 to 5 would I like to see more articles
16815 There are four ways to enter a rating for an article in GroupLens.
16820 @kindex r (GroupLens)
16821 @findex bbb-summary-rate-article
16822 This function will prompt you for a rating on a scale of one to five.
16825 @kindex k (GroupLens)
16826 @findex grouplens-score-thread
16827 This function will prompt you for a rating, and rate all the articles in
16828 the thread. This is really useful for some of those long running giant
16829 threads in rec.humor.
16833 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
16834 the score of the article you're reading.
16839 @kindex n (GroupLens)
16840 @findex grouplens-next-unread-article
16841 Rate the article and go to the next unread article.
16844 @kindex , (GroupLens)
16845 @findex grouplens-best-unread-article
16846 Rate the article and go to the next unread article with the highest score.
16850 If you want to give the current article a score of 4 and then go to the
16851 next article, just type @kbd{4 n}.
16854 @node Displaying Predictions
16855 @subsection Displaying Predictions
16857 GroupLens makes a prediction for you about how much you will like a
16858 news article. The predictions from GroupLens are on a scale from 1 to
16859 5, where 1 is the worst and 5 is the best. You can use the predictions
16860 from GroupLens in one of three ways controlled by the variable
16861 @code{gnus-grouplens-override-scoring}.
16863 @vindex gnus-grouplens-override-scoring
16864 There are three ways to display predictions in grouplens. You may
16865 choose to have the GroupLens scores contribute to, or override the
16866 regular gnus scoring mechanism. override is the default; however, some
16867 people prefer to see the Gnus scores plus the grouplens scores. To get
16868 the separate scoring behavior you need to set
16869 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
16870 GroupLens predictions combined with the grouplens scores set it to
16871 @code{'override} and to combine the scores set
16872 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
16873 the combine option you will also want to set the values for
16874 @code{grouplens-prediction-offset} and
16875 @code{grouplens-score-scale-factor}.
16877 @vindex grouplens-prediction-display
16878 In either case, GroupLens gives you a few choices for how you would like
16879 to see your predictions displayed. The display of predictions is
16880 controlled by the @code{grouplens-prediction-display} variable.
16882 The following are valid values for that variable.
16885 @item prediction-spot
16886 The higher the prediction, the further to the right an @samp{*} is
16889 @item confidence-interval
16890 A numeric confidence interval.
16892 @item prediction-bar
16893 The higher the prediction, the longer the bar.
16895 @item confidence-bar
16896 Numerical confidence.
16898 @item confidence-spot
16899 The spot gets bigger with more confidence.
16901 @item prediction-num
16902 Plain-old numeric value.
16904 @item confidence-plus-minus
16905 Prediction +/- confidence.
16910 @node GroupLens Variables
16911 @subsection GroupLens Variables
16915 @item gnus-summary-grouplens-line-format
16916 The summary line format used in GroupLens-enhanced summary buffers. It
16917 accepts the same specs as the normal summary line format (@pxref{Summary
16918 Buffer Lines}). The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
16921 @item grouplens-bbb-host
16922 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
16925 @item grouplens-bbb-port
16926 Port of the host running the bbbd server. The default is 9000.
16928 @item grouplens-score-offset
16929 Offset the prediction by this value. In other words, subtract the
16930 prediction value by this number to arrive at the effective score. The
16933 @item grouplens-score-scale-factor
16934 This variable allows the user to magnify the effect of GroupLens scores.
16935 The scale factor is applied after the offset. The default is 1.
16940 @node Advanced Scoring
16941 @section Advanced Scoring
16943 Scoring on Subjects and From headers is nice enough, but what if you're
16944 really interested in what a person has to say only when she's talking
16945 about a particular subject? Or what if you really don't want to
16946 read what person A has to say when she's following up to person B, but
16947 want to read what she says when she's following up to person C?
16949 By using advanced scoring rules you may create arbitrarily complex
16953 * Advanced Scoring Syntax:: A definition.
16954 * Advanced Scoring Examples:: What they look like.
16955 * Advanced Scoring Tips:: Getting the most out of it.
16959 @node Advanced Scoring Syntax
16960 @subsection Advanced Scoring Syntax
16962 Ordinary scoring rules have a string as the first element in the rule.
16963 Advanced scoring rules have a list as the first element. The second
16964 element is the score to be applied if the first element evaluated to a
16965 non-@code{nil} value.
16967 These lists may consist of three logical operators, one redirection
16968 operator, and various match operators.
16975 This logical operator will evaluate each of its arguments until it finds
16976 one that evaluates to @code{false}, and then it'll stop. If all arguments
16977 evaluate to @code{true} values, then this operator will return
16982 This logical operator will evaluate each of its arguments until it finds
16983 one that evaluates to @code{true}. If no arguments are @code{true},
16984 then this operator will return @code{false}.
16989 This logical operator only takes a single argument. It returns the
16990 logical negation of the value of its argument.
16994 There is an @dfn{indirection operator} that will make its arguments
16995 apply to the ancestors of the current article being scored. For
16996 instance, @code{1-} will make score rules apply to the parent of the
16997 current article. @code{2-} will make score rules apply to the
16998 grandparent of the current article. Alternatively, you can write
16999 @code{^^}, where the number of @code{^}s (carets) says how far back into
17000 the ancestry you want to go.
17002 Finally, we have the match operators. These are the ones that do the
17003 real work. Match operators are header name strings followed by a match
17004 and a match type. A typical match operator looks like @samp{("from"
17005 "Lars Ingebrigtsen" s)}. The header names are the same as when using
17006 simple scoring, and the match types are also the same.
17009 @node Advanced Scoring Examples
17010 @subsection Advanced Scoring Examples
17012 Let's say you want to increase the score of articles written by Lars
17013 when he's talking about Gnus:
17017 ("from" "Lars Ingebrigtsen")
17018 ("subject" "Gnus"))
17024 When he writes long articles, he sometimes has something nice to say:
17028 ("from" "Lars Ingebrigtsen")
17035 However, when he responds to things written by Reig Eigil Logge, you
17036 really don't want to read what he's written:
17040 ("from" "Lars Ingebrigtsen")
17041 (1- ("from" "Reig Eigir Logge")))
17045 Everybody that follows up Redmondo when he writes about disappearing
17046 socks should have their scores raised, but only when they talk about
17047 white socks. However, when Lars talks about socks, it's usually not
17054 ("from" "redmondo@@.*no" r)
17055 ("body" "disappearing.*socks" t)))
17056 (! ("from" "Lars Ingebrigtsen"))
17057 ("body" "white.*socks"))
17061 The possibilities are endless.
17064 @node Advanced Scoring Tips
17065 @subsection Advanced Scoring Tips
17067 The @code{&} and @code{|} logical operators do short-circuit logic.
17068 That is, they stop processing their arguments when it's clear what the
17069 result of the operation will be. For instance, if one of the arguments
17070 of an @code{&} evaluates to @code{false}, there's no point in evaluating
17071 the rest of the arguments. This means that you should put slow matches
17072 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
17073 @samp{subject}) first.
17075 The indirection arguments (@code{1-} and so on) will make their
17076 arguments work on previous generations of the thread. If you say
17087 Then that means "score on the from header of the grandparent of the
17088 current article". An indirection is quite fast, but it's better to say:
17094 ("subject" "Gnus")))
17101 (1- ("from" "Lars"))
17102 (1- ("subject" "Gnus")))
17107 @section Score Decays
17108 @cindex score decays
17111 You may find that your scores have a tendency to grow without
17112 bounds, especially if you're using adaptive scoring. If scores get too
17113 big, they lose all meaning---they simply max out and it's difficult to
17114 use them in any sensible way.
17116 @vindex gnus-decay-scores
17117 @findex gnus-decay-score
17118 @vindex gnus-decay-score-function
17119 Gnus provides a mechanism for decaying scores to help with this problem.
17120 When score files are loaded and @code{gnus-decay-scores} is
17121 non-@code{nil}, Gnus will run the score files through the decaying
17122 mechanism thereby lowering the scores of all non-permanent score rules.
17123 The decay itself if performed by the @code{gnus-decay-score-function}
17124 function, which is @code{gnus-decay-score} by default. Here's the
17125 definition of that function:
17128 (defun gnus-decay-score (score)
17130 This is done according to `gnus-score-decay-constant'
17131 and `gnus-score-decay-scale'."
17134 (* (if (< score 0) 1 -1)
17136 (max gnus-score-decay-constant
17138 gnus-score-decay-scale)))))))
17141 @vindex gnus-score-decay-scale
17142 @vindex gnus-score-decay-constant
17143 @code{gnus-score-decay-constant} is 3 by default and
17144 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
17148 Scores between -3 and 3 will be set to 0 when this function is called.
17151 Scores with magnitudes between 3 and 60 will be shrunk by 3.
17154 Scores with magnitudes greater than 60 will be shrunk by 5% of the
17158 If you don't like this decay function, write your own. It is called
17159 with the score to be decayed as its only parameter, and it should return
17160 the new score, which should be an integer.
17162 Gnus will try to decay scores once a day. If you haven't run Gnus for
17163 four days, Gnus will decay the scores four times, for instance.
17170 * Process/Prefix:: A convention used by many treatment commands.
17171 * Interactive:: Making Gnus ask you many questions.
17172 * Symbolic Prefixes:: How to supply some Gnus functions with options.
17173 * Formatting Variables:: You can specify what buffers should look like.
17174 * Windows Configuration:: Configuring the Gnus buffer windows.
17175 * Faces and Fonts:: How to change how faces look.
17176 * Compilation:: How to speed Gnus up.
17177 * Mode Lines:: Displaying information in the mode lines.
17178 * Highlighting and Menus:: Making buffers look all nice and cozy.
17179 * Buttons:: Get tendinitis in ten easy steps!
17180 * Daemons:: Gnus can do things behind your back.
17181 * NoCeM:: How to avoid spam and other fatty foods.
17182 * Undo:: Some actions can be undone.
17183 * Moderation:: What to do if you're a moderator.
17184 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
17185 * Fuzzy Matching:: What's the big fuzz?
17186 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
17187 * Various Various:: Things that are really various.
17191 @node Process/Prefix
17192 @section Process/Prefix
17193 @cindex process/prefix convention
17195 Many functions, among them functions for moving, decoding and saving
17196 articles, use what is known as the @dfn{Process/Prefix convention}.
17198 This is a method for figuring out what articles the user wants the
17199 command to be performed on.
17203 If the numeric prefix is N, perform the operation on the next N
17204 articles, starting with the current one. If the numeric prefix is
17205 negative, perform the operation on the previous N articles, starting
17206 with the current one.
17208 @vindex transient-mark-mode
17209 If @code{transient-mark-mode} in non-@code{nil} and the region is
17210 active, all articles in the region will be worked upon.
17212 If there is no numeric prefix, but some articles are marked with the
17213 process mark, perform the operation on the articles marked with
17216 If there is neither a numeric prefix nor any articles marked with the
17217 process mark, just perform the operation on the current article.
17219 Quite simple, really, but it needs to be made clear so that surprises
17222 Commands that react to the process mark will push the current list of
17223 process marked articles onto a stack and will then clear all process
17224 marked articles. You can restore the previous configuration with the
17225 @kbd{M P y} command (@pxref{Setting Process Marks}).
17227 @vindex gnus-summary-goto-unread
17228 One thing that seems to shock & horrify lots of people is that, for
17229 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
17230 Since each @kbd{d} (which marks the current article as read) by default
17231 goes to the next unread article after marking, this means that @kbd{3 d}
17232 will mark the next three unread articles as read, no matter what the
17233 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
17234 @code{nil} for a more straightforward action.
17236 Many commands do not use the process/prefix convention. All commands
17237 that do explicitly say so in this manual. To apply the process/prefix
17238 convention to commands that do not use it, you can use the @kbd{M-&}
17239 command. For instance, to mark all the articles in the group as
17240 expirable, you could say `M P b M-& E'.
17244 @section Interactive
17245 @cindex interaction
17249 @item gnus-novice-user
17250 @vindex gnus-novice-user
17251 If this variable is non-@code{nil}, you are either a newcomer to the
17252 World of Usenet, or you are very cautious, which is a nice thing to be,
17253 really. You will be given questions of the type ``Are you sure you want
17254 to do this?'' before doing anything dangerous. This is @code{t} by
17257 @item gnus-expert-user
17258 @vindex gnus-expert-user
17259 If this variable is non-@code{nil}, you will seldom be asked any
17260 questions by Gnus. It will simply assume you know what you're doing, no
17261 matter how strange.
17263 @item gnus-interactive-catchup
17264 @vindex gnus-interactive-catchup
17265 Require confirmation before catching up a group if non-@code{nil}. It
17266 is @code{t} by default.
17268 @item gnus-interactive-exit
17269 @vindex gnus-interactive-exit
17270 Require confirmation before exiting Gnus. This variable is @code{t} by
17275 @node Symbolic Prefixes
17276 @section Symbolic Prefixes
17277 @cindex symbolic prefixes
17279 Quite a lot of Emacs commands react to the (numeric) prefix. For
17280 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
17281 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
17282 rule of 900 to the current article.
17284 This is all nice and well, but what if you want to give a command some
17285 additional information? Well, what most commands do is interpret the
17286 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
17287 doesn't want a backup file to be created when saving the current buffer,
17288 for instance. But what if you want to save without making a backup
17289 file, and you want Emacs to flash lights and play a nice tune at the
17290 same time? You can't, and you're probably perfectly happy that way.
17292 @kindex M-i (Summary)
17293 @findex gnus-symbolic-argument
17294 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
17295 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
17296 character typed in is the value. You can stack as many @kbd{M-i}
17297 prefixes as you want. @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
17298 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b M-C-u} means
17299 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
17300 @code{b}''. You get the drift.
17302 Typing in symbolic prefixes to commands that don't accept them doesn't
17303 hurt, but it doesn't do any good either. Currently not many Gnus
17304 functions make use of the symbolic prefix.
17306 If you're interested in how Gnus implements this, @pxref{Extended
17310 @node Formatting Variables
17311 @section Formatting Variables
17312 @cindex formatting variables
17314 Throughout this manual you've probably noticed lots of variables called
17315 things like @code{gnus-group-line-format} and
17316 @code{gnus-summary-mode-line-format}. These control how Gnus is to
17317 output lines in the various buffers. There's quite a lot of them.
17318 Fortunately, they all use the same syntax, so there's not that much to
17321 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
17322 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
17323 lots of percentages everywhere.
17326 * Formatting Basics:: A formatting variable is basically a format string.
17327 * Mode Line Formatting:: Some rules about mode line formatting variables.
17328 * Advanced Formatting:: Modifying output in various ways.
17329 * User-Defined Specs:: Having Gnus call your own functions.
17330 * Formatting Fonts:: Making the formatting look colorful and nice.
17333 Currently Gnus uses the following formatting variables:
17334 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
17335 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
17336 @code{gnus-group-mode-line-format},
17337 @code{gnus-summary-mode-line-format},
17338 @code{gnus-article-mode-line-format},
17339 @code{gnus-server-mode-line-format}, and
17340 @code{gnus-summary-pick-line-format}.
17342 All these format variables can also be arbitrary elisp forms. In that
17343 case, they will be @code{eval}ed to insert the required lines.
17345 @kindex M-x gnus-update-format
17346 @findex gnus-update-format
17347 Gnus includes a command to help you while creating your own format
17348 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
17349 update the spec in question and pop you to a buffer where you can
17350 examine the resulting lisp code to be run to generate the line.
17354 @node Formatting Basics
17355 @subsection Formatting Basics
17357 Each @samp{%} element will be replaced by some string or other when the
17358 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
17359 spec, and pad with spaces to get a 5-character field''.
17361 As with normal C and Emacs Lisp formatting strings, the numerical
17362 modifier between the @samp{%} and the formatting type character will
17363 @dfn{pad} the output so that it is always at least that long.
17364 @samp{%5y} will make the field always (at least) five characters wide by
17365 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
17368 You may also wish to limit the length of the field to protect against
17369 particularly wide values. For that you can say @samp{%4,6y}, which
17370 means that the field will never be more than 6 characters wide and never
17371 less than 4 characters wide.
17374 @node Mode Line Formatting
17375 @subsection Mode Line Formatting
17377 Mode line formatting variables (e.g.,
17378 @code{gnus-summary-mode-line-format}) follow the same rules as other,
17379 buffer line oriented formatting variables (@pxref{Formatting Basics})
17380 with the following two differences:
17385 There must be no newline (@samp{\n}) at the end.
17388 The special @samp{%%b} spec can be used to display the buffer name.
17389 Well, it's no spec at all, really---@samp{%%} is just a way to quote
17390 @samp{%} to allow it to pass through the formatting machinery unmangled,
17391 so that Emacs receives @samp{%b}, which is something the Emacs mode line
17392 display interprets to mean ``show the buffer name''. For a full list of
17393 mode line specs Emacs understands, see the documentation of the
17394 @code{mode-line-format} variable.
17399 @node Advanced Formatting
17400 @subsection Advanced Formatting
17402 It is frequently useful to post-process the fields in some way.
17403 Padding, limiting, cutting off parts and suppressing certain values can
17404 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
17405 look like @samp{%~(cut 3)~(ignore "0")y}.
17407 These are the valid modifiers:
17412 Pad the field to the left with spaces until it reaches the required
17416 Pad the field to the right with spaces until it reaches the required
17421 Cut off characters from the left until it reaches the specified length.
17424 Cut off characters from the right until it reaches the specified
17429 Cut off the specified number of characters from the left.
17432 Cut off the specified number of characters from the right.
17435 Return an empty string if the field is equal to the specified value.
17438 Use the specified form as the field value when the @samp{@@} spec is
17442 Let's take an example. The @samp{%o} spec in the summary mode lines
17443 will return a date in compact ISO8601 format---@samp{19960809T230410}.
17444 This is quite a mouthful, so we want to shave off the century number and
17445 the time, leaving us with a six-character date. That would be
17446 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
17447 maxing, and we need the padding to ensure that the date is never less
17448 than 6 characters to make it look nice in columns.)
17450 Ignoring is done first; then cutting; then maxing; and then as the very
17451 last operation, padding.
17453 If you use lots of these advanced thingies, you'll find that Gnus gets
17454 quite slow. This can be helped enormously by running @kbd{M-x
17455 gnus-compile} when you are satisfied with the look of your lines.
17456 @xref{Compilation}.
17459 @node User-Defined Specs
17460 @subsection User-Defined Specs
17462 All the specs allow for inserting user defined specifiers---@samp{u}.
17463 The next character in the format string should be a letter. Gnus
17464 will call the function @code{gnus-user-format-function-}@samp{X}, where
17465 @samp{X} is the letter following @samp{%u}. The function will be passed
17466 a single parameter---what the parameter means depends on what buffer
17467 it's being called from. The function should return a string, which will
17468 be inserted into the buffer just like information from any other
17469 specifier. This function may also be called with dummy values, so it
17470 should protect against that.
17472 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
17473 much the same without defining new functions. Here's an example:
17474 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
17475 given here will be evaluated to yield the current line number, and then
17479 @node Formatting Fonts
17480 @subsection Formatting Fonts
17482 There are specs for highlighting, and these are shared by all the format
17483 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
17484 the special @code{mouse-face} property set, which means that it will be
17485 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
17488 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
17489 normal faces set using @code{gnus-face-0}, which is @code{bold} by
17490 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
17491 and so on. Create as many faces as you wish. The same goes for the
17492 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
17493 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
17495 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
17496 @code{balloon-help} property set to @code{gnus-balloon-face-0}. If you
17497 say @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The
17498 @code{gnus-balloon-face-*} variables should be either strings or symbols
17499 naming functions that return a string. Under @code{balloon-help-mode},
17500 when the mouse passes over text with this property set, a balloon window
17501 will appear and display the string. Please refer to the doc string of
17502 @code{balloon-help-mode} for more information on this.
17504 Here's an alternative recipe for the group buffer:
17507 ;; Create three face types.
17508 (setq gnus-face-1 'bold)
17509 (setq gnus-face-3 'italic)
17511 ;; We want the article count to be in
17512 ;; a bold and green face. So we create
17513 ;; a new face called `my-green-bold'.
17514 (copy-face 'bold 'my-green-bold)
17516 (set-face-foreground 'my-green-bold "ForestGreen")
17517 (setq gnus-face-2 'my-green-bold)
17519 ;; Set the new & fancy format.
17520 (setq gnus-group-line-format
17521 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
17524 I'm sure you'll be able to use this scheme to create totally unreadable
17525 and extremely vulgar displays. Have fun!
17527 Note that the @samp{%(} specs (and friends) do not make any sense on the
17528 mode-line variables.
17531 @node Windows Configuration
17532 @section Windows Configuration
17533 @cindex windows configuration
17535 No, there's nothing here about X, so be quiet.
17537 @vindex gnus-use-full-window
17538 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
17539 other windows and occupy the entire Emacs screen by itself. It is
17540 @code{t} by default.
17542 Setting this variable to @code{nil} kinda works, but there are
17543 glitches. Use at your own peril.
17545 @vindex gnus-buffer-configuration
17546 @code{gnus-buffer-configuration} describes how much space each Gnus
17547 buffer should be given. Here's an excerpt of this variable:
17550 ((group (vertical 1.0 (group 1.0 point)
17551 (if gnus-carpal (group-carpal 4))))
17552 (article (vertical 1.0 (summary 0.25 point)
17556 This is an alist. The @dfn{key} is a symbol that names some action or
17557 other. For instance, when displaying the group buffer, the window
17558 configuration function will use @code{group} as the key. A full list of
17559 possible names is listed below.
17561 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
17562 should occupy. To take the @code{article} split as an example -
17565 (article (vertical 1.0 (summary 0.25 point)
17569 This @dfn{split} says that the summary buffer should occupy 25% of upper
17570 half of the screen, and that it is placed over the article buffer. As
17571 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
17572 reaching for that calculator there). However, the special number
17573 @code{1.0} is used to signal that this buffer should soak up all the
17574 rest of the space available after the rest of the buffers have taken
17575 whatever they need. There should be only one buffer with the @code{1.0}
17576 size spec per split.
17578 Point will be put in the buffer that has the optional third element
17579 @code{point}. In a @code{frame} split, the last subsplit having a leaf
17580 split where the tag @code{frame-focus} is a member (i.e. is the third or
17581 fourth element in the list, depending on whether the @code{point} tag is
17582 present) gets focus.
17584 Here's a more complicated example:
17587 (article (vertical 1.0 (group 4)
17588 (summary 0.25 point)
17589 (if gnus-carpal (summary-carpal 4))
17593 If the size spec is an integer instead of a floating point number,
17594 then that number will be used to say how many lines a buffer should
17595 occupy, not a percentage.
17597 If the @dfn{split} looks like something that can be @code{eval}ed (to be
17598 precise---if the @code{car} of the split is a function or a subr), this
17599 split will be @code{eval}ed. If the result is non-@code{nil}, it will
17600 be used as a split. This means that there will be three buffers if
17601 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
17604 Not complicated enough for you? Well, try this on for size:
17607 (article (horizontal 1.0
17612 (summary 0.25 point)
17617 Whoops. Two buffers with the mystery 100% tag. And what's that
17618 @code{horizontal} thingie?
17620 If the first element in one of the split is @code{horizontal}, Gnus will
17621 split the window horizontally, giving you two windows side-by-side.
17622 Inside each of these strips you may carry on all you like in the normal
17623 fashion. The number following @code{horizontal} says what percentage of
17624 the screen is to be given to this strip.
17626 For each split, there @emph{must} be one element that has the 100% tag.
17627 The splitting is never accurate, and this buffer will eat any leftover
17628 lines from the splits.
17630 To be slightly more formal, here's a definition of what a valid split
17634 split = frame | horizontal | vertical | buffer | form
17635 frame = "(frame " size *split ")"
17636 horizontal = "(horizontal " size *split ")"
17637 vertical = "(vertical " size *split ")"
17638 buffer = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
17639 size = number | frame-params
17640 buffer-name = group | article | summary ...
17643 The limitations are that the @code{frame} split can only appear as the
17644 top-level split. @var{form} should be an Emacs Lisp form that should
17645 return a valid split. We see that each split is fully recursive, and
17646 may contain any number of @code{vertical} and @code{horizontal} splits.
17648 @vindex gnus-window-min-width
17649 @vindex gnus-window-min-height
17650 @cindex window height
17651 @cindex window width
17652 Finding the right sizes can be a bit complicated. No window may be less
17653 than @code{gnus-window-min-height} (default 1) characters high, and all
17654 windows must be at least @code{gnus-window-min-width} (default 1)
17655 characters wide. Gnus will try to enforce this before applying the
17656 splits. If you want to use the normal Emacs window width/height limit,
17657 you can just set these two variables to @code{nil}.
17659 If you're not familiar with Emacs terminology, @code{horizontal} and
17660 @code{vertical} splits may work the opposite way of what you'd expect.
17661 Windows inside a @code{horizontal} split are shown side-by-side, and
17662 windows within a @code{vertical} split are shown above each other.
17664 @findex gnus-configure-frame
17665 If you want to experiment with window placement, a good tip is to call
17666 @code{gnus-configure-frame} directly with a split. This is the function
17667 that does all the real work when splitting buffers. Below is a pretty
17668 nonsensical configuration with 5 windows; two for the group buffer and
17669 three for the article buffer. (I said it was nonsensical.) If you
17670 @code{eval} the statement below, you can get an idea of how that would
17671 look straight away, without going through the normal Gnus channels.
17672 Play with it until you're satisfied, and then use
17673 @code{gnus-add-configuration} to add your new creation to the buffer
17674 configuration list.
17677 (gnus-configure-frame
17681 (article 0.3 point))
17689 You might want to have several frames as well. No prob---just use the
17690 @code{frame} split:
17693 (gnus-configure-frame
17696 (summary 0.25 point frame-focus)
17698 (vertical ((height . 5) (width . 15)
17699 (user-position . t)
17700 (left . -1) (top . 1))
17705 This split will result in the familiar summary/article window
17706 configuration in the first (or ``main'') frame, while a small additional
17707 frame will be created where picons will be shown. As you can see,
17708 instead of the normal @code{1.0} top-level spec, each additional split
17709 should have a frame parameter alist as the size spec.
17710 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
17711 Reference Manual}. Under XEmacs, a frame property list will be
17712 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
17714 The list of all possible keys for @code{gnus-buffer-configuration} can
17715 be found in its default value.
17717 Note that the @code{message} key is used for both
17718 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
17719 it is desirable to distinguish between the two, something like this
17723 (message (horizontal 1.0
17724 (vertical 1.0 (message 1.0 point))
17726 (if (buffer-live-p gnus-summary-buffer)
17731 One common desire for a multiple frame split is to have a separate frame
17732 for composing mail and news while leaving the original frame intact. To
17733 accomplish that, something like the following can be done:
17736 (message (frame 1.0
17737 (if (not (buffer-live-p gnus-summary-buffer))
17738 (car (cdr (assoc 'group gnus-buffer-configuration)))
17739 (car (cdr (assoc 'summary gnus-buffer-configuration))))
17740 (vertical ((user-position . t) (top . 1) (left . 1)
17741 (name . "Message"))
17742 (message 1.0 point))))
17745 @findex gnus-add-configuration
17746 Since the @code{gnus-buffer-configuration} variable is so long and
17747 complicated, there's a function you can use to ease changing the config
17748 of a single setting: @code{gnus-add-configuration}. If, for instance,
17749 you want to change the @code{article} setting, you could say:
17752 (gnus-add-configuration
17753 '(article (vertical 1.0
17755 (summary .25 point)
17759 You'd typically stick these @code{gnus-add-configuration} calls in your
17760 @file{.gnus.el} file or in some startup hook---they should be run after
17761 Gnus has been loaded.
17763 @vindex gnus-always-force-window-configuration
17764 If all windows mentioned in the configuration are already visible, Gnus
17765 won't change the window configuration. If you always want to force the
17766 ``right'' window configuration, you can set
17767 @code{gnus-always-force-window-configuration} to non-@code{nil}.
17769 If you're using tree displays (@pxref{Tree Display}), and the tree
17770 window is displayed vertically next to another window, you may also want
17771 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
17774 @subsection Example Window Configurations
17778 Narrow left hand side occupied by group buffer. Right hand side split
17779 between summary buffer (top one-sixth) and article buffer (bottom).
17794 (gnus-add-configuration
17797 (vertical 25 (group 1.0))
17799 (summary 0.16 point)
17802 (gnus-add-configuration
17805 (vertical 25 (group 1.0))
17806 (vertical 1.0 (summary 1.0 point)))))
17812 @node Faces and Fonts
17813 @section Faces and Fonts
17818 Fiddling with fonts and faces used to be very difficult, but these days
17819 it is very simple. You simply say @kbd{M-x customize-face}, pick out
17820 the face you want to alter, and alter it via the standard Customize
17825 @section Compilation
17826 @cindex compilation
17827 @cindex byte-compilation
17829 @findex gnus-compile
17831 Remember all those line format specification variables?
17832 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
17833 on. Now, Gnus will of course heed whatever these variables are, but,
17834 unfortunately, changing them will mean a quite significant slow-down.
17835 (The default values of these variables have byte-compiled functions
17836 associated with them, while the user-generated versions do not, of
17839 To help with this, you can run @kbd{M-x gnus-compile} after you've
17840 fiddled around with the variables and feel that you're (kind of)
17841 satisfied. This will result in the new specs being byte-compiled, and
17842 you'll get top speed again. Gnus will save these compiled specs in the
17843 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
17844 this function, though---you should compile them yourself by sticking
17845 them into the @code{.gnus.el} file and byte-compiling that file.)
17849 @section Mode Lines
17852 @vindex gnus-updated-mode-lines
17853 @code{gnus-updated-mode-lines} says what buffers should keep their mode
17854 lines updated. It is a list of symbols. Supported symbols include
17855 @code{group}, @code{article}, @code{summary}, @code{server},
17856 @code{browse}, and @code{tree}. If the corresponding symbol is present,
17857 Gnus will keep that mode line updated with information that may be
17858 pertinent. If this variable is @code{nil}, screen refresh may be
17861 @cindex display-time
17863 @vindex gnus-mode-non-string-length
17864 By default, Gnus displays information on the current article in the mode
17865 lines of the summary and article buffers. The information Gnus wishes
17866 to display (e.g. the subject of the article) is often longer than the
17867 mode lines, and therefore have to be cut off at some point. The
17868 @code{gnus-mode-non-string-length} variable says how long the other
17869 elements on the line is (i.e., the non-info part). If you put
17870 additional elements on the mode line (e.g. a clock), you should modify
17873 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
17875 (add-hook 'display-time-hook
17876 (lambda () (setq gnus-mode-non-string-length
17878 (if line-number-mode 5 0)
17879 (if column-number-mode 4 0)
17880 (length display-time-string)))))
17883 If this variable is @code{nil} (which is the default), the mode line
17884 strings won't be chopped off, and they won't be padded either. Note
17885 that the default is unlikely to be desirable, as even the percentage
17886 complete in the buffer may be crowded off the mode line; the user should
17887 configure this variable appropriately for her configuration.
17890 @node Highlighting and Menus
17891 @section Highlighting and Menus
17893 @cindex highlighting
17896 @vindex gnus-visual
17897 The @code{gnus-visual} variable controls most of the Gnus-prettifying
17898 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
17899 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
17902 This variable can be a list of visual properties that are enabled. The
17903 following elements are valid, and are all included by default:
17906 @item group-highlight
17907 Do highlights in the group buffer.
17908 @item summary-highlight
17909 Do highlights in the summary buffer.
17910 @item article-highlight
17911 Do highlights in the article buffer.
17913 Turn on highlighting in all buffers.
17915 Create menus in the group buffer.
17917 Create menus in the summary buffers.
17919 Create menus in the article buffer.
17921 Create menus in the browse buffer.
17923 Create menus in the server buffer.
17925 Create menus in the score buffers.
17927 Create menus in all buffers.
17930 So if you only want highlighting in the article buffer and menus in all
17931 buffers, you could say something like:
17934 (setq gnus-visual '(article-highlight menu))
17937 If you want highlighting only and no menus whatsoever, you'd say:
17940 (setq gnus-visual '(highlight))
17943 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
17944 in all Gnus buffers.
17946 Other general variables that influence the look of all buffers include:
17949 @item gnus-mouse-face
17950 @vindex gnus-mouse-face
17951 This is the face (i.e., font) used for mouse highlighting in Gnus. No
17952 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
17956 There are hooks associated with the creation of all the different menus:
17960 @item gnus-article-menu-hook
17961 @vindex gnus-article-menu-hook
17962 Hook called after creating the article mode menu.
17964 @item gnus-group-menu-hook
17965 @vindex gnus-group-menu-hook
17966 Hook called after creating the group mode menu.
17968 @item gnus-summary-menu-hook
17969 @vindex gnus-summary-menu-hook
17970 Hook called after creating the summary mode menu.
17972 @item gnus-server-menu-hook
17973 @vindex gnus-server-menu-hook
17974 Hook called after creating the server mode menu.
17976 @item gnus-browse-menu-hook
17977 @vindex gnus-browse-menu-hook
17978 Hook called after creating the browse mode menu.
17980 @item gnus-score-menu-hook
17981 @vindex gnus-score-menu-hook
17982 Hook called after creating the score mode menu.
17993 Those new-fangled @dfn{mouse} contraptions is very popular with the
17994 young, hep kids who don't want to learn the proper way to do things
17995 these days. Why, I remember way back in the summer of '89, when I was
17996 using Emacs on a Tops 20 system. Three hundred users on one single
17997 machine, and every user was running Simula compilers. Bah!
18001 @vindex gnus-carpal
18002 Well, you can make Gnus display bufferfuls of buttons you can click to
18003 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
18004 really. Tell the chiropractor I sent you.
18009 @item gnus-carpal-mode-hook
18010 @vindex gnus-carpal-mode-hook
18011 Hook run in all carpal mode buffers.
18013 @item gnus-carpal-button-face
18014 @vindex gnus-carpal-button-face
18015 Face used on buttons.
18017 @item gnus-carpal-header-face
18018 @vindex gnus-carpal-header-face
18019 Face used on carpal buffer headers.
18021 @item gnus-carpal-group-buffer-buttons
18022 @vindex gnus-carpal-group-buffer-buttons
18023 Buttons in the group buffer.
18025 @item gnus-carpal-summary-buffer-buttons
18026 @vindex gnus-carpal-summary-buffer-buttons
18027 Buttons in the summary buffer.
18029 @item gnus-carpal-server-buffer-buttons
18030 @vindex gnus-carpal-server-buffer-buttons
18031 Buttons in the server buffer.
18033 @item gnus-carpal-browse-buffer-buttons
18034 @vindex gnus-carpal-browse-buffer-buttons
18035 Buttons in the browse buffer.
18038 All the @code{buttons} variables are lists. The elements in these list
18039 are either cons cells where the @code{car} contains a text to be displayed and
18040 the @code{cdr} contains a function symbol, or a simple string.
18048 Gnus, being larger than any program ever written (allegedly), does lots
18049 of strange stuff that you may wish to have done while you're not
18050 present. For instance, you may want it to check for new mail once in a
18051 while. Or you may want it to close down all connections to all servers
18052 when you leave Emacs idle. And stuff like that.
18054 Gnus will let you do stuff like that by defining various
18055 @dfn{handlers}. Each handler consists of three elements: A
18056 @var{function}, a @var{time}, and an @var{idle} parameter.
18058 Here's an example of a handler that closes connections when Emacs has
18059 been idle for thirty minutes:
18062 (gnus-demon-close-connections nil 30)
18065 Here's a handler that scans for PGP headers every hour when Emacs is
18069 (gnus-demon-scan-pgp 60 t)
18072 This @var{time} parameter and than @var{idle} parameter work together
18073 in a strange, but wonderful fashion. Basically, if @var{idle} is
18074 @code{nil}, then the function will be called every @var{time} minutes.
18076 If @var{idle} is @code{t}, then the function will be called after
18077 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
18078 the function will never be called. But once Emacs goes idle, the
18079 function will be called every @var{time} minutes.
18081 If @var{idle} is a number and @var{time} is a number, the function will
18082 be called every @var{time} minutes only when Emacs has been idle for
18083 @var{idle} minutes.
18085 If @var{idle} is a number and @var{time} is @code{nil}, the function
18086 will be called once every time Emacs has been idle for @var{idle}
18089 And if @var{time} is a string, it should look like @samp{07:31}, and
18090 the function will then be called once every day somewhere near that
18091 time. Modified by the @var{idle} parameter, of course.
18093 @vindex gnus-demon-timestep
18094 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
18095 seconds. This is 60 by default. If you change that variable,
18096 all the timings in the handlers will be affected.)
18098 So, if you want to add a handler, you could put something like this in
18099 your @file{.gnus} file:
18101 @findex gnus-demon-add-handler
18103 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
18106 @findex gnus-demon-add-nocem
18107 @findex gnus-demon-add-scanmail
18108 @findex gnus-demon-add-rescan
18109 @findex gnus-demon-add-scan-timestamps
18110 @findex gnus-demon-add-disconnection
18111 Some ready-made functions to do this have been created:
18112 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
18113 @code{gnus-demon-add-nntp-close-connection},
18114 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
18115 @code{gnus-demon-add-scanmail}. Just put those functions in your
18116 @file{.gnus} if you want those abilities.
18118 @findex gnus-demon-init
18119 @findex gnus-demon-cancel
18120 @vindex gnus-demon-handlers
18121 If you add handlers to @code{gnus-demon-handlers} directly, you should
18122 run @code{gnus-demon-init} to make the changes take hold. To cancel all
18123 daemons, you can use the @code{gnus-demon-cancel} function.
18125 Note that adding daemons can be pretty naughty if you over do it. Adding
18126 functions that scan all news and mail from all servers every two seconds
18127 is a sure-fire way of getting booted off any respectable system. So
18136 @dfn{Spamming} is posting the same article lots and lots of times.
18137 Spamming is bad. Spamming is evil.
18139 Spamming is usually canceled within a day or so by various anti-spamming
18140 agencies. These agencies usually also send out @dfn{NoCeM} messages.
18141 NoCeM is pronounced ``no see-'em'', and means what the name
18142 implies---these are messages that make the offending articles, like, go
18145 What use are these NoCeM messages if the articles are canceled anyway?
18146 Some sites do not honor cancel messages and some sites just honor cancels
18147 from a select few people. Then you may wish to make use of the NoCeM
18148 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
18150 Gnus can read and parse the messages in this group automatically, and
18151 this will make spam disappear.
18153 There are some variables to customize, of course:
18156 @item gnus-use-nocem
18157 @vindex gnus-use-nocem
18158 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
18161 @item gnus-nocem-groups
18162 @vindex gnus-nocem-groups
18163 Gnus will look for NoCeM messages in the groups in this list. The
18164 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
18165 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
18167 @item gnus-nocem-issuers
18168 @vindex gnus-nocem-issuers
18169 There are many people issuing NoCeM messages. This list says what
18170 people you want to listen to. The default is @code{("Automoose-1"
18171 "clewis@@ferret.ocunix.on.ca" "cosmo.roadkill" "SpamHippo"
18172 "hweede@@snafu.de")}; fine, upstanding citizens all of them.
18174 Known despammers that you can put in this list are listed at
18175 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
18177 You do not have to heed NoCeM messages from all these people---just the
18178 ones you want to listen to. You also don't have to accept all NoCeM
18179 messages from the people you like. Each NoCeM message has a @dfn{type}
18180 header that gives the message a (more or less, usually less) rigorous
18181 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
18182 @samp{binary}, and @samp{troll}. To specify this, you have to use
18183 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
18184 Each condition is either a string (which is a regexp that matches types
18185 you want to use) or a list on the form @code{(not @var{string})}, where
18186 @var{string} is a regexp that matches types you don't want to use.
18188 For instance, if you want all NoCeM messages from Chris Lewis except his
18189 @samp{troll} messages, you'd say:
18192 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
18195 On the other hand, if you just want nothing but his @samp{spam} and
18196 @samp{spew} messages, you'd say:
18199 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
18202 The specs are applied left-to-right.
18205 @item gnus-nocem-verifyer
18206 @vindex gnus-nocem-verifyer
18208 This should be a function for verifying that the NoCeM issuer is who she
18209 says she is. The default is @code{mc-verify}, which is a Mailcrypt
18210 function. If this is too slow and you don't care for verification
18211 (which may be dangerous), you can set this variable to @code{nil}.
18213 If you want signed NoCeM messages to be verified and unsigned messages
18214 not to be verified (but used anyway), you could do something like:
18217 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
18219 (defun my-gnus-mc-verify ()
18227 This might be dangerous, though.
18229 @item gnus-nocem-directory
18230 @vindex gnus-nocem-directory
18231 This is where Gnus will store its NoCeM cache files. The default is
18232 @file{~/News/NoCeM/}.
18234 @item gnus-nocem-expiry-wait
18235 @vindex gnus-nocem-expiry-wait
18236 The number of days before removing old NoCeM entries from the cache.
18237 The default is 15. If you make it shorter Gnus will be faster, but you
18238 might then see old spam.
18240 @item gnus-nocem-check-from
18241 @vindex gnus-nocem-check-from
18242 Non-@code{nil} means check for valid issuers in message bodies.
18243 Otherwise don't bother fetching articles unless their author matches a
18244 valid issuer; that is much faster if you are selective about the
18247 @item gnus-nocem-check-article-limit
18248 @vindex gnus-nocem-check-article-limit
18249 If non-@code{nil}, the maximum number of articles to check in any NoCeM
18250 group. NoCeM groups can be huge and very slow to process.
18254 Using NoCeM could potentially be a memory hog. If you have many living
18255 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
18256 big. If this is a problem, you should kill off all (or most) of your
18257 unsubscribed groups (@pxref{Subscription Commands}).
18264 It is very useful to be able to undo actions one has done. In normal
18265 Emacs buffers, it's easy enough---you just push the @code{undo} button.
18266 In Gnus buffers, however, it isn't that simple.
18268 The things Gnus displays in its buffer is of no value whatsoever to
18269 Gnus---it's all just data designed to look nice to the user.
18270 Killing a group in the group buffer with @kbd{C-k} makes the line
18271 disappear, but that's just a side-effect of the real action---the
18272 removal of the group in question from the internal Gnus structures.
18273 Undoing something like that can't be done by the normal Emacs
18274 @code{undo} function.
18276 Gnus tries to remedy this somewhat by keeping track of what the user
18277 does and coming up with actions that would reverse the actions the user
18278 takes. When the user then presses the @code{undo} key, Gnus will run
18279 the code to reverse the previous action, or the previous actions.
18280 However, not all actions are easily reversible, so Gnus currently offers
18281 a few key functions to be undoable. These include killing groups,
18282 yanking groups, and changing the list of read articles of groups.
18283 That's it, really. More functions may be added in the future, but each
18284 added function means an increase in data to be stored, so Gnus will
18285 never be totally undoable.
18287 @findex gnus-undo-mode
18288 @vindex gnus-use-undo
18290 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
18291 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
18292 default. The @kbd{M-C-_} key performs the @code{gnus-undo}
18293 command, which should feel kinda like the normal Emacs @code{undo}
18298 @section Moderation
18301 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
18302 It is not included in the standard Gnus package. Write a mail to
18303 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
18306 The moderation package is implemented as a minor mode for summary
18310 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
18313 in your @file{.gnus.el} file.
18315 If you are the moderator of @samp{rec.zoofle}, this is how it's
18320 You split your incoming mail by matching on
18321 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
18322 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
18325 You enter that group once in a while and post articles using the @kbd{e}
18326 (edit-and-post) or @kbd{s} (just send unedited) commands.
18329 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
18330 articles that weren't approved by you, you can cancel them with the
18334 To use moderation mode in these two groups, say:
18337 (setq gnus-moderated-list
18338 "^nnml:rec.zoofle$\\|^rec.zoofle$")
18342 @node XEmacs Enhancements
18343 @section XEmacs Enhancements
18346 XEmacs is able to display pictures and stuff, so Gnus has taken
18350 * Picons:: How to display pictures of what your reading.
18351 * Smileys:: Show all those happy faces the way they were meant to be shown.
18352 * Toolbar:: Click'n'drool.
18353 * XVarious:: Other XEmacsy Gnusey variables.
18366 So@dots{} You want to slow down your news reader even more! This is a
18367 good way to do so. Its also a great way to impress people staring
18368 over your shoulder as you read news.
18371 * Picon Basics:: What are picons and How do I get them.
18372 * Picon Requirements:: Don't go further if you aren't using XEmacs.
18373 * Easy Picons:: Displaying Picons---the easy way.
18374 * Hard Picons:: The way you should do it. You'll learn something.
18375 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
18380 @subsubsection Picon Basics
18382 What are Picons? To quote directly from the Picons Web site:
18391 @dfn{Picons} is short for ``personal icons''. They're small,
18392 constrained images used to represent users and domains on the net,
18393 organized into databases so that the appropriate image for a given
18394 e-mail address can be found. Besides users and domains, there are picon
18395 databases for Usenet newsgroups and weather forecasts. The picons are
18396 in either monochrome @code{XBM} format or color @code{XPM} and
18397 @code{GIF} formats.
18400 @vindex gnus-picons-piconsearch-url
18401 If you have a permanent connection to the Internet you can use Steve
18402 Kinzler's Picons Search engine by setting
18403 @code{gnus-picons-piconsearch-url} to the string @*
18404 @uref{http://www.cs.indiana.edu/picons/search.html}.
18406 @vindex gnus-picons-database
18407 Otherwise you need a local copy of his database. For instructions on
18408 obtaining and installing the picons databases, point your Web browser at @*
18409 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}. Gnus expects
18410 picons to be installed into a location pointed to by
18411 @code{gnus-picons-database}.
18414 @node Picon Requirements
18415 @subsubsection Picon Requirements
18417 To have Gnus display Picons for you, you must be running XEmacs
18418 19.13 or greater since all other versions of Emacs aren't yet able to
18421 Additionally, you must have @code{x} support compiled into XEmacs. To
18422 display color picons which are much nicer than the black & white one,
18423 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
18425 @vindex gnus-picons-convert-x-face
18426 If you want to display faces from @code{X-Face} headers, you should have
18427 the @code{xface} support compiled into XEmacs. Otherwise you must have
18428 the @code{netpbm} utilities installed, or munge the
18429 @code{gnus-picons-convert-x-face} variable to use something else.
18433 @subsubsection Easy Picons
18435 To enable displaying picons, simply put the following line in your
18436 @file{~/.gnus} file and start Gnus.
18439 (setq gnus-use-picons t)
18440 (setq gnus-treat-display-picons t)
18443 and make sure @code{gnus-picons-database} points to the directory
18444 containing the Picons databases.
18446 Alternatively if you want to use the web piconsearch engine add this:
18449 (setq gnus-picons-piconsearch-url
18450 "http://www.cs.indiana.edu:800/piconsearch")
18455 @subsubsection Hard Picons
18463 Gnus can display picons for you as you enter and leave groups and
18464 articles. It knows how to interact with three sections of the picons
18465 database. Namely, it can display the picons newsgroup pictures,
18466 author's face picture(s), and the authors domain. To enable this
18467 feature, you need to select where to get the picons from, and where to
18472 @item gnus-picons-database
18473 @vindex gnus-picons-database
18474 The location of the picons database. Should point to a directory
18475 containing the @file{news}, @file{domains}, @file{users} (and so on)
18476 subdirectories. This is only useful if
18477 @code{gnus-picons-piconsearch-url} is @code{nil}. Defaults to
18478 @file{/usr/local/faces/}.
18480 @item gnus-picons-piconsearch-url
18481 @vindex gnus-picons-piconsearch-url
18482 The URL for the web picons search engine. The only currently known
18483 engine is @uref{http://www.cs.indiana.edu:800/piconsearch}. To
18484 workaround network delays, icons will be fetched in the background. If
18485 this is @code{nil} 'the default), then picons are fetched from local
18486 database indicated by @code{gnus-picons-database}.
18488 @item gnus-picons-display-where
18489 @vindex gnus-picons-display-where
18490 Where the picon images should be displayed. It is @code{picons} by
18491 default (which by default maps to the buffer @samp{*Picons*}). Other
18492 valid places could be @code{article}, @code{summary}, or
18493 @samp{*scratch*} for all I care. Just make sure that you've made the
18494 buffer visible using the standard Gnus window configuration
18495 routines---@pxref{Windows Configuration}.
18497 @item gnus-picons-group-excluded-groups
18498 @vindex gnus-picons-group-excluded-groups
18499 Groups that are matched by this regexp won't have their group icons
18504 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
18505 window configuration for you to include the @code{picons} buffer.
18507 Now that you've made those decision, you need to add the following
18508 functions to the appropriate hooks so these pictures will get displayed
18511 @vindex gnus-picons-display-where
18513 @item gnus-article-display-picons
18514 @findex gnus-article-display-picons
18515 Looks up and displays the picons for the author and the author's domain
18516 in the @code{gnus-picons-display-where} buffer.
18518 @item gnus-picons-article-display-x-face
18519 @findex gnus-article-display-picons
18520 Decodes and displays the X-Face header if present.
18526 @node Picon Useless Configuration
18527 @subsubsection Picon Useless Configuration
18535 The following variables offer further control over how things are
18536 done, where things are located, and other useless stuff you really
18537 don't need to worry about.
18541 @item gnus-picons-news-directories
18542 @vindex gnus-picons-news-directories
18543 List of subdirectories to search in @code{gnus-picons-database} for
18544 newsgroups faces. @code{("news")} is the default.
18546 @item gnus-picons-user-directories
18547 @vindex gnus-picons-user-directories
18548 List of subdirectories to search in @code{gnus-picons-database} for user
18549 faces. @code{("local" "users" "usenix" "misc")} is the default.
18551 @item gnus-picons-domain-directories
18552 @vindex gnus-picons-domain-directories
18553 List of subdirectories to search in @code{gnus-picons-database} for
18554 domain name faces. Defaults to @code{("domains")}. Some people may
18555 want to add @samp{"unknown"} to this list.
18557 @item gnus-picons-convert-x-face
18558 @vindex gnus-picons-convert-x-face
18559 If you don't have @code{xface} support builtin XEmacs, this is the
18560 command to use to convert the @code{X-Face} header to an X bitmap
18561 (@code{xbm}). Defaults to @code{(format "@{ echo '/* Width=48,
18562 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
18563 gnus-picons-x-face-file-name)}
18565 @item gnus-picons-x-face-file-name
18566 @vindex gnus-picons-x-face-file-name
18567 Names a temporary file to store the @code{X-Face} bitmap in. Defaults
18568 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
18570 @item gnus-picons-has-modeline-p
18571 @vindex gnus-picons-has-modeline-p
18572 If you have set @code{gnus-picons-display-where} to @code{picons}, your
18573 XEmacs frame will become really cluttered. To alleviate this a bit you
18574 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
18575 remove the mode line from the Picons buffer. This is only useful if
18576 @code{gnus-picons-display-where} is @code{picons}.
18578 @item gnus-picons-refresh-before-display
18579 @vindex gnus-picons-refresh-before-display
18580 If non-nil, display the article buffer before computing the picons.
18581 Defaults to @code{nil}.
18583 @item gnus-picons-display-as-address
18584 @vindex gnus-picons-display-as-address
18585 If @code{t} display textual email addresses along with pictures.
18586 Defaults to @code{t}.
18588 @item gnus-picons-file-suffixes
18589 @vindex gnus-picons-file-suffixes
18590 Ordered list of suffixes on picon file names to try. Defaults to
18591 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
18593 @item gnus-picons-setup-hook
18594 @vindex gnus-picons-setup-hook
18595 Hook run in the picon buffer, if that is displayed.
18597 @item gnus-picons-display-article-move-p
18598 @vindex gnus-picons-display-article-move-p
18599 Whether to move point to first empty line when displaying picons. This
18600 has only an effect if `gnus-picons-display-where' has value `article'.
18602 If @code{nil}, display the picons in the @code{From} and
18603 @code{Newsgroups} lines. This is the default.
18605 @item gnus-picons-clear-cache-on-shutdown
18606 @vindex gnus-picons-clear-cache-on-shutdown
18607 Whether to clear the picons cache when exiting gnus. Gnus caches every
18608 picons it finds while it is running. This saves some time in the search
18609 process but eats some memory. If this variable is set to @code{nil},
18610 Gnus will never clear the cache itself; you will have to manually call
18611 @code{gnus-picons-clear-cache} to clear it. Otherwise the cache will be
18612 cleared every time you exit Gnus. Defaults to @code{t}.
18623 @subsection Smileys
18628 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
18633 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
18634 currently the only package that uses Smiley, it is documented here.
18636 In short---to use Smiley in Gnus, put the following in your
18637 @file{.gnus.el} file:
18640 (setq gnus-treat-display-smileys t)
18643 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
18644 the like---to pictures and displays those instead of the text smiley
18645 faces. The conversion is controlled by a list of regexps that matches
18646 text and maps that to file names.
18648 @vindex smiley-nosey-regexp-alist
18649 @vindex smiley-deformed-regexp-alist
18650 Smiley supplies two example conversion alists by default:
18651 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
18652 and so on), and @code{smiley-nosey-regexp-alist} (which matches
18653 @samp{:-)}, @samp{:-(} and so on).
18655 The alist used is specified by the @code{smiley-regexp-alist} variable,
18656 which defaults to the value of @code{smiley-deformed-regexp-alist}.
18658 The first item in each element is the regexp to be matched; the second
18659 element is the regexp match group that is to be replaced by the picture;
18660 and the third element is the name of the file to be displayed.
18662 The following variables customize where Smiley will look for these
18663 files, as well as the color to be used and stuff:
18667 @item smiley-data-directory
18668 @vindex smiley-data-directory
18669 Where Smiley will look for smiley faces files.
18671 @item smiley-flesh-color
18672 @vindex smiley-flesh-color
18673 Skin color. The default is @samp{yellow}, which is really racist.
18675 @item smiley-features-color
18676 @vindex smiley-features-color
18677 Color of the features of the face. The default is @samp{black}.
18679 @item smiley-tongue-color
18680 @vindex smiley-tongue-color
18681 Color of the tongue. The default is @samp{red}.
18683 @item smiley-circle-color
18684 @vindex smiley-circle-color
18685 Color of the circle around the face. The default is @samp{black}.
18687 @item smiley-mouse-face
18688 @vindex smiley-mouse-face
18689 Face used for mouse highlighting over the smiley face.
18695 @subsection Toolbar
18705 @item gnus-use-toolbar
18706 @vindex gnus-use-toolbar
18707 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
18708 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
18709 @code{right-toolbar}, or @code{left-toolbar}.
18711 @item gnus-group-toolbar
18712 @vindex gnus-group-toolbar
18713 The toolbar in the group buffer.
18715 @item gnus-summary-toolbar
18716 @vindex gnus-summary-toolbar
18717 The toolbar in the summary buffer.
18719 @item gnus-summary-mail-toolbar
18720 @vindex gnus-summary-mail-toolbar
18721 The toolbar in the summary buffer of mail groups.
18727 @subsection Various XEmacs Variables
18730 @item gnus-xmas-glyph-directory
18731 @vindex gnus-xmas-glyph-directory
18732 This is where Gnus will look for pictures. Gnus will normally
18733 auto-detect this directory, but you may set it manually if you have an
18734 unusual directory structure.
18736 @item gnus-xmas-logo-color-alist
18737 @vindex gnus-xmas-logo-color-alist
18738 This is an alist where the key is a type symbol and the values are the
18739 foreground and background color of the splash page glyph.
18741 @item gnus-xmas-logo-color-style
18742 @vindex gnus-xmas-logo-color-style
18743 This is the key used to look up the color in the alist described above.
18744 Valid values include @code{flame}, @code{pine}, @code{moss},
18745 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
18746 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
18748 @item gnus-xmas-modeline-glyph
18749 @vindex gnus-xmas-modeline-glyph
18750 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
18764 @node Fuzzy Matching
18765 @section Fuzzy Matching
18766 @cindex fuzzy matching
18768 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
18769 things like scoring, thread gathering and thread comparison.
18771 As opposed to regular expression matching, fuzzy matching is very fuzzy.
18772 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
18773 means, and the implementation has changed over time.
18775 Basically, it tries to remove all noise from lines before comparing.
18776 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
18777 out of the strings before comparing the results. This often leads to
18778 adequate results---even when faced with strings generated by text
18779 manglers masquerading as newsreaders.
18782 @node Thwarting Email Spam
18783 @section Thwarting Email Spam
18787 @cindex unsolicited commercial email
18789 In these last days of the Usenet, commercial vultures are hanging about
18790 and grepping through news like crazy to find email addresses they can
18791 foist off their scams and products to. As a reaction to this, many
18792 people have started putting nonsense addresses into their @code{From}
18793 lines. I think this is counterproductive---it makes it difficult for
18794 people to send you legitimate mail in response to things you write, as
18795 well as making it difficult to see who wrote what. This rewriting may
18796 perhaps be a bigger menace than the unsolicited commercial email itself
18799 The biggest problem I have with email spam is that it comes in under
18800 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
18801 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
18802 mail group, only to find two pyramid schemes, seven advertisements
18803 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
18804 and one mail asking me to repent and find some god.
18808 The way to deal with this is having Gnus split out all spam into a
18809 @samp{spam} mail group (@pxref{Splitting Mail}).
18811 First, pick one (1) valid mail address that you can be reached at, and
18812 put it in your @code{From} header of all your news articles. (I've
18813 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
18814 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
18815 sysadmin whether your sendmail installation accepts keywords in the local
18816 part of the mail address.)
18819 (setq message-default-news-headers
18820 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
18823 Then put the following split rule in @code{nnmail-split-fancy}
18824 (@pxref{Fancy Mail Splitting}):
18829 (to "larsi@@trym.ifi.uio.no"
18830 (| ("subject" "re:.*" "misc")
18831 ("references" ".*@@.*" "misc")
18837 This says that all mail to this address is suspect, but if it has a
18838 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
18839 header, it's probably ok. All the rest goes to the @samp{spam} group.
18840 (This idea probably comes from Tim Pierce.)
18842 In addition, many mail spammers talk directly to your @code{smtp} server
18843 and do not include your email address explicitly in the @code{To}
18844 header. Why they do this is unknown---perhaps it's to thwart this
18845 thwarting scheme? In any case, this is trivial to deal with---you just
18846 put anything not addressed to you in the @samp{spam} group by ending
18847 your fancy split rule in this way:
18852 (to "larsi" "misc")
18856 In my experience, this will sort virtually everything into the right
18857 group. You still have to check the @samp{spam} group from time to time to
18858 check for legitimate mail, though. If you feel like being a good net
18859 citizen, you can even send off complaints to the proper authorities on
18860 each unsolicited commercial email---at your leisure.
18862 If you are also a lazy net citizen, you will probably prefer complaining
18863 automatically with the @file{gnus-junk.el} package, available FOR FREE
18864 at @* @uref{http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html}.
18865 Since most e-mail spam is sent automatically, this may reconcile the
18866 cosmic balance somewhat.
18868 This works for me. It allows people an easy way to contact me (they can
18869 just press @kbd{r} in the usual way), and I'm not bothered at all with
18870 spam. It's a win-win situation. Forging @code{From} headers to point
18871 to non-existent domains is yucky, in my opinion.
18874 @node Various Various
18875 @section Various Various
18881 @item gnus-home-directory
18882 All Gnus path variables will be initialized from this variable, which
18883 defaults to @file{~/}.
18885 @item gnus-directory
18886 @vindex gnus-directory
18887 Most Gnus storage path variables will be initialized from this variable,
18888 which defaults to the @samp{SAVEDIR} environment variable, or
18889 @file{~/News/} if that variable isn't set.
18891 Note that Gnus is mostly loaded when the @file{.gnus.el} file is read.
18892 This means that other directory variables that are initialized from this
18893 variable won't be set properly if you set this variable in
18894 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
18896 @item gnus-default-directory
18897 @vindex gnus-default-directory
18898 Not related to the above variable at all---this variable says what the
18899 default directory of all Gnus buffers should be. If you issue commands
18900 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
18901 default directory. If this variable is @code{nil} (which is the
18902 default), the default directory will be the default directory of the
18903 buffer you were in when you started Gnus.
18906 @vindex gnus-verbose
18907 This variable is an integer between zero and ten. The higher the value,
18908 the more messages will be displayed. If this variable is zero, Gnus
18909 will never flash any messages, if it is seven (which is the default),
18910 most important messages will be shown, and if it is ten, Gnus won't ever
18911 shut up, but will flash so many messages it will make your head swim.
18913 @item gnus-verbose-backends
18914 @vindex gnus-verbose-backends
18915 This variable works the same way as @code{gnus-verbose}, but it applies
18916 to the Gnus backends instead of Gnus proper.
18918 @item nnheader-max-head-length
18919 @vindex nnheader-max-head-length
18920 When the backends read straight heads of articles, they all try to read
18921 as little as possible. This variable (default 4096) specifies
18922 the absolute max length the backends will try to read before giving up
18923 on finding a separator line between the head and the body. If this
18924 variable is @code{nil}, there is no upper read bound. If it is
18925 @code{t}, the backends won't try to read the articles piece by piece,
18926 but read the entire articles. This makes sense with some versions of
18927 @code{ange-ftp} or @code{efs}.
18929 @item nnheader-head-chop-length
18930 @vindex nnheader-head-chop-length
18931 This variable (default 2048) says how big a piece of each article to
18932 read when doing the operation described above.
18934 @item nnheader-file-name-translation-alist
18935 @vindex nnheader-file-name-translation-alist
18937 @cindex invalid characters in file names
18938 @cindex characters in file names
18939 This is an alist that says how to translate characters in file names.
18940 For instance, if @samp{:} is invalid as a file character in file names
18941 on your system (you OS/2 user you), you could say something like:
18944 (setq nnheader-file-name-translation-alist
18948 In fact, this is the default value for this variable on OS/2 and MS
18949 Windows (phooey) systems.
18951 @item gnus-hidden-properties
18952 @vindex gnus-hidden-properties
18953 This is a list of properties to use to hide ``invisible'' text. It is
18954 @code{(invisible t intangible t)} by default on most systems, which
18955 makes invisible text invisible and intangible.
18957 @item gnus-parse-headers-hook
18958 @vindex gnus-parse-headers-hook
18959 A hook called before parsing headers. It can be used, for instance, to
18960 gather statistics on the headers fetched, or perhaps you'd like to prune
18961 some headers. I don't see why you'd want that, though.
18963 @item gnus-shell-command-separator
18964 @vindex gnus-shell-command-separator
18965 String used to separate two shell commands. The default is @samp{;}.
18967 @item gnus-invalid-group-regexp
18968 @vindex gnus-invalid-group-regexp
18970 Regexp to match ``invalid'' group names when querying user for a group
18971 name. The default value catches some @strong{really} invalid group
18972 names who could possibly mess up Gnus internally (like allowing
18973 @samp{:} in a group name, which is normally used to delimit method and
18976 @sc{imap} users might want to allow @samp{/} in group names though.
18985 Well, that's the manual---you can get on with your life now. Keep in
18986 touch. Say hello to your cats from me.
18988 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
18990 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
18996 Not because of victories @*
18999 but for the common sunshine,@*
19001 the largess of the spring.
19005 but for the day's work done@*
19006 as well as I was able;@*
19007 not for a seat upon the dais@*
19008 but at the common table.@*
19013 @chapter Appendices
19016 * History:: How Gnus got where it is today.
19017 * On Writing Manuals:: Why this is not a beginner's guide.
19018 * Terminology:: We use really difficult, like, words here.
19019 * Customization:: Tailoring Gnus to your needs.
19020 * Troubleshooting:: What you might try if things do not work.
19021 * Gnus Reference Guide:: Rilly, rilly technical stuff.
19022 * Emacs for Heathens:: A short introduction to Emacsian terms.
19023 * Frequently Asked Questions:: A question-and-answer session.
19031 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
19032 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
19034 If you want to investigate the person responsible for this outrage,
19035 you can point your (feh!) web browser to
19036 @uref{http://quimby.gnus.org/}. This is also the primary
19037 distribution point for the new and spiffy versions of Gnus, and is
19038 known as The Site That Destroys Newsrcs And Drives People Mad.
19040 During the first extended alpha period of development, the new Gnus was
19041 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
19042 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
19043 (Besides, the ``Gnus'' in this abbreviation should probably be
19044 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
19045 appropriate name, don't you think?)
19047 In any case, after spending all that energy on coming up with a new and
19048 spunky name, we decided that the name was @emph{too} spunky, so we
19049 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
19050 ``@sc{gnus}''. New vs. old.
19053 * Gnus Versions:: What Gnus versions have been released.
19054 * Other Gnus Versions:: Other Gnus versions that also have been released.
19055 * Why?:: What's the point of Gnus?
19056 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
19057 * Conformity:: Gnus tries to conform to all standards.
19058 * Emacsen:: Gnus can be run on a few modern Emacsen.
19059 * Gnus Development:: How Gnus is developed.
19060 * Contributors:: Oodles of people.
19061 * New Features:: Pointers to some of the new stuff in Gnus.
19065 @node Gnus Versions
19066 @subsection Gnus Versions
19067 @cindex Pterodactyl Gnus
19069 @cindex September Gnus
19070 @cindex Quassia Gnus
19072 The first ``proper'' release of Gnus 5 was done in November 1995 when it
19073 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
19074 plus 15 Gnus 5.0 releases).
19076 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
19077 releases)) was released under the name ``Gnus 5.2'' (40 releases).
19079 On July 28th 1996 work on Red Gnus was begun, and it was released on
19080 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
19082 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
19083 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
19085 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
19086 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
19089 On the 26th of October 2000, Oort Gnus was begun.
19091 If you happen upon a version of Gnus that has a prefixed name --
19092 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
19093 ``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic. Don't let it know
19094 that you're frightened. Back away. Slowly. Whatever you do, don't
19095 run. Walk away, calmly, until you're out of its reach. Find a proper
19096 released version of Gnus and snuggle up to that instead.
19099 @node Other Gnus Versions
19100 @subsection Other Gnus Versions
19103 In addition to the versions of Gnus which have had their releases
19104 coordinated by Lars, one major development has been Semi-gnus from
19105 Japan. It's based on a library called @sc{semi}, which provides
19106 @sc{mime} capabilities.
19108 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
19109 Collectively, they are called ``Semi-gnus'', and different strains are
19110 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
19111 @sc{mime} and multilingualization things, especially important for
19118 What's the point of Gnus?
19120 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
19121 newsreader, that lets you do anything you can think of. That was my
19122 original motivation, but while working on Gnus, it has become clear to
19123 me that this generation of newsreaders really belong in the stone age.
19124 Newsreaders haven't developed much since the infancy of the net. If the
19125 volume continues to rise with the current rate of increase, all current
19126 newsreaders will be pretty much useless. How do you deal with
19127 newsgroups that have thousands of new articles each day? How do you
19128 keep track of millions of people who post?
19130 Gnus offers no real solutions to these questions, but I would very much
19131 like to see Gnus being used as a testing ground for new methods of
19132 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
19133 to separate the newsreader from the backends, Gnus now offers a simple
19134 interface for anybody who wants to write new backends for fetching mail
19135 and news from different sources. I have added hooks for customizations
19136 everywhere I could imagine it being useful. By doing so, I'm inviting
19137 every one of you to explore and invent.
19139 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
19140 @kbd{C-u 100 M-x all-hail-xemacs}.
19143 @node Compatibility
19144 @subsection Compatibility
19146 @cindex compatibility
19147 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
19148 bindings have been kept. More key bindings have been added, of course,
19149 but only in one or two obscure cases have old bindings been changed.
19154 @center In a cloud bones of steel.
19158 All commands have kept their names. Some internal functions have changed
19161 The @code{gnus-uu} package has changed drastically. @xref{Decoding
19164 One major compatibility question is the presence of several summary
19165 buffers. All variables relevant while reading a group are
19166 buffer-local to the summary buffer they belong in. Although many
19167 important variables have their values copied into their global
19168 counterparts whenever a command is executed in the summary buffer, this
19169 change might lead to incorrect values being used unless you are careful.
19171 All code that relies on knowledge of @sc{gnus} internals will probably
19172 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
19173 changing it in any way, as a matter of fact) is strictly verboten. Gnus
19174 maintains a hash table that points to the entries in this alist (which
19175 speeds up many functions), and changing the alist directly will lead to
19179 @cindex highlighting
19180 Old hilit19 code does not work at all. In fact, you should probably
19181 remove all hilit code from all Gnus hooks
19182 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
19183 Gnus provides various integrated functions for highlighting. These are
19184 faster and more accurate. To make life easier for everybody, Gnus will
19185 by default remove all hilit calls from all hilit hooks. Uncleanliness!
19188 Packages like @code{expire-kill} will no longer work. As a matter of
19189 fact, you should probably remove all old @sc{gnus} packages (and other
19190 code) when you start using Gnus. More likely than not, Gnus already
19191 does what you have written code to make @sc{gnus} do. (Snicker.)
19193 Even though old methods of doing things are still supported, only the
19194 new methods are documented in this manual. If you detect a new method of
19195 doing something while reading this manual, that does not mean you have
19196 to stop doing it the old way.
19198 Gnus understands all @sc{gnus} startup files.
19200 @kindex M-x gnus-bug
19202 @cindex reporting bugs
19204 Overall, a casual user who hasn't written much code that depends on
19205 @sc{gnus} internals should suffer no problems. If problems occur,
19206 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
19208 @vindex gnus-bug-create-help-buffer
19209 If you are in the habit of sending bug reports @emph{very} often, you
19210 may find the helpful help buffer annoying after a while. If so, set
19211 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
19216 @subsection Conformity
19218 No rebels without a clue here, ma'am. We conform to all standards known
19219 to (wo)man. Except for those standards and/or conventions we disagree
19226 There are no known breaches of this standard.
19230 There are no known breaches of this standard, either.
19232 @item Son-of-RFC 1036
19233 @cindex Son-of-RFC 1036
19234 We do have some breaches to this one.
19240 These are considered to be ``vanity headers'', while I consider them
19241 to be consumer information. After seeing so many badly formatted
19242 articles coming from @code{tin} and @code{Netscape} I know not to use
19243 either of those for posting articles. I would not have known that if
19244 it wasn't for the @code{X-Newsreader} header.
19249 USEFOR is an IETF working group writing a successor to RFC 1036, based
19250 on Son-of-RFC 1036. They have produced a number of drafts proposing
19251 various changes to the format of news articles. The Gnus towers will
19252 look into implementing the changes when the draft is accepted as an RFC.
19256 If you ever notice Gnus acting non-compliant with regards to the texts
19257 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
19262 @subsection Emacsen
19268 Gnus should work on :
19276 XEmacs 20.4 and up.
19280 This Gnus version will absolutely not work on any Emacsen older than
19281 that. Not reliably, at least. Older versions of Gnus may work on older
19284 There are some vague differences between Gnus on the various
19285 platforms---XEmacs features more graphics (a logo and a toolbar)---but
19286 other than that, things should look pretty much the same under all
19290 @node Gnus Development
19291 @subsection Gnus Development
19293 Gnus is developed in a two-phased cycle. The first phase involves much
19294 discussion on the @samp{ding@@gnus.org} mailing list, where people
19295 propose changes and new features, post patches and new backends. This
19296 phase is called the @dfn{alpha} phase, since the Gnusae released in this
19297 phase are @dfn{alpha releases}, or (perhaps more commonly in other
19298 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
19299 unstable and should not be used by casual users. Gnus alpha releases
19300 have names like ``Red Gnus'' and ``Quassia Gnus''.
19302 After futzing around for 50-100 alpha releases, Gnus is declared
19303 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
19304 and is called things like ``Gnus 5.6.32'' instead. Normal people are
19305 supposed to be able to use these, and these are mostly discussed on the
19306 @samp{gnu.emacs.gnus} newsgroup.
19309 @vindex mail-source-delete-incoming
19310 Some variable defaults differ between alpha Gnusae and released Gnusae.
19311 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
19312 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
19313 lossage of mail if an alpha release hiccups while handling the mail.
19315 The division of discussion between the ding mailing list and the Gnus
19316 newsgroup is not purely based on publicity concerns. It's true that
19317 having people write about the horrible things that an alpha Gnus release
19318 can do (sometimes) in a public forum may scare people off, but more
19319 importantly, talking about new experimental features that have been
19320 introduced may confuse casual users. New features are frequently
19321 introduced, fiddled with, and judged to be found wanting, and then
19322 either discarded or totally rewritten. People reading the mailing list
19323 usually keep up with these rapid changes, while people on the newsgroup
19324 can't be assumed to do so.
19329 @subsection Contributors
19330 @cindex contributors
19332 The new Gnus version couldn't have been done without the help of all the
19333 people on the (ding) mailing list. Every day for over a year I have
19334 gotten billions of nice bug reports from them, filling me with joy,
19335 every single one of them. Smooches. The people on the list have been
19336 tried beyond endurance, what with my ``oh, that's a neat idea <type
19337 type>, yup, I'll release it right away <ship off> no wait, that doesn't
19338 work at all <type type>, yup, I'll ship that one off right away <ship
19339 off> no, wait, that absolutely does not work'' policy for releases.
19340 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
19341 ``worser''? ``much worser''? ``worsest''?)
19343 I would like to take this opportunity to thank the Academy for... oops,
19349 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
19352 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
19353 nnwarchive and many, many other things connected with @sc{mime} and
19354 other types of en/decoding, as well as general bug fixing, new
19355 functionality and stuff.
19358 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
19359 well as numerous other things).
19362 Luis Fernandes---design and graphics.
19365 Justin Sheehy--the FAQ maintainer.
19368 Erik Naggum---help, ideas, support, code and stuff.
19371 Wes Hardaker---@file{gnus-picon.el} and the manual section on
19372 @dfn{picons} (@pxref{Picons}).
19375 Kim-Minh Kaplan---further work on the picon code.
19378 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
19379 (@pxref{GroupLens}).
19382 Sudish Joseph---innumerable bug fixes.
19385 Ilja Weis---@file{gnus-topic.el}.
19388 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
19391 Vladimir Alexiev---the refcard and reference booklets.
19394 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
19395 distribution by Felix Lee and JWZ.
19398 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
19401 Peter Mutsaers---orphan article scoring code.
19404 Ken Raeburn---POP mail support.
19407 Hallvard B Furuseth---various bits and pieces, especially dealing with
19411 Brian Edmonds---@file{gnus-bbdb.el}.
19414 David Moore---rewrite of @file{nnvirtual.el} and many other things.
19417 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
19420 François Pinard---many, many interesting and thorough bug reports, as
19421 well as autoconf support.
19425 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
19426 Borges, and Jost Krieger proof-reading parts of the manual.
19428 The following people have contributed many patches and suggestions:
19437 Jason L. Tibbitts, III,
19441 Also thanks to the following for patches and stuff:
19451 Alexei V. Barantsev,
19466 Massimo Campostrini,
19471 Jae-you Chung, @c ?
19472 James H. Cloos, Jr.,
19476 Andrew J. Cosgriff,
19479 Geoffrey T. Dairiki,
19485 Michael Welsh Duggan,
19490 Enami Tsugutomo, @c Enami
19494 Nelson Jose dos Santos Ferreira,
19502 Arne Georg Gleditsch,
19504 Michelangelo Grigni,
19508 Kenichi Handa, @c Handa
19510 Yoshiki Hayashi, @c ?
19512 Hisashige Kenji, @c Hisashige
19519 François Felix Ingrand,
19520 Tatsuya Ichikawa, @c ?
19521 Ishikawa Ichiro, @c Ishikawa
19523 Iwamuro Motonori, @c Iwamuro
19534 Peter Skov Knudsen,
19535 Shuhei Kobayashi, @c Kobayashi
19537 Koseki Yoshinori, @c Koseki
19538 Thor Kristoffersen,
19541 Seokchan Lee, @c Lee
19559 Morioka Tomohiko, @c Morioka
19560 Erik Toubro Nielsen,
19567 Masaharu Onishi, @c Onishi
19572 Jens-Ulrik Holger Petersen,
19576 John McClary Prevost,
19582 Lars Balker Rasmussen,
19587 Christian von Roques,
19590 Wolfgang Rupprecht,
19597 Philippe Schnoebelen,
19599 Randal L. Schwartz,
19613 Kiyokazu Suto, @c Suto
19618 Tozawa Akihiko, @c Tozawa
19634 Katsumi Yamaoka @c Yamaoka
19639 For a full overview of what each person has done, the ChangeLogs
19640 included in the Gnus alpha distributions should give ample reading
19641 (550kB and counting).
19643 Apologies to everybody that I've forgotten, of which there are many, I'm
19646 Gee, that's quite a list of people. I guess that must mean that there
19647 actually are people who are using Gnus. Who'd'a thunk it!
19651 @subsection New Features
19652 @cindex new features
19655 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
19656 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
19657 * Red Gnus:: Third time best---Gnus 5.4/5.5.
19658 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
19659 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
19662 These lists are, of course, just @emph{short} overviews of the
19663 @emph{most} important new features. No, really. There are tons more.
19664 Yes, we have feeping creaturism in full effect.
19667 @subsubsection (ding) Gnus
19669 New features in Gnus 5.0/5.1:
19674 The look of all buffers can be changed by setting format-like variables
19675 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
19678 Local spool and several @sc{nntp} servers can be used at once
19679 (@pxref{Select Methods}).
19682 You can combine groups into virtual groups (@pxref{Virtual Groups}).
19685 You can read a number of different mail formats (@pxref{Getting Mail}).
19686 All the mail backends implement a convenient mail expiry scheme
19687 (@pxref{Expiring Mail}).
19690 Gnus can use various strategies for gathering threads that have lost
19691 their roots (thereby gathering loose sub-threads into one thread) or it
19692 can go back and retrieve enough headers to build a complete thread
19693 (@pxref{Customizing Threading}).
19696 Killed groups can be displayed in the group buffer, and you can read
19697 them as well (@pxref{Listing Groups}).
19700 Gnus can do partial group updates---you do not have to retrieve the
19701 entire active file just to check for new articles in a few groups
19702 (@pxref{The Active File}).
19705 Gnus implements a sliding scale of subscribedness to groups
19706 (@pxref{Group Levels}).
19709 You can score articles according to any number of criteria
19710 (@pxref{Scoring}). You can even get Gnus to find out how to score
19711 articles for you (@pxref{Adaptive Scoring}).
19714 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
19715 manner, so it should be difficult to lose much data on what you have
19716 read if your machine should go down (@pxref{Auto Save}).
19719 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
19720 the @file{.emacs} file.
19723 You can set the process mark on both groups and articles and perform
19724 operations on all the marked items (@pxref{Process/Prefix}).
19727 You can grep through a subset of groups and create a group from the
19728 results (@pxref{Kibozed Groups}).
19731 You can list subsets of groups according to, well, anything
19732 (@pxref{Listing Groups}).
19735 You can browse foreign servers and subscribe to groups from those
19736 servers (@pxref{Browse Foreign Server}).
19739 Gnus can fetch articles, asynchronously, on a second connection to the
19740 server (@pxref{Asynchronous Fetching}).
19743 You can cache articles locally (@pxref{Article Caching}).
19746 The uudecode functions have been expanded and generalized
19747 (@pxref{Decoding Articles}).
19750 You can still post uuencoded articles, which was a little-known feature
19751 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
19754 Fetching parents (and other articles) now actually works without
19755 glitches (@pxref{Finding the Parent}).
19758 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
19761 Digests (and other files) can be used as the basis for groups
19762 (@pxref{Document Groups}).
19765 Articles can be highlighted and customized (@pxref{Customizing
19769 URLs and other external references can be buttonized (@pxref{Article
19773 You can do lots of strange stuff with the Gnus window & frame
19774 configuration (@pxref{Windows Configuration}).
19777 You can click on buttons instead of using the keyboard
19783 @node September Gnus
19784 @subsubsection September Gnus
19788 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
19792 New features in Gnus 5.2/5.3:
19797 A new message composition mode is used. All old customization variables
19798 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
19802 Gnus is now able to generate @dfn{sparse} threads---threads where
19803 missing articles are represented by empty nodes (@pxref{Customizing
19807 (setq gnus-build-sparse-threads 'some)
19811 Outgoing articles are stored on a special archive server
19812 (@pxref{Archived Messages}).
19815 Partial thread regeneration now happens when articles are
19819 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
19822 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
19825 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
19828 (setq gnus-use-trees t)
19832 An @code{nn}-like pick-and-read minor mode is available for the summary
19833 buffers (@pxref{Pick and Read}).
19836 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
19840 In binary groups you can use a special binary minor mode (@pxref{Binary
19844 Groups can be grouped in a folding topic hierarchy (@pxref{Group
19848 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
19852 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
19855 Groups can now have a score, and bubbling based on entry frequency
19856 is possible (@pxref{Group Score}).
19859 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
19863 Groups can be process-marked, and commands can be performed on
19864 groups of groups (@pxref{Marking Groups}).
19867 Caching is possible in virtual groups.
19870 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
19871 news batches, ClariNet briefs collections, and just about everything
19872 else (@pxref{Document Groups}).
19875 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
19879 The Gnus cache is much faster.
19882 Groups can be sorted according to many criteria (@pxref{Sorting
19886 New group parameters have been introduced to set list-addresses and
19887 expiry times (@pxref{Group Parameters}).
19890 All formatting specs allow specifying faces to be used
19891 (@pxref{Formatting Fonts}).
19894 There are several more commands for setting/removing/acting on process
19895 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
19898 The summary buffer can be limited to show parts of the available
19899 articles based on a wide range of criteria. These commands have been
19900 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
19903 Articles can be made persistent with the @kbd{*} command
19904 (@pxref{Persistent Articles}).
19907 All functions for hiding article elements are now toggles.
19910 Article headers can be buttonized (@pxref{Article Washing}).
19913 All mail backends support fetching articles by @code{Message-ID}.
19916 Duplicate mail can now be treated properly (@pxref{Duplicates}).
19919 All summary mode commands are available directly from the article
19920 buffer (@pxref{Article Keymap}).
19923 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
19927 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
19930 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
19935 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
19938 (setq gnus-use-nocem t)
19942 Groups can be made permanently visible (@pxref{Listing Groups}).
19945 (setq gnus-permanently-visible-groups "^nnml:")
19949 Many new hooks have been introduced to make customizing easier.
19952 Gnus respects the @code{Mail-Copies-To} header.
19955 Threads can be gathered by looking at the @code{References} header
19956 (@pxref{Customizing Threading}).
19959 (setq gnus-summary-thread-gathering-function
19960 'gnus-gather-threads-by-references)
19964 Read articles can be stored in a special backlog buffer to avoid
19965 refetching (@pxref{Article Backlog}).
19968 (setq gnus-keep-backlog 50)
19972 A clean copy of the current article is always stored in a separate
19973 buffer to allow easier treatment.
19976 Gnus can suggest where to save articles (@pxref{Saving Articles}).
19979 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
19983 (setq gnus-prompt-before-saving t)
19987 @code{gnus-uu} can view decoded files asynchronously while fetching
19988 articles (@pxref{Other Decode Variables}).
19991 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
19995 Filling in the article buffer now works properly on cited text
19996 (@pxref{Article Washing}).
19999 Hiding cited text adds buttons to toggle hiding, and how much
20000 cited text to hide is now customizable (@pxref{Article Hiding}).
20003 (setq gnus-cited-lines-visible 2)
20007 Boring headers can be hidden (@pxref{Article Hiding}).
20010 Default scoring values can now be set from the menu bar.
20013 Further syntax checking of outgoing articles have been added.
20019 @subsubsection Red Gnus
20021 New features in Gnus 5.4/5.5:
20025 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
20032 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
20035 Article prefetching functionality has been moved up into
20036 Gnus (@pxref{Asynchronous Fetching}).
20039 Scoring can now be performed with logical operators like @code{and},
20040 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
20044 Article washing status can be displayed in the
20045 article mode line (@pxref{Misc Article}).
20048 @file{gnus.el} has been split into many smaller files.
20051 Suppression of duplicate articles based on Message-ID can be done
20052 (@pxref{Duplicate Suppression}).
20055 (setq gnus-suppress-duplicates t)
20059 New variables for specifying what score and adapt files are to be
20060 considered home score and adapt files (@pxref{Home Score File}) have
20064 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
20065 Server Internals}).
20068 Groups can inherit group parameters from parent topics (@pxref{Topic
20072 Article editing has been revamped and is now actually usable.
20075 Signatures can be recognized in more intelligent fashions
20076 (@pxref{Article Signature}).
20079 Summary pick mode has been made to look more @code{nn}-like. Line
20080 numbers are displayed and the @kbd{.} command can be used to pick
20081 articles (@code{Pick and Read}).
20084 Commands for moving the @file{.newsrc.eld} from one server to
20085 another have been added (@pxref{Changing Servers}).
20088 There's a way now to specify that ``uninteresting'' fields be suppressed
20089 when generating lines in buffers (@pxref{Advanced Formatting}).
20092 Several commands in the group buffer can be undone with @kbd{M-C-_}
20096 Scoring can be done on words using the new score type @code{w}
20097 (@pxref{Score File Format}).
20100 Adaptive scoring can be done on a Subject word-by-word basis
20101 (@pxref{Adaptive Scoring}).
20104 (setq gnus-use-adaptive-scoring '(word))
20108 Scores can be decayed (@pxref{Score Decays}).
20111 (setq gnus-decay-scores t)
20115 Scoring can be performed using a regexp on the Date header. The Date is
20116 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
20119 A new command has been added to remove all data on articles from
20120 the native server (@pxref{Changing Servers}).
20123 A new command for reading collections of documents
20124 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
20125 (@pxref{Really Various Summary Commands}).
20128 Process mark sets can be pushed and popped (@pxref{Setting Process
20132 A new mail-to-news backend makes it possible to post even when the @sc{nntp}
20133 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
20136 A new backend for reading searches from Web search engines
20137 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
20138 (@pxref{Web Searches}).
20141 Groups inside topics can now be sorted using the standard sorting
20142 functions, and each topic can be sorted independently (@pxref{Topic
20146 Subsets of the groups can be sorted independently (@code{Sorting
20150 Cached articles can be pulled into the groups (@pxref{Summary Generation
20154 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
20159 Score files are now applied in a more reliable order (@pxref{Score
20163 Reports on where mail messages end up can be generated (@pxref{Splitting
20167 More hooks and functions have been added to remove junk from incoming
20168 mail before saving the mail (@pxref{Washing Mail}).
20171 Emphasized text can be properly fontisized:
20177 @subsubsection Quassia Gnus
20179 New features in Gnus 5.6:
20184 New functionality for using Gnus as an offline newsreader has been
20185 added. A plethora of new commands and modes have been added. See
20186 @pxref{Gnus Unplugged} for the full story.
20189 The @code{nndraft} backend has returned, but works differently than
20190 before. All Message buffers are now also articles in the @code{nndraft}
20191 group, which is created automatically.
20194 @code{gnus-alter-header-function} can now be used to alter header
20198 @code{gnus-summary-goto-article} now accept Message-ID's.
20201 A new Message command for deleting text in the body of a message
20202 outside the region: @kbd{C-c C-v}.
20205 You can now post to component group in @code{nnvirtual} groups with
20209 @code{nntp-rlogin-program}---new variable to ease customization.
20212 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
20213 re-highlighting of the article buffer.
20216 New element in @code{gnus-boring-article-headers}---@code{long-to}.
20219 @kbd{M-i} symbolic prefix command. See the section "Symbolic
20220 Prefixes" in the Gnus manual for details.
20223 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
20224 @kbd{a} to add the score rule to the "all.SCORE" file.
20227 @code{gnus-simplify-subject-functions} variable to allow greater
20228 control over simplification.
20231 @kbd{A T}---new command for fetching the current thread.
20234 @kbd{/ T}---new command for including the current thread in the
20238 @kbd{M-RET} is a new Message command for breaking cited text.
20241 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
20244 The @code{custom-face-lookup} function has been removed.
20245 If you used this function in your initialization files, you must
20246 rewrite them to use @code{face-spec-set} instead.
20249 Canceling now uses the current select method. Symbolic prefix
20250 @kbd{a} forces normal posting method.
20253 New command to translate M******** sm*rtq**t*s into proper
20257 For easier debugging of @code{nntp}, you can set
20258 @code{nntp-record-commands} to a non-@code{nil} value.
20261 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
20262 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
20265 A command for editing group parameters from the summary buffer
20269 A history of where mails have been split is available.
20272 A new article date command has been added---@code{article-date-iso8601}.
20275 Subjects can be simplified when threading by setting
20276 @code{gnus-score-thread-simplify}.
20279 A new function for citing in Message has been
20280 added---@code{message-cite-original-without-signature}.
20283 @code{article-strip-all-blank-lines}---new article command.
20286 A new Message command to kill to the end of the article has
20290 A minimum adaptive score can be specified by using the
20291 @code{gnus-adaptive-word-minimum} variable.
20294 The "lapsed date" article header can be kept continually
20295 updated by the @code{gnus-start-date-timer} command.
20298 Web listserv archives can be read with the @code{nnlistserv} backend.
20301 Old dejanews archives can now be read by @code{nnweb}.
20305 @node Pterodactyl Gnus
20306 @subsubsection Pterodactyl Gnus
20308 New features in Gnus 5.8:
20312 @item The mail-fetching functions have changed. See the manual for the
20313 many details. In particular, all procmail fetching variables are gone.
20315 If you used procmail like in
20318 (setq nnmail-use-procmail t)
20319 (setq nnmail-spool-file 'procmail)
20320 (setq nnmail-procmail-directory "~/mail/incoming/")
20321 (setq nnmail-procmail-suffix "\\.in")
20324 this now has changed to
20328 '((directory :path "~/mail/incoming/"
20332 More information is available in the info doc at Select Methods ->
20333 Getting Mail -> Mail Sources
20335 @item Gnus is now a MIME-capable reader. This affects many parts of
20336 Gnus, and adds a slew of new commands. See the manual for details.
20338 @item Gnus has also been multilingualized. This also affects too
20339 many parts of Gnus to summarize here, and adds many new variables.
20341 @item @code{gnus-auto-select-first} can now be a function to be
20342 called to position point.
20344 @item The user can now decide which extra headers should be included in
20345 summary buffers and NOV files.
20347 @item @code{gnus-article-display-hook} has been removed. Instead, a number
20348 of variables starting with @code{gnus-treat-} have been added.
20350 @item The Gnus posting styles have been redone again and now works in a
20351 subtly different manner.
20353 @item New web-based backends have been added: @code{nnslashdot},
20354 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
20355 again, to keep up with ever-changing layouts.
20357 @item Gnus can now read IMAP mail via @code{nnimap}.
20365 @section The Manual
20369 This manual was generated from a TeXinfo file and then run through
20370 either @code{texi2dvi}
20372 or my own home-brewed TeXinfo to \LaTeX\ transformer,
20373 and then run through @code{latex} and @code{dvips}
20375 to get what you hold in your hands now.
20377 The following conventions have been used:
20382 This is a @samp{string}
20385 This is a @kbd{keystroke}
20388 This is a @file{file}
20391 This is a @code{symbol}
20395 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
20399 (setq flargnoze "yes")
20402 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
20405 (setq flumphel 'yes)
20408 @samp{yes} and @code{yes} are two @emph{very} different things---don't
20409 ever get them confused.
20413 Of course, everything in this manual is of vital interest, so you should
20414 read it all. Several times. However, if you feel like skimming the
20415 manual, look for that gnu head you should see in the margin over
20416 there---it means that what's being discussed is of more importance than
20417 the rest of the stuff. (On the other hand, if everything is infinitely
20418 important, how can anything be more important than that? Just one more
20419 of the mysteries of this world, I guess.)
20425 @node On Writing Manuals
20426 @section On Writing Manuals
20428 I guess most manuals are written after-the-fact; documenting a program
20429 that's already there. This is not how this manual is written. When
20430 implementing something, I write the manual entry for that something
20431 straight away. I then see that it's difficult to explain the
20432 functionality, so I write how it's supposed to be, and then I change the
20433 implementation. Writing the documentation and writing the code goes
20436 This, of course, means that this manual has no, or little, flow. It
20437 documents absolutely everything in Gnus, but often not where you're
20438 looking for it. It is a reference manual, and not a guide to how to get
20441 That would be a totally different book, that should be written using the
20442 reference manual as source material. It would look quite differently.
20447 @section Terminology
20449 @cindex terminology
20454 This is what you are supposed to use this thing for---reading news.
20455 News is generally fetched from a nearby @sc{nntp} server, and is
20456 generally publicly available to everybody. If you post news, the entire
20457 world is likely to read just what you have written, and they'll all
20458 snigger mischievously. Behind your back.
20462 Everything that's delivered to you personally is mail. Some news/mail
20463 readers (like Gnus) blur the distinction between mail and news, but
20464 there is a difference. Mail is private. News is public. Mailing is
20465 not posting, and replying is not following up.
20469 Send a mail to the person who has written what you are reading.
20473 Post an article to the current newsgroup responding to the article you
20478 Gnus gets fed articles from a number of backends, both news and mail
20479 backends. Gnus does not handle the underlying media, so to speak---this
20480 is all done by the backends.
20484 Gnus will always use one method (and backend) as the @dfn{native}, or
20485 default, way of getting news.
20489 You can also have any number of foreign groups active at the same time.
20490 These are groups that use non-native non-secondary backends for getting
20495 Secondary backends are somewhere half-way between being native and being
20496 foreign, but they mostly act like they are native.
20500 A message that has been posted as news.
20503 @cindex mail message
20504 A message that has been mailed.
20508 A mail message or news article
20512 The top part of a message, where administrative information (etc.) is
20517 The rest of an article. Everything not in the head is in the
20522 A line from the head of an article.
20526 A collection of such lines, or a collection of heads. Or even a
20527 collection of @sc{nov} lines.
20531 When Gnus enters a group, it asks the backend for the headers of all
20532 unread articles in the group. Most servers support the News OverView
20533 format, which is more compact and much faster to read and parse than the
20534 normal @sc{head} format.
20538 Each group is subscribed at some @dfn{level} or other (1-9). The ones
20539 that have a lower level are ``more'' subscribed than the groups with a
20540 higher level. In fact, groups on levels 1-5 are considered
20541 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
20542 are @dfn{killed}. Commands for listing groups and scanning for new
20543 articles will all use the numeric prefix as @dfn{working level}.
20545 @item killed groups
20546 @cindex killed groups
20547 No information on killed groups is stored or updated, which makes killed
20548 groups much easier to handle than subscribed groups.
20550 @item zombie groups
20551 @cindex zombie groups
20552 Just like killed groups, only slightly less dead.
20555 @cindex active file
20556 The news server has to keep track of what articles it carries, and what
20557 groups exist. All this information in stored in the active file, which
20558 is rather large, as you might surmise.
20561 @cindex bogus groups
20562 A group that exists in the @file{.newsrc} file, but isn't known to the
20563 server (i.e., it isn't in the active file), is a @emph{bogus group}.
20564 This means that the group probably doesn't exist (any more).
20567 @cindex activating groups
20568 The act of asking the server for info on a group and computing the
20569 number of unread articles is called @dfn{activating the group}.
20570 Un-activated groups are listed with @samp{*} in the group buffer.
20574 A machine one can connect to and get news (or mail) from.
20576 @item select method
20577 @cindex select method
20578 A structure that specifies the backend, the server and the virtual
20581 @item virtual server
20582 @cindex virtual server
20583 A named select method. Since a select method defines all there is to
20584 know about connecting to a (physical) server, taking the thing as a
20585 whole is a virtual server.
20589 Taking a buffer and running it through a filter of some sort. The
20590 result will (more often than not) be cleaner and more pleasing than the
20593 @item ephemeral groups
20594 @cindex ephemeral groups
20595 Most groups store data on what articles you have read. @dfn{Ephemeral}
20596 groups are groups that will have no data stored---when you exit the
20597 group, it'll disappear into the aether.
20600 @cindex solid groups
20601 This is the opposite of ephemeral groups. All groups listed in the
20602 group buffer are solid groups.
20604 @item sparse articles
20605 @cindex sparse articles
20606 These are article placeholders shown in the summary buffer when
20607 @code{gnus-build-sparse-threads} has been switched on.
20611 To put responses to articles directly after the articles they respond
20612 to---in a hierarchical fashion.
20616 @cindex thread root
20617 The first article in a thread is the root. It is the ancestor of all
20618 articles in the thread.
20622 An article that has responses.
20626 An article that responds to a different article---its parent.
20630 A collection of messages in one file. The most common digest format is
20631 specified by RFC 1153.
20637 @node Customization
20638 @section Customization
20639 @cindex general customization
20641 All variables are properly documented elsewhere in this manual. This
20642 section is designed to give general pointers on how to customize Gnus
20643 for some quite common situations.
20646 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
20647 * Slow Terminal Connection:: You run a remote Emacs.
20648 * Little Disk Space:: You feel that having large setup files is icky.
20649 * Slow Machine:: You feel like buying a faster machine.
20653 @node Slow/Expensive Connection
20654 @subsection Slow/Expensive @sc{nntp} Connection
20656 If you run Emacs on a machine locally, and get your news from a machine
20657 over some very thin strings, you want to cut down on the amount of data
20658 Gnus has to get from the @sc{nntp} server.
20662 @item gnus-read-active-file
20663 Set this to @code{nil}, which will inhibit Gnus from requesting the
20664 entire active file from the server. This file is often v. large. You
20665 also have to set @code{gnus-check-new-newsgroups} and
20666 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
20667 doesn't suddenly decide to fetch the active file anyway.
20669 @item gnus-nov-is-evil
20670 This one has to be @code{nil}. If not, grabbing article headers from
20671 the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers
20672 support @sc{xover}; Gnus will detect this by itself.
20676 @node Slow Terminal Connection
20677 @subsection Slow Terminal Connection
20679 Let's say you use your home computer for dialing up the system that runs
20680 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
20681 possible) the amount of data sent over the wires.
20685 @item gnus-auto-center-summary
20686 Set this to @code{nil} to inhibit Gnus from re-centering the summary
20687 buffer all the time. If it is @code{vertical}, do only vertical
20688 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
20689 horizontal and vertical recentering.
20691 @item gnus-visible-headers
20692 Cut down on the headers included in the articles to the
20693 minimum. You can, in fact, make do without them altogether---most of the
20694 useful data is in the summary buffer, anyway. Set this variable to
20695 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
20697 Set this hook to all the available hiding commands:
20699 (setq gnus-treat-hide-headers 'head
20700 gnus-treat-hide-signature t
20701 gnus-treat-hide-citation t)
20704 @item gnus-use-full-window
20705 By setting this to @code{nil}, you can make all the windows smaller.
20706 While this doesn't really cut down much generally, it means that you
20707 have to see smaller portions of articles before deciding that you didn't
20708 want to read them anyway.
20710 @item gnus-thread-hide-subtree
20711 If this is non-@code{nil}, all threads in the summary buffer will be
20714 @item gnus-updated-mode-lines
20715 If this is @code{nil}, Gnus will not put information in the buffer mode
20716 lines, which might save some time.
20720 @node Little Disk Space
20721 @subsection Little Disk Space
20724 The startup files can get rather large, so you may want to cut their
20725 sizes a bit if you are running out of space.
20729 @item gnus-save-newsrc-file
20730 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
20731 only save @file{.newsrc.eld}. This means that you will not be able to
20732 use any other newsreaders than Gnus. This variable is @code{t} by
20735 @item gnus-read-newsrc-file
20736 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
20737 only read @file{.newsrc.eld}. This means that you will not be able to
20738 use any other newsreaders than Gnus. This variable is @code{t} by
20741 @item gnus-save-killed-list
20742 If this is @code{nil}, Gnus will not save the list of dead groups. You
20743 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
20744 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
20745 variable to @code{nil}. This variable is @code{t} by default.
20751 @subsection Slow Machine
20752 @cindex slow machine
20754 If you have a slow machine, or are just really impatient, there are a
20755 few things you can do to make Gnus run faster.
20757 Set @code{gnus-check-new-newsgroups} and
20758 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
20760 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
20761 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
20762 summary buffer faster.
20766 @node Troubleshooting
20767 @section Troubleshooting
20768 @cindex troubleshooting
20770 Gnus works @emph{so} well straight out of the box---I can't imagine any
20778 Make sure your computer is switched on.
20781 Make sure that you really load the current Gnus version. If you have
20782 been running @sc{gnus}, you need to exit Emacs and start it up again before
20786 Try doing an @kbd{M-x gnus-version}. If you get something that looks
20787 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded. If,
20788 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
20789 flee}, you have some old @file{.el} files lying around. Delete these.
20792 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
20796 @vindex max-lisp-eval-depth
20797 Gnus works on many recursive structures, and in some extreme (and very
20798 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
20799 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
20800 something like that.
20803 If all else fails, report the problem as a bug.
20806 @cindex reporting bugs
20808 @kindex M-x gnus-bug
20810 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
20811 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
20812 me the backtrace. I will fix bugs, but I can only fix them if you send
20813 me a precise description as to how to reproduce the bug.
20815 You really can never be too detailed in a bug report. Always use the
20816 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
20817 a 10Kb mail each time you use it, and even if you have sent me your
20818 environment 500 times before. I don't care. I want the full info each
20821 It is also important to remember that I have no memory whatsoever. If
20822 you send a bug report, and I send you a reply, and then you just send
20823 back ``No, it's not! Moron!'', I will have no idea what you are
20824 insulting me about. Always over-explain everything. It's much easier
20825 for all of us---if I don't have all the information I need, I will just
20826 mail you and ask for more info, and everything takes more time.
20828 If the problem you're seeing is very visual, and you can't quite explain
20829 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
20830 it somewhere it can be reached, and include the URL of the picture in
20833 If you just need help, you are better off asking on
20834 @samp{gnu.emacs.gnus}. I'm not very helpful.
20836 @cindex gnu.emacs.gnus
20837 @cindex ding mailing list
20838 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
20839 Write to @samp{ding-request@@gnus.org} to subscribe.
20843 @node Gnus Reference Guide
20844 @section Gnus Reference Guide
20846 It is my hope that other people will figure out smart stuff that Gnus
20847 can do, and that other people will write those smart things as well. To
20848 facilitate that I thought it would be a good idea to describe the inner
20849 workings of Gnus. And some of the not-so-inner workings, while I'm at
20852 You can never expect the internals of a program not to change, but I
20853 will be defining (in some details) the interface between Gnus and its
20854 backends (this is written in stone), the format of the score files
20855 (ditto), data structures (some are less likely to change than others)
20856 and general methods of operation.
20859 * Gnus Utility Functions:: Common functions and variable to use.
20860 * Backend Interface:: How Gnus communicates with the servers.
20861 * Score File Syntax:: A BNF definition of the score file standard.
20862 * Headers:: How Gnus stores headers internally.
20863 * Ranges:: A handy format for storing mucho numbers.
20864 * Group Info:: The group info format.
20865 * Extended Interactive:: Symbolic prefixes and stuff.
20866 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
20867 * Various File Formats:: Formats of files that Gnus use.
20871 @node Gnus Utility Functions
20872 @subsection Gnus Utility Functions
20873 @cindex Gnus utility functions
20874 @cindex utility functions
20876 @cindex internal variables
20878 When writing small functions to be run from hooks (and stuff), it's
20879 vital to have access to the Gnus internal functions and variables.
20880 Below is a list of the most common ones.
20884 @item gnus-newsgroup-name
20885 @vindex gnus-newsgroup-name
20886 This variable holds the name of the current newsgroup.
20888 @item gnus-find-method-for-group
20889 @findex gnus-find-method-for-group
20890 A function that returns the select method for @var{group}.
20892 @item gnus-group-real-name
20893 @findex gnus-group-real-name
20894 Takes a full (prefixed) Gnus group name, and returns the unprefixed
20897 @item gnus-group-prefixed-name
20898 @findex gnus-group-prefixed-name
20899 Takes an unprefixed group name and a select method, and returns the full
20900 (prefixed) Gnus group name.
20902 @item gnus-get-info
20903 @findex gnus-get-info
20904 Returns the group info list for @var{group}.
20906 @item gnus-group-unread
20907 @findex gnus-group-unread
20908 The number of unread articles in @var{group}, or @code{t} if that is
20912 @findex gnus-active
20913 The active entry for @var{group}.
20915 @item gnus-set-active
20916 @findex gnus-set-active
20917 Set the active entry for @var{group}.
20919 @item gnus-add-current-to-buffer-list
20920 @findex gnus-add-current-to-buffer-list
20921 Adds the current buffer to the list of buffers to be killed on Gnus
20924 @item gnus-continuum-version
20925 @findex gnus-continuum-version
20926 Takes a Gnus version string as a parameter and returns a floating point
20927 number. Earlier versions will always get a lower number than later
20930 @item gnus-group-read-only-p
20931 @findex gnus-group-read-only-p
20932 Says whether @var{group} is read-only or not.
20934 @item gnus-news-group-p
20935 @findex gnus-news-group-p
20936 Says whether @var{group} came from a news backend.
20938 @item gnus-ephemeral-group-p
20939 @findex gnus-ephemeral-group-p
20940 Says whether @var{group} is ephemeral or not.
20942 @item gnus-server-to-method
20943 @findex gnus-server-to-method
20944 Returns the select method corresponding to @var{server}.
20946 @item gnus-server-equal
20947 @findex gnus-server-equal
20948 Says whether two virtual servers are equal.
20950 @item gnus-group-native-p
20951 @findex gnus-group-native-p
20952 Says whether @var{group} is native or not.
20954 @item gnus-group-secondary-p
20955 @findex gnus-group-secondary-p
20956 Says whether @var{group} is secondary or not.
20958 @item gnus-group-foreign-p
20959 @findex gnus-group-foreign-p
20960 Says whether @var{group} is foreign or not.
20962 @item group-group-find-parameter
20963 @findex group-group-find-parameter
20964 Returns the parameter list of @var{group}. If given a second parameter,
20965 returns the value of that parameter for @var{group}.
20967 @item gnus-group-set-parameter
20968 @findex gnus-group-set-parameter
20969 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
20971 @item gnus-narrow-to-body
20972 @findex gnus-narrow-to-body
20973 Narrows the current buffer to the body of the article.
20975 @item gnus-check-backend-function
20976 @findex gnus-check-backend-function
20977 Takes two parameters, @var{function} and @var{group}. If the backend
20978 @var{group} comes from supports @var{function}, return non-@code{nil}.
20981 (gnus-check-backend-function "request-scan" "nnml:misc")
20985 @item gnus-read-method
20986 @findex gnus-read-method
20987 Prompts the user for a select method.
20992 @node Backend Interface
20993 @subsection Backend Interface
20995 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
20996 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
20997 server is a @dfn{backend} and some @dfn{backend variables}. As examples
20998 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
20999 examples of the latter we have @code{nntp-port-number} and
21000 @code{nnmbox-directory}.
21002 When Gnus asks for information from a backend---say @code{nntp}---on
21003 something, it will normally include a virtual server name in the
21004 function parameters. (If not, the backend should use the ``current''
21005 virtual server.) For instance, @code{nntp-request-list} takes a virtual
21006 server as its only (optional) parameter. If this virtual server hasn't
21007 been opened, the function should fail.
21009 Note that a virtual server name has no relation to some physical server
21010 name. Take this example:
21014 (nntp-address "ifi.uio.no")
21015 (nntp-port-number 4324))
21018 Here the virtual server name is @samp{odd-one} while the name of
21019 the physical server is @samp{ifi.uio.no}.
21021 The backends should be able to switch between several virtual servers.
21022 The standard backends implement this by keeping an alist of virtual
21023 server environments that they pull down/push up when needed.
21025 There are two groups of interface functions: @dfn{required functions},
21026 which must be present, and @dfn{optional functions}, which Gnus will
21027 always check for presence before attempting to call 'em.
21029 All these functions are expected to return data in the buffer
21030 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
21031 unfortunately named, but we'll have to live with it. When I talk about
21032 @dfn{resulting data}, I always refer to the data in that buffer. When I
21033 talk about @dfn{return value}, I talk about the function value returned by
21034 the function call. Functions that fail should return @code{nil} as the
21037 Some backends could be said to be @dfn{server-forming} backends, and
21038 some might be said not to be. The latter are backends that generally
21039 only operate on one group at a time, and have no concept of ``server''
21040 -- they have a group, and they deliver info on that group and nothing
21043 In the examples and definitions I will refer to the imaginary backend
21046 @cindex @code{nnchoke}
21049 * Required Backend Functions:: Functions that must be implemented.
21050 * Optional Backend Functions:: Functions that need not be implemented.
21051 * Error Messaging:: How to get messages and report errors.
21052 * Writing New Backends:: Extending old backends.
21053 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
21054 * Mail-like Backends:: Some tips on mail backends.
21058 @node Required Backend Functions
21059 @subsubsection Required Backend Functions
21063 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
21065 @var{articles} is either a range of article numbers or a list of
21066 @code{Message-ID}s. Current backends do not fully support either---only
21067 sequences (lists) of article numbers, and most backends do not support
21068 retrieval of @code{Message-ID}s. But they should try for both.
21070 The result data should either be HEADs or NOV lines, and the result
21071 value should either be @code{headers} or @code{nov} to reflect this.
21072 This might later be expanded to @code{various}, which will be a mixture
21073 of HEADs and NOV lines, but this is currently not supported by Gnus.
21075 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
21076 headers", in some meaning of the word. This is generally done by
21077 fetching (at most) @var{fetch-old} extra headers less than the smallest
21078 article number in @code{articles}, and filling the gaps as well. The
21079 presence of this parameter can be ignored if the backend finds it
21080 cumbersome to follow the request. If this is non-@code{nil} and not a
21081 number, do maximum fetches.
21083 Here's an example HEAD:
21086 221 1056 Article retrieved.
21087 Path: ifi.uio.no!sturles
21088 From: sturles@@ifi.uio.no (Sturle Sunde)
21089 Newsgroups: ifi.discussion
21090 Subject: Re: Something very droll
21091 Date: 27 Oct 1994 14:02:57 +0100
21092 Organization: Dept. of Informatics, University of Oslo, Norway
21094 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
21095 References: <38jdmq$4qu@@visbur.ifi.uio.no>
21096 NNTP-Posting-Host: holmenkollen.ifi.uio.no
21100 So a @code{headers} return value would imply that there's a number of
21101 these in the data buffer.
21103 Here's a BNF definition of such a buffer:
21107 head = error / valid-head
21108 error-message = [ "4" / "5" ] 2number " " <error message> eol
21109 valid-head = valid-message *header "." eol
21110 valid-message = "221 " <number> " Article retrieved." eol
21111 header = <text> eol
21114 If the return value is @code{nov}, the data buffer should contain
21115 @dfn{network overview database} lines. These are basically fields
21119 nov-buffer = *nov-line
21120 nov-line = 8*9 [ field <TAB> ] eol
21121 field = <text except TAB>
21124 For a closer look at what should be in those fields,
21128 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
21130 @var{server} is here the virtual server name. @var{definitions} is a
21131 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
21133 If the server can't be opened, no error should be signaled. The backend
21134 may then choose to refuse further attempts at connecting to this
21135 server. In fact, it should do so.
21137 If the server is opened already, this function should return a
21138 non-@code{nil} value. There should be no data returned.
21141 @item (nnchoke-close-server &optional SERVER)
21143 Close connection to @var{server} and free all resources connected
21144 to it. Return @code{nil} if the server couldn't be closed for some
21147 There should be no data returned.
21150 @item (nnchoke-request-close)
21152 Close connection to all servers and free all resources that the backend
21153 have reserved. All buffers that have been created by that backend
21154 should be killed. (Not the @code{nntp-server-buffer}, though.) This
21155 function is generally only called when Gnus is shutting down.
21157 There should be no data returned.
21160 @item (nnchoke-server-opened &optional SERVER)
21162 If @var{server} is the current virtual server, and the connection to the
21163 physical server is alive, then this function should return a
21164 non-@code{nil} vlue. This function should under no circumstances
21165 attempt to reconnect to a server we have lost connection to.
21167 There should be no data returned.
21170 @item (nnchoke-status-message &optional SERVER)
21172 This function should return the last error message from @var{server}.
21174 There should be no data returned.
21177 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
21179 The result data from this function should be the article specified by
21180 @var{article}. This might either be a @code{Message-ID} or a number.
21181 It is optional whether to implement retrieval by @code{Message-ID}, but
21182 it would be nice if that were possible.
21184 If @var{to-buffer} is non-@code{nil}, the result data should be returned
21185 in this buffer instead of the normal data buffer. This is to make it
21186 possible to avoid copying large amounts of data from one buffer to
21187 another, while Gnus mainly requests articles to be inserted directly
21188 into its article buffer.
21190 If it is at all possible, this function should return a cons cell where
21191 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
21192 the article number. This will enable Gnus to find out what the real
21193 group and article numbers are when fetching articles by
21194 @code{Message-ID}. If this isn't possible, @code{t} should be returned
21195 on successful article retrieval.
21198 @item (nnchoke-request-group GROUP &optional SERVER FAST)
21200 Get data on @var{group}. This function also has the side effect of
21201 making @var{group} the current group.
21203 If @var{fast}, don't bother to return useful data, just make @var{group}
21206 Here's an example of some result data and a definition of the same:
21209 211 56 1000 1059 ifi.discussion
21212 The first number is the status, which should be 211. Next is the
21213 total number of articles in the group, the lowest article number, the
21214 highest article number, and finally the group name. Note that the total
21215 number of articles may be less than one might think while just
21216 considering the highest and lowest article numbers, but some articles
21217 may have been canceled. Gnus just discards the total-number, so
21218 whether one should take the bother to generate it properly (if that is a
21219 problem) is left as an exercise to the reader.
21222 group-status = [ error / info ] eol
21223 error = [ "4" / "5" ] 2<number> " " <Error message>
21224 info = "211 " 3* [ <number> " " ] <string>
21228 @item (nnchoke-close-group GROUP &optional SERVER)
21230 Close @var{group} and free any resources connected to it. This will be
21231 a no-op on most backends.
21233 There should be no data returned.
21236 @item (nnchoke-request-list &optional SERVER)
21238 Return a list of all groups available on @var{server}. And that means
21241 Here's an example from a server that only carries two groups:
21244 ifi.test 0000002200 0000002000 y
21245 ifi.discussion 3324 3300 n
21248 On each line we have a group name, then the highest article number in
21249 that group, the lowest article number, and finally a flag.
21252 active-file = *active-line
21253 active-line = name " " <number> " " <number> " " flags eol
21255 flags = "n" / "y" / "m" / "x" / "j" / "=" name
21258 The flag says whether the group is read-only (@samp{n}), is moderated
21259 (@samp{m}), is dead (@samp{x}), is aliased to some other group
21260 (@samp{=other-group}) or none of the above (@samp{y}).
21263 @item (nnchoke-request-post &optional SERVER)
21265 This function should post the current buffer. It might return whether
21266 the posting was successful or not, but that's not required. If, for
21267 instance, the posting is done asynchronously, it has generally not been
21268 completed by the time this function concludes. In that case, this
21269 function should set up some kind of sentinel to beep the user loud and
21270 clear if the posting could not be completed.
21272 There should be no result data from this function.
21277 @node Optional Backend Functions
21278 @subsubsection Optional Backend Functions
21282 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
21284 @var{groups} is a list of groups, and this function should request data
21285 on all those groups. How it does it is of no concern to Gnus, but it
21286 should attempt to do this in a speedy fashion.
21288 The return value of this function can be either @code{active} or
21289 @code{group}, which says what the format of the result data is. The
21290 former is in the same format as the data from
21291 @code{nnchoke-request-list}, while the latter is a buffer full of lines
21292 in the same format as @code{nnchoke-request-group} gives.
21295 group-buffer = *active-line / *group-status
21299 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
21301 A Gnus group info (@pxref{Group Info}) is handed to the backend for
21302 alterations. This comes in handy if the backend really carries all the
21303 information (as is the case with virtual and imap groups). This
21304 function should destructively alter the info to suit its needs, and
21305 should return the (altered) group info.
21307 There should be no result data from this function.
21310 @item (nnchoke-request-type GROUP &optional ARTICLE)
21312 When the user issues commands for ``sending news'' (@kbd{F} in the
21313 summary buffer, for instance), Gnus has to know whether the article the
21314 user is following up on is news or mail. This function should return
21315 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
21316 is mail and @code{unknown} if the type can't be decided. (The
21317 @var{article} parameter is necessary in @code{nnvirtual} groups which
21318 might very well combine mail groups and news groups.) Both @var{group}
21319 and @var{article} may be @code{nil}.
21321 There should be no result data from this function.
21324 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
21326 Set/remove/add marks on articles. Normally Gnus handles the article
21327 marks (such as read, ticked, expired etc) internally, and store them in
21328 @code{~/.newsrc.eld}. Some backends (such as @sc{imap}) however carry
21329 all information about the articles on the server, so Gnus need to
21330 propagate the mark information to the server.
21332 ACTION is a list of mark setting requests, having this format:
21335 (RANGE ACTION MARK)
21338 RANGE is a range of articles you wish to update marks on. ACTION is
21339 @code{set}, @code{add} or @code{del}, respectively used for removing all
21340 existing marks and setting them as specified, adding (preserving the
21341 marks not mentioned) mark and removing (preserving the marks not
21342 mentioned) marks. MARK is a list of marks; where each mark is a symbol.
21343 Currently used marks are @code{read}, @code{tick}, @code{reply},
21344 @code{expire}, @code{killed}, @code{dormant}, @code{save},
21345 @code{download} and @code{unsend}, but your backend should, if possible,
21346 not limit itself to these.
21348 Given contradictory actions, the last action in the list should be the
21349 effective one. That is, if your action contains a request to add the
21350 @code{tick} mark on article 1 and, later in the list, a request to
21351 remove the mark on the same article, the mark should in fact be removed.
21353 An example action list:
21356 (((5 12 30) 'del '(tick))
21357 ((10 . 90) 'add '(read expire))
21358 ((92 94) 'del '(read)))
21361 The function should return a range of articles it wasn't able to set the
21362 mark on (currently not used for anything).
21364 There should be no result data from this function.
21366 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
21368 If the user tries to set a mark that the backend doesn't like, this
21369 function may change the mark. Gnus will use whatever this function
21370 returns as the mark for @var{article} instead of the original
21371 @var{mark}. If the backend doesn't care, it must return the original
21372 @var{mark}, and not @code{nil} or any other type of garbage.
21374 The only use for this I can see is what @code{nnvirtual} does with
21375 it---if a component group is auto-expirable, marking an article as read
21376 in the virtual group should result in the article being marked as
21379 There should be no result data from this function.
21382 @item (nnchoke-request-scan &optional GROUP SERVER)
21384 This function may be called at any time (by Gnus or anything else) to
21385 request that the backend check for incoming articles, in one way or
21386 another. A mail backend will typically read the spool file or query the
21387 POP server when this function is invoked. The @var{group} doesn't have
21388 to be heeded---if the backend decides that it is too much work just
21389 scanning for a single group, it may do a total scan of all groups. It
21390 would be nice, however, to keep things local if that's practical.
21392 There should be no result data from this function.
21395 @item (nnchoke-request-group-description GROUP &optional SERVER)
21397 The result data from this function should be a description of
21401 description-line = name <TAB> description eol
21403 description = <text>
21406 @item (nnchoke-request-list-newsgroups &optional SERVER)
21408 The result data from this function should be the description of all
21409 groups available on the server.
21412 description-buffer = *description-line
21416 @item (nnchoke-request-newgroups DATE &optional SERVER)
21418 The result data from this function should be all groups that were
21419 created after @samp{date}, which is in normal human-readable date
21420 format. The data should be in the active buffer format.
21423 @item (nnchoke-request-create-group GROUP &optional SERVER)
21425 This function should create an empty group with name @var{group}.
21427 There should be no return data.
21430 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
21432 This function should run the expiry process on all articles in the
21433 @var{articles} range (which is currently a simple list of article
21434 numbers.) It is left up to the backend to decide how old articles
21435 should be before they are removed by this function. If @var{force} is
21436 non-@code{nil}, all @var{articles} should be deleted, no matter how new
21439 This function should return a list of articles that it did not/was not
21442 There should be no result data returned.
21445 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
21448 This function should move @var{article} (which is a number) from
21449 @var{group} by calling @var{accept-form}.
21451 This function should ready the article in question for moving by
21452 removing any header lines it has added to the article, and generally
21453 should ``tidy up'' the article. Then it should @code{eval}
21454 @var{accept-form} in the buffer where the ``tidy'' article is. This
21455 will do the actual copying. If this @code{eval} returns a
21456 non-@code{nil} value, the article should be removed.
21458 If @var{last} is @code{nil}, that means that there is a high likelihood
21459 that there will be more requests issued shortly, so that allows some
21462 The function should return a cons where the @code{car} is the group name and
21463 the @code{cdr} is the article number that the article was entered as.
21465 There should be no data returned.
21468 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
21470 This function takes the current buffer and inserts it into @var{group}.
21471 If @var{last} in @code{nil}, that means that there will be more calls to
21472 this function in short order.
21474 The function should return a cons where the @code{car} is the group name and
21475 the @code{cdr} is the article number that the article was entered as.
21477 There should be no data returned.
21480 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
21482 This function should remove @var{article} (which is a number) from
21483 @var{group} and insert @var{buffer} there instead.
21485 There should be no data returned.
21488 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
21490 This function should delete @var{group}. If @var{force}, it should
21491 really delete all the articles in the group, and then delete the group
21492 itself. (If there is such a thing as ``the group itself''.)
21494 There should be no data returned.
21497 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
21499 This function should rename @var{group} into @var{new-name}. All
21500 articles in @var{group} should move to @var{new-name}.
21502 There should be no data returned.
21507 @node Error Messaging
21508 @subsubsection Error Messaging
21510 @findex nnheader-report
21511 @findex nnheader-get-report
21512 The backends should use the function @code{nnheader-report} to report
21513 error conditions---they should not raise errors when they aren't able to
21514 perform a request. The first argument to this function is the backend
21515 symbol, and the rest are interpreted as arguments to @code{format} if
21516 there are multiple of them, or just a string if there is one of them.
21517 This function must always returns @code{nil}.
21520 (nnheader-report 'nnchoke "You did something totally bogus")
21522 (nnheader-report 'nnchoke "Could not request group %s" group)
21525 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
21526 @code{nil} back from a server, and this function returns the most
21527 recently reported message for the backend in question. This function
21528 takes one argument---the server symbol.
21530 Internally, these functions access @var{backend}@code{-status-string},
21531 so the @code{nnchoke} backend will have its error message stored in
21532 @code{nnchoke-status-string}.
21535 @node Writing New Backends
21536 @subsubsection Writing New Backends
21538 Many backends are quite similar. @code{nnml} is just like
21539 @code{nnspool}, but it allows you to edit the articles on the server.
21540 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
21541 and it doesn't maintain overview databases. @code{nndir} is just like
21542 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
21545 It would make sense if it were possible to ``inherit'' functions from
21546 backends when writing new backends. And, indeed, you can do that if you
21547 want to. (You don't have to if you don't want to, of course.)
21549 All the backends declare their public variables and functions by using a
21550 package called @code{nnoo}.
21552 To inherit functions from other backends (and allow other backends to
21553 inherit functions from the current backend), you should use the
21559 This macro declares the first parameter to be a child of the subsequent
21560 parameters. For instance:
21563 (nnoo-declare nndir
21567 @code{nndir} has declared here that it intends to inherit functions from
21568 both @code{nnml} and @code{nnmh}.
21571 This macro is equivalent to @code{defvar}, but registers the variable as
21572 a public server variable. Most state-oriented variables should be
21573 declared with @code{defvoo} instead of @code{defvar}.
21575 In addition to the normal @code{defvar} parameters, it takes a list of
21576 variables in the parent backends to map the variable to when executing
21577 a function in those backends.
21580 (defvoo nndir-directory nil
21581 "Where nndir will look for groups."
21582 nnml-current-directory nnmh-current-directory)
21585 This means that @code{nnml-current-directory} will be set to
21586 @code{nndir-directory} when an @code{nnml} function is called on behalf
21587 of @code{nndir}. (The same with @code{nnmh}.)
21589 @item nnoo-define-basics
21590 This macro defines some common functions that almost all backends should
21594 (nnoo-define-basics nndir)
21598 This macro is just like @code{defun} and takes the same parameters. In
21599 addition to doing the normal @code{defun} things, it registers the
21600 function as being public so that other backends can inherit it.
21602 @item nnoo-map-functions
21603 This macro allows mapping of functions from the current backend to
21604 functions from the parent backends.
21607 (nnoo-map-functions nndir
21608 (nnml-retrieve-headers 0 nndir-current-group 0 0)
21609 (nnmh-request-article 0 nndir-current-group 0 0))
21612 This means that when @code{nndir-retrieve-headers} is called, the first,
21613 third, and fourth parameters will be passed on to
21614 @code{nnml-retrieve-headers}, while the second parameter is set to the
21615 value of @code{nndir-current-group}.
21618 This macro allows importing functions from backends. It should be the
21619 last thing in the source file, since it will only define functions that
21620 haven't already been defined.
21626 nnmh-request-newgroups)
21630 This means that calls to @code{nndir-request-list} should just be passed
21631 on to @code{nnmh-request-list}, while all public functions from
21632 @code{nnml} that haven't been defined in @code{nndir} yet should be
21637 Below is a slightly shortened version of the @code{nndir} backend.
21640 ;;; nndir.el --- single directory newsgroup access for Gnus
21641 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
21645 (require 'nnheader)
21649 (eval-when-compile (require 'cl))
21651 (nnoo-declare nndir
21654 (defvoo nndir-directory nil
21655 "Where nndir will look for groups."
21656 nnml-current-directory nnmh-current-directory)
21658 (defvoo nndir-nov-is-evil nil
21659 "*Non-nil means that nndir will never retrieve NOV headers."
21662 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
21663 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
21664 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
21666 (defvoo nndir-status-string "" nil nnmh-status-string)
21667 (defconst nndir-version "nndir 1.0")
21669 ;;; Interface functions.
21671 (nnoo-define-basics nndir)
21673 (deffoo nndir-open-server (server &optional defs)
21674 (setq nndir-directory
21675 (or (cadr (assq 'nndir-directory defs))
21677 (unless (assq 'nndir-directory defs)
21678 (push `(nndir-directory ,server) defs))
21679 (push `(nndir-current-group
21680 ,(file-name-nondirectory (directory-file-name nndir-directory)))
21682 (push `(nndir-top-directory
21683 ,(file-name-directory (directory-file-name nndir-directory)))
21685 (nnoo-change-server 'nndir server defs))
21687 (nnoo-map-functions nndir
21688 (nnml-retrieve-headers 0 nndir-current-group 0 0)
21689 (nnmh-request-article 0 nndir-current-group 0 0)
21690 (nnmh-request-group nndir-current-group 0 0)
21691 (nnmh-close-group nndir-current-group 0))
21695 nnmh-status-message
21697 nnmh-request-newgroups))
21703 @node Hooking New Backends Into Gnus
21704 @subsubsection Hooking New Backends Into Gnus
21706 @vindex gnus-valid-select-methods
21707 Having Gnus start using your new backend is rather easy---you just
21708 declare it with the @code{gnus-declare-backend} functions. This will
21709 enter the backend into the @code{gnus-valid-select-methods} variable.
21711 @code{gnus-declare-backend} takes two parameters---the backend name and
21712 an arbitrary number of @dfn{abilities}.
21717 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
21720 The abilities can be:
21724 This is a mailish backend---followups should (probably) go via mail.
21726 This is a newsish backend---followups should (probably) go via news.
21728 This backend supports both mail and news.
21730 This is neither a post nor mail backend---it's something completely
21733 It supports respooling---or rather, it is able to modify its source
21734 articles and groups.
21736 The name of the server should be in the virtual server name. This is
21737 true for almost all backends.
21738 @item prompt-address
21739 The user should be prompted for an address when doing commands like
21740 @kbd{B} in the group buffer. This is true for backends like
21741 @code{nntp}, but not @code{nnmbox}, for instance.
21745 @node Mail-like Backends
21746 @subsubsection Mail-like Backends
21748 One of the things that separate the mail backends from the rest of the
21749 backends is the heavy dependence by the mail backends on common
21750 functions in @file{nnmail.el}. For instance, here's the definition of
21751 @code{nnml-request-scan}:
21754 (deffoo nnml-request-scan (&optional group server)
21755 (setq nnml-article-file-alist nil)
21756 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
21759 It simply calls @code{nnmail-get-new-mail} with a few parameters,
21760 and @code{nnmail} takes care of all the moving and splitting of the
21763 This function takes four parameters.
21767 This should be a symbol to designate which backend is responsible for
21770 @item exit-function
21771 This function should be called after the splitting has been performed.
21773 @item temp-directory
21774 Where the temporary files should be stored.
21777 This optional argument should be a group name if the splitting is to be
21778 performed for one group only.
21781 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
21782 save each article. @var{backend}@code{-active-number} will be called to
21783 find the article number assigned to this article.
21785 The function also uses the following variables:
21786 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
21787 this backend); and @var{backend}@code{-group-alist} and
21788 @var{backend}@code{-active-file} to generate the new active file.
21789 @var{backend}@code{-group-alist} should be a group-active alist, like
21793 (("a-group" (1 . 10))
21794 ("some-group" (34 . 39)))
21798 @node Score File Syntax
21799 @subsection Score File Syntax
21801 Score files are meant to be easily parseable, but yet extremely
21802 mallable. It was decided that something that had the same read syntax
21803 as an Emacs Lisp list would fit that spec.
21805 Here's a typical score file:
21809 ("win95" -10000 nil s)
21816 BNF definition of a score file:
21819 score-file = "" / "(" *element ")"
21820 element = rule / atom
21821 rule = string-rule / number-rule / date-rule
21822 string-rule = "(" quote string-header quote space *string-match ")"
21823 number-rule = "(" quote number-header quote space *number-match ")"
21824 date-rule = "(" quote date-header quote space *date-match ")"
21826 string-header = "subject" / "from" / "references" / "message-id" /
21827 "xref" / "body" / "head" / "all" / "followup"
21828 number-header = "lines" / "chars"
21829 date-header = "date"
21830 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
21831 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
21832 score = "nil" / <integer>
21833 date = "nil" / <natural number>
21834 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
21835 "r" / "regex" / "R" / "Regex" /
21836 "e" / "exact" / "E" / "Exact" /
21837 "f" / "fuzzy" / "F" / "Fuzzy"
21838 number-match = "(" <integer> [ "" / [ space score [ "" /
21839 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
21840 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
21841 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
21842 space date [ "" / [ space date-match-t ] ] ] ] ")"
21843 date-match-t = "nil" / "at" / "before" / "after"
21844 atom = "(" [ required-atom / optional-atom ] ")"
21845 required-atom = mark / expunge / mark-and-expunge / files /
21846 exclude-files / read-only / touched
21847 optional-atom = adapt / local / eval
21848 mark = "mark" space nil-or-number
21849 nil-or-number = "nil" / <integer>
21850 expunge = "expunge" space nil-or-number
21851 mark-and-expunge = "mark-and-expunge" space nil-or-number
21852 files = "files" *[ space <string> ]
21853 exclude-files = "exclude-files" *[ space <string> ]
21854 read-only = "read-only" [ space "nil" / space "t" ]
21855 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
21856 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
21857 local = "local" *[ space "(" <string> space <form> ")" ]
21858 eval = "eval" space <form>
21859 space = *[ " " / <TAB> / <NEWLINE> ]
21862 Any unrecognized elements in a score file should be ignored, but not
21865 As you can see, white space is needed, but the type and amount of white
21866 space is irrelevant. This means that formatting of the score file is
21867 left up to the programmer---if it's simpler to just spew it all out on
21868 one looong line, then that's ok.
21870 The meaning of the various atoms are explained elsewhere in this
21871 manual (@pxref{Score File Format}).
21875 @subsection Headers
21877 Internally Gnus uses a format for storing article headers that
21878 corresponds to the @sc{nov} format in a mysterious fashion. One could
21879 almost suspect that the author looked at the @sc{nov} specification and
21880 just shamelessly @emph{stole} the entire thing, and one would be right.
21882 @dfn{Header} is a severely overloaded term. ``Header'' is used in
21883 RFC 1036 to talk about lines in the head of an article (e.g.,
21884 @code{From}). It is used by many people as a synonym for
21885 ``head''---``the header and the body''. (That should be avoided, in my
21886 opinion.) And Gnus uses a format internally that it calls ``header'',
21887 which is what I'm talking about here. This is a 9-element vector,
21888 basically, with each header (ouch) having one slot.
21890 These slots are, in order: @code{number}, @code{subject}, @code{from},
21891 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
21892 @code{xref}, and @code{extra}. There are macros for accessing and
21893 setting these slots---they all have predictable names beginning with
21894 @code{mail-header-} and @code{mail-header-set-}, respectively.
21896 All these slots contain strings, except the @code{extra} slot, which
21897 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
21903 @sc{gnus} introduced a concept that I found so useful that I've started
21904 using it a lot and have elaborated on it greatly.
21906 The question is simple: If you have a large amount of objects that are
21907 identified by numbers (say, articles, to take a @emph{wild} example)
21908 that you want to qualify as being ``included'', a normal sequence isn't
21909 very useful. (A 200,000 length sequence is a bit long-winded.)
21911 The solution is as simple as the question: You just collapse the
21915 (1 2 3 4 5 6 10 11 12)
21918 is transformed into
21921 ((1 . 6) (10 . 12))
21924 To avoid having those nasty @samp{(13 . 13)} elements to denote a
21925 lonesome object, a @samp{13} is a valid element:
21928 ((1 . 6) 7 (10 . 12))
21931 This means that comparing two ranges to find out whether they are equal
21932 is slightly tricky:
21935 ((1 . 5) 7 8 (10 . 12))
21941 ((1 . 5) (7 . 8) (10 . 12))
21944 are equal. In fact, any non-descending list is a range:
21950 is a perfectly valid range, although a pretty long-winded one. This is
21957 and is equal to the previous range.
21959 Here's a BNF definition of ranges. Of course, one must remember the
21960 semantic requirement that the numbers are non-descending. (Any number
21961 of repetition of the same number is allowed, but apt to disappear in
21965 range = simple-range / normal-range
21966 simple-range = "(" number " . " number ")"
21967 normal-range = "(" start-contents ")"
21968 contents = "" / simple-range *[ " " contents ] /
21969 number *[ " " contents ]
21972 Gnus currently uses ranges to keep track of read articles and article
21973 marks. I plan on implementing a number of range operators in C if The
21974 Powers That Be are willing to let me. (I haven't asked yet, because I
21975 need to do some more thinking on what operators I need to make life
21976 totally range-based without ever having to convert back to normal
21981 @subsection Group Info
21983 Gnus stores all permanent info on groups in a @dfn{group info} list.
21984 This list is from three to six elements (or more) long and exhaustively
21985 describes the group.
21987 Here are two example group infos; one is a very simple group while the
21988 second is a more complex one:
21991 ("no.group" 5 ((1 . 54324)))
21993 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
21994 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
21996 ((auto-expire . t) (to-address . "ding@@gnus.org")))
21999 The first element is the @dfn{group name}---as Gnus knows the group,
22000 anyway. The second element is the @dfn{subscription level}, which
22001 normally is a small integer. (It can also be the @dfn{rank}, which is a
22002 cons cell where the @code{car} is the level and the @code{cdr} is the
22003 score.) The third element is a list of ranges of read articles. The
22004 fourth element is a list of lists of article marks of various kinds.
22005 The fifth element is the select method (or virtual server, if you like).
22006 The sixth element is a list of @dfn{group parameters}, which is what
22007 this section is about.
22009 Any of the last three elements may be missing if they are not required.
22010 In fact, the vast majority of groups will normally only have the first
22011 three elements, which saves quite a lot of cons cells.
22013 Here's a BNF definition of the group info format:
22016 info = "(" group space ralevel space read
22017 [ "" / [ space marks-list [ "" / [ space method [ "" /
22018 space parameters ] ] ] ] ] ")"
22019 group = quote <string> quote
22020 ralevel = rank / level
22021 level = <integer in the range of 1 to inf>
22022 rank = "(" level "." score ")"
22023 score = <integer in the range of 1 to inf>
22025 marks-lists = nil / "(" *marks ")"
22026 marks = "(" <string> range ")"
22027 method = "(" <string> *elisp-forms ")"
22028 parameters = "(" *elisp-forms ")"
22031 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
22032 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
22035 If you have a Gnus info and want to access the elements, Gnus offers a
22036 series of macros for getting/setting these elements.
22039 @item gnus-info-group
22040 @itemx gnus-info-set-group
22041 @findex gnus-info-group
22042 @findex gnus-info-set-group
22043 Get/set the group name.
22045 @item gnus-info-rank
22046 @itemx gnus-info-set-rank
22047 @findex gnus-info-rank
22048 @findex gnus-info-set-rank
22049 Get/set the group rank (@pxref{Group Score}).
22051 @item gnus-info-level
22052 @itemx gnus-info-set-level
22053 @findex gnus-info-level
22054 @findex gnus-info-set-level
22055 Get/set the group level.
22057 @item gnus-info-score
22058 @itemx gnus-info-set-score
22059 @findex gnus-info-score
22060 @findex gnus-info-set-score
22061 Get/set the group score (@pxref{Group Score}).
22063 @item gnus-info-read
22064 @itemx gnus-info-set-read
22065 @findex gnus-info-read
22066 @findex gnus-info-set-read
22067 Get/set the ranges of read articles.
22069 @item gnus-info-marks
22070 @itemx gnus-info-set-marks
22071 @findex gnus-info-marks
22072 @findex gnus-info-set-marks
22073 Get/set the lists of ranges of marked articles.
22075 @item gnus-info-method
22076 @itemx gnus-info-set-method
22077 @findex gnus-info-method
22078 @findex gnus-info-set-method
22079 Get/set the group select method.
22081 @item gnus-info-params
22082 @itemx gnus-info-set-params
22083 @findex gnus-info-params
22084 @findex gnus-info-set-params
22085 Get/set the group parameters.
22088 All the getter functions take one parameter---the info list. The setter
22089 functions take two parameters---the info list and the new value.
22091 The last three elements in the group info aren't mandatory, so it may be
22092 necessary to extend the group info before setting the element. If this
22093 is necessary, you can just pass on a non-@code{nil} third parameter to
22094 the three final setter functions to have this happen automatically.
22097 @node Extended Interactive
22098 @subsection Extended Interactive
22099 @cindex interactive
22100 @findex gnus-interactive
22102 Gnus extends the standard Emacs @code{interactive} specification
22103 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
22104 Prefixes}). Here's an example of how this is used:
22107 (defun gnus-summary-increase-score (&optional score symp)
22108 (interactive (gnus-interactive "P\ny"))
22113 The best thing to do would have been to implement
22114 @code{gnus-interactive} as a macro which would have returned an
22115 @code{interactive} form, but this isn't possible since Emacs checks
22116 whether a function is interactive or not by simply doing an @code{assq}
22117 on the lambda form. So, instead we have @code{gnus-interactive}
22118 function that takes a string and returns values that are usable to
22119 @code{interactive}.
22121 This function accepts (almost) all normal @code{interactive} specs, but
22126 @vindex gnus-current-prefix-symbol
22127 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
22131 @vindex gnus-current-prefix-symbols
22132 A list of the current symbolic prefixes---the
22133 @code{gnus-current-prefix-symbol} variable.
22136 The current article number---the @code{gnus-summary-article-number}
22140 The current article header---the @code{gnus-summary-article-header}
22144 The current group name---the @code{gnus-group-group-name}
22150 @node Emacs/XEmacs Code
22151 @subsection Emacs/XEmacs Code
22155 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
22156 platforms must be the primary one. I chose Emacs. Not because I don't
22157 like XEmacs or Mule, but because it comes first alphabetically.
22159 This means that Gnus will byte-compile under Emacs with nary a warning,
22160 while XEmacs will pump out gigabytes of warnings while byte-compiling.
22161 As I use byte-compilation warnings to help me root out trivial errors in
22162 Gnus, that's very useful.
22164 I've also consistently used Emacs function interfaces, but have used
22165 Gnusey aliases for the functions. To take an example: Emacs defines a
22166 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
22167 function. I then define a function called @code{gnus-run-at-time} that
22168 takes the same parameters as the Emacs @code{run-at-time}. When running
22169 Gnus under Emacs, the former function is just an alias for the latter.
22170 However, when running under XEmacs, the former is an alias for the
22171 following function:
22174 (defun gnus-xmas-run-at-time (time repeat function &rest args)
22178 (,function ,@@args))
22182 This sort of thing has been done for bunches of functions. Gnus does
22183 not redefine any native Emacs functions while running under XEmacs---it
22184 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
22187 In the cases where the XEmacs function interface was obviously cleaner,
22188 I used it instead. For example @code{gnus-region-active-p} is an alias
22189 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
22191 Of course, I could have chosen XEmacs as my native platform and done
22192 mapping functions the other way around. But I didn't. The performance
22193 hit these indirections impose on Gnus under XEmacs should be slight.
22196 @node Various File Formats
22197 @subsection Various File Formats
22200 * Active File Format:: Information on articles and groups available.
22201 * Newsgroups File Format:: Group descriptions.
22205 @node Active File Format
22206 @subsubsection Active File Format
22208 The active file lists all groups available on the server in
22209 question. It also lists the highest and lowest current article numbers
22212 Here's an excerpt from a typical active file:
22215 soc.motss 296030 293865 y
22216 alt.binaries.pictures.fractals 3922 3913 n
22217 comp.sources.unix 1605 1593 m
22218 comp.binaries.ibm.pc 5097 5089 y
22219 no.general 1000 900 y
22222 Here's a pseudo-BNF definition of this file:
22225 active = *group-line
22226 group-line = group space high-number space low-number space flag <NEWLINE>
22227 group = <non-white-space string>
22229 high-number = <non-negative integer>
22230 low-number = <positive integer>
22231 flag = "y" / "n" / "m" / "j" / "x" / "=" group
22234 For a full description of this file, see the manual pages for
22235 @samp{innd}, in particular @samp{active(5)}.
22238 @node Newsgroups File Format
22239 @subsubsection Newsgroups File Format
22241 The newsgroups file lists groups along with their descriptions. Not all
22242 groups on the server have to be listed, and not all groups in the file
22243 have to exist on the server. The file is meant purely as information to
22246 The format is quite simple; a group name, a tab, and the description.
22247 Here's the definition:
22251 line = group tab description <NEWLINE>
22252 group = <non-white-space string>
22254 description = <string>
22259 @node Emacs for Heathens
22260 @section Emacs for Heathens
22262 Believe it or not, but some people who use Gnus haven't really used
22263 Emacs much before they embarked on their journey on the Gnus Love Boat.
22264 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
22265 region'', and ``set @code{gnus-flargblossen} to an alist where the key
22266 is a regexp that is used for matching on the group name'' are magical
22267 phrases with little or no meaning, then this appendix is for you. If
22268 you are already familiar with Emacs, just ignore this and go fondle your
22272 * Keystrokes:: Entering text and executing commands.
22273 * Emacs Lisp:: The built-in Emacs programming language.
22278 @subsection Keystrokes
22282 Q: What is an experienced Emacs user?
22285 A: A person who wishes that the terminal had pedals.
22288 Yes, when you use Emacs, you are apt to use the control key, the shift
22289 key and the meta key a lot. This is very annoying to some people
22290 (notably @code{vi}le users), and the rest of us just love the hell out
22291 of it. Just give up and submit. Emacs really does stand for
22292 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
22293 may have heard from other disreputable sources (like the Emacs author).
22295 The shift keys are normally located near your pinky fingers, and are
22296 normally used to get capital letters and stuff. You probably use it all
22297 the time. The control key is normally marked ``CTRL'' or something like
22298 that. The meta key is, funnily enough, never marked as such on any
22299 keyboard. The one I'm currently at has a key that's marked ``Alt'',
22300 which is the meta key on this keyboard. It's usually located somewhere
22301 to the left hand side of the keyboard, usually on the bottom row.
22303 Now, us Emacs people don't say ``press the meta-control-m key'',
22304 because that's just too inconvenient. We say ``press the @kbd{M-C-m}
22305 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
22306 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
22307 down the control key, and hold it down while you press @kbd{k}''.
22308 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
22309 the control key and then press @kbd{k}''. Simple, ay?
22311 This is somewhat complicated by the fact that not all keyboards have a
22312 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
22313 means ``press escape, release escape, press @kbd{k}''. That's much more
22314 work than if you have a meta key, so if that's the case, I respectfully
22315 suggest you get a real keyboard with a meta key. You can't live without
22321 @subsection Emacs Lisp
22323 Emacs is the King of Editors because it's really a Lisp interpreter.
22324 Each and every key you tap runs some Emacs Lisp code snippet, and since
22325 Emacs Lisp is an interpreted language, that means that you can configure
22326 any key to run any arbitrary code. You just, like, do it.
22328 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
22329 functions. (These are byte-compiled for speed, but it's still
22330 interpreted.) If you decide that you don't like the way Gnus does
22331 certain things, it's trivial to have it do something a different way.
22332 (Well, at least if you know how to write Lisp code.) However, that's
22333 beyond the scope of this manual, so we are simply going to talk about
22334 some common constructs that you normally use in your @file{.emacs} file
22337 If you want to set the variable @code{gnus-florgbnize} to four (4), you
22338 write the following:
22341 (setq gnus-florgbnize 4)
22344 This function (really ``special form'') @code{setq} is the one that can
22345 set a variable to some value. This is really all you need to know. Now
22346 you can go and fill your @code{.emacs} file with lots of these to change
22349 If you have put that thing in your @code{.emacs} file, it will be read
22350 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
22351 start Emacs. If you want to change the variable right away, simply say
22352 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
22353 previous ``form'', which is a simple @code{setq} statement here.
22355 Go ahead---just try it, if you're located at your Emacs. After you
22356 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
22357 is the return value of the form you @code{eval}ed.
22361 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
22365 (setq gnus-read-active-file 'some)
22368 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
22369 @samp{nntp.ifi.uio.no}'', that means:
22372 (setq gnus-nntp-server "nntp.ifi.uio.no")
22375 So be careful not to mix up strings (the latter) with symbols (the
22376 former). The manual is unambiguous, but it can be confusing.
22379 @include gnus-faq.texi
22400 % LocalWords: Backend BNF mucho Backends backends detailmenu cindex kindex kbd
22401 % LocalWords: findex Gnusae vindex dfn dfn samp nntp setq nnspool nntpserver
22402 % LocalWords: nnmbox backend newusers Blllrph NEWGROUPS dingnusdingnusdingnus
22403 % LocalWords: pre fab rec comp nnslashdot regex ga ga sci nnml nnbabyl nnmh
22404 % LocalWords: nnfolder emph looong eld newsreaders defun init elc pxref