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,96,97,98,99,2000 Free Software Foundation, Inc.
278 Permission is granted to copy, distribute and/or modify this document
279 under the terms of the GNU Free Documentation License, Version 1.1 or
280 any later version published by the Free Software Foundation; with the
281 Invariant Sections being none, with the Front-Cover texts being ``A GNU
282 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
283 license is included in the section entitled ``GNU Free Documentation
286 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
287 this GNU Manual, like GNU software. Copies published by the Free
288 Software Foundation raise funds for GNU development.''
296 This file documents Gnus, the GNU Emacs newsreader.
298 Copyright (C) 1995,96,97,98,99,2000 Free Software Foundation, Inc.
300 Permission is granted to copy, distribute and/or modify this document
301 under the terms of the GNU Free Documentation License, Version 1.1 or
302 any later version published by the Free Software Foundation; with the
303 Invariant Sections being none, with the Front-Cover texts being ``A GNU
304 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
305 license is included in the section entitled ``GNU Free Documentation
308 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
309 this GNU Manual, like GNU software. Copies published by the Free
310 Software Foundation raise funds for GNU development.''
318 @author by Lars Magne Ingebrigtsen
321 @vskip 0pt plus 1filll
322 Copyright @copyright{} 1995,96,97,98,99,2000 Free Software Foundation, Inc.
324 Permission is granted to make and distribute verbatim copies of
325 this manual provided the copyright notice and this permission notice
326 are preserved on all copies.
328 Permission is granted to copy and distribute modified versions of this
329 manual under the conditions for verbatim copying, provided that the
330 entire resulting derived work is distributed under the terms of a
331 permission notice identical to this one.
333 Permission is granted to copy and distribute translations of this manual
334 into another language, under the above conditions for modified versions.
343 @top The Gnus Newsreader
347 You can read news (and mail) from within Emacs by using Gnus. The news
348 can be gotten by any nefarious means you can think of---@sc{nntp}, local
349 spool or your mbox file. All at the same time, if you want to push your
352 This manual corresponds to Gnus 5.8.7.
363 Gnus is the advanced, self-documenting, customizable, extensible
364 unreal-time newsreader for GNU Emacs.
366 Oops. That sounds oddly familiar, so let's start over again to avoid
367 being accused of plagiarism:
369 Gnus is a message-reading laboratory. It will let you look at just
370 about anything as if it were a newsgroup. You can read mail with it,
371 you can browse directories with it, you can @code{ftp} with it---you
372 can even read news with it!
374 Gnus tries to empower people who read news the same way Emacs empowers
375 people who edit text. Gnus sets no limits to what the user should be
376 allowed to do. Users are encouraged to extend Gnus to make it behave
377 like they want it to behave. A program should not control people;
378 people should be empowered to do what they want by using (or abusing)
384 * Starting Up:: Finding news can be a pain.
385 * The Group Buffer:: Selecting, subscribing and killing groups.
386 * The Summary Buffer:: Reading, saving and posting articles.
387 * The Article Buffer:: Displaying and handling articles.
388 * Composing Messages:: Information on sending mail and news.
389 * Select Methods:: Gnus reads all messages from various select methods.
390 * Scoring:: Assigning values to articles.
391 * Various:: General purpose settings.
392 * The End:: Farewell and goodbye.
393 * Appendices:: Terminology, Emacs intro, FAQ, History, Internals.
394 * Index:: Variable, function and concept index.
395 * Key Index:: Key Index.
398 --- The Detailed Node Listing ---
402 * Finding the News:: Choosing a method for getting news.
403 * The First Time:: What does Gnus do the first time you start it?
404 * The Server is Down:: How can I read my mail then?
405 * Slave Gnusae:: You can have more than one Gnus active at a time.
406 * Fetching a Group:: Starting Gnus just to read a group.
407 * New Groups:: What is Gnus supposed to do with new groups?
408 * Startup Files:: Those pesky startup files---@file{.newsrc}.
409 * Auto Save:: Recovering from a crash.
410 * The Active File:: Reading the active file over a slow line Takes Time.
411 * Changing Servers:: You may want to move from one server to another.
412 * Startup Variables:: Other variables you might change.
416 * Checking New Groups:: Determining what groups are new.
417 * Subscription Methods:: What Gnus should do with new groups.
418 * Filtering New Groups:: Making Gnus ignore certain new groups.
422 * Group Buffer Format:: Information listed and how you can change it.
423 * Group Maneuvering:: Commands for moving in the group buffer.
424 * Selecting a Group:: Actually reading news.
425 * Group Data:: Changing the info for a group.
426 * Subscription Commands:: Unsubscribing, killing, subscribing.
427 * Group Levels:: Levels? What are those, then?
428 * Group Score:: A mechanism for finding out what groups you like.
429 * Marking Groups:: You can mark groups for later processing.
430 * Foreign Groups:: Creating and editing groups.
431 * Group Parameters:: Each group may have different parameters set.
432 * Listing Groups:: Gnus can list various subsets of the groups.
433 * Sorting Groups:: Re-arrange the group order.
434 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
435 * Browse Foreign Server:: You can browse a server. See what it has to offer.
436 * Exiting Gnus:: Stop reading news and get some work done.
437 * Group Topics:: A folding group mode divided into topics.
438 * Misc Group Stuff:: Other stuff that you can to do.
442 * Group Line Specification:: Deciding how the group buffer is to look.
443 * Group Modeline Specification:: The group buffer modeline.
444 * Group Highlighting:: Having nice colors in the group buffer.
448 * Topic Variables:: How to customize the topics the Lisp Way.
449 * Topic Commands:: Interactive E-Z commands.
450 * Topic Sorting:: Sorting each topic individually.
451 * Topic Topology:: A map of the world.
452 * Topic Parameters:: Parameters that apply to all groups in a topic.
456 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
457 * Group Information:: Information and help on groups and Gnus.
458 * Group Timestamp:: Making Gnus keep track of when you last read a group.
459 * File Commands:: Reading and writing the Gnus files.
463 * Summary Buffer Format:: Deciding how the summary buffer is to look.
464 * Summary Maneuvering:: Moving around the summary buffer.
465 * Choosing Articles:: Reading articles.
466 * Paging the Article:: Scrolling the current article.
467 * Reply Followup and Post:: Posting articles.
468 * Marking Articles:: Marking articles as read, expirable, etc.
469 * Limiting:: You can limit the summary buffer.
470 * Threading:: How threads are made.
471 * Sorting:: How articles and threads are sorted.
472 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
473 * Article Caching:: You may store articles in a cache.
474 * Persistent Articles:: Making articles expiry-resistant.
475 * Article Backlog:: Having already read articles hang around.
476 * Saving Articles:: Ways of customizing article saving.
477 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
478 * Article Treatment:: The article buffer can be mangled at will.
479 * MIME Commands:: Doing MIMEy things with the articles.
480 * Charsets:: Character set issues.
481 * Article Commands:: Doing various things with the article buffer.
482 * Summary Sorting:: Sorting the summary buffer in various ways.
483 * Finding the Parent:: No child support? Get the parent.
484 * Alternative Approaches:: Reading using non-default summaries.
485 * Tree Display:: A more visual display of threads.
486 * Mail Group Commands:: Some commands can only be used in mail groups.
487 * Various Summary Stuff:: What didn't fit anywhere else.
488 * Exiting the Summary Buffer:: Returning to the Group buffer.
489 * Crosspost Handling:: How crossposted articles are dealt with.
490 * Duplicate Suppression:: An alternative when crosspost handling fails.
492 Summary Buffer Format
494 * Summary Buffer Lines:: You can specify how summary lines should look.
495 * To From Newsgroups:: How to not display your own name.
496 * Summary Buffer Mode Line:: You can say how the mode line should look.
497 * Summary Highlighting:: Making the summary buffer all pretty and nice.
501 * Choosing Commands:: Commands for choosing articles.
502 * Choosing Variables:: Variables that influence these commands.
504 Reply, Followup and Post
506 * Summary Mail Commands:: Sending mail.
507 * Summary Post Commands:: Sending news.
508 * Summary Message Commands:: Other Message-related commands.
509 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
513 * Unread Articles:: Marks for unread articles.
514 * Read Articles:: Marks for read articles.
515 * Other Marks:: Marks that do not affect readedness.
516 * Setting Marks:: How to set and remove marks.
517 * Generic Marking Commands:: How to customize the marking.
518 * Setting Process Marks:: How to mark articles for later processing.
522 * Customizing Threading:: Variables you can change to affect the threading.
523 * Thread Commands:: Thread based commands in the summary buffer.
525 Customizing Threading
527 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
528 * Filling In Threads:: Making the threads displayed look fuller.
529 * More Threading:: Even more variables for fiddling with threads.
530 * Low-Level Threading:: You thought it was over... but you were wrong!
534 * Uuencoded Articles:: Uudecode articles.
535 * Shell Archives:: Unshar articles.
536 * PostScript Files:: Split PostScript.
537 * Other Files:: Plain save and binhex.
538 * Decoding Variables:: Variables for a happy decoding.
539 * Viewing Files:: You want to look at the result of the decoding?
543 * Rule Variables:: Variables that say how a file is to be viewed.
544 * Other Decode Variables:: Other decode variables.
545 * Uuencoding and Posting:: Variables for customizing uuencoding.
549 * Article Highlighting:: You want to make the article look like fruit salad.
550 * Article Fontisizing:: Making emphasized text look nice.
551 * Article Hiding:: You also want to make certain info go away.
552 * Article Washing:: Lots of way-neat functions to make life better.
553 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
554 * Article Date:: Grumble, UT!
555 * Article Signature:: What is a signature?
556 * Article Miscellania:: Various other stuff.
558 Alternative Approaches
560 * Pick and Read:: First mark articles and then read them.
561 * Binary Groups:: Auto-decode all articles.
563 Various Summary Stuff
565 * Summary Group Information:: Information oriented commands.
566 * Searching for Articles:: Multiple article commands.
567 * Summary Generation Commands:: (Re)generating the summary buffer.
568 * Really Various Summary Commands:: Those pesky non-conformant commands.
572 * Hiding Headers:: Deciding what headers should be displayed.
573 * Using MIME:: Pushing articles through @sc{mime} before reading them.
574 * Customizing Articles:: Tailoring the look of the articles.
575 * Article Keymap:: Keystrokes available in the article buffer.
576 * Misc Article:: Other stuff.
580 * Mail:: Mailing and replying.
581 * Post:: Posting and following up.
582 * Posting Server:: What server should you post via?
583 * Mail and Post:: Mailing and posting at the same time.
584 * Archived Messages:: Where Gnus stores the messages you've sent.
585 * Posting Styles:: An easier way to specify who you are.
586 * Drafts:: Postponing messages and rejected messages.
587 * Rejected Articles:: What happens if the server doesn't like your article?
591 * The Server Buffer:: Making and editing virtual servers.
592 * Getting News:: Reading USENET news with Gnus.
593 * Getting Mail:: Reading your personal mail with Gnus.
594 * Browsing the Web:: Getting messages from a plethora of Web sources.
595 * Other Sources:: Reading directories, files, SOUP packets.
596 * Combined Groups:: Combining groups into one group.
597 * Gnus Unplugged:: Reading news and mail offline.
601 * Server Buffer Format:: You can customize the look of this buffer.
602 * Server Commands:: Commands to manipulate servers.
603 * Example Methods:: Examples server specifications.
604 * Creating a Virtual Server:: An example session.
605 * Server Variables:: Which variables to set.
606 * Servers and Methods:: You can use server names as select methods.
607 * Unavailable Servers:: Some servers you try to contact may be down.
611 * NNTP:: Reading news from an @sc{nntp} server.
612 * News Spool:: Reading news from the local spool.
616 * Mail in a Newsreader:: Important introductory notes.
617 * Getting Started Reading Mail:: A simple cookbook example.
618 * Splitting Mail:: How to create mail groups.
619 * Mail Sources:: How to tell Gnus where to get mail from.
620 * Mail Backend Variables:: Variables for customizing mail handling.
621 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
622 * Group Mail Splitting:: Use group customize to drive mail splitting.
623 * Incorporating Old Mail:: What about the old mail you have?
624 * Expiring Mail:: Getting rid of unwanted mail.
625 * Washing Mail:: Removing gruft from the mail you get.
626 * Duplicates:: Dealing with duplicated mail.
627 * Not Reading Mail:: Using mail backends for reading other files.
628 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
632 * Mail Source Specifiers:: How to specify what a mail source is.
633 * Mail Source Customization:: Some variables that influence things.
634 * Fetching Mail:: Using the mail source specifiers.
636 Choosing a Mail Backend
638 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
639 * Rmail Babyl:: Emacs programs use the rmail babyl format.
640 * Mail Spool:: Store your mail in a private spool?
641 * MH Spool:: An mhspool-like backend.
642 * Mail Folders:: Having one file for each group.
643 * Comparing Mail Backends:: An in-depth looks at pros and cons.
647 * Web Searches:: Creating groups from articles that match a string.
648 * Slashdot:: Reading the Slashdot comments.
649 * Ultimate:: The Ultimate Bulletin Board systems.
650 * Web Archive:: Reading mailing list archived on web.
654 * Directory Groups:: You can read a directory as if it was a newsgroup.
655 * Anything Groups:: Dired? Who needs dired?
656 * Document Groups:: Single files can be the basis of a group.
657 * SOUP:: Reading @sc{soup} packets ``offline''.
658 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
659 * IMAP:: Using Gnus as a @sc{imap} client.
663 * Document Server Internals:: How to add your own document types.
667 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
668 * SOUP Groups:: A backend for reading @sc{soup} packets.
669 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
673 * Splitting in IMAP:: Splitting mail with nnimap.
674 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
675 * Expunging mailboxes:: Equivalent of a "compress mailbox" button.
679 * Virtual Groups:: Combining articles from many groups.
680 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
684 * Agent Basics:: How it all is supposed to work.
685 * Agent Categories:: How to tell the Gnus Agent what to download.
686 * Agent Commands:: New commands for all the buffers.
687 * Agent Expiry:: How to make old articles go away.
688 * Agent and IMAP:: How to use the Agent with IMAP.
689 * Outgoing Messages:: What happens when you post/mail something?
690 * Agent Variables:: Customizing is fun.
691 * Example Setup:: An example @file{.gnus.el} file for offline people.
692 * Batching Agents:: How to fetch news from a @code{cron} job.
693 * Agent Caveats:: What you think it'll do and what it does.
697 * Category Syntax:: What a category looks like.
698 * The Category Buffer:: A buffer for maintaining categories.
699 * Category Variables:: Customize'r'Us.
703 * Group Agent Commands::
704 * Summary Agent Commands::
705 * Server Agent Commands::
709 * Summary Score Commands:: Adding score entries for the current group.
710 * Group Score Commands:: General score commands.
711 * Score Variables:: Customize your scoring. (My, what terminology).
712 * Score File Format:: What a score file may contain.
713 * Score File Editing:: You can edit score files by hand as well.
714 * Adaptive Scoring:: Big Sister Gnus knows what you read.
715 * Home Score File:: How to say where new score entries are to go.
716 * Followups To Yourself:: Having Gnus notice when people answer you.
717 * Scoring Tips:: How to score effectively.
718 * Reverse Scoring:: That problem child of old is not problem.
719 * Global Score Files:: Earth-spanning, ear-splitting score files.
720 * Kill Files:: They are still here, but they can be ignored.
721 * GroupLens:: Getting predictions on what you like to read.
722 * Advanced Scoring:: Using logical expressions to build score rules.
723 * Score Decays:: It can be useful to let scores wither away.
727 * Using GroupLens:: How to make Gnus use GroupLens.
728 * Rating Articles:: Letting GroupLens know how you rate articles.
729 * Displaying Predictions:: Displaying predictions given by GroupLens.
730 * GroupLens Variables:: Customizing GroupLens.
734 * Advanced Scoring Syntax:: A definition.
735 * Advanced Scoring Examples:: What they look like.
736 * Advanced Scoring Tips:: Getting the most out of it.
740 * Process/Prefix:: A convention used by many treatment commands.
741 * Interactive:: Making Gnus ask you many questions.
742 * Symbolic Prefixes:: How to supply some Gnus functions with options.
743 * Formatting Variables:: You can specify what buffers should look like.
744 * Windows Configuration:: Configuring the Gnus buffer windows.
745 * Faces and Fonts:: How to change how faces look.
746 * Compilation:: How to speed Gnus up.
747 * Mode Lines:: Displaying information in the mode lines.
748 * Highlighting and Menus:: Making buffers look all nice and cozy.
749 * Buttons:: Get tendonitis in ten easy steps!
750 * Daemons:: Gnus can do things behind your back.
751 * NoCeM:: How to avoid spam and other fatty foods.
752 * Undo:: Some actions can be undone.
753 * Moderation:: What to do if you're a moderator.
754 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
755 * Fuzzy Matching:: What's the big fuzz?
756 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
757 * Various Various:: Things that are really various.
761 * Formatting Basics:: A formatting variable is basically a format string.
762 * Mode Line Formatting:: Some rules about mode line formatting variables.
763 * Advanced Formatting:: Modifying output in various ways.
764 * User-Defined Specs:: Having Gnus call your own functions.
765 * Formatting Fonts:: Making the formatting look colorful and nice.
769 * Picons:: How to display pictures of what your reading.
770 * Smileys:: Show all those happy faces the way they were meant to be shown.
771 * Toolbar:: Click'n'drool.
772 * XVarious:: Other XEmacsy Gnusey variables.
776 * Picon Basics:: What are picons and How do I get them.
777 * Picon Requirements:: Don't go further if you aren't using XEmacs.
778 * Easy Picons:: Displaying Picons---the easy way.
779 * Hard Picons:: The way you should do it. You'll learn something.
780 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
784 * History:: How Gnus got where it is today.
785 * On Writing Manuals:: Why this is not a beginner's guide.
786 * Terminology:: We use really difficult, like, words here.
787 * Customization:: Tailoring Gnus to your needs.
788 * Troubleshooting:: What you might try if things do not work.
789 * Gnus Reference Guide:: Rilly, rilly technical stuff.
790 * Emacs for Heathens:: A short introduction to Emacsian terms.
791 * Frequently Asked Questions:: A question-and-answer session.
795 * Gnus Versions:: What Gnus versions have been released.
796 * Other Gnus Versions:: Other Gnus versions that also have been released.
797 * Why?:: What's the point of Gnus?
798 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
799 * Conformity:: Gnus tries to conform to all standards.
800 * Emacsen:: Gnus can be run on a few modern Emacsen.
801 * Gnus Development:: How Gnus is developed.
802 * Contributors:: Oodles of people.
803 * New Features:: Pointers to some of the new stuff in Gnus.
804 * Newest Features:: Features so new that they haven't been written yet.
808 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
809 * September Gnus:: The Thing Formally Known As Gnus 5.3/5.3.
810 * Red Gnus:: Third time best---Gnus 5.4/5.5.
811 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
815 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
816 * Slow Terminal Connection:: You run a remote Emacs.
817 * Little Disk Space:: You feel that having large setup files is icky.
818 * Slow Machine:: You feel like buying a faster machine.
822 * Gnus Utility Functions:: Common functions and variable to use.
823 * Backend Interface:: How Gnus communicates with the servers.
824 * Score File Syntax:: A BNF definition of the score file standard.
825 * Headers:: How Gnus stores headers internally.
826 * Ranges:: A handy format for storing mucho numbers.
827 * Group Info:: The group info format.
828 * Extended Interactive:: Symbolic prefixes and stuff.
829 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
830 * Various File Formats:: Formats of files that Gnus use.
834 * Required Backend Functions:: Functions that must be implemented.
835 * Optional Backend Functions:: Functions that need not be implemented.
836 * Error Messaging:: How to get messages and report errors.
837 * Writing New Backends:: Extending old backends.
838 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
839 * Mail-like Backends:: Some tips on mail backends.
843 * Active File Format:: Information on articles and groups available.
844 * Newsgroups File Format:: Group descriptions.
848 * Keystrokes:: Entering text and executing commands.
849 * Emacs Lisp:: The built-in Emacs programming language.
855 @chapter Starting Gnus
860 If your system administrator has set things up properly, starting Gnus
861 and reading news is extremely easy---you just type @kbd{M-x gnus} in
864 @findex gnus-other-frame
865 @kindex M-x gnus-other-frame
866 If you want to start Gnus in a different frame, you can use the command
867 @kbd{M-x gnus-other-frame} instead.
869 If things do not go smoothly at startup, you have to twiddle some
870 variables in your @file{~/.gnus} file. This file is similar to
871 @file{~/.emacs}, but is read when gnus starts.
873 If you puzzle at any terms used in this manual, please refer to the
874 terminology section (@pxref{Terminology}).
877 * Finding the News:: Choosing a method for getting news.
878 * The First Time:: What does Gnus do the first time you start it?
879 * The Server is Down:: How can I read my mail then?
880 * Slave Gnusae:: You can have more than one Gnus active at a time.
881 * Fetching a Group:: Starting Gnus just to read a group.
882 * New Groups:: What is Gnus supposed to do with new groups?
883 * Startup Files:: Those pesky startup files---@file{.newsrc}.
884 * Auto Save:: Recovering from a crash.
885 * The Active File:: Reading the active file over a slow line Takes Time.
886 * Changing Servers:: You may want to move from one server to another.
887 * Startup Variables:: Other variables you might change.
891 @node Finding the News
892 @section Finding the News
895 @vindex gnus-select-method
897 The @code{gnus-select-method} variable says where Gnus should look for
898 news. This variable should be a list where the first element says
899 @dfn{how} and the second element says @dfn{where}. This method is your
900 native method. All groups not fetched with this method are
903 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
904 you want to get your daily dosage of news from, you'd say:
907 (setq gnus-select-method '(nntp "news.somewhere.edu"))
910 If you want to read directly from the local spool, say:
913 (setq gnus-select-method '(nnspool ""))
916 If you can use a local spool, you probably should, as it will almost
917 certainly be much faster.
919 @vindex gnus-nntpserver-file
921 @cindex @sc{nntp} server
922 If this variable is not set, Gnus will take a look at the
923 @code{NNTPSERVER} environment variable. If that variable isn't set,
924 Gnus will see whether @code{gnus-nntpserver-file}
925 (@file{/etc/nntpserver} by default) has any opinions on the matter. If
926 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server. That's a long shot, though.
928 @vindex gnus-nntp-server
929 If @code{gnus-nntp-server} is set, this variable will override
930 @code{gnus-select-method}. You should therefore set
931 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
933 @vindex gnus-secondary-servers
934 @vindex gnus-nntp-server
935 You can also make Gnus prompt you interactively for the name of an
936 @sc{nntp} server. If you give a non-numerical prefix to @code{gnus}
937 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
938 in the @code{gnus-secondary-servers} list (if any). You can also just
939 type in the name of any server you feel like visiting. (Note that this
940 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
941 gnus} later in the same Emacs session, Gnus will contact the same
944 @findex gnus-group-browse-foreign-server
946 However, if you use one @sc{nntp} server regularly and are just
947 interested in a couple of groups from a different server, you would be
948 better served by using the @kbd{B} command in the group buffer. It will
949 let you have a look at what groups are available, and you can subscribe
950 to any of the groups you want to. This also makes @file{.newsrc}
951 maintenance much tidier. @xref{Foreign Groups}.
953 @vindex gnus-secondary-select-methods
955 A slightly different approach to foreign groups is to set the
956 @code{gnus-secondary-select-methods} variable. The select methods
957 listed in this variable are in many ways just as native as the
958 @code{gnus-select-method} server. They will also be queried for active
959 files during startup (if that's required), and new newsgroups that
960 appear on these servers will be subscribed (or not) just as native
963 For instance, if you use the @code{nnmbox} backend to read your mail, you
964 would typically set this variable to
967 (setq gnus-secondary-select-methods '((nnmbox "")))
972 @section The First Time
973 @cindex first time usage
975 If no startup files exist, Gnus will try to determine what groups should
976 be subscribed by default.
978 @vindex gnus-default-subscribed-newsgroups
979 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
980 will subscribe you to just those groups in that list, leaving the rest
981 killed. Your system administrator should have set this variable to
984 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
985 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
986 here as @dfn{whatever Lars thinks you should read}.)
988 You'll also be subscribed to the Gnus documentation group, which should
989 help you with most common problems.
991 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
992 use the normal functions for handling new groups, and not do anything
996 @node The Server is Down
997 @section The Server is Down
998 @cindex server errors
1000 If the default server is down, Gnus will understandably have some
1001 problems starting. However, if you have some mail groups in addition to
1002 the news groups, you may want to start Gnus anyway.
1004 Gnus, being the trusting sort of program, will ask whether to proceed
1005 without a native select method if that server can't be contacted. This
1006 will happen whether the server doesn't actually exist (i.e., you have
1007 given the wrong address) or the server has just momentarily taken ill
1008 for some reason or other. If you decide to continue and have no foreign
1009 groups, you'll find it difficult to actually do anything in the group
1010 buffer. But, hey, that's your problem. Blllrph!
1012 @findex gnus-no-server
1013 @kindex M-x gnus-no-server
1015 If you know that the server is definitely down, or you just want to read
1016 your mail without bothering with the server at all, you can use the
1017 @code{gnus-no-server} command to start Gnus. That might come in handy
1018 if you're in a hurry as well. This command will not attempt to contact
1019 your primary server---instead, it will just activate all groups on level
1020 1 and 2. (You should preferably keep no native groups on those two
1025 @section Slave Gnusae
1028 You might want to run more than one Emacs with more than one Gnus at the
1029 same time. If you are using different @file{.newsrc} files (e.g., if you
1030 are using the two different Gnusae to read from two different servers),
1031 that is no problem whatsoever. You just do it.
1033 The problem appears when you want to run two Gnusae that use the same
1034 @code{.newsrc} file.
1036 To work around that problem some, we here at the Think-Tank at the Gnus
1037 Towers have come up with a new concept: @dfn{Masters} and
1038 @dfn{slaves}. (We have applied for a patent on this concept, and have
1039 taken out a copyright on those words. If you wish to use those words in
1040 conjunction with each other, you have to send $1 per usage instance to
1041 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1042 Applications}) will be much more expensive, of course.)
1044 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
1045 however you do it). Each subsequent slave Gnusae should be started with
1046 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1047 files, but instead save @dfn{slave files} that contain information only
1048 on what groups have been read in the slave session. When a master Gnus
1049 starts, it will read (and delete) these slave files, incorporating all
1050 information from them. (The slave files will be read in the sequence
1051 they were created, so the latest changes will have precedence.)
1053 Information from the slave files has, of course, precedence over the
1054 information in the normal (i.e., master) @code{.newsrc} file.
1057 @node Fetching a Group
1058 @section Fetching a Group
1059 @cindex fetching a group
1061 @findex gnus-fetch-group
1062 It is sometimes convenient to be able to just say ``I want to read this
1063 group and I don't care whether Gnus has been started or not''. This is
1064 perhaps more useful for people who write code than for users, but the
1065 command @code{gnus-fetch-group} provides this functionality in any case.
1066 It takes the group name as a parameter.
1072 @cindex subscription
1074 @vindex gnus-check-new-newsgroups
1075 If you are satisfied that you really never want to see any new groups,
1076 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1077 also save you some time at startup. Even if this variable is
1078 @code{nil}, you can always subscribe to the new groups just by pressing
1079 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1080 is @code{ask-server} by default. If you set this variable to
1081 @code{always}, then Gnus will query the backends for new groups even
1082 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1085 * Checking New Groups:: Determining what groups are new.
1086 * Subscription Methods:: What Gnus should do with new groups.
1087 * Filtering New Groups:: Making Gnus ignore certain new groups.
1091 @node Checking New Groups
1092 @subsection Checking New Groups
1094 Gnus normally determines whether a group is new or not by comparing the
1095 list of groups from the active file(s) with the lists of subscribed and
1096 dead groups. This isn't a particularly fast method. If
1097 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
1098 server for new groups since the last time. This is both faster and
1099 cheaper. This also means that you can get rid of the list of killed
1100 groups altogether, so you may set @code{gnus-save-killed-list} to
1101 @code{nil}, which will save time both at startup, at exit, and all over.
1102 Saves disk space, too. Why isn't this the default, then?
1103 Unfortunately, not all servers support this command.
1105 I bet I know what you're thinking now: How do I find out whether my
1106 server supports @code{ask-server}? No? Good, because I don't have a
1107 fail-safe answer. I would suggest just setting this variable to
1108 @code{ask-server} and see whether any new groups appear within the next
1109 few days. If any do, then it works. If none do, then it doesn't
1110 work. I could write a function to make Gnus guess whether the server
1111 supports @code{ask-server}, but it would just be a guess. So I won't.
1112 You could @code{telnet} to the server and say @code{HELP} and see
1113 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1114 it does, then it might work. (But there are servers that lists
1115 @samp{NEWGROUPS} without supporting the function properly.)
1117 This variable can also be a list of select methods. If so, Gnus will
1118 issue an @code{ask-server} command to each of the select methods, and
1119 subscribe them (or not) using the normal methods. This might be handy
1120 if you are monitoring a few servers for new groups. A side effect is
1121 that startup will take much longer, so you can meditate while waiting.
1122 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1125 @node Subscription Methods
1126 @subsection Subscription Methods
1128 @vindex gnus-subscribe-newsgroup-method
1129 What Gnus does when it encounters a new group is determined by the
1130 @code{gnus-subscribe-newsgroup-method} variable.
1132 This variable should contain a function. This function will be called
1133 with the name of the new group as the only parameter.
1135 Some handy pre-fab functions are:
1139 @item gnus-subscribe-zombies
1140 @vindex gnus-subscribe-zombies
1141 Make all new groups zombies. This is the default. You can browse the
1142 zombies later (with @kbd{A z}) and either kill them all off properly
1143 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1145 @item gnus-subscribe-randomly
1146 @vindex gnus-subscribe-randomly
1147 Subscribe all new groups in arbitrary order. This really means that all
1148 new groups will be added at ``the top'' of the group buffer.
1150 @item gnus-subscribe-alphabetically
1151 @vindex gnus-subscribe-alphabetically
1152 Subscribe all new groups in alphabetical order.
1154 @item gnus-subscribe-hierarchically
1155 @vindex gnus-subscribe-hierarchically
1156 Subscribe all new groups hierarchically. The difference between this
1157 function and @code{gnus-subscribe-alphabetically} is slight.
1158 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1159 alphabetical fashion, while this function will enter groups into its
1160 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1161 @samp{comp} hierarchy, this function will not mess that configuration
1162 up. Or something like that.
1164 @item gnus-subscribe-interactively
1165 @vindex gnus-subscribe-interactively
1166 Subscribe new groups interactively. This means that Gnus will ask
1167 you about @strong{all} new groups. The groups you choose to subscribe
1168 to will be subscribed hierarchically.
1170 @item gnus-subscribe-killed
1171 @vindex gnus-subscribe-killed
1172 Kill all new groups.
1174 @item gnus-subscribe-topics
1175 @vindex gnus-subscribe-topics
1176 Put the groups into the topic that has a matching @code{subscribe} topic
1177 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1178 topic parameter that looks like
1184 will mean that all groups that match that regex will be subscribed under
1187 If no topics match the groups, the groups will be subscribed in the
1192 @vindex gnus-subscribe-hierarchical-interactive
1193 A closely related variable is
1194 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1195 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
1196 hierarchical fashion whether to subscribe to new groups or not. Gnus
1197 will ask you for each sub-hierarchy whether you want to descend the
1200 One common mistake is to set the variable a few paragraphs above
1201 (@code{gnus-subscribe-newsgroup-method}) to
1202 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1203 will not work. This is ga-ga. So don't do it.
1206 @node Filtering New Groups
1207 @subsection Filtering New Groups
1209 A nice and portable way to control which new newsgroups should be
1210 subscribed (or ignored) is to put an @dfn{options} line at the start of
1211 the @file{.newsrc} file. Here's an example:
1214 options -n !alt.all !rec.all sci.all
1217 @vindex gnus-subscribe-options-newsgroup-method
1218 This line obviously belongs to a serious-minded intellectual scientific
1219 person (or she may just be plain old boring), because it says that all
1220 groups that have names beginning with @samp{alt} and @samp{rec} should
1221 be ignored, and all groups with names beginning with @samp{sci} should
1222 be subscribed. Gnus will not use the normal subscription method for
1223 subscribing these groups.
1224 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1225 variable defaults to @code{gnus-subscribe-alphabetically}.
1227 @vindex gnus-options-not-subscribe
1228 @vindex gnus-options-subscribe
1229 If you don't want to mess with your @file{.newsrc} file, you can just
1230 set the two variables @code{gnus-options-subscribe} and
1231 @code{gnus-options-not-subscribe}. These two variables do exactly the
1232 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1233 and if the new group matches the former, it will be unconditionally
1234 subscribed, and if it matches the latter, it will be ignored.
1236 @vindex gnus-auto-subscribed-groups
1237 Yet another variable that meddles here is
1238 @code{gnus-auto-subscribed-groups}. It works exactly like
1239 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
1240 thought it would be nice to have two of these. This variable is more
1241 meant for setting some ground rules, while the other variable is used
1242 more for user fiddling. By default this variable makes all new groups
1243 that come from mail backends (@code{nnml}, @code{nnbabyl},
1244 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed. If you
1245 don't like that, just set this variable to @code{nil}.
1247 New groups that match this regexp are subscribed using
1248 @code{gnus-subscribe-options-newsgroup-method}.
1251 @node Changing Servers
1252 @section Changing Servers
1253 @cindex changing servers
1255 Sometimes it is necessary to move from one @sc{nntp} server to another.
1256 This happens very rarely, but perhaps you change jobs, or one server is
1257 very flaky and you want to use another.
1259 Changing the server is pretty easy, right? You just change
1260 @code{gnus-select-method} to point to the new server?
1264 Article numbers are not (in any way) kept synchronized between different
1265 @sc{nntp} servers, and the only way Gnus keeps track of what articles
1266 you have read is by keeping track of article numbers. So when you
1267 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1270 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1271 file from one server to another. They all have one thing in
1272 common---they take a looong time to run. You don't want to use these
1273 functions more than absolutely necessary.
1275 @kindex M-x gnus-change-server
1276 @findex gnus-change-server
1277 If you have access to both servers, Gnus can request the headers for all
1278 the articles you have read and compare @code{Message-ID}s and map the
1279 article numbers of the read articles and article marks. The @kbd{M-x
1280 gnus-change-server} command will do this for all your native groups. It
1281 will prompt for the method you want to move to.
1283 @kindex M-x gnus-group-move-group-to-server
1284 @findex gnus-group-move-group-to-server
1285 You can also move individual groups with the @kbd{M-x
1286 gnus-group-move-group-to-server} command. This is useful if you want to
1287 move a (foreign) group from one server to another.
1289 @kindex M-x gnus-group-clear-data-on-native-groups
1290 @findex gnus-group-clear-data-on-native-groups
1291 If you don't have access to both the old and new server, all your marks
1292 and read ranges have become worthless. You can use the @kbd{M-x
1293 gnus-group-clear-data-on-native-groups} command to clear out all data
1294 that you have on your native groups. Use with caution.
1296 After changing servers, you @strong{must} move the cache hierarchy away,
1297 since the cached articles will have wrong article numbers, which will
1298 affect which articles Gnus thinks are read.
1302 @section Startup Files
1303 @cindex startup files
1308 Now, you all know about the @file{.newsrc} file. All subscription
1309 information is traditionally stored in this file.
1311 Things got a bit more complicated with @sc{gnus}. In addition to
1312 keeping the @file{.newsrc} file updated, it also used a file called
1313 @file{.newsrc.el} for storing all the information that didn't fit into
1314 the @file{.newsrc} file. (Actually, it also duplicated everything in
1315 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1316 files was the most recently saved, which enabled people to swap between
1317 @sc{gnus} and other newsreaders.
1319 That was kinda silly, so Gnus went one better: In addition to the
1320 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1321 @file{.newsrc.eld}. It will read whichever of these files that are most
1322 recent, but it will never write a @file{.newsrc.el} file. You should
1323 never delete the @file{.newsrc.eld} file---it contains much information
1324 not stored in the @file{.newsrc} file.
1326 @vindex gnus-save-newsrc-file
1327 @vindex gnus-read-newsrc-file
1328 You can turn off writing the @file{.newsrc} file by setting
1329 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1330 the file and save some space, as well as exiting from Gnus faster.
1331 However, this will make it impossible to use other newsreaders than
1332 Gnus. But hey, who would want to, right? Similarly, setting
1333 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
1334 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1335 convenient if you have a tendency to use Netscape once in a while.
1337 @vindex gnus-save-killed-list
1338 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1339 will not save the list of killed groups to the startup file. This will
1340 save both time (when starting and quitting) and space (on disk). It
1341 will also mean that Gnus has no record of what groups are new or old,
1342 so the automatic new groups subscription methods become meaningless.
1343 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1344 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1345 Groups}). This variable can also be a regular expression. If that's
1346 the case, remove all groups that do not match this regexp before
1347 saving. This can be useful in certain obscure situations that involve
1348 several servers where not all servers support @code{ask-server}.
1350 @vindex gnus-startup-file
1351 The @code{gnus-startup-file} variable says where the startup files are.
1352 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1353 file being whatever that one is, with a @samp{.eld} appended.
1355 @vindex gnus-save-newsrc-hook
1356 @vindex gnus-save-quick-newsrc-hook
1357 @vindex gnus-save-standard-newsrc-hook
1358 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1359 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1360 saving the @file{.newsrc.eld} file, and
1361 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1362 @file{.newsrc} file. The latter two are commonly used to turn version
1363 control on or off. Version control is on by default when saving the
1364 startup files. If you want to turn backup creation off, say something like:
1367 (defun turn-off-backup ()
1368 (set (make-local-variable 'backup-inhibited) t))
1370 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1371 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1374 @vindex gnus-init-file
1375 When Gnus starts, it will read the @code{gnus-site-init-file}
1376 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1377 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1378 and can be used to avoid cluttering your @file{~/.emacs} and
1379 @file{site-init} files with Gnus stuff. Gnus will also check for files
1380 with the same names as these, but with @file{.elc} and @file{.el}
1381 suffixes. In other words, if you have set @code{gnus-init-file} to
1382 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1383 and finally @file{~/.gnus} (in this order).
1389 @cindex dribble file
1392 Whenever you do something that changes the Gnus data (reading articles,
1393 catching up, killing/subscribing groups), the change is added to a
1394 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1395 Emacs way. If your Emacs should crash before you have saved the
1396 @file{.newsrc} files, all changes you have made can be recovered from
1399 If Gnus detects this file at startup, it will ask the user whether to
1400 read it. The auto save file is deleted whenever the real startup file is
1403 @vindex gnus-use-dribble-file
1404 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
1405 maintain a dribble buffer. The default is @code{t}.
1407 @vindex gnus-dribble-directory
1408 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1409 this variable is @code{nil}, which it is by default, Gnus will dribble
1410 into the directory where the @file{.newsrc} file is located. (This is
1411 normally the user's home directory.) The dribble file will get the same
1412 file permissions as the @code{.newsrc} file.
1414 @vindex gnus-always-read-dribble-file
1415 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1416 read the dribble file on startup without querying the user.
1419 @node The Active File
1420 @section The Active File
1422 @cindex ignored groups
1424 When Gnus starts, or indeed whenever it tries to determine whether new
1425 articles have arrived, it reads the active file. This is a very large
1426 file that lists all the active groups and articles on the server.
1428 @vindex gnus-ignored-newsgroups
1429 Before examining the active file, Gnus deletes all lines that match the
1430 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1431 any groups with bogus names, but you can use this variable to make Gnus
1432 ignore hierarchies you aren't ever interested in. However, this is not
1433 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1434 Groups} for an overview of other variables that can be used instead.
1437 @c @code{nil} by default, and will slow down active file handling somewhat
1438 @c if you set it to anything else.
1440 @vindex gnus-read-active-file
1442 The active file can be rather Huge, so if you have a slow network, you
1443 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
1444 reading the active file. This variable is @code{some} by default.
1446 Gnus will try to make do by getting information just on the groups that
1447 you actually subscribe to.
1449 Note that if you subscribe to lots and lots of groups, setting this
1450 variable to @code{nil} will probably make Gnus slower, not faster. At
1451 present, having this variable @code{nil} will slow Gnus down
1452 considerably, unless you read news over a 2400 baud modem.
1454 This variable can also have the value @code{some}. Gnus will then
1455 attempt to read active info only on the subscribed groups. On some
1456 servers this is quite fast (on sparkling, brand new INN servers that
1457 support the @code{LIST ACTIVE group} command), on others this isn't fast
1458 at all. In any case, @code{some} should be faster than @code{nil}, and
1459 is certainly faster than @code{t} over slow lines.
1461 Some news servers (Leafnode and old versions of INN, for instance) do
1462 not support the @code{LIST ACTIVE group}. For these servers, @code{nil}
1463 is probably the most efficient value for this variable.
1465 If this variable is @code{nil}, Gnus will ask for group info in total
1466 lock-step, which isn't very fast. If it is @code{some} and you use an
1467 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
1468 read all the replies in one swoop. This will normally result in better
1469 performance, but if the server does not support the aforementioned
1470 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1472 If you think that starting up Gnus takes too long, try all the three
1473 different values for this variable and see what works best for you.
1475 In any case, if you use @code{some} or @code{nil}, you should definitely
1476 kill all groups that you aren't interested in to speed things up.
1478 Note that this variable also affects active file retrieval from
1479 secondary select methods.
1482 @node Startup Variables
1483 @section Startup Variables
1487 @item gnus-load-hook
1488 @vindex gnus-load-hook
1489 A hook run while Gnus is being loaded. Note that this hook will
1490 normally be run just once in each Emacs session, no matter how many
1491 times you start Gnus.
1493 @item gnus-before-startup-hook
1494 @vindex gnus-before-startup-hook
1495 A hook run after starting up Gnus successfully.
1497 @item gnus-startup-hook
1498 @vindex gnus-startup-hook
1499 A hook run as the very last thing after starting up Gnus
1501 @item gnus-started-hook
1502 @vindex gnus-started-hook
1503 A hook that is run as the very last thing after starting up Gnus
1506 @item gnus-setup-news-hook
1507 @vindex gnus-setup-news-hook
1508 A hook that is run after reading the @file{.newsrc} file(s), but before
1509 generating the group buffer.
1511 @item gnus-check-bogus-newsgroups
1512 @vindex gnus-check-bogus-newsgroups
1513 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1514 startup. A @dfn{bogus group} is a group that you have in your
1515 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1516 bogus groups can take quite a while, so to save time and resources it's
1517 best to leave this option off, and do the checking for bogus groups once
1518 in a while from the group buffer instead (@pxref{Group Maintenance}).
1520 @item gnus-inhibit-startup-message
1521 @vindex gnus-inhibit-startup-message
1522 If non-@code{nil}, the startup message won't be displayed. That way,
1523 your boss might not notice as easily that you are reading news instead
1524 of doing your job. Note that this variable is used before
1525 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1527 @item gnus-no-groups-message
1528 @vindex gnus-no-groups-message
1529 Message displayed by Gnus when no groups are available.
1531 @item gnus-play-startup-jingle
1532 @vindex gnus-play-startup-jingle
1533 If non-@code{nil}, play the Gnus jingle at startup.
1535 @item gnus-startup-jingle
1536 @vindex gnus-startup-jingle
1537 Jingle to be played if the above variable is non-@code{nil}. The
1538 default is @samp{Tuxedomoon.Jingle4.au}.
1543 @node The Group Buffer
1544 @chapter The Group Buffer
1545 @cindex group buffer
1547 The @dfn{group buffer} lists all (or parts) of the available groups. It
1548 is the first buffer shown when Gnus starts, and will never be killed as
1549 long as Gnus is active.
1553 \gnusfigure{The Group Buffer}{320}{
1554 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1555 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1556 \put(120,38){\vector(1,2){10}}
1557 \put(40,60){\makebox(0,0)[r]{Mode line}}
1558 \put(40,58){\vector(1,0){30}}
1559 \put(200,28){\makebox(0,0)[t]{Native select method}}
1560 \put(200,26){\vector(-1,2){15}}
1566 * Group Buffer Format:: Information listed and how you can change it.
1567 * Group Maneuvering:: Commands for moving in the group buffer.
1568 * Selecting a Group:: Actually reading news.
1569 * Group Data:: Changing the info for a group.
1570 * Subscription Commands:: Unsubscribing, killing, subscribing.
1571 * Group Levels:: Levels? What are those, then?
1572 * Group Score:: A mechanism for finding out what groups you like.
1573 * Marking Groups:: You can mark groups for later processing.
1574 * Foreign Groups:: Creating and editing groups.
1575 * Group Parameters:: Each group may have different parameters set.
1576 * Listing Groups:: Gnus can list various subsets of the groups.
1577 * Sorting Groups:: Re-arrange the group order.
1578 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1579 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1580 * Exiting Gnus:: Stop reading news and get some work done.
1581 * Group Topics:: A folding group mode divided into topics.
1582 * Misc Group Stuff:: Other stuff that you can to do.
1586 @node Group Buffer Format
1587 @section Group Buffer Format
1590 * Group Line Specification:: Deciding how the group buffer is to look.
1591 * Group Modeline Specification:: The group buffer modeline.
1592 * Group Highlighting:: Having nice colors in the group buffer.
1596 @node Group Line Specification
1597 @subsection Group Line Specification
1598 @cindex group buffer format
1600 The default format of the group buffer is nice and dull, but you can
1601 make it as exciting and ugly as you feel like.
1603 Here's a couple of example group lines:
1606 25: news.announce.newusers
1607 * 0: alt.fan.andrea-dworkin
1612 You can see that there are 25 unread articles in
1613 @samp{news.announce.newusers}. There are no unread articles, but some
1614 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1615 asterisk at the beginning of the line?).
1617 @vindex gnus-group-line-format
1618 You can change that format to whatever you want by fiddling with the
1619 @code{gnus-group-line-format} variable. This variable works along the
1620 lines of a @code{format} specification, which is pretty much the same as
1621 a @code{printf} specifications, for those of you who use (feh!) C.
1622 @xref{Formatting Variables}.
1624 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1626 There should always be a colon on the line; the cursor always moves to
1627 the colon after performing an operation. Nothing else is required---not
1628 even the group name. All displayed text is just window dressing, and is
1629 never examined by Gnus. Gnus stores all real information it needs using
1632 (Note that if you make a really strange, wonderful, spreadsheet-like
1633 layout, everybody will believe you are hard at work with the accounting
1634 instead of wasting time reading news.)
1636 Here's a list of all available format characters:
1641 An asterisk if the group only has marked articles.
1644 Whether the group is subscribed.
1647 Level of subscribedness.
1650 Number of unread articles.
1653 Number of dormant articles.
1656 Number of ticked articles.
1659 Number of read articles.
1662 Estimated total number of articles. (This is really @var{max-number}
1663 minus @var{min-number} plus 1.)
1666 Number of unread, unticked, non-dormant articles.
1669 Number of ticked and dormant articles.
1678 Newsgroup description.
1681 @samp{m} if moderated.
1684 @samp{(m)} if moderated.
1693 A string that looks like @samp{<%s:%n>} if a foreign select method is
1697 Indentation based on the level of the topic (@pxref{Group Topics}).
1700 @vindex gnus-group-uncollapsed-levels
1701 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1702 variable says how many levels to leave at the end of the group name.
1703 The default is 1---this will mean that group names like
1704 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1707 @vindex gnus-new-mail-mark
1709 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1713 A string that says when you last read the group (@pxref{Group
1717 User defined specifier. The next character in the format string should
1718 be a letter. Gnus will call the function
1719 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1720 following @samp{%u}. The function will be passed a single dummy
1721 parameter as argument. The function should return a string, which will
1722 be inserted into the buffer just like information from any other
1727 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1728 if no info is available---for instance, if it is a non-activated foreign
1729 group, or a bogus native group.
1732 @node Group Modeline Specification
1733 @subsection Group Modeline Specification
1734 @cindex group modeline
1736 @vindex gnus-group-mode-line-format
1737 The mode line can be changed by setting
1738 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1739 doesn't understand that many format specifiers:
1743 The native news server.
1745 The native select method.
1749 @node Group Highlighting
1750 @subsection Group Highlighting
1751 @cindex highlighting
1752 @cindex group highlighting
1754 @vindex gnus-group-highlight
1755 Highlighting in the group buffer is controlled by the
1756 @code{gnus-group-highlight} variable. This is an alist with elements
1757 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1758 something non-@code{nil}, the @var{face} will be used on the line.
1760 Here's an example value for this variable that might look nice if the
1764 (cond (window-system
1765 (setq custom-background-mode 'light)
1766 (defface my-group-face-1
1767 '((t (:foreground "Red" :bold t))) "First group face")
1768 (defface my-group-face-2
1769 '((t (:foreground "DarkSeaGreen4" :bold t))) "Second group face")
1770 (defface my-group-face-3
1771 '((t (:foreground "Green4" :bold t))) "Third group face")
1772 (defface my-group-face-4
1773 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1774 (defface my-group-face-5
1775 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1777 (setq gnus-group-highlight
1778 '(((> unread 200) . my-group-face-1)
1779 ((and (< level 3) (zerop unread)) . my-group-face-2)
1780 ((< level 3) . my-group-face-3)
1781 ((zerop unread) . my-group-face-4)
1782 (t . my-group-face-5)))
1785 Also @pxref{Faces and Fonts}.
1787 Variables that are dynamically bound when the forms are evaluated
1794 The number of unread articles in the group.
1798 Whether the group is a mail group.
1800 The level of the group.
1802 The score of the group.
1804 The number of ticked articles in the group.
1806 The total number of articles in the group. Or rather, MAX-NUMBER minus
1807 MIN-NUMBER plus one.
1809 When using the topic minor mode, this variable is bound to the current
1810 topic being inserted.
1813 When the forms are @code{eval}ed, point is at the beginning of the line
1814 of the group in question, so you can use many of the normal Gnus
1815 functions for snarfing info on the group.
1817 @vindex gnus-group-update-hook
1818 @findex gnus-group-highlight-line
1819 @code{gnus-group-update-hook} is called when a group line is changed.
1820 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1821 calls @code{gnus-group-highlight-line} by default.
1824 @node Group Maneuvering
1825 @section Group Maneuvering
1826 @cindex group movement
1828 All movement commands understand the numeric prefix and will behave as
1829 expected, hopefully.
1835 @findex gnus-group-next-unread-group
1836 Go to the next group that has unread articles
1837 (@code{gnus-group-next-unread-group}).
1843 @findex gnus-group-prev-unread-group
1844 Go to the previous group that has unread articles
1845 (@code{gnus-group-prev-unread-group}).
1849 @findex gnus-group-next-group
1850 Go to the next group (@code{gnus-group-next-group}).
1854 @findex gnus-group-prev-group
1855 Go to the previous group (@code{gnus-group-prev-group}).
1859 @findex gnus-group-next-unread-group-same-level
1860 Go to the next unread group on the same (or lower) level
1861 (@code{gnus-group-next-unread-group-same-level}).
1865 @findex gnus-group-prev-unread-group-same-level
1866 Go to the previous unread group on the same (or lower) level
1867 (@code{gnus-group-prev-unread-group-same-level}).
1870 Three commands for jumping to groups:
1876 @findex gnus-group-jump-to-group
1877 Jump to a group (and make it visible if it isn't already)
1878 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
1883 @findex gnus-group-best-unread-group
1884 Jump to the unread group with the lowest level
1885 (@code{gnus-group-best-unread-group}).
1889 @findex gnus-group-first-unread-group
1890 Jump to the first group with unread articles
1891 (@code{gnus-group-first-unread-group}).
1894 @vindex gnus-group-goto-unread
1895 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1896 commands will move to the next group, not the next unread group. Even
1897 the commands that say they move to the next unread group. The default
1901 @node Selecting a Group
1902 @section Selecting a Group
1903 @cindex group selection
1908 @kindex SPACE (Group)
1909 @findex gnus-group-read-group
1910 Select the current group, switch to the summary buffer and display the
1911 first unread article (@code{gnus-group-read-group}). If there are no
1912 unread articles in the group, or if you give a non-numerical prefix to
1913 this command, Gnus will offer to fetch all the old articles in this
1914 group from the server. If you give a numerical prefix @var{N}, @var{N}
1915 determines the number of articles Gnus will fetch. If @var{N} is
1916 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1917 negative, Gnus fetches the @code{abs(@var{N})} oldest articles.
1921 @findex gnus-group-select-group
1922 Select the current group and switch to the summary buffer
1923 (@code{gnus-group-select-group}). Takes the same arguments as
1924 @code{gnus-group-read-group}---the only difference is that this command
1925 does not display the first unread article automatically upon group
1929 @kindex M-RET (Group)
1930 @findex gnus-group-quick-select-group
1931 This does the same as the command above, but tries to do it with the
1932 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
1933 scoring/killing will be performed, there will be no highlights and no
1934 expunging. This might be useful if you're in a real hurry and have to
1935 enter some humongous group. If you give a 0 prefix to this command
1936 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
1937 which is useful if you want to toggle threading before generating the
1938 summary buffer (@pxref{Summary Generation Commands}).
1941 @kindex M-SPACE (Group)
1942 @findex gnus-group-visible-select-group
1943 This is yet one more command that does the same as the @kbd{RET}
1944 command, but this one does it without expunging and hiding dormants
1945 (@code{gnus-group-visible-select-group}).
1948 @kindex M-C-RET (Group)
1949 @findex gnus-group-select-group-ephemerally
1950 Finally, this command selects the current group ephemerally without
1951 doing any processing of its contents
1952 (@code{gnus-group-select-group-ephemerally}). Even threading has been
1953 turned off. Everything you do in the group after selecting it in this
1954 manner will have no permanent effects.
1958 @vindex gnus-large-newsgroup
1959 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1960 to be a big group. This is 200 by default. If the group has more
1961 (unread and/or ticked) articles than this, Gnus will query the user
1962 before entering the group. The user can then specify how many articles
1963 should be fetched from the server. If the user specifies a negative
1964 number (@code{-n}), the @code{n} oldest articles will be fetched. If it
1965 is positive, the @code{n} articles that have arrived most recently will
1968 @vindex gnus-select-group-hook
1969 @vindex gnus-auto-select-first
1970 @code{gnus-auto-select-first} control whether any articles are selected
1971 automatically when entering a group with the @kbd{SPACE} command.
1976 Don't select any articles when entering the group. Just display the
1977 full summary buffer.
1980 Select the first unread article when entering the group.
1983 Select the highest scored article in the group when entering the
1988 This variable can also be a function. In that case, that function will
1989 be called to place point on a subject line, and/or select some article.
1990 Useful functions include:
1993 @item gnus-summary-first-unread-subject
1994 Place point on the subject line of the first unread article, but
1995 don't select the article.
1997 @item gnus-summary-first-unread-article
1998 Select the first unread article.
2000 @item gnus-summary-best-unread-article
2001 Select the highest-scored unread article.
2005 If you want to prevent automatic selection in some group (say, in a
2006 binary group with Huge articles) you can set this variable to @code{nil}
2007 in @code{gnus-select-group-hook}, which is called when a group is
2011 @node Subscription Commands
2012 @section Subscription Commands
2013 @cindex subscription
2021 @findex gnus-group-unsubscribe-current-group
2022 @c @icon{gnus-group-unsubscribe}
2023 Toggle subscription to the current group
2024 (@code{gnus-group-unsubscribe-current-group}).
2030 @findex gnus-group-unsubscribe-group
2031 Prompt for a group to subscribe, and then subscribe it. If it was
2032 subscribed already, unsubscribe it instead
2033 (@code{gnus-group-unsubscribe-group}).
2039 @findex gnus-group-kill-group
2040 @c @icon{gnus-group-kill-group}
2041 Kill the current group (@code{gnus-group-kill-group}).
2047 @findex gnus-group-yank-group
2048 Yank the last killed group (@code{gnus-group-yank-group}).
2051 @kindex C-x C-t (Group)
2052 @findex gnus-group-transpose-groups
2053 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2054 really a subscription command, but you can use it instead of a
2055 kill-and-yank sequence sometimes.
2061 @findex gnus-group-kill-region
2062 Kill all groups in the region (@code{gnus-group-kill-region}).
2066 @findex gnus-group-kill-all-zombies
2067 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2070 @kindex S C-k (Group)
2071 @findex gnus-group-kill-level
2072 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2073 These groups can't be yanked back after killing, so this command should
2074 be used with some caution. The only time where this command comes in
2075 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2076 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2077 kill off all unsubscribed groups that do not have message numbers in the
2078 @file{.newsrc} file.
2082 Also @pxref{Group Levels}.
2092 @findex gnus-group-catchup-current
2093 @vindex gnus-group-catchup-group-hook
2094 @c @icon{gnus-group-catchup-current}
2095 Mark all unticked articles in this group as read
2096 (@code{gnus-group-catchup-current}).
2097 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2102 @findex gnus-group-catchup-current-all
2103 Mark all articles in this group, even the ticked ones, as read
2104 (@code{gnus-group-catchup-current-all}).
2108 @findex gnus-group-clear-data
2109 Clear the data from the current group---nix out marks and the list of
2110 read articles (@code{gnus-group-clear-data}).
2112 @item M-x gnus-group-clear-data-on-native-groups
2113 @kindex M-x gnus-group-clear-data-on-native-groups
2114 @findex gnus-group-clear-data-on-native-groups
2115 If you have switched from one @sc{nntp} server to another, all your marks
2116 and read ranges have become worthless. You can use this command to
2117 clear out all data that you have on your native groups. Use with
2124 @section Group Levels
2128 All groups have a level of @dfn{subscribedness}. For instance, if a
2129 group is on level 2, it is more subscribed than a group on level 5. You
2130 can ask Gnus to just list groups on a given level or lower
2131 (@pxref{Listing Groups}), or to just check for new articles in groups on
2132 a given level or lower (@pxref{Scanning New Messages}).
2134 Remember: The higher the level of the group, the less important it is.
2140 @findex gnus-group-set-current-level
2141 Set the level of the current group. If a numeric prefix is given, the
2142 next @var{n} groups will have their levels set. The user will be
2143 prompted for a level.
2146 @vindex gnus-level-killed
2147 @vindex gnus-level-zombie
2148 @vindex gnus-level-unsubscribed
2149 @vindex gnus-level-subscribed
2150 Gnus considers groups from levels 1 to
2151 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2152 @code{gnus-level-subscribed} (exclusive) and
2153 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2154 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2155 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2156 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2157 same, but zombie and killed groups have no information on what articles
2158 you have read, etc, stored. This distinction between dead and living
2159 groups isn't done because it is nice or clever, it is done purely for
2160 reasons of efficiency.
2162 It is recommended that you keep all your mail groups (if any) on quite
2163 low levels (e.g. 1 or 2).
2165 If you want to play with the level variables, you should show some care.
2166 Set them once, and don't touch them ever again. Better yet, don't touch
2167 them at all unless you know exactly what you're doing.
2169 @vindex gnus-level-default-unsubscribed
2170 @vindex gnus-level-default-subscribed
2171 Two closely related variables are @code{gnus-level-default-subscribed}
2172 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2173 which are the levels that new groups will be put on if they are
2174 (un)subscribed. These two variables should, of course, be inside the
2175 relevant valid ranges.
2177 @vindex gnus-keep-same-level
2178 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2179 will only move to groups of the same level (or lower). In
2180 particular, going from the last article in one group to the next group
2181 will go to the next group of the same level (or lower). This might be
2182 handy if you want to read the most important groups before you read the
2185 If this variable is @code{best}, Gnus will make the next newsgroup the
2186 one with the best level.
2188 @vindex gnus-group-default-list-level
2189 All groups with a level less than or equal to
2190 @code{gnus-group-default-list-level} will be listed in the group buffer
2193 @vindex gnus-group-list-inactive-groups
2194 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2195 groups will be listed along with the unread groups. This variable is
2196 @code{t} by default. If it is @code{nil}, inactive groups won't be
2199 @vindex gnus-group-use-permanent-levels
2200 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2201 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2202 use this level as the ``work'' level.
2204 @vindex gnus-activate-level
2205 Gnus will normally just activate (i. e., query the server about) groups
2206 on level @code{gnus-activate-level} or less. If you don't want to
2207 activate unsubscribed groups, for instance, you might set this variable
2208 to 5. The default is 6.
2212 @section Group Score
2217 You would normally keep important groups on high levels, but that scheme
2218 is somewhat restrictive. Don't you wish you could have Gnus sort the
2219 group buffer according to how often you read groups, perhaps? Within
2222 This is what @dfn{group score} is for. You can have Gnus assign a score
2223 to each group through the mechanism described below. You can then sort
2224 the group buffer based on this score. Alternatively, you can sort on
2225 score and then level. (Taken together, the level and the score is
2226 called the @dfn{rank} of the group. A group that is on level 4 and has
2227 a score of 1 has a higher rank than a group on level 5 that has a score
2228 of 300. (The level is the most significant part and the score is the
2229 least significant part.))
2231 @findex gnus-summary-bubble-group
2232 If you want groups you read often to get higher scores than groups you
2233 read seldom you can add the @code{gnus-summary-bubble-group} function to
2234 the @code{gnus-summary-exit-hook} hook. This will result (after
2235 sorting) in a bubbling sort of action. If you want to see that in
2236 action after each summary exit, you can add
2237 @code{gnus-group-sort-groups-by-rank} or
2238 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2239 slow things down somewhat.
2242 @node Marking Groups
2243 @section Marking Groups
2244 @cindex marking groups
2246 If you want to perform some command on several groups, and they appear
2247 subsequently in the group buffer, you would normally just give a
2248 numerical prefix to the command. Most group commands will then do your
2249 bidding on those groups.
2251 However, if the groups are not in sequential order, you can still
2252 perform a command on several groups. You simply mark the groups first
2253 with the process mark and then execute the command.
2261 @findex gnus-group-mark-group
2262 Set the mark on the current group (@code{gnus-group-mark-group}).
2268 @findex gnus-group-unmark-group
2269 Remove the mark from the current group
2270 (@code{gnus-group-unmark-group}).
2274 @findex gnus-group-unmark-all-groups
2275 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2279 @findex gnus-group-mark-region
2280 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2284 @findex gnus-group-mark-buffer
2285 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2289 @findex gnus-group-mark-regexp
2290 Mark all groups that match some regular expression
2291 (@code{gnus-group-mark-regexp}).
2294 Also @pxref{Process/Prefix}.
2296 @findex gnus-group-universal-argument
2297 If you want to execute some command on all groups that have been marked
2298 with the process mark, you can use the @kbd{M-&}
2299 (@code{gnus-group-universal-argument}) command. It will prompt you for
2300 the command to be executed.
2303 @node Foreign Groups
2304 @section Foreign Groups
2305 @cindex foreign groups
2307 Below are some group mode commands for making and editing general foreign
2308 groups, as well as commands to ease the creation of a few
2309 special-purpose groups. All these commands insert the newly created
2310 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2317 @findex gnus-group-make-group
2318 @cindex making groups
2319 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2320 for a name, a method and possibly an @dfn{address}. For an easier way
2321 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
2325 @findex gnus-group-rename-group
2326 @cindex renaming groups
2327 Rename the current group to something else
2328 (@code{gnus-group-rename-group}). This is valid only on some
2329 groups---mail groups mostly. This command might very well be quite slow
2335 @findex gnus-group-customize
2336 Customize the group parameters (@code{gnus-group-customize}).
2340 @findex gnus-group-edit-group-method
2341 @cindex renaming groups
2342 Enter a buffer where you can edit the select method of the current
2343 group (@code{gnus-group-edit-group-method}).
2347 @findex gnus-group-edit-group-parameters
2348 Enter a buffer where you can edit the group parameters
2349 (@code{gnus-group-edit-group-parameters}).
2353 @findex gnus-group-edit-group
2354 Enter a buffer where you can edit the group info
2355 (@code{gnus-group-edit-group}).
2359 @findex gnus-group-make-directory-group
2361 Make a directory group (@pxref{Directory Groups}). You will be prompted
2362 for a directory name (@code{gnus-group-make-directory-group}).
2367 @findex gnus-group-make-help-group
2368 Make the Gnus help group (@code{gnus-group-make-help-group}).
2372 @cindex (ding) archive
2373 @cindex archive group
2374 @findex gnus-group-make-archive-group
2375 @vindex gnus-group-archive-directory
2376 @vindex gnus-group-recent-archive-directory
2377 Make a Gnus archive group (@code{gnus-group-make-archive-group}). By
2378 default a group pointing to the most recent articles will be created
2379 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2380 group will be created from @code{gnus-group-archive-directory}.
2384 @findex gnus-group-make-kiboze-group
2386 Make a kiboze group. You will be prompted for a name, for a regexp to
2387 match groups to be ``included'' in the kiboze group, and a series of
2388 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2389 @xref{Kibozed Groups}.
2393 @findex gnus-group-enter-directory
2395 Read an arbitrary directory as if it were a newsgroup with the
2396 @code{nneething} backend (@code{gnus-group-enter-directory}).
2397 @xref{Anything Groups}.
2401 @findex gnus-group-make-doc-group
2402 @cindex ClariNet Briefs
2404 Make a group based on some file or other
2405 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2406 command, you will be prompted for a file name and a file type.
2407 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
2408 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
2409 @code{rfc934}, @code{rfc822-forward}, @code{nsmail} and @code{forward}.
2410 If you run this command without a prefix, Gnus will guess at the file
2411 type. @xref{Document Groups}.
2415 @vindex gnus-useful-groups
2416 @findex gnus-group-make-useful-group
2417 Create one of the groups mentioned in @code{gnus-useful-groups}
2418 (@code{gnus-group-make-useful-group}).
2422 @findex gnus-group-make-web-group
2427 Make an ephemeral group based on a web search
2428 (@code{gnus-group-make-web-group}). If you give a prefix to this
2429 command, make a solid group instead. You will be prompted for the
2430 search engine type and the search string. Valid search engine types
2431 include @code{dejanews}, @code{altavista} and @code{reference}.
2432 @xref{Web Searches}.
2434 If you use the @code{dejanews} search engine, you can limit the search
2435 to a particular group by using a match string like
2436 @samp{~g alt.sysadmin.recovery shaving}.
2439 @kindex G DEL (Group)
2440 @findex gnus-group-delete-group
2441 This function will delete the current group
2442 (@code{gnus-group-delete-group}). If given a prefix, this function will
2443 actually delete all the articles in the group, and forcibly remove the
2444 group itself from the face of the Earth. Use a prefix only if you are
2445 absolutely sure of what you are doing. This command can't be used on
2446 read-only groups (like @code{nntp} group), though.
2450 @findex gnus-group-make-empty-virtual
2451 Make a new, fresh, empty @code{nnvirtual} group
2452 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2456 @findex gnus-group-add-to-virtual
2457 Add the current group to an @code{nnvirtual} group
2458 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2461 @xref{Select Methods}, for more information on the various select
2464 @vindex gnus-activate-foreign-newsgroups
2465 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2466 Gnus will check all foreign groups with this level or lower at startup.
2467 This might take quite a while, especially if you subscribe to lots of
2468 groups from different @sc{nntp} servers. Also @pxref{Group Levels};
2469 @code{gnus-activate-level} also affects activation of foreign
2473 @node Group Parameters
2474 @section Group Parameters
2475 @cindex group parameters
2477 The group parameters store information local to a particular group.
2478 Here's an example group parameter list:
2481 ((to-address . "ding@@gnus.org")
2485 We see that each element consists of a "dotted pair"---the thing before
2486 the dot is the key, while the thing after the dot is the value. All the
2487 parameters have this form @emph{except} local variable specs, which are
2488 not dotted pairs, but proper lists.
2490 The following group parameters can be used:
2495 Address used by when doing followups and new posts.
2498 (to-address . "some@@where.com")
2501 This is primarily useful in mail groups that represent closed mailing
2502 lists---mailing lists where it's expected that everybody that writes to
2503 the mailing list is subscribed to it. Since using this parameter
2504 ensures that the mail only goes to the mailing list itself, it means
2505 that members won't receive two copies of your followups.
2507 Using @code{to-address} will actually work whether the group is foreign
2508 or not. Let's say there's a group on the server that is called
2509 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2510 the articles from a mail-to-news gateway. Posting directly to this
2511 group is therefore impossible---you have to send mail to the mailing
2512 list address instead.
2516 Address used when doing @kbd{a} in that group.
2519 (to-list . "some@@where.com")
2522 It is totally ignored
2523 when doing a followup---except that if it is present in a news group,
2524 you'll get mail group semantics when doing @kbd{f}.
2526 If you do an @kbd{a} command in a mail group and you have neither a
2527 @code{to-list} group parameter nor a @code{to-address} group parameter,
2528 then a @code{to-list} group parameter will be added automatically upon
2529 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2530 @vindex gnus-add-to-list
2532 If you do an @kbd{a} command in a mail group and you don't have a
2533 @code{to-list} group parameter, one will be added automatically upon
2534 sending the message.
2538 If the group parameter list has the element @code{(visible . t)},
2539 that group will always be visible in the Group buffer, regardless
2540 of whether it has any unread articles.
2542 @item broken-reply-to
2543 @cindex broken-reply-to
2544 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2545 headers in this group are to be ignored. This can be useful if you're
2546 reading a mailing list group where the listserv has inserted
2547 @code{Reply-To} headers that point back to the listserv itself. This is
2548 broken behavior. So there!
2552 Elements like @code{(to-group . "some.group.name")} means that all
2553 posts in that group will be sent to @code{some.group.name}.
2557 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2558 will treat all responses as if they were responses to news articles.
2559 This can be useful if you have a mail group that's really a mirror of a
2564 If @code{(gcc-self . t)} is present in the group parameter list, newly
2565 composed messages will be @code{Gcc}'d to the current group. If
2566 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2567 generated, if @code{(gcc-self . "string")} is present, this string will
2568 be inserted literally as a @code{gcc} header. This parameter takes
2569 precedence over any default @code{Gcc} rules as described later
2570 (@pxref{Archived Messages}).
2574 If the group parameter has an element that looks like @code{(auto-expire
2575 . t)}, all articles read will be marked as expirable. For an
2576 alternative approach, @pxref{Expiring Mail}.
2579 @cindex total-expire
2580 If the group parameter has an element that looks like
2581 @code{(total-expire . t)}, all read articles will be put through the
2582 expiry process, even if they are not marked as expirable. Use with
2583 caution. Unread, ticked and dormant articles are not eligible for
2588 @vindex nnmail-expiry-wait-function
2589 If the group parameter has an element that looks like @code{(expiry-wait
2590 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2591 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2592 The value can either be a number of days (not necessarily an integer) or
2593 the symbols @code{never} or @code{immediate}.
2596 @cindex score file group parameter
2597 Elements that look like @code{(score-file . "file")} will make
2598 @file{file} into the current score file for the group in question. All
2599 interactive score entries will be put into this file.
2602 @cindex adapt file group parameter
2603 Elements that look like @code{(adapt-file . "file")} will make
2604 @file{file} into the current adaptive file for the group in question.
2605 All adaptive score entries will be put into this file.
2608 When unsubscribing from a mailing list you should never send the
2609 unsubscription notice to the mailing list itself. Instead, you'd send
2610 messages to the administrative address. This parameter allows you to
2611 put the admin address somewhere convenient.
2614 Elements that look like @code{(display . MODE)} say which articles to
2615 display on entering the group. Valid values are:
2619 Display all articles, both read and unread.
2622 Display the default visible articles, which normally includes unread and
2627 Elements that look like @code{(comment . "This is a comment")}
2628 are arbitrary comments on the group. They are currently ignored by
2629 Gnus, but provide a place for you to store information on particular
2633 Elements that look like @code{(charset . iso-8859-1)} will make
2634 @code{iso-8859-1} the default charset; that is, the charset that will be
2635 used for all articles that do not specify a charset.
2637 @item (@var{variable} @var{form})
2638 You can use the group parameters to set variables local to the group you
2639 are entering. If you want to turn threading off in @samp{news.answers},
2640 you could put @code{(gnus-show-threads nil)} in the group parameters of
2641 that group. @code{gnus-show-threads} will be made into a local variable
2642 in the summary buffer you enter, and the form @code{nil} will be
2643 @code{eval}ed there.
2645 This can also be used as a group-specific hook function, if you'd like.
2646 If you want to hear a beep when you enter a group, you could put
2647 something like @code{(dummy-variable (ding))} in the parameters of that
2648 group. @code{dummy-variable} will be set to the result of the
2649 @code{(ding)} form, but who cares?
2652 You can store additional posting style information for this group only
2653 here (@pxref{Posting Styles}). The format is that of an entry in the
2654 @code{gnus-posting-styles} alist, except that there's no regexp matching
2655 the group name (of course). Style elements in this group parameter will
2656 take precedence over the ones found in @code{gnus-posting-styles}.
2658 For instance, if you want a funky name and signature in this group only,
2659 instead of hacking @code{gnus-posting-styles}, you could put something
2660 like this in the group parameters:
2665 (signature "Funky Signature"))
2670 Use the @kbd{G p} command to edit group parameters of a group. You
2671 might also be interested in reading about topic parameters (@pxref{Topic
2675 @node Listing Groups
2676 @section Listing Groups
2677 @cindex group listing
2679 These commands all list various slices of the groups available.
2687 @findex gnus-group-list-groups
2688 List all groups that have unread articles
2689 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
2690 command will list only groups of level ARG and lower. By default, it
2691 only lists groups of level five (i. e.,
2692 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2699 @findex gnus-group-list-all-groups
2700 List all groups, whether they have unread articles or not
2701 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
2702 this command will list only groups of level ARG and lower. By default,
2703 it lists groups of level seven or lower (i.e., just subscribed and
2704 unsubscribed groups).
2708 @findex gnus-group-list-level
2709 List all unread groups on a specific level
2710 (@code{gnus-group-list-level}). If given a prefix, also list the groups
2711 with no unread articles.
2715 @findex gnus-group-list-killed
2716 List all killed groups (@code{gnus-group-list-killed}). If given a
2717 prefix argument, really list all groups that are available, but aren't
2718 currently (un)subscribed. This could entail reading the active file
2723 @findex gnus-group-list-zombies
2724 List all zombie groups (@code{gnus-group-list-zombies}).
2728 @findex gnus-group-list-matching
2729 List all unread, subscribed groups with names that match a regexp
2730 (@code{gnus-group-list-matching}).
2734 @findex gnus-group-list-all-matching
2735 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2739 @findex gnus-group-list-active
2740 List absolutely all groups in the active file(s) of the
2741 server(s) you are connected to (@code{gnus-group-list-active}). This
2742 might very well take quite a while. It might actually be a better idea
2743 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2744 thing to match on. Also note that this command may list groups that
2745 don't exist (yet)---these will be listed as if they were killed groups.
2746 Take the output with some grains of salt.
2750 @findex gnus-group-apropos
2751 List all groups that have names that match a regexp
2752 (@code{gnus-group-apropos}).
2756 @findex gnus-group-description-apropos
2757 List all groups that have names or descriptions that match a regexp
2758 (@code{gnus-group-description-apropos}).
2762 @findex gnus-group-list-cached
2763 List all groups with cached articles (@code{gnus-group-list-cached}).
2767 @findex gnus-group-list-dormant
2768 List all groups with dormant articles (@code{gnus-group-list-dormant}).
2772 @vindex gnus-permanently-visible-groups
2773 @cindex visible group parameter
2774 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2775 always be shown, whether they have unread articles or not. You can also
2776 add the @code{visible} element to the group parameters in question to
2777 get the same effect.
2779 @vindex gnus-list-groups-with-ticked-articles
2780 Groups that have just ticked articles in it are normally listed in the
2781 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
2782 @code{nil}, these groups will be treated just like totally empty
2783 groups. It is @code{t} by default.
2786 @node Sorting Groups
2787 @section Sorting Groups
2788 @cindex sorting groups
2790 @kindex C-c C-s (Group)
2791 @findex gnus-group-sort-groups
2792 @vindex gnus-group-sort-function
2793 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2794 group buffer according to the function(s) given by the
2795 @code{gnus-group-sort-function} variable. Available sorting functions
2800 @item gnus-group-sort-by-alphabet
2801 @findex gnus-group-sort-by-alphabet
2802 Sort the group names alphabetically. This is the default.
2804 @item gnus-group-sort-by-real-name
2805 @findex gnus-group-sort-by-real-name
2806 Sort the group alphabetically on the real (unprefixed) group names.
2808 @item gnus-group-sort-by-level
2809 @findex gnus-group-sort-by-level
2810 Sort by group level.
2812 @item gnus-group-sort-by-score
2813 @findex gnus-group-sort-by-score
2814 Sort by group score. @xref{Group Score}.
2816 @item gnus-group-sort-by-rank
2817 @findex gnus-group-sort-by-rank
2818 Sort by group score and then the group level. The level and the score
2819 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
2821 @item gnus-group-sort-by-unread
2822 @findex gnus-group-sort-by-unread
2823 Sort by number of unread articles.
2825 @item gnus-group-sort-by-method
2826 @findex gnus-group-sort-by-method
2827 Sort alphabetically on the select method.
2832 @code{gnus-group-sort-function} can also be a list of sorting
2833 functions. In that case, the most significant sort key function must be
2837 There are also a number of commands for sorting directly according to
2838 some sorting criteria:
2842 @kindex G S a (Group)
2843 @findex gnus-group-sort-groups-by-alphabet
2844 Sort the group buffer alphabetically by group name
2845 (@code{gnus-group-sort-groups-by-alphabet}).
2848 @kindex G S u (Group)
2849 @findex gnus-group-sort-groups-by-unread
2850 Sort the group buffer by the number of unread articles
2851 (@code{gnus-group-sort-groups-by-unread}).
2854 @kindex G S l (Group)
2855 @findex gnus-group-sort-groups-by-level
2856 Sort the group buffer by group level
2857 (@code{gnus-group-sort-groups-by-level}).
2860 @kindex G S v (Group)
2861 @findex gnus-group-sort-groups-by-score
2862 Sort the group buffer by group score
2863 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
2866 @kindex G S r (Group)
2867 @findex gnus-group-sort-groups-by-rank
2868 Sort the group buffer by group rank
2869 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
2872 @kindex G S m (Group)
2873 @findex gnus-group-sort-groups-by-method
2874 Sort the group buffer alphabetically by backend name
2875 (@code{gnus-group-sort-groups-by-method}).
2879 All the commands below obey the process/prefix convention
2880 (@pxref{Process/Prefix}).
2882 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
2883 commands will sort in reverse order.
2885 You can also sort a subset of the groups:
2889 @kindex G P a (Group)
2890 @findex gnus-group-sort-selected-groups-by-alphabet
2891 Sort the groups alphabetically by group name
2892 (@code{gnus-group-sort-selected-groups-by-alphabet}).
2895 @kindex G P u (Group)
2896 @findex gnus-group-sort-selected-groups-by-unread
2897 Sort the groups by the number of unread articles
2898 (@code{gnus-group-sort-selected-groups-by-unread}).
2901 @kindex G P l (Group)
2902 @findex gnus-group-sort-selected-groups-by-level
2903 Sort the groups by group level
2904 (@code{gnus-group-sort-selected-groups-by-level}).
2907 @kindex G P v (Group)
2908 @findex gnus-group-sort-selected-groups-by-score
2909 Sort the groups by group score
2910 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
2913 @kindex G P r (Group)
2914 @findex gnus-group-sort-selected-groups-by-rank
2915 Sort the groups by group rank
2916 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
2919 @kindex G P m (Group)
2920 @findex gnus-group-sort-selected-groups-by-method
2921 Sort the groups alphabetically by backend name
2922 (@code{gnus-group-sort-selected-groups-by-method}).
2928 @node Group Maintenance
2929 @section Group Maintenance
2930 @cindex bogus groups
2935 @findex gnus-group-check-bogus-groups
2936 Find bogus groups and delete them
2937 (@code{gnus-group-check-bogus-groups}).
2941 @findex gnus-group-find-new-groups
2942 Find new groups and process them (@code{gnus-group-find-new-groups}).
2943 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
2944 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
2945 to query the server for new groups, and subscribe the new groups as
2949 @kindex C-c C-x (Group)
2950 @findex gnus-group-expire-articles
2951 Run all expirable articles in the current group through the expiry
2952 process (if any) (@code{gnus-group-expire-articles}).
2955 @kindex C-c M-C-x (Group)
2956 @findex gnus-group-expire-all-groups
2957 Run all articles in all groups through the expiry process
2958 (@code{gnus-group-expire-all-groups}).
2963 @node Browse Foreign Server
2964 @section Browse Foreign Server
2965 @cindex foreign servers
2966 @cindex browsing servers
2971 @findex gnus-group-browse-foreign-server
2972 You will be queried for a select method and a server name. Gnus will
2973 then attempt to contact this server and let you browse the groups there
2974 (@code{gnus-group-browse-foreign-server}).
2977 @findex gnus-browse-mode
2978 A new buffer with a list of available groups will appear. This buffer
2979 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
2980 a lot) like a normal group buffer.
2982 Here's a list of keystrokes available in the browse mode:
2987 @findex gnus-group-next-group
2988 Go to the next group (@code{gnus-group-next-group}).
2992 @findex gnus-group-prev-group
2993 Go to the previous group (@code{gnus-group-prev-group}).
2996 @kindex SPACE (Browse)
2997 @findex gnus-browse-read-group
2998 Enter the current group and display the first article
2999 (@code{gnus-browse-read-group}).
3002 @kindex RET (Browse)
3003 @findex gnus-browse-select-group
3004 Enter the current group (@code{gnus-browse-select-group}).
3008 @findex gnus-browse-unsubscribe-current-group
3009 Unsubscribe to the current group, or, as will be the case here,
3010 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3016 @findex gnus-browse-exit
3017 Exit browse mode (@code{gnus-browse-exit}).
3021 @findex gnus-browse-describe-briefly
3022 Describe browse mode briefly (well, there's not much to describe, is
3023 there) (@code{gnus-browse-describe-briefly}).
3028 @section Exiting Gnus
3029 @cindex exiting Gnus
3031 Yes, Gnus is ex(c)iting.
3036 @findex gnus-group-suspend
3037 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
3038 but it kills all buffers except the Group buffer. I'm not sure why this
3039 is a gain, but then who am I to judge?
3043 @findex gnus-group-exit
3044 @c @icon{gnus-group-exit}
3045 Quit Gnus (@code{gnus-group-exit}).
3049 @findex gnus-group-quit
3050 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3051 The dribble file will be saved, though (@pxref{Auto Save}).
3054 @vindex gnus-exit-gnus-hook
3055 @vindex gnus-suspend-gnus-hook
3056 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
3057 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
3058 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3063 If you wish to completely unload Gnus and all its adherents, you can use
3064 the @code{gnus-unload} command. This command is also very handy when
3065 trying to customize meta-variables.
3070 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3071 numbly heavy and herself fall into a hazy trance as the boy sitting
3072 behind her drew repeated lines with his pencil across the back of her
3078 @section Group Topics
3081 If you read lots and lots of groups, it might be convenient to group
3082 them hierarchically according to topics. You put your Emacs groups over
3083 here, your sex groups over there, and the rest (what, two groups or so?)
3084 you put in some misc section that you never bother with anyway. You can
3085 even group the Emacs sex groups as a sub-topic to either the Emacs
3086 groups or the sex groups---or both! Go wild!
3090 \gnusfigure{Group Topics}{400}{
3091 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
3102 2: alt.religion.emacs
3105 0: comp.talk.emacs.recovery
3107 8: comp.binaries.fractals
3108 13: comp.sources.unix
3111 @findex gnus-topic-mode
3113 To get this @emph{fab} functionality you simply turn on (ooh!) the
3114 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3115 is a toggling command.)
3117 Go ahead, just try it. I'll still be here when you get back. La de
3118 dum... Nice tune, that... la la la... What, you're back? Yes, and now
3119 press @kbd{l}. There. All your groups are now listed under
3120 @samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and
3123 If you want this permanently enabled, you should add that minor mode to
3124 the hook for the group mode:
3127 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3131 * Topic Variables:: How to customize the topics the Lisp Way.
3132 * Topic Commands:: Interactive E-Z commands.
3133 * Topic Sorting:: Sorting each topic individually.
3134 * Topic Topology:: A map of the world.
3135 * Topic Parameters:: Parameters that apply to all groups in a topic.
3139 @node Topic Variables
3140 @subsection Topic Variables
3141 @cindex topic variables
3143 Now, if you select a topic, it will fold/unfold that topic, which is
3144 really neat, I think.
3146 @vindex gnus-topic-line-format
3147 The topic lines themselves are created according to the
3148 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3161 Number of groups in the topic.
3163 Number of unread articles in the topic.
3165 Number of unread articles in the topic and all its subtopics.
3168 @vindex gnus-topic-indent-level
3169 Each sub-topic (and the groups in the sub-topics) will be indented with
3170 @code{gnus-topic-indent-level} times the topic level number of spaces.
3173 @vindex gnus-topic-mode-hook
3174 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3176 @vindex gnus-topic-display-empty-topics
3177 The @code{gnus-topic-display-empty-topics} says whether to display even
3178 topics that have no unread articles in them. The default is @code{t}.
3181 @node Topic Commands
3182 @subsection Topic Commands
3183 @cindex topic commands
3185 When the topic minor mode is turned on, a new @kbd{T} submap will be
3186 available. In addition, a few of the standard keys change their
3187 definitions slightly.
3193 @findex gnus-topic-create-topic
3194 Prompt for a new topic name and create it
3195 (@code{gnus-topic-create-topic}).
3199 @findex gnus-topic-move-group
3200 Move the current group to some other topic
3201 (@code{gnus-topic-move-group}). This command uses the process/prefix
3202 convention (@pxref{Process/Prefix}).
3206 @findex gnus-topic-jump-to-topic
3207 Go to a topic (@code{gnus-topic-jump-to-topic}).
3211 @findex gnus-topic-copy-group
3212 Copy the current group to some other topic
3213 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3214 convention (@pxref{Process/Prefix}).
3218 @findex gnus-topic-hide-topic
3219 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3220 a prefix, hide the topic permanently.
3224 @findex gnus-topic-show-topic
3225 Show the current topic (@code{gnus-topic-show-topic}). If given
3226 a prefix, show the topic permanently.
3230 @findex gnus-topic-remove-group
3231 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3232 This command is mainly useful if you have the same group in several
3233 topics and wish to remove it from one of the topics. You may also
3234 remove a group from all topics, but in that case, Gnus will add it to
3235 the root topic the next time you start Gnus. In fact, all new groups
3236 (which, naturally, don't belong to any topic) will show up in the root
3239 This command uses the process/prefix convention
3240 (@pxref{Process/Prefix}).
3244 @findex gnus-topic-move-matching
3245 Move all groups that match some regular expression to a topic
3246 (@code{gnus-topic-move-matching}).
3250 @findex gnus-topic-copy-matching
3251 Copy all groups that match some regular expression to a topic
3252 (@code{gnus-topic-copy-matching}).
3256 @findex gnus-topic-toggle-display-empty-topics
3257 Toggle hiding empty topics
3258 (@code{gnus-topic-toggle-display-empty-topics}).
3262 @findex gnus-topic-mark-topic
3263 Mark all groups in the current topic with the process mark
3264 (@code{gnus-topic-mark-topic}).
3267 @kindex T M-# (Topic)
3268 @findex gnus-topic-unmark-topic
3269 Remove the process mark from all groups in the current topic
3270 (@code{gnus-topic-unmark-topic}).
3274 @kindex T TAB (Topic)
3276 @findex gnus-topic-indent
3277 ``Indent'' the current topic so that it becomes a sub-topic of the
3278 previous topic (@code{gnus-topic-indent}). If given a prefix,
3279 ``un-indent'' the topic instead.
3282 @kindex M-TAB (Topic)
3283 @findex gnus-topic-unindent
3284 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3285 parent of its current parent (@code{gnus-topic-unindent}).
3289 @findex gnus-topic-select-group
3291 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3292 When you perform this command on a group, you'll enter the group, as
3293 usual. When done on a topic line, the topic will be folded (if it was
3294 visible) or unfolded (if it was folded already). So it's basically a
3295 toggling command on topics. In addition, if you give a numerical
3296 prefix, group on that level (and lower) will be displayed.
3299 @kindex C-c C-x (Topic)
3300 @findex gnus-topic-expire-articles
3301 Run all expirable articles in the current group or topic through the expiry
3302 process (if any) (@code{gnus-topic-expire-articles}).
3306 @findex gnus-topic-kill-group
3307 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3308 topic will be removed along with the topic.
3312 @findex gnus-topic-yank-group
3313 Yank the previously killed group or topic
3314 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3319 @findex gnus-topic-rename
3320 Rename a topic (@code{gnus-topic-rename}).
3323 @kindex T DEL (Topic)
3324 @findex gnus-topic-delete
3325 Delete an empty topic (@code{gnus-topic-delete}).
3329 @findex gnus-topic-list-active
3330 List all groups that Gnus knows about in a topics-ified way
3331 (@code{gnus-topic-list-active}).
3335 @findex gnus-topic-edit-parameters
3336 @cindex group parameters
3337 @cindex topic parameters
3339 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3340 @xref{Topic Parameters}.
3346 @subsection Topic Sorting
3347 @cindex topic sorting
3349 You can sort the groups in each topic individually with the following
3355 @kindex T S a (Topic)
3356 @findex gnus-topic-sort-groups-by-alphabet
3357 Sort the current topic alphabetically by group name
3358 (@code{gnus-topic-sort-groups-by-alphabet}).
3361 @kindex T S u (Topic)
3362 @findex gnus-topic-sort-groups-by-unread
3363 Sort the current topic by the number of unread articles
3364 (@code{gnus-topic-sort-groups-by-unread}).
3367 @kindex T S l (Topic)
3368 @findex gnus-topic-sort-groups-by-level
3369 Sort the current topic by group level
3370 (@code{gnus-topic-sort-groups-by-level}).
3373 @kindex T S v (Topic)
3374 @findex gnus-topic-sort-groups-by-score
3375 Sort the current topic by group score
3376 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
3379 @kindex T S r (Topic)
3380 @findex gnus-topic-sort-groups-by-rank
3381 Sort the current topic by group rank
3382 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
3385 @kindex T S m (Topic)
3386 @findex gnus-topic-sort-groups-by-method
3387 Sort the current topic alphabetically by backend name
3388 (@code{gnus-topic-sort-groups-by-method}).
3392 @xref{Sorting Groups}, for more information about group sorting.
3395 @node Topic Topology
3396 @subsection Topic Topology
3397 @cindex topic topology
3400 So, let's have a look at an example group buffer:
3406 2: alt.religion.emacs
3409 0: comp.talk.emacs.recovery
3411 8: comp.binaries.fractals
3412 13: comp.sources.unix
3415 So, here we have one top-level topic (@samp{Gnus}), two topics under
3416 that, and one sub-topic under one of the sub-topics. (There is always
3417 just one (1) top-level topic). This topology can be expressed as
3422 (("Emacs -- I wuw it!" visible)
3423 (("Naughty Emacs" visible)))
3427 @vindex gnus-topic-topology
3428 This is in fact how the variable @code{gnus-topic-topology} would look
3429 for the display above. That variable is saved in the @file{.newsrc.eld}
3430 file, and shouldn't be messed with manually---unless you really want
3431 to. Since this variable is read from the @file{.newsrc.eld} file,
3432 setting it in any other startup files will have no effect.
3434 This topology shows what topics are sub-topics of what topics (right),
3435 and which topics are visible. Two settings are currently
3436 allowed---@code{visible} and @code{invisible}.
3439 @node Topic Parameters
3440 @subsection Topic Parameters
3441 @cindex topic parameters
3443 All groups in a topic will inherit group parameters from the parent (and
3444 ancestor) topic parameters. All valid group parameters are valid topic
3445 parameters (@pxref{Group Parameters}).
3447 In addition, the following parameters are only valid as topic
3452 When subscribing new groups by topic (@pxref{Subscription Methods}), the
3453 @code{subscribe} topic parameter says what groups go in what topic. Its
3454 value should be a regexp to match the groups that should go in that
3459 Group parameters (of course) override topic parameters, and topic
3460 parameters in sub-topics override topic parameters in super-topics. You
3461 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
3462 verb, although you may feel free to disagree with me here.)
3468 2: alt.religion.emacs
3472 0: comp.talk.emacs.recovery
3474 8: comp.binaries.fractals
3475 13: comp.sources.unix
3479 The @samp{Emacs} topic has the topic parameter @code{(score-file
3480 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
3481 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
3482 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
3483 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
3484 . "religion.SCORE")}.
3486 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
3487 will get the @file{relief.SCORE} home score file. If you enter the same
3488 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
3489 score file. If you enter the group @samp{alt.religion.emacs}, you'll
3490 get the @file{religion.SCORE} home score file.
3492 This seems rather simple and self-evident, doesn't it? Well, yes. But
3493 there are some problems, especially with the @code{total-expiry}
3494 parameter. Say you have a mail group in two topics; one with
3495 @code{total-expiry} and one without. What happens when you do @kbd{M-x
3496 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
3497 of these topics you mean to expire articles from, so anything may
3498 happen. In fact, I hereby declare that it is @dfn{undefined} what
3499 happens. You just have to be careful if you do stuff like that.
3502 @node Misc Group Stuff
3503 @section Misc Group Stuff
3506 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
3507 * Group Information:: Information and help on groups and Gnus.
3508 * Group Timestamp:: Making Gnus keep track of when you last read a group.
3509 * File Commands:: Reading and writing the Gnus files.
3516 @findex gnus-group-enter-server-mode
3517 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3518 @xref{The Server Buffer}.
3522 @findex gnus-group-post-news
3523 Post an article to a group (@code{gnus-group-post-news}). If given a
3524 prefix, the current group name will be used as the default.
3528 @findex gnus-group-mail
3529 Mail a message somewhere (@code{gnus-group-mail}).
3533 Variables for the group buffer:
3537 @item gnus-group-mode-hook
3538 @vindex gnus-group-mode-hook
3539 is called after the group buffer has been
3542 @item gnus-group-prepare-hook
3543 @vindex gnus-group-prepare-hook
3544 is called after the group buffer is
3545 generated. It may be used to modify the buffer in some strange,
3548 @item gnus-group-prepared-hook
3549 @vindex gnus-group-prepare-hook
3550 is called as the very last thing after the group buffer has been
3551 generated. It may be used to move point around, for instance.
3553 @item gnus-permanently-visible-groups
3554 @vindex gnus-permanently-visible-groups
3555 Groups matching this regexp will always be listed in the group buffer,
3556 whether they are empty or not.
3558 @item gnus-group-name-charset-method-alist
3559 @vindex gnus-group-name-charset-method-alist
3560 An alist of method and the charset for group names. It is used to show
3561 non-ASCII group names.
3565 (setq gnus-group-name-charset-method-alist
3566 '(((nntp "news.com.cn") . cn-gb-2312)))
3569 @item gnus-group-name-charset-group-alist
3570 @vindex gnus-group-name-charset-group-alist
3571 An alist of regexp of group name and the charset for group names.
3572 It is used to show non-ASCII group names.
3576 (setq gnus-group-name-charset-group-alist
3577 '(("\\.com\\.cn:" . cn-gb-2312)))
3582 @node Scanning New Messages
3583 @subsection Scanning New Messages
3584 @cindex new messages
3585 @cindex scanning new news
3591 @findex gnus-group-get-new-news
3592 @c @icon{gnus-group-get-new-news}
3593 Check the server(s) for new articles. If the numerical prefix is used,
3594 this command will check only groups of level @var{arg} and lower
3595 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
3596 command will force a total re-reading of the active file(s) from the
3601 @findex gnus-group-get-new-news-this-group
3602 @vindex gnus-goto-next-group-when-activating
3603 @c @icon{gnus-group-get-new-news-this-group}
3604 Check whether new articles have arrived in the current group
3605 (@code{gnus-group-get-new-news-this-group}).
3606 @code{gnus-goto-next-group-when-activating} says whether this command is
3607 to move point to the next group or not. It is @code{t} by default.
3609 @findex gnus-activate-all-groups
3610 @cindex activating groups
3612 @kindex C-c M-g (Group)
3613 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3618 @findex gnus-group-restart
3619 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
3620 file(s), closes the connection to all servers, clears up all run-time
3621 Gnus variables, and then starts Gnus all over again.
3625 @vindex gnus-get-new-news-hook
3626 @code{gnus-get-new-news-hook} is run just before checking for new news.
3628 @vindex gnus-after-getting-new-news-hook
3629 @code{gnus-after-getting-new-news-hook} is run after checking for new
3633 @node Group Information
3634 @subsection Group Information
3635 @cindex group information
3636 @cindex information on groups
3643 @findex gnus-group-fetch-faq
3644 @vindex gnus-group-faq-directory
3647 Try to fetch the FAQ for the current group
3648 (@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from
3649 @code{gnus-group-faq-directory}, which is usually a directory on a
3650 remote machine. This variable can also be a list of directories. In
3651 that case, giving a prefix to this command will allow you to choose
3652 between the various sites. @code{ange-ftp} (or @code{efs}) will be used
3653 for fetching the file.
3655 If fetching from the first site is unsuccessful, Gnus will attempt to go
3656 through @code{gnus-group-faq-directory} and try to open them one by one.
3660 @c @icon{gnus-group-describe-group}
3662 @kindex C-c C-d (Group)
3663 @cindex describing groups
3664 @cindex group description
3665 @findex gnus-group-describe-group
3666 Describe the current group (@code{gnus-group-describe-group}). If given
3667 a prefix, force Gnus to re-read the description from the server.
3671 @findex gnus-group-describe-all-groups
3672 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
3673 prefix, force Gnus to re-read the description file from the server.
3680 @findex gnus-version
3681 Display current Gnus version numbers (@code{gnus-version}).
3685 @findex gnus-group-describe-briefly
3686 Give a very short help message (@code{gnus-group-describe-briefly}).
3689 @kindex C-c C-i (Group)
3692 @findex gnus-info-find-node
3693 Go to the Gnus info node (@code{gnus-info-find-node}).
3697 @node Group Timestamp
3698 @subsection Group Timestamp
3700 @cindex group timestamps
3702 It can be convenient to let Gnus keep track of when you last read a
3703 group. To set the ball rolling, you should add
3704 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3707 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3710 After doing this, each time you enter a group, it'll be recorded.
3712 This information can be displayed in various ways---the easiest is to
3713 use the @samp{%d} spec in the group line format:
3716 (setq gnus-group-line-format
3717 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3720 This will result in lines looking like:
3723 * 0: mail.ding 19961002T012943
3724 0: custom 19961002T012713
3727 As you can see, the date is displayed in compact ISO 8601 format. This
3728 may be a bit too much, so to just display the date, you could say
3732 (setq gnus-group-line-format
3733 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3738 @subsection File Commands
3739 @cindex file commands
3745 @findex gnus-group-read-init-file
3746 @vindex gnus-init-file
3747 @cindex reading init file
3748 Re-read the init file (@code{gnus-init-file}, which defaults to
3749 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3753 @findex gnus-group-save-newsrc
3754 @cindex saving .newsrc
3755 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3756 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
3757 file(s) whether Gnus thinks it is necessary or not.
3760 @c @kindex Z (Group)
3761 @c @findex gnus-group-clear-dribble
3762 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3767 @node The Summary Buffer
3768 @chapter The Summary Buffer
3769 @cindex summary buffer
3771 A line for each article is displayed in the summary buffer. You can
3772 move around, read articles, post articles and reply to articles.
3774 The most common way to a summary buffer is to select a group from the
3775 group buffer (@pxref{Selecting a Group}).
3777 You can have as many summary buffers open as you wish.
3780 * Summary Buffer Format:: Deciding how the summary buffer is to look.
3781 * Summary Maneuvering:: Moving around the summary buffer.
3782 * Choosing Articles:: Reading articles.
3783 * Paging the Article:: Scrolling the current article.
3784 * Reply Followup and Post:: Posting articles.
3785 * Marking Articles:: Marking articles as read, expirable, etc.
3786 * Limiting:: You can limit the summary buffer.
3787 * Threading:: How threads are made.
3788 * Sorting:: How articles and threads are sorted.
3789 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
3790 * Article Caching:: You may store articles in a cache.
3791 * Persistent Articles:: Making articles expiry-resistant.
3792 * Article Backlog:: Having already read articles hang around.
3793 * Saving Articles:: Ways of customizing article saving.
3794 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
3795 * Article Treatment:: The article buffer can be mangled at will.
3796 * MIME Commands:: Doing MIMEy things with the articles.
3797 * Charsets:: Character set issues.
3798 * Article Commands:: Doing various things with the article buffer.
3799 * Summary Sorting:: Sorting the summary buffer in various ways.
3800 * Finding the Parent:: No child support? Get the parent.
3801 * Alternative Approaches:: Reading using non-default summaries.
3802 * Tree Display:: A more visual display of threads.
3803 * Mail Group Commands:: Some commands can only be used in mail groups.
3804 * Various Summary Stuff:: What didn't fit anywhere else.
3805 * Exiting the Summary Buffer:: Returning to the Group buffer.
3806 * Crosspost Handling:: How crossposted articles are dealt with.
3807 * Duplicate Suppression:: An alternative when crosspost handling fails.
3811 @node Summary Buffer Format
3812 @section Summary Buffer Format
3813 @cindex summary buffer format
3817 \gnusfigure{The Summary Buffer}{180}{
3818 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3819 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3825 * Summary Buffer Lines:: You can specify how summary lines should look.
3826 * To From Newsgroups:: How to not display your own name.
3827 * Summary Buffer Mode Line:: You can say how the mode line should look.
3828 * Summary Highlighting:: Making the summary buffer all pretty and nice.
3831 @findex mail-extract-address-components
3832 @findex gnus-extract-address-components
3833 @vindex gnus-extract-address-components
3834 Gnus will use the value of the @code{gnus-extract-address-components}
3835 variable as a function for getting the name and address parts of a
3836 @code{From} header. Two pre-defined functions exist:
3837 @code{gnus-extract-address-components}, which is the default, quite
3838 fast, and too simplistic solution; and
3839 @code{mail-extract-address-components}, which works very nicely, but is
3840 slower. The default function will return the wrong answer in 5% of the
3841 cases. If this is unacceptable to you, use the other function instead:
3844 (setq gnus-extract-address-components
3845 'mail-extract-address-components)
3848 @vindex gnus-summary-same-subject
3849 @code{gnus-summary-same-subject} is a string indicating that the current
3850 article has the same subject as the previous. This string will be used
3851 with those specs that require it. The default is @code{""}.
3854 @node Summary Buffer Lines
3855 @subsection Summary Buffer Lines
3857 @vindex gnus-summary-line-format
3858 You can change the format of the lines in the summary buffer by changing
3859 the @code{gnus-summary-line-format} variable. It works along the same
3860 lines as a normal @code{format} string, with some extensions
3861 (@pxref{Formatting Variables}).
3863 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3865 The following format specification characters are understood:
3871 Subject string. List identifiers stripped,
3872 @code{gnus-list-identifies}. @xref{Article Hiding}.
3874 Subject if the article is the root of the thread or the previous article
3875 had a different subject, @code{gnus-summary-same-subject} otherwise.
3876 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3878 Full @code{From} header.
3880 The name (from the @code{From} header).
3882 The name, code @code{To} header or the @code{Newsgroups} header
3883 (@pxref{To From Newsgroups}).
3885 The name (from the @code{From} header). This differs from the @code{n}
3886 spec in that it uses the function designated by the
3887 @code{gnus-extract-address-components} variable, which is slower, but
3888 may be more thorough.
3890 The address (from the @code{From} header). This works the same way as
3893 Number of lines in the article.
3895 Number of characters in the article. This specifier is not supported in some
3896 methods (like nnfolder).
3898 Indentation based on thread level (@pxref{Customizing Threading}).
3900 Nothing if the article is a root and lots of spaces if it isn't (it
3901 pushes everything after it off the screen).
3903 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3904 for adopted articles (@pxref{Customizing Threading}).
3906 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3907 for adopted articles.
3909 One space for each thread level.
3911 Twenty minus thread level spaces.
3916 This misleadingly named specifier is the @dfn{secondary mark}. This
3917 mark will say whether the article has been replied to, has been cached,
3921 Score as a number (@pxref{Scoring}).
3923 @vindex gnus-summary-zcore-fuzz
3924 Zcore, @samp{+} if above the default level and @samp{-} if below the
3925 default level. If the difference between
3926 @code{gnus-summary-default-score} and the score is less than
3927 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3935 The @code{Date} in @code{DD-MMM} format.
3937 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3943 Number of articles in the current sub-thread. Using this spec will slow
3944 down summary buffer generation somewhat.
3946 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3947 article has any children.
3953 User defined specifier. The next character in the format string should
3954 be a letter. Gnus will call the function
3955 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3956 following @samp{%u}. The function will be passed the current header as
3957 argument. The function should return a string, which will be inserted
3958 into the summary just like information from any other summary specifier.
3961 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3962 have to be handled with care. For reasons of efficiency, Gnus will
3963 compute what column these characters will end up in, and ``hard-code''
3964 that. This means that it is invalid to have these specs after a
3965 variable-length spec. Well, you might not be arrested, but your summary
3966 buffer will look strange, which is bad enough.
3968 The smart choice is to have these specs as far to the left as possible.
3969 (Isn't that the case with everything, though? But I digress.)
3971 This restriction may disappear in later versions of Gnus.
3974 @node To From Newsgroups
3975 @subsection To From Newsgroups
3979 In some groups (particularly in archive groups), the @code{From} header
3980 isn't very interesting, since all the articles there are written by
3981 you. To display the information in the @code{To} or @code{Newsgroups}
3982 headers instead, you need to decide three things: What information to
3983 gather; where to display it; and when to display it.
3987 @vindex gnus-extra-headers
3988 The reading of extra header information is controlled by the
3989 @code{gnus-extra-headers}. This is a list of header symbols. For
3993 (setq gnus-extra-headers
3994 '(To Newsgroups X-Newsreader))
3997 This will result in Gnus trying to obtain these three headers, and
3998 storing it in header structures for later easy retrieval.
4001 @findex gnus-extra-header
4002 The value of these extra headers can be accessed via the
4003 @code{gnus-extra-header} function. Here's a format line spec that will
4004 access the @code{X-Newsreader} header:
4007 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4011 @vindex gnus-ignored-from-addresses
4012 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4013 summary line spec returns the @code{To}, @code{Newsreader} or
4014 @code{From} header. If this regexp matches the contents of the
4015 @code{From} header, the value of the @code{To} or @code{Newsreader}
4016 headers are used instead.
4020 @vindex nnmail-extra-headers
4021 A related variable is @code{nnmail-extra-headers}, which controls when
4022 to include extra headers when generating overview (@sc{nov}) files. If
4023 you have old overview files, you should regenerate them after changing
4026 @vindex gnus-summary-line-format
4027 You also have to instruct Gnus to display the data by changing the
4028 @code{%n} spec to the @code{%f} spec in the
4029 @code{gnus-summary-line-format} variable.
4031 In summary, you'd typically do something like the following:
4034 (setq gnus-extra-headers
4036 (setq nnmail-extra-headers gnus-extra-headers)
4037 (setq gnus-summary-line-format
4038 "%U%R%z%I%(%[%4L: %-20,20f%]%) %s\n")
4039 (setq gnus-ignored-from-addresses
4043 Now, this is mostly useful for mail groups, where you have control over
4044 the @sc{nov} files that are created. However, if you can persuade your
4051 to the end of her @file{overview.fmt} file, then you can use that just
4052 as you would the extra headers from the mail groups.
4055 @node Summary Buffer Mode Line
4056 @subsection Summary Buffer Mode Line
4058 @vindex gnus-summary-mode-line-format
4059 You can also change the format of the summary mode bar (@pxref{Mode Line
4060 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
4061 like. The default is @samp{Gnus: %%b [%A] %Z}.
4063 Here are the elements you can play with:
4069 Unprefixed group name.
4071 Current article number.
4073 Current article score.
4077 Number of unread articles in this group.
4079 Number of unread articles in this group that aren't displayed in the
4082 A string with the number of unread and unselected articles represented
4083 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4084 articles, and just as @samp{<%U more>} if there are just unread articles
4085 and no unselected ones.
4087 Shortish group name. For instance, @samp{rec.arts.anime} will be
4088 shortened to @samp{r.a.anime}.
4090 Subject of the current article.
4092 User-defined spec (@pxref{User-Defined Specs}).
4094 Name of the current score file (@pxref{Scoring}).
4096 Number of dormant articles (@pxref{Unread Articles}).
4098 Number of ticked articles (@pxref{Unread Articles}).
4100 Number of articles that have been marked as read in this session.
4102 Number of articles expunged by the score files.
4106 @node Summary Highlighting
4107 @subsection Summary Highlighting
4111 @item gnus-visual-mark-article-hook
4112 @vindex gnus-visual-mark-article-hook
4113 This hook is run after selecting an article. It is meant to be used for
4114 highlighting the article in some way. It is not run if
4115 @code{gnus-visual} is @code{nil}.
4117 @item gnus-summary-update-hook
4118 @vindex gnus-summary-update-hook
4119 This hook is called when a summary line is changed. It is not run if
4120 @code{gnus-visual} is @code{nil}.
4122 @item gnus-summary-selected-face
4123 @vindex gnus-summary-selected-face
4124 This is the face (or @dfn{font} as some people call it) used to
4125 highlight the current article in the summary buffer.
4127 @item gnus-summary-highlight
4128 @vindex gnus-summary-highlight
4129 Summary lines are highlighted according to this variable, which is a
4130 list where the elements are of the format @code{(@var{form}
4131 . @var{face})}. If you would, for instance, like ticked articles to be
4132 italic and high-scored articles to be bold, you could set this variable
4135 (((eq mark gnus-ticked-mark) . italic)
4136 ((> score default) . bold))
4138 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4139 @var{face} will be applied to the line.
4143 @node Summary Maneuvering
4144 @section Summary Maneuvering
4145 @cindex summary movement
4147 All the straight movement commands understand the numeric prefix and
4148 behave pretty much as you'd expect.
4150 None of these commands select articles.
4155 @kindex M-n (Summary)
4156 @kindex G M-n (Summary)
4157 @findex gnus-summary-next-unread-subject
4158 Go to the next summary line of an unread article
4159 (@code{gnus-summary-next-unread-subject}).
4163 @kindex M-p (Summary)
4164 @kindex G M-p (Summary)
4165 @findex gnus-summary-prev-unread-subject
4166 Go to the previous summary line of an unread article
4167 (@code{gnus-summary-prev-unread-subject}).
4172 @kindex G j (Summary)
4173 @findex gnus-summary-goto-article
4174 Ask for an article number or @code{Message-ID}, and then go to that
4175 article (@code{gnus-summary-goto-article}).
4178 @kindex G g (Summary)
4179 @findex gnus-summary-goto-subject
4180 Ask for an article number and then go to the summary line of that article
4181 without displaying the article (@code{gnus-summary-goto-subject}).
4184 If Gnus asks you to press a key to confirm going to the next group, you
4185 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4186 buffer, searching for the next group to read without actually returning
4187 to the group buffer.
4189 Variables related to summary movement:
4193 @vindex gnus-auto-select-next
4194 @item gnus-auto-select-next
4195 If you issue one of the movement commands (like @kbd{n}) and there are
4196 no more unread articles after the current one, Gnus will offer to go to
4197 the next group. If this variable is @code{t} and the next group is
4198 empty, Gnus will exit summary mode and return to the group buffer. If
4199 this variable is neither @code{t} nor @code{nil}, Gnus will select the
4200 next group, no matter whether it has any unread articles or not. As a
4201 special case, if this variable is @code{quietly}, Gnus will select the
4202 next group without asking for confirmation. If this variable is
4203 @code{almost-quietly}, the same will happen only if you are located on
4204 the last article in the group. Finally, if this variable is
4205 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
4206 without confirmation. Also @pxref{Group Levels}.
4208 @item gnus-auto-select-same
4209 @vindex gnus-auto-select-same
4210 If non-@code{nil}, all the movement commands will try to go to the next
4211 article with the same subject as the current. (@dfn{Same} here might
4212 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
4213 for details (@pxref{Customizing Threading}).) If there are no more
4214 articles with the same subject, go to the first unread article.
4216 This variable is not particularly useful if you use a threaded display.
4218 @item gnus-summary-check-current
4219 @vindex gnus-summary-check-current
4220 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4221 to the next (or previous) article if the current article is unread.
4222 Instead, they will choose the current article.
4224 @item gnus-auto-center-summary
4225 @vindex gnus-auto-center-summary
4226 If non-@code{nil}, Gnus will keep the point in the summary buffer
4227 centered at all times. This makes things quite tidy, but if you have a
4228 slow network connection, or simply do not like this un-Emacsism, you can
4229 set this variable to @code{nil} to get the normal Emacs scrolling
4230 action. This will also inhibit horizontal re-centering of the summary
4231 buffer, which might make it more inconvenient to read extremely long
4234 This variable can also be a number. In that case, center the window at
4235 the given number of lines from the top.
4240 @node Choosing Articles
4241 @section Choosing Articles
4242 @cindex selecting articles
4245 * Choosing Commands:: Commands for choosing articles.
4246 * Choosing Variables:: Variables that influence these commands.
4250 @node Choosing Commands
4251 @subsection Choosing Commands
4253 None of the following movement commands understand the numeric prefix,
4254 and they all select and display an article.
4258 @kindex SPACE (Summary)
4259 @findex gnus-summary-next-page
4260 Select the current article, or, if that one's read already, the next
4261 unread article (@code{gnus-summary-next-page}).
4266 @kindex G n (Summary)
4267 @findex gnus-summary-next-unread-article
4268 @c @icon{gnus-summary-next-unread}
4269 Go to next unread article (@code{gnus-summary-next-unread-article}).
4274 @findex gnus-summary-prev-unread-article
4275 @c @icon{gnus-summary-prev-unread}
4276 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
4281 @kindex G N (Summary)
4282 @findex gnus-summary-next-article
4283 Go to the next article (@code{gnus-summary-next-article}).
4288 @kindex G P (Summary)
4289 @findex gnus-summary-prev-article
4290 Go to the previous article (@code{gnus-summary-prev-article}).
4293 @kindex G C-n (Summary)
4294 @findex gnus-summary-next-same-subject
4295 Go to the next article with the same subject
4296 (@code{gnus-summary-next-same-subject}).
4299 @kindex G C-p (Summary)
4300 @findex gnus-summary-prev-same-subject
4301 Go to the previous article with the same subject
4302 (@code{gnus-summary-prev-same-subject}).
4306 @kindex G f (Summary)
4308 @findex gnus-summary-first-unread-article
4309 Go to the first unread article
4310 (@code{gnus-summary-first-unread-article}).
4314 @kindex G b (Summary)
4316 @findex gnus-summary-best-unread-article
4317 Go to the article with the highest score
4318 (@code{gnus-summary-best-unread-article}).
4323 @kindex G l (Summary)
4324 @findex gnus-summary-goto-last-article
4325 Go to the previous article read (@code{gnus-summary-goto-last-article}).
4328 @kindex G o (Summary)
4329 @findex gnus-summary-pop-article
4331 @cindex article history
4332 Pop an article off the summary history and go to this article
4333 (@code{gnus-summary-pop-article}). This command differs from the
4334 command above in that you can pop as many previous articles off the
4335 history as you like, while @kbd{l} toggles the two last read articles.
4336 For a somewhat related issue (if you use these commands a lot),
4337 @pxref{Article Backlog}.
4341 @node Choosing Variables
4342 @subsection Choosing Variables
4344 Some variables relevant for moving and selecting articles:
4347 @item gnus-auto-extend-newsgroup
4348 @vindex gnus-auto-extend-newsgroup
4349 All the movement commands will try to go to the previous (or next)
4350 article, even if that article isn't displayed in the Summary buffer if
4351 this variable is non-@code{nil}. Gnus will then fetch the article from
4352 the server and display it in the article buffer.
4354 @item gnus-select-article-hook
4355 @vindex gnus-select-article-hook
4356 This hook is called whenever an article is selected. By default it
4357 exposes any threads hidden under the selected article.
4359 @item gnus-mark-article-hook
4360 @vindex gnus-mark-article-hook
4361 @findex gnus-summary-mark-unread-as-read
4362 @findex gnus-summary-mark-read-and-unread-as-read
4363 @findex gnus-unread-mark
4364 This hook is called whenever an article is selected. It is intended to
4365 be used for marking articles as read. The default value is
4366 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
4367 mark of almost any article you read to @code{gnus-unread-mark}. The
4368 only articles not affected by this function are ticked, dormant, and
4369 expirable articles. If you'd instead like to just have unread articles
4370 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
4371 instead. It will leave marks like @code{gnus-low-score-mark},
4372 @code{gnus-del-mark} (and so on) alone.
4377 @node Paging the Article
4378 @section Scrolling the Article
4379 @cindex article scrolling
4384 @kindex SPACE (Summary)
4385 @findex gnus-summary-next-page
4386 Pressing @kbd{SPACE} will scroll the current article forward one page,
4387 or, if you have come to the end of the current article, will choose the
4388 next article (@code{gnus-summary-next-page}).
4391 @kindex DEL (Summary)
4392 @findex gnus-summary-prev-page
4393 Scroll the current article back one page (@code{gnus-summary-prev-page}).
4396 @kindex RET (Summary)
4397 @findex gnus-summary-scroll-up
4398 Scroll the current article one line forward
4399 (@code{gnus-summary-scroll-up}).
4402 @kindex M-RET (Summary)
4403 @findex gnus-summary-scroll-down
4404 Scroll the current article one line backward
4405 (@code{gnus-summary-scroll-down}).
4409 @kindex A g (Summary)
4411 @findex gnus-summary-show-article
4412 @vindex gnus-summary-show-article-charset-alist
4413 (Re)fetch the current article (@code{gnus-summary-show-article}). If
4414 given a prefix, fetch the current article, but don't run any of the
4415 article treatment functions. This will give you a ``raw'' article, just
4416 the way it came from the server.
4418 If given a numerical prefix, you can do semi-manual charset stuff.
4419 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
4420 encoded in the @code{cn-gb-2312} charset. If you have
4423 (setq gnus-summary-show-article-charset-alist
4428 then you can say @kbd{C-u 1 g} to get the same effect.
4433 @kindex A < (Summary)
4434 @findex gnus-summary-beginning-of-article
4435 Scroll to the beginning of the article
4436 (@code{gnus-summary-beginning-of-article}).
4441 @kindex A > (Summary)
4442 @findex gnus-summary-end-of-article
4443 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
4447 @kindex A s (Summary)
4449 @findex gnus-summary-isearch-article
4450 Perform an isearch in the article buffer
4451 (@code{gnus-summary-isearch-article}).
4455 @findex gnus-summary-select-article-buffer
4456 Select the article buffer (@code{gnus-summary-select-article-buffer}).
4461 @node Reply Followup and Post
4462 @section Reply, Followup and Post
4465 * Summary Mail Commands:: Sending mail.
4466 * Summary Post Commands:: Sending news.
4467 * Summary Message Commands:: Other Message-related commands.
4468 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
4472 @node Summary Mail Commands
4473 @subsection Summary Mail Commands
4475 @cindex composing mail
4477 Commands for composing a mail message:
4483 @kindex S r (Summary)
4485 @findex gnus-summary-reply
4486 @c @icon{gnus-summary-mail-reply}
4487 @c @icon{gnus-summary-reply}
4488 Mail a reply to the author of the current article
4489 (@code{gnus-summary-reply}).
4494 @kindex S R (Summary)
4495 @findex gnus-summary-reply-with-original
4496 @c @icon{gnus-summary-reply-with-original}
4497 Mail a reply to the author of the current article and include the
4498 original message (@code{gnus-summary-reply-with-original}). This
4499 command uses the process/prefix convention.
4502 @kindex S w (Summary)
4503 @findex gnus-summary-wide-reply
4504 Mail a wide reply to the author of the current article
4505 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
4506 goes out to all people listed in the @code{To}, @code{From} (or
4507 @code{Reply-to}) and @code{Cc} headers.
4510 @kindex S W (Summary)
4511 @findex gnus-summary-wide-reply-with-original
4512 Mail a wide reply to the current article and include the original
4513 message (@code{gnus-summary-wide-reply-with-original}). This command uses
4514 the process/prefix convention.
4518 @kindex S o m (Summary)
4519 @kindex C-c C-f (Summary)
4520 @findex gnus-summary-mail-forward
4521 @c @icon{gnus-summary-mail-forward}
4522 Forward the current article to some other person
4523 (@code{gnus-summary-mail-forward}). If no prefix is given, the message
4524 is forwarded according to the value of (@code{message-forward-as-mime})
4525 and (@code{message-forward-show-mml}); if the prefix is 1, decode the
4526 message and forward directly inline; if the prefix is 2, foward message
4527 as an rfc822 MIME section; if the prefix is 3, decode message and
4528 forward as an rfc822 MIME section; if the prefix is 4, foward message
4529 directly inline; otherwise, the message is forwarded as no prefix given
4530 but use the flipped value of (@code{message-forward-as-mime}). By
4531 default, the message is decoded and forwarded as an rfc822 MIME section.
4536 @kindex S m (Summary)
4537 @findex gnus-summary-mail-other-window
4538 @c @icon{gnus-summary-mail-originate}
4539 Send a mail to some other person
4540 (@code{gnus-summary-mail-other-window}).
4543 @kindex S D b (Summary)
4544 @findex gnus-summary-resend-bounced-mail
4545 @cindex bouncing mail
4546 If you have sent a mail, but the mail was bounced back to you for some
4547 reason (wrong address, transient failure), you can use this command to
4548 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
4549 will be popped into a mail buffer where you can edit the headers before
4550 sending the mail off again. If you give a prefix to this command, and
4551 the bounced mail is a reply to some other mail, Gnus will try to fetch
4552 that mail and display it for easy perusal of its headers. This might
4553 very well fail, though.
4556 @kindex S D r (Summary)
4557 @findex gnus-summary-resend-message
4558 Not to be confused with the previous command,
4559 @code{gnus-summary-resend-message} will prompt you for an address to
4560 send the current message off to, and then send it to that place. The
4561 headers of the message won't be altered---but lots of headers that say
4562 @code{Resent-To}, @code{Resent-From} and so on will be added. This
4563 means that you actually send a mail to someone that has a @code{To}
4564 header that (probably) points to yourself. This will confuse people.
4565 So, natcherly you'll only do that if you're really eVIl.
4567 This command is mainly used if you have several accounts and want to
4568 ship a mail to a different account of yours. (If you're both
4569 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4570 to the @code{root} account, you may want to resend it to
4571 @code{postmaster}. Ordnung muß sein!
4573 This command understands the process/prefix convention
4574 (@pxref{Process/Prefix}).
4577 @kindex S O m (Summary)
4578 @findex gnus-uu-digest-mail-forward
4579 Digest the current series (@pxref{Decoding Articles}) and forward the
4580 result using mail (@code{gnus-uu-digest-mail-forward}). This command
4581 uses the process/prefix convention (@pxref{Process/Prefix}).
4584 @kindex S M-c (Summary)
4585 @findex gnus-summary-mail-crosspost-complaint
4586 @cindex crossposting
4587 @cindex excessive crossposting
4588 Send a complaint about excessive crossposting to the author of the
4589 current article (@code{gnus-summary-mail-crosspost-complaint}).
4591 @findex gnus-crosspost-complaint
4592 This command is provided as a way to fight back against the current
4593 crossposting pandemic that's sweeping Usenet. It will compose a reply
4594 using the @code{gnus-crosspost-complaint} variable as a preamble. This
4595 command understands the process/prefix convention
4596 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
4600 Also @pxref{(message)Header Commands} for more information.
4603 @node Summary Post Commands
4604 @subsection Summary Post Commands
4606 @cindex composing news
4608 Commands for posting a news article:
4614 @kindex S p (Summary)
4615 @findex gnus-summary-post-news
4616 @c @icon{gnus-summary-post-news}
4617 Post an article to the current group
4618 (@code{gnus-summary-post-news}).
4623 @kindex S f (Summary)
4624 @findex gnus-summary-followup
4625 @c @icon{gnus-summary-followup}
4626 Post a followup to the current article (@code{gnus-summary-followup}).
4630 @kindex S F (Summary)
4632 @c @icon{gnus-summary-followup-with-original}
4633 @findex gnus-summary-followup-with-original
4634 Post a followup to the current article and include the original message
4635 (@code{gnus-summary-followup-with-original}). This command uses the
4636 process/prefix convention.
4639 @kindex S n (Summary)
4640 @findex gnus-summary-followup-to-mail
4641 Post a followup to the current article via news, even if you got the
4642 message through mail (@code{gnus-summary-followup-to-mail}).
4645 @kindex S N (Summary)
4646 @findex gnus-summary-followup-to-mail-with-original
4647 Post a followup to the current article via news, even if you got the
4648 message through mail and include the original message
4649 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
4650 the process/prefix convention.
4653 @kindex S o p (Summary)
4654 @findex gnus-summary-post-forward
4655 Forward the current article to a newsgroup
4656 (@code{gnus-summary-post-forward}).
4657 If no prefix is given, the message is forwarded according to the value
4658 of (@code{message-forward-as-mime}) and
4659 (@code{message-forward-show-mml}); if the prefix is 1, decode the
4660 message and forward directly inline; if the prefix is 2, foward message
4661 as an rfc822 MIME section; if the prefix is 3, decode message and
4662 forward as an rfc822 MIME section; if the prefix is 4, foward message
4663 directly inline; otherwise, the message is forwarded as no prefix given
4664 but use the flipped value of (@code{message-forward-as-mime}). By
4665 default, the message is decoded and forwarded as an rfc822 MIME section.
4668 @kindex S O p (Summary)
4669 @findex gnus-uu-digest-post-forward
4671 @cindex making digests
4672 Digest the current series and forward the result to a newsgroup
4673 (@code{gnus-uu-digest-mail-forward}). This command uses the
4674 process/prefix convention.
4677 @kindex S u (Summary)
4678 @findex gnus-uu-post-news
4679 @c @icon{gnus-uu-post-news}
4680 Uuencode a file, split it into parts, and post it as a series
4681 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
4684 Also @pxref{(message)Header Commands} for more information.
4687 @node Summary Message Commands
4688 @subsection Summary Message Commands
4692 @kindex S y (Summary)
4693 @findex gnus-summary-yank-message
4694 Yank the current article into an already existing Message composition
4695 buffer (@code{gnus-summary-yank-message}). This command prompts for
4696 what message buffer you want to yank into, and understands the
4697 process/prefix convention (@pxref{Process/Prefix}).
4702 @node Canceling and Superseding
4703 @subsection Canceling Articles
4704 @cindex canceling articles
4705 @cindex superseding articles
4707 Have you ever written something, and then decided that you really,
4708 really, really wish you hadn't posted that?
4710 Well, you can't cancel mail, but you can cancel posts.
4712 @findex gnus-summary-cancel-article
4714 @c @icon{gnus-summary-cancel-article}
4715 Find the article you wish to cancel (you can only cancel your own
4716 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
4717 c} (@code{gnus-summary-cancel-article}). Your article will be
4718 canceled---machines all over the world will be deleting your article.
4719 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4721 Be aware, however, that not all sites honor cancels, so your article may
4722 live on here and there, while most sites will delete the article in
4725 Gnus will use the ``current'' select method when canceling. If you
4726 want to use the standard posting method, use the @samp{a} symbolic
4727 prefix (@pxref{Symbolic Prefixes}).
4729 If you discover that you have made some mistakes and want to do some
4730 corrections, you can post a @dfn{superseding} article that will replace
4731 your original article.
4733 @findex gnus-summary-supersede-article
4735 Go to the original article and press @kbd{S s}
4736 (@code{gnus-summary-supersede-article}). You will be put in a buffer
4737 where you can edit the article all you want before sending it off the
4740 The same goes for superseding as for canceling, only more so: Some
4741 sites do not honor superseding. On those sites, it will appear that you
4742 have posted almost the same article twice.
4744 If you have just posted the article, and change your mind right away,
4745 there is a trick you can use to cancel/supersede the article without
4746 waiting for the article to appear on your site first. You simply return
4747 to the post buffer (which is called @code{*sent ...*}). There you will
4748 find the article you just posted, with all the headers intact. Change
4749 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4750 header by substituting one of those words for the word
4751 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
4752 you would do normally. The previous article will be
4753 canceled/superseded.
4755 Just remember, kids: There is no 'c' in 'supersede'.
4758 @node Marking Articles
4759 @section Marking Articles
4760 @cindex article marking
4761 @cindex article ticking
4764 There are several marks you can set on an article.
4766 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4767 neologism ohoy!) of the article. Alphabetic marks generally mean
4768 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4770 In addition, you also have marks that do not affect readedness.
4773 * Unread Articles:: Marks for unread articles.
4774 * Read Articles:: Marks for read articles.
4775 * Other Marks:: Marks that do not affect readedness.
4779 There's a plethora of commands for manipulating these marks:
4783 * Setting Marks:: How to set and remove marks.
4784 * Generic Marking Commands:: How to customize the marking.
4785 * Setting Process Marks:: How to mark articles for later processing.
4789 @node Unread Articles
4790 @subsection Unread Articles
4792 The following marks mark articles as (kinda) unread, in one form or
4797 @vindex gnus-ticked-mark
4798 Marked as ticked (@code{gnus-ticked-mark}).
4800 @dfn{Ticked articles} are articles that will remain visible always. If
4801 you see an article that you find interesting, or you want to put off
4802 reading it, or replying to it, until sometime later, you'd typically
4803 tick it. However, articles can be expired, so if you want to keep an
4804 article forever, you'll have to make it persistent (@pxref{Persistent
4808 @vindex gnus-dormant-mark
4809 Marked as dormant (@code{gnus-dormant-mark}).
4811 @dfn{Dormant articles} will only appear in the summary buffer if there
4812 are followups to it. If you want to see them even if they don't have
4813 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4816 @vindex gnus-unread-mark
4817 Marked as unread (@code{gnus-unread-mark}).
4819 @dfn{Unread articles} are articles that haven't been read at all yet.
4824 @subsection Read Articles
4825 @cindex expirable mark
4827 All the following marks mark articles as read.
4832 @vindex gnus-del-mark
4833 These are articles that the user has marked as read with the @kbd{d}
4834 command manually, more or less (@code{gnus-del-mark}).
4837 @vindex gnus-read-mark
4838 Articles that have actually been read (@code{gnus-read-mark}).
4841 @vindex gnus-ancient-mark
4842 Articles that were marked as read in previous sessions and are now
4843 @dfn{old} (@code{gnus-ancient-mark}).
4846 @vindex gnus-killed-mark
4847 Marked as killed (@code{gnus-killed-mark}).
4850 @vindex gnus-kill-file-mark
4851 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4854 @vindex gnus-low-score-mark
4855 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4858 @vindex gnus-catchup-mark
4859 Marked as read by a catchup (@code{gnus-catchup-mark}).
4862 @vindex gnus-canceled-mark
4863 Canceled article (@code{gnus-canceled-mark})
4866 @vindex gnus-souped-mark
4867 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
4870 @vindex gnus-sparse-mark
4871 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
4875 @vindex gnus-duplicate-mark
4876 Article marked as read by duplicate suppression
4877 (@code{gnus-duplicated-mark}). @xref{Duplicate Suppression}.
4881 All these marks just mean that the article is marked as read, really.
4882 They are interpreted differently when doing adaptive scoring, though.
4884 One more special mark, though:
4888 @vindex gnus-expirable-mark
4889 Marked as expirable (@code{gnus-expirable-mark}).
4891 Marking articles as @dfn{expirable} (or have them marked as such
4892 automatically) doesn't make much sense in normal groups---a user doesn't
4893 control expiring of news articles, but in mail groups, for instance,
4894 articles marked as @dfn{expirable} can be deleted by Gnus at
4900 @subsection Other Marks
4901 @cindex process mark
4904 There are some marks that have nothing to do with whether the article is
4910 You can set a bookmark in the current article. Say you are reading a
4911 long thesis on cats' urinary tracts, and have to go home for dinner
4912 before you've finished reading the thesis. You can then set a bookmark
4913 in the article, and Gnus will jump to this bookmark the next time it
4914 encounters the article. @xref{Setting Marks}.
4917 @vindex gnus-replied-mark
4918 All articles that you have replied to or made a followup to (i.e., have
4919 answered) will be marked with an @samp{A} in the second column
4920 (@code{gnus-replied-mark}).
4923 @vindex gnus-cached-mark
4924 Articles stored in the article cache will be marked with an @samp{*} in
4925 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
4928 @vindex gnus-saved-mark
4929 Articles ``saved'' (in some manner or other; not necessarily
4930 religiously) are marked with an @samp{S} in the second column
4931 (@code{gnus-saved-mark}).
4934 @vindex gnus-not-empty-thread-mark
4935 @vindex gnus-empty-thread-mark
4936 If the @samp{%e} spec is used, the presence of threads or not will be
4937 marked with @code{gnus-not-empty-thread-mark} and
4938 @code{gnus-empty-thread-mark} in the third column, respectively.
4941 @vindex gnus-process-mark
4942 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
4943 variety of commands react to the presence of the process mark. For
4944 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4945 all articles that have been marked with the process mark. Articles
4946 marked with the process mark have a @samp{#} in the second column.
4950 You might have noticed that most of these ``non-readedness'' marks
4951 appear in the second column by default. So if you have a cached, saved,
4952 replied article that you have process-marked, what will that look like?
4954 Nothing much. The precedence rules go as follows: process -> cache ->
4955 replied -> saved. So if the article is in the cache and is replied,
4956 you'll only see the cache mark and not the replied mark.
4960 @subsection Setting Marks
4961 @cindex setting marks
4963 All the marking commands understand the numeric prefix.
4968 @kindex M c (Summary)
4969 @kindex M-u (Summary)
4970 @findex gnus-summary-clear-mark-forward
4971 @cindex mark as unread
4972 Clear all readedness-marks from the current article
4973 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
4979 @kindex M t (Summary)
4980 @findex gnus-summary-tick-article-forward
4981 Tick the current article (@code{gnus-summary-tick-article-forward}).
4982 @xref{Article Caching}.
4987 @kindex M ? (Summary)
4988 @findex gnus-summary-mark-as-dormant
4989 Mark the current article as dormant
4990 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
4994 @kindex M d (Summary)
4996 @findex gnus-summary-mark-as-read-forward
4997 Mark the current article as read
4998 (@code{gnus-summary-mark-as-read-forward}).
5002 @findex gnus-summary-mark-as-read-backward
5003 Mark the current article as read and move point to the previous line
5004 (@code{gnus-summary-mark-as-read-backward}).
5009 @kindex M k (Summary)
5010 @findex gnus-summary-kill-same-subject-and-select
5011 Mark all articles that have the same subject as the current one as read,
5012 and then select the next unread article
5013 (@code{gnus-summary-kill-same-subject-and-select}).
5017 @kindex M K (Summary)
5018 @kindex C-k (Summary)
5019 @findex gnus-summary-kill-same-subject
5020 Mark all articles that have the same subject as the current one as read
5021 (@code{gnus-summary-kill-same-subject}).
5024 @kindex M C (Summary)
5025 @findex gnus-summary-catchup
5026 @c @icon{gnus-summary-catchup}
5027 Mark all unread articles as read (@code{gnus-summary-catchup}).
5030 @kindex M C-c (Summary)
5031 @findex gnus-summary-catchup-all
5032 Mark all articles in the group as read---even the ticked and dormant
5033 articles (@code{gnus-summary-catchup-all}).
5036 @kindex M H (Summary)
5037 @findex gnus-summary-catchup-to-here
5038 Catchup the current group to point
5039 (@code{gnus-summary-catchup-to-here}).
5042 @kindex C-w (Summary)
5043 @findex gnus-summary-mark-region-as-read
5044 Mark all articles between point and mark as read
5045 (@code{gnus-summary-mark-region-as-read}).
5048 @kindex M V k (Summary)
5049 @findex gnus-summary-kill-below
5050 Kill all articles with scores below the default score (or below the
5051 numeric prefix) (@code{gnus-summary-kill-below}).
5055 @kindex M e (Summary)
5057 @findex gnus-summary-mark-as-expirable
5058 Mark the current article as expirable
5059 (@code{gnus-summary-mark-as-expirable}).
5062 @kindex M b (Summary)
5063 @findex gnus-summary-set-bookmark
5064 Set a bookmark in the current article
5065 (@code{gnus-summary-set-bookmark}).
5068 @kindex M B (Summary)
5069 @findex gnus-summary-remove-bookmark
5070 Remove the bookmark from the current article
5071 (@code{gnus-summary-remove-bookmark}).
5074 @kindex M V c (Summary)
5075 @findex gnus-summary-clear-above
5076 Clear all marks from articles with scores over the default score (or
5077 over the numeric prefix) (@code{gnus-summary-clear-above}).
5080 @kindex M V u (Summary)
5081 @findex gnus-summary-tick-above
5082 Tick all articles with scores over the default score (or over the
5083 numeric prefix) (@code{gnus-summary-tick-above}).
5086 @kindex M V m (Summary)
5087 @findex gnus-summary-mark-above
5088 Prompt for a mark, and mark all articles with scores over the default
5089 score (or over the numeric prefix) with this mark
5090 (@code{gnus-summary-clear-above}).
5093 @vindex gnus-summary-goto-unread
5094 The @code{gnus-summary-goto-unread} variable controls what action should
5095 be taken after setting a mark. If non-@code{nil}, point will move to
5096 the next/previous unread article. If @code{nil}, point will just move
5097 one line up or down. As a special case, if this variable is
5098 @code{never}, all the marking commands as well as other commands (like
5099 @kbd{SPACE}) will move to the next article, whether it is unread or not.
5100 The default is @code{t}.
5103 @node Generic Marking Commands
5104 @subsection Generic Marking Commands
5106 Some people would like the command that ticks an article (@kbd{!}) go to
5107 the next article. Others would like it to go to the next unread
5108 article. Yet others would like it to stay on the current article. And
5109 even though I haven't heard of anybody wanting it to go to the
5110 previous (unread) article, I'm sure there are people that want that as
5113 Multiply these five behaviours with five different marking commands, and
5114 you get a potentially complex set of variable to control what each
5117 To sidestep that mess, Gnus provides commands that do all these
5118 different things. They can be found on the @kbd{M M} map in the summary
5119 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
5120 to list in this manual.
5122 While you can use these commands directly, most users would prefer
5123 altering the summary mode keymap. For instance, if you would like the
5124 @kbd{!} command to go to the next article instead of the next unread
5125 article, you could say something like:
5128 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
5129 (defun my-alter-summary-map ()
5130 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
5136 (defun my-alter-summary-map ()
5137 (local-set-key "!" "MM!n"))
5141 @node Setting Process Marks
5142 @subsection Setting Process Marks
5143 @cindex setting process marks
5150 @kindex M P p (Summary)
5151 @findex gnus-summary-mark-as-processable
5152 Mark the current article with the process mark
5153 (@code{gnus-summary-mark-as-processable}).
5154 @findex gnus-summary-unmark-as-processable
5158 @kindex M P u (Summary)
5159 @kindex M-# (Summary)
5160 Remove the process mark, if any, from the current article
5161 (@code{gnus-summary-unmark-as-processable}).
5164 @kindex M P U (Summary)
5165 @findex gnus-summary-unmark-all-processable
5166 Remove the process mark from all articles
5167 (@code{gnus-summary-unmark-all-processable}).
5170 @kindex M P i (Summary)
5171 @findex gnus-uu-invert-processable
5172 Invert the list of process marked articles
5173 (@code{gnus-uu-invert-processable}).
5176 @kindex M P R (Summary)
5177 @findex gnus-uu-mark-by-regexp
5178 Mark articles that have a @code{Subject} header that matches a regular
5179 expression (@code{gnus-uu-mark-by-regexp}).
5182 @kindex M P G (Summary)
5183 @findex gnus-uu-unmark-by-regexp
5184 Unmark articles that have a @code{Subject} header that matches a regular
5185 expression (@code{gnus-uu-unmark-by-regexp}).
5188 @kindex M P r (Summary)
5189 @findex gnus-uu-mark-region
5190 Mark articles in region (@code{gnus-uu-mark-region}).
5193 @kindex M P t (Summary)
5194 @findex gnus-uu-mark-thread
5195 Mark all articles in the current (sub)thread
5196 (@code{gnus-uu-mark-thread}).
5199 @kindex M P T (Summary)
5200 @findex gnus-uu-unmark-thread
5201 Unmark all articles in the current (sub)thread
5202 (@code{gnus-uu-unmark-thread}).
5205 @kindex M P v (Summary)
5206 @findex gnus-uu-mark-over
5207 Mark all articles that have a score above the prefix argument
5208 (@code{gnus-uu-mark-over}).
5211 @kindex M P s (Summary)
5212 @findex gnus-uu-mark-series
5213 Mark all articles in the current series (@code{gnus-uu-mark-series}).
5216 @kindex M P S (Summary)
5217 @findex gnus-uu-mark-sparse
5218 Mark all series that have already had some articles marked
5219 (@code{gnus-uu-mark-sparse}).
5222 @kindex M P a (Summary)
5223 @findex gnus-uu-mark-all
5224 Mark all articles in series order (@code{gnus-uu-mark-series}).
5227 @kindex M P b (Summary)
5228 @findex gnus-uu-mark-buffer
5229 Mark all articles in the buffer in the order they appear
5230 (@code{gnus-uu-mark-buffer}).
5233 @kindex M P k (Summary)
5234 @findex gnus-summary-kill-process-mark
5235 Push the current process mark set onto the stack and unmark all articles
5236 (@code{gnus-summary-kill-process-mark}).
5239 @kindex M P y (Summary)
5240 @findex gnus-summary-yank-process-mark
5241 Pop the previous process mark set from the stack and restore it
5242 (@code{gnus-summary-yank-process-mark}).
5245 @kindex M P w (Summary)
5246 @findex gnus-summary-save-process-mark
5247 Push the current process mark set onto the stack
5248 (@code{gnus-summary-save-process-mark}).
5252 Also see the @kbd{&} command in @pxref{Searching for Articles} for how to
5253 set process marks based on article body contents.
5260 It can be convenient to limit the summary buffer to just show some
5261 subset of the articles currently in the group. The effect most limit
5262 commands have is to remove a few (or many) articles from the summary
5265 All limiting commands work on subsets of the articles already fetched
5266 from the servers. None of these commands query the server for
5267 additional articles.
5273 @kindex / / (Summary)
5274 @findex gnus-summary-limit-to-subject
5275 Limit the summary buffer to articles that match some subject
5276 (@code{gnus-summary-limit-to-subject}).
5279 @kindex / a (Summary)
5280 @findex gnus-summary-limit-to-author
5281 Limit the summary buffer to articles that match some author
5282 (@code{gnus-summary-limit-to-author}).
5285 @kindex / x (Summary)
5286 @findex gnus-summary-limit-to-extra
5287 Limit the summary buffer to articles that match one of the ``extra''
5288 headers (@pxref{To From Newsgroups})
5289 (@code{gnus-summary-limit-to-extra}).
5293 @kindex / u (Summary)
5295 @findex gnus-summary-limit-to-unread
5296 Limit the summary buffer to articles not marked as read
5297 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
5298 buffer to articles strictly unread. This means that ticked and
5299 dormant articles will also be excluded.
5302 @kindex / m (Summary)
5303 @findex gnus-summary-limit-to-marks
5304 Ask for a mark and then limit to all articles that have been marked
5305 with that mark (@code{gnus-summary-limit-to-marks}).
5308 @kindex / t (Summary)
5309 @findex gnus-summary-limit-to-age
5310 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
5311 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
5312 articles younger than that number of days.
5315 @kindex / n (Summary)
5316 @findex gnus-summary-limit-to-articles
5317 Limit the summary buffer to the current article
5318 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
5319 convention (@pxref{Process/Prefix}).
5322 @kindex / w (Summary)
5323 @findex gnus-summary-pop-limit
5324 Pop the previous limit off the stack and restore it
5325 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
5329 @kindex / v (Summary)
5330 @findex gnus-summary-limit-to-score
5331 Limit the summary buffer to articles that have a score at or above some
5332 score (@code{gnus-summary-limit-to-score}).
5336 @kindex M S (Summary)
5337 @kindex / E (Summary)
5338 @findex gnus-summary-limit-include-expunged
5339 Include all expunged articles in the limit
5340 (@code{gnus-summary-limit-include-expunged}).
5343 @kindex / D (Summary)
5344 @findex gnus-summary-limit-include-dormant
5345 Include all dormant articles in the limit
5346 (@code{gnus-summary-limit-include-dormant}).
5349 @kindex / * (Summary)
5350 @findex gnus-summary-limit-include-cached
5351 Include all cached articles in the limit
5352 (@code{gnus-summary-limit-include-cached}).
5355 @kindex / d (Summary)
5356 @findex gnus-summary-limit-exclude-dormant
5357 Exclude all dormant articles from the limit
5358 (@code{gnus-summary-limit-exclude-dormant}).
5361 @kindex / M (Summary)
5362 @findex gnus-summary-limit-exclude-marks
5363 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
5366 @kindex / T (Summary)
5367 @findex gnus-summary-limit-include-thread
5368 Include all the articles in the current thread in the limit.
5371 @kindex / c (Summary)
5372 @findex gnus-summary-limit-exclude-childless-dormant
5373 Exclude all dormant articles that have no children from the limit
5374 (@code{gnus-summary-limit-exclude-childless-dormant}).
5377 @kindex / C (Summary)
5378 @findex gnus-summary-limit-mark-excluded-as-read
5379 Mark all excluded unread articles as read
5380 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
5381 also mark excluded ticked and dormant articles as read.
5389 @cindex article threading
5391 Gnus threads articles by default. @dfn{To thread} is to put responses
5392 to articles directly after the articles they respond to---in a
5393 hierarchical fashion.
5395 Threading is done by looking at the @code{References} headers of the
5396 articles. In a perfect world, this would be enough to build pretty
5397 trees, but unfortunately, the @code{References} header is often broken
5398 or simply missing. Weird news propagation excarcerbates the problem,
5399 so one has to employ other heuristics to get pleasing results. A
5400 plethora of approaches exists, as detailed in horrible detail in
5401 @pxref{Customizing Threading}.
5403 First, a quick overview of the concepts:
5407 The top-most article in a thread; the first article in the thread.
5410 A tree-like article structure.
5413 A small(er) section of this tree-like structure.
5416 Threads often lose their roots due to article expiry, or due to the root
5417 already having been read in a previous session, and not displayed in the
5418 summary buffer. We then typically have many sub-threads that really
5419 belong to one thread, but are without connecting roots. These are
5420 called loose threads.
5422 @item thread gathering
5423 An attempt to gather loose threads into bigger threads.
5425 @item sparse threads
5426 A thread where the missing articles have been ``guessed'' at, and are
5427 displayed as empty lines in the summary buffer.
5433 * Customizing Threading:: Variables you can change to affect the threading.
5434 * Thread Commands:: Thread based commands in the summary buffer.
5438 @node Customizing Threading
5439 @subsection Customizing Threading
5440 @cindex customizing threading
5443 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
5444 * Filling In Threads:: Making the threads displayed look fuller.
5445 * More Threading:: Even more variables for fiddling with threads.
5446 * Low-Level Threading:: You thought it was over... but you were wrong!
5451 @subsubsection Loose Threads
5454 @cindex loose threads
5457 @item gnus-summary-make-false-root
5458 @vindex gnus-summary-make-false-root
5459 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
5460 and create a dummy root at the top. (Wait a minute. Root at the top?
5461 Yup.) Loose subtrees occur when the real root has expired, or you've
5462 read or killed the root in a previous session.
5464 When there is no real root of a thread, Gnus will have to fudge
5465 something. This variable says what fudging method Gnus should use.
5466 There are four possible values:
5470 \gnusfigure{The Summary Buffer}{390}{
5471 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
5472 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
5473 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
5474 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
5479 @cindex adopting articles
5484 Gnus will make the first of the orphaned articles the parent. This
5485 parent will adopt all the other articles. The adopted articles will be
5486 marked as such by pointy brackets (@samp{<>}) instead of the standard
5487 square brackets (@samp{[]}). This is the default method.
5490 @vindex gnus-summary-dummy-line-format
5491 Gnus will create a dummy summary line that will pretend to be the
5492 parent. This dummy line does not correspond to any real article, so
5493 selecting it will just select the first real article after the dummy
5494 article. @code{gnus-summary-dummy-line-format} is used to specify the
5495 format of the dummy roots. It accepts only one format spec: @samp{S},
5496 which is the subject of the article. @xref{Formatting Variables}.
5499 Gnus won't actually make any article the parent, but simply leave the
5500 subject field of all orphans except the first empty. (Actually, it will
5501 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
5505 Don't make any article parent at all. Just gather the threads and
5506 display them after one another.
5509 Don't gather loose threads.
5512 @item gnus-summary-gather-subject-limit
5513 @vindex gnus-summary-gather-subject-limit
5514 Loose threads are gathered by comparing subjects of articles. If this
5515 variable is @code{nil}, Gnus requires an exact match between the
5516 subjects of the loose threads before gathering them into one big
5517 super-thread. This might be too strict a requirement, what with the
5518 presence of stupid newsreaders that chop off long subject lines. If
5519 you think so, set this variable to, say, 20 to require that only the
5520 first 20 characters of the subjects have to match. If you set this
5521 variable to a really low number, you'll find that Gnus will gather
5522 everything in sight into one thread, which isn't very helpful.
5524 @cindex fuzzy article gathering
5525 If you set this variable to the special value @code{fuzzy}, Gnus will
5526 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
5529 @item gnus-simplify-subject-fuzzy-regexp
5530 @vindex gnus-simplify-subject-fuzzy-regexp
5531 This can either be a regular expression or list of regular expressions
5532 that match strings that will be removed from subjects if fuzzy subject
5533 simplification is used.
5535 @item gnus-simplify-ignored-prefixes
5536 @vindex gnus-simplify-ignored-prefixes
5537 If you set @code{gnus-summary-gather-subject-limit} to something as low
5538 as 10, you might consider setting this variable to something sensible:
5540 @c Written by Michael Ernst <mernst@cs.rice.edu>
5542 (setq gnus-simplify-ignored-prefixes
5548 "wanted" "followup" "summary\\( of\\)?"
5549 "help" "query" "problem" "question"
5550 "answer" "reference" "announce"
5551 "How can I" "How to" "Comparison of"
5556 (mapconcat 'identity
5557 '("for" "for reference" "with" "about")
5559 "\\)?\\]?:?[ \t]*"))
5562 All words that match this regexp will be removed before comparing two
5565 @item gnus-simplify-subject-functions
5566 @vindex gnus-simplify-subject-functions
5567 If non-@code{nil}, this variable overrides
5568 @code{gnus-summary-gather-subject-limit}. This variable should be a
5569 list of functions to apply to the @code{Subject} string iteratively to
5570 arrive at the simplified version of the string.
5572 Useful functions to put in this list include:
5575 @item gnus-simplify-subject-re
5576 @findex gnus-simplify-subject-re
5577 Strip the leading @samp{Re:}.
5579 @item gnus-simplify-subject-fuzzy
5580 @findex gnus-simplify-subject-fuzzy
5583 @item gnus-simplify-whitespace
5584 @findex gnus-simplify-whitespace
5585 Remove excessive whitespace.
5588 You may also write your own functions, of course.
5591 @item gnus-summary-gather-exclude-subject
5592 @vindex gnus-summary-gather-exclude-subject
5593 Since loose thread gathering is done on subjects only, that might lead
5594 to many false hits, especially with certain common subjects like
5595 @samp{} and @samp{(none)}. To make the situation slightly better,
5596 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
5597 what subjects should be excluded from the gathering process.@*
5598 The default is @samp{^ *$\\|^(none)$}.
5600 @item gnus-summary-thread-gathering-function
5601 @vindex gnus-summary-thread-gathering-function
5602 Gnus gathers threads by looking at @code{Subject} headers. This means
5603 that totally unrelated articles may end up in the same ``thread'', which
5604 is confusing. An alternate approach is to look at all the
5605 @code{Message-ID}s in all the @code{References} headers to find matches.
5606 This will ensure that no gathered threads ever include unrelated
5607 articles, but it also means that people who have posted with broken
5608 newsreaders won't be gathered properly. The choice is yours---plague or
5612 @item gnus-gather-threads-by-subject
5613 @findex gnus-gather-threads-by-subject
5614 This function is the default gathering function and looks at
5615 @code{Subject}s exclusively.
5617 @item gnus-gather-threads-by-references
5618 @findex gnus-gather-threads-by-references
5619 This function looks at @code{References} headers exclusively.
5622 If you want to test gathering by @code{References}, you could say
5626 (setq gnus-summary-thread-gathering-function
5627 'gnus-gather-threads-by-references)
5633 @node Filling In Threads
5634 @subsubsection Filling In Threads
5637 @item gnus-fetch-old-headers
5638 @vindex gnus-fetch-old-headers
5639 If non-@code{nil}, Gnus will attempt to build old threads by fetching
5640 more old headers---headers to articles marked as read. If you
5641 would like to display as few summary lines as possible, but still
5642 connect as many loose threads as possible, you should set this variable
5643 to @code{some} or a number. If you set it to a number, no more than
5644 that number of extra old headers will be fetched. In either case,
5645 fetching old headers only works if the backend you are using carries
5646 overview files---this would normally be @code{nntp}, @code{nnspool} and
5647 @code{nnml}. Also remember that if the root of the thread has been
5648 expired by the server, there's not much Gnus can do about that.
5650 This variable can also be set to @code{invisible}. This won't have any
5651 visible effects, but is useful if you use the @kbd{A T} command a lot
5652 (@pxref{Finding the Parent}).
5654 @item gnus-build-sparse-threads
5655 @vindex gnus-build-sparse-threads
5656 Fetching old headers can be slow. A low-rent similar effect can be
5657 gotten by setting this variable to @code{some}. Gnus will then look at
5658 the complete @code{References} headers of all articles and try to string
5659 together articles that belong in the same thread. This will leave
5660 @dfn{gaps} in the threading display where Gnus guesses that an article
5661 is missing from the thread. (These gaps appear like normal summary
5662 lines. If you select a gap, Gnus will try to fetch the article in
5663 question.) If this variable is @code{t}, Gnus will display all these
5664 ``gaps'' without regard for whether they are useful for completing the
5665 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
5666 off sparse leaf nodes that don't lead anywhere. This variable is
5667 @code{nil} by default.
5672 @node More Threading
5673 @subsubsection More Threading
5676 @item gnus-show-threads
5677 @vindex gnus-show-threads
5678 If this variable is @code{nil}, no threading will be done, and all of
5679 the rest of the variables here will have no effect. Turning threading
5680 off will speed group selection up a bit, but it is sure to make reading
5681 slower and more awkward.
5683 @item gnus-thread-hide-subtree
5684 @vindex gnus-thread-hide-subtree
5685 If non-@code{nil}, all threads will be hidden when the summary buffer is
5688 @item gnus-thread-expunge-below
5689 @vindex gnus-thread-expunge-below
5690 All threads that have a total score (as defined by
5691 @code{gnus-thread-score-function}) less than this number will be
5692 expunged. This variable is @code{nil} by default, which means that no
5693 threads are expunged.
5695 @item gnus-thread-hide-killed
5696 @vindex gnus-thread-hide-killed
5697 if you kill a thread and this variable is non-@code{nil}, the subtree
5700 @item gnus-thread-ignore-subject
5701 @vindex gnus-thread-ignore-subject
5702 Sometimes somebody changes the subject in the middle of a thread. If
5703 this variable is non-@code{nil}, the subject change is ignored. If it
5704 is @code{nil}, which is the default, a change in the subject will result
5707 @item gnus-thread-indent-level
5708 @vindex gnus-thread-indent-level
5709 This is a number that says how much each sub-thread should be indented.
5712 @item gnus-sort-gathered-threads-function
5713 @vindex gnus-sort-gathered-threads-function
5714 Sometimes, particularly with mailing lists, the order in which mails
5715 arrive locally is not necessarily the same as the order in which they
5716 arrived on the mailing list. Consequently, when sorting sub-threads
5717 using the default @code{gnus-thread-sort-by-number}, responses can end
5718 up appearing before the article to which they are responding to.
5719 Setting this variable to an alternate value
5720 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
5721 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
5722 more logical sub-thread ordering in such instances.
5727 @node Low-Level Threading
5728 @subsubsection Low-Level Threading
5732 @item gnus-parse-headers-hook
5733 @vindex gnus-parse-headers-hook
5734 Hook run before parsing any headers.
5736 @item gnus-alter-header-function
5737 @vindex gnus-alter-header-function
5738 If non-@code{nil}, this function will be called to allow alteration of
5739 article header structures. The function is called with one parameter,
5740 the article header vector, which it may alter in any way. For instance,
5741 if you have a mail-to-news gateway which alters the @code{Message-ID}s
5742 in systematic ways (by adding prefixes and such), you can use this
5743 variable to un-scramble the @code{Message-ID}s so that they are more
5744 meaningful. Here's one example:
5747 (setq gnus-alter-header-function 'my-alter-message-id)
5749 (defun my-alter-message-id (header)
5750 (let ((id (mail-header-id header)))
5752 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
5754 (concat (match-string 1 id) "@@" (match-string 2 id))
5761 @node Thread Commands
5762 @subsection Thread Commands
5763 @cindex thread commands
5769 @kindex T k (Summary)
5770 @kindex M-C-k (Summary)
5771 @findex gnus-summary-kill-thread
5772 Mark all articles in the current (sub-)thread as read
5773 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
5774 remove all marks instead. If the prefix argument is negative, tick
5779 @kindex T l (Summary)
5780 @kindex M-C-l (Summary)
5781 @findex gnus-summary-lower-thread
5782 Lower the score of the current (sub-)thread
5783 (@code{gnus-summary-lower-thread}).
5786 @kindex T i (Summary)
5787 @findex gnus-summary-raise-thread
5788 Increase the score of the current (sub-)thread
5789 (@code{gnus-summary-raise-thread}).
5792 @kindex T # (Summary)
5793 @findex gnus-uu-mark-thread
5794 Set the process mark on the current (sub-)thread
5795 (@code{gnus-uu-mark-thread}).
5798 @kindex T M-# (Summary)
5799 @findex gnus-uu-unmark-thread
5800 Remove the process mark from the current (sub-)thread
5801 (@code{gnus-uu-unmark-thread}).
5804 @kindex T T (Summary)
5805 @findex gnus-summary-toggle-threads
5806 Toggle threading (@code{gnus-summary-toggle-threads}).
5809 @kindex T s (Summary)
5810 @findex gnus-summary-show-thread
5811 Expose the (sub-)thread hidden under the current article, if any
5812 (@code{gnus-summary-show-thread}).
5815 @kindex T h (Summary)
5816 @findex gnus-summary-hide-thread
5817 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5820 @kindex T S (Summary)
5821 @findex gnus-summary-show-all-threads
5822 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5825 @kindex T H (Summary)
5826 @findex gnus-summary-hide-all-threads
5827 Hide all threads (@code{gnus-summary-hide-all-threads}).
5830 @kindex T t (Summary)
5831 @findex gnus-summary-rethread-current
5832 Re-thread the current article's thread
5833 (@code{gnus-summary-rethread-current}). This works even when the
5834 summary buffer is otherwise unthreaded.
5837 @kindex T ^ (Summary)
5838 @findex gnus-summary-reparent-thread
5839 Make the current article the child of the marked (or previous) article
5840 (@code{gnus-summary-reparent-thread}).
5844 The following commands are thread movement commands. They all
5845 understand the numeric prefix.
5850 @kindex T n (Summary)
5852 @kindex M-C-n (Summary)
5854 @kindex M-down (Summary)
5855 @findex gnus-summary-next-thread
5856 Go to the next thread (@code{gnus-summary-next-thread}).
5859 @kindex T p (Summary)
5861 @kindex M-C-p (Summary)
5863 @kindex M-up (Summary)
5864 @findex gnus-summary-prev-thread
5865 Go to the previous thread (@code{gnus-summary-prev-thread}).
5868 @kindex T d (Summary)
5869 @findex gnus-summary-down-thread
5870 Descend the thread (@code{gnus-summary-down-thread}).
5873 @kindex T u (Summary)
5874 @findex gnus-summary-up-thread
5875 Ascend the thread (@code{gnus-summary-up-thread}).
5878 @kindex T o (Summary)
5879 @findex gnus-summary-top-thread
5880 Go to the top of the thread (@code{gnus-summary-top-thread}).
5883 @vindex gnus-thread-operation-ignore-subject
5884 If you ignore subject while threading, you'll naturally end up with
5885 threads that have several different subjects in them. If you then issue
5886 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
5887 wish to kill the entire thread, but just those parts of the thread that
5888 have the same subject as the current article. If you like this idea,
5889 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
5890 is non-@code{nil} (which it is by default), subjects will be ignored
5891 when doing thread commands. If this variable is @code{nil}, articles in
5892 the same thread with different subjects will not be included in the
5893 operation in question. If this variable is @code{fuzzy}, only articles
5894 that have subjects fuzzily equal will be included (@pxref{Fuzzy
5901 @findex gnus-thread-sort-by-total-score
5902 @findex gnus-thread-sort-by-date
5903 @findex gnus-thread-sort-by-score
5904 @findex gnus-thread-sort-by-subject
5905 @findex gnus-thread-sort-by-author
5906 @findex gnus-thread-sort-by-number
5907 @vindex gnus-thread-sort-functions
5908 If you are using a threaded summary display, you can sort the threads by
5909 setting @code{gnus-thread-sort-functions}, which can be either a single
5910 function, a list of functions, or a list containing functions and
5911 @code{(not some-function)} elements.
5913 By default, sorting is done on article numbers. Ready-made sorting
5914 predicate functions include @code{gnus-thread-sort-by-number},
5915 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5916 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5917 @code{gnus-thread-sort-by-total-score}.
5919 Each function takes two threads and returns non-@code{nil} if the first
5920 thread should be sorted before the other. Note that sorting really is
5921 normally done by looking only at the roots of each thread.
5923 If you use more than one function, the primary sort key should be the
5924 last function in the list. You should probably always include
5925 @code{gnus-thread-sort-by-number} in the list of sorting
5926 functions---preferably first. This will ensure that threads that are
5927 equal with respect to the other sort criteria will be displayed in
5928 ascending article order.
5930 If you would like to sort by reverse score, then by subject, and finally
5931 by number, you could do something like:
5934 (setq gnus-thread-sort-functions
5935 '(gnus-thread-sort-by-number
5936 gnus-thread-sort-by-subject
5937 (not gnus-thread-sort-by-total-score)))
5940 The threads that have highest score will be displayed first in the
5941 summary buffer. When threads have the same score, they will be sorted
5942 alphabetically. The threads that have the same score and the same
5943 subject will be sorted by number, which is (normally) the sequence in
5944 which the articles arrived.
5946 If you want to sort by score and then reverse arrival order, you could
5950 (setq gnus-thread-sort-functions
5952 (not (gnus-thread-sort-by-number t1 t2)))
5953 gnus-thread-sort-by-score))
5956 @vindex gnus-thread-score-function
5957 The function in the @code{gnus-thread-score-function} variable (default
5958 @code{+}) is used for calculating the total score of a thread. Useful
5959 functions might be @code{max}, @code{min}, or squared means, or whatever
5962 @findex gnus-article-sort-functions
5963 @findex gnus-article-sort-by-date
5964 @findex gnus-article-sort-by-score
5965 @findex gnus-article-sort-by-subject
5966 @findex gnus-article-sort-by-author
5967 @findex gnus-article-sort-by-number
5968 If you are using an unthreaded display for some strange reason or other,
5969 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5970 It is very similar to the @code{gnus-thread-sort-functions}, except that
5971 it uses slightly different functions for article comparison. Available
5972 sorting predicate functions are @code{gnus-article-sort-by-number},
5973 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5974 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5976 If you want to sort an unthreaded summary display by subject, you could
5980 (setq gnus-article-sort-functions
5981 '(gnus-article-sort-by-number
5982 gnus-article-sort-by-subject))
5987 @node Asynchronous Fetching
5988 @section Asynchronous Article Fetching
5989 @cindex asynchronous article fetching
5990 @cindex article pre-fetch
5993 If you read your news from an @sc{nntp} server that's far away, the
5994 network latencies may make reading articles a chore. You have to wait
5995 for a while after pressing @kbd{n} to go to the next article before the
5996 article appears. Why can't Gnus just go ahead and fetch the article
5997 while you are reading the previous one? Why not, indeed.
5999 First, some caveats. There are some pitfalls to using asynchronous
6000 article fetching, especially the way Gnus does it.
6002 Let's say you are reading article 1, which is short, and article 2 is
6003 quite long, and you are not interested in reading that. Gnus does not
6004 know this, so it goes ahead and fetches article 2. You decide to read
6005 article 3, but since Gnus is in the process of fetching article 2, the
6006 connection is blocked.
6008 To avoid these situations, Gnus will open two (count 'em two)
6009 connections to the server. Some people may think this isn't a very nice
6010 thing to do, but I don't see any real alternatives. Setting up that
6011 extra connection takes some time, so Gnus startup will be slower.
6013 Gnus will fetch more articles than you will read. This will mean that
6014 the link between your machine and the @sc{nntp} server will become more
6015 loaded than if you didn't use article pre-fetch. The server itself will
6016 also become more loaded---both with the extra article requests, and the
6019 Ok, so now you know that you shouldn't really use this thing... unless
6022 @vindex gnus-asynchronous
6023 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
6024 happen automatically.
6026 @vindex gnus-use-article-prefetch
6027 You can control how many articles are to be pre-fetched by setting
6028 @code{gnus-use-article-prefetch}. This is 30 by default, which means
6029 that when you read an article in the group, the backend will pre-fetch
6030 the next 30 articles. If this variable is @code{t}, the backend will
6031 pre-fetch all the articles it can without bound. If it is
6032 @code{nil}, no pre-fetching will be done.
6034 @vindex gnus-async-prefetch-article-p
6035 @findex gnus-async-read-p
6036 There are probably some articles that you don't want to pre-fetch---read
6037 articles, for instance. The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched. This function should
6038 return non-@code{nil} when the article in question is to be
6039 pre-fetched. The default is @code{gnus-async-read-p}, which returns
6040 @code{nil} on read articles. The function is called with an article
6041 data structure as the only parameter.
6043 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
6046 (defun my-async-short-unread-p (data)
6047 "Return non-nil for short, unread articles."
6048 (and (gnus-data-unread-p data)
6049 (< (mail-header-lines (gnus-data-header data))
6052 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
6055 These functions will be called many, many times, so they should
6056 preferably be short and sweet to avoid slowing down Gnus too much.
6057 It's probably a good idea to byte-compile things like this.
6059 @vindex gnus-prefetched-article-deletion-strategy
6060 Articles have to be removed from the asynch buffer sooner or later. The
6061 @code{gnus-prefetched-article-deletion-strategy} says when to remove
6062 articles. This is a list that may contain the following elements:
6066 Remove articles when they are read.
6069 Remove articles when exiting the group.
6072 The default value is @code{(read exit)}.
6074 @c @vindex gnus-use-header-prefetch
6075 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
6076 @c from the next group.
6079 @node Article Caching
6080 @section Article Caching
6081 @cindex article caching
6084 If you have an @emph{extremely} slow @sc{nntp} connection, you may
6085 consider turning article caching on. Each article will then be stored
6086 locally under your home directory. As you may surmise, this could
6087 potentially use @emph{huge} amounts of disk space, as well as eat up all
6088 your inodes so fast it will make your head swim. In vodka.
6090 Used carefully, though, it could be just an easier way to save articles.
6092 @vindex gnus-use-long-file-name
6093 @vindex gnus-cache-directory
6094 @vindex gnus-use-cache
6095 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
6096 all articles ticked or marked as dormant will then be copied
6097 over to your local cache (@code{gnus-cache-directory}). Whether this
6098 cache is flat or hierarchal is controlled by the
6099 @code{gnus-use-long-file-name} variable, as usual.
6101 When re-selecting a ticked or dormant article, it will be fetched from the
6102 cache instead of from the server. As articles in your cache will never
6103 expire, this might serve as a method of saving articles while still
6104 keeping them where they belong. Just mark all articles you want to save
6105 as dormant, and don't worry.
6107 When an article is marked as read, is it removed from the cache.
6109 @vindex gnus-cache-remove-articles
6110 @vindex gnus-cache-enter-articles
6111 The entering/removal of articles from the cache is controlled by the
6112 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
6113 variables. Both are lists of symbols. The first is @code{(ticked
6114 dormant)} by default, meaning that ticked and dormant articles will be
6115 put in the cache. The latter is @code{(read)} by default, meaning that
6116 articles marked as read are removed from the cache. Possibly
6117 symbols in these two lists are @code{ticked}, @code{dormant},
6118 @code{unread} and @code{read}.
6120 @findex gnus-jog-cache
6121 So where does the massive article-fetching and storing come into the
6122 picture? The @code{gnus-jog-cache} command will go through all
6123 subscribed newsgroups, request all unread articles, score them, and
6124 store them in the cache. You should only ever, ever ever ever, use this
6125 command if 1) your connection to the @sc{nntp} server is really, really,
6126 really slow and 2) you have a really, really, really huge disk.
6127 Seriously. One way to cut down on the number of articles downloaded is
6128 to score unwanted articles down and have them marked as read. They will
6129 not then be downloaded by this command.
6131 @vindex gnus-uncacheable-groups
6132 @vindex gnus-cacheable-groups
6133 It is likely that you do not want caching on all groups. For instance,
6134 if your @code{nnml} mail is located under your home directory, it makes no
6135 sense to cache it somewhere else under your home directory. Unless you
6136 feel that it's neat to use twice as much space.
6138 To limit the caching, you could set @code{gnus-cacheable-groups} to a
6139 regexp of groups to cache, @samp{^nntp} for instance, or set the
6140 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
6141 Both variables are @code{nil} by default. If a group matches both
6142 variables, the group is not cached.
6144 @findex gnus-cache-generate-nov-databases
6145 @findex gnus-cache-generate-active
6146 @vindex gnus-cache-active-file
6147 The cache stores information on what articles it contains in its active
6148 file (@code{gnus-cache-active-file}). If this file (or any other parts
6149 of the cache) becomes all messed up for some reason or other, Gnus
6150 offers two functions that will try to set things right. @kbd{M-x
6151 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
6152 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
6156 @node Persistent Articles
6157 @section Persistent Articles
6158 @cindex persistent articles
6160 Closely related to article caching, we have @dfn{persistent articles}.
6161 In fact, it's just a different way of looking at caching, and much more
6162 useful in my opinion.
6164 Say you're reading a newsgroup, and you happen on to some valuable gem
6165 that you want to keep and treasure forever. You'd normally just save it
6166 (using one of the many saving commands) in some file. The problem with
6167 that is that it's just, well, yucky. Ideally you'd prefer just having
6168 the article remain in the group where you found it forever; untouched by
6169 the expiry going on at the news server.
6171 This is what a @dfn{persistent article} is---an article that just won't
6172 be deleted. It's implemented using the normal cache functions, but
6173 you use two explicit commands for managing persistent articles:
6179 @findex gnus-cache-enter-article
6180 Make the current article persistent (@code{gnus-cache-enter-article}).
6183 @kindex M-* (Summary)
6184 @findex gnus-cache-remove-article
6185 Remove the current article from the persistent articles
6186 (@code{gnus-cache-remove-article}). This will normally delete the
6190 Both these commands understand the process/prefix convention.
6192 To avoid having all ticked articles (and stuff) entered into the cache,
6193 you should set @code{gnus-use-cache} to @code{passive} if you're just
6194 interested in persistent articles:
6197 (setq gnus-use-cache 'passive)
6201 @node Article Backlog
6202 @section Article Backlog
6204 @cindex article backlog
6206 If you have a slow connection, but the idea of using caching seems
6207 unappealing to you (and it is, really), you can help the situation some
6208 by switching on the @dfn{backlog}. This is where Gnus will buffer
6209 already read articles so that it doesn't have to re-fetch articles
6210 you've already read. This only helps if you are in the habit of
6211 re-selecting articles you've recently read, of course. If you never do
6212 that, turning the backlog on will slow Gnus down a little bit, and
6213 increase memory usage some.
6215 @vindex gnus-keep-backlog
6216 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
6217 at most @var{n} old articles in a buffer for later re-fetching. If this
6218 variable is non-@code{nil} and is not a number, Gnus will store
6219 @emph{all} read articles, which means that your Emacs will grow without
6220 bound before exploding and taking your machine down with you. I put
6221 that in there just to keep y'all on your toes.
6223 This variable is @code{nil} by default.
6226 @node Saving Articles
6227 @section Saving Articles
6228 @cindex saving articles
6230 Gnus can save articles in a number of ways. Below is the documentation
6231 for saving articles in a fairly straight-forward fashion (i.e., little
6232 processing of the article is done before it is saved). For a different
6233 approach (uudecoding, unsharing) you should use @code{gnus-uu}
6234 (@pxref{Decoding Articles}).
6236 @vindex gnus-save-all-headers
6237 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
6238 unwanted headers before saving the article.
6240 @vindex gnus-saved-headers
6241 If the preceding variable is @code{nil}, all headers that match the
6242 @code{gnus-saved-headers} regexp will be kept, while the rest will be
6243 deleted before saving.
6249 @kindex O o (Summary)
6251 @findex gnus-summary-save-article
6252 @c @icon{gnus-summary-save-article}
6253 Save the current article using the default article saver
6254 (@code{gnus-summary-save-article}).
6257 @kindex O m (Summary)
6258 @findex gnus-summary-save-article-mail
6259 Save the current article in mail format
6260 (@code{gnus-summary-save-article-mail}).
6263 @kindex O r (Summary)
6264 @findex gnus-summary-save-article-rmail
6265 Save the current article in rmail format
6266 (@code{gnus-summary-save-article-rmail}).
6269 @kindex O f (Summary)
6270 @findex gnus-summary-save-article-file
6271 @c @icon{gnus-summary-save-article-file}
6272 Save the current article in plain file format
6273 (@code{gnus-summary-save-article-file}).
6276 @kindex O F (Summary)
6277 @findex gnus-summary-write-article-file
6278 Write the current article in plain file format, overwriting any previous
6279 file contents (@code{gnus-summary-write-article-file}).
6282 @kindex O b (Summary)
6283 @findex gnus-summary-save-article-body-file
6284 Save the current article body in plain file format
6285 (@code{gnus-summary-save-article-body-file}).
6288 @kindex O h (Summary)
6289 @findex gnus-summary-save-article-folder
6290 Save the current article in mh folder format
6291 (@code{gnus-summary-save-article-folder}).
6294 @kindex O v (Summary)
6295 @findex gnus-summary-save-article-vm
6296 Save the current article in a VM folder
6297 (@code{gnus-summary-save-article-vm}).
6300 @kindex O p (Summary)
6301 @findex gnus-summary-pipe-output
6302 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
6303 the current article to a process (@code{gnus-summary-pipe-output}).
6306 @vindex gnus-prompt-before-saving
6307 All these commands use the process/prefix convention
6308 (@pxref{Process/Prefix}). If you save bunches of articles using these
6309 functions, you might get tired of being prompted for files to save each
6310 and every article in. The prompting action is controlled by
6311 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
6312 default, giving you that excessive prompting action you know and
6313 loathe. If you set this variable to @code{t} instead, you'll be prompted
6314 just once for each series of articles you save. If you like to really
6315 have Gnus do all your thinking for you, you can even set this variable
6316 to @code{nil}, which means that you will never be prompted for files to
6317 save articles in. Gnus will simply save all the articles in the default
6321 @vindex gnus-default-article-saver
6322 You can customize the @code{gnus-default-article-saver} variable to make
6323 Gnus do what you want it to. You can use any of the six ready-made
6324 functions below, or you can create your own.
6328 @item gnus-summary-save-in-rmail
6329 @findex gnus-summary-save-in-rmail
6330 @vindex gnus-rmail-save-name
6331 @findex gnus-plain-save-name
6332 This is the default format, @dfn{babyl}. Uses the function in the
6333 @code{gnus-rmail-save-name} variable to get a file name to save the
6334 article in. The default is @code{gnus-plain-save-name}.
6336 @item gnus-summary-save-in-mail
6337 @findex gnus-summary-save-in-mail
6338 @vindex gnus-mail-save-name
6339 Save in a Unix mail (mbox) file. Uses the function in the
6340 @code{gnus-mail-save-name} variable to get a file name to save the
6341 article in. The default is @code{gnus-plain-save-name}.
6343 @item gnus-summary-save-in-file
6344 @findex gnus-summary-save-in-file
6345 @vindex gnus-file-save-name
6346 @findex gnus-numeric-save-name
6347 Append the article straight to an ordinary file. Uses the function in
6348 the @code{gnus-file-save-name} variable to get a file name to save the
6349 article in. The default is @code{gnus-numeric-save-name}.
6351 @item gnus-summary-save-body-in-file
6352 @findex gnus-summary-save-body-in-file
6353 Append the article body to an ordinary file. Uses the function in the
6354 @code{gnus-file-save-name} variable to get a file name to save the
6355 article in. The default is @code{gnus-numeric-save-name}.
6357 @item gnus-summary-save-in-folder
6358 @findex gnus-summary-save-in-folder
6359 @findex gnus-folder-save-name
6360 @findex gnus-Folder-save-name
6361 @vindex gnus-folder-save-name
6364 Save the article to an MH folder using @code{rcvstore} from the MH
6365 library. Uses the function in the @code{gnus-folder-save-name} variable
6366 to get a file name to save the article in. The default is
6367 @code{gnus-folder-save-name}, but you can also use
6368 @code{gnus-Folder-save-name}, which creates capitalized names.
6370 @item gnus-summary-save-in-vm
6371 @findex gnus-summary-save-in-vm
6372 Save the article in a VM folder. You have to have the VM mail
6373 reader to use this setting.
6376 @vindex gnus-article-save-directory
6377 All of these functions, except for the last one, will save the article
6378 in the @code{gnus-article-save-directory}, which is initialized from the
6379 @code{SAVEDIR} environment variable. This is @file{~/News/} by
6382 As you can see above, the functions use different functions to find a
6383 suitable name of a file to save the article in. Below is a list of
6384 available functions that generate names:
6388 @item gnus-Numeric-save-name
6389 @findex gnus-Numeric-save-name
6390 File names like @file{~/News/Alt.andrea-dworkin/45}.
6392 @item gnus-numeric-save-name
6393 @findex gnus-numeric-save-name
6394 File names like @file{~/News/alt.andrea-dworkin/45}.
6396 @item gnus-Plain-save-name
6397 @findex gnus-Plain-save-name
6398 File names like @file{~/News/Alt.andrea-dworkin}.
6400 @item gnus-plain-save-name
6401 @findex gnus-plain-save-name
6402 File names like @file{~/News/alt.andrea-dworkin}.
6405 @vindex gnus-split-methods
6406 You can have Gnus suggest where to save articles by plonking a regexp into
6407 the @code{gnus-split-methods} alist. For instance, if you would like to
6408 save articles related to Gnus in the file @file{gnus-stuff}, and articles
6409 related to VM in @code{vm-stuff}, you could set this variable to something
6413 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
6414 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
6415 (my-choosing-function "../other-dir/my-stuff")
6416 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
6419 We see that this is a list where each element is a list that has two
6420 elements---the @dfn{match} and the @dfn{file}. The match can either be
6421 a string (in which case it is used as a regexp to match on the article
6422 head); it can be a symbol (which will be called as a function with the
6423 group name as a parameter); or it can be a list (which will be
6424 @code{eval}ed). If any of these actions have a non-@code{nil} result,
6425 the @dfn{file} will be used as a default prompt. In addition, the
6426 result of the operation itself will be used if the function or form
6427 called returns a string or a list of strings.
6429 You basically end up with a list of file names that might be used when
6430 saving the current article. (All ``matches'' will be used.) You will
6431 then be prompted for what you really want to use as a name, with file
6432 name completion over the results from applying this variable.
6434 This variable is @code{((gnus-article-archive-name))} by default, which
6435 means that Gnus will look at the articles it saves for an
6436 @code{Archive-name} line and use that as a suggestion for the file
6439 Here's an example function to clean up file names somewhat. If you have
6440 lots of mail groups called things like
6441 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
6442 these group names before creating the file name to save to. The
6443 following will do just that:
6446 (defun my-save-name (group)
6447 (when (string-match "^nnml:mail." group)
6448 (substring group (match-end 0))))
6450 (setq gnus-split-methods
6451 '((gnus-article-archive-name)
6456 @vindex gnus-use-long-file-name
6457 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
6458 @code{nil}, all the preceding functions will replace all periods
6459 (@samp{.}) in the group names with slashes (@samp{/})---which means that
6460 the functions will generate hierarchies of directories instead of having
6461 all the files in the top level directory
6462 (@file{~/News/alt/andrea-dworkin} instead of
6463 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
6464 on most systems. However, for historical reasons, this is @code{nil} on
6465 Xenix and usg-unix-v machines by default.
6467 This function also affects kill and score file names. If this variable
6468 is a list, and the list contains the element @code{not-score}, long file
6469 names will not be used for score files, if it contains the element
6470 @code{not-save}, long file names will not be used for saving, and if it
6471 contains the element @code{not-kill}, long file names will not be used
6474 If you'd like to save articles in a hierarchy that looks something like
6478 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
6479 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
6482 Then just save with @kbd{o}. You'd then read this hierarchy with
6483 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
6484 the top level directory as the argument (@file{~/News/}). Then just walk
6485 around to the groups/directories with @code{nneething}.
6488 @node Decoding Articles
6489 @section Decoding Articles
6490 @cindex decoding articles
6492 Sometime users post articles (or series of articles) that have been
6493 encoded in some way or other. Gnus can decode them for you.
6496 * Uuencoded Articles:: Uudecode articles.
6497 * Shell Archives:: Unshar articles.
6498 * PostScript Files:: Split PostScript.
6499 * Other Files:: Plain save and binhex.
6500 * Decoding Variables:: Variables for a happy decoding.
6501 * Viewing Files:: You want to look at the result of the decoding?
6505 @cindex article series
6506 All these functions use the process/prefix convention
6507 (@pxref{Process/Prefix}) for finding out what articles to work on, with
6508 the extension that a ``single article'' means ``a single series''. Gnus
6509 can find out by itself what articles belong to a series, decode all the
6510 articles and unpack/view/save the resulting file(s).
6512 Gnus guesses what articles are in the series according to the following
6513 simplish rule: The subjects must be (nearly) identical, except for the
6514 last two numbers of the line. (Spaces are largely ignored, however.)
6516 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
6517 will find all the articles that match the regexp @samp{^cat.gif
6518 ([0-9]+/[0-9]+).*$}.
6520 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
6521 series}, will not be properly recognized by any of the automatic viewing
6522 commands, and you have to mark the articles manually with @kbd{#}.
6525 @node Uuencoded Articles
6526 @subsection Uuencoded Articles
6528 @cindex uuencoded articles
6533 @kindex X u (Summary)
6534 @findex gnus-uu-decode-uu
6535 @c @icon{gnus-uu-decode-uu}
6536 Uudecodes the current series (@code{gnus-uu-decode-uu}).
6539 @kindex X U (Summary)
6540 @findex gnus-uu-decode-uu-and-save
6541 Uudecodes and saves the current series
6542 (@code{gnus-uu-decode-uu-and-save}).
6545 @kindex X v u (Summary)
6546 @findex gnus-uu-decode-uu-view
6547 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
6550 @kindex X v U (Summary)
6551 @findex gnus-uu-decode-uu-and-save-view
6552 Uudecodes, views and saves the current series
6553 (@code{gnus-uu-decode-uu-and-save-view}).
6557 Remember that these all react to the presence of articles marked with
6558 the process mark. If, for instance, you'd like to decode and save an
6559 entire newsgroup, you'd typically do @kbd{M P a}
6560 (@code{gnus-uu-mark-all}) and then @kbd{X U}
6561 (@code{gnus-uu-decode-uu-and-save}).
6563 All this is very much different from how @code{gnus-uu} worked with
6564 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
6565 the sun. This version of @code{gnus-uu} generally assumes that you mark
6566 articles in some way (@pxref{Setting Process Marks}) and then press
6569 @vindex gnus-uu-notify-files
6570 Note: When trying to decode articles that have names matching
6571 @code{gnus-uu-notify-files}, which is hard-coded to
6572 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
6573 automatically post an article on @samp{comp.unix.wizards} saying that
6574 you have just viewed the file in question. This feature can't be turned
6578 @node Shell Archives
6579 @subsection Shell Archives
6581 @cindex shell archives
6582 @cindex shared articles
6584 Shell archives (``shar files'') used to be a popular way to distribute
6585 sources, but it isn't used all that much today. In any case, we have
6586 some commands to deal with these:
6591 @kindex X s (Summary)
6592 @findex gnus-uu-decode-unshar
6593 Unshars the current series (@code{gnus-uu-decode-unshar}).
6596 @kindex X S (Summary)
6597 @findex gnus-uu-decode-unshar-and-save
6598 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
6601 @kindex X v s (Summary)
6602 @findex gnus-uu-decode-unshar-view
6603 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
6606 @kindex X v S (Summary)
6607 @findex gnus-uu-decode-unshar-and-save-view
6608 Unshars, views and saves the current series
6609 (@code{gnus-uu-decode-unshar-and-save-view}).
6613 @node PostScript Files
6614 @subsection PostScript Files
6620 @kindex X p (Summary)
6621 @findex gnus-uu-decode-postscript
6622 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
6625 @kindex X P (Summary)
6626 @findex gnus-uu-decode-postscript-and-save
6627 Unpack and save the current PostScript series
6628 (@code{gnus-uu-decode-postscript-and-save}).
6631 @kindex X v p (Summary)
6632 @findex gnus-uu-decode-postscript-view
6633 View the current PostScript series
6634 (@code{gnus-uu-decode-postscript-view}).
6637 @kindex X v P (Summary)
6638 @findex gnus-uu-decode-postscript-and-save-view
6639 View and save the current PostScript series
6640 (@code{gnus-uu-decode-postscript-and-save-view}).
6645 @subsection Other Files
6649 @kindex X o (Summary)
6650 @findex gnus-uu-decode-save
6651 Save the current series
6652 (@code{gnus-uu-decode-save}).
6655 @kindex X b (Summary)
6656 @findex gnus-uu-decode-binhex
6657 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
6658 doesn't really work yet.
6662 @node Decoding Variables
6663 @subsection Decoding Variables
6665 Adjective, not verb.
6668 * Rule Variables:: Variables that say how a file is to be viewed.
6669 * Other Decode Variables:: Other decode variables.
6670 * Uuencoding and Posting:: Variables for customizing uuencoding.
6674 @node Rule Variables
6675 @subsubsection Rule Variables
6676 @cindex rule variables
6678 Gnus uses @dfn{rule variables} to decide how to view a file. All these
6679 variables are of the form
6682 (list '(regexp1 command2)
6689 @item gnus-uu-user-view-rules
6690 @vindex gnus-uu-user-view-rules
6692 This variable is consulted first when viewing files. If you wish to use,
6693 for instance, @code{sox} to convert an @samp{.au} sound file, you could
6696 (setq gnus-uu-user-view-rules
6697 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
6700 @item gnus-uu-user-view-rules-end
6701 @vindex gnus-uu-user-view-rules-end
6702 This variable is consulted if Gnus couldn't make any matches from the
6703 user and default view rules.
6705 @item gnus-uu-user-archive-rules
6706 @vindex gnus-uu-user-archive-rules
6707 This variable can be used to say what commands should be used to unpack
6712 @node Other Decode Variables
6713 @subsubsection Other Decode Variables
6716 @vindex gnus-uu-grabbed-file-functions
6718 @item gnus-uu-grabbed-file-functions
6719 All functions in this list will be called right after each file has been
6720 successfully decoded---so that you can move or view files right away,
6721 and don't have to wait for all files to be decoded before you can do
6722 anything. Ready-made functions you can put in this list are:
6726 @item gnus-uu-grab-view
6727 @findex gnus-uu-grab-view
6730 @item gnus-uu-grab-move
6731 @findex gnus-uu-grab-move
6732 Move the file (if you're using a saving function.)
6735 @item gnus-uu-be-dangerous
6736 @vindex gnus-uu-be-dangerous
6737 Specifies what to do if unusual situations arise during decoding. If
6738 @code{nil}, be as conservative as possible. If @code{t}, ignore things
6739 that didn't work, and overwrite existing files. Otherwise, ask each
6742 @item gnus-uu-ignore-files-by-name
6743 @vindex gnus-uu-ignore-files-by-name
6744 Files with name matching this regular expression won't be viewed.
6746 @item gnus-uu-ignore-files-by-type
6747 @vindex gnus-uu-ignore-files-by-type
6748 Files with a @sc{mime} type matching this variable won't be viewed.
6749 Note that Gnus tries to guess what type the file is based on the name.
6750 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
6753 @item gnus-uu-tmp-dir
6754 @vindex gnus-uu-tmp-dir
6755 Where @code{gnus-uu} does its work.
6757 @item gnus-uu-do-not-unpack-archives
6758 @vindex gnus-uu-do-not-unpack-archives
6759 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
6760 looking for files to display.
6762 @item gnus-uu-view-and-save
6763 @vindex gnus-uu-view-and-save
6764 Non-@code{nil} means that the user will always be asked to save a file
6767 @item gnus-uu-ignore-default-view-rules
6768 @vindex gnus-uu-ignore-default-view-rules
6769 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
6772 @item gnus-uu-ignore-default-archive-rules
6773 @vindex gnus-uu-ignore-default-archive-rules
6774 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
6777 @item gnus-uu-kill-carriage-return
6778 @vindex gnus-uu-kill-carriage-return
6779 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
6782 @item gnus-uu-unmark-articles-not-decoded
6783 @vindex gnus-uu-unmark-articles-not-decoded
6784 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
6785 decoded articles as unread.
6787 @item gnus-uu-correct-stripped-uucode
6788 @vindex gnus-uu-correct-stripped-uucode
6789 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
6790 uuencoded files that have had trailing spaces deleted.
6792 @item gnus-uu-pre-uudecode-hook
6793 @vindex gnus-uu-pre-uudecode-hook
6794 Hook run before sending a message to @code{uudecode}.
6796 @item gnus-uu-view-with-metamail
6797 @vindex gnus-uu-view-with-metamail
6799 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
6800 commands defined by the rule variables and just fudge a @sc{mime}
6801 content type based on the file name. The result will be fed to
6802 @code{metamail} for viewing.
6804 @item gnus-uu-save-in-digest
6805 @vindex gnus-uu-save-in-digest
6806 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
6807 decoding, will save in digests. If this variable is @code{nil},
6808 @code{gnus-uu} will just save everything in a file without any
6809 embellishments. The digesting almost conforms to RFC 1153---no easy way
6810 to specify any meaningful volume and issue numbers were found, so I
6811 simply dropped them.
6816 @node Uuencoding and Posting
6817 @subsubsection Uuencoding and Posting
6821 @item gnus-uu-post-include-before-composing
6822 @vindex gnus-uu-post-include-before-composing
6823 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6824 before you compose the article. If this variable is @code{t}, you can
6825 either include an encoded file with @kbd{C-c C-i} or have one included
6826 for you when you post the article.
6828 @item gnus-uu-post-length
6829 @vindex gnus-uu-post-length
6830 Maximum length of an article. The encoded file will be split into how
6831 many articles it takes to post the entire file.
6833 @item gnus-uu-post-threaded
6834 @vindex gnus-uu-post-threaded
6835 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6836 thread. This may not be smart, as no other decoder I have seen is able
6837 to follow threads when collecting uuencoded articles. (Well, I have
6838 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6839 think that counts...) Default is @code{nil}.
6841 @item gnus-uu-post-separate-description
6842 @vindex gnus-uu-post-separate-description
6843 Non-@code{nil} means that the description will be posted in a separate
6844 article. The first article will typically be numbered (0/x). If this
6845 variable is @code{nil}, the description the user enters will be included
6846 at the beginning of the first article, which will be numbered (1/x).
6847 Default is @code{t}.
6853 @subsection Viewing Files
6854 @cindex viewing files
6855 @cindex pseudo-articles
6857 After decoding, if the file is some sort of archive, Gnus will attempt
6858 to unpack the archive and see if any of the files in the archive can be
6859 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
6860 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
6861 uncompress and de-tar the main file, and then view the two pictures.
6862 This unpacking process is recursive, so if the archive contains archives
6863 of archives, it'll all be unpacked.
6865 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
6866 extracted file into the summary buffer. If you go to these
6867 ``articles'', you will be prompted for a command to run (usually Gnus
6868 will make a suggestion), and then the command will be run.
6870 @vindex gnus-view-pseudo-asynchronously
6871 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
6872 until the viewing is done before proceeding.
6874 @vindex gnus-view-pseudos
6875 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
6876 the pseudo-articles into the summary buffer, but view them
6877 immediately. If this variable is @code{not-confirm}, the user won't even
6878 be asked for a confirmation before viewing is done.
6880 @vindex gnus-view-pseudos-separately
6881 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
6882 pseudo-article will be created for each file to be viewed. If
6883 @code{nil}, all files that use the same viewing command will be given as
6884 a list of parameters to that command.
6886 @vindex gnus-insert-pseudo-articles
6887 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
6888 pseudo-articles when decoding. It is @code{t} by default.
6890 So; there you are, reading your @emph{pseudo-articles} in your
6891 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
6892 Why isn't anything real anymore? How did we get here?
6895 @node Article Treatment
6896 @section Article Treatment
6898 Reading through this huge manual, you may have quite forgotten that the
6899 object of newsreaders is to actually, like, read what people have
6900 written. Reading articles. Unfortunately, people are quite bad at
6901 writing, so there are tons of functions and variables to make reading
6902 these articles easier.
6905 * Article Highlighting:: You want to make the article look like fruit salad.
6906 * Article Fontisizing:: Making emphasized text look nice.
6907 * Article Hiding:: You also want to make certain info go away.
6908 * Article Washing:: Lots of way-neat functions to make life better.
6909 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
6910 * Article Date:: Grumble, UT!
6911 * Article Signature:: What is a signature?
6912 * Article Miscellania:: Various other stuff.
6916 @node Article Highlighting
6917 @subsection Article Highlighting
6918 @cindex highlighting
6920 Not only do you want your article buffer to look like fruit salad, but
6921 you want it to look like technicolor fruit salad.
6926 @kindex W H a (Summary)
6927 @findex gnus-article-highlight
6928 @findex gnus-article-maybe-highlight
6929 Do much highlighting of the current article
6930 (@code{gnus-article-highlight}). This function highlights header, cited
6931 text, the signature, and adds buttons to the body and the head.
6934 @kindex W H h (Summary)
6935 @findex gnus-article-highlight-headers
6936 @vindex gnus-header-face-alist
6937 Highlight the headers (@code{gnus-article-highlight-headers}). The
6938 highlighting will be done according to the @code{gnus-header-face-alist}
6939 variable, which is a list where each element has the form
6940 @code{(@var{regexp} @var{name} @var{content})}.
6941 @var{regexp} is a regular expression for matching the
6942 header, @var{name} is the face used for highlighting the header name
6943 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6944 the header value. The first match made will be used. Note that
6945 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6948 @kindex W H c (Summary)
6949 @findex gnus-article-highlight-citation
6950 Highlight cited text (@code{gnus-article-highlight-citation}).
6952 Some variables to customize the citation highlights:
6955 @vindex gnus-cite-parse-max-size
6957 @item gnus-cite-parse-max-size
6958 If the article size if bigger than this variable (which is 25000 by
6959 default), no citation highlighting will be performed.
6961 @item gnus-cite-prefix-regexp
6962 @vindex gnus-cite-prefix-regexp
6963 Regexp matching the longest possible citation prefix on a line.
6965 @item gnus-cite-max-prefix
6966 @vindex gnus-cite-max-prefix
6967 Maximum possible length for a citation prefix (default 20).
6969 @item gnus-cite-face-list
6970 @vindex gnus-cite-face-list
6971 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6972 When there are citations from multiple articles in the same message,
6973 Gnus will try to give each citation from each article its own face.
6974 This should make it easier to see who wrote what.
6976 @item gnus-supercite-regexp
6977 @vindex gnus-supercite-regexp
6978 Regexp matching normal Supercite attribution lines.
6980 @item gnus-supercite-secondary-regexp
6981 @vindex gnus-supercite-secondary-regexp
6982 Regexp matching mangled Supercite attribution lines.
6984 @item gnus-cite-minimum-match-count
6985 @vindex gnus-cite-minimum-match-count
6986 Minimum number of identical prefixes we have to see before we believe
6987 that it's a citation.
6989 @item gnus-cite-attribution-prefix
6990 @vindex gnus-cite-attribution-prefix
6991 Regexp matching the beginning of an attribution line.
6993 @item gnus-cite-attribution-suffix
6994 @vindex gnus-cite-attribution-suffix
6995 Regexp matching the end of an attribution line.
6997 @item gnus-cite-attribution-face
6998 @vindex gnus-cite-attribution-face
6999 Face used for attribution lines. It is merged with the face for the
7000 cited text belonging to the attribution.
7006 @kindex W H s (Summary)
7007 @vindex gnus-signature-separator
7008 @vindex gnus-signature-face
7009 @findex gnus-article-highlight-signature
7010 Highlight the signature (@code{gnus-article-highlight-signature}).
7011 Everything after @code{gnus-signature-separator} (@pxref{Article
7012 Signature}) in an article will be considered a signature and will be
7013 highlighted with @code{gnus-signature-face}, which is @code{italic} by
7018 @xref{Customizing Articles}, for how to highlight articles automatically.
7021 @node Article Fontisizing
7022 @subsection Article Fontisizing
7024 @cindex article emphasis
7026 @findex gnus-article-emphasize
7027 @kindex W e (Summary)
7028 People commonly add emphasis to words in news articles by writing things
7029 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
7030 this look nicer by running the article through the @kbd{W e}
7031 (@code{gnus-article-emphasize}) command.
7033 @vindex gnus-emphasis-alist
7034 How the emphasis is computed is controlled by the
7035 @code{gnus-emphasis-alist} variable. This is an alist where the first
7036 element is a regular expression to be matched. The second is a number
7037 that says what regular expression grouping is used to find the entire
7038 emphasized word. The third is a number that says what regexp grouping
7039 should be displayed and highlighted. (The text between these two
7040 groupings will be hidden.) The fourth is the face used for
7044 (setq gnus-article-emphasis
7045 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
7046 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
7055 @vindex gnus-emphasis-underline
7056 @vindex gnus-emphasis-bold
7057 @vindex gnus-emphasis-italic
7058 @vindex gnus-emphasis-underline-bold
7059 @vindex gnus-emphasis-underline-italic
7060 @vindex gnus-emphasis-bold-italic
7061 @vindex gnus-emphasis-underline-bold-italic
7062 By default, there are seven rules, and they use the following faces:
7063 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
7064 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
7065 @code{gnus-emphasis-underline-italic},
7066 @code{gnus-emphasis-underline-bold}, and
7067 @code{gnus-emphasis-underline-bold-italic}.
7069 If you want to change these faces, you can either use @kbd{M-x
7070 customize}, or you can use @code{copy-face}. For instance, if you want
7071 to make @code{gnus-emphasis-italic} use a red face instead, you could
7075 (copy-face 'red 'gnus-emphasis-italic)
7078 @vindex gnus-group-highlight-words-alist
7080 If you want to highlight arbitrary words, you can use the
7081 @code{gnus-group-highlight-words-alist} variable, which uses the same
7082 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
7083 parameter (@pxref{Group Parameters}) can also be used.
7085 @xref{Customizing Articles}, for how to fontize articles automatically.
7088 @node Article Hiding
7089 @subsection Article Hiding
7090 @cindex article hiding
7092 Or rather, hiding certain things in each article. There usually is much
7093 too much cruft in most articles.
7098 @kindex W W a (Summary)
7099 @findex gnus-article-hide
7100 Do quite a lot of hiding on the article buffer
7101 (@kbd{gnus-article-hide}). In particular, this function will hide
7102 headers, PGP, cited text and the signature.
7105 @kindex W W h (Summary)
7106 @findex gnus-article-hide-headers
7107 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
7111 @kindex W W b (Summary)
7112 @findex gnus-article-hide-boring-headers
7113 Hide headers that aren't particularly interesting
7114 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
7117 @kindex W W s (Summary)
7118 @findex gnus-article-hide-signature
7119 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
7123 @kindex W W l (Summary)
7124 @findex gnus-article-hide-list-identifiers
7125 @vindex gnus-list-identifiers
7126 Strip list identifiers specified in @code{gnus-list-identifiers}. These
7127 are strings some mailing list servers add to the beginning of all
7128 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
7129 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
7130 may not contain @code{\\(..\\)}.
7134 @item gnus-list-identifiers
7135 @vindex gnus-list-identifiers
7136 A regular expression that matches list identifiers to be removed from
7137 subject. This can also be a list of regular expressions.
7142 @kindex W W p (Summary)
7143 @findex gnus-article-hide-pgp
7144 @vindex gnus-article-hide-pgp-hook
7145 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). The
7146 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
7147 signature has been hidden. For example, to automatically verify
7148 articles that have signatures in them do:
7150 ;;; Hide pgp cruft if any.
7152 (setq gnus-treat-strip-pgp t)
7154 ;;; After hiding pgp, verify the message;
7155 ;;; only happens if pgp signature is found.
7157 (add-hook 'gnus-article-hide-pgp-hook
7160 (set-buffer gnus-original-article-buffer)
7165 @kindex W W P (Summary)
7166 @findex gnus-article-hide-pem
7167 Hide @sc{pem} (privacy enhanced messages) cruft
7168 (@code{gnus-article-hide-pem}).
7171 @kindex W W B (Summary)
7172 @findex gnus-article-strip-banner
7175 @cindex stripping advertisments
7176 @cindex advertisments
7177 Strip the banner specified by the @code{banner} group parameter
7178 (@code{gnus-article-strip-banner}). This is mainly used to hide those
7179 annoying banners and/or signatures that some mailing lists and moderated
7180 groups adds to all the messages. The way to use this function is to add
7181 the @code{banner} group parameter (@pxref{Group Parameters}) to the
7182 group you want banners stripped from. The parameter either be a string,
7183 which will be interpreted as a regular expression matching text to be
7184 removed, or the symbol @code{signature}, meaning that the (last)
7185 signature should be removed.
7188 @kindex W W c (Summary)
7189 @findex gnus-article-hide-citation
7190 Hide citation (@code{gnus-article-hide-citation}). Some variables for
7191 customizing the hiding:
7195 @item gnus-cited-opened-text-button-line-format
7196 @itemx gnus-cited-closed-text-button-line-format
7197 @vindex gnus-cited-closed-text-button-line-format
7198 @vindex gnus-cited-opened-text-button-line-format
7199 Gnus adds buttons to show where the cited text has been hidden, and to
7200 allow toggle hiding the text. The format of the variable is specified
7201 by these format-like variable (@pxref{Formatting Variables}). These
7206 Starting point of the hidden text.
7208 Ending point of the hidden text.
7210 Number of characters in the hidden region.
7212 Number of lines of hidden text.
7215 @item gnus-cited-lines-visible
7216 @vindex gnus-cited-lines-visible
7217 The number of lines at the beginning of the cited text to leave
7218 shown. This can also be a cons cell with the number of lines at the top
7219 and bottom of the text, respectively, to remain visible.
7224 @kindex W W C-c (Summary)
7225 @findex gnus-article-hide-citation-maybe
7227 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
7228 following two variables:
7231 @item gnus-cite-hide-percentage
7232 @vindex gnus-cite-hide-percentage
7233 If the cited text is of a bigger percentage than this variable (default
7234 50), hide the cited text.
7236 @item gnus-cite-hide-absolute
7237 @vindex gnus-cite-hide-absolute
7238 The cited text must have at least this length (default 10) before it
7243 @kindex W W C (Summary)
7244 @findex gnus-article-hide-citation-in-followups
7245 Hide cited text in articles that aren't roots
7246 (@code{gnus-article-hide-citation-in-followups}). This isn't very
7247 useful as an interactive command, but might be a handy function to stick
7248 have happen automatically (@pxref{Customizing Articles}).
7252 All these ``hiding'' commands are toggles, but if you give a negative
7253 prefix to these commands, they will show what they have previously
7254 hidden. If you give a positive prefix, they will always hide.
7256 Also @pxref{Article Highlighting} for further variables for
7257 citation customization.
7259 @xref{Customizing Articles}, for how to hide article elements
7263 @node Article Washing
7264 @subsection Article Washing
7266 @cindex article washing
7268 We call this ``article washing'' for a really good reason. Namely, the
7269 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
7271 @dfn{Washing} is defined by us as ``changing something from something to
7272 something else'', but normally results in something looking better.
7278 @kindex W l (Summary)
7279 @findex gnus-summary-stop-page-breaking
7280 Remove page breaks from the current article
7281 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
7285 @kindex W r (Summary)
7286 @findex gnus-summary-caesar-message
7287 @c @icon{gnus-summary-caesar-message}
7288 Do a Caesar rotate (rot13) on the article buffer
7289 (@code{gnus-summary-caesar-message}).
7290 Unreadable articles that tell you to read them with Caesar rotate or rot13.
7291 (Typically offensive jokes and such.)
7293 It's commonly called ``rot13'' because each letter is rotated 13
7294 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
7295 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
7296 is rumored to have employed this form of, uh, somewhat weak encryption.
7300 @kindex W t (Summary)
7302 @findex gnus-summary-toggle-header
7303 Toggle whether to display all headers in the article buffer
7304 (@code{gnus-summary-toggle-header}).
7307 @kindex W v (Summary)
7308 @findex gnus-summary-verbose-header
7309 Toggle whether to display all headers in the article buffer permanently
7310 (@code{gnus-summary-verbose-header}).
7313 @kindex W o (Summary)
7314 @findex gnus-article-treat-overstrike
7315 Treat overstrike (@code{gnus-article-treat-overstrike}).
7318 @kindex W d (Summary)
7319 @findex gnus-article-treat-dumbquotes
7320 @vindex gnus-article-dumbquotes-map
7322 @cindex M******** sm*rtq**t*s
7324 Treat M******** sm*rtq**t*s according to
7325 @code{gnus-article-dumbquotes-map}
7326 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
7327 whether a character is a sm*rtq**t* or not, so it should only be used
7331 @kindex W w (Summary)
7332 @findex gnus-article-fill-cited-article
7333 Do word wrap (@code{gnus-article-fill-cited-article}).
7335 You can give the command a numerical prefix to specify the width to use
7339 @kindex W Q (Summary)
7340 @findex gnus-article-fill-long-lines
7341 Fill long lines (@code{gnus-article-fill-long-lines}).
7344 @kindex W C (Summary)
7345 @findex gnus-article-capitalize-sentences
7346 Capitalize the first word in each sentence
7347 (@code{gnus-article-capitalize-sentences}).
7350 @kindex W c (Summary)
7351 @findex gnus-article-remove-cr
7352 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
7353 (this takes care of DOS line endings), and then translate any remaining
7354 CRs into LF (this takes care of Mac line endings)
7355 (@code{gnus-article-remove-cr}).
7358 @kindex W q (Summary)
7359 @findex gnus-article-de-quoted-unreadable
7360 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
7361 Quoted-Printable is one common @sc{mime} encoding employed when sending
7362 non-ASCII (i. e., 8-bit) articles. It typically makes strings like
7363 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
7364 readable to me. Note that the this is usually done automatically by
7365 Gnus if the message in question has a @code{Content-Transfer-Encoding}
7366 header that says that this encoding has been done.
7369 @kindex W 6 (Summary)
7370 @findex gnus-article-de-base64-unreadable
7371 Treat base64 (@code{gnus-article-de-base64-unreadable}).
7372 Base64 is one common @sc{mime} encoding employed when sending non-ASCII
7373 (i. e., 8-bit) articles. Note that the this is usually done
7374 automatically by Gnus if the message in question has a
7375 @code{Content-Transfer-Encoding} header that says that this encoding has
7379 @kindex W Z (Summary)
7380 @findex gnus-article-decode-HZ
7381 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
7382 common encoding employed when sending Chinese articles. It typically
7383 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
7386 @kindex W h (Summary)
7387 @findex gnus-article-wash-html
7388 Treat HTML (@code{gnus-article-wash-html}).
7389 Note that the this is usually done automatically by Gnus if the message
7390 in question has a @code{Content-Type} header that says that this type
7394 @kindex W f (Summary)
7396 @findex gnus-article-display-x-face
7397 @findex gnus-article-x-face-command
7398 @vindex gnus-article-x-face-command
7399 @vindex gnus-article-x-face-too-ugly
7405 Look for and display any X-Face headers
7406 (@code{gnus-article-display-x-face}). The command executed by this
7407 function is given by the @code{gnus-article-x-face-command} variable.
7408 If this variable is a string, this string will be executed in a
7409 sub-shell. If it is a function, this function will be called with the
7410 face as the argument. If the @code{gnus-article-x-face-too-ugly} (which
7411 is a regexp) matches the @code{From} header, the face will not be shown.
7412 The default action under Emacs is to fork off the @code{display}
7413 program@footnote{@code{display} is from the ImageMagick package. For the
7414 @code{uncompface} and @code{icontopbm} programs look for a package
7415 like `compface' or `faces-xface' on a GNU/Linux system.}
7416 to view the face. Under XEmacs or Emacs 21+ with suitable image
7417 support, the default action is to display the face before the
7418 @code{From} header. (It's nicer if XEmacs has been compiled with X-Face
7419 support---that will make display somewhat faster. If there's no native
7420 X-Face support, Gnus will try to convert the @code{X-Face} header using
7421 external programs from the @code{pbmplus} package and
7422 friends.@footnote{On a GNU/Linux system look for packages with names
7423 like @code{netpbm} or @code{libgr-progs}.}) If you
7424 want to have this function in the display hook, it should probably come
7428 @kindex W b (Summary)
7429 @findex gnus-article-add-buttons
7430 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
7431 @xref{Article Buttons}.
7434 @kindex W B (Summary)
7435 @findex gnus-article-add-buttons-to-head
7436 Add clickable buttons to the article headers
7437 (@code{gnus-article-add-buttons-to-head}).
7440 @kindex W W H (Summary)
7441 @findex gnus-article-strip-headers-from-body
7442 Strip headers like the @code{X-No-Archive} header from the beginning of
7443 article bodies (@code{gnus-article-strip-headers-from-body}).
7446 @kindex W E l (Summary)
7447 @findex gnus-article-strip-leading-blank-lines
7448 Remove all blank lines from the beginning of the article
7449 (@code{gnus-article-strip-leading-blank-lines}).
7452 @kindex W E m (Summary)
7453 @findex gnus-article-strip-multiple-blank-lines
7454 Replace all blank lines with empty lines and then all multiple empty
7455 lines with a single empty line.
7456 (@code{gnus-article-strip-multiple-blank-lines}).
7459 @kindex W E t (Summary)
7460 @findex gnus-article-remove-trailing-blank-lines
7461 Remove all blank lines at the end of the article
7462 (@code{gnus-article-remove-trailing-blank-lines}).
7465 @kindex W E a (Summary)
7466 @findex gnus-article-strip-blank-lines
7467 Do all the three commands above
7468 (@code{gnus-article-strip-blank-lines}).
7471 @kindex W E A (Summary)
7472 @findex gnus-article-strip-all-blank-lines
7473 Remove all blank lines
7474 (@code{gnus-article-strip-all-blank-lines}).
7477 @kindex W E s (Summary)
7478 @findex gnus-article-strip-leading-space
7479 Remove all white space from the beginning of all lines of the article
7480 body (@code{gnus-article-strip-leading-space}).
7483 @kindex W E e (Summary)
7484 @findex gnus-article-strip-trailing-space
7485 Remove all white space from the end of all lines of the article
7486 body (@code{gnus-article-strip-trailing-space}).
7490 @xref{Customizing Articles}, for how to wash articles automatically.
7493 @node Article Buttons
7494 @subsection Article Buttons
7497 People often include references to other stuff in articles, and it would
7498 be nice if Gnus could just fetch whatever it is that people talk about
7499 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
7500 button on these references.
7502 Gnus adds @dfn{buttons} to certain standard references by default:
7503 Well-formed URLs, mail addresses and Message-IDs. This is controlled by
7504 two variables, one that handles article bodies and one that handles
7509 @item gnus-button-alist
7510 @vindex gnus-button-alist
7511 This is an alist where each entry has this form:
7514 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
7520 All text that match this regular expression will be considered an
7521 external reference. Here's a typical regexp that matches embedded URLs:
7522 @samp{<URL:\\([^\n\r>]*\\)>}.
7525 Gnus has to know which parts of the matches is to be highlighted. This
7526 is a number that says what sub-expression of the regexp is to be
7527 highlighted. If you want it all highlighted, you use 0 here.
7530 This form will be @code{eval}ed, and if the result is non-@code{nil},
7531 this is considered a match. This is useful if you want extra sifting to
7532 avoid false matches.
7535 This function will be called when you click on this button.
7538 As with @var{button-par}, this is a sub-expression number, but this one
7539 says which part of the match is to be sent as data to @var{function}.
7543 So the full entry for buttonizing URLs is then
7546 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
7549 @item gnus-header-button-alist
7550 @vindex gnus-header-button-alist
7551 This is just like the other alist, except that it is applied to the
7552 article head only, and that each entry has an additional element that is
7553 used to say what headers to apply the buttonize coding to:
7556 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
7559 @var{header} is a regular expression.
7561 @item gnus-button-url-regexp
7562 @vindex gnus-button-url-regexp
7563 A regular expression that matches embedded URLs. It is used in the
7564 default values of the variables above.
7566 @item gnus-article-button-face
7567 @vindex gnus-article-button-face
7568 Face used on buttons.
7570 @item gnus-article-mouse-face
7571 @vindex gnus-article-mouse-face
7572 Face used when the mouse cursor is over a button.
7576 @xref{Customizing Articles}, for how to buttonize articles automatically.
7580 @subsection Article Date
7582 The date is most likely generated in some obscure timezone you've never
7583 heard of, so it's quite nice to be able to find out what the time was
7584 when the article was sent.
7589 @kindex W T u (Summary)
7590 @findex gnus-article-date-ut
7591 Display the date in UT (aka. GMT, aka ZULU)
7592 (@code{gnus-article-date-ut}).
7595 @kindex W T i (Summary)
7596 @findex gnus-article-date-iso8601
7598 Display the date in international format, aka. ISO 8601
7599 (@code{gnus-article-date-iso8601}).
7602 @kindex W T l (Summary)
7603 @findex gnus-article-date-local
7604 Display the date in the local timezone (@code{gnus-article-date-local}).
7607 @kindex W T s (Summary)
7608 @vindex gnus-article-time-format
7609 @findex gnus-article-date-user
7610 @findex format-time-string
7611 Display the date using a user-defined format
7612 (@code{gnus-article-date-user}). The format is specified by the
7613 @code{gnus-article-time-format} variable, and is a string that's passed
7614 to @code{format-time-string}. See the documentation of that variable
7615 for a list of possible format specs.
7618 @kindex W T e (Summary)
7619 @findex gnus-article-date-lapsed
7620 @findex gnus-start-date-timer
7621 @findex gnus-stop-date-timer
7622 Say how much time has elapsed between the article was posted and now
7623 (@code{gnus-article-date-lapsed}). It looks something like:
7626 X-Sent: 9 years, 6 weeks, 4 days, 9 hours, 3 minutes, 28 seconds ago
7629 The value of @code{gnus-article-date-lapsed-new-header} determines
7630 whether this header will just be added below the old Date one, or will
7633 An advantage of using Gnus to read mail is that it converts simple bugs
7634 into wonderful absurdities.
7636 If you want to have this line updated continually, you can put
7639 (gnus-start-date-timer)
7642 in your @file{.gnus.el} file, or you can run it off of some hook. If
7643 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
7647 @kindex W T o (Summary)
7648 @findex gnus-article-date-original
7649 Display the original date (@code{gnus-article-date-original}). This can
7650 be useful if you normally use some other conversion function and are
7651 worried that it might be doing something totally wrong. Say, claiming
7652 that the article was posted in 1854. Although something like that is
7653 @emph{totally} impossible. Don't you trust me? *titter*
7657 @xref{Customizing Articles}, for how to display the date in your
7658 preferred format automatically.
7661 @node Article Signature
7662 @subsection Article Signature
7664 @cindex article signature
7666 @vindex gnus-signature-separator
7667 Each article is divided into two parts---the head and the body. The
7668 body can be divided into a signature part and a text part. The variable
7669 that says what is to be considered a signature is
7670 @code{gnus-signature-separator}. This is normally the standard
7671 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
7672 non-standard signature separators, so this variable can also be a list
7673 of regular expressions to be tested, one by one. (Searches are done
7674 from the end of the body towards the beginning.) One likely value is:
7677 (setq gnus-signature-separator
7678 '("^-- $" ; The standard
7679 "^-- *$" ; A common mangling
7680 "^-------*$" ; Many people just use a looong
7681 ; line of dashes. Shame!
7682 "^ *--------*$" ; Double-shame!
7683 "^________*$" ; Underscores are also popular
7684 "^========*$")) ; Pervert!
7687 The more permissive you are, the more likely it is that you'll get false
7690 @vindex gnus-signature-limit
7691 @code{gnus-signature-limit} provides a limit to what is considered a
7692 signature when displaying articles.
7696 If it is an integer, no signature may be longer (in characters) than
7699 If it is a floating point number, no signature may be longer (in lines)
7702 If it is a function, the function will be called without any parameters,
7703 and if it returns @code{nil}, there is no signature in the buffer.
7705 If it is a string, it will be used as a regexp. If it matches, the text
7706 in question is not a signature.
7709 This variable can also be a list where the elements may be of the types
7710 listed above. Here's an example:
7713 (setq gnus-signature-limit
7714 '(200.0 "^---*Forwarded article"))
7717 This means that if there are more than 200 lines after the signature
7718 separator, or the text after the signature separator is matched by
7719 the regular expression @samp{^---*Forwarded article}, then it isn't a
7720 signature after all.
7723 @node Article Miscellania
7724 @subsection Article Miscellania
7728 @kindex A t (Summary)
7729 @findex gnus-article-babel
7730 Translate the article from one language to another
7731 (@code{gnus-article-babel}).
7737 @section @sc{mime} Commands
7738 @cindex MIME decoding
7740 @cindex viewing attachments
7742 The following commands all understand the numerical prefix. For
7743 instance, @kbd{3 b} means ``view the third @sc{mime} part''.
7749 @kindex K v (Summary)
7750 View the @sc{mime} part.
7753 @kindex K o (Summary)
7754 Save the @sc{mime} part.
7757 @kindex K c (Summary)
7758 Copy the @sc{mime} part.
7761 @kindex K e (Summary)
7762 View the @sc{mime} part externally.
7765 @kindex K i (Summary)
7766 View the @sc{mime} part internally.
7769 @kindex K | (Summary)
7770 Pipe the @sc{mime} part to an external command.
7773 The rest of these @sc{mime} commands do not use the numerical prefix in
7778 @kindex K b (Summary)
7779 Make all the @sc{mime} parts have buttons in front of them. This is
7780 mostly useful if you wish to save (or perform other actions) on inlined
7784 @kindex K m (Summary)
7785 @findex gnus-summary-repair-multipart
7786 Some multipart messages are transmitted with missing or faulty headers.
7787 This command will attempt to ``repair'' these messages so that they can
7788 be viewed in a more pleasant manner
7789 (@code{gnus-summary-repair-multipart}).
7792 @kindex X m (Summary)
7793 @findex gnus-summary-save-parts
7794 Save all parts matching a @sc{mime} type to a directory
7795 (@code{gnus-summary-save-parts}). Understands the process/prefix
7796 convention (@pxref{Process/Prefix}).
7799 @kindex M-t (Summary)
7800 @findex gnus-summary-display-buttonized
7801 Toggle the buttonized display of the article buffer
7802 (@code{gnus-summary-toggle-display-buttonized}).
7805 @kindex W M w (Summary)
7806 Decode RFC 2047-encoded words in the article headers
7807 (@code{gnus-article-decode-mime-words}).
7810 @kindex W M c (Summary)
7811 Decode encoded article bodies as well as charsets
7812 (@code{gnus-article-decode-charset}).
7814 This command looks in the @code{Content-Type} header to determine the
7815 charset. If there is no such header in the article, you can give it a
7816 prefix, which will prompt for the charset to decode as. In regional
7817 groups where people post using some common encoding (but do not include
7818 MIME headers), you can set the @code{charset} group/topic parameter to
7819 the required charset (@pxref{Group Parameters}).
7822 @kindex W M v (Summary)
7823 View all the @sc{mime} parts in the current article
7824 (@code{gnus-mime-view-all-parts}).
7831 @item gnus-ignored-mime-types
7832 @vindex gnus-ignored-mime-types
7833 This is a list of regexps. @sc{mime} types that match a regexp from
7834 this list will be completely ignored by Gnus. The default value is
7837 To have all Vcards be ignored, you'd say something like this:
7840 (setq gnus-ignored-mime-types
7844 @item gnus-unbuttonized-mime-types
7845 @vindex gnus-unbuttonized-mime-types
7846 This is a list of regexps. @sc{mime} types that match a regexp from
7847 this list won't have @sc{mime} buttons inserted unless they aren't
7848 displayed. The default value is @code{(".*/.*")}.
7850 @item gnus-article-mime-part-function
7851 @vindex gnus-article-mime-part-function
7852 For each @sc{mime} part, this function will be called with the @sc{mime}
7853 handle as the parameter. The function is meant to be used to allow
7854 users to gather information from the article (e. g., add Vcard info to
7855 the bbdb database) or to do actions based on parts (e. g., automatically
7856 save all jpegs into some directory).
7858 Here's an example function the does the latter:
7861 (defun my-save-all-jpeg-parts (handle)
7862 (when (equal (car (mm-handle-type handle)) "image/jpeg")
7864 (insert (mm-get-part handle))
7865 (write-region (point-min) (point-max)
7866 (read-file-name "Save jpeg to: ")))))
7867 (setq gnus-article-mime-part-function
7868 'my-save-all-jpeg-parts)
7871 @vindex gnus-mime-multipart-functions
7872 @item gnus-mime-multipart-functions
7873 Alist of @sc{mime} multipart types and functions to handle them.
7882 People use different charsets, and we have @sc{mime} to let us know what
7883 charsets they use. Or rather, we wish we had. Many people use
7884 newsreaders and mailers that do not understand or use @sc{mime}, and
7885 just send out messages without saying what character sets they use. To
7886 help a bit with this, some local news hierarchies have policies that say
7887 what character set is the default. For instance, the @samp{fj}
7888 hierarchy uses @code{iso-2022-jp-2}.
7890 @vindex gnus-group-charset-alist
7891 This knowledge is encoded in the @code{gnus-group-charset-alist}
7892 variable, which is an alist of regexps (to match group names) and
7893 default charsets to be used when reading these groups.
7895 In addition, some people do use soi-disant @sc{mime}-aware agents that
7896 aren't. These blitely mark messages as being in @code{iso-8859-1} even
7897 if they really are in @code{koi-8}. To help here, the
7898 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
7899 charsets that are listed here will be ignored. The variable can be set
7900 on a group-by-group basis using the group parameters (@pxref{Group
7901 Parameters}). The default value is @code{(unknown-8bit)}, which is
7902 something some agents insist on having in there.
7904 @vindex gnus-group-posting-charset-alist
7905 When posting, @code{gnus-group-posting-charset-alist} is used to
7906 determine which charsets should not be encoded using the @sc{mime}
7907 encodings. For instance, some hierarchies discourage using
7908 quoted-printable header encoding.
7910 This variable is an alist of regexps and permitted unencoded charsets
7911 for posting. Each element of the alist has the form @code{(}@var{test
7912 header body-list}@code{)}, where:
7916 is either a regular expression matching the newsgroup header or a
7919 is the charset which may be left unencoded in the header (@code{nil}
7920 means encode all charsets),
7922 is a list of charsets which may be encoded using 8bit content-transfer
7923 encoding in the body, or one of the special values @code{nil} (always
7924 encode using quoted-printable) or @code{t} (always use 8bit).
7931 @cindex coding system aliases
7932 @cindex preferred charset
7934 Other charset tricks that may be useful, although not Gnus-specific:
7936 If there are several @sc{mime} charsets that encode the same Emacs
7937 charset, you can choose what charset to use by saying the following:
7940 (put-charset-property 'cyrillic-iso8859-5
7941 'preferred-coding-system 'koi8-r)
7944 This means that Russian will be encoded using @code{koi8-r} instead of
7945 the default @code{iso-8859-5} @sc{mime} charset.
7947 If you want to read messages in @code{koi8-u}, you can cheat and say
7950 (define-coding-system-alias 'koi8-u 'koi8-r)
7953 This will almost do the right thing.
7955 And finally, to read charsets like @code{windows-1251}, you can say
7959 (codepage-setup 1251)
7960 (define-coding-system-alias 'windows-1251 'cp1251)
7964 @node Article Commands
7965 @section Article Commands
7972 @kindex A P (Summary)
7973 @vindex gnus-ps-print-hook
7974 @findex gnus-summary-print-article
7975 Generate and print a PostScript image of the article buffer
7976 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be
7977 run just before printing the buffer.
7982 @node Summary Sorting
7983 @section Summary Sorting
7984 @cindex summary sorting
7986 You can have the summary buffer sorted in various ways, even though I
7987 can't really see why you'd want that.
7992 @kindex C-c C-s C-n (Summary)
7993 @findex gnus-summary-sort-by-number
7994 Sort by article number (@code{gnus-summary-sort-by-number}).
7997 @kindex C-c C-s C-a (Summary)
7998 @findex gnus-summary-sort-by-author
7999 Sort by author (@code{gnus-summary-sort-by-author}).
8002 @kindex C-c C-s C-s (Summary)
8003 @findex gnus-summary-sort-by-subject
8004 Sort by subject (@code{gnus-summary-sort-by-subject}).
8007 @kindex C-c C-s C-d (Summary)
8008 @findex gnus-summary-sort-by-date
8009 Sort by date (@code{gnus-summary-sort-by-date}).
8012 @kindex C-c C-s C-l (Summary)
8013 @findex gnus-summary-sort-by-lines
8014 Sort by lines (@code{gnus-summary-sort-by-lines}).
8017 @kindex C-c C-s C-c (Summary)
8018 @findex gnus-summary-sort-by-chars
8019 Sort by article length (@code{gnus-summary-sort-by-chars}).
8022 @kindex C-c C-s C-i (Summary)
8023 @findex gnus-summary-sort-by-score
8024 Sort by score (@code{gnus-summary-sort-by-score}).
8027 These functions will work both when you use threading and when you don't
8028 use threading. In the latter case, all summary lines will be sorted,
8029 line by line. In the former case, sorting will be done on a
8030 root-by-root basis, which might not be what you were looking for. To
8031 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
8035 @node Finding the Parent
8036 @section Finding the Parent
8037 @cindex parent articles
8038 @cindex referring articles
8043 @findex gnus-summary-refer-parent-article
8044 If you'd like to read the parent of the current article, and it is not
8045 displayed in the summary buffer, you might still be able to. That is,
8046 if the current group is fetched by @sc{nntp}, the parent hasn't expired
8047 and the @code{References} in the current article are not mangled, you
8048 can just press @kbd{^} or @kbd{A r}
8049 (@code{gnus-summary-refer-parent-article}). If everything goes well,
8050 you'll get the parent. If the parent is already displayed in the
8051 summary buffer, point will just move to this article.
8053 If given a positive numerical prefix, fetch that many articles back into
8054 the ancestry. If given a negative numerical prefix, fetch just that
8055 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
8056 grandparent and the grandgrandparent of the current article. If you say
8057 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
8061 @findex gnus-summary-refer-references
8062 @kindex A R (Summary)
8063 Fetch all articles mentioned in the @code{References} header of the
8064 article (@code{gnus-summary-refer-references}).
8067 @findex gnus-summary-refer-thread
8068 @kindex A T (Summary)
8069 Display the full thread where the current article appears
8070 (@code{gnus-summary-refer-thread}). This command has to fetch all the
8071 headers in the current group to work, so it usually takes a while. If
8072 you do it often, you may consider setting @code{gnus-fetch-old-headers}
8073 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
8074 visible effects normally, but it'll make this command work a whole lot
8075 faster. Of course, it'll make group entry somewhat slow.
8077 @vindex gnus-refer-thread-limit
8078 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
8079 articles before the first displayed in the current group) headers to
8080 fetch when doing this command. The default is 200. If @code{t}, all
8081 the available headers will be fetched. This variable can be overridden
8082 by giving the @kbd{A T} command a numerical prefix.
8085 @findex gnus-summary-refer-article
8086 @kindex M-^ (Summary)
8088 @cindex fetching by Message-ID
8089 You can also ask the @sc{nntp} server for an arbitrary article, no
8090 matter what group it belongs to. @kbd{M-^}
8091 (@code{gnus-summary-refer-article}) will ask you for a
8092 @code{Message-ID}, which is one of those long, hard-to-read thingies
8093 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
8094 have to get it all exactly right. No fuzzy searches, I'm afraid.
8097 The current select method will be used when fetching by
8098 @code{Message-ID} from non-news select method, but you can override this
8099 by giving this command a prefix.
8101 @vindex gnus-refer-article-method
8102 If the group you are reading is located on a backend that does not
8103 support fetching by @code{Message-ID} very well (like @code{nnspool}),
8104 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
8105 would, perhaps, be best if the @sc{nntp} server you consult is the one
8106 updating the spool you are reading from, but that's not really
8109 It can also be a list of select methods, as well as the special symbol
8110 @code{current}, which means to use the current select method. If it
8111 is a list, Gnus will try all the methods in the list until it finds a
8114 Here's an example setting that will first try the current method, and
8115 then ask Deja if that fails:
8118 (setq gnus-refer-article-method
8120 (nnweb "refer" (nnweb-type dejanews))))
8123 Most of the mail backends support fetching by @code{Message-ID}, but do
8124 not do a particularly excellent job at it. That is, @code{nnmbox} and
8125 @code{nnbabyl} are able to locate articles from any groups, while
8126 @code{nnml} and @code{nnfolder} are only able to locate articles that
8127 have been posted to the current group. (Anything else would be too time
8128 consuming.) @code{nnmh} does not support this at all.
8131 @node Alternative Approaches
8132 @section Alternative Approaches
8134 Different people like to read news using different methods. This being
8135 Gnus, we offer a small selection of minor modes for the summary buffers.
8138 * Pick and Read:: First mark articles and then read them.
8139 * Binary Groups:: Auto-decode all articles.
8144 @subsection Pick and Read
8145 @cindex pick and read
8147 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
8148 a two-phased reading interface. The user first marks in a summary
8149 buffer the articles she wants to read. Then she starts reading the
8150 articles with just an article buffer displayed.
8152 @findex gnus-pick-mode
8153 @kindex M-x gnus-pick-mode
8154 Gnus provides a summary buffer minor mode that allows
8155 this---@code{gnus-pick-mode}. This basically means that a few process
8156 mark commands become one-keystroke commands to allow easy marking, and
8157 it provides one additional command for switching to the summary buffer.
8159 Here are the available keystrokes when using pick mode:
8164 @findex gnus-pick-article-or-thread
8165 Pick the article or thread on the current line
8166 (@code{gnus-pick-article-or-thread}). If the variable
8167 @code{gnus-thread-hide-subtree} is true, then this key selects the
8168 entire thread when used at the first article of the thread. Otherwise,
8169 it selects just the article. If given a numerical prefix, go to that
8170 thread or article and pick it. (The line number is normally displayed
8171 at the beginning of the summary pick lines.)
8174 @kindex SPACE (Pick)
8175 @findex gnus-pick-next-page
8176 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
8177 at the end of the buffer, start reading the picked articles.
8181 @findex gnus-pick-unmark-article-or-thread.
8182 Unpick the thread or article
8183 (@code{gnus-pick-unmark-article-or-thread}). If the variable
8184 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
8185 thread if used at the first article of the thread. Otherwise it unpicks
8186 just the article. You can give this key a numerical prefix to unpick
8187 the thread or article at that line.
8191 @findex gnus-pick-start-reading
8192 @vindex gnus-pick-display-summary
8193 Start reading the picked articles (@code{gnus-pick-start-reading}). If
8194 given a prefix, mark all unpicked articles as read first. If
8195 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
8196 will still be visible when you are reading.
8200 All the normal summary mode commands are still available in the
8201 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
8202 which is mapped to the same function
8203 @code{gnus-summary-tick-article-forward}.
8205 If this sounds like a good idea to you, you could say:
8208 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
8211 @vindex gnus-pick-mode-hook
8212 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
8214 @vindex gnus-mark-unpicked-articles-as-read
8215 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
8216 all unpicked articles as read. The default is @code{nil}.
8218 @vindex gnus-summary-pick-line-format
8219 The summary line format in pick mode is slightly different from the
8220 standard format. At the beginning of each line the line number is
8221 displayed. The pick mode line format is controlled by the
8222 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
8223 Variables}). It accepts the same format specs that
8224 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
8228 @subsection Binary Groups
8229 @cindex binary groups
8231 @findex gnus-binary-mode
8232 @kindex M-x gnus-binary-mode
8233 If you spend much time in binary groups, you may grow tired of hitting
8234 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
8235 is a minor mode for summary buffers that makes all ordinary Gnus article
8236 selection functions uudecode series of articles and display the result
8237 instead of just displaying the articles the normal way.
8240 @findex gnus-binary-show-article
8241 The only way, in fact, to see the actual articles is the @kbd{g}
8242 command, when you have turned on this mode
8243 (@code{gnus-binary-show-article}).
8245 @vindex gnus-binary-mode-hook
8246 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
8250 @section Tree Display
8253 @vindex gnus-use-trees
8254 If you don't like the normal Gnus summary display, you might try setting
8255 @code{gnus-use-trees} to @code{t}. This will create (by default) an
8256 additional @dfn{tree buffer}. You can execute all summary mode commands
8259 There are a few variables to customize the tree display, of course:
8262 @item gnus-tree-mode-hook
8263 @vindex gnus-tree-mode-hook
8264 A hook called in all tree mode buffers.
8266 @item gnus-tree-mode-line-format
8267 @vindex gnus-tree-mode-line-format
8268 A format string for the mode bar in the tree mode buffers (@pxref{Mode
8269 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
8270 of valid specs, @pxref{Summary Buffer Mode Line}.
8272 @item gnus-selected-tree-face
8273 @vindex gnus-selected-tree-face
8274 Face used for highlighting the selected article in the tree buffer. The
8275 default is @code{modeline}.
8277 @item gnus-tree-line-format
8278 @vindex gnus-tree-line-format
8279 A format string for the tree nodes. The name is a bit of a misnomer,
8280 though---it doesn't define a line, but just the node. The default value
8281 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
8282 the name of the poster. It is vital that all nodes are of the same
8283 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
8289 The name of the poster.
8291 The @code{From} header.
8293 The number of the article.
8295 The opening bracket.
8297 The closing bracket.
8302 @xref{Formatting Variables}.
8304 Variables related to the display are:
8307 @item gnus-tree-brackets
8308 @vindex gnus-tree-brackets
8309 This is used for differentiating between ``real'' articles and
8310 ``sparse'' articles. The format is @code{((@var{real-open} . @var{real-close})
8311 (@var{sparse-open} . @var{sparse-close}) (@var{dummy-open} . @var{dummy-close}))}, and the
8312 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
8314 @item gnus-tree-parent-child-edges
8315 @vindex gnus-tree-parent-child-edges
8316 This is a list that contains the characters used for connecting parent
8317 nodes to their children. The default is @code{(?- ?\\ ?|)}.
8321 @item gnus-tree-minimize-window
8322 @vindex gnus-tree-minimize-window
8323 If this variable is non-@code{nil}, Gnus will try to keep the tree
8324 buffer as small as possible to allow more room for the other Gnus
8325 windows. If this variable is a number, the tree buffer will never be
8326 higher than that number. The default is @code{t}. Note that if you
8327 have several windows displayed side-by-side in a frame and the tree
8328 buffer is one of these, minimizing the tree window will also resize all
8329 other windows displayed next to it.
8331 @item gnus-generate-tree-function
8332 @vindex gnus-generate-tree-function
8333 @findex gnus-generate-horizontal-tree
8334 @findex gnus-generate-vertical-tree
8335 The function that actually generates the thread tree. Two predefined
8336 functions are available: @code{gnus-generate-horizontal-tree} and
8337 @code{gnus-generate-vertical-tree} (which is the default).
8341 Here's an example from a horizontal tree buffer:
8344 @{***@}-(***)-[odd]-[Gun]
8354 Here's the same thread displayed in a vertical tree buffer:
8358 |--------------------------\-----\-----\
8359 (***) [Bjo] [Gun] [Gun]
8361 [odd] [Jan] [odd] (***) [Jor]
8363 [Gun] [Eri] [Eri] [odd]
8368 If you're using horizontal trees, it might be nice to display the trees
8369 side-by-side with the summary buffer. You could add something like the
8370 following to your @file{.gnus.el} file:
8373 (setq gnus-use-trees t
8374 gnus-generate-tree-function 'gnus-generate-horizontal-tree
8375 gnus-tree-minimize-window nil)
8376 (gnus-add-configuration
8380 (summary 0.75 point)
8385 @xref{Windows Configuration}.
8388 @node Mail Group Commands
8389 @section Mail Group Commands
8390 @cindex mail group commands
8392 Some commands only make sense in mail groups. If these commands are
8393 invalid in the current group, they will raise a hell and let you know.
8395 All these commands (except the expiry and edit commands) use the
8396 process/prefix convention (@pxref{Process/Prefix}).
8401 @kindex B e (Summary)
8402 @findex gnus-summary-expire-articles
8403 Expire all expirable articles in the group
8404 (@code{gnus-summary-expire-articles}).
8407 @kindex B M-C-e (Summary)
8408 @findex gnus-summary-expire-articles-now
8409 Delete all the expirable articles in the group
8410 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
8411 articles eligible for expiry in the current group will
8412 disappear forever into that big @file{/dev/null} in the sky.
8415 @kindex B DEL (Summary)
8416 @findex gnus-summary-delete-article
8417 @c @icon{gnus-summary-mail-delete}
8418 Delete the mail article. This is ``delete'' as in ``delete it from your
8419 disk forever and ever, never to return again.'' Use with caution.
8420 (@code{gnus-summary-delete-article}).
8423 @kindex B m (Summary)
8425 @findex gnus-summary-move-article
8426 @vindex gnus-preserve-marks
8427 Move the article from one mail group to another
8428 (@code{gnus-summary-move-article}). Marks will be preserved if
8429 @var{gnus-preserve-marks} is non-@code{nil} (which is the default).
8432 @kindex B c (Summary)
8434 @findex gnus-summary-copy-article
8435 @c @icon{gnus-summary-mail-copy}
8436 Copy the article from one group (mail group or not) to a mail group
8437 (@code{gnus-summary-copy-article}). Marks will be preserved if
8438 @var{gnus-preserve-marks} is non-@code{nil} (which is the default).
8441 @kindex B B (Summary)
8442 @cindex crosspost mail
8443 @findex gnus-summary-crosspost-article
8444 Crosspost the current article to some other group
8445 (@code{gnus-summary-crosspost-article}). This will create a new copy of
8446 the article in the other group, and the Xref headers of the article will
8447 be properly updated.
8450 @kindex B i (Summary)
8451 @findex gnus-summary-import-article
8452 Import an arbitrary file into the current mail newsgroup
8453 (@code{gnus-summary-import-article}). You will be prompted for a file
8454 name, a @code{From} header and a @code{Subject} header.
8457 @kindex B r (Summary)
8458 @findex gnus-summary-respool-article
8459 Respool the mail article (@code{gnus-summary-respool-article}).
8460 @code{gnus-summary-respool-default-method} will be used as the default
8461 select method when respooling. This variable is @code{nil} by default,
8462 which means that the current group select method will be used instead.
8463 Marks will be preserved if @var{gnus-preserve-marks} is non-@code{nil}
8464 (which is the default).
8468 @kindex B w (Summary)
8470 @findex gnus-summary-edit-article
8471 @kindex C-c C-c (Article)
8472 Edit the current article (@code{gnus-summary-edit-article}). To finish
8473 editing and make the changes permanent, type @kbd{C-c C-c}
8474 (@kbd{gnus-summary-edit-article-done}). If you give a prefix to the
8475 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
8478 @kindex B q (Summary)
8479 @findex gnus-summary-respool-query
8480 If you want to re-spool an article, you might be curious as to what group
8481 the article will end up in before you do the re-spooling. This command
8482 will tell you (@code{gnus-summary-respool-query}).
8485 @kindex B t (Summary)
8486 @findex gnus-summary-respool-trace
8487 Similarly, this command will display all fancy splitting patterns used
8488 when repooling, if any (@code{gnus-summary-respool-trace}).
8491 @kindex B p (Summary)
8492 @findex gnus-summary-article-posted-p
8493 Some people have a tendency to send you "courtesy" copies when they
8494 follow up to articles you have posted. These usually have a
8495 @code{Newsgroups} header in them, but not always. This command
8496 (@code{gnus-summary-article-posted-p}) will try to fetch the current
8497 article from your news server (or rather, from
8498 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
8499 report back whether it found the article or not. Even if it says that
8500 it didn't find the article, it may have been posted anyway---mail
8501 propagation is much faster than news propagation, and the news copy may
8502 just not have arrived yet.
8506 @vindex gnus-move-split-methods
8507 @cindex moving articles
8508 If you move (or copy) articles regularly, you might wish to have Gnus
8509 suggest where to put the articles. @code{gnus-move-split-methods} is a
8510 variable that uses the same syntax as @code{gnus-split-methods}
8511 (@pxref{Saving Articles}). You may customize that variable to create
8512 suggestions you find reasonable.
8515 (setq gnus-move-split-methods
8516 '(("^From:.*Lars Magne" "nnml:junk")
8517 ("^Subject:.*gnus" "nnfolder:important")
8518 (".*" "nnml:misc")))
8522 @node Various Summary Stuff
8523 @section Various Summary Stuff
8526 * Summary Group Information:: Information oriented commands.
8527 * Searching for Articles:: Multiple article commands.
8528 * Summary Generation Commands:: (Re)generating the summary buffer.
8529 * Really Various Summary Commands:: Those pesky non-conformant commands.
8533 @vindex gnus-summary-mode-hook
8534 @item gnus-summary-mode-hook
8535 This hook is called when creating a summary mode buffer.
8537 @vindex gnus-summary-generate-hook
8538 @item gnus-summary-generate-hook
8539 This is called as the last thing before doing the threading and the
8540 generation of the summary buffer. It's quite convenient for customizing
8541 the threading variables based on what data the newsgroup has. This hook
8542 is called from the summary buffer after most summary buffer variables
8545 @vindex gnus-summary-prepare-hook
8546 @item gnus-summary-prepare-hook
8547 It is called after the summary buffer has been generated. You might use
8548 it to, for instance, highlight lines or modify the look of the buffer in
8549 some other ungodly manner. I don't care.
8551 @vindex gnus-summary-prepared-hook
8552 @item gnus-summary-prepared-hook
8553 A hook called as the very last thing after the summary buffer has been
8556 @vindex gnus-summary-ignore-duplicates
8557 @item gnus-summary-ignore-duplicates
8558 When Gnus discovers two articles that have the same @code{Message-ID},
8559 it has to do something drastic. No articles are allowed to have the
8560 same @code{Message-ID}, but this may happen when reading mail from some
8561 sources. Gnus allows you to customize what happens with this variable.
8562 If it is @code{nil} (which is the default), Gnus will rename the
8563 @code{Message-ID} (for display purposes only) and display the article as
8564 any other article. If this variable is @code{t}, it won't display the
8565 article---it'll be as if it never existed.
8567 @vindex gnus-alter-articles-to-read-function
8568 @item gnus-alter-articles-to-read-function
8569 This function, which takes two parameters (the group name and the list
8570 of articles to be selected), is called to allow the user to alter the
8571 list of articles to be selected.
8573 For instance, the following function adds the list of cached articles to
8574 the list in one particular group:
8577 (defun my-add-cached-articles (group articles)
8578 (if (string= group "some.group")
8579 (append gnus-newsgroup-cached articles)
8586 @node Summary Group Information
8587 @subsection Summary Group Information
8592 @kindex H f (Summary)
8593 @findex gnus-summary-fetch-faq
8594 @vindex gnus-group-faq-directory
8595 Try to fetch the FAQ (list of frequently asked questions) for the
8596 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
8597 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
8598 on a remote machine. This variable can also be a list of directories.
8599 In that case, giving a prefix to this command will allow you to choose
8600 between the various sites. @code{ange-ftp} or @code{efs} will probably
8601 be used for fetching the file.
8604 @kindex H d (Summary)
8605 @findex gnus-summary-describe-group
8606 Give a brief description of the current group
8607 (@code{gnus-summary-describe-group}). If given a prefix, force
8608 rereading the description from the server.
8611 @kindex H h (Summary)
8612 @findex gnus-summary-describe-briefly
8613 Give an extremely brief description of the most important summary
8614 keystrokes (@code{gnus-summary-describe-briefly}).
8617 @kindex H i (Summary)
8618 @findex gnus-info-find-node
8619 Go to the Gnus info node (@code{gnus-info-find-node}).
8623 @node Searching for Articles
8624 @subsection Searching for Articles
8629 @kindex M-s (Summary)
8630 @findex gnus-summary-search-article-forward
8631 Search through all subsequent articles for a regexp
8632 (@code{gnus-summary-search-article-forward}).
8635 @kindex M-r (Summary)
8636 @findex gnus-summary-search-article-backward
8637 Search through all previous articles for a regexp
8638 (@code{gnus-summary-search-article-backward}).
8642 @findex gnus-summary-execute-command
8643 This command will prompt you for a header, a regular expression to match
8644 on this field, and a command to be executed if the match is made
8645 (@code{gnus-summary-execute-command}). If the header is an empty
8646 string, the match is done on the entire article. If given a prefix,
8647 search backward instead.
8649 For instance, @kbd{& RET some.*string #} will put the process mark on
8650 all articles that have heads or bodies that match @samp{some.*string}.
8653 @kindex M-& (Summary)
8654 @findex gnus-summary-universal-argument
8655 Perform any operation on all articles that have been marked with
8656 the process mark (@code{gnus-summary-universal-argument}).
8659 @node Summary Generation Commands
8660 @subsection Summary Generation Commands
8665 @kindex Y g (Summary)
8666 @findex gnus-summary-prepare
8667 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
8670 @kindex Y c (Summary)
8671 @findex gnus-summary-insert-cached-articles
8672 Pull all cached articles (for the current group) into the summary buffer
8673 (@code{gnus-summary-insert-cached-articles}).
8678 @node Really Various Summary Commands
8679 @subsection Really Various Summary Commands
8685 @kindex C-d (Summary)
8686 @kindex A D (Summary)
8687 @findex gnus-summary-enter-digest-group
8688 If the current article is a collection of other articles (for instance,
8689 a digest), you might use this command to enter a group based on the that
8690 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
8691 guess what article type is currently displayed unless you give a prefix
8692 to this command, which forces a ``digest'' interpretation. Basically,
8693 whenever you see a message that is a collection of other messages of
8694 some format, you @kbd{C-d} and read these messages in a more convenient
8698 @kindex M-C-d (Summary)
8699 @findex gnus-summary-read-document
8700 This command is very similar to the one above, but lets you gather
8701 several documents into one biiig group
8702 (@code{gnus-summary-read-document}). It does this by opening several
8703 @code{nndoc} groups for each document, and then opening an
8704 @code{nnvirtual} group on top of these @code{nndoc} groups. This
8705 command understands the process/prefix convention
8706 (@pxref{Process/Prefix}).
8709 @kindex C-t (Summary)
8710 @findex gnus-summary-toggle-truncation
8711 Toggle truncation of summary lines
8712 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
8713 line centering function in the summary buffer, so it's not a good idea
8714 to have truncation switched off while reading articles.
8718 @findex gnus-summary-expand-window
8719 Expand the summary buffer window (@code{gnus-summary-expand-window}).
8720 If given a prefix, force an @code{article} window configuration.
8723 @kindex M-C-e (Summary)
8724 @findex gnus-summary-edit-parameters
8725 Edit the group parameters (@pxref{Group Parameters}) of the current
8726 group (@code{gnus-summary-edit-parameters}).
8729 @kindex M-C-a (Summary)
8730 @findex gnus-summary-customize-parameters
8731 Customize the group parameters (@pxref{Group Parameters}) of the current
8732 group (@code{gnus-summary-customize-parameters}).
8737 @node Exiting the Summary Buffer
8738 @section Exiting the Summary Buffer
8739 @cindex summary exit
8740 @cindex exiting groups
8742 Exiting from the summary buffer will normally update all info on the
8743 group and return you to the group buffer.
8749 @kindex Z Z (Summary)
8751 @findex gnus-summary-exit
8752 @vindex gnus-summary-exit-hook
8753 @vindex gnus-summary-prepare-exit-hook
8754 @c @icon{gnus-summary-exit}
8755 Exit the current group and update all information on the group
8756 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
8757 called before doing much of the exiting, which calls
8758 @code{gnus-summary-expire-articles} by default.
8759 @code{gnus-summary-exit-hook} is called after finishing the exit
8760 process. @code{gnus-group-no-more-groups-hook} is run when returning to
8761 group mode having no more (unread) groups.
8765 @kindex Z E (Summary)
8767 @findex gnus-summary-exit-no-update
8768 Exit the current group without updating any information on the group
8769 (@code{gnus-summary-exit-no-update}).
8773 @kindex Z c (Summary)
8775 @findex gnus-summary-catchup-and-exit
8776 @c @icon{gnus-summary-catchup-and-exit}
8777 Mark all unticked articles in the group as read and then exit
8778 (@code{gnus-summary-catchup-and-exit}).
8781 @kindex Z C (Summary)
8782 @findex gnus-summary-catchup-all-and-exit
8783 Mark all articles, even the ticked ones, as read and then exit
8784 (@code{gnus-summary-catchup-all-and-exit}).
8787 @kindex Z n (Summary)
8788 @findex gnus-summary-catchup-and-goto-next-group
8789 Mark all articles as read and go to the next group
8790 (@code{gnus-summary-catchup-and-goto-next-group}).
8793 @kindex Z R (Summary)
8794 @findex gnus-summary-reselect-current-group
8795 Exit this group, and then enter it again
8796 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
8797 all articles, both read and unread.
8801 @kindex Z G (Summary)
8802 @kindex M-g (Summary)
8803 @findex gnus-summary-rescan-group
8804 @c @icon{gnus-summary-mail-get}
8805 Exit the group, check for new articles in the group, and select the
8806 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
8807 articles, both read and unread.
8810 @kindex Z N (Summary)
8811 @findex gnus-summary-next-group
8812 Exit the group and go to the next group
8813 (@code{gnus-summary-next-group}).
8816 @kindex Z P (Summary)
8817 @findex gnus-summary-prev-group
8818 Exit the group and go to the previous group
8819 (@code{gnus-summary-prev-group}).
8822 @kindex Z s (Summary)
8823 @findex gnus-summary-save-newsrc
8824 Save the current number of read/marked articles in the dribble buffer
8825 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
8826 given a prefix, also save the @file{.newsrc} file(s). Using this
8827 command will make exit without updating (the @kbd{Q} command) worthless.
8830 @vindex gnus-exit-group-hook
8831 @code{gnus-exit-group-hook} is called when you exit the current group
8832 with an ``updating'' exit. For instance @kbd{Q}
8833 (@code{gnus-summary-exit-no-update}) does not call this hook.
8835 @findex gnus-summary-wake-up-the-dead
8836 @findex gnus-dead-summary-mode
8837 @vindex gnus-kill-summary-on-exit
8838 If you're in the habit of exiting groups, and then changing your mind
8839 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
8840 If you do that, Gnus won't kill the summary buffer when you exit it.
8841 (Quelle surprise!) Instead it will change the name of the buffer to
8842 something like @samp{*Dead Summary ... *} and install a minor mode
8843 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
8844 buffer, you'll find that all keys are mapped to a function called
8845 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
8846 summary buffer will result in a live, normal summary buffer.
8848 There will never be more than one dead summary buffer at any one time.
8850 @vindex gnus-use-cross-reference
8851 The data on the current group will be updated (which articles you have
8852 read, which articles you have replied to, etc.) when you exit the
8853 summary buffer. If the @code{gnus-use-cross-reference} variable is
8854 @code{t} (which is the default), articles that are cross-referenced to
8855 this group and are marked as read, will also be marked as read in the
8856 other subscribed groups they were cross-posted to. If this variable is
8857 neither @code{nil} nor @code{t}, the article will be marked as read in
8858 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
8861 @node Crosspost Handling
8862 @section Crosspost Handling
8866 Marking cross-posted articles as read ensures that you'll never have to
8867 read the same article more than once. Unless, of course, somebody has
8868 posted it to several groups separately. Posting the same article to
8869 several groups (not cross-posting) is called @dfn{spamming}, and you are
8870 by law required to send nasty-grams to anyone who perpetrates such a
8871 heinous crime. You may want to try NoCeM handling to filter out spam
8874 Remember: Cross-posting is kinda ok, but posting the same article
8875 separately to several groups is not. Massive cross-posting (aka.
8876 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
8877 @code{gnus-summary-mail-crosspost-complaint} command to complain about
8878 excessive crossposting (@pxref{Summary Mail Commands}).
8880 @cindex cross-posting
8883 One thing that may cause Gnus to not do the cross-posting thing
8884 correctly is if you use an @sc{nntp} server that supports @sc{xover}
8885 (which is very nice, because it speeds things up considerably) which
8886 does not include the @code{Xref} header in its @sc{nov} lines. This is
8887 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
8888 even with @sc{xover} by registering the @code{Xref} lines of all
8889 articles you actually read, but if you kill the articles, or just mark
8890 them as read without reading them, Gnus will not get a chance to snoop
8891 the @code{Xref} lines out of these articles, and will be unable to use
8892 the cross reference mechanism.
8894 @cindex LIST overview.fmt
8895 @cindex overview.fmt
8896 To check whether your @sc{nntp} server includes the @code{Xref} header
8897 in its overview files, try @samp{telnet your.nntp.server nntp},
8898 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
8899 overview.fmt}. This may not work, but if it does, and the last line you
8900 get does not read @samp{Xref:full}, then you should shout and whine at
8901 your news admin until she includes the @code{Xref} header in the
8904 @vindex gnus-nov-is-evil
8905 If you want Gnus to get the @code{Xref}s right all the time, you have to
8906 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
8911 For an alternative approach, @pxref{Duplicate Suppression}.
8914 @node Duplicate Suppression
8915 @section Duplicate Suppression
8917 By default, Gnus tries to make sure that you don't have to read the same
8918 article more than once by utilizing the crossposting mechanism
8919 (@pxref{Crosspost Handling}). However, that simple and efficient
8920 approach may not work satisfactory for some users for various
8925 The @sc{nntp} server may fail to generate the @code{Xref} header. This
8926 is evil and not very common.
8929 The @sc{nntp} server may fail to include the @code{Xref} header in the
8930 @file{.overview} data bases. This is evil and all too common, alas.
8933 You may be reading the same group (or several related groups) from
8934 different @sc{nntp} servers.
8937 You may be getting mail that duplicates articles posted to groups.
8940 I'm sure there are other situations where @code{Xref} handling fails as
8941 well, but these four are the most common situations.
8943 If, and only if, @code{Xref} handling fails for you, then you may
8944 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
8945 will remember the @code{Message-ID}s of all articles you have read or
8946 otherwise marked as read, and then, as if by magic, mark them as read
8947 all subsequent times you see them---in @emph{all} groups. Using this
8948 mechanism is quite likely to be somewhat inefficient, but not overly
8949 so. It's certainly preferable to reading the same articles more than
8952 Duplicate suppression is not a very subtle instrument. It's more like a
8953 sledge hammer than anything else. It works in a very simple
8954 fashion---if you have marked an article as read, it adds this Message-ID
8955 to a cache. The next time it sees this Message-ID, it will mark the
8956 article as read with the @samp{M} mark. It doesn't care what group it
8960 @item gnus-suppress-duplicates
8961 @vindex gnus-suppress-duplicates
8962 If non-@code{nil}, suppress duplicates.
8964 @item gnus-save-duplicate-list
8965 @vindex gnus-save-duplicate-list
8966 If non-@code{nil}, save the list of duplicates to a file. This will
8967 make startup and shutdown take longer, so the default is @code{nil}.
8968 However, this means that only duplicate articles read in a single Gnus
8969 session are suppressed.
8971 @item gnus-duplicate-list-length
8972 @vindex gnus-duplicate-list-length
8973 This variable says how many @code{Message-ID}s to keep in the duplicate
8974 suppression list. The default is 10000.
8976 @item gnus-duplicate-file
8977 @vindex gnus-duplicate-file
8978 The name of the file to store the duplicate suppression list in. The
8979 default is @file{~/News/suppression}.
8982 If you have a tendency to stop and start Gnus often, setting
8983 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
8984 you leave Gnus running for weeks on end, you may have it @code{nil}. On
8985 the other hand, saving the list makes startup and shutdown much slower,
8986 so that means that if you stop and start Gnus often, you should set
8987 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
8988 to you to figure out, I think.
8991 @node The Article Buffer
8992 @chapter The Article Buffer
8993 @cindex article buffer
8995 The articles are displayed in the article buffer, of which there is only
8996 one. All the summary buffers share the same article buffer unless you
8997 tell Gnus otherwise.
9000 * Hiding Headers:: Deciding what headers should be displayed.
9001 * Using MIME:: Pushing articles through @sc{mime} before reading them.
9002 * Customizing Articles:: Tailoring the look of the articles.
9003 * Article Keymap:: Keystrokes available in the article buffer.
9004 * Misc Article:: Other stuff.
9008 @node Hiding Headers
9009 @section Hiding Headers
9010 @cindex hiding headers
9011 @cindex deleting headers
9013 The top section of each article is the @dfn{head}. (The rest is the
9014 @dfn{body}, but you may have guessed that already.)
9016 @vindex gnus-show-all-headers
9017 There is a lot of useful information in the head: the name of the person
9018 who wrote the article, the date it was written and the subject of the
9019 article. That's well and nice, but there's also lots of information
9020 most people do not want to see---what systems the article has passed
9021 through before reaching you, the @code{Message-ID}, the
9022 @code{References}, etc. ad nauseum---and you'll probably want to get rid
9023 of some of those lines. If you want to keep all those lines in the
9024 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
9026 Gnus provides you with two variables for sifting headers:
9030 @item gnus-visible-headers
9031 @vindex gnus-visible-headers
9032 If this variable is non-@code{nil}, it should be a regular expression
9033 that says what headers you wish to keep in the article buffer. All
9034 headers that do not match this variable will be hidden.
9036 For instance, if you only want to see the name of the person who wrote
9037 the article and the subject, you'd say:
9040 (setq gnus-visible-headers "^From:\\|^Subject:")
9043 This variable can also be a list of regexps to match headers to
9046 @item gnus-ignored-headers
9047 @vindex gnus-ignored-headers
9048 This variable is the reverse of @code{gnus-visible-headers}. If this
9049 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
9050 should be a regular expression that matches all lines that you want to
9051 hide. All lines that do not match this variable will remain visible.
9053 For instance, if you just want to get rid of the @code{References} line
9054 and the @code{Xref} line, you might say:
9057 (setq gnus-ignored-headers "^References:\\|^Xref:")
9060 This variable can also be a list of regexps to match headers to
9063 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
9064 variable will have no effect.
9068 @vindex gnus-sorted-header-list
9069 Gnus can also sort the headers for you. (It does this by default.) You
9070 can control the sorting by setting the @code{gnus-sorted-header-list}
9071 variable. It is a list of regular expressions that says in what order
9072 the headers are to be displayed.
9074 For instance, if you want the name of the author of the article first,
9075 and then the subject, you might say something like:
9078 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
9081 Any headers that are to remain visible, but are not listed in this
9082 variable, will be displayed in random order after all the headers listed in this variable.
9084 @findex gnus-article-hide-boring-headers
9085 @vindex gnus-boring-article-headers
9086 You can hide further boring headers by setting
9087 @code{gnus-treat-hide-boring-header} to @code{head}. What this function
9088 does depends on the @code{gnus-boring-article-headers} variable. It's a
9089 list, but this list doesn't actually contain header names. Instead is
9090 lists various @dfn{boring conditions} that Gnus can check and remove
9093 These conditions are:
9096 Remove all empty headers.
9098 Remove the @code{Followup-To} header if it is identical to the
9099 @code{Newsgroups} header.
9101 Remove the @code{Reply-To} header if it lists the same address as the
9104 Remove the @code{Newsgroups} header if it only contains the current group
9107 Remove the @code{Date} header if the article is less than three days
9110 Remove the @code{To} header if it is very long.
9112 Remove all @code{To} headers if there are more than one.
9115 To include the four three elements, you could say something like;
9118 (setq gnus-boring-article-headers
9119 '(empty followup-to reply-to))
9122 This is also the default value for this variable.
9126 @section Using @sc{mime}
9129 Mime is a standard for waving your hands through the air, aimlessly,
9130 while people stand around yawning.
9132 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
9133 while all newsreaders die of fear.
9135 @sc{mime} may specify what character set the article uses, the encoding
9136 of the characters, and it also makes it possible to embed pictures and
9137 other naughty stuff in innocent-looking articles.
9139 @vindex gnus-display-mime-function
9140 @findex gnus-display-mime
9141 Gnus pushes @sc{mime} articles through @code{gnus-display-mime-function}
9142 to display the @sc{mime} parts. This is @code{gnus-display-mime} by
9143 default, which creates a bundle of clickable buttons that can be used to
9144 display, save and manipulate the @sc{mime} objects.
9146 The following commands are available when you have placed point over a
9150 @findex gnus-article-press-button
9152 @itemx BUTTON-2 (Article)
9153 Toggle displaying of the @sc{mime} object
9154 (@code{gnus-article-press-button}).
9156 @findex gnus-mime-view-part
9157 @item M-RET (Article)
9159 Prompt for a method, and then view the @sc{mime} object using this
9160 method (@code{gnus-mime-view-part}).
9162 @findex gnus-mime-save-part
9164 Prompt for a file name, and then save the @sc{mime} object
9165 (@code{gnus-mime-save-part}).
9167 @findex gnus-mime-copy-part
9169 Copy the @sc{mime} object to a fresh buffer and display this buffer
9170 (@code{gnus-mime-copy-part}).
9172 @findex gnus-mime-view-part-as-type
9174 View the @sc{mime} object as if it were a different @sc{mime} media type
9175 (@code{gnus-mime-view-part-as-type}).
9177 @findex gnus-mime-pipe-part
9179 Output the @sc{mime} object to a process (@code{gnus-mime-pipe-part}).
9181 @findex gnus-mime-inline-part
9183 Insert the raw contents of the @sc{mime} object into the buffer
9184 (@code{gnus-mime-inline-part}).
9188 Gnus will display some @sc{mime} objects automatically. The way Gnus
9189 determines which parts to do this with is described in the Emacs MIME
9192 It might be best to just use the toggling functions from the article
9193 buffer to avoid getting nasty surprises. (For instance, you enter the
9194 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
9195 decoded the sound file in the article and some horrible sing-a-long song
9196 comes screaming out your speakers, and you can't find the volume button,
9197 because there isn't one, and people are starting to look at you, and you
9198 try to stop the program, but you can't, and you can't find the program
9199 to control the volume, and everybody else in the room suddenly decides
9200 to look at you disdainfully, and you'll feel rather stupid.)
9202 Any similarity to real events and people is purely coincidental. Ahem.
9204 Also see @pxref{MIME Commands}.
9207 @node Customizing Articles
9208 @section Customizing Articles
9209 @cindex article customization
9211 A slew of functions for customizing how the articles are to look like
9212 exist. You can call these functions interactively, or you can have them
9213 called automatically when you select the articles.
9215 To have them called automatically, you should set the corresponding
9216 ``treatment'' variable. For instance, to have headers hidden, you'd set
9217 @code{gnus-treat-hide-headers}. Below is a list of variables that can
9218 be set, but first we discuss the values these variables can have.
9220 Note: Some values, while valid, make little sense. Check the list below
9221 for sensible values.
9225 @code{nil}: Don't do this treatment.
9228 @code{t}: Do this treatment on all body parts.
9231 @code{head}: Do the treatment on the headers.
9234 @code{last}: Do this treatment on the last part.
9237 An integer: Do this treatment on all body parts that have a length less
9241 A list of strings: Do this treatment on all body parts that are in
9242 articles that are read in groups that have names that match one of the
9243 regexps in the list.
9246 A list where the first element is not a string:
9248 The list is evaluated recursively. The first element of the list is a
9249 predicate. The following predicates are recognized: @code{or},
9250 @code{and}, @code{not} and @code{typep}. Here's an example:
9254 (typep "text/x-vcard"))
9259 You may have noticed that the word @dfn{part} is used here. This refers
9260 to the fact that some messages are @sc{mime} multipart articles that may
9261 be divided into several parts. Articles that are not multiparts are
9262 considered to contain just a single part.
9264 @vindex gnus-article-treat-types
9265 Are the treatments applied to all sorts of multipart parts? Yes, if you
9266 want to, but by default, only @samp{text/plain} parts are given the
9267 treatment. This is controlled by the @code{gnus-article-treat-types}
9268 variable, which is a list of regular expressions that are matched to the
9269 type of the part. This variable is ignored if the value of the
9270 controlling variable is a predicate list, as described above.
9272 The following treatment options are available. The easiest way to
9273 customize this is to examine the @code{gnus-article-treat} customization
9274 group. Values in parenthesis are suggested sensible values. Others are
9275 possible but those listed are probably sufficient for most people.
9278 @item gnus-treat-highlight-signature (t, last)
9279 @item gnus-treat-buttonize (t, integer)
9280 @item gnus-treat-buttonize-head (head)
9281 @item gnus-treat-emphasize (t, head, integer)
9282 @item gnus-treat-fill-article (t, integer)
9283 @item gnus-treat-strip-cr (t, integer)
9284 @item gnus-treat-hide-headers (head)
9285 @item gnus-treat-hide-boring-headers (head)
9286 @item gnus-treat-hide-signature (t, last)
9287 @item gnus-treat-hide-citation (t, integer)
9288 @item gnus-treat-strip-pgp (t, last, integer)
9289 @item gnus-treat-strip-pem (t, last, integer)
9290 @item gnus-treat-highlight-headers (head)
9291 @item gnus-treat-highlight-citation (t, integer)
9292 @item gnus-treat-highlight-signature (t, last, integer)
9293 @item gnus-treat-date-ut (head)
9294 @item gnus-treat-date-local (head)
9295 @item gnus-treat-date-lapsed (head)
9296 @item gnus-treat-date-original (head)
9297 @item gnus-treat-strip-headers-in-body (t, integer)
9298 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
9299 @item gnus-treat-strip-leading-blank-lines (t, integer)
9300 @item gnus-treat-strip-multiple-blank-lines (t, integer)
9301 @item gnus-treat-overstrike (t, integer)
9302 @item gnus-treat-display-xface (head)
9303 @item gnus-treat-display-smileys (t, integer)
9304 @item gnus-treat-display-picons (head)
9305 @item gnus-treat-capitalize-sentences (t, integer)
9306 @item gnus-treat-fill-long-lines (t, integer)
9307 @item gnus-treat-play-sounds
9308 @item gnus-treat-translate
9311 @vindex gnus-part-display-hook
9312 You can, of course, write your own functions to be called from
9313 @code{gnus-part-display-hook}. The functions are called narrowed to the
9314 part, and you can do anything you like, pretty much. There is no
9315 information that you have to keep in the buffer---you can change
9319 @node Article Keymap
9320 @section Article Keymap
9322 Most of the keystrokes in the summary buffer can also be used in the
9323 article buffer. They should behave as if you typed them in the summary
9324 buffer, which means that you don't actually have to have a summary
9325 buffer displayed while reading. You can do it all from the article
9328 A few additional keystrokes are available:
9333 @kindex SPACE (Article)
9334 @findex gnus-article-next-page
9335 Scroll forwards one page (@code{gnus-article-next-page}).
9338 @kindex DEL (Article)
9339 @findex gnus-article-prev-page
9340 Scroll backwards one page (@code{gnus-article-prev-page}).
9343 @kindex C-c ^ (Article)
9344 @findex gnus-article-refer-article
9345 If point is in the neighborhood of a @code{Message-ID} and you press
9346 @kbd{C-c ^}, Gnus will try to get that article from the server
9347 (@code{gnus-article-refer-article}).
9350 @kindex C-c C-m (Article)
9351 @findex gnus-article-mail
9352 Send a reply to the address near point (@code{gnus-article-mail}). If
9353 given a prefix, include the mail.
9357 @findex gnus-article-show-summary
9358 Reconfigure the buffers so that the summary buffer becomes visible
9359 (@code{gnus-article-show-summary}).
9363 @findex gnus-article-describe-briefly
9364 Give a very brief description of the available keystrokes
9365 (@code{gnus-article-describe-briefly}).
9368 @kindex TAB (Article)
9369 @findex gnus-article-next-button
9370 Go to the next button, if any (@code{gnus-article-next-button}). This
9371 only makes sense if you have buttonizing turned on.
9374 @kindex M-TAB (Article)
9375 @findex gnus-article-prev-button
9376 Go to the previous button, if any (@code{gnus-article-prev-button}).
9382 @section Misc Article
9386 @item gnus-single-article-buffer
9387 @vindex gnus-single-article-buffer
9388 If non-@code{nil}, use the same article buffer for all the groups.
9389 (This is the default.) If @code{nil}, each group will have its own
9392 @vindex gnus-article-decode-hook
9393 @item gnus-article-decode-hook
9395 Hook used to decode @sc{mime} articles. The default value is
9396 @code{(article-decode-charset article-decode-encoded-words)}
9398 @vindex gnus-article-prepare-hook
9399 @item gnus-article-prepare-hook
9400 This hook is called right after the article has been inserted into the
9401 article buffer. It is mainly intended for functions that do something
9402 depending on the contents; it should probably not be used for changing
9403 the contents of the article buffer.
9405 @item gnus-article-mode-hook
9406 @vindex gnus-article-mode-hook
9407 Hook called in article mode buffers.
9409 @item gnus-article-mode-syntax-table
9410 @vindex gnus-article-mode-syntax-table
9411 Syntax table used in article buffers. It is initialized from
9412 @code{text-mode-syntax-table}.
9414 @vindex gnus-article-mode-line-format
9415 @item gnus-article-mode-line-format
9416 This variable is a format string along the same lines as
9417 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}). It
9418 accepts the same format specifications as that variable, with two
9423 The @dfn{wash status} of the article. This is a short string with one
9424 character for each possible article wash operation that may have been
9427 The number of @sc{mime} parts in the article.
9430 @vindex gnus-break-pages
9432 @item gnus-break-pages
9433 Controls whether @dfn{page breaking} is to take place. If this variable
9434 is non-@code{nil}, the articles will be divided into pages whenever a
9435 page delimiter appears in the article. If this variable is @code{nil},
9436 paging will not be done.
9438 @item gnus-page-delimiter
9439 @vindex gnus-page-delimiter
9440 This is the delimiter mentioned above. By default, it is @samp{^L}
9445 @node Composing Messages
9446 @chapter Composing Messages
9447 @cindex composing messages
9450 @cindex sending mail
9455 @kindex C-c C-c (Post)
9456 All commands for posting and mailing will put you in a message buffer
9457 where you can edit the article all you like, before you send the
9458 article by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The
9459 Message Manual}. Where the message will be posted/mailed to depends
9460 on your setup (@pxref{Posting Server}).
9463 * Mail:: Mailing and replying.
9464 * Post:: Posting and following up.
9465 * Posting Server:: What server should you post via?
9466 * Mail and Post:: Mailing and posting at the same time.
9467 * Archived Messages:: Where Gnus stores the messages you've sent.
9468 * Posting Styles:: An easier way to specify who you are.
9469 * Drafts:: Postponing messages and rejected messages.
9470 * Rejected Articles:: What happens if the server doesn't like your article?
9473 Also see @pxref{Canceling and Superseding} for information on how to
9474 remove articles you shouldn't have posted.
9480 Variables for customizing outgoing mail:
9483 @item gnus-uu-digest-headers
9484 @vindex gnus-uu-digest-headers
9485 List of regexps to match headers included in digested messages. The
9486 headers will be included in the sequence they are matched.
9488 @item gnus-add-to-list
9489 @vindex gnus-add-to-list
9490 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
9491 that have none when you do a @kbd{a}.
9493 @item message-send-mail-partially-limit
9494 @vindex message-send-mail-partially-limit
9495 The limitation of messages sent as message/partial.
9496 The lower bound of message size in characters, beyond which the message
9497 should be sent in several parts. If it is nil, the size is unlimited.
9505 Variables for composing news articles:
9508 @item gnus-sent-message-ids-file
9509 @vindex gnus-sent-message-ids-file
9510 Gnus will keep a @code{Message-ID} history file of all the mails it has
9511 sent. If it discovers that it has already sent a mail, it will ask the
9512 user whether to re-send the mail. (This is primarily useful when
9513 dealing with @sc{soup} packets and the like where one is apt to send the
9514 same packet multiple times.) This variable says what the name of this
9515 history file is. It is @file{~/News/Sent-Message-IDs} by default. Set
9516 this variable to @code{nil} if you don't want Gnus to keep a history
9519 @item gnus-sent-message-ids-length
9520 @vindex gnus-sent-message-ids-length
9521 This variable says how many @code{Message-ID}s to keep in the history
9522 file. It is 1000 by default.
9527 @node Posting Server
9528 @section Posting Server
9530 When you press those magical @kbd{C-c C-c} keys to ship off your latest
9531 (extremely intelligent, of course) article, where does it go?
9533 Thank you for asking. I hate you.
9535 @vindex gnus-post-method
9537 It can be quite complicated. Normally, Gnus will use the same native
9538 server. However. If your native server doesn't allow posting, just
9539 reading, you probably want to use some other server to post your
9540 (extremely intelligent and fabulously interesting) articles. You can
9541 then set the @code{gnus-post-method} to some other method:
9544 (setq gnus-post-method '(nnspool ""))
9547 Now, if you've done this, and then this server rejects your article, or
9548 this server is down, what do you do then? To override this variable you
9549 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
9550 the ``current'' server for posting.
9552 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
9553 Gnus will prompt you for what method to use for posting.
9555 You can also set @code{gnus-post-method} to a list of select methods.
9556 If that's the case, Gnus will always prompt you for what method to use
9559 Finally, if you want to always post using the same select method as
9560 you're reading from (which might be convenient if you're reading lots of
9561 groups from different private servers), you can set this variable to
9566 @section Mail and Post
9568 Here's a list of variables relevant to both mailing and
9572 @item gnus-mailing-list-groups
9573 @findex gnus-mailing-list-groups
9574 @cindex mailing lists
9576 If your news server offers groups that are really mailing lists
9577 gatewayed to the @sc{nntp} server, you can read those groups without
9578 problems, but you can't post/followup to them without some difficulty.
9579 One solution is to add a @code{to-address} to the group parameters
9580 (@pxref{Group Parameters}). An easier thing to do is set the
9581 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
9582 really are mailing lists. Then, at least, followups to the mailing
9583 lists will work most of the time. Posting to these groups (@kbd{a}) is
9584 still a pain, though.
9588 You may want to do spell-checking on messages that you send out. Or, if
9589 you don't want to spell-check by hand, you could add automatic
9590 spell-checking via the @code{ispell} package:
9593 @findex ispell-message
9595 (add-hook 'message-send-hook 'ispell-message)
9598 If you want to change the @code{ispell} dictionary based on what group
9599 you're in, you could say something like the following:
9602 (add-hook 'gnus-select-group-hook
9605 ((string-match "^de\\." gnus-newsgroup-name)
9606 (ispell-change-dictionary "deutsch"))
9608 (ispell-change-dictionary "english")))))
9611 Modify to suit your needs.
9614 @node Archived Messages
9615 @section Archived Messages
9616 @cindex archived messages
9617 @cindex sent messages
9619 Gnus provides a few different methods for storing the mail and news you
9620 send. The default method is to use the @dfn{archive virtual server} to
9621 store the messages. If you want to disable this completely, the
9622 @code{gnus-message-archive-group} variable should be @code{nil}, which
9625 @vindex gnus-message-archive-method
9626 @code{gnus-message-archive-method} says what virtual server Gnus is to
9627 use to store sent messages. The default is:
9631 (nnfolder-directory "~/Mail/archive")
9632 (nnfolder-active-file "~/Mail/archive/active")
9633 (nnfolder-get-new-mail nil)
9634 (nnfolder-inhibit-expiry t))
9637 You can, however, use any mail select method (@code{nnml},
9638 @code{nnmbox}, etc.). @code{nnfolder} is a quite likeable select method
9639 for doing this sort of thing, though. If you don't like the default
9640 directory chosen, you could say something like:
9643 (setq gnus-message-archive-method
9644 '(nnfolder "archive"
9645 (nnfolder-inhibit-expiry t)
9646 (nnfolder-active-file "~/News/sent-mail/active")
9647 (nnfolder-directory "~/News/sent-mail/")))
9650 @vindex gnus-message-archive-group
9652 Gnus will insert @code{Gcc} headers in all outgoing messages that point
9653 to one or more group(s) on that server. Which group to use is
9654 determined by the @code{gnus-message-archive-group} variable.
9656 This variable can be used to do the following:
9660 Messages will be saved in that group.
9661 @item a list of strings
9662 Messages will be saved in all those groups.
9663 @item an alist of regexps, functions and forms
9664 When a key ``matches'', the result is used.
9666 No message archiving will take place. This is the default.
9671 Just saving to a single group called @samp{MisK}:
9673 (setq gnus-message-archive-group "MisK")
9676 Saving to two groups, @samp{MisK} and @samp{safe}:
9678 (setq gnus-message-archive-group '("MisK" "safe"))
9681 Save to different groups based on what group you are in:
9683 (setq gnus-message-archive-group
9684 '(("^alt" "sent-to-alt")
9685 ("mail" "sent-to-mail")
9686 (".*" "sent-to-misc")))
9691 (setq gnus-message-archive-group
9692 '((if (message-news-p)
9697 How about storing all news messages in one file, but storing all mail
9698 messages in one file per month:
9701 (setq gnus-message-archive-group
9702 '((if (message-news-p)
9704 (concat "mail." (format-time-string "%Y-%m")))))
9707 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
9708 use a different value for @code{gnus-message-archive-group} there.)
9710 Now, when you send a message off, it will be stored in the appropriate
9711 group. (If you want to disable storing for just one particular message,
9712 you can just remove the @code{Gcc} header that has been inserted.) The
9713 archive group will appear in the group buffer the next time you start
9714 Gnus, or the next time you press @kbd{F} in the group buffer. You can
9715 enter it and read the articles in it just like you'd read any other
9716 group. If the group gets really big and annoying, you can simply rename
9717 if (using @kbd{G r} in the group buffer) to something
9718 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
9719 continue to be stored in the old (now empty) group.
9721 That's the default method of archiving sent messages. Gnus offers a
9722 different way for the people who don't like the default method. In that
9723 case you should set @code{gnus-message-archive-group} to @code{nil};
9724 this will disable archiving.
9727 @item gnus-outgoing-message-group
9728 @vindex gnus-outgoing-message-group
9729 All outgoing messages will be put in this group. If you want to store
9730 all your outgoing mail and articles in the group @samp{nnml:archive},
9731 you set this variable to that value. This variable can also be a list of
9734 If you want to have greater control over what group to put each
9735 message in, you can set this variable to a function that checks the
9736 current newsgroup name and then returns a suitable group name (or list
9739 This variable can be used instead of @code{gnus-message-archive-group},
9740 but the latter is the preferred method.
9744 @node Posting Styles
9745 @section Posting Styles
9746 @cindex posting styles
9749 All them variables, they make my head swim.
9751 So what if you want a different @code{Organization} and signature based
9752 on what groups you post to? And you post both from your home machine
9753 and your work machine, and you want different @code{From} lines, and so
9756 @vindex gnus-posting-styles
9757 One way to do stuff like that is to write clever hooks that change the
9758 variables you need to have changed. That's a bit boring, so somebody
9759 came up with the bright idea of letting the user specify these things in
9760 a handy alist. Here's an example of a @code{gnus-posting-styles}
9765 (signature "Peace and happiness")
9766 (organization "What me?"))
9768 (signature "Death to everybody"))
9769 ("comp.emacs.i-love-it"
9770 (organization "Emacs is it")))
9773 As you might surmise from this example, this alist consists of several
9774 @dfn{styles}. Each style will be applicable if the first element
9775 ``matches'', in some form or other. The entire alist will be iterated
9776 over, from the beginning towards the end, and each match will be
9777 applied, which means that attributes in later styles that match override
9778 the same attributes in earlier matching styles. So
9779 @samp{comp.programming.literate} will have the @samp{Death to everybody}
9780 signature and the @samp{What me?} @code{Organization} header.
9782 The first element in each style is called the @code{match}. If it's a
9783 string, then Gnus will try to regexp match it against the group name.
9784 If it is the symbol @code{header}, then Gnus will look for header that
9785 match the next element in the match, and compare that to the last header
9786 in the match. If it's a function symbol, that function will be called
9787 with no arguments. If it's a variable symbol, then the variable will be
9788 referenced. If it's a list, then that list will be @code{eval}ed. In
9789 any case, if this returns a non-@code{nil} value, then the style is said
9792 Each style may contain a arbitrary amount of @dfn{attributes}. Each
9793 attribute consists of a @code{(@var{name} . @var{value})} pair. The
9794 attribute name can be one of @code{signature}, @code{signature-file},
9795 @code{organization}, @code{address}, @code{name} or @code{body}. The
9796 attribute name can also be a string. In that case, this will be used as
9797 a header name, and the value will be inserted in the headers of the
9798 article; if the value is @code{nil}, the header name will be removed.
9799 If the attribute name is @code{eval}, the form is evaluated, and the
9800 result is thrown away.
9802 The attribute value can be a string (used verbatim), a function with
9803 zero arguments (the return value will be used), a variable (its value
9804 will be used) or a list (it will be @code{eval}ed and the return value
9805 will be used). The functions and sexps are called/@code{eval}ed in the
9806 message buffer that is being set up. The headers of the current article
9807 are available through the @code{message-reply-headers} variable.
9809 If you wish to check whether the message you are about to compose is
9810 meant to be a news article or a mail message, you can check the values
9811 of the @code{message-news-p} and @code{message-mail-p} functions.
9813 @findex message-mail-p
9814 @findex message-news-p
9816 So here's a new example:
9819 (setq gnus-posting-styles
9821 (signature-file "~/.signature")
9823 ("X-Home-Page" (getenv "WWW_HOME"))
9824 (organization "People's Front Against MWM"))
9826 (signature my-funny-signature-randomizer))
9827 ((equal (system-name) "gnarly")
9828 (signature my-quote-randomizer))
9830 (signature my-news-signature))
9831 (header "From\\|To" "larsi.*org"
9832 (Organization "Somewhere, Inc."))
9833 ((posting-from-work-p)
9834 (signature-file "~/.work-signature")
9835 (address "user@@bar.foo")
9836 (body "You are fired.\n\nSincerely, your boss.")
9837 (organization "Important Work, Inc"))
9839 (signature-file "~/.mail-signature"))))
9847 If you are writing a message (mail or news) and suddenly remember that
9848 you have a steak in the oven (or some pesto in the food processor, you
9849 craaazy vegetarians), you'll probably wish there was a method to save
9850 the message you are writing so that you can continue editing it some
9851 other day, and send it when you feel its finished.
9853 Well, don't worry about it. Whenever you start composing a message of
9854 some sort using the Gnus mail and post commands, the buffer you get will
9855 automatically associate to an article in a special @dfn{draft} group.
9856 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
9857 article will be saved there. (Auto-save files also go to the draft
9861 @vindex nndraft-directory
9862 The draft group is a special group (which is implemented as an
9863 @code{nndraft} group, if you absolutely have to know) called
9864 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
9865 @code{nndraft} is to store its files. What makes this group special is
9866 that you can't tick any articles in it or mark any articles as
9867 read---all articles in the group are permanently unread.
9869 If the group doesn't exist, it will be created and you'll be subscribed
9870 to it. The only way to make it disappear from the Group buffer is to
9873 @c @findex gnus-dissociate-buffer-from-draft
9874 @c @kindex C-c M-d (Mail)
9875 @c @kindex C-c M-d (Post)
9876 @c @findex gnus-associate-buffer-with-draft
9877 @c @kindex C-c C-d (Mail)
9878 @c @kindex C-c C-d (Post)
9879 @c If you're writing some super-secret message that you later want to
9880 @c encode with PGP before sending, you may wish to turn the auto-saving
9881 @c (and association with the draft group) off. You never know who might be
9882 @c interested in reading all your extremely valuable and terribly horrible
9883 @c and interesting secrets. The @kbd{C-c M-d}
9884 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
9885 @c If you change your mind and want to turn the auto-saving back on again,
9886 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
9888 @c @vindex gnus-use-draft
9889 @c To leave association with the draft group off by default, set
9890 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
9892 @findex gnus-draft-edit-message
9894 When you want to continue editing the article, you simply enter the
9895 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
9896 that. You will be placed in a buffer where you left off.
9898 Rejected articles will also be put in this draft group (@pxref{Rejected
9901 @findex gnus-draft-send-all-messages
9902 @findex gnus-draft-send-message
9903 If you have lots of rejected messages you want to post (or mail) without
9904 doing further editing, you can use the @kbd{D s} command
9905 (@code{gnus-draft-send-message}). This command understands the
9906 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
9907 command (@code{gnus-draft-send-all-messages}) will ship off all messages
9910 If you have some messages that you wish not to send, you can use the
9911 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
9912 as unsendable. This is a toggling command.
9915 @node Rejected Articles
9916 @section Rejected Articles
9917 @cindex rejected articles
9919 Sometimes a news server will reject an article. Perhaps the server
9920 doesn't like your face. Perhaps it just feels miserable. Perhaps
9921 @emph{there be demons}. Perhaps you have included too much cited text.
9922 Perhaps the disk is full. Perhaps the server is down.
9924 These situations are, of course, totally beyond the control of Gnus.
9925 (Gnus, of course, loves the way you look, always feels great, has angels
9926 fluttering around inside of it, doesn't care about how much cited text
9927 you include, never runs full and never goes down.) So Gnus saves these
9928 articles until some later time when the server feels better.
9930 The rejected articles will automatically be put in a special draft group
9931 (@pxref{Drafts}). When the server comes back up again, you'd then
9932 typically enter that group and send all the articles off.
9935 @node Select Methods
9936 @chapter Select Methods
9937 @cindex foreign groups
9938 @cindex select methods
9940 A @dfn{foreign group} is a group not read by the usual (or
9941 default) means. It could be, for instance, a group from a different
9942 @sc{nntp} server, it could be a virtual group, or it could be your own
9943 personal mail group.
9945 A foreign group (or any group, really) is specified by a @dfn{name} and
9946 a @dfn{select method}. To take the latter first, a select method is a
9947 list where the first element says what backend to use (e.g. @code{nntp},
9948 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
9949 name}. There may be additional elements in the select method, where the
9950 value may have special meaning for the backend in question.
9952 One could say that a select method defines a @dfn{virtual server}---so
9953 we do just that (@pxref{The Server Buffer}).
9955 The @dfn{name} of the group is the name the backend will recognize the
9958 For instance, the group @samp{soc.motss} on the @sc{nntp} server
9959 @samp{some.where.edu} will have the name @samp{soc.motss} and select
9960 method @code{(nntp "some.where.edu")}. Gnus will call this group
9961 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
9962 backend just knows this group as @samp{soc.motss}.
9964 The different methods all have their peculiarities, of course.
9967 * The Server Buffer:: Making and editing virtual servers.
9968 * Getting News:: Reading USENET news with Gnus.
9969 * Getting Mail:: Reading your personal mail with Gnus.
9970 * Browsing the Web:: Getting messages from a plethora of Web sources.
9971 * Other Sources:: Reading directories, files, SOUP packets.
9972 * Combined Groups:: Combining groups into one group.
9973 * Gnus Unplugged:: Reading news and mail offline.
9977 @node The Server Buffer
9978 @section The Server Buffer
9980 Traditionally, a @dfn{server} is a machine or a piece of software that
9981 one connects to, and then requests information from. Gnus does not
9982 connect directly to any real servers, but does all transactions through
9983 one backend or other. But that's just putting one layer more between
9984 the actual media and Gnus, so we might just as well say that each
9985 backend represents a virtual server.
9987 For instance, the @code{nntp} backend may be used to connect to several
9988 different actual @sc{nntp} servers, or, perhaps, to many different ports
9989 on the same actual @sc{nntp} server. You tell Gnus which backend to
9990 use, and what parameters to set by specifying a @dfn{select method}.
9992 These select method specifications can sometimes become quite
9993 complicated---say, for instance, that you want to read from the
9994 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
9995 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
9996 Anyways, if you had to specify that for each group that used this
9997 server, that would be too much work, so Gnus offers a way of naming
9998 select methods, which is what you do in the server buffer.
10000 To enter the server buffer, use the @kbd{^}
10001 (@code{gnus-group-enter-server-mode}) command in the group buffer.
10004 * Server Buffer Format:: You can customize the look of this buffer.
10005 * Server Commands:: Commands to manipulate servers.
10006 * Example Methods:: Examples server specifications.
10007 * Creating a Virtual Server:: An example session.
10008 * Server Variables:: Which variables to set.
10009 * Servers and Methods:: You can use server names as select methods.
10010 * Unavailable Servers:: Some servers you try to contact may be down.
10013 @vindex gnus-server-mode-hook
10014 @code{gnus-server-mode-hook} is run when creating the server buffer.
10017 @node Server Buffer Format
10018 @subsection Server Buffer Format
10019 @cindex server buffer format
10021 @vindex gnus-server-line-format
10022 You can change the look of the server buffer lines by changing the
10023 @code{gnus-server-line-format} variable. This is a @code{format}-like
10024 variable, with some simple extensions:
10029 How the news is fetched---the backend name.
10032 The name of this server.
10035 Where the news is to be fetched from---the address.
10038 The opened/closed/denied status of the server.
10041 @vindex gnus-server-mode-line-format
10042 The mode line can also be customized by using the
10043 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
10044 Formatting}). The following specs are understood:
10054 Also @pxref{Formatting Variables}.
10057 @node Server Commands
10058 @subsection Server Commands
10059 @cindex server commands
10065 @findex gnus-server-add-server
10066 Add a new server (@code{gnus-server-add-server}).
10070 @findex gnus-server-edit-server
10071 Edit a server (@code{gnus-server-edit-server}).
10074 @kindex SPACE (Server)
10075 @findex gnus-server-read-server
10076 Browse the current server (@code{gnus-server-read-server}).
10080 @findex gnus-server-exit
10081 Return to the group buffer (@code{gnus-server-exit}).
10085 @findex gnus-server-kill-server
10086 Kill the current server (@code{gnus-server-kill-server}).
10090 @findex gnus-server-yank-server
10091 Yank the previously killed server (@code{gnus-server-yank-server}).
10095 @findex gnus-server-copy-server
10096 Copy the current server (@code{gnus-server-copy-server}).
10100 @findex gnus-server-list-servers
10101 List all servers (@code{gnus-server-list-servers}).
10105 @findex gnus-server-scan-server
10106 Request that the server scan its sources for new articles
10107 (@code{gnus-server-scan-server}). This is mainly sensible with mail
10112 @findex gnus-server-regenerate-server
10113 Request that the server regenerate all its data structures
10114 (@code{gnus-server-regenerate-server}). This can be useful if you have
10115 a mail backend that has gotten out of synch.
10120 @node Example Methods
10121 @subsection Example Methods
10123 Most select methods are pretty simple and self-explanatory:
10126 (nntp "news.funet.fi")
10129 Reading directly from the spool is even simpler:
10135 As you can see, the first element in a select method is the name of the
10136 backend, and the second is the @dfn{address}, or @dfn{name}, if you
10139 After these two elements, there may be an arbitrary number of
10140 @code{(@var{variable} @var{form})} pairs.
10142 To go back to the first example---imagine that you want to read from
10143 port 15 on that machine. This is what the select method should
10147 (nntp "news.funet.fi" (nntp-port-number 15))
10150 You should read the documentation to each backend to find out what
10151 variables are relevant, but here's an @code{nnmh} example:
10153 @code{nnmh} is a mail backend that reads a spool-like structure. Say
10154 you have two structures that you wish to access: One is your private
10155 mail spool, and the other is a public one. Here's the possible spec for
10159 (nnmh "private" (nnmh-directory "~/private/mail/"))
10162 (This server is then called @samp{private}, but you may have guessed
10165 Here's the method for a public spool:
10169 (nnmh-directory "/usr/information/spool/")
10170 (nnmh-get-new-mail nil))
10176 If you are behind a firewall and only have access to the @sc{nntp}
10177 server from the firewall machine, you can instruct Gnus to @code{rlogin}
10178 on the firewall machine and telnet from there to the @sc{nntp} server.
10179 Doing this can be rather fiddly, but your virtual server definition
10180 should probably look something like this:
10184 (nntp-address "the.firewall.machine")
10185 (nntp-open-connection-function nntp-open-rlogin)
10186 (nntp-end-of-line "\n")
10187 (nntp-rlogin-parameters
10188 ("telnet" "the.real.nntp.host" "nntp")))
10191 If you want to use the wonderful @code{ssh} program to provide a
10192 compressed connection over the modem line, you could create a virtual
10193 server that would look something like this:
10197 (nntp-address "copper.uio.no")
10198 (nntp-rlogin-program "ssh")
10199 (nntp-open-connection-function nntp-open-rlogin)
10200 (nntp-end-of-line "\n")
10201 (nntp-rlogin-parameters
10202 ("telnet" "news.uio.no" "nntp")))
10205 This means that you have to have set up @code{ssh-agent} correctly to
10206 provide automatic authorization, of course. And to get a compressed
10207 connection, you have to have the @samp{Compression} option in the
10208 @code{ssh} @file{config} file.
10211 @node Creating a Virtual Server
10212 @subsection Creating a Virtual Server
10214 If you're saving lots of articles in the cache by using persistent
10215 articles, you may want to create a virtual server to read the cache.
10217 First you need to add a new server. The @kbd{a} command does that. It
10218 would probably be best to use @code{nnspool} to read the cache. You
10219 could also use @code{nnml} or @code{nnmh}, though.
10221 Type @kbd{a nnspool RET cache RET}.
10223 You should now have a brand new @code{nnspool} virtual server called
10224 @samp{cache}. You now need to edit it to have the right definitions.
10225 Type @kbd{e} to edit the server. You'll be entered into a buffer that
10226 will contain the following:
10236 (nnspool-spool-directory "~/News/cache/")
10237 (nnspool-nov-directory "~/News/cache/")
10238 (nnspool-active-file "~/News/cache/active"))
10241 Type @kbd{C-c C-c} to return to the server buffer. If you now press
10242 @kbd{RET} over this virtual server, you should be entered into a browse
10243 buffer, and you should be able to enter any of the groups displayed.
10246 @node Server Variables
10247 @subsection Server Variables
10249 One sticky point when defining variables (both on backends and in Emacs
10250 in general) is that some variables are typically initialized from other
10251 variables when the definition of the variables is being loaded. If you
10252 change the "base" variable after the variables have been loaded, you
10253 won't change the "derived" variables.
10255 This typically affects directory and file variables. For instance,
10256 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
10257 directory variables are initialized from that variable, so
10258 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
10259 new virtual @code{nnml} server, it will @emph{not} suffice to set just
10260 @code{nnml-directory}---you have to explicitly set all the file
10261 variables to be what you want them to be. For a complete list of
10262 variables for each backend, see each backend's section later in this
10263 manual, but here's an example @code{nnml} definition:
10267 (nnml-directory "~/my-mail/")
10268 (nnml-active-file "~/my-mail/active")
10269 (nnml-newsgroups-file "~/my-mail/newsgroups"))
10273 @node Servers and Methods
10274 @subsection Servers and Methods
10276 Wherever you would normally use a select method
10277 (e.g. @code{gnus-secondary-select-method}, in the group select method,
10278 when browsing a foreign server) you can use a virtual server name
10279 instead. This could potentially save lots of typing. And it's nice all
10283 @node Unavailable Servers
10284 @subsection Unavailable Servers
10286 If a server seems to be unreachable, Gnus will mark that server as
10287 @code{denied}. That means that any subsequent attempt to make contact
10288 with that server will just be ignored. ``It can't be opened,'' Gnus
10289 will tell you, without making the least effort to see whether that is
10290 actually the case or not.
10292 That might seem quite naughty, but it does make sense most of the time.
10293 Let's say you have 10 groups subscribed to on server
10294 @samp{nephelococcygia.com}. This server is located somewhere quite far
10295 away from you and the machine is quite slow, so it takes 1 minute just
10296 to find out that it refuses connection to you today. If Gnus were to
10297 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
10298 attempt to do that. Once it has gotten a single ``connection refused'',
10299 it will regard that server as ``down''.
10301 So, what happens if the machine was only feeling unwell temporarily?
10302 How do you test to see whether the machine has come up again?
10304 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
10305 with the following commands:
10311 @findex gnus-server-open-server
10312 Try to establish connection to the server on the current line
10313 (@code{gnus-server-open-server}).
10317 @findex gnus-server-close-server
10318 Close the connection (if any) to the server
10319 (@code{gnus-server-close-server}).
10323 @findex gnus-server-deny-server
10324 Mark the current server as unreachable
10325 (@code{gnus-server-deny-server}).
10328 @kindex M-o (Server)
10329 @findex gnus-server-open-all-servers
10330 Open the connections to all servers in the buffer
10331 (@code{gnus-server-open-all-servers}).
10334 @kindex M-c (Server)
10335 @findex gnus-server-close-all-servers
10336 Close the connections to all servers in the buffer
10337 (@code{gnus-server-close-all-servers}).
10341 @findex gnus-server-remove-denials
10342 Remove all marks to whether Gnus was denied connection from any servers
10343 (@code{gnus-server-remove-denials}).
10349 @section Getting News
10350 @cindex reading news
10351 @cindex news backends
10353 A newsreader is normally used for reading news. Gnus currently provides
10354 only two methods of getting news---it can read from an @sc{nntp} server,
10355 or it can read from a local spool.
10358 * NNTP:: Reading news from an @sc{nntp} server.
10359 * News Spool:: Reading news from the local spool.
10364 @subsection @sc{nntp}
10367 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
10368 You just specify @code{nntp} as method and the address of the @sc{nntp}
10369 server as the, uhm, address.
10371 If the @sc{nntp} server is located at a non-standard port, setting the
10372 third element of the select method to this port number should allow you
10373 to connect to the right port. You'll have to edit the group info for
10374 that (@pxref{Foreign Groups}).
10376 The name of the foreign group can be the same as a native group. In
10377 fact, you can subscribe to the same group from as many different servers
10378 you feel like. There will be no name collisions.
10380 The following variables can be used to create a virtual @code{nntp}
10385 @item nntp-server-opened-hook
10386 @vindex nntp-server-opened-hook
10387 @cindex @sc{mode reader}
10389 @cindex authentification
10390 @cindex nntp authentification
10391 @findex nntp-send-authinfo
10392 @findex nntp-send-mode-reader
10393 is run after a connection has been made. It can be used to send
10394 commands to the @sc{nntp} server after it has been contacted. By
10395 default it sends the command @code{MODE READER} to the server with the
10396 @code{nntp-send-mode-reader} function. This function should always be
10397 present in this hook.
10399 @item nntp-authinfo-function
10400 @vindex nntp-authinfo-function
10401 @findex nntp-send-authinfo
10402 @vindex nntp-authinfo-file
10403 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
10404 server. The default function is @code{nntp-send-authinfo}, which looks
10405 through your @file{~/.authinfo} (or whatever you've set the
10406 @code{nntp-authinfo-file} variable to) for applicable entries. If none
10407 are found, it will prompt you for a login name and a password. The
10408 format of the @file{~/.authinfo} file is (almost) the same as the
10409 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
10410 manual page, but here are the salient facts:
10414 The file contains one or more line, each of which define one server.
10417 Each line may contain an arbitrary number of token/value pairs. The
10418 valid tokens include @samp{machine}, @samp{login}, @samp{password},
10419 @samp{default}, @samp{port} and @samp{force}. (The latter is not a
10420 valid @file{.netrc}/@code{ftp} token, which is almost the only way the
10421 @file{.authinfo} file format deviates from the @file{.netrc} file
10426 Here's an example file:
10429 machine news.uio.no login larsi password geheimnis
10430 machine nntp.ifi.uio.no login larsi force yes
10433 The token/value pairs may appear in any order; @samp{machine} doesn't
10434 have to be first, for instance.
10436 In this example, both login name and password have been supplied for the
10437 former server, while the latter has only the login name listed, and the
10438 user will be prompted for the password. The latter also has the
10439 @samp{force} tag, which means that the authinfo will be sent to the
10440 @var{nntp} server upon connection; the default (i.e., when there is not
10441 @samp{force} tag) is to not send authinfo to the @var{nntp} server
10442 until the @var{nntp} server asks for it.
10444 You can also add @samp{default} lines that will apply to all servers
10445 that don't have matching @samp{machine} lines.
10451 This will force sending @samp{AUTHINFO} commands to all servers not
10452 previously mentioned.
10454 Remember to not leave the @file{~/.authinfo} file world-readable.
10456 @item nntp-server-action-alist
10457 @vindex nntp-server-action-alist
10458 This is a list of regexps to match on server types and actions to be
10459 taken when matches are made. For instance, if you want Gnus to beep
10460 every time you connect to innd, you could say something like:
10463 (setq nntp-server-action-alist
10464 '(("innd" (ding))))
10467 You probably don't want to do that, though.
10469 The default value is
10472 '(("nntpd 1\\.5\\.11t"
10473 (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
10476 This ensures that Gnus doesn't send the @code{MODE READER} command to
10477 nntpd 1.5.11t, since that command chokes that server, I've been told.
10479 @item nntp-maximum-request
10480 @vindex nntp-maximum-request
10481 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
10482 will collect headers by sending a series of @code{head} commands. To
10483 speed things up, the backend sends lots of these commands without
10484 waiting for reply, and then reads all the replies. This is controlled
10485 by the @code{nntp-maximum-request} variable, and is 400 by default. If
10486 your network is buggy, you should set this to 1.
10488 @item nntp-connection-timeout
10489 @vindex nntp-connection-timeout
10490 If you have lots of foreign @code{nntp} groups that you connect to
10491 regularly, you're sure to have problems with @sc{nntp} servers not
10492 responding properly, or being too loaded to reply within reasonable
10493 time. This is can lead to awkward problems, which can be helped
10494 somewhat by setting @code{nntp-connection-timeout}. This is an integer
10495 that says how many seconds the @code{nntp} backend should wait for a
10496 connection before giving up. If it is @code{nil}, which is the default,
10497 no timeouts are done.
10499 @c @item nntp-command-timeout
10500 @c @vindex nntp-command-timeout
10501 @c @cindex PPP connections
10502 @c @cindex dynamic IP addresses
10503 @c If you're running Gnus on a machine that has a dynamically assigned
10504 @c address, Gnus may become confused. If the address of your machine
10505 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
10506 @c waiting forever for replies from the server. To help with this
10507 @c unfortunate problem, you can set this command to a number. Gnus will
10508 @c then, if it sits waiting for a reply from the server longer than that
10509 @c number of seconds, shut down the connection, start a new one, and resend
10510 @c the command. This should hopefully be transparent to the user. A
10511 @c likely number is 30 seconds.
10513 @c @item nntp-retry-on-break
10514 @c @vindex nntp-retry-on-break
10515 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
10516 @c hangs. This will have much the same effect as the command timeout
10517 @c described above.
10519 @item nntp-server-hook
10520 @vindex nntp-server-hook
10521 This hook is run as the last step when connecting to an @sc{nntp}
10524 @findex nntp-open-rlogin
10525 @findex nntp-open-telnet
10526 @findex nntp-open-network-stream
10527 @item nntp-open-connection-function
10528 @vindex nntp-open-connection-function
10529 This function is used to connect to the remote system. Four pre-made
10530 functions are supplied:
10533 @item nntp-open-network-stream
10534 This is the default, and simply connects to some port or other on the
10537 @item nntp-open-rlogin
10538 Does an @samp{rlogin} on the
10539 remote system, and then does a @samp{telnet} to the @sc{nntp} server
10542 @code{nntp-open-rlogin}-related variables:
10546 @item nntp-rlogin-program
10547 @vindex nntp-rlogin-program
10548 Program used to log in on remote machines. The default is @samp{rsh},
10549 but @samp{ssh} is a popular alternative.
10551 @item nntp-rlogin-parameters
10552 @vindex nntp-rlogin-parameters
10553 This list will be used as the parameter list given to @code{rsh}.
10555 @item nntp-rlogin-user-name
10556 @vindex nntp-rlogin-user-name
10557 User name on the remote system.
10561 @item nntp-open-telnet
10562 Does a @samp{telnet} to the remote system and then another @samp{telnet}
10563 to get to the @sc{nntp} server.
10565 @code{nntp-open-telnet}-related variables:
10568 @item nntp-telnet-command
10569 @vindex nntp-telnet-command
10570 Command used to start @code{telnet}.
10572 @item nntp-telnet-switches
10573 @vindex nntp-telnet-switches
10574 List of strings to be used as the switches to the @code{telnet} command.
10576 @item nntp-telnet-user-name
10577 @vindex nntp-telnet-user-name
10578 User name for log in on the remote system.
10580 @item nntp-telnet-passwd
10581 @vindex nntp-telnet-passwd
10582 Password to use when logging in.
10584 @item nntp-telnet-parameters
10585 @vindex nntp-telnet-parameters
10586 A list of strings executed as a command after logging in
10589 @item nntp-telnet-shell-prompt
10590 @vindex nntp-telnet-shell-prompt
10591 Regexp matching the shell prompt on the remote machine. The default is
10592 @samp{bash\\|\$ *\r?$\\|> *\r?}.
10594 @item nntp-open-telnet-envuser
10595 @vindex nntp-open-telnet-envuser
10596 If non-@code{nil}, the @code{telnet} session (client and server both)
10597 will support the @code{ENVIRON} option and not prompt for login name.
10598 This works for Solaris @code{telnet}, for instance.
10602 @findex nntp-open-ssl-stream
10603 @item nntp-open-ssl-stream
10604 Opens a connection to a server over a @dfn{secure} channel. To use this
10605 you must have SSLay installed
10606 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
10607 @file{ssl.el} (from the W3 distributeion, for instance). You then
10608 define a server as follows:
10611 ;; Type `C-c C-c' after you've finished editing.
10613 ;; "snews" is port 563 and is predefined in our /etc/services
10615 (nntp "snews.bar.com"
10616 (nntp-open-connection-function nntp-open-ssl-stream)
10617 (nntp-port-number "snews")
10618 (nntp-address "snews.bar.com"))
10623 @item nntp-end-of-line
10624 @vindex nntp-end-of-line
10625 String to use as end-of-line marker when talking to the @sc{nntp}
10626 server. This is @samp{\r\n} by default, but should be @samp{\n} when
10627 using @code{rlogin} to talk to the server.
10629 @item nntp-rlogin-user-name
10630 @vindex nntp-rlogin-user-name
10631 User name on the remote system when using the @code{rlogin} connect
10635 @vindex nntp-address
10636 The address of the remote system running the @sc{nntp} server.
10638 @item nntp-port-number
10639 @vindex nntp-port-number
10640 Port number to connect to when using the @code{nntp-open-network-stream}
10643 @item nntp-buggy-select
10644 @vindex nntp-buggy-select
10645 Set this to non-@code{nil} if your select routine is buggy.
10647 @item nntp-nov-is-evil
10648 @vindex nntp-nov-is-evil
10649 If the @sc{nntp} server does not support @sc{nov}, you could set this
10650 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
10653 @item nntp-xover-commands
10654 @vindex nntp-xover-commands
10657 List of strings used as commands to fetch @sc{nov} lines from a
10658 server. The default value of this variable is @code{("XOVER"
10662 @vindex nntp-nov-gap
10663 @code{nntp} normally sends just one big request for @sc{nov} lines to
10664 the server. The server responds with one huge list of lines. However,
10665 if you have read articles 2-5000 in the group, and only want to read
10666 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
10667 lines that you will not need. This variable says how
10668 big a gap between two consecutive articles is allowed to be before the
10669 @code{XOVER} request is split into several request. Note that if your
10670 network is fast, setting this variable to a really small number means
10671 that fetching will probably be slower. If this variable is @code{nil},
10672 @code{nntp} will never split requests. The default is 5.
10674 @item nntp-prepare-server-hook
10675 @vindex nntp-prepare-server-hook
10676 A hook run before attempting to connect to an @sc{nntp} server.
10678 @item nntp-warn-about-losing-connection
10679 @vindex nntp-warn-about-losing-connection
10680 If this variable is non-@code{nil}, some noise will be made when a
10681 server closes connection.
10683 @item nntp-record-commands
10684 @vindex nntp-record-commands
10685 If non-@code{nil}, @code{nntp} will log all commands it sends to the
10686 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
10687 buffer. This is useful if you are debugging a Gnus/@sc{nntp} connection
10688 that doesn't seem to work.
10694 @subsection News Spool
10698 Subscribing to a foreign group from the local spool is extremely easy,
10699 and might be useful, for instance, to speed up reading groups that
10700 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
10703 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
10704 anything else) as the address.
10706 If you have access to a local spool, you should probably use that as the
10707 native select method (@pxref{Finding the News}). It is normally faster
10708 than using an @code{nntp} select method, but might not be. It depends.
10709 You just have to try to find out what's best at your site.
10713 @item nnspool-inews-program
10714 @vindex nnspool-inews-program
10715 Program used to post an article.
10717 @item nnspool-inews-switches
10718 @vindex nnspool-inews-switches
10719 Parameters given to the inews program when posting an article.
10721 @item nnspool-spool-directory
10722 @vindex nnspool-spool-directory
10723 Where @code{nnspool} looks for the articles. This is normally
10724 @file{/usr/spool/news/}.
10726 @item nnspool-nov-directory
10727 @vindex nnspool-nov-directory
10728 Where @code{nnspool} will look for @sc{nov} files. This is normally
10729 @file{/usr/spool/news/over.view/}.
10731 @item nnspool-lib-dir
10732 @vindex nnspool-lib-dir
10733 Where the news lib dir is (@file{/usr/lib/news/} by default).
10735 @item nnspool-active-file
10736 @vindex nnspool-active-file
10737 The path to the active file.
10739 @item nnspool-newsgroups-file
10740 @vindex nnspool-newsgroups-file
10741 The path to the group descriptions file.
10743 @item nnspool-history-file
10744 @vindex nnspool-history-file
10745 The path to the news history file.
10747 @item nnspool-active-times-file
10748 @vindex nnspool-active-times-file
10749 The path to the active date file.
10751 @item nnspool-nov-is-evil
10752 @vindex nnspool-nov-is-evil
10753 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
10756 @item nnspool-sift-nov-with-sed
10757 @vindex nnspool-sift-nov-with-sed
10759 If non-@code{nil}, which is the default, use @code{sed} to get the
10760 relevant portion from the overview file. If nil, @code{nnspool} will
10761 load the entire file into a buffer and process it there.
10767 @section Getting Mail
10768 @cindex reading mail
10771 Reading mail with a newsreader---isn't that just plain WeIrD? But of
10775 * Mail in a Newsreader:: Important introductory notes.
10776 * Getting Started Reading Mail:: A simple cookbook example.
10777 * Splitting Mail:: How to create mail groups.
10778 * Mail Sources:: How to tell Gnus where to get mail from.
10779 * Mail Backend Variables:: Variables for customizing mail handling.
10780 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
10781 * Group Mail Splitting:: Use group customize to drive mail splitting.
10782 * Incorporating Old Mail:: What about the old mail you have?
10783 * Expiring Mail:: Getting rid of unwanted mail.
10784 * Washing Mail:: Removing gruft from the mail you get.
10785 * Duplicates:: Dealing with duplicated mail.
10786 * Not Reading Mail:: Using mail backends for reading other files.
10787 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
10791 @node Mail in a Newsreader
10792 @subsection Mail in a Newsreader
10794 If you are used to traditional mail readers, but have decided to switch
10795 to reading mail with Gnus, you may find yourself experiencing something
10796 of a culture shock.
10798 Gnus does not behave like traditional mail readers. If you want to make
10799 it behave that way, you can, but it's an uphill battle.
10801 Gnus, by default, handles all its groups using the same approach. This
10802 approach is very newsreaderly---you enter a group, see the new/unread
10803 messages, and when you read the messages, they get marked as read, and
10804 you don't see them any more. (Unless you explicitly ask for them.)
10806 In particular, you do not do anything explicitly to delete messages.
10808 Does this mean that all the messages that have been marked as read are
10809 deleted? How awful!
10811 But, no, it means that old messages are @dfn{expired} according to some
10812 scheme or other. For news messages, the expire process is controlled by
10813 the news administrator; for mail, the expire process is controlled by
10814 you. The expire process for mail is covered in depth in @pxref{Expiring
10817 What many Gnus users find, after using it a while for both news and
10818 mail, is that the transport mechanism has very little to do with how
10819 they want to treat a message.
10821 Many people subscribe to several mailing lists. These are transported
10822 via SMTP, and are therefore mail. But we might go for weeks without
10823 answering, or even reading these messages very carefully. We may not
10824 need to save them because if we should need to read one again, they are
10825 archived somewhere else.
10827 Some people have local news groups which have only a handful of readers.
10828 These are transported via @sc{nntp}, and are therefore news. But we may need
10829 to read and answer a large fraction of the messages very carefully in
10830 order to do our work. And there may not be an archive, so we may need
10831 to save the interesting messages the same way we would personal mail.
10833 The important distinction turns out to be not the transport mechanism,
10834 but other factors such as how interested we are in the subject matter,
10835 or how easy it is to retrieve the message if we need to read it again.
10837 Gnus provides many options for sorting mail into ``groups'' which behave
10838 like newsgroups, and for treating each group (whether mail or news)
10841 Some users never get comfortable using the Gnus (ahem) paradigm and wish
10842 that Gnus should grow up and be a male, er, mail reader. It is possible
10843 to whip Gnus into a more mailreaderly being, but, as said before, it's
10844 not easy. People who prefer proper mail readers should try @sc{vm}
10845 instead, which is an excellent, and proper, mail reader.
10847 I don't mean to scare anybody off, but I want to make it clear that you
10848 may be required to learn a new way of thinking about messages. After
10849 you've been subjected to The Gnus Way, you will come to love it. I can
10850 guarantee it. (At least the guy who sold me the Emacs Subliminal
10851 Brain-Washing Functions that I've put into Gnus did guarantee it. You
10852 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
10856 @node Getting Started Reading Mail
10857 @subsection Getting Started Reading Mail
10859 It's quite easy to use Gnus to read your new mail. You just plonk the
10860 mail backend of your choice into @code{gnus-secondary-select-methods},
10861 and things will happen automatically.
10863 For instance, if you want to use @code{nnml} (which is a "one file per
10864 mail" backend), you could put the following in your @file{.gnus} file:
10867 (setq gnus-secondary-select-methods
10868 '((nnml "private")))
10871 Now, the next time you start Gnus, this backend will be queried for new
10872 articles, and it will move all the messages in your spool file to its
10873 directory, which is @code{~/Mail/} by default. The new group that will
10874 be created (@samp{mail.misc}) will be subscribed, and you can read it
10875 like any other group.
10877 You will probably want to split the mail into several groups, though:
10880 (setq nnmail-split-methods
10881 '(("junk" "^From:.*Lars Ingebrigtsen")
10882 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
10886 This will result in three new @code{nnml} mail groups being created:
10887 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
10888 mail that doesn't fit into the first two groups will be placed in the
10891 This should be sufficient for reading mail with Gnus. You might want to
10892 give the other sections in this part of the manual a perusal, though.
10893 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
10896 @node Splitting Mail
10897 @subsection Splitting Mail
10898 @cindex splitting mail
10899 @cindex mail splitting
10901 @vindex nnmail-split-methods
10902 The @code{nnmail-split-methods} variable says how the incoming mail is
10903 to be split into groups.
10906 (setq nnmail-split-methods
10907 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
10908 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
10909 ("mail.other" "")))
10912 This variable is a list of lists, where the first element of each of
10913 these lists is the name of the mail group (they do not have to be called
10914 something beginning with @samp{mail}, by the way), and the second
10915 element is a regular expression used on the header of each mail to
10916 determine if it belongs in this mail group. The first string may
10917 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
10918 insert sub-expressions from the matched text. For instance:
10921 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
10924 The second element can also be a function. In that case, it will be
10925 called narrowed to the headers with the first element of the rule as the
10926 argument. It should return a non-@code{nil} value if it thinks that the
10927 mail belongs in that group.
10929 The last of these groups should always be a general one, and the regular
10930 expression should @emph{always} be @samp{} so that it matches any mails
10931 that haven't been matched by any of the other regexps. (These rules are
10932 processed from the beginning of the alist toward the end. The first
10933 rule to make a match will "win", unless you have crossposting enabled.
10934 In that case, all matching rules will "win".)
10936 If you like to tinker with this yourself, you can set this variable to a
10937 function of your choice. This function will be called without any
10938 arguments in a buffer narrowed to the headers of an incoming mail
10939 message. The function should return a list of group names that it
10940 thinks should carry this mail message.
10942 Note that the mail backends are free to maul the poor, innocent,
10943 incoming headers all they want to. They all add @code{Lines} headers;
10944 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
10945 @code{From<SPACE>} line to something else.
10947 @vindex nnmail-crosspost
10948 The mail backends all support cross-posting. If several regexps match,
10949 the mail will be ``cross-posted'' to all those groups.
10950 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
10951 that no articles are crossposted to the general (@samp{}) group.
10953 @vindex nnmail-crosspost-link-function
10956 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
10957 the crossposted articles. However, not all file systems support hard
10958 links. If that's the case for you, set
10959 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
10960 variable is @code{add-name-to-file} by default.)
10962 @kindex M-x nnmail-split-history
10963 @kindex nnmail-split-history
10964 If you wish to see where the previous mail split put the messages, you
10965 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
10966 where re-spooling messages would put the messages, you can use
10967 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
10970 Gnus gives you all the opportunity you could possibly want for shooting
10971 yourself in the foot. Let's say you create a group that will contain
10972 all the mail you get from your boss. And then you accidentally
10973 unsubscribe from the group. Gnus will still put all the mail from your
10974 boss in the unsubscribed group, and so, when your boss mails you ``Have
10975 that report ready by Monday or you're fired!'', you'll never see it and,
10976 come Tuesday, you'll still believe that you're gainfully employed while
10977 you really should be out collecting empty bottles to save up for next
10978 month's rent money.
10982 @subsection Mail Sources
10984 Mail can be gotten from many different sources---the mail spool, from a
10985 POP mail server, from a procmail directory, or from a maildir, for
10989 * Mail Source Specifiers:: How to specify what a mail source is.
10990 * Mail Source Customization:: Some variables that influence things.
10991 * Fetching Mail:: Using the mail source specifiers.
10995 @node Mail Source Specifiers
10996 @subsubsection Mail Source Specifiers
10998 @cindex mail server
11001 @cindex mail source
11003 You tell Gnus how to fetch mail by setting @code{mail-sources}
11004 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
11009 (pop :server "pop3.mailserver.com" :user "myname")
11012 As can be observed, a mail source specifier is a list where the first
11013 element is a @dfn{mail source type}, followed by an arbitrary number of
11014 @dfn{keywords}. Keywords that are not explicitly specified are given
11017 The following mail source types are available:
11021 Get mail from a single file; typically from the mail spool.
11027 The path of the file. Defaults to the value of the @code{MAIL}
11028 environment variable or @file{/usr/mail/spool/user-name}.
11031 An example file mail source:
11034 (file :path "/usr/spool/mail/user-name")
11037 Or using the default path:
11043 If the mail spool file is not located on the local machine, it's best to
11044 use POP or @sc{imap} or the like to fetch the mail. You can not use ange-ftp
11045 file names here---it has no way to lock the mail spool while moving the
11048 If it's impossible to set up a proper server, you can use ssh instead.
11052 '((file :prescript "ssh host bin/getmail >%t")))
11055 The @samp{getmail} script would look something like the following:
11059 # getmail - move mail from spool to stdout
11062 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
11064 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
11067 Alter this script to fit find the @samp{movemail} you want to use.
11071 Get mail from several files in a directory. This is typically used when
11072 you have procmail split the incoming mail into several files. Setting
11073 @code{nnmail-scan-directory-mail-source-once} to non-nil force Gnus to
11074 scan the mail source only once.
11080 The path of the directory where the files are. There is no default
11084 Only files ending with this suffix are used. The default is
11088 Only files that have this predicate return non-@code{nil} are returned.
11089 The default is @code{identity}. This is used as an additional
11090 filter---only files that have the right suffix @emph{and} satisfy this
11091 predicate are considered.
11095 Script run before/after fetching mail.
11099 An example directory mail source:
11102 (directory :path "/home/user-name/procmail-dir/"
11107 Get mail from a POP server.
11113 The name of the POP server. The default is taken from the
11114 @code{MAILHOST} environment variable.
11117 The port number of the POP server. This can be a number (eg,
11118 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
11119 string, it should be a service name as listed in @file{/etc/services} on
11120 Unix systems. The default is @samp{"pop3"}.
11123 The user name to give to the POP server. The default is the login
11127 The password to give to the POP server. If not specified, the user is
11131 The program to use to fetch mail from the POP server. This is should be
11132 a @code{format}-like string. Here's an example:
11135 fetchmail %u@@%s -P %p %t
11138 The valid format specifier characters are:
11142 The name of the file the mail is to be moved to. This must always be
11143 included in this string.
11146 The name of the server.
11149 The port number of the server.
11152 The user name to use.
11155 The password to use.
11158 The values used for these specs are taken from the values you give the
11159 corresponding keywords.
11162 A script to be run before fetching the mail. The syntax is the same as
11163 the @code{:program} keyword. This can also be a function to be run.
11166 A script to be run after fetching the mail. The syntax is the same as
11167 the @code{:program} keyword. This can also be a function to be run.
11170 The function to use to fetch mail from the POP server. The function is
11171 called with one parameter---the name of the file where the mail should
11174 @item :authentication
11175 This can be either the symbol @code{password} or the symbol @code{apop}
11176 and says what authentication scheme to use. The default is
11181 If the @code{:program} and @code{:function} keywords aren't specified,
11182 @code{pop3-movemail} will be used.
11184 Here are some examples. Fetch from the default POP server, using the
11185 default user name, and default fetcher:
11191 Fetch from a named server with a named user and password:
11194 (pop :server "my.pop.server"
11195 :user "user-name" :password "secret")
11198 Use @samp{movemail} to move the mail:
11201 (pop :program "movemail po:%u %t %p")
11205 Get mail from a maildir. This is a type of mailbox that is supported by
11206 at least qmail and postfix, where each file in a special directory
11207 contains exactly one mail.
11213 The path of the directory where the mails are stored. The default is
11214 taken from the @code{MAILDIR} environment variable or
11217 The subdirectories of the Maildir. The default is
11218 @samp{("new" "cur")}.
11220 @c If you sometimes look at your mail through a pop3 daemon before fetching
11221 @c them with Gnus, you may also have to fetch your mails from the
11222 @c @code{cur} directory inside the maildir, like in the first example
11225 You can also get mails from remote hosts (because maildirs don't suffer
11226 from locking problems).
11230 Two example maildir mail sources:
11233 (maildir :path "/home/user-name/Maildir/" :subdirs ("cur" "new"))
11237 (maildir :path "/user@@remotehost.org:~/Maildir/" :subdirs ("new"))
11241 Get mail from a @sc{imap} server. If you don't want to use @sc{imap} as
11242 intended, as a network mail reading protocol (ie with nnimap), for some
11243 reason or other, Gnus let you treat it similar to a POP server and
11244 fetches articles from a given @sc{imap} mailbox.
11250 The name of the @sc{imap} server. The default is taken from the
11251 @code{MAILHOST} environment variable.
11254 The port number of the @sc{imap} server. The default is @samp{143}, or
11255 @samp{993} for SSL connections.
11258 The user name to give to the @sc{imap} server. The default is the login
11262 The password to give to the @sc{imap} server. If not specified, the user is
11266 What stream to use for connecting to the server, this is one of the
11267 symbols in @code{imap-stream-alist}. Right now, this means
11268 @samp{kerberos4}, @samp{ssl} or the default @samp{network}.
11270 @item :authentication
11271 Which authenticator to use for authenticating to the server, this is one
11272 of the symbols in @code{imap-authenticator-alist}. Right now, this
11273 means @samp{kerberos4}, @samp{cram-md5}, @samp{anonymous} or the default
11277 The name of the mailbox to get mail from. The default is @samp{INBOX}
11278 which normally is the mailbox which receive incoming mail.
11281 The predicate used to find articles to fetch. The default, @samp{UNSEEN
11282 UNDELETED}, is probably the best choice for most people, but if you
11283 sometimes peek in your mailbox with a @sc{imap} client and mark some
11284 articles as read (or; SEEN) you might want to set this to @samp{nil}.
11285 Then all articles in the mailbox is fetched, no matter what. For a
11286 complete list of predicates, see RFC 2060 §6.4.4.
11289 How to flag fetched articles on the server, the default @samp{\Deleted}
11290 will mark them as deleted, an alternative would be @samp{\Seen} which
11291 would simply mark them as read. These are the two most likely choices,
11292 but more flags are defined in RFC 2060 §2.3.2.
11295 If non-nil, don't remove all articles marked as deleted in the mailbox
11296 after finishing the fetch.
11300 An example @sc{imap} mail source:
11303 (imap :server "mail.mycorp.com" :stream kerberos4 :fetchflag "\\Seen")
11307 Get mail from a webmail server, such as www.hotmail.com,
11308 webmail.netscape.com, www.netaddress.com, www.my-deja.com.
11310 NOTE: Now mail.yahoo.com provides POP3 service, so @sc{pop} mail source
11313 NOTE: Webmail largely depends cookies. A "one-line-cookie" patch is
11314 required for url "4.0pre.46".
11316 WARNING: Mails may lost. NO WARRANTY.
11322 The type of the webmail server. The default is @code{hotmail}. The
11323 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
11326 The user name to give to the webmail server. The default is the login
11330 The password to give to the webmail server. If not specified, the user is
11334 If non-nil, only fetch unread articles and don't move them to trash
11335 folder after finishing the fetch.
11339 An example webmail source:
11342 (webmail :subtype 'hotmail :user "user-name" :password "secret")
11347 @item Common Keywords
11348 Common keywords can be used in any type of mail source.
11354 If non-nil, fetch the mail even when Gnus is unplugged. If you use
11355 directory source to get mail, you can specify it as in this example:
11359 '((directory :path "/home/pavel/.Spool/"
11364 Gnus will then fetch your mail even when you are unplugged. This is
11365 useful when you use local mail and news.
11370 @subsubheading Function Interface
11372 Some of the above keywords specify a Lisp function to be executed.
11373 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
11374 the value of the keyword while the function is executing. For example,
11375 consider the following mail-source setting:
11378 (setq mail-sources '((pop :user "jrl"
11379 :server "pophost" :function fetchfunc)))
11382 While the function @code{fetchfunc} is executing, the symbol @code{user}
11383 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
11384 @code{"pophost"}. The symbols @code{port}, @code{password},
11385 @code{program}, @code{prescript}, @code{postscript}, @code{function},
11386 and @code{authentication} are also bound (to their default values).
11388 See above for a list of keywords for each type of mail source.
11391 @node Mail Source Customization
11392 @subsubsection Mail Source Customization
11394 The following is a list of variables that influence how the mail is
11395 fetched. You would normally not need to set or change any of these
11399 @item mail-source-crash-box
11400 @vindex mail-source-crash-box
11401 File where mail will be stored while processing it. The default is
11402 @file{~/.emacs-mail-crash-box}.
11404 @item mail-source-delete-incoming
11405 @vindex mail-source-delete-incoming
11406 If non-@code{nil}, delete incoming files after handling them.
11408 @item mail-source-directory
11409 @vindex mail-source-directory
11410 Directory where files (if any) will be stored. The default is
11411 @file{~/Mail/}. At present, the only thing this is used for is to say
11412 where the incoming files will be stored if the previous variable is
11415 @item mail-source-incoming-file-prefix
11416 @vindex mail-source-incoming-file-prefix
11417 Prefix for file name for storing incoming mail. The default is
11418 @file{Incoming}, in which case files will end up with names like
11419 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
11420 relevant if @code{mail-source-delete-incoming} is @code{nil}.
11422 @item mail-source-default-file-modes
11423 @vindex mail-source-default-file-modes
11424 All new mail files will get this file mode. The default is 384.
11429 @node Fetching Mail
11430 @subsubsection Fetching Mail
11432 @vindex mail-sources
11433 @vindex nnmail-spool-file
11434 The way to actually tell Gnus where to get new mail from is to set
11435 @code{mail-sources} to a list of mail source specifiers
11436 (@pxref{Mail Source Specifiers}).
11438 If this variable (and the obsolescent @code{nnmail-spool-file}) is
11439 @code{nil}, the mail backends will never attempt to fetch mail by
11442 If you want to fetch mail both from your local spool as well as a POP
11443 mail server, you'd say something like:
11448 (pop :server "pop3.mail.server"
11449 :password "secret")))
11452 Or, if you don't want to use any of the keyword defaults:
11456 '((file :path "/var/spool/mail/user-name")
11457 (pop :server "pop3.mail.server"
11460 :password "secret")))
11464 When you use a mail backend, Gnus will slurp all your mail from your
11465 inbox and plonk it down in your home directory. Gnus doesn't move any
11466 mail if you're not using a mail backend---you have to do a lot of magic
11467 invocations first. At the time when you have finished drawing the
11468 pentagram, lightened the candles, and sacrificed the goat, you really
11469 shouldn't be too surprised when Gnus moves your mail.
11473 @node Mail Backend Variables
11474 @subsection Mail Backend Variables
11476 These variables are (for the most part) pertinent to all the various
11480 @vindex nnmail-read-incoming-hook
11481 @item nnmail-read-incoming-hook
11482 The mail backends all call this hook after reading new mail. You can
11483 use this hook to notify any mail watch programs, if you want to.
11485 @vindex nnmail-split-hook
11486 @item nnmail-split-hook
11487 @findex article-decode-encoded-words
11488 @findex RFC 1522 decoding
11489 @findex RFC 2047 decoding
11490 Hook run in the buffer where the mail headers of each message is kept
11491 just before the splitting based on these headers is done. The hook is
11492 free to modify the buffer contents in any way it sees fit---the buffer
11493 is discarded after the splitting has been done, and no changes performed
11494 in the buffer will show up in any files.
11495 @code{gnus-article-decode-encoded-words} is one likely function to add
11498 @vindex nnmail-pre-get-new-mail-hook
11499 @vindex nnmail-post-get-new-mail-hook
11500 @item nnmail-pre-get-new-mail-hook
11501 @itemx nnmail-post-get-new-mail-hook
11502 These are two useful hooks executed when treating new incoming
11503 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
11504 starting to handle the new mail) and
11505 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
11506 is done). Here's and example of using these two hooks to change the
11507 default file modes the new mail files get:
11510 (add-hook 'gnus-pre-get-new-mail-hook
11511 (lambda () (set-default-file-modes 511)))
11513 (add-hook 'gnus-post-get-new-mail-hook
11514 (lambda () (set-default-file-modes 551)))
11517 @item nnmail-use-long-file-names
11518 @vindex nnmail-use-long-file-names
11519 If non-@code{nil}, the mail backends will use long file and directory
11520 names. Groups like @samp{mail.misc} will end up in directories
11521 (assuming use of @code{nnml} backend) or files (assuming use of
11522 @code{nnfolder} backend) like @file{mail.misc}. If it is @code{nil},
11523 the same group will end up in @file{mail/misc}.
11525 @item nnmail-delete-file-function
11526 @vindex nnmail-delete-file-function
11527 @findex delete-file
11528 Function called to delete files. It is @code{delete-file} by default.
11530 @item nnmail-cache-accepted-message-ids
11531 @vindex nnmail-cache-accepted-message-ids
11532 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
11533 the backend (via @code{Gcc}, for instance) into the mail duplication
11534 discovery cache. The default is @code{nil}.
11539 @node Fancy Mail Splitting
11540 @subsection Fancy Mail Splitting
11541 @cindex mail splitting
11542 @cindex fancy mail splitting
11544 @vindex nnmail-split-fancy
11545 @findex nnmail-split-fancy
11546 If the rather simple, standard method for specifying how to split mail
11547 doesn't allow you to do what you want, you can set
11548 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
11549 play with the @code{nnmail-split-fancy} variable.
11551 Let's look at an example value of this variable first:
11554 ;; Messages from the mailer daemon are not crossposted to any of
11555 ;; the ordinary groups. Warnings are put in a separate group
11556 ;; from real errors.
11557 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
11559 ;; Non-error messages are crossposted to all relevant
11560 ;; groups, but we don't crosspost between the group for the
11561 ;; (ding) list and the group for other (ding) related mail.
11562 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
11563 ("subject" "ding" "ding.misc"))
11564 ;; Other mailing lists...
11565 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
11566 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
11567 ;; Both lists below have the same suffix, so prevent
11568 ;; cross-posting to mkpkg.list of messages posted only to
11569 ;; the bugs- list, but allow cross-posting when the
11570 ;; message was really cross-posted.
11571 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
11572 (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
11574 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
11575 ;; Unmatched mail goes to the catch all group.
11579 This variable has the format of a @dfn{split}. A split is a (possibly)
11580 recursive structure where each split may contain other splits. Here are
11581 the five possible split syntaxes:
11586 @samp{group}: If the split is a string, that will be taken as a group
11587 name. Normal regexp match expansion will be done. See below for
11591 @code{(@var{field} @var{value} @code{[-} @var{restrict}
11592 @code{[@dots{}]}@code{]} @var{split})}: If the split is a list, the
11593 first element of which is a string, then store the message as
11594 specified by @var{split}, if header @var{field} (a regexp) contains
11595 @var{value} (also a regexp). If @var{restrict} (yet another regexp)
11596 matches some string after @var{field} and before the end of the
11597 matched @var{value}, the @var{split} is ignored. If none of the
11598 @var{restrict} clauses match, @var{split} is processed.
11601 @code{(| @var{split}@dots{})}: If the split is a list, and the first
11602 element is @code{|} (vertical bar), then process each @var{split} until
11603 one of them matches. A @var{split} is said to match if it will cause
11604 the mail message to be stored in one or more groups.
11607 @code{(& @var{split}@dots{})}: If the split is a list, and the first
11608 element is @code{&}, then process all @var{split}s in the list.
11611 @code{junk}: If the split is the symbol @code{junk}, then don't save
11612 this message. Use with extreme caution.
11615 @code{(: @var{function} @var{arg1} @var{arg2} @dots{})}: If the split is
11616 a list, and the first element is @code{:}, then the second element will
11617 be called as a function with @var{args} given as arguments. The
11618 function should return a @var{split}.
11620 For instance, the following function could be used to split based on the
11621 body of the messages:
11624 (defun split-on-body ()
11626 (set-buffer " *nnmail incoming*")
11627 (goto-char (point-min))
11628 (when (re-search-forward "Some.*string" nil t)
11633 @code{(! @var{func} @var{split})}: If the split is a list, and the first
11634 element is @code{!}, then SPLIT will be processed, and FUNC will be
11635 called as a function with the result of SPLIT as argument. FUNC should
11639 @code{nil}: If the split is @code{nil}, it is ignored.
11643 In these splits, @var{field} must match a complete field name.
11644 @var{value} must match a complete word according to the fundamental mode
11645 syntax table. You can use @code{.*} in the regexps to match partial
11646 field names or words. In other words, all @var{value}'s are wrapped in
11647 @samp{\<} and @samp{\>} pairs.
11649 @vindex nnmail-split-abbrev-alist
11650 @var{field} and @var{value} can also be lisp symbols, in that case they
11651 are expanded as specified by the variable
11652 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
11653 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
11656 @vindex nnmail-split-fancy-syntax-table
11657 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
11658 when all this splitting is performed.
11660 If you want to have Gnus create groups dynamically based on some
11661 information in the headers (i.e., do @code{replace-match}-like
11662 substitutions in the group names), you can say things like:
11665 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
11668 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
11669 will be filed in @samp{mail.debian.foo}.
11671 If the string contains the element @samp{\&}, then the previously
11672 matched string will be substituted. Similarly, the elements @samp{\\1}
11673 up to @samp{\\9} will be substituted with the text matched by the
11674 groupings 1 through 9.
11677 @node Group Mail Splitting
11678 @subsection Group Mail Splitting
11679 @cindex mail splitting
11680 @cindex group mail splitting
11682 @findex gnus-group-split
11683 If you subscribe to dozens of mailing lists but you don't want to
11684 maintain mail splitting rules manually, group mail splitting is for you.
11685 You just have to set @var{to-list} and/or @var{to-address} in group
11686 parameters or group customization and set @code{nnmail-split-methods} to
11687 @code{gnus-group-split}. This splitting function will scan all groups
11688 for those parameters and split mail accordingly, i.e., messages posted
11689 from or to the addresses specified in the parameters @var{to-list} or
11690 @var{to-address} of a mail group will be stored in that group.
11692 Sometimes, mailing lists have multiple addresses, and you may want mail
11693 splitting to recognize them all: just set the @var{extra-aliases} group
11694 parameter to the list of additional addresses and it's done. If you'd
11695 rather use a regular expression, set @var{split-regexp}.
11697 All these parameters in a group will be used to create an
11698 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
11699 the @var{value} is a single regular expression that matches
11700 @var{to-list}, @var{to-address}, all of @var{extra-aliases} and all
11701 matches of @var{split-regexp}, and the @var{split} is the name of the
11702 group. @var{restrict}s are also supported: just set the
11703 @var{split-exclude} parameter to a list of regular expressions.
11705 If you can't get the right split to be generated using all these
11706 parameters, or you just need something fancier, you can set the
11707 parameter @var{split-spec} to an @code{nnmail-split-fancy} split. In
11708 this case, all other aforementioned parameters will be ignored by
11709 @code{gnus-group-split}. In particular, @var{split-spec} may be set to
11710 @code{nil}, in which case the group will be ignored by
11711 @code{gnus-group-split}.
11713 @vindex gnus-group-split-default-catch-all-group
11714 @code{gnus-group-split} will do cross-posting on all groups that match,
11715 by defining a single @code{&} fancy split containing one split for each
11716 group. If a message doesn't match any split, it will be stored in the
11717 group named in @code{gnus-group-split-default-catch-all-group}, unless
11718 some group has @var{split-spec} set to @code{catch-all}, in which case
11719 that group is used as the catch-all group. Note that, in this case,
11720 there's no cross-posting, as a @code{|} fancy split encloses the
11721 @code{&} split and the catch-all group.
11723 It's time for an example. Assume the following group parameters have
11728 ((to-address . "bar@@femail.com")
11729 (split-regexp . ".*@@femail\\.com"))
11731 ((to-list . "foo@@nowhere.gov")
11732 (extra-aliases "foo@@localhost" "foo-redist@@home")
11733 (split-exclude "bugs-foo" "rambling-foo")
11734 (admin-address . "foo-request@@nowhere.gov"))
11736 ((split-spec . catch-all))
11739 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
11740 behave as if @code{nnmail-split-fancy} had been selected and variable
11741 @code{nnmail-split-fancy} had been set as follows:
11744 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
11745 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
11746 - "bugs-foo" - "rambling-foo" "mail.foo"))
11750 @findex gnus-group-split-fancy
11751 If you'd rather not use group splitting for all your mail groups, you
11752 may use it for only some of them, by using @code{nnmail-split-fancy}
11756 (: gnus-mlsplt-fancy GROUPS NO-CROSSPOST CATCH-ALL)
11759 @var{groups} may be a regular expression or a list of group names whose
11760 parameters will be scanned to generate the output split.
11761 @var{no-crosspost} can be used to disable cross-posting; in this case, a
11762 single @code{|} split will be output. @var{catch-all} may be the name
11763 of a group to be used as the default catch-all group. If
11764 @var{catch-all} is @code{nil}, or if @var{split-regexp} matches the
11765 empty string in any selected group, no catch-all split will be issued.
11766 Otherwise, if some group has @var{split-spec} set to @code{catch-all},
11767 this group will override the value of the @var{catch-all} argument.
11769 @findex gnus-group-split-setup
11770 Unfortunately, scanning all groups and their parameters can be quite
11771 slow, especially considering that it has to be done for every message.
11772 But don't despair! The function @code{gnus-group-split-setup} can be
11773 used to select @code{gnus-group-split} in a much more efficient way. It
11774 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
11775 @code{nnmail-split-fancy} to the split produced by
11776 @code{gnus-group-split-fancy}. Thus, the group parameters are only
11777 scanned once, no matter how many messages are split.
11779 @findex gnus-group-split-update
11780 However, if you change group parameters, you have to update
11781 @code{nnmail-split-fancy} manually. You can do it by running
11782 @code{gnus-group-split-update}. If you'd rather have it updated
11783 automatically, just tell @code{gnus-group-split-setup} to do it for
11784 you. For example, add to your @file{.gnus}:
11787 (gnus-group-split-setup AUTO-UPDATE CATCH-ALL)
11790 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
11791 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
11792 have to worry about updating @code{nnmail-split-fancy} again. If you
11793 don't omit @var{catch-all} (it's optional),
11794 @code{gnus-group-split-default-catch-all-group} will be set to its
11797 @vindex gnus-group-split-updated-hook
11798 Because you may want to change @code{nnmail-split-fancy} after it is set
11799 by @code{gnus-group-split-update}, this function will run
11800 @code{gnus-group-split-updated-hook} just before finishing.
11802 @node Incorporating Old Mail
11803 @subsection Incorporating Old Mail
11805 Most people have lots of old mail stored in various file formats. If
11806 you have set up Gnus to read mail using one of the spiffy Gnus mail
11807 backends, you'll probably wish to have that old mail incorporated into
11810 Doing so can be quite easy.
11812 To take an example: You're reading mail using @code{nnml}
11813 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
11814 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
11815 file filled with important, but old, mail. You want to move it into
11816 your @code{nnml} groups.
11822 Go to the group buffer.
11825 Type `G f' and give the path to the mbox file when prompted to create an
11826 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
11829 Type `SPACE' to enter the newly created group.
11832 Type `M P b' to process-mark all articles in this group's buffer
11833 (@pxref{Setting Process Marks}).
11836 Type `B r' to respool all the process-marked articles, and answer
11837 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
11840 All the mail messages in the mbox file will now also be spread out over
11841 all your @code{nnml} groups. Try entering them and check whether things
11842 have gone without a glitch. If things look ok, you may consider
11843 deleting the mbox file, but I wouldn't do that unless I was absolutely
11844 sure that all the mail has ended up where it should be.
11846 Respooling is also a handy thing to do if you're switching from one mail
11847 backend to another. Just respool all the mail in the old mail groups
11848 using the new mail backend.
11851 @node Expiring Mail
11852 @subsection Expiring Mail
11853 @cindex article expiry
11855 Traditional mail readers have a tendency to remove mail articles when
11856 you mark them as read, in some way. Gnus takes a fundamentally
11857 different approach to mail reading.
11859 Gnus basically considers mail just to be news that has been received in
11860 a rather peculiar manner. It does not think that it has the power to
11861 actually change the mail, or delete any mail messages. If you enter a
11862 mail group, and mark articles as ``read'', or kill them in some other
11863 fashion, the mail articles will still exist on the system. I repeat:
11864 Gnus will not delete your old, read mail. Unless you ask it to, of
11867 To make Gnus get rid of your unwanted mail, you have to mark the
11868 articles as @dfn{expirable}. This does not mean that the articles will
11869 disappear right away, however. In general, a mail article will be
11870 deleted from your system if, 1) it is marked as expirable, AND 2) it is
11871 more than one week old. If you do not mark an article as expirable, it
11872 will remain on your system until hell freezes over. This bears
11873 repeating one more time, with some spurious capitalizations: IF you do
11874 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
11876 @vindex gnus-auto-expirable-newsgroups
11877 You do not have to mark articles as expirable by hand. Groups that
11878 match the regular expression @code{gnus-auto-expirable-newsgroups} will
11879 have all articles that you read marked as expirable automatically. All
11880 articles marked as expirable have an @samp{E} in the first
11881 column in the summary buffer.
11883 By default, if you have auto expiry switched on, Gnus will mark all the
11884 articles you read as expirable, no matter if they were read or unread
11885 before. To avoid having articles marked as read marked as expirable
11886 automatically, you can put something like the following in your
11889 @vindex gnus-mark-article-hook
11891 (remove-hook 'gnus-mark-article-hook
11892 'gnus-summary-mark-read-and-unread-as-read)
11893 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
11896 Note that making a group auto-expirable doesn't mean that all read
11897 articles are expired---only the articles marked as expirable
11898 will be expired. Also note that using the @kbd{d} command won't make
11899 groups expirable---only semi-automatic marking of articles as read will
11900 mark the articles as expirable in auto-expirable groups.
11902 Let's say you subscribe to a couple of mailing lists, and you want the
11903 articles you have read to disappear after a while:
11906 (setq gnus-auto-expirable-newsgroups
11907 "mail.nonsense-list\\|mail.nice-list")
11910 Another way to have auto-expiry happen is to have the element
11911 @code{auto-expire} in the group parameters of the group.
11913 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
11914 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
11915 don't really mix very well.
11917 @vindex nnmail-expiry-wait
11918 The @code{nnmail-expiry-wait} variable supplies the default time an
11919 expirable article has to live. Gnus starts counting days from when the
11920 message @emph{arrived}, not from when it was sent. The default is seven
11923 Gnus also supplies a function that lets you fine-tune how long articles
11924 are to live, based on what group they are in. Let's say you want to
11925 have one month expiry period in the @samp{mail.private} group, a one day
11926 expiry period in the @samp{mail.junk} group, and a six day expiry period
11929 @vindex nnmail-expiry-wait-function
11931 (setq nnmail-expiry-wait-function
11933 (cond ((string= group "mail.private")
11935 ((string= group "mail.junk")
11937 ((string= group "important")
11943 The group names this function is fed are ``unadorned'' group
11944 names---no @samp{nnml:} prefixes and the like.
11946 The @code{nnmail-expiry-wait} variable and
11947 @code{nnmail-expiry-wait-function} function can either be a number (not
11948 necessarily an integer) or one of the symbols @code{immediate} or
11951 You can also use the @code{expiry-wait} group parameter to selectively
11952 change the expiry period (@pxref{Group Parameters}).
11954 @vindex nnmail-expiry-target
11955 The normal action taken when expiring articles is to delete them.
11956 However, in some circumstances it might make more sense to move them to
11957 other groups instead of deleting them. The variable @code{nnmail-expiry-target}
11958 (and the @code{expiry-target} group parameter) controls this. The
11959 variable supplies a default value for all groups, which can be
11960 overridden for specific groups by the group parameter.
11961 default value is @code{delete}, but this can also be a string (which
11962 should be the name of the group the message should be moved to), or a
11963 function (which will be called in a buffer narrowed to the message in
11964 question, and with the name of the group being moved from as its
11965 parameter) which should return a target -- either a group name or
11968 Here's an example for specifying a group name:
11970 (setq nnmail-expiry-target "nnml:expired")
11974 @vindex nnmail-keep-last-article
11975 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
11976 expire the final article in a mail newsgroup. This is to make life
11977 easier for procmail users.
11979 @vindex gnus-total-expirable-newsgroups
11980 By the way: That line up there, about Gnus never expiring non-expirable
11981 articles, is a lie. If you put @code{total-expire} in the group
11982 parameters, articles will not be marked as expirable, but all read
11983 articles will be put through the expiry process. Use with extreme
11984 caution. Even more dangerous is the
11985 @code{gnus-total-expirable-newsgroups} variable. All groups that match
11986 this regexp will have all read articles put through the expiry process,
11987 which means that @emph{all} old mail articles in the groups in question
11988 will be deleted after a while. Use with extreme caution, and don't come
11989 crying to me when you discover that the regexp you used matched the
11990 wrong group and all your important mail has disappeared. Be a
11991 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
11994 Most people make most of their mail groups total-expirable, though.
11996 @vindex gnus-inhibit-user-auto-expire
11997 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
11998 commands will not mark an article as expirable, even if the group has
11999 auto-expire turned on.
12003 @subsection Washing Mail
12004 @cindex mail washing
12005 @cindex list server brain damage
12006 @cindex incoming mail treatment
12008 Mailers and list servers are notorious for doing all sorts of really,
12009 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
12010 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
12011 end of all lines passing through our server, so let's do that!!!!1!''
12012 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
12013 considered to be self-evident were not discussed. So. Here we are.
12015 Case in point: The German version of Microsoft Exchange adds @samp{AW:
12016 } to the subjects of replies instead of @samp{Re: }. I could pretend to
12017 be shocked and dismayed by this, but I haven't got the energy. It is to
12020 Gnus provides a plethora of functions for washing articles while
12021 displaying them, but it might be nicer to do the filtering before
12022 storing the mail to disc. For that purpose, we have three hooks and
12023 various functions that can be put in these hooks.
12026 @item nnmail-prepare-incoming-hook
12027 @vindex nnmail-prepare-incoming-hook
12028 This hook is called before doing anything with the mail and is meant for
12029 grand, sweeping gestures. It is called in a buffer that contains all
12030 the new, incoming mail. Functions to be used include:
12033 @item nnheader-ms-strip-cr
12034 @findex nnheader-ms-strip-cr
12035 Remove trailing carriage returns from each line. This is default on
12036 Emacs running on MS machines.
12040 @item nnmail-prepare-incoming-header-hook
12041 @vindex nnmail-prepare-incoming-header-hook
12042 This hook is called narrowed to each header. It can be used when
12043 cleaning up the headers. Functions that can be used include:
12046 @item nnmail-remove-leading-whitespace
12047 @findex nnmail-remove-leading-whitespace
12048 Clear leading white space that ``helpful'' listservs have added to the
12049 headers to make them look nice. Aaah.
12051 @item nnmail-remove-list-identifiers
12052 @findex nnmail-remove-list-identifiers
12053 Some list servers add an identifier---for example, @samp{(idm)}---to the
12054 beginning of all @code{Subject} headers. I'm sure that's nice for
12055 people who use stone age mail readers. This function will remove
12056 strings that match the @code{nnmail-list-identifiers} regexp, which can
12057 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
12060 For instance, if you want to remove the @samp{(idm)} and the
12061 @samp{nagnagnag} identifiers:
12064 (setq nnmail-list-identifiers
12065 '("(idm)" "nagnagnag"))
12068 This can also be done non-destructively with
12069 @code{gnus-list-identifiers}, @xref{Article Hiding}.
12071 @item nnmail-remove-tabs
12072 @findex nnmail-remove-tabs
12073 Translate all @samp{TAB} characters into @samp{SPACE} characters.
12075 @item nnmail-fix-eudora-headers
12076 @findex nnmail-fix-eudora-headers
12078 Eudora produces broken @code{References} headers, but OK
12079 @code{In-Reply-To} headers. This function will get rid of the
12080 @code{References} headers.
12084 @item nnmail-prepare-incoming-message-hook
12085 @vindex nnmail-prepare-incoming-message-hook
12086 This hook is called narrowed to each message. Functions to be used
12090 @item article-de-quoted-unreadable
12091 @findex article-de-quoted-unreadable
12092 Decode Quoted Readable encoding.
12099 @subsection Duplicates
12101 @vindex nnmail-treat-duplicates
12102 @vindex nnmail-message-id-cache-length
12103 @vindex nnmail-message-id-cache-file
12104 @cindex duplicate mails
12105 If you are a member of a couple of mailing lists, you will sometimes
12106 receive two copies of the same mail. This can be quite annoying, so
12107 @code{nnmail} checks for and treats any duplicates it might find. To do
12108 this, it keeps a cache of old @code{Message-ID}s---
12109 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
12110 default. The approximate maximum number of @code{Message-ID}s stored
12111 there is controlled by the @code{nnmail-message-id-cache-length}
12112 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
12113 stored.) If all this sounds scary to you, you can set
12114 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
12115 default), and @code{nnmail} won't delete duplicate mails. Instead it
12116 will insert a warning into the head of the mail saying that it thinks
12117 that this is a duplicate of a different message.
12119 This variable can also be a function. If that's the case, the function
12120 will be called from a buffer narrowed to the message in question with
12121 the @code{Message-ID} as a parameter. The function must return either
12122 @code{nil}, @code{warn}, or @code{delete}.
12124 You can turn this feature off completely by setting the variable to
12127 If you want all the duplicate mails to be put into a special
12128 @dfn{duplicates} group, you could do that using the normal mail split
12132 (setq nnmail-split-fancy
12133 '(| ;; Messages duplicates go to a separate group.
12134 ("gnus-warning" "duplication of message" "duplicate")
12135 ;; Message from daemons, postmaster, and the like to another.
12136 (any mail "mail.misc")
12143 (setq nnmail-split-methods
12144 '(("duplicates" "^Gnus-Warning:")
12149 Here's a neat feature: If you know that the recipient reads her mail
12150 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
12151 @code{delete}, you can send her as many insults as you like, just by
12152 using a @code{Message-ID} of a mail that you know that she's already
12153 received. Think of all the fun! She'll never see any of it! Whee!
12156 @node Not Reading Mail
12157 @subsection Not Reading Mail
12159 If you start using any of the mail backends, they have the annoying
12160 habit of assuming that you want to read mail with them. This might not
12161 be unreasonable, but it might not be what you want.
12163 If you set @code{mail-sources} and @code{nnmail-spool-file} to
12164 @code{nil}, none of the backends will ever attempt to read incoming
12165 mail, which should help.
12167 @vindex nnbabyl-get-new-mail
12168 @vindex nnmbox-get-new-mail
12169 @vindex nnml-get-new-mail
12170 @vindex nnmh-get-new-mail
12171 @vindex nnfolder-get-new-mail
12172 This might be too much, if, for instance, you are reading mail quite
12173 happily with @code{nnml} and just want to peek at some old @sc{rmail}
12174 file you have stashed away with @code{nnbabyl}. All backends have
12175 variables called backend-@code{get-new-mail}. If you want to disable
12176 the @code{nnbabyl} mail reading, you edit the virtual server for the
12177 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
12179 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
12180 narrowed to the article to be saved before saving it when reading
12184 @node Choosing a Mail Backend
12185 @subsection Choosing a Mail Backend
12187 Gnus will read the mail spool when you activate a mail group. The mail
12188 file is first copied to your home directory. What happens after that
12189 depends on what format you want to store your mail in.
12191 There are five different mail backends in the standard Gnus, and more
12192 backends are available separately. The mail backend most people use
12193 (because it is the fastest and most flexible) is @code{nnml}
12194 (@pxref{Mail Spool}).
12197 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
12198 * Rmail Babyl:: Emacs programs use the rmail babyl format.
12199 * Mail Spool:: Store your mail in a private spool?
12200 * MH Spool:: An mhspool-like backend.
12201 * Mail Folders:: Having one file for each group.
12202 * Comparing Mail Backends:: An in-depth looks at pros and cons.
12206 @node Unix Mail Box
12207 @subsubsection Unix Mail Box
12209 @cindex unix mail box
12211 @vindex nnmbox-active-file
12212 @vindex nnmbox-mbox-file
12213 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
12214 mail. @code{nnmbox} will add extra headers to each mail article to say
12215 which group it belongs in.
12217 Virtual server settings:
12220 @item nnmbox-mbox-file
12221 @vindex nnmbox-mbox-file
12222 The name of the mail box in the user's home directory.
12224 @item nnmbox-active-file
12225 @vindex nnmbox-active-file
12226 The name of the active file for the mail box.
12228 @item nnmbox-get-new-mail
12229 @vindex nnmbox-get-new-mail
12230 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
12236 @subsubsection Rmail Babyl
12240 @vindex nnbabyl-active-file
12241 @vindex nnbabyl-mbox-file
12242 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
12243 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
12244 mail article to say which group it belongs in.
12246 Virtual server settings:
12249 @item nnbabyl-mbox-file
12250 @vindex nnbabyl-mbox-file
12251 The name of the rmail mbox file.
12253 @item nnbabyl-active-file
12254 @vindex nnbabyl-active-file
12255 The name of the active file for the rmail box.
12257 @item nnbabyl-get-new-mail
12258 @vindex nnbabyl-get-new-mail
12259 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
12264 @subsubsection Mail Spool
12266 @cindex mail @sc{nov} spool
12268 The @dfn{nnml} spool mail format isn't compatible with any other known
12269 format. It should be used with some caution.
12271 @vindex nnml-directory
12272 If you use this backend, Gnus will split all incoming mail into files,
12273 one file for each mail, and put the articles into the corresponding
12274 directories under the directory specified by the @code{nnml-directory}
12275 variable. The default value is @file{~/Mail/}.
12277 You do not have to create any directories beforehand; Gnus will take
12280 If you have a strict limit as to how many files you are allowed to store
12281 in your account, you should not use this backend. As each mail gets its
12282 own file, you might very well occupy thousands of inodes within a few
12283 weeks. If this is no problem for you, and it isn't a problem for you
12284 having your friendly systems administrator walking around, madly,
12285 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
12286 know that this is probably the fastest format to use. You do not have
12287 to trudge through a big mbox file just to read your new mail.
12289 @code{nnml} is probably the slowest backend when it comes to article
12290 splitting. It has to create lots of files, and it also generates
12291 @sc{nov} databases for the incoming mails. This makes it the fastest
12292 backend when it comes to reading mail.
12294 Virtual server settings:
12297 @item nnml-directory
12298 @vindex nnml-directory
12299 All @code{nnml} directories will be placed under this directory.
12301 @item nnml-active-file
12302 @vindex nnml-active-file
12303 The active file for the @code{nnml} server.
12305 @item nnml-newsgroups-file
12306 @vindex nnml-newsgroups-file
12307 The @code{nnml} group descriptions file. @xref{Newsgroups File
12310 @item nnml-get-new-mail
12311 @vindex nnml-get-new-mail
12312 If non-@code{nil}, @code{nnml} will read incoming mail.
12314 @item nnml-nov-is-evil
12315 @vindex nnml-nov-is-evil
12316 If non-@code{nil}, this backend will ignore any @sc{nov} files.
12318 @item nnml-nov-file-name
12319 @vindex nnml-nov-file-name
12320 The name of the @sc{nov} files. The default is @file{.overview}.
12322 @item nnml-prepare-save-mail-hook
12323 @vindex nnml-prepare-save-mail-hook
12324 Hook run narrowed to an article before saving.
12328 @findex nnml-generate-nov-databases
12329 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
12330 you can do a complete update by typing @kbd{M-x
12331 nnml-generate-nov-databases}. This command will trawl through the
12332 entire @code{nnml} hierarchy, looking at each and every article, so it
12333 might take a while to complete. A better interface to this
12334 functionality can be found in the server buffer (@pxref{Server
12339 @subsubsection MH Spool
12341 @cindex mh-e mail spool
12343 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
12344 @sc{nov} databases and it doesn't keep an active file. This makes
12345 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
12346 makes it easier to write procmail scripts for.
12348 Virtual server settings:
12351 @item nnmh-directory
12352 @vindex nnmh-directory
12353 All @code{nnmh} directories will be located under this directory.
12355 @item nnmh-get-new-mail
12356 @vindex nnmh-get-new-mail
12357 If non-@code{nil}, @code{nnmh} will read incoming mail.
12360 @vindex nnmh-be-safe
12361 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
12362 sure that the articles in the folder are actually what Gnus thinks they
12363 are. It will check date stamps and stat everything in sight, so
12364 setting this to @code{t} will mean a serious slow-down. If you never
12365 use anything but Gnus to read the @code{nnmh} articles, you do not have
12366 to set this variable to @code{t}.
12371 @subsubsection Mail Folders
12373 @cindex mbox folders
12374 @cindex mail folders
12376 @code{nnfolder} is a backend for storing each mail group in a separate
12377 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
12378 will add extra headers to keep track of article numbers and arrival
12381 Virtual server settings:
12384 @item nnfolder-directory
12385 @vindex nnfolder-directory
12386 All the @code{nnfolder} mail boxes will be stored under this directory.
12388 @item nnfolder-active-file
12389 @vindex nnfolder-active-file
12390 The name of the active file.
12392 @item nnfolder-newsgroups-file
12393 @vindex nnfolder-newsgroups-file
12394 The name of the group descriptions file. @xref{Newsgroups File Format}.
12396 @item nnfolder-get-new-mail
12397 @vindex nnfolder-get-new-mail
12398 If non-@code{nil}, @code{nnfolder} will read incoming mail.
12400 @item nnfolder-save-buffer-hook
12401 @vindex nnfolder-save-buffer-hook
12402 @cindex backup files
12403 Hook run before saving the folders. Note that Emacs does the normal
12404 backup renaming of files even with the @code{nnfolder} buffers. If you
12405 wish to switch this off, you could say something like the following in
12406 your @file{.emacs} file:
12409 (defun turn-off-backup ()
12410 (set (make-local-variable 'backup-inhibited) t))
12412 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
12415 @item nnfolder-delete-mail-hook
12416 @vindex nnfolder-delete-mail-hook
12417 Hook run in a buffer narrowed to the message that is to be deleted.
12418 This function can be used to copy the message to somewhere else, or to
12419 extract some information from it before removing it.
12424 @findex nnfolder-generate-active-file
12425 @kindex M-x nnfolder-generate-active-file
12426 If you have lots of @code{nnfolder}-like files you'd like to read with
12427 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
12428 command to make @code{nnfolder} aware of all likely files in
12429 @code{nnfolder-directory}. This only works if you use long file names,
12432 @node Comparing Mail Backends
12433 @subsubsection Comparing Mail Backends
12435 First, just for terminology, the @dfn{backend} is the common word for a
12436 low-level access method---a transport, if you will, by which something
12437 is acquired. The sense is that one's mail has to come from somewhere,
12438 and so selection of a suitable backend is required in order to get that
12439 mail within spitting distance of Gnus.
12441 The same concept exists for Usenet itself: Though access to articles is
12442 typically done by @sc{nntp} these days, once upon a midnight dreary, everyone
12443 in the world got at Usenet by running a reader on the machine where the
12444 articles lay (the machine which today we call an @sc{nntp} server), and
12445 access was by the reader stepping into the articles' directory spool
12446 area directly. One can still select between either the @code{nntp} or
12447 @code{nnspool} backends, to select between these methods, if one happens
12448 actually to live on the server (or can see its spool directly, anyway,
12451 The goal in selecting a mail backend is to pick one which
12452 simultaneously represents a suitable way of dealing with the original
12453 format plus leaving mail in a form that is convenient to use in the
12454 future. Here are some high and low points on each:
12459 UNIX systems have historically had a single, very common, and well-
12460 defined format. All messages arrive in a single @dfn{spool file}, and
12461 they are delineated by a line whose regular expression matches
12462 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
12463 to make it clear in this instance that this is not the RFC-specified
12464 @samp{From:} header.) Because Emacs and therefore Gnus emanate
12465 historically from the Unix environment, it is simplest if one does not
12466 mess a great deal with the original mailbox format, so if one chooses
12467 this backend, Gnus' primary activity in getting mail from the real spool
12468 area to Gnus' preferred directory is simply to copy it, with no
12469 (appreciable) format change in the process. It is the ``dumbest'' way
12470 to move mail into availability in the Gnus environment. This makes it
12471 fast to move into place, but slow to parse, when Gnus has to look at
12476 Once upon a time, there was the DEC-10 and DEC-20, running operating
12477 systems called TOPS and related things, and the usual (only?) mail
12478 reading environment was a thing called Babyl. I don't know what format
12479 was used for mail landing on the system, but Babyl had its own internal
12480 format to which mail was converted, primarily involving creating a
12481 spool-file-like entity with a scheme for inserting Babyl-specific
12482 headers and status bits above the top of each message in the file.
12483 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
12484 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
12485 to understand the mail files folks already had in existence. Gnus (and
12486 VM, for that matter) continue to support this format because it's
12487 perceived as having some good qualities in those mailer-specific
12488 headers/status bits stuff. RMAIL itself still exists as well, of
12489 course, and is still maintained by Stallman.
12491 Both of the above forms leave your mail in a single file on your
12492 filesystem, and they must parse that entire file each time you take a
12497 @code{nnml} is the backend which smells the most as though you were
12498 actually operating with an @code{nnspool}-accessed Usenet system. (In
12499 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
12500 lo these years ago.) One's mail is taken from the original spool file,
12501 and is then cut up into individual message files, 1:1. It maintains a
12502 Usenet-style active file (analogous to what one finds in an INN- or
12503 CNews-based news system in (for instance) @file{/var/lib/news/active},
12504 or what is returned via the @samp{NNTP LIST} verb) and also creates
12505 @dfn{overview} files for efficient group entry, as has been defined for
12506 @sc{nntp} servers for some years now. It is slower in mail-splitting,
12507 due to the creation of lots of files, updates to the @code{nnml} active
12508 file, and additions to overview files on a per-message basis, but it is
12509 extremely fast on access because of what amounts to the indexing support
12510 provided by the active file and overviews.
12512 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
12513 resource which defines available places in the filesystem to put new
12514 files. Sysadmins take a dim view of heavy inode occupation within
12515 tight, shared filesystems. But if you live on a personal machine where
12516 the filesystem is your own and space is not at a premium, @code{nnml}
12519 It is also problematic using this backend if you are living in a
12520 FAT16-based Windows world, since much space will be wasted on all these
12525 The Rand MH mail-reading system has been around UNIX systems for a very
12526 long time; it operates by splitting one's spool file of messages into
12527 individual files, but with little or no indexing support -- @code{nnmh}
12528 is considered to be semantically equivalent to ``@code{nnml} without
12529 active file or overviews''. This is arguably the worst choice, because
12530 one gets the slowness of individual file creation married to the
12531 slowness of access parsing when learning what's new in one's groups.
12535 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
12536 method described above) on a per-group basis. That is, @code{nnmbox}
12537 itself puts *all* one's mail in one file; @code{nnfolder} provides a
12538 little bit of optimization to this so that each of one's mail groups has
12539 a Unix mail box file. It's faster than @code{nnmbox} because each group
12540 can be parsed separately, and still provides the simple Unix mail box
12541 format requiring minimal effort in moving the mail around. In addition,
12542 it maintains an ``active'' file making it much faster for Gnus to figure
12543 out how many messages there are in each separate group.
12545 If you have groups that are expected to have a massive amount of
12546 messages, @code{nnfolder} is not the best choice, but if you receive
12547 only a moderate amount of mail, @code{nnfolder} is probably the most
12548 friendly mail backend all over.
12553 @node Browsing the Web
12554 @section Browsing the Web
12556 @cindex browsing the web
12560 Web-based discussion forums are getting more and more popular. On many
12561 subjects, the web-based forums have become the most important forums,
12562 eclipsing the importance of mailing lists and news groups. The reason
12563 is easy to understand---they are friendly to new users; you just point
12564 and click, and there's the discussion. With mailing lists, you have to
12565 go through a cumbersome subscription procedure, and most people don't
12566 even know what a news group is.
12568 The problem with this scenario is that web browsers are not very good at
12569 being newsreaders. They do not keep track of what articles you've read;
12570 they do not allow you to score on subjects you're interested in; they do
12571 not allow off-line browsing; they require you to click around and drive
12572 you mad in the end.
12574 So---if web browsers suck at reading discussion forums, why not use Gnus
12577 Gnus has been getting a bit of a collection of backends for providing
12578 interfaces to these sources.
12581 * Web Searches:: Creating groups from articles that match a string.
12582 * Slashdot:: Reading the Slashdot comments.
12583 * Ultimate:: The Ultimate Bulletin Board systems.
12584 * Web Archive:: Reading mailing list archived on web.
12585 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
12588 All the web sources require Emacs/w3 and the url library to work.
12590 The main caveat with all these web sources is that they probably won't
12591 work for a very long time. Gleaning information from the @sc{html} data
12592 is guesswork at best, and when the layout is altered, the Gnus backend
12593 will fail. If you have reasonably new versions of these backends,
12594 though, you should be ok.
12596 One thing all these Web methods have in common is that the Web sources
12597 are often down, unavailable or just plain too slow to be fun. In those
12598 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
12599 Unplugged}) handle downloading articles, and then you can read them at
12600 leisure from your local disk. No more World Wide Wait for you.
12604 @subsection Web Searches
12608 @cindex InReference
12609 @cindex Usenet searches
12610 @cindex searching the Usenet
12612 It's, like, too neat to search the Usenet for articles that match a
12613 string, but it, like, totally @emph{sucks}, like, totally, to use one of
12614 those, like, Web browsers, and you, like, have to, rilly, like, look at
12615 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
12616 searches without having to use a browser.
12618 The @code{nnweb} backend allows an easy interface to the mighty search
12619 engine. You create an @code{nnweb} group, enter a search pattern, and
12620 then enter the group and read the articles like you would any normal
12621 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
12622 Groups}) will do this in an easy-to-use fashion.
12624 @code{nnweb} groups don't really lend themselves to being solid
12625 groups---they have a very fleeting idea of article numbers. In fact,
12626 each time you enter an @code{nnweb} group (not even changing the search
12627 pattern), you are likely to get the articles ordered in a different
12628 manner. Not even using duplicate suppression (@pxref{Duplicate
12629 Suppression}) will help, since @code{nnweb} doesn't even know the
12630 @code{Message-ID} of the articles before reading them using some search
12631 engines (DejaNews, for instance). The only possible way to keep track
12632 of which articles you've read is by scoring on the @code{Date}
12633 header---mark all articles posted before the last date you read the
12636 If the search engine changes its output substantially, @code{nnweb}
12637 won't be able to parse it and will fail. One could hardly fault the Web
12638 providers if they were to do this---their @emph{raison d'être} is to
12639 make money off of advertisements, not to provide services to the
12640 community. Since @code{nnweb} washes the ads off all the articles, one
12641 might think that the providers might be somewhat miffed. We'll see.
12643 You must have the @code{url} and @code{w3} package installed to be able
12644 to use @code{nnweb}.
12646 Virtual server variables:
12651 What search engine type is being used. The currently supported types
12652 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
12656 @vindex nnweb-search
12657 The search string to feed to the search engine.
12659 @item nnweb-max-hits
12660 @vindex nnweb-max-hits
12661 Advisory maximum number of hits per search to display. The default is
12664 @item nnweb-type-definition
12665 @vindex nnweb-type-definition
12666 Type-to-definition alist. This alist says what @code{nnweb} should do
12667 with the various search engine types. The following elements must be
12672 Function to decode the article and provide something that Gnus
12676 Function to create an article number to message header and URL alist.
12679 Function to send the search string to the search engine.
12682 The address the aforementioned function should send the search string
12686 Format string URL to fetch an article by @code{Message-ID}.
12693 @subsection Slashdot
12697 Slashdot (@file{http://slashdot.org/}) is a popular news site, with
12698 lively discussion following the news articles. @code{nnslashdot} will
12699 let you read this forum in a convenient manner.
12701 The easiest way to read this source is to put something like the
12702 following in your @file{.gnus.el} file:
12705 (setq gnus-secondary-select-methods
12706 '((nnslashdot "")))
12709 This will make Gnus query the @code{nnslashdot} backend for new comments
12710 and groups. The @kbd{F} command will subscribe each new news article as
12711 a new Gnus group, and you can read the comments by entering these
12712 groups. (Note that the default subscription method is to subscribe new
12713 groups as zombies. Other methods are available (@pxref{Subscription
12716 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
12717 command is the most handy tool (@pxref{Foreign Groups}).
12719 When following up to @code{nnslashdot} comments (or posting new
12720 comments), some light @sc{html}izations will be performed. In
12721 particular, text quoted with @samp{> } will be quoted with
12722 @code{blockquote} instead, and signatures will have @code{br} added to
12723 the end of each line. Other than that, you can just write @sc{html}
12724 directly into the message buffer. Note that Slashdot filters out some
12727 The following variables can be altered to change its behavior:
12730 @item nnslashdot-threaded
12731 Whether @code{nnslashdot} should display threaded groups or not. The
12732 default is @code{t}. To be able to display threads, @code{nnslashdot}
12733 has to retrieve absolutely all comments in a group upon entry. If a
12734 threaded display is not required, @code{nnslashdot} will only retrieve
12735 the comments that are actually wanted by the user. Threading is nicer,
12736 but much, much slower than untreaded.
12738 @item nnslashdot-login-name
12739 @vindex nnslashdot-login-name
12740 The login name to use when posting.
12742 @item nnslashdot-password
12743 @vindex nnslashdot-password
12744 The password to use when posting.
12746 @item nnslashdot-directory
12747 @vindex nnslashdot-directory
12748 Where @code{nnslashdot} will store its files. The default value is
12749 @samp{~/News/slashdot/}.
12751 @item nnslashdot-active-url
12752 @vindex nnslashdot-active-url
12753 The @sc{url} format string that will be used to fetch the information on
12754 news articles and comments. The default is
12755 @samp{http://slashdot.org/search.pl?section=&min=%d}.
12757 @item nnslashdot-comments-url
12758 @vindex nnslashdot-comments-url
12759 The @sc{url} format string that will be used to fetch comments. The
12761 @samp{http://slashdot.org/comments.pl?sid=%s&threshold=%d&commentsort=%d&mode=flat&startat=%d}.
12763 @item nnslashdot-article-url
12764 @vindex nnslashdot-article-url
12765 The @sc{url} format string that will be used to fetch the news article. The
12767 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
12769 @item nnslashdot-threshold
12770 @vindex nnslashdot-threshold
12771 The score threshold. The default is -1.
12773 @item nnslashdot-group-number
12774 @vindex nnslashdot-group-number
12775 The number of old groups, in addition to the ten latest, to keep
12776 updated. The default is 0.
12783 @subsection Ultimate
12785 @cindex Ultimate Bulletin Board
12787 The Ultimate Bulletin Board (@file{http://www.ultimatebb.com/}) is
12788 probably the most popular Web bulletin board system used. It has a
12789 quite regular and nice interface, and it's possible to get the
12790 information Gnus needs to keep groups updated.
12792 The easiest way to get started with @code{nnultimate} is to say
12793 something like the following in the group buffer: @kbd{B nnultimate RET
12794 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @sc{url}
12795 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
12796 you're interested in; there's quite a list of them on the Ultimate web
12797 site.) Then subscribe to the groups you're interested in from the
12798 server buffer, and read them from the group buffer.
12800 The following @code{nnultimate} variables can be altered:
12803 @item nnultimate-directory
12804 @vindex nnultimate-directory
12805 The directory where @code{nnultimate} stores its files. The default is
12806 @samp{~/News/ultimate/}.
12811 @subsection Web Archive
12813 @cindex Web Archive
12815 Some mailing lists only have archives on Web servers, such as
12816 @file{http://www.egroups.com/} and
12817 @file{http://www.mail-archive.com/}. It has a quite regular and nice
12818 interface, and it's possible to get the information Gnus needs to keep
12821 The easiest way to get started with @code{nnwarchive} is to say
12822 something like the following in the group buffer: @kbd{M-x
12823 gnus-group-make-warchive-group RET an_egroup RET egroups RET
12824 www.egroups.com RET your@@email.address RET}. (Substitute the
12825 @sc{an_egroup} with the mailing list you subscribed, the
12826 @sc{your@@email.address} with your email address.), or to browse the
12827 backend by @kbd{B nnwarchive RET mail-archive RET}.
12829 The following @code{nnwarchive} variables can be altered:
12832 @item nnwarchive-directory
12833 @vindex nnwarchive-directory
12834 The directory where @code{nnwarchive} stores its files. The default is
12835 @samp{~/News/warchive/}.
12837 @item nnwarchive-login
12838 @vindex nnwarchive-login
12839 The account name on the web server.
12841 @item nnwarchive-passwd
12842 @vindex nnwarchive-passwd
12843 The password for your account on the web server.
12847 @node Customizing w3
12848 @subsection Customizing w3
12854 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
12855 pages. Emacs/w3 is documented in its own manual, but there are some
12856 things that may be more relevant for Gnus users.
12858 For instance, a common question is how to make Emacs/w3 follow links
12859 using the @code{browse-url} functions (which will call some external web
12860 browser like Netscape). Here's one way:
12863 (eval-after-load "w3"
12865 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
12866 (defun w3-fetch (&optional url target)
12867 (interactive (list (w3-read-url-with-default)))
12868 (if (eq major-mode 'gnus-article-mode)
12870 (w3-fetch-orig url target)))))
12873 Put that in your @file{.emacs} file, and hitting links in w3-rendered
12874 @sc{html} in the Gnus article buffers will use @code{browse-url} to
12878 @node Other Sources
12879 @section Other Sources
12881 Gnus can do more than just read news or mail. The methods described
12882 below allow Gnus to view directories and files as if they were
12886 * Directory Groups:: You can read a directory as if it was a newsgroup.
12887 * Anything Groups:: Dired? Who needs dired?
12888 * Document Groups:: Single files can be the basis of a group.
12889 * SOUP:: Reading @sc{soup} packets ``offline''.
12890 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
12891 * IMAP:: Using Gnus as a @sc{imap} client.
12895 @node Directory Groups
12896 @subsection Directory Groups
12898 @cindex directory groups
12900 If you have a directory that has lots of articles in separate files in
12901 it, you might treat it as a newsgroup. The files have to have numerical
12904 This might be an opportune moment to mention @code{ange-ftp} (and its
12905 successor @code{efs}), that most wonderful of all wonderful Emacs
12906 packages. When I wrote @code{nndir}, I didn't think much about it---a
12907 backend to read directories. Big deal.
12909 @code{ange-ftp} changes that picture dramatically. For instance, if you
12910 enter the @code{ange-ftp} file name
12911 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
12912 @code{ange-ftp} or @code{efs} will actually allow you to read this
12913 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
12915 @code{nndir} will use @sc{nov} files if they are present.
12917 @code{nndir} is a ``read-only'' backend---you can't delete or expire
12918 articles with this method. You can use @code{nnmh} or @code{nnml} for
12919 whatever you use @code{nndir} for, so you could switch to any of those
12920 methods if you feel the need to have a non-read-only @code{nndir}.
12923 @node Anything Groups
12924 @subsection Anything Groups
12927 From the @code{nndir} backend (which reads a single spool-like
12928 directory), it's just a hop and a skip to @code{nneething}, which
12929 pretends that any arbitrary directory is a newsgroup. Strange, but
12932 When @code{nneething} is presented with a directory, it will scan this
12933 directory and assign article numbers to each file. When you enter such
12934 a group, @code{nneething} must create ``headers'' that Gnus can use.
12935 After all, Gnus is a newsreader, in case you're forgetting.
12936 @code{nneething} does this in a two-step process. First, it snoops each
12937 file in question. If the file looks like an article (i.e., the first
12938 few lines look like headers), it will use this as the head. If this is
12939 just some arbitrary file without a head (e.g. a C source file),
12940 @code{nneething} will cobble up a header out of thin air. It will use
12941 file ownership, name and date and do whatever it can with these
12944 All this should happen automatically for you, and you will be presented
12945 with something that looks very much like a newsgroup. Totally like a
12946 newsgroup, to be precise. If you select an article, it will be displayed
12947 in the article buffer, just as usual.
12949 If you select a line that represents a directory, Gnus will pop you into
12950 a new summary buffer for this @code{nneething} group. And so on. You can
12951 traverse the entire disk this way, if you feel like, but remember that
12952 Gnus is not dired, really, and does not intend to be, either.
12954 There are two overall modes to this action---ephemeral or solid. When
12955 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
12956 will not store information on what files you have read, and what files
12957 are new, and so on. If you create a solid @code{nneething} group the
12958 normal way with @kbd{G m}, Gnus will store a mapping table between
12959 article numbers and file names, and you can treat this group like any
12960 other groups. When you activate a solid @code{nneething} group, you will
12961 be told how many unread articles it contains, etc., etc.
12966 @item nneething-map-file-directory
12967 @vindex nneething-map-file-directory
12968 All the mapping files for solid @code{nneething} groups will be stored
12969 in this directory, which defaults to @file{~/.nneething/}.
12971 @item nneething-exclude-files
12972 @vindex nneething-exclude-files
12973 All files that match this regexp will be ignored. Nice to use to exclude
12974 auto-save files and the like, which is what it does by default.
12976 @item nneething-include-files
12977 @vindex nneething-include-files
12978 Regexp saying what files to include in the group. If this variable is
12979 non-@code{nil}, only files matching this regexp will be included.
12981 @item nneething-map-file
12982 @vindex nneething-map-file
12983 Name of the map files.
12987 @node Document Groups
12988 @subsection Document Groups
12990 @cindex documentation group
12993 @code{nndoc} is a cute little thing that will let you read a single file
12994 as a newsgroup. Several files types are supported:
13001 The babyl (rmail) mail box.
13006 The standard Unix mbox file.
13008 @cindex MMDF mail box
13010 The MMDF mail box format.
13013 Several news articles appended into a file.
13016 @cindex rnews batch files
13017 The rnews batch transport format.
13018 @cindex forwarded messages
13021 Forwarded articles.
13024 Netscape mail boxes.
13027 MIME multipart messages.
13029 @item standard-digest
13030 The standard (RFC 1153) digest format.
13033 Non-standard digest format---matches most things, but does it badly.
13036 You can also use the special ``file type'' @code{guess}, which means
13037 that @code{nndoc} will try to guess what file type it is looking at.
13038 @code{digest} means that @code{nndoc} should guess what digest type the
13041 @code{nndoc} will not try to change the file or insert any extra headers into
13042 it---it will simply, like, let you use the file as the basis for a
13043 group. And that's it.
13045 If you have some old archived articles that you want to insert into your
13046 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
13047 that. Say you have an old @file{RMAIL} file with mail that you now want
13048 to split into your new @code{nnml} groups. You look at that file using
13049 @code{nndoc} (using the @kbd{G f} command in the group buffer
13050 (@pxref{Foreign Groups})), set the process mark on all the articles in
13051 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
13052 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
13053 file is now also stored in lots of @code{nnml} directories, and you can
13054 delete that pesky @file{RMAIL} file. If you have the guts!
13056 Virtual server variables:
13059 @item nndoc-article-type
13060 @vindex nndoc-article-type
13061 This should be one of @code{mbox}, @code{babyl}, @code{digest},
13062 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
13063 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
13064 @code{slack-digest}, @code{clari-briefs}, @code{nsmail} or @code{guess}.
13066 @item nndoc-post-type
13067 @vindex nndoc-post-type
13068 This variable says whether Gnus is to consider the group a news group or
13069 a mail group. There are two valid values: @code{mail} (the default)
13074 * Document Server Internals:: How to add your own document types.
13078 @node Document Server Internals
13079 @subsubsection Document Server Internals
13081 Adding new document types to be recognized by @code{nndoc} isn't
13082 difficult. You just have to whip up a definition of what the document
13083 looks like, write a predicate function to recognize that document type,
13084 and then hook into @code{nndoc}.
13086 First, here's an example document type definition:
13090 (article-begin . "^\^A\^A\^A\^A\n")
13091 (body-end . "^\^A\^A\^A\^A\n"))
13094 The definition is simply a unique @dfn{name} followed by a series of
13095 regexp pseudo-variable settings. Below are the possible
13096 variables---don't be daunted by the number of variables; most document
13097 types can be defined with very few settings:
13100 @item first-article
13101 If present, @code{nndoc} will skip past all text until it finds
13102 something that match this regexp. All text before this will be
13105 @item article-begin
13106 This setting has to be present in all document type definitions. It
13107 says what the beginning of each article looks like.
13109 @item head-begin-function
13110 If present, this should be a function that moves point to the head of
13113 @item nndoc-head-begin
13114 If present, this should be a regexp that matches the head of the
13117 @item nndoc-head-end
13118 This should match the end of the head of the article. It defaults to
13119 @samp{^$}---the empty line.
13121 @item body-begin-function
13122 If present, this function should move point to the beginning of the body
13126 This should match the beginning of the body of the article. It defaults
13129 @item body-end-function
13130 If present, this function should move point to the end of the body of
13134 If present, this should match the end of the body of the article.
13137 If present, this should match the end of the file. All text after this
13138 regexp will be totally ignored.
13142 So, using these variables @code{nndoc} is able to dissect a document
13143 file into a series of articles, each with a head and a body. However, a
13144 few more variables are needed since not all document types are all that
13145 news-like---variables needed to transform the head or the body into
13146 something that's palatable for Gnus:
13149 @item prepare-body-function
13150 If present, this function will be called when requesting an article. It
13151 will be called with point at the start of the body, and is useful if the
13152 document has encoded some parts of its contents.
13154 @item article-transform-function
13155 If present, this function is called when requesting an article. It's
13156 meant to be used for more wide-ranging transformation of both head and
13157 body of the article.
13159 @item generate-head-function
13160 If present, this function is called to generate a head that Gnus can
13161 understand. It is called with the article number as a parameter, and is
13162 expected to generate a nice head for the article in question. It is
13163 called when requesting the headers of all articles.
13167 Let's look at the most complicated example I can come up with---standard
13172 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
13173 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
13174 (prepare-body-function . nndoc-unquote-dashes)
13175 (body-end-function . nndoc-digest-body-end)
13176 (head-end . "^ ?$")
13177 (body-begin . "^ ?\n")
13178 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
13179 (subtype digest guess))
13182 We see that all text before a 70-width line of dashes is ignored; all
13183 text after a line that starts with that @samp{^End of} is also ignored;
13184 each article begins with a 30-width line of dashes; the line separating
13185 the head from the body may contain a single space; and that the body is
13186 run through @code{nndoc-unquote-dashes} before being delivered.
13188 To hook your own document definition into @code{nndoc}, use the
13189 @code{nndoc-add-type} function. It takes two parameters---the first is
13190 the definition itself and the second (optional) parameter says where in
13191 the document type definition alist to put this definition. The alist is
13192 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
13193 is of @code{mmdf} type, and so on. These type predicates should return
13194 @code{nil} if the document is not of the correct type; @code{t} if it is
13195 of the correct type; and a number if the document might be of the
13196 correct type. A high number means high probability; a low number means
13197 low probability with @samp{0} being the lowest valid number.
13205 In the PC world people often talk about ``offline'' newsreaders. These
13206 are thingies that are combined reader/news transport monstrosities.
13207 With built-in modem programs. Yecchh!
13209 Of course, us Unix Weenie types of human beans use things like
13210 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
13211 transport things like Ghod intended. And then we just use normal
13214 However, it can sometimes be convenient to do something that's a bit
13215 easier on the brain if you have a very slow modem, and you're not really
13216 that interested in doing things properly.
13218 A file format called @sc{soup} has been developed for transporting news
13219 and mail from servers to home machines and back again. It can be a bit
13222 First some terminology:
13227 This is the machine that is connected to the outside world and where you
13228 get news and/or mail from.
13231 This is the machine that you want to do the actual reading and responding
13232 on. It is typically not connected to the rest of the world in any way.
13235 Something that contains messages and/or commands. There are two kinds
13239 @item message packets
13240 These are packets made at the server, and typically contain lots of
13241 messages for you to read. These are called @file{SoupoutX.tgz} by
13242 default, where @var{x} is a number.
13244 @item response packets
13245 These are packets made at the home machine, and typically contains
13246 replies that you've written. These are called @file{SoupinX.tgz} by
13247 default, where @var{x} is a number.
13257 You log in on the server and create a @sc{soup} packet. You can either
13258 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
13259 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
13260 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
13263 You transfer the packet home. Rail, boat, car or modem will do fine.
13266 You put the packet in your home directory.
13269 You fire up Gnus on your home machine using the @code{nnsoup} backend as
13270 the native or secondary server.
13273 You read articles and mail and answer and followup to the things you
13274 want (@pxref{SOUP Replies}).
13277 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
13281 You transfer this packet to the server.
13284 You use Gnus to mail this packet out with the @kbd{G s s} command.
13287 You then repeat until you die.
13291 So you basically have a bipartite system---you use @code{nnsoup} for
13292 reading and Gnus for packing/sending these @sc{soup} packets.
13295 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
13296 * SOUP Groups:: A backend for reading @sc{soup} packets.
13297 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
13301 @node SOUP Commands
13302 @subsubsection SOUP Commands
13304 These are commands for creating and manipulating @sc{soup} packets.
13308 @kindex G s b (Group)
13309 @findex gnus-group-brew-soup
13310 Pack all unread articles in the current group
13311 (@code{gnus-group-brew-soup}). This command understands the
13312 process/prefix convention.
13315 @kindex G s w (Group)
13316 @findex gnus-soup-save-areas
13317 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
13320 @kindex G s s (Group)
13321 @findex gnus-soup-send-replies
13322 Send all replies from the replies packet
13323 (@code{gnus-soup-send-replies}).
13326 @kindex G s p (Group)
13327 @findex gnus-soup-pack-packet
13328 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
13331 @kindex G s r (Group)
13332 @findex nnsoup-pack-replies
13333 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
13336 @kindex O s (Summary)
13337 @findex gnus-soup-add-article
13338 This summary-mode command adds the current article to a @sc{soup} packet
13339 (@code{gnus-soup-add-article}). It understands the process/prefix
13340 convention (@pxref{Process/Prefix}).
13345 There are a few variables to customize where Gnus will put all these
13350 @item gnus-soup-directory
13351 @vindex gnus-soup-directory
13352 Directory where Gnus will save intermediate files while composing
13353 @sc{soup} packets. The default is @file{~/SoupBrew/}.
13355 @item gnus-soup-replies-directory
13356 @vindex gnus-soup-replies-directory
13357 This is what Gnus will use as a temporary directory while sending our
13358 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
13360 @item gnus-soup-prefix-file
13361 @vindex gnus-soup-prefix-file
13362 Name of the file where Gnus stores the last used prefix. The default is
13363 @samp{gnus-prefix}.
13365 @item gnus-soup-packer
13366 @vindex gnus-soup-packer
13367 A format string command for packing a @sc{soup} packet. The default is
13368 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
13370 @item gnus-soup-unpacker
13371 @vindex gnus-soup-unpacker
13372 Format string command for unpacking a @sc{soup} packet. The default is
13373 @samp{gunzip -c %s | tar xvf -}.
13375 @item gnus-soup-packet-directory
13376 @vindex gnus-soup-packet-directory
13377 Where Gnus will look for reply packets. The default is @file{~/}.
13379 @item gnus-soup-packet-regexp
13380 @vindex gnus-soup-packet-regexp
13381 Regular expression matching @sc{soup} reply packets in
13382 @code{gnus-soup-packet-directory}.
13388 @subsubsection @sc{soup} Groups
13391 @code{nnsoup} is the backend for reading @sc{soup} packets. It will
13392 read incoming packets, unpack them, and put them in a directory where
13393 you can read them at leisure.
13395 These are the variables you can use to customize its behavior:
13399 @item nnsoup-tmp-directory
13400 @vindex nnsoup-tmp-directory
13401 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
13402 directory. (@file{/tmp/} by default.)
13404 @item nnsoup-directory
13405 @vindex nnsoup-directory
13406 @code{nnsoup} then moves each message and index file to this directory.
13407 The default is @file{~/SOUP/}.
13409 @item nnsoup-replies-directory
13410 @vindex nnsoup-replies-directory
13411 All replies will be stored in this directory before being packed into a
13412 reply packet. The default is @file{~/SOUP/replies/"}.
13414 @item nnsoup-replies-format-type
13415 @vindex nnsoup-replies-format-type
13416 The @sc{soup} format of the replies packets. The default is @samp{?n}
13417 (rnews), and I don't think you should touch that variable. I probably
13418 shouldn't even have documented it. Drats! Too late!
13420 @item nnsoup-replies-index-type
13421 @vindex nnsoup-replies-index-type
13422 The index type of the replies packet. The default is @samp{?n}, which
13423 means ``none''. Don't fiddle with this one either!
13425 @item nnsoup-active-file
13426 @vindex nnsoup-active-file
13427 Where @code{nnsoup} stores lots of information. This is not an ``active
13428 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
13429 this file or mess it up in any way, you're dead. The default is
13430 @file{~/SOUP/active}.
13432 @item nnsoup-packer
13433 @vindex nnsoup-packer
13434 Format string command for packing a reply @sc{soup} packet. The default
13435 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
13437 @item nnsoup-unpacker
13438 @vindex nnsoup-unpacker
13439 Format string command for unpacking incoming @sc{soup} packets. The
13440 default is @samp{gunzip -c %s | tar xvf -}.
13442 @item nnsoup-packet-directory
13443 @vindex nnsoup-packet-directory
13444 Where @code{nnsoup} will look for incoming packets. The default is
13447 @item nnsoup-packet-regexp
13448 @vindex nnsoup-packet-regexp
13449 Regular expression matching incoming @sc{soup} packets. The default is
13452 @item nnsoup-always-save
13453 @vindex nnsoup-always-save
13454 If non-@code{nil}, save the replies buffer after each posted message.
13460 @subsubsection SOUP Replies
13462 Just using @code{nnsoup} won't mean that your postings and mailings end
13463 up in @sc{soup} reply packets automagically. You have to work a bit
13464 more for that to happen.
13466 @findex nnsoup-set-variables
13467 The @code{nnsoup-set-variables} command will set the appropriate
13468 variables to ensure that all your followups and replies end up in the
13471 In specific, this is what it does:
13474 (setq message-send-news-function 'nnsoup-request-post)
13475 (setq message-send-mail-function 'nnsoup-request-mail)
13478 And that's it, really. If you only want news to go into the @sc{soup}
13479 system you just use the first line. If you only want mail to be
13480 @sc{soup}ed you use the second.
13483 @node Mail-To-News Gateways
13484 @subsection Mail-To-News Gateways
13485 @cindex mail-to-news gateways
13488 If your local @code{nntp} server doesn't allow posting, for some reason
13489 or other, you can post using one of the numerous mail-to-news gateways.
13490 The @code{nngateway} backend provides the interface.
13492 Note that you can't read anything from this backend---it can only be
13498 @item nngateway-address
13499 @vindex nngateway-address
13500 This is the address of the mail-to-news gateway.
13502 @item nngateway-header-transformation
13503 @vindex nngateway-header-transformation
13504 News headers often have to be transformed in some odd way or other
13505 for the mail-to-news gateway to accept it. This variable says what
13506 transformation should be called, and defaults to
13507 @code{nngateway-simple-header-transformation}. The function is called
13508 narrowed to the headers to be transformed and with one parameter---the
13511 This default function just inserts a new @code{To} header based on the
13512 @code{Newsgroups} header and the gateway address.
13513 For instance, an article with this @code{Newsgroups} header:
13516 Newsgroups: alt.religion.emacs
13519 will get this @code{From} header inserted:
13522 To: alt-religion-emacs@@GATEWAY
13525 The following pre-defined functions exist:
13527 @findex nngateway-simple-header-transformation
13530 @item nngateway-simple-header-transformation
13531 Creates a @code{To} header that looks like
13532 @var{newsgroup}@@@code{nngateway-address}.
13534 @findex nngateway-mail2news-header-transformation
13536 @item nngateway-mail2news-header-transformation
13537 Creates a @code{To} header that looks like
13538 @code{nngateway-address}.
13543 (setq gnus-post-method
13544 '(nngateway "mail2news@@replay.com"
13545 (nngateway-header-transformation
13546 nngateway-mail2news-header-transformation)))
13554 So, to use this, simply say something like:
13557 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
13563 @subsection @sc{imap}
13567 @sc{imap} is a network protocol for reading mail (or news, or ...),
13568 think of it as a modernized @sc{nntp}. Connecting to a @sc{imap} server
13569 is much similar to connecting to a news server, you just specify the
13570 network address of the server.
13572 The following variables can be used to create a virtual @code{nnimap}
13577 @item nnimap-address
13578 @vindex nnimap-address
13580 The address of the remote @sc{imap} server. Defaults to the virtual
13581 server name if not specified.
13583 @item nnimap-server-port
13584 @vindex nnimap-server-port
13585 Port on server to contact. Defaults to port 143, or 993 for SSL.
13587 Note that this should be a integer, example server specification:
13590 (nnimap "mail.server.com"
13591 (nnimap-server-port 4711))
13594 @item nnimap-list-pattern
13595 @vindex nnimap-list-pattern
13596 String or list of strings of mailboxes to limit available groups to.
13597 This is used when the server has very many mailboxes and you're only
13598 interested in a few -- some servers export your home directory via
13599 @sc{imap}, you'll probably want to limit the mailboxes to those in
13600 @file{~/Mail/*} then.
13602 The string can also be a cons of REFERENCE and the string as above, what
13603 REFERENCE is used for is server specific, but on the University of
13604 Washington server it's a directory that will be concatenated with the
13607 Example server specification:
13610 (nnimap "mail.server.com"
13611 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
13612 ("~friend/Mail/" . "list/*"))))
13615 @item nnimap-stream
13616 @vindex nnimap-stream
13617 The type of stream used to connect to your server. By default, nnimap
13618 will detect and automatically use all of the below, with the exception
13619 of SSL. (SSL is being replaced by STARTTLS, which can be automatically
13620 detected, but it's not widely deployed yet).
13622 Example server specification:
13625 (nnimap "mail.server.com"
13626 (nnimap-stream ssl))
13629 Please note that the value of @code{nnimap-stream} is a symbol!
13633 @dfn{gssapi:} Connect with GSSAPI (usually kerberos 5). Require the
13634 @samp{imtest} program.
13636 @dfn{kerberos4:} Connect with kerberos 4. Require the @samp{imtest} program.
13638 @dfn{starttls:} Connect via the STARTTLS extension (similar to
13639 SSL). Require the external library @samp{starttls.el} and program
13642 @dfn{ssl:} Connect through SSL. Require OpenSSL (the
13643 program @samp{openssl}) or SSLeay (@samp{s_client}).
13645 @dfn{shell:} Use a shell command to start IMAP connection.
13647 @dfn{network:} Plain, TCP/IP network connection.
13650 @vindex imap-kerberos4-program
13651 The @samp{imtest} program is shipped with Cyrus IMAPD, nnimap support
13652 both @samp{imtest} version 1.5.x and version 1.6.x. The variable
13653 @code{imap-kerberos4-program} contain parameters to pass to the imtest
13656 @vindex imap-ssl-program
13657 For SSL connections, the OpenSSL program is available from
13658 @file{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
13659 and nnimap support it too - altough the most recent versions of
13660 SSLeay, 0.9.x, are known to have serious bugs making it
13661 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
13662 work. The variable @code{imap-ssl-program} contain parameters to pass
13665 @vindex imap-shell-program
13666 @vindex imap-shell-host
13667 For IMAP connections using the @code{shell} stream, the variable
13668 @code{imap-shell-program} specify what program to call.
13670 @item nnimap-authenticator
13671 @vindex nnimap-authenticator
13673 The authenticator used to connect to the server. By default, nnimap
13674 will use the most secure authenticator your server is capable of.
13676 Example server specification:
13679 (nnimap "mail.server.com"
13680 (nnimap-authenticator anonymous))
13683 Please note that the value of @code{nnimap-authenticator} is a symbol!
13687 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Require
13688 external program @code{imtest}.
13690 @dfn{kerberos4:} Kerberos authentication. Require external program
13693 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Require
13694 external library @code{digest-md5.el}.
13696 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
13698 @dfn{login:} Plain-text username/password via LOGIN.
13700 @dfn{anonymous:} Login as `anonymous', supplying your emailadress as password.
13703 @item nnimap-expunge-on-close
13705 @vindex nnimap-expunge-on-close
13706 Unlike Parmenides the @sc{imap} designers has decided that things that
13707 doesn't exist actually does exist. More specifically, @sc{imap} has
13708 this concept of marking articles @code{Deleted} which doesn't actually
13709 delete them, and this (marking them @code{Deleted}, that is) is what
13710 nnimap does when you delete a article in Gnus (with @kbd{G DEL} or
13713 Since the articles aren't really removed when we mark them with the
13714 @code{Deleted} flag we'll need a way to actually delete them. Feel like
13715 running in circles yet?
13717 Traditionally, nnimap has removed all articles marked as @code{Deleted}
13718 when closing a mailbox but this is now configurable by this server
13721 The possible options are:
13726 The default behaviour, delete all articles marked as "Deleted" when
13729 Never actually delete articles. Currently there is no way of showing
13730 the articles marked for deletion in nnimap, but other @sc{imap} clients
13731 may allow you to do this. If you ever want to run the EXPUNGE command
13732 manually, @xref{Expunging mailboxes}.
13734 When closing mailboxes, nnimap will ask if you wish to expunge deleted
13739 @item nnimap-authinfo-file
13740 @vindex nnimap-authinfo-file
13742 A file containing credentials used to log in on servers. The format
13743 is (almost) the same as the @code{ftp} @file{~/.netrc} file. See
13744 `nntp-authinfo-file' for exact syntax.
13746 A file containing credentials used to log in on servers. The format is
13747 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
13748 variable @code{nntp-authinfo-file} for exact syntax; also see
13754 * Splitting in IMAP:: Splitting mail with nnimap.
13755 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
13756 * Expunging mailboxes:: Equivalent of a "compress mailbox" button.
13761 @node Splitting in IMAP
13762 @subsubsection Splitting in @sc{imap}
13763 @cindex splitting imap mail
13765 Splitting is something Gnus users has loved and used for years, and now
13766 the rest of the world is catching up. Yeah, dream on, not many
13767 @sc{imap} server has server side splitting and those that have splitting
13768 seem to use some non-standard protocol. This means that @sc{imap}
13769 support for Gnus has to do it's own splitting.
13773 Here are the variables of interest:
13777 @item nnimap-split-crosspost
13778 @cindex splitting, crosspost
13780 @vindex nnimap-split-crosspost
13782 If non-nil, do crossposting if several split methods match the mail. If
13783 nil, the first match in @code{nnimap-split-rule} found will be used.
13785 Nnmail equivalent: @code{nnmail-crosspost}.
13787 @item nnimap-split-inbox
13788 @cindex splitting, inbox
13790 @vindex nnimap-split-inbox
13792 A string or a list of strings that gives the name(s) of @sc{imap}
13793 mailboxes to split from. Defaults to nil, which means that splitting is
13797 (setq nnimap-split-inbox
13798 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
13801 No nnmail equivalent.
13803 @item nnimap-split-rule
13804 @cindex Splitting, rules
13805 @vindex nnimap-split-rule
13807 New mail found in @code{nnimap-split-inbox} will be split according to
13810 This variable contains a list of lists, where the first element in the
13811 sublist gives the name of the @sc{imap} mailbox to move articles
13812 matching the regexp in the second element in the sublist. Got that?
13813 Neither did I, we need examples.
13816 (setq nnimap-split-rule
13817 '(("INBOX.nnimap" "^Sender: owner-nnimap@@vic20.globalcom.se")
13818 ("INBOX.junk" "^Subject:.*MAKE MONEY")
13819 ("INBOX.private" "")))
13822 This will put all articles from the nnimap mailing list into mailbox
13823 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
13824 into INBOX.spam and everything else in INBOX.private.
13826 The first string may contain `\\1' forms, like the ones used by
13827 replace-match to insert sub-expressions from the matched text. For
13831 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
13834 The second element can also be a function. In that case, it will be
13835 called with the first element of the rule as the argument, in a buffer
13836 containing the headers of the article. It should return a non-nil value
13837 if it thinks that the mail belongs in that group.
13839 Nnmail users might recollect that the last regexp had to be empty to
13840 match all articles (like in the example above). This is not required in
13841 nnimap. Articles not matching any of the regexps will not be moved out
13842 of your inbox. (This might might affect performance if you keep lots of
13843 unread articles in your inbox, since the splitting code would go over
13844 them every time you fetch new mail.)
13846 These rules are processed from the beginning of the alist toward the
13847 end. The first rule to make a match will "win", unless you have
13848 crossposting enabled. In that case, all matching rules will "win".
13850 This variable can also have a function as its value, the function will
13851 be called with the headers narrowed and should return a group where it
13852 thinks the article should be splitted to. See @code{nnimap-split-fancy}.
13854 The splitting code tries to create mailboxes if it need too.
13856 To allow for different split rules on different virtual servers, and
13857 even different split rules in different inboxes on the same server,
13858 the syntax of this variable have been extended along the lines of:
13861 (setq nnimap-split-rule
13862 '(("my1server" (".*" (("ding" "ding@@gnus.org")
13863 ("junk" "From:.*Simon")))
13864 ("my2server" ("INBOX" nnimap-split-fancy))
13865 ("my[34]server" (".*" (("private" "To:.*Simon")
13866 ("junk" my-junk-func)))))
13869 The virtual server name is in fact a regexp, so that the same rules
13870 may apply to several servers. In the example, the servers
13871 @code{my3server} and @code{my4server} both use the same rules.
13872 Similarly, the inbox string is also a regexp. The actual splitting
13873 rules are as before, either a function, or a list with group/regexp or
13874 group/function elements.
13876 Nnmail equivalent: @code{nnmail-split-methods}.
13878 @item nnimap-split-predicate
13880 @vindex nnimap-split-predicate
13882 Mail matching this predicate in @code{nnimap-split-inbox} will be
13883 splitted, it is a string and the default is @samp{UNSEEN UNDELETED}.
13885 This might be useful if you use another @sc{imap} client to read mail in
13886 your inbox but would like Gnus to split all articles in the inbox
13887 regardless of readedness. Then you might change this to
13890 @item nnimap-split-fancy
13891 @cindex splitting, fancy
13892 @findex nnimap-split-fancy
13893 @vindex nnimap-split-fancy
13895 It's possible to set @code{nnimap-split-rule} to
13896 @code{nnmail-split-fancy} if you want to use fancy
13897 splitting. @xref{Fancy Mail Splitting}.
13899 However, to be able to have different fancy split rules for nnmail and
13900 nnimap backends you can set @code{nnimap-split-rule} to
13901 @code{nnimap-split-fancy} and define the nnimap specific fancy split
13902 rule in @code{nnimap-split-fancy}.
13907 (setq nnimap-split-rule 'nnimap-split-fancy
13908 nnimap-split-fancy ...)
13911 Nnmail equivalent: @code{nnmail-split-fancy}.
13915 @node Editing IMAP ACLs
13916 @subsubsection Editing @sc{imap} ACLs
13917 @cindex editing imap acls
13918 @cindex Access Control Lists
13919 @cindex Editing @sc{imap} ACLs
13921 @findex gnus-group-nnimap-edit-acl
13923 ACL stands for Access Control List. ACLs are used in @sc{imap} for
13924 limiting (or enabling) other users access to your mail boxes. Not all
13925 @sc{imap} servers support this, this function will give an error if it
13928 To edit a ACL for a mailbox, type @kbd{G l}
13929 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with a ACL
13930 editing window with detailed instructions.
13932 Some possible uses:
13936 Giving "anyone" the "lrs" rights (lookup, read, keep seen/unseen flags)
13937 on your mailing list mailboxes enables other users on the same server to
13938 follow the list without subscribing to it.
13940 At least with the Cyrus server, you are required to give the user
13941 "anyone" posting ("p") capabilities to have "plussing" work (that is,
13942 mail sent to user+mailbox@@domain ending up in the @sc{imap} mailbox
13946 @node Expunging mailboxes
13947 @subsubsection Expunging mailboxes
13951 @cindex Manual expunging
13953 @findex gnus-group-nnimap-expunge
13955 If you're using the @code{never} setting of @code{nnimap-expunge-close},
13956 you may want the option of expunging all deleted articles in a mailbox
13957 manually. This is exactly what @kbd{G x} does.
13959 Currently there is no way of showing deleted articles, you can just
13964 @node Combined Groups
13965 @section Combined Groups
13967 Gnus allows combining a mixture of all the other group types into bigger
13971 * Virtual Groups:: Combining articles from many groups.
13972 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
13976 @node Virtual Groups
13977 @subsection Virtual Groups
13979 @cindex virtual groups
13980 @cindex merging groups
13982 An @dfn{nnvirtual group} is really nothing more than a collection of
13985 For instance, if you are tired of reading many small groups, you can
13986 put them all in one big group, and then grow tired of reading one
13987 big, unwieldy group. The joys of computing!
13989 You specify @code{nnvirtual} as the method. The address should be a
13990 regexp to match component groups.
13992 All marks in the virtual group will stick to the articles in the
13993 component groups. So if you tick an article in a virtual group, the
13994 article will also be ticked in the component group from whence it came.
13995 (And vice versa---marks from the component groups will also be shown in
13996 the virtual group.)
13998 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
13999 newsgroups into one, big, happy newsgroup:
14002 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
14005 The component groups can be native or foreign; everything should work
14006 smoothly, but if your computer explodes, it was probably my fault.
14008 Collecting the same group from several servers might actually be a good
14009 idea if users have set the Distribution header to limit distribution.
14010 If you would like to read @samp{soc.motss} both from a server in Japan
14011 and a server in Norway, you could use the following as the group regexp:
14014 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
14017 (Remember, though, that if you're creating the group with @kbd{G m}, you
14018 shouldn't double the backslashes, and you should leave off the quote
14019 characters at the beginning and the end of the string.)
14021 This should work kinda smoothly---all articles from both groups should
14022 end up in this one, and there should be no duplicates. Threading (and
14023 the rest) will still work as usual, but there might be problems with the
14024 sequence of articles. Sorting on date might be an option here
14025 (@pxref{Selecting a Group}).
14027 One limitation, however---all groups included in a virtual
14028 group have to be alive (i.e., subscribed or unsubscribed). Killed or
14029 zombie groups can't be component groups for @code{nnvirtual} groups.
14031 @vindex nnvirtual-always-rescan
14032 If the @code{nnvirtual-always-rescan} is non-@code{nil},
14033 @code{nnvirtual} will always scan groups for unread articles when
14034 entering a virtual group. If this variable is @code{nil} (which is the
14035 default) and you read articles in a component group after the virtual
14036 group has been activated, the read articles from the component group
14037 will show up when you enter the virtual group. You'll also see this
14038 effect if you have two virtual groups that have a component group in
14039 common. If that's the case, you should set this variable to @code{t}.
14040 Or you can just tap @code{M-g} on the virtual group every time before
14041 you enter it---it'll have much the same effect.
14043 @code{nnvirtual} can have both mail and news groups as component groups.
14044 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
14045 has to ask the backend of the component group the article comes from
14046 whether it is a news or mail backend. However, when you do a @kbd{^},
14047 there is typically no sure way for the component backend to know this,
14048 and in that case @code{nnvirtual} tells Gnus that the article came from a
14049 not-news backend. (Just to be on the safe side.)
14051 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
14052 line from the article you respond to in these cases.
14056 @node Kibozed Groups
14057 @subsection Kibozed Groups
14061 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
14062 the news feed''. @code{nnkiboze} is a backend that will do this for
14063 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
14064 with useless requests! Oh happiness!
14066 @kindex G k (Group)
14067 To create a kibozed group, use the @kbd{G k} command in the group
14070 The address field of the @code{nnkiboze} method is, as with
14071 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
14072 @code{nnkiboze} group. That's where most similarities between @code{nnkiboze}
14073 and @code{nnvirtual} end.
14075 In addition to this regexp detailing component groups, an @code{nnkiboze} group
14076 must have a score file to say what articles are to be included in
14077 the group (@pxref{Scoring}).
14079 @kindex M-x nnkiboze-generate-groups
14080 @findex nnkiboze-generate-groups
14081 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
14082 @code{nnkiboze} groups you want to have. This command will take time. Lots of
14083 time. Oodles and oodles of time. Gnus has to fetch the headers from
14084 all the articles in all the component groups and run them through the
14085 scoring process to determine if there are any articles in the groups
14086 that are to be part of the @code{nnkiboze} groups.
14088 Please limit the number of component groups by using restrictive
14089 regexps. Otherwise your sysadmin may become annoyed with you, and the
14090 @sc{nntp} site may throw you off and never let you back in again.
14091 Stranger things have happened.
14093 @code{nnkiboze} component groups do not have to be alive---they can be dead,
14094 and they can be foreign. No restrictions.
14096 @vindex nnkiboze-directory
14097 The generation of an @code{nnkiboze} group means writing two files in
14098 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
14099 contains the @sc{nov} header lines for all the articles in the group,
14100 and the other is an additional @file{.newsrc} file to store information
14101 on what groups have been searched through to find component articles.
14103 Articles marked as read in the @code{nnkiboze} group will have
14104 their @sc{nov} lines removed from the @sc{nov} file.
14107 @node Gnus Unplugged
14108 @section Gnus Unplugged
14113 @cindex Gnus Unplugged
14115 In olden times (ca. February '88), people used to run their newsreaders
14116 on big machines with permanent connections to the net. News transport
14117 was dealt with by news servers, and all the newsreaders had to do was to
14118 read news. Believe it or not.
14120 Nowadays most people read news and mail at home, and use some sort of
14121 modem to connect to the net. To avoid running up huge phone bills, it
14122 would be nice to have a way to slurp down all the news and mail, hang up
14123 the phone, read for several hours, and then upload any responses you
14124 have to make. And then you repeat the procedure.
14126 Of course, you can use news servers for doing this as well. I've used
14127 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
14128 for some years, but doing that's a bore. Moving the news server
14129 functionality up to the newsreader makes sense if you're the only person
14130 reading news on a machine.
14132 Using Gnus as an ``offline'' newsreader is quite simple.
14136 First, set up Gnus as you would do if you were running it on a machine
14137 that has full connection to the net. Go ahead. I'll still be waiting
14141 Then, put the following magical incantation at the end of your
14142 @file{.gnus.el} file:
14149 That's it. Gnus is now an ``offline'' newsreader.
14151 Of course, to use it as such, you have to learn a few new commands.
14154 * Agent Basics:: How it all is supposed to work.
14155 * Agent Categories:: How to tell the Gnus Agent what to download.
14156 * Agent Commands:: New commands for all the buffers.
14157 * Agent Expiry:: How to make old articles go away.
14158 * Agent and IMAP:: How to use the Agent with IMAP.
14159 * Outgoing Messages:: What happens when you post/mail something?
14160 * Agent Variables:: Customizing is fun.
14161 * Example Setup:: An example @file{.gnus.el} file for offline people.
14162 * Batching Agents:: How to fetch news from a @code{cron} job.
14163 * Agent Caveats:: What you think it'll do and what it does.
14168 @subsection Agent Basics
14170 First, let's get some terminology out of the way.
14172 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
14173 connection to the net (and notified the Agent that this is the case).
14174 When the connection to the net is up again (and Gnus knows this), the
14175 Agent is @dfn{plugged}.
14177 The @dfn{local} machine is the one you're running on, and which isn't
14178 connected to the net continuously.
14180 @dfn{Downloading} means fetching things from the net to your local
14181 machine. @dfn{Uploading} is doing the opposite.
14183 Let's take a typical Gnus session using the Agent.
14188 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
14189 Agent in a disconnected state. You can read all the news that you have
14190 already fetched while in this mode.
14193 You then decide to see whether any new news has arrived. You connect
14194 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
14195 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
14196 as usual. To check for new mail in unplugged mode, see (@pxref{Mail
14197 Source Specifiers}).
14200 You can then read the new news immediately, or you can download the news
14201 onto your local machine. If you want to do the latter, you press @kbd{g}
14202 to check if there are any new news and then @kbd{J
14203 s} to fetch all the eligible articles in all the groups. (To let Gnus
14204 know which articles you want to download, @pxref{Agent Categories}.)
14207 After fetching the articles, you press @kbd{J j} to make Gnus become
14208 unplugged again, and you shut down the PPP thing (or whatever). And
14209 then you read the news offline.
14212 And then you go to step 2.
14215 Here are some things you should do the first time (or so) that you use
14221 Decide which servers should be covered by the Agent. If you have a mail
14222 backend, it would probably be nonsensical to have it covered by the
14223 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
14224 @kbd{J a} the server (or servers) that you wish to have covered by the
14225 Agent (@pxref{Server Agent Commands}). This will typically be only the
14226 primary select method, which is listed on the bottom in the buffer.
14229 Decide on download policy. @xref{Agent Categories}.
14236 @node Agent Categories
14237 @subsection Agent Categories
14239 One of the main reasons to integrate the news transport layer into the
14240 newsreader is to allow greater control over what articles to download.
14241 There's not much point in downloading huge amounts of articles, just to
14242 find out that you're not interested in reading any of them. It's better
14243 to be somewhat more conservative in choosing what to download, and then
14244 mark the articles for downloading manually if it should turn out that
14245 you're interested in the articles anyway.
14247 The main way to control what is to be downloaded is to create a
14248 @dfn{category} and then assign some (or all) groups to this category.
14249 Groups that do not belong in any other category belong to the
14250 @code{default} category. Gnus has its own buffer for creating and
14251 managing categories.
14254 * Category Syntax:: What a category looks like.
14255 * The Category Buffer:: A buffer for maintaining categories.
14256 * Category Variables:: Customize'r'Us.
14260 @node Category Syntax
14261 @subsubsection Category Syntax
14263 A category consists of two things.
14267 A predicate which (generally) gives a rough outline of which articles
14268 are eligible for downloading; and
14271 a score rule which (generally) gives you a finer granularity when
14272 deciding what articles to download. (Note that this @dfn{download
14273 score} is not necessarily related to normal scores.)
14276 A predicate in its simplest form can be a single predicate such as
14277 @code{true} or @code{false}. These two will download every available
14278 article or nothing respectively. In the case of these two special
14279 predicates an additional score rule is superfluous.
14281 Predicates of @code{high} or @code{low} download articles in respect of
14282 their scores in relationship to @code{gnus-agent-high-score} and
14283 @code{gnus-agent-low-score} as descibed below.
14285 To gain even finer control of what is to be regarded eligible for
14286 download a predicate can consist of a number of predicates with logical
14287 operators sprinkled in between.
14289 Perhaps some examples are in order.
14291 Here's a simple predicate. (It's the default predicate, in fact, used
14292 for all groups that don't belong to any other category.)
14298 Quite simple, eh? This predicate is true if and only if the article is
14299 short (for some value of ``short'').
14301 Here's a more complex predicate:
14310 This means that an article should be downloaded if it has a high score,
14311 or if the score is not low and the article is not long. You get the
14314 The available logical operators are @code{or}, @code{and} and
14315 @code{not}. (If you prefer, you can use the more ``C''-ish operators
14316 @samp{|}, @code{&} and @code{!} instead.)
14318 The following predicates are pre-defined, but if none of these fit what
14319 you want to do, you can write your own.
14323 True iff the article is shorter than @code{gnus-agent-short-article}
14324 lines; default 100.
14327 True iff the article is longer than @code{gnus-agent-long-article}
14328 lines; default 200.
14331 True iff the article has a download score less than
14332 @code{gnus-agent-low-score}; default 0.
14335 True iff the article has a download score greater than
14336 @code{gnus-agent-high-score}; default 0.
14339 True iff the Gnus Agent guesses that the article is spam. The
14340 heuristics may change over time, but at present it just computes a
14341 checksum and sees whether articles match.
14350 If you want to create your own predicate function, here's what you have
14351 to know: The functions are called with no parameters, but the
14352 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
14355 For example, you could decide that you don't want to download articles
14356 that were posted more than a certain number of days ago (e.g. posted
14357 more than @code{gnus-agent-expire-days} ago) you might write a function
14358 something along the lines of the following:
14361 (defun my-article-old-p ()
14362 "Say whether an article is old."
14363 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
14364 (- (time-to-days (current-time)) gnus-agent-expire-days)))
14367 with the predicate then defined as:
14370 (not my-article-old-p)
14373 or you could append your predicate to the predefined
14374 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
14375 wherever. (Note: this would have to be at a point *after*
14376 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
14379 (defvar gnus-category-predicate-alist
14380 (append gnus-category-predicate-alist
14381 '((old . my-article-old-p))))
14384 and simply specify your predicate as:
14390 If/when using something like the above, be aware that there are many
14391 misconfigured systems/mailers out there and so an article's date is not
14392 always a reliable indication of when it was posted. Hell, some people
14393 just don't give a damm.
14395 The above predicates apply to *all* the groups which belong to the
14396 category. However, if you wish to have a specific predicate for an
14397 individual group within a category, or you're just too lazy to set up a
14398 new category, you can enter a group's individual predicate in it's group
14399 parameters like so:
14402 (agent-predicate . short)
14405 This is the group parameter equivalent of the agent category default.
14406 Note that when specifying a single word predicate like this, the
14407 @code{agent-predicate} specification must be in dotted pair notation.
14409 The equivalent of the longer example from above would be:
14412 (agent-predicate or high (and (not low) (not long)))
14415 The outer parenthesis required in the category specification are not
14416 entered here as, not being in dotted pair notation, the value of the
14417 predicate is assumed to be a list.
14420 Now, the syntax of the download score is the same as the syntax of
14421 normal score files, except that all elements that require actually
14422 seeing the article itself are verboten. This means that only the
14423 following headers can be scored on: @code{Subject}, @code{From},
14424 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
14425 @code{Lines}, and @code{Xref}.
14427 As with predicates, the specification of the @code{download score rule}
14428 to use in respect of a group can be in either the category definition if
14429 it's to be applicable to all groups in therein, or a group's parameters
14430 if it's to be specific to that group.
14432 In both of these places the @code{download score rule} can take one of
14439 This has the same syntax as a normal gnus score file except only a
14440 subset of scoring keywords are available as mentioned above.
14446 Category specification
14450 ("Lars Ingebrigtsen" 1000000 nil s))
14456 Group Parameter specification
14459 (agent-score ("from"
14460 ("Lars Ingebrigtsen" 1000000 nil s))
14465 Again, note the omission of the outermost parenthesis here.
14471 These score files must *only* contain the permitted scoring keywords
14478 Category specification
14481 ("~/News/agent.SCORE")
14487 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
14491 Group Parameter specification
14494 (agent-score "~/News/agent.SCORE")
14497 Additional score files can be specified as above. Need I say anything
14502 Use @code{normal} score files
14504 If you dont want to maintain two sets of scoring rules for a group, and
14505 your desired @code{downloading} criteria for a group are the same as your
14506 @code{reading} criteria then you can tell the agent to refer to your
14507 @code{normal} score files when deciding what to download.
14509 These directives in either the category definition or a group's
14510 parameters will cause the agent to read in all the applicable score
14511 files for a group, *filtering out* those those sections that do not
14512 relate to one of the permitted subset of scoring keywords.
14516 Category Specification
14523 Group Parameter specification
14526 (agent-score . file)
14531 @node The Category Buffer
14532 @subsubsection The Category Buffer
14534 You'd normally do all category maintenance from the category buffer.
14535 When you enter it for the first time (with the @kbd{J c} command from
14536 the group buffer), you'll only see the @code{default} category.
14538 The following commands are available in this buffer:
14542 @kindex q (Category)
14543 @findex gnus-category-exit
14544 Return to the group buffer (@code{gnus-category-exit}).
14547 @kindex k (Category)
14548 @findex gnus-category-kill
14549 Kill the current category (@code{gnus-category-kill}).
14552 @kindex c (Category)
14553 @findex gnus-category-copy
14554 Copy the current category (@code{gnus-category-copy}).
14557 @kindex a (Category)
14558 @findex gnus-category-add
14559 Add a new category (@code{gnus-category-add}).
14562 @kindex p (Category)
14563 @findex gnus-category-edit-predicate
14564 Edit the predicate of the current category
14565 (@code{gnus-category-edit-predicate}).
14568 @kindex g (Category)
14569 @findex gnus-category-edit-groups
14570 Edit the list of groups belonging to the current category
14571 (@code{gnus-category-edit-groups}).
14574 @kindex s (Category)
14575 @findex gnus-category-edit-score
14576 Edit the download score rule of the current category
14577 (@code{gnus-category-edit-score}).
14580 @kindex l (Category)
14581 @findex gnus-category-list
14582 List all the categories (@code{gnus-category-list}).
14586 @node Category Variables
14587 @subsubsection Category Variables
14590 @item gnus-category-mode-hook
14591 @vindex gnus-category-mode-hook
14592 Hook run in category buffers.
14594 @item gnus-category-line-format
14595 @vindex gnus-category-line-format
14596 Format of the lines in the category buffer (@pxref{Formatting
14597 Variables}). Valid elements are:
14601 The name of the category.
14604 The number of groups in the category.
14607 @item gnus-category-mode-line-format
14608 @vindex gnus-category-mode-line-format
14609 Format of the category mode line (@pxref{Mode Line Formatting}).
14611 @item gnus-agent-short-article
14612 @vindex gnus-agent-short-article
14613 Articles that have fewer lines than this are short. Default 100.
14615 @item gnus-agent-long-article
14616 @vindex gnus-agent-long-article
14617 Articles that have more lines than this are long. Default 200.
14619 @item gnus-agent-low-score
14620 @vindex gnus-agent-low-score
14621 Articles that have a score lower than this have a low score. Default
14624 @item gnus-agent-high-score
14625 @vindex gnus-agent-high-score
14626 Articles that have a score higher than this have a high score. Default
14632 @node Agent Commands
14633 @subsection Agent Commands
14635 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
14636 (@code{gnus-agent-toggle-plugged} command works in all modes, and
14637 toggles the plugged/unplugged state of the Gnus Agent.
14641 * Group Agent Commands::
14642 * Summary Agent Commands::
14643 * Server Agent Commands::
14646 You can run a complete batch fetch from the command line with the
14647 following incantation:
14649 @cindex gnus-agent-batch-fetch
14651 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
14656 @node Group Agent Commands
14657 @subsubsection Group Agent Commands
14661 @kindex J u (Agent Group)
14662 @findex gnus-agent-fetch-groups
14663 Fetch all eligible articles in the current group
14664 (@code{gnus-agent-fetch-groups}).
14667 @kindex J c (Agent Group)
14668 @findex gnus-enter-category-buffer
14669 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
14672 @kindex J s (Agent Group)
14673 @findex gnus-agent-fetch-session
14674 Fetch all eligible articles in all groups
14675 (@code{gnus-agent-fetch-session}).
14678 @kindex J S (Agent Group)
14679 @findex gnus-group-send-drafts
14680 Send all sendable messages in the draft group
14681 (@code{gnus-group-send-drafts}). @xref{Drafts}.
14684 @kindex J a (Agent Group)
14685 @findex gnus-agent-add-group
14686 Add the current group to an Agent category
14687 (@code{gnus-agent-add-group}). This command understands the
14688 process/prefix convention (@pxref{Process/Prefix}).
14691 @kindex J r (Agent Group)
14692 @findex gnus-agent-remove-group
14693 Remove the current group from its category, if any
14694 (@code{gnus-agent-remove-group}). This command understands the
14695 process/prefix convention (@pxref{Process/Prefix}).
14698 @kindex J Y (Agent Group)
14699 @findex gnus-agent-synchronize-flags
14700 Synchronize flags changed while unplugged with remote server, if any.
14706 @node Summary Agent Commands
14707 @subsubsection Summary Agent Commands
14711 @kindex J # (Agent Summary)
14712 @findex gnus-agent-mark-article
14713 Mark the article for downloading (@code{gnus-agent-mark-article}).
14716 @kindex J M-# (Agent Summary)
14717 @findex gnus-agent-unmark-article
14718 Remove the downloading mark from the article
14719 (@code{gnus-agent-unmark-article}).
14722 @kindex @@ (Agent Summary)
14723 @findex gnus-agent-toggle-mark
14724 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
14727 @kindex J c (Agent Summary)
14728 @findex gnus-agent-catchup
14729 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
14734 @node Server Agent Commands
14735 @subsubsection Server Agent Commands
14739 @kindex J a (Agent Server)
14740 @findex gnus-agent-add-server
14741 Add the current server to the list of servers covered by the Gnus Agent
14742 (@code{gnus-agent-add-server}).
14745 @kindex J r (Agent Server)
14746 @findex gnus-agent-remove-server
14747 Remove the current server from the list of servers covered by the Gnus
14748 Agent (@code{gnus-agent-remove-server}).
14754 @subsection Agent Expiry
14756 @vindex gnus-agent-expire-days
14757 @findex gnus-agent-expire
14758 @kindex M-x gnus-agent-expire
14759 @cindex Agent expiry
14760 @cindex Gnus Agent expiry
14763 @code{nnagent} doesn't handle expiry. Instead, there's a special
14764 @code{gnus-agent-expire} command that will expire all read articles that
14765 are older than @code{gnus-agent-expire-days} days. It can be run
14766 whenever you feel that you're running out of space. It's not
14767 particularly fast or efficient, and it's not a particularly good idea to
14768 interrupt it (with @kbd{C-g} or anything else) once you've started it.
14770 @vindex gnus-agent-expire-all
14771 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
14772 expire all articles---unread, read, ticked and dormant. If @code{nil}
14773 (which is the default), only read articles are eligible for expiry, and
14774 unread, ticked and dormant articles will be kept indefinitely.
14777 @node Agent and IMAP
14778 @subsection Agent and IMAP
14780 The Agent work with any Gnus backend, including nnimap. However, since
14781 there are some conceptual differences between NNTP and IMAP, this
14782 section (should) provide you with some information to make Gnus Agent
14783 work smoother as a IMAP Disconnected Mode client.
14785 The first thing to keep in mind is that all flags (read, ticked, etc)
14786 are kept on the IMAP server, rather than in @code{.newsrc} as is the
14787 case for nntp. Thus Gnus need to remember flag changes when
14788 disconnected, and synchronize these flags when you plug back in.
14790 Gnus keep track of flag changes when reading nnimap groups under the
14791 Agent by default. When you plug back in, by default Gnus will check if
14792 you have any changed any flags and ask if you wish to synchronize theese
14793 with the server. This behaviour is customizable with
14794 @code{gnus-agent-synchronize-flags}.
14796 @vindex gnus-agent-synchronize-flags
14797 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
14798 never automatically synchronize flags. If it is @code{ask}, the
14799 default, the Agent will check if you made any changes and if so ask if
14800 you wish to synchronize these when you re-connect. If it has any other
14801 value, all flags will be synchronized automatically.
14803 If you do not wish to automatically synchronize flags when you
14804 re-connect, this can be done manually with the
14805 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
14806 in the group buffer by default.
14808 Some things are currently not implemented in the Agent that you'd might
14809 expect from a disconnected IMAP client, including:
14814 Copying/moving articles into nnimap groups when unplugged. (This
14815 currently include GCC into a nnimap group when unplugged.)
14818 Creating/deleting nnimap groups when unplugged.
14822 Technical note: the synchronization algorithm does not work by "pushing"
14823 all local flags to the server, but rather incrementally update the
14824 server view of flags by changing only those flags that were changed by
14825 the user. Thus, if you set one flag on a article, quit the group and
14826 re-select the group and remove the flag; the flag will be set and
14827 removed from the server when you "synchronize". The queued flag
14828 operations can be found in the per-server @code{flags} file in the Agent
14829 directory. It's emptied when you synchronize flags.
14832 @node Outgoing Messages
14833 @subsection Outgoing Messages
14835 When Gnus is unplugged, all outgoing messages (both mail and news) are
14836 stored in the draft groups (@pxref{Drafts}). You can view them there
14837 after posting, and edit them at will.
14839 When Gnus is plugged again, you can send the messages either from the
14840 draft group with the special commands available there, or you can use
14841 the @kbd{J S} command in the group buffer to send all the sendable
14842 messages in the draft group.
14846 @node Agent Variables
14847 @subsection Agent Variables
14850 @item gnus-agent-directory
14851 @vindex gnus-agent-directory
14852 Where the Gnus Agent will store its files. The default is
14853 @file{~/News/agent/}.
14855 @item gnus-agent-handle-level
14856 @vindex gnus-agent-handle-level
14857 Groups on levels (@pxref{Group Levels}) higher than this variable will
14858 be ignored by the Agent. The default is @code{gnus-level-subscribed},
14859 which means that only subscribed group will be considered by the Agent
14862 @item gnus-agent-plugged-hook
14863 @vindex gnus-agent-plugged-hook
14864 Hook run when connecting to the network.
14866 @item gnus-agent-unplugged-hook
14867 @vindex gnus-agent-unplugged-hook
14868 Hook run when disconnecting from the network.
14873 @node Example Setup
14874 @subsection Example Setup
14876 If you don't want to read this manual, and you have a fairly standard
14877 setup, you may be able to use something like the following as your
14878 @file{.gnus.el} file to get started.
14881 ;;; Define how Gnus is to fetch news. We do this over @sc{nntp}
14882 ;;; from your ISP's server.
14883 (setq gnus-select-method '(nntp "news.your-isp.com"))
14885 ;;; Define how Gnus is to read your mail. We read mail from
14886 ;;; your ISP's POP server.
14887 (setq mail-sources '((pop :server "pop.your-isp.com")))
14889 ;;; Say how Gnus is to store the mail. We use nnml groups.
14890 (setq gnus-secondary-select-methods '((nnml "")))
14892 ;;; Make Gnus into an offline newsreader.
14896 That should be it, basically. Put that in your @file{~/.gnus.el} file,
14897 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
14900 If this is the first time you've run Gnus, you will be subscribed
14901 automatically to a few default newsgroups. You'll probably want to
14902 subscribe to more groups, and to do that, you have to query the
14903 @sc{nntp} server for a complete list of groups with the @kbd{A A}
14904 command. This usually takes quite a while, but you only have to do it
14907 After reading and parsing a while, you'll be presented with a list of
14908 groups. Subscribe to the ones you want to read with the @kbd{u}
14909 command. @kbd{l} to make all the killed groups disappear after you've
14910 subscribe to all the groups you want to read. (@kbd{A k} will bring
14911 back all the killed groups.)
14913 You can now read the groups at once, or you can download the articles
14914 with the @kbd{J s} command. And then read the rest of this manual to
14915 find out which of the other gazillion things you want to customize.
14918 @node Batching Agents
14919 @subsection Batching Agents
14921 Having the Gnus Agent fetch articles (and post whatever messages you've
14922 written) is quite easy once you've gotten things set up properly. The
14923 following shell script will do everything that is necessary:
14927 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
14931 @node Agent Caveats
14932 @subsection Agent Caveats
14934 The Gnus Agent doesn't seem to work like most other offline
14935 newsreaders. Here are some common questions that some imaginary people
14939 @item If I read an article while plugged, do they get entered into the
14944 @item If I read an article while plugged, and the article already exists
14945 in the Agent, will it get downloaded once more?
14951 In short, when Gnus is unplugged, it only looks into the locally stored
14952 articles; when it's plugged, it only talks to your ISP.
14959 Other people use @dfn{kill files}, but we here at Gnus Towers like
14960 scoring better than killing, so we'd rather switch than fight. They do
14961 something completely different as well, so sit up straight and pay
14964 @vindex gnus-summary-mark-below
14965 All articles have a default score (@code{gnus-summary-default-score}),
14966 which is 0 by default. This score may be raised or lowered either
14967 interactively or by score files. Articles that have a score lower than
14968 @code{gnus-summary-mark-below} are marked as read.
14970 Gnus will read any @dfn{score files} that apply to the current group
14971 before generating the summary buffer.
14973 There are several commands in the summary buffer that insert score
14974 entries based on the current article. You can, for instance, ask Gnus to
14975 lower or increase the score of all articles with a certain subject.
14977 There are two sorts of scoring entries: Permanent and temporary.
14978 Temporary score entries are self-expiring entries. Any entries that are
14979 temporary and have not been used for, say, a week, will be removed
14980 silently to help keep the sizes of the score files down.
14983 * Summary Score Commands:: Adding score entries for the current group.
14984 * Group Score Commands:: General score commands.
14985 * Score Variables:: Customize your scoring. (My, what terminology).
14986 * Score File Format:: What a score file may contain.
14987 * Score File Editing:: You can edit score files by hand as well.
14988 * Adaptive Scoring:: Big Sister Gnus knows what you read.
14989 * Home Score File:: How to say where new score entries are to go.
14990 * Followups To Yourself:: Having Gnus notice when people answer you.
14991 * Scoring Tips:: How to score effectively.
14992 * Reverse Scoring:: That problem child of old is not problem.
14993 * Global Score Files:: Earth-spanning, ear-splitting score files.
14994 * Kill Files:: They are still here, but they can be ignored.
14995 * GroupLens:: Getting predictions on what you like to read.
14996 * Advanced Scoring:: Using logical expressions to build score rules.
14997 * Score Decays:: It can be useful to let scores wither away.
15001 @node Summary Score Commands
15002 @section Summary Score Commands
15003 @cindex score commands
15005 The score commands that alter score entries do not actually modify real
15006 score files. That would be too inefficient. Gnus maintains a cache of
15007 previously loaded score files, one of which is considered the
15008 @dfn{current score file alist}. The score commands simply insert
15009 entries into this list, and upon group exit, this list is saved.
15011 The current score file is by default the group's local score file, even
15012 if no such score file actually exists. To insert score commands into
15013 some other score file (e.g. @file{all.SCORE}), you must first make this
15014 score file the current one.
15016 General score commands that don't actually change the score file:
15021 @kindex V s (Summary)
15022 @findex gnus-summary-set-score
15023 Set the score of the current article (@code{gnus-summary-set-score}).
15026 @kindex V S (Summary)
15027 @findex gnus-summary-current-score
15028 Display the score of the current article
15029 (@code{gnus-summary-current-score}).
15032 @kindex V t (Summary)
15033 @findex gnus-score-find-trace
15034 Display all score rules that have been used on the current article
15035 (@code{gnus-score-find-trace}).
15038 @kindex V R (Summary)
15039 @findex gnus-summary-rescore
15040 Run the current summary through the scoring process
15041 (@code{gnus-summary-rescore}). This might be useful if you're playing
15042 around with your score files behind Gnus' back and want to see the
15043 effect you're having.
15046 @kindex V c (Summary)
15047 @findex gnus-score-change-score-file
15048 Make a different score file the current
15049 (@code{gnus-score-change-score-file}).
15052 @kindex V e (Summary)
15053 @findex gnus-score-edit-current-scores
15054 Edit the current score file (@code{gnus-score-edit-current-scores}).
15055 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
15059 @kindex V f (Summary)
15060 @findex gnus-score-edit-file
15061 Edit a score file and make this score file the current one
15062 (@code{gnus-score-edit-file}).
15065 @kindex V F (Summary)
15066 @findex gnus-score-flush-cache
15067 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
15068 after editing score files.
15071 @kindex V C (Summary)
15072 @findex gnus-score-customize
15073 Customize a score file in a visually pleasing manner
15074 (@code{gnus-score-customize}).
15078 The rest of these commands modify the local score file.
15083 @kindex V m (Summary)
15084 @findex gnus-score-set-mark-below
15085 Prompt for a score, and mark all articles with a score below this as
15086 read (@code{gnus-score-set-mark-below}).
15089 @kindex V x (Summary)
15090 @findex gnus-score-set-expunge-below
15091 Prompt for a score, and add a score rule to the current score file to
15092 expunge all articles below this score
15093 (@code{gnus-score-set-expunge-below}).
15096 The keystrokes for actually making score entries follow a very regular
15097 pattern, so there's no need to list all the commands. (Hundreds of
15100 @findex gnus-summary-increase-score
15101 @findex gnus-summary-lower-score
15105 The first key is either @kbd{I} (upper case i) for increasing the score
15106 or @kbd{L} for lowering the score.
15108 The second key says what header you want to score on. The following
15109 keys are available:
15113 Score on the author name.
15116 Score on the subject line.
15119 Score on the @code{Xref} line---i.e., the cross-posting line.
15122 Score on the @code{References} line.
15128 Score on the number of lines.
15131 Score on the @code{Message-ID} header.
15134 Score on followups---this matches the author name, and adds scores to
15135 the followups to this author.
15149 The third key is the match type. Which match types are valid depends on
15150 what headers you are scoring on.
15162 Substring matching.
15165 Fuzzy matching (@pxref{Fuzzy Matching}).
15194 Greater than number.
15199 The fourth and final key says whether this is a temporary (i.e., expiring)
15200 score entry, or a permanent (i.e., non-expiring) score entry, or whether
15201 it is to be done immediately, without adding to the score file.
15205 Temporary score entry.
15208 Permanent score entry.
15211 Immediately scoring.
15216 So, let's say you want to increase the score on the current author with
15217 exact matching permanently: @kbd{I a e p}. If you want to lower the
15218 score based on the subject line, using substring matching, and make a
15219 temporary score entry: @kbd{L s s t}. Pretty easy.
15221 To make things a bit more complicated, there are shortcuts. If you use
15222 a capital letter on either the second or third keys, Gnus will use
15223 defaults for the remaining one or two keystrokes. The defaults are
15224 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
15225 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
15227 These functions take both the numerical prefix and the symbolic prefix
15228 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
15229 (or increase) the score of the article. A symbolic prefix of @code{a}
15230 says to use the @file{all.SCORE} file for the command instead of the
15231 current score file.
15233 @vindex gnus-score-mimic-keymap
15234 The @code{gnus-score-mimic-keymap} says whether these commands will
15235 pretend they are keymaps or not.
15238 @node Group Score Commands
15239 @section Group Score Commands
15240 @cindex group score commands
15242 There aren't many of these as yet, I'm afraid.
15247 @kindex W f (Group)
15248 @findex gnus-score-flush-cache
15249 Gnus maintains a cache of score alists to avoid having to reload them
15250 all the time. This command will flush the cache
15251 (@code{gnus-score-flush-cache}).
15255 You can do scoring from the command line by saying something like:
15257 @findex gnus-batch-score
15258 @cindex batch scoring
15260 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
15264 @node Score Variables
15265 @section Score Variables
15266 @cindex score variables
15270 @item gnus-use-scoring
15271 @vindex gnus-use-scoring
15272 If @code{nil}, Gnus will not check for score files, and will not, in
15273 general, do any score-related work. This is @code{t} by default.
15275 @item gnus-kill-killed
15276 @vindex gnus-kill-killed
15277 If this variable is @code{nil}, Gnus will never apply score files to
15278 articles that have already been through the kill process. While this
15279 may save you lots of time, it also means that if you apply a kill file
15280 to a group, and then change the kill file and want to run it over you
15281 group again to kill more articles, it won't work. You have to set this
15282 variable to @code{t} to do that. (It is @code{t} by default.)
15284 @item gnus-kill-files-directory
15285 @vindex gnus-kill-files-directory
15286 All kill and score files will be stored in this directory, which is
15287 initialized from the @code{SAVEDIR} environment variable by default.
15288 This is @file{~/News/} by default.
15290 @item gnus-score-file-suffix
15291 @vindex gnus-score-file-suffix
15292 Suffix to add to the group name to arrive at the score file name
15293 (@samp{SCORE} by default.)
15295 @item gnus-score-uncacheable-files
15296 @vindex gnus-score-uncacheable-files
15297 @cindex score cache
15298 All score files are normally cached to avoid excessive re-loading of
15299 score files. However, if this might make your Emacs grow big and
15300 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
15301 @file{all.SCORE}, while it might be a good idea to not cache
15302 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
15303 variable is @samp{ADAPT$} by default, so no adaptive score files will
15306 @item gnus-save-score
15307 @vindex gnus-save-score
15308 If you have really complicated score files, and do lots of batch
15309 scoring, then you might set this variable to @code{t}. This will make
15310 Gnus save the scores into the @file{.newsrc.eld} file.
15312 If you do not set this to @code{t}, then manual scores (like those set
15313 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
15314 across group visits.
15316 @item gnus-score-interactive-default-score
15317 @vindex gnus-score-interactive-default-score
15318 Score used by all the interactive raise/lower commands to raise/lower
15319 score with. Default is 1000, which may seem excessive, but this is to
15320 ensure that the adaptive scoring scheme gets enough room to play with.
15321 We don't want the small changes from the adaptive scoring to overwrite
15322 manually entered data.
15324 @item gnus-summary-default-score
15325 @vindex gnus-summary-default-score
15326 Default score of an article, which is 0 by default.
15328 @item gnus-summary-expunge-below
15329 @vindex gnus-summary-expunge-below
15330 Don't display the summary lines of articles that have scores lower than
15331 this variable. This is @code{nil} by default, which means that no
15332 articles will be hidden. This variable is local to the summary buffers,
15333 and has to be set from @code{gnus-summary-mode-hook}.
15335 @item gnus-score-over-mark
15336 @vindex gnus-score-over-mark
15337 Mark (in the third column) used for articles with a score over the
15338 default. Default is @samp{+}.
15340 @item gnus-score-below-mark
15341 @vindex gnus-score-below-mark
15342 Mark (in the third column) used for articles with a score below the
15343 default. Default is @samp{-}.
15345 @item gnus-score-find-score-files-function
15346 @vindex gnus-score-find-score-files-function
15347 Function used to find score files for the current group. This function
15348 is called with the name of the group as the argument.
15350 Predefined functions available are:
15353 @item gnus-score-find-single
15354 @findex gnus-score-find-single
15355 Only apply the group's own score file.
15357 @item gnus-score-find-bnews
15358 @findex gnus-score-find-bnews
15359 Apply all score files that match, using bnews syntax. This is the
15360 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
15361 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
15362 @file{gnu.all.SCORE} would all apply. In short, the instances of
15363 @samp{all} in the score file names are translated into @samp{.*}, and
15364 then a regexp match is done.
15366 This means that if you have some score entries that you want to apply to
15367 all groups, then you put those entries in the @file{all.SCORE} file.
15369 The score files are applied in a semi-random order, although Gnus will
15370 try to apply the more general score files before the more specific score
15371 files. It does this by looking at the number of elements in the score
15372 file names---discarding the @samp{all} elements.
15374 @item gnus-score-find-hierarchical
15375 @findex gnus-score-find-hierarchical
15376 Apply all score files from all the parent groups. This means that you
15377 can't have score files like @file{all.SCORE}, but you can have
15378 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
15382 This variable can also be a list of functions. In that case, all these
15383 functions will be called with the group name as argument, and all the
15384 returned lists of score files will be applied. These functions can also
15385 return lists of score alists directly. In that case, the functions that
15386 return these non-file score alists should probably be placed before the
15387 ``real'' score file functions, to ensure that the last score file
15388 returned is the local score file. Phu.
15390 For example, to do hierarchical scoring but use a non-server-specific
15391 overall score file, you could use the value
15393 (list (lambda (group) ("all.SCORE")) 'gnus-score-find-hierarchical)
15396 @item gnus-score-expiry-days
15397 @vindex gnus-score-expiry-days
15398 This variable says how many days should pass before an unused score file
15399 entry is expired. If this variable is @code{nil}, no score file entries
15400 are expired. It's 7 by default.
15402 @item gnus-update-score-entry-dates
15403 @vindex gnus-update-score-entry-dates
15404 If this variable is non-@code{nil}, matching score entries will have
15405 their dates updated. (This is how Gnus controls expiry---all
15406 non-matching entries will become too old while matching entries will
15407 stay fresh and young.) However, if you set this variable to @code{nil},
15408 even matching entries will grow old and will have to face that oh-so
15411 @item gnus-score-after-write-file-function
15412 @vindex gnus-score-after-write-file-function
15413 Function called with the name of the score file just written.
15415 @item gnus-score-thread-simplify
15416 @vindex gnus-score-thread-simplify
15417 If this variable is non-@code{nil}, article subjects will be simplified
15418 for subject scoring purposes in the same manner as with
15419 threading---according to the current value of
15420 gnus-simplify-subject-functions. If the scoring entry uses
15421 @code{substring} or @code{exact} matching, the match will also be
15422 simplified in this manner.
15427 @node Score File Format
15428 @section Score File Format
15429 @cindex score file format
15431 A score file is an @code{emacs-lisp} file that normally contains just a
15432 single form. Casual users are not expected to edit these files;
15433 everything can be changed from the summary buffer.
15435 Anyway, if you'd like to dig into it yourself, here's an example:
15439 ("Lars Ingebrigtsen" -10000)
15441 ("larsi\\|lmi" -50000 nil R))
15443 ("Ding is Badd" nil 728373))
15445 ("alt.politics" -1000 728372 s))
15450 (mark-and-expunge -10)
15454 (files "/hom/larsi/News/gnu.SCORE")
15455 (exclude-files "all.SCORE")
15456 (local (gnus-newsgroup-auto-expire t)
15457 (gnus-summary-make-false-root empty))
15461 This example demonstrates most score file elements. For a different
15462 approach, see @pxref{Advanced Scoring}.
15464 Even though this looks much like lisp code, nothing here is actually
15465 @code{eval}ed. The lisp reader is used to read this form, though, so it
15466 has to be valid syntactically, if not semantically.
15468 Six keys are supported by this alist:
15473 If the key is a string, it is the name of the header to perform the
15474 match on. Scoring can only be performed on these eight headers:
15475 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
15476 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
15477 these headers, there are three strings to tell Gnus to fetch the entire
15478 article and do the match on larger parts of the article: @code{Body}
15479 will perform the match on the body of the article, @code{Head} will
15480 perform the match on the head of the article, and @code{All} will
15481 perform the match on the entire article. Note that using any of these
15482 last three keys will slow down group entry @emph{considerably}. The
15483 final ``header'' you can score on is @code{Followup}. These score
15484 entries will result in new score entries being added for all follow-ups
15485 to articles that matches these score entries.
15487 Following this key is a arbitrary number of score entries, where each
15488 score entry has one to four elements.
15492 The first element is the @dfn{match element}. On most headers this will
15493 be a string, but on the Lines and Chars headers, this must be an
15497 If the second element is present, it should be a number---the @dfn{score
15498 element}. This number should be an integer in the neginf to posinf
15499 interval. This number is added to the score of the article if the match
15500 is successful. If this element is not present, the
15501 @code{gnus-score-interactive-default-score} number will be used
15502 instead. This is 1000 by default.
15505 If the third element is present, it should be a number---the @dfn{date
15506 element}. This date says when the last time this score entry matched,
15507 which provides a mechanism for expiring the score entries. It this
15508 element is not present, the score entry is permanent. The date is
15509 represented by the number of days since December 31, 1 BCE.
15512 If the fourth element is present, it should be a symbol---the @dfn{type
15513 element}. This element specifies what function should be used to see
15514 whether this score entry matches the article. What match types that can
15515 be used depends on what header you wish to perform the match on.
15518 @item From, Subject, References, Xref, Message-ID
15519 For most header types, there are the @code{r} and @code{R} (regexp), as
15520 well as @code{s} and @code{S} (substring) types, and @code{e} and
15521 @code{E} (exact match), and @code{w} (word match) types. If this
15522 element is not present, Gnus will assume that substring matching should
15523 be used. @code{R}, @code{S}, and @code{E} differ from the others in
15524 that the matches will be done in a case-sensitive manner. All these
15525 one-letter types are really just abbreviations for the @code{regexp},
15526 @code{string}, @code{exact}, and @code{word} types, which you can use
15527 instead, if you feel like.
15530 These two headers use different match types: @code{<}, @code{>},
15531 @code{=}, @code{>=} and @code{<=}.
15533 These predicates are true if
15536 (PREDICATE HEADER MATCH)
15539 evaluates to non-@code{nil}. For instance, the advanced match
15540 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
15547 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
15548 the match, we get the score added if the article has less than 4 lines.
15549 (It's easy to get confused and think it's the other way around. But
15550 it's not. I think.)
15552 When matching on @code{Lines}, be careful because some backends (like
15553 @code{nndir}) do not generate @code{Lines} header, so every article ends
15554 up being marked as having 0 lines. This can lead to strange results if
15555 you happen to lower score of the articles with few lines.
15558 For the Date header we have three kinda silly match types:
15559 @code{before}, @code{at} and @code{after}. I can't really imagine this
15560 ever being useful, but, like, it would feel kinda silly not to provide
15561 this function. Just in case. You never know. Better safe than sorry.
15562 Once burnt, twice shy. Don't judge a book by its cover. Never not have
15563 sex on a first date. (I have been told that at least one person, and I
15564 quote, ``found this function indispensable'', however.)
15568 A more useful match type is @code{regexp}. With it, you can match the
15569 date string using a regular expression. The date is normalized to
15570 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
15571 you want to match all articles that have been posted on April 1st in
15572 every year, you could use @samp{....0401.........} as a match string,
15573 for instance. (Note that the date is kept in its original time zone, so
15574 this will match articles that were posted when it was April 1st where
15575 the article was posted from. Time zones are such wholesome fun for the
15578 @item Head, Body, All
15579 These three match keys use the same match types as the @code{From} (etc)
15583 This match key is somewhat special, in that it will match the
15584 @code{From} header, and affect the score of not only the matching
15585 articles, but also all followups to the matching articles. This allows
15586 you e.g. increase the score of followups to your own articles, or
15587 decrease the score of followups to the articles of some known
15588 trouble-maker. Uses the same match types as the @code{From} header
15589 uses. (Using this match key will lead to creation of @file{ADAPT}
15593 This match key works along the same lines as the @code{Followup} match
15594 key. If you say that you want to score on a (sub-)thread started by an
15595 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
15596 match. This will add a new @samp{thread} match for each article that
15597 has @var{x} in its @code{References} header. (These new @samp{thread}
15598 matches will use the @code{Message-ID}s of these matching articles.)
15599 This will ensure that you can raise/lower the score of an entire thread,
15600 even though some articles in the thread may not have complete
15601 @code{References} headers. Note that using this may lead to
15602 undeterministic scores of the articles in the thread. (Using this match
15603 key will lead to creation of @file{ADAPT} files.)
15607 @cindex Score File Atoms
15609 The value of this entry should be a number. Any articles with a score
15610 lower than this number will be marked as read.
15613 The value of this entry should be a number. Any articles with a score
15614 lower than this number will be removed from the summary buffer.
15616 @item mark-and-expunge
15617 The value of this entry should be a number. Any articles with a score
15618 lower than this number will be marked as read and removed from the
15621 @item thread-mark-and-expunge
15622 The value of this entry should be a number. All articles that belong to
15623 a thread that has a total score below this number will be marked as read
15624 and removed from the summary buffer. @code{gnus-thread-score-function}