9 @documentencoding ISO-8859-1
12 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
13 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
16 Permission is granted to copy, distribute and/or modify this document
17 under the terms of the GNU Free Documentation License, Version 1.3 or
18 any later version published by the Free Software Foundation; with no
19 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
20 and with the Back-Cover Texts as in (a) below. A copy of the license
21 is included in the section entitled ``GNU Free Documentation License''.
23 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
24 modify this GNU manual. Buying copies from the FSF supports it in
25 developing GNU and promoting software freedom.''
31 \documentclass[twoside,a4paper,openright,11pt]{book}
32 \usepackage[latin1]{inputenc}
33 \usepackage{pagestyle}
36 \input{gnusconfig.tex}
38 \ifx\pdfoutput\undefined
40 \usepackage[pdftex,bookmarks,colorlinks=true]{hyperref}
48 % Adjust ../Makefile.in if you change the following line:
49 \newcommand{\gnusversionname}{No Gnus v0.11}
50 \newcommand{\gnuschaptername}{}
51 \newcommand{\gnussectionname}{}
53 \newcommand{\gnusbackslash}{/}
55 \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}}
56 \ifx\pdfoutput\undefined
57 \newcommand{\gnusuref}[1]{\gnustt{#1}}
59 \newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}}
61 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
62 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
64 \newcommand{\gnuskindex}[1]{\index{#1}}
65 \newcommand{\gnusindex}[1]{\index{#1}}
67 \newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}}
68 \newcommand{\gnuscode}[1]{\gnustt{#1}}
69 \newcommand{\gnusasis}[1]{\gnustt{#1}}
70 \newcommand{\gnusurl}[1]{\gnustt{#1}}
71 \newcommand{\gnuscommand}[1]{\gnustt{#1}}
72 \newcommand{\gnusenv}[1]{\gnustt{#1}}
73 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''}
74 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
75 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
76 \newcommand{\gnuskey}[1]{`\gnustt{#1}'}
77 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
78 \newcommand{\gnusdfn}[1]{\textit{#1}}
79 \newcommand{\gnusi}[1]{\textit{#1}}
80 \newcommand{\gnusr}[1]{\textrm{#1}}
81 \newcommand{\gnusstrong}[1]{\textbf{#1}}
82 \newcommand{\gnusemph}[1]{\textit{#1}}
83 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
84 \newcommand{\gnussc}[1]{\textsc{#1}}
85 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
86 \newcommand{\gnusversion}[1]{{\small\textit{#1}}}
87 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
88 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
89 \newcommand{\gnusacronym}[1]{\textsc{#1}}
90 \newcommand{\gnusemail}[1]{\textit{#1}}
92 \newcommand{\gnusbullet}{{${\bullet}$}}
93 \newcommand{\gnusdollar}{\$}
94 \newcommand{\gnusampersand}{\&}
95 \newcommand{\gnuspercent}{\%}
96 \newcommand{\gnushash}{\#}
97 \newcommand{\gnushat}{\symbol{"5E}}
98 \newcommand{\gnusunderline}{\symbol{"5F}}
99 \newcommand{\gnusnot}{$\neg$}
100 \newcommand{\gnustilde}{\symbol{"7E}}
101 \newcommand{\gnusless}{{$<$}}
102 \newcommand{\gnusgreater}{{$>$}}
103 \newcommand{\gnusbraceleft}{{$>$}}
104 \newcommand{\gnusbraceright}{{$>$}}
106 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}}
107 \newcommand{\gnusinteresting}{
108 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
111 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
113 \newcommand{\gnuspagechapter}[1]{
117 \newdimen{\gnusdimen}
120 \newcommand{\gnuschapter}[2]{
122 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
124 \renewcommand{\gnussectionname}{}
125 \renewcommand{\gnuschaptername}{#2}
126 \thispagestyle{empty}
128 \begin{picture}(500,500)(0,0)
129 \put(480,350){\makebox(0,0)[tr]{#1}}
130 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
135 \newcommand{\gnusfigure}[3]{
137 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
144 \newcommand{\gnusicon}[1]{
145 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}}
148 \newcommand{\gnuspicon}[1]{
149 \margindex{\epsfig{figure=#1,width=2cm}}
152 \newcommand{\gnusxface}[2]{
153 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
156 \newcommand{\gnussmiley}[2]{
157 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
160 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
162 \newcommand{\gnussection}[1]{
163 \renewcommand{\gnussectionname}{#1}
167 \newenvironment{codelist}%
172 \newenvironment{asislist}%
177 \newenvironment{kbdlist}%
183 \newenvironment{dfnlist}%
188 \newenvironment{stronglist}%
193 \newenvironment{samplist}%
198 \newenvironment{varlist}%
203 \newenvironment{emphlist}%
208 \newlength\gnusheadtextwidth
209 \setlength{\gnusheadtextwidth}{\headtextwidth}
210 \addtolength{\gnusheadtextwidth}{1cm}
212 \newpagestyle{gnuspreamble}%
217 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
221 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
230 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
232 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
237 \newpagestyle{gnusindex}%
242 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
246 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
254 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
256 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
266 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
270 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
278 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
280 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
285 \pagenumbering{roman}
286 \pagestyle{gnuspreamble}
297 %\addtolength{\oddsidemargin}{-5cm}
298 %\addtolength{\evensidemargin}{-5cm}
300 \addtolength{\textheight}{2cm}
302 \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\
305 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm}
308 \gnusauthor{by Lars Magne Ingebrigtsen}
315 \thispagestyle{empty}
325 * Gnus: (gnus). The newsreader Gnus.
335 @author by Lars Magne Ingebrigtsen
337 @vskip 0pt plus 1filll
345 @top The Gnus Newsreader
349 You can read news (and mail) from within Emacs by using Gnus. The news
350 can be gotten by any nefarious means you can think of---@acronym{NNTP}, local
351 spool or your mbox file. All at the same time, if you want to push your
354 @c Adjust ../Makefile.in if you change the following line:
355 This manual corresponds to No Gnus v0.11.
370 Gnus is the advanced, self-documenting, customizable, extensible
371 unreal-time newsreader for GNU Emacs.
373 Oops. That sounds oddly familiar, so let's start over again to avoid
374 being accused of plagiarism:
376 Gnus is a message-reading laboratory. It will let you look at just
377 about anything as if it were a newsgroup. You can read mail with it,
378 you can browse directories with it, you can @code{ftp} with it---you
379 can even read news with it!
381 Gnus tries to empower people who read news the same way Emacs empowers
382 people who edit text. Gnus sets no limits to what the user should be
383 allowed to do. Users are encouraged to extend Gnus to make it behave
384 like they want it to behave. A program should not control people;
385 people should be empowered to do what they want by using (or abusing)
388 @c Adjust ../Makefile.in if you change the following line:
389 This manual corresponds to No Gnus v0.11.
391 @heading Other related manuals
393 @item Message manual: Composing messages
394 @item Emacs-MIME: Composing messages; @acronym{MIME}-specific parts.
395 @item Sieve: Managing Sieve scripts in Emacs.
396 @item PGG: @acronym{PGP/MIME} with Gnus.
397 @item SASL: @acronym{SASL} authentication in Emacs.
403 * Starting Up:: Finding news can be a pain.
404 * Group Buffer:: Selecting, subscribing and killing groups.
405 * Summary Buffer:: Reading, saving and posting articles.
406 * Article Buffer:: Displaying and handling articles.
407 * Composing Messages:: Information on sending mail and news.
408 * Select Methods:: Gnus reads all messages from various select methods.
409 * Scoring:: Assigning values to articles.
410 * Various:: General purpose settings.
411 * The End:: Farewell and goodbye.
412 * Appendices:: Terminology, Emacs intro, @acronym{FAQ}, History, Internals.
413 * GNU Free Documentation License:: The license for this documentation.
414 * Index:: Variable, function and concept index.
415 * Key Index:: Key Index.
417 Other related manuals
419 * Message:(message). Composing messages.
420 * Emacs-MIME:(emacs-mime). Composing messages; @acronym{MIME}-specific parts.
421 * Sieve:(sieve). Managing Sieve scripts in Emacs.
422 * PGG:(pgg). @acronym{PGP/MIME} with Gnus.
423 * SASL:(sasl). @acronym{SASL} authentication in Emacs.
426 --- The Detailed Node Listing ---
430 * Finding the News:: Choosing a method for getting news.
431 * The First Time:: What does Gnus do the first time you start it?
432 * The Server is Down:: How can I read my mail then?
433 * Slave Gnusae:: You can have more than one Gnus active at a time.
434 * Fetching a Group:: Starting Gnus just to read a group.
435 * New Groups:: What is Gnus supposed to do with new groups?
436 * Changing Servers:: You may want to move from one server to another.
437 * Startup Files:: Those pesky startup files---@file{.newsrc}.
438 * Auto Save:: Recovering from a crash.
439 * The Active File:: Reading the active file over a slow line Takes Time.
440 * Startup Variables:: Other variables you might change.
444 * Checking New Groups:: Determining what groups are new.
445 * Subscription Methods:: What Gnus should do with new groups.
446 * Filtering New Groups:: Making Gnus ignore certain new groups.
450 * Group Buffer Format:: Information listed and how you can change it.
451 * Group Maneuvering:: Commands for moving in the group buffer.
452 * Selecting a Group:: Actually reading news.
453 * Subscription Commands:: Unsubscribing, killing, subscribing.
454 * Group Data:: Changing the info for a group.
455 * Group Levels:: Levels? What are those, then?
456 * Group Score:: A mechanism for finding out what groups you like.
457 * Marking Groups:: You can mark groups for later processing.
458 * Foreign Groups:: Creating and editing groups.
459 * Group Parameters:: Each group may have different parameters set.
460 * Listing Groups:: Gnus can list various subsets of the groups.
461 * Sorting Groups:: Re-arrange the group order.
462 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
463 * Browse Foreign Server:: You can browse a server. See what it has to offer.
464 * Exiting Gnus:: Stop reading news and get some work done.
465 * Group Topics:: A folding group mode divided into topics.
466 * Non-ASCII Group Names:: Accessing groups of non-English names.
467 * Misc Group Stuff:: Other stuff that you can to do.
471 * Group Line Specification:: Deciding how the group buffer is to look.
472 * Group Mode Line Specification:: The group buffer mode line.
473 * Group Highlighting:: Having nice colors in the group buffer.
477 * Topic Commands:: Interactive E-Z commands.
478 * Topic Variables:: How to customize the topics the Lisp Way.
479 * Topic Sorting:: Sorting each topic individually.
480 * Topic Topology:: A map of the world.
481 * Topic Parameters:: Parameters that apply to all groups in a topic.
485 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
486 * Group Information:: Information and help on groups and Gnus.
487 * Group Timestamp:: Making Gnus keep track of when you last read a group.
488 * File Commands:: Reading and writing the Gnus files.
489 * Sieve Commands:: Managing Sieve scripts.
493 * Summary Buffer Format:: Deciding how the summary buffer is to look.
494 * Summary Maneuvering:: Moving around the summary buffer.
495 * Choosing Articles:: Reading articles.
496 * Paging the Article:: Scrolling the current article.
497 * Reply Followup and Post:: Posting articles.
498 * Delayed Articles:: Send articles at a later time.
499 * Marking Articles:: Marking articles as read, expirable, etc.
500 * Limiting:: You can limit the summary buffer.
501 * Threading:: How threads are made.
502 * Sorting the Summary Buffer:: How articles and threads are sorted.
503 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
504 * Article Caching:: You may store articles in a cache.
505 * Persistent Articles:: Making articles expiry-resistant.
506 * Sticky Articles:: Article buffers that are not reused.
507 * Article Backlog:: Having already read articles hang around.
508 * Saving Articles:: Ways of customizing article saving.
509 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
510 * Article Treatment:: The article buffer can be mangled at will.
511 * MIME Commands:: Doing MIMEy things with the articles.
512 * Charsets:: Character set issues.
513 * Article Commands:: Doing various things with the article buffer.
514 * Summary Sorting:: Sorting the summary buffer in various ways.
515 * Finding the Parent:: No child support? Get the parent.
516 * Alternative Approaches:: Reading using non-default summaries.
517 * Tree Display:: A more visual display of threads.
518 * Mail Group Commands:: Some commands can only be used in mail groups.
519 * Various Summary Stuff:: What didn't fit anywhere else.
520 * Exiting the Summary Buffer:: Returning to the Group buffer,
521 or reselecting the current group.
522 * Crosspost Handling:: How crossposted articles are dealt with.
523 * Duplicate Suppression:: An alternative when crosspost handling fails.
524 * Security:: Decrypt and Verify.
525 * Mailing List:: Mailing list minor mode.
527 Summary Buffer Format
529 * Summary Buffer Lines:: You can specify how summary lines should look.
530 * To From Newsgroups:: How to not display your own name.
531 * Summary Buffer Mode Line:: You can say how the mode line should look.
532 * Summary Highlighting:: Making the summary buffer all pretty and nice.
536 * Choosing Commands:: Commands for choosing articles.
537 * Choosing Variables:: Variables that influence these commands.
539 Reply, Followup and Post
541 * Summary Mail Commands:: Sending mail.
542 * Summary Post Commands:: Sending news.
543 * Summary Message Commands:: Other Message-related commands.
544 * Canceling and Superseding::
548 * Unread Articles:: Marks for unread articles.
549 * Read Articles:: Marks for read articles.
550 * Other Marks:: Marks that do not affect readedness.
551 * Setting Marks:: How to set and remove marks.
552 * Generic Marking Commands:: How to customize the marking.
553 * Setting Process Marks:: How to mark articles for later processing.
557 * Customizing Threading:: Variables you can change to affect the threading.
558 * Thread Commands:: Thread based commands in the summary buffer.
560 Customizing Threading
562 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
563 * Filling In Threads:: Making the threads displayed look fuller.
564 * More Threading:: Even more variables for fiddling with threads.
565 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
569 * Uuencoded Articles:: Uudecode articles.
570 * Shell Archives:: Unshar articles.
571 * PostScript Files:: Split PostScript.
572 * Other Files:: Plain save and binhex.
573 * Decoding Variables:: Variables for a happy decoding.
574 * Viewing Files:: You want to look at the result of the decoding?
578 * Rule Variables:: Variables that say how a file is to be viewed.
579 * Other Decode Variables:: Other decode variables.
580 * Uuencoding and Posting:: Variables for customizing uuencoding.
584 * Article Highlighting:: You want to make the article look like fruit salad.
585 * Article Fontisizing:: Making emphasized text look nice.
586 * Article Hiding:: You also want to make certain info go away.
587 * Article Washing:: Lots of way-neat functions to make life better.
588 * Article Header:: Doing various header transformations.
589 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
590 * Article Button Levels:: Controlling appearance of buttons.
591 * Article Date:: Grumble, UT!
592 * Article Display:: Display various stuff---X-Face, Picons, Smileys, Gravatars
593 * Article Signature:: What is a signature?
594 * Article Miscellanea:: Various other stuff.
596 Alternative Approaches
598 * Pick and Read:: First mark articles and then read them.
599 * Binary Groups:: Auto-decode all articles.
601 Various Summary Stuff
603 * Summary Group Information:: Information oriented commands.
604 * Searching for Articles:: Multiple article commands.
605 * Summary Generation Commands::
606 * Really Various Summary Commands:: Those pesky non-conformant commands.
610 * Hiding Headers:: Deciding what headers should be displayed.
611 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
612 * Customizing Articles:: Tailoring the look of the articles.
613 * Article Keymap:: Keystrokes available in the article buffer.
614 * Misc Article:: Other stuff.
618 * Mail:: Mailing and replying.
619 * Posting Server:: What server should you post and mail via?
620 * POP before SMTP:: You cannot send a mail unless you read a mail.
621 * Mail and Post:: Mailing and posting at the same time.
622 * Archived Messages:: Where Gnus stores the messages you've sent.
623 * Posting Styles:: An easier way to specify who you are.
624 * Drafts:: Postponing messages and rejected messages.
625 * Rejected Articles:: What happens if the server doesn't like your article?
626 * Signing and encrypting:: How to compose secure messages.
630 * Server Buffer:: Making and editing virtual servers.
631 * Getting News:: Reading USENET news with Gnus.
632 * Using IMAP:: Reading mail from @acronym{IMAP}.
633 * Getting Mail:: Reading your personal mail with Gnus.
634 * Browsing the Web:: Getting messages from a plethora of Web sources.
635 * Other Sources:: Reading directories, files.
636 * Combined Groups:: Combining groups into one group.
637 * Email Based Diary:: Using mails to manage diary events in Gnus.
638 * Gnus Unplugged:: Reading news and mail offline.
642 * Server Buffer Format:: You can customize the look of this buffer.
643 * Server Commands:: Commands to manipulate servers.
644 * Example Methods:: Examples server specifications.
645 * Creating a Virtual Server:: An example session.
646 * Server Variables:: Which variables to set.
647 * Servers and Methods:: You can use server names as select methods.
648 * Unavailable Servers:: Some servers you try to contact may be down.
652 * NNTP:: Reading news from an @acronym{NNTP} server.
653 * News Spool:: Reading news from the local spool.
657 * Direct Functions:: Connecting directly to the server.
658 * Indirect Functions:: Connecting indirectly to the server.
659 * Common Variables:: Understood by several connection functions.
660 * NNTP marks:: Storing marks for @acronym{NNTP} servers.
664 * Mail in a Newsreader:: Important introductory notes.
665 * Getting Started Reading Mail:: A simple cookbook example.
666 * Splitting Mail:: How to create mail groups.
667 * Mail Sources:: How to tell Gnus where to get mail from.
668 * Mail Back End Variables:: Variables for customizing mail handling.
669 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
670 * Group Mail Splitting:: Use group customize to drive mail splitting.
671 * Incorporating Old Mail:: What about the old mail you have?
672 * Expiring Mail:: Getting rid of unwanted mail.
673 * Washing Mail:: Removing cruft from the mail you get.
674 * Duplicates:: Dealing with duplicated mail.
675 * Not Reading Mail:: Using mail back ends for reading other files.
676 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
680 * Mail Source Specifiers:: How to specify what a mail source is.
681 * Mail Source Customization:: Some variables that influence things.
682 * Fetching Mail:: Using the mail source specifiers.
684 Choosing a Mail Back End
686 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
687 * Babyl:: Babyl was used by older versions of Rmail.
688 * Mail Spool:: Store your mail in a private spool?
689 * MH Spool:: An mhspool-like back end.
690 * Maildir:: Another one-file-per-message format.
691 * Mail Folders:: Having one file for each group.
692 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
697 * Web Searches:: Creating groups from articles that match a string.
698 * RSS:: Reading RDF site summary.
699 * Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
703 * Directory Groups:: You can read a directory as if it was a newsgroup.
704 * Anything Groups:: Dired? Who needs dired?
705 * Document Groups:: Single files can be the basis of a group.
706 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
710 * Document Server Internals:: How to add your own document types.
714 * Virtual Groups:: Combining articles from many groups.
718 * The NNDiary Back End:: Basic setup and usage.
719 * The Gnus Diary Library:: Utility toolkit on top of nndiary.
720 * Sending or Not Sending:: A final note on sending diary messages.
724 * Diary Messages:: What makes a message valid for nndiary.
725 * Running NNDiary:: NNDiary has two modes of operation.
726 * Customizing NNDiary:: Bells and whistles.
728 The Gnus Diary Library
730 * Diary Summary Line Format:: A nicer summary buffer line format.
731 * Diary Articles Sorting:: A nicer way to sort messages.
732 * Diary Headers Generation:: Not doing it manually.
733 * Diary Group Parameters:: Not handling them manually.
737 * Agent Basics:: How it all is supposed to work.
738 * Agent Categories:: How to tell the Gnus Agent what to download.
739 * Agent Commands:: New commands for all the buffers.
740 * Agent Visuals:: Ways that the agent may effect your summary buffer.
741 * Agent as Cache:: The Agent is a big cache too.
742 * Agent Expiry:: How to make old articles go away.
743 * Agent Regeneration:: How to recover from lost connections and other accidents.
744 * Agent and flags:: How the Agent maintains flags.
745 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
746 * Outgoing Messages:: What happens when you post/mail something?
747 * Agent Variables:: Customizing is fun.
748 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
749 * Batching Agents:: How to fetch news from a @code{cron} job.
750 * Agent Caveats:: What you think it'll do and what it does.
754 * Category Syntax:: What a category looks like.
755 * Category Buffer:: A buffer for maintaining categories.
756 * Category Variables:: Customize'r'Us.
760 * Group Agent Commands:: Configure groups and fetch their contents.
761 * Summary Agent Commands:: Manually select then fetch specific articles.
762 * Server Agent Commands:: Select the servers that are supported by the agent.
766 * Summary Score Commands:: Adding score entries for the current group.
767 * Group Score Commands:: General score commands.
768 * Score Variables:: Customize your scoring. (My, what terminology).
769 * Score File Format:: What a score file may contain.
770 * Score File Editing:: You can edit score files by hand as well.
771 * Adaptive Scoring:: Big Sister Gnus knows what you read.
772 * Home Score File:: How to say where new score entries are to go.
773 * Followups To Yourself:: Having Gnus notice when people answer you.
774 * Scoring On Other Headers:: Scoring on non-standard headers.
775 * Scoring Tips:: How to score effectively.
776 * Reverse Scoring:: That problem child of old is not problem.
777 * Global Score Files:: Earth-spanning, ear-splitting score files.
778 * Kill Files:: They are still here, but they can be ignored.
779 * Converting Kill Files:: Translating kill files to score files.
780 * Advanced Scoring:: Using logical expressions to build score rules.
781 * Score Decays:: It can be useful to let scores wither away.
785 * Advanced Scoring Syntax:: A definition.
786 * Advanced Scoring Examples:: What they look like.
787 * Advanced Scoring Tips:: Getting the most out of it.
791 * Process/Prefix:: A convention used by many treatment commands.
792 * Interactive:: Making Gnus ask you many questions.
793 * Symbolic Prefixes:: How to supply some Gnus functions with options.
794 * Formatting Variables:: You can specify what buffers should look like.
795 * Window Layout:: Configuring the Gnus buffer windows.
796 * Faces and Fonts:: How to change how faces look.
797 * Compilation:: How to speed Gnus up.
798 * Mode Lines:: Displaying information in the mode lines.
799 * Highlighting and Menus:: Making buffers look all nice and cozy.
800 * Daemons:: Gnus can do things behind your back.
801 * Undo:: Some actions can be undone.
802 * Predicate Specifiers:: Specifying predicates.
803 * Moderation:: What to do if you're a moderator.
804 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
805 * Fuzzy Matching:: What's the big fuzz?
806 * Thwarting Email Spam:: Simple ways to avoid unsolicited commercial email.
807 * Spam Package:: A package for filtering and processing spam.
808 * The Gnus Registry:: A package for tracking messages by Message-ID.
809 * Other modes:: Interaction with other modes.
810 * Various Various:: Things that are really various.
814 * Formatting Basics:: A formatting variable is basically a format string.
815 * Mode Line Formatting:: Some rules about mode line formatting variables.
816 * Advanced Formatting:: Modifying output in various ways.
817 * User-Defined Specs:: Having Gnus call your own functions.
818 * Formatting Fonts:: Making the formatting look colorful and nice.
819 * Positioning Point:: Moving point to a position after an operation.
820 * Tabulation:: Tabulating your output.
821 * Wide Characters:: Dealing with wide characters.
825 * X-Face:: Display a funky, teensy black-and-white image.
826 * Face:: Display a funkier, teensier colored image.
827 * Smileys:: Show all those happy faces the way they were
829 * Picons:: How to display pictures of what you're reading.
830 * Gravatars:: Display the avatar of people you read.
831 * XVarious:: Other XEmacsy Gnusey variables.
835 * The problem of spam:: Some background, and some solutions
836 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
837 * SpamAssassin:: How to use external anti-spam tools.
838 * Hashcash:: Reduce spam by burning CPU time.
842 * Spam Package Introduction::
843 * Filtering Incoming Mail::
844 * Detecting Spam in Groups::
845 * Spam and Ham Processors::
846 * Spam Package Configuration Examples::
848 * Extending the Spam package::
849 * Spam Statistics Package::
851 Spam Statistics Package
853 * Creating a spam-stat dictionary::
854 * Splitting mail using spam-stat::
855 * Low-level interface to the spam-stat dictionary::
859 * XEmacs:: Requirements for installing under XEmacs.
860 * History:: How Gnus got where it is today.
861 * On Writing Manuals:: Why this is not a beginner's guide.
862 * Terminology:: We use really difficult, like, words here.
863 * Customization:: Tailoring Gnus to your needs.
864 * Troubleshooting:: What you might try if things do not work.
865 * Gnus Reference Guide:: Rilly, rilly technical stuff.
866 * Emacs for Heathens:: A short introduction to Emacsian terms.
867 * Frequently Asked Questions:: The Gnus FAQ
871 * Gnus Versions:: What Gnus versions have been released.
872 * Other Gnus Versions:: Other Gnus versions that also have been released.
873 * Why?:: What's the point of Gnus?
874 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
875 * Conformity:: Gnus tries to conform to all standards.
876 * Emacsen:: Gnus can be run on a few modern Emacsen.
877 * Gnus Development:: How Gnus is developed.
878 * Contributors:: Oodles of people.
879 * New Features:: Pointers to some of the new stuff in Gnus.
883 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
884 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
885 * Red Gnus:: Third time best---Gnus 5.4/5.5.
886 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
887 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
888 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
889 * No Gnus:: Very punny.
893 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
894 * Slow Terminal Connection:: You run a remote Emacs.
895 * Little Disk Space:: You feel that having large setup files is icky.
896 * Slow Machine:: You feel like buying a faster machine.
900 * Gnus Utility Functions:: Common functions and variable to use.
901 * Back End Interface:: How Gnus communicates with the servers.
902 * Score File Syntax:: A BNF definition of the score file standard.
903 * Headers:: How Gnus stores headers internally.
904 * Ranges:: A handy format for storing mucho numbers.
905 * Group Info:: The group info format.
906 * Extended Interactive:: Symbolic prefixes and stuff.
907 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
908 * Various File Formats:: Formats of files that Gnus use.
912 * Required Back End Functions:: Functions that must be implemented.
913 * Optional Back End Functions:: Functions that need not be implemented.
914 * Error Messaging:: How to get messages and report errors.
915 * Writing New Back Ends:: Extending old back ends.
916 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
917 * Mail-like Back Ends:: Some tips on mail back ends.
921 * Active File Format:: Information on articles and groups available.
922 * Newsgroups File Format:: Group descriptions.
926 * Keystrokes:: Entering text and executing commands.
927 * Emacs Lisp:: The built-in Emacs programming language.
933 @chapter Starting Gnus
936 If you haven't used Emacs much before using Gnus, read @ref{Emacs for
941 If your system administrator has set things up properly, starting Gnus
942 and reading news is extremely easy---you just type @kbd{M-x gnus} in
943 your Emacs. If not, you should customize the variable
944 @code{gnus-select-method} as described in @ref{Finding the News}. For a
945 minimal setup for posting should also customize the variables
946 @code{user-full-name} and @code{user-mail-address}.
948 @findex gnus-other-frame
949 @kindex M-x gnus-other-frame
950 If you want to start Gnus in a different frame, you can use the command
951 @kbd{M-x gnus-other-frame} instead.
953 If things do not go smoothly at startup, you have to twiddle some
954 variables in your @file{~/.gnus.el} file. This file is similar to
955 @file{~/.emacs}, but is read when Gnus starts.
957 If you puzzle at any terms used in this manual, please refer to the
958 terminology section (@pxref{Terminology}).
961 * Finding the News:: Choosing a method for getting news.
962 * The First Time:: What does Gnus do the first time you start it?
963 * The Server is Down:: How can I read my mail then?
964 * Slave Gnusae:: You can have more than one Gnus active at a time.
965 * New Groups:: What is Gnus supposed to do with new groups?
966 * Changing Servers:: You may want to move from one server to another.
967 * Startup Files:: Those pesky startup files---@file{.newsrc}.
968 * Auto Save:: Recovering from a crash.
969 * The Active File:: Reading the active file over a slow line Takes Time.
970 * Startup Variables:: Other variables you might change.
974 @node Finding the News
975 @section Finding the News
978 First of all, you should know that there is a special buffer called
979 @code{*Server*} that lists all the servers Gnus knows about. You can
980 press @kbd{^} from the Group buffer to see it. In the Server buffer,
981 you can press @kbd{RET} on a defined server to see all the groups it
982 serves (subscribed or not!). You can also add or delete servers, edit
983 a foreign server's definition, agentize or de-agentize a server, and
984 do many other neat things. @xref{Server Buffer}.
985 @xref{Foreign Groups}. @xref{Agent Basics}.
987 @vindex gnus-select-method
989 The @code{gnus-select-method} variable says where Gnus should look for
990 news. This variable should be a list where the first element says
991 @dfn{how} and the second element says @dfn{where}. This method is your
992 native method. All groups not fetched with this method are
995 For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where
996 you want to get your daily dosage of news from, you'd say:
999 (setq gnus-select-method '(nntp "news.somewhere.edu"))
1002 If you want to read directly from the local spool, say:
1005 (setq gnus-select-method '(nnspool ""))
1008 If you can use a local spool, you probably should, as it will almost
1009 certainly be much faster. But do not use the local spool if your
1010 server is running Leafnode (which is a simple, standalone private news
1011 server); in this case, use @code{(nntp "localhost")}.
1013 @vindex gnus-nntpserver-file
1015 @cindex @acronym{NNTP} server
1016 If this variable is not set, Gnus will take a look at the
1017 @env{NNTPSERVER} environment variable. If that variable isn't set,
1018 Gnus will see whether @code{gnus-nntpserver-file}
1019 (@file{/etc/nntpserver} by default) has any opinions on the matter.
1020 If that fails as well, Gnus will try to use the machine running Emacs
1021 as an @acronym{NNTP} server. That's a long shot, though.
1023 @vindex gnus-nntp-server
1024 If @code{gnus-nntp-server} is set, this variable will override
1025 @code{gnus-select-method}. You should therefore set
1026 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1028 @vindex gnus-secondary-servers
1029 @vindex gnus-nntp-server
1030 You can also make Gnus prompt you interactively for the name of an
1031 @acronym{NNTP} server. If you give a non-numerical prefix to @code{gnus}
1032 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
1033 in the @code{gnus-secondary-servers} list (if any). You can also just
1034 type in the name of any server you feel like visiting. (Note that this
1035 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1036 gnus} later in the same Emacs session, Gnus will contact the same
1039 @findex gnus-group-browse-foreign-server
1041 However, if you use one @acronym{NNTP} server regularly and are just
1042 interested in a couple of groups from a different server, you would be
1043 better served by using the @kbd{B} command in the group buffer. It will
1044 let you have a look at what groups are available, and you can subscribe
1045 to any of the groups you want to. This also makes @file{.newsrc}
1046 maintenance much tidier. @xref{Foreign Groups}.
1048 @vindex gnus-secondary-select-methods
1050 A slightly different approach to foreign groups is to set the
1051 @code{gnus-secondary-select-methods} variable. The select methods
1052 listed in this variable are in many ways just as native as the
1053 @code{gnus-select-method} server. They will also be queried for active
1054 files during startup (if that's required), and new newsgroups that
1055 appear on these servers will be subscribed (or not) just as native
1058 For instance, if you use the @code{nnmbox} back end to read your mail,
1059 you would typically set this variable to
1062 (setq gnus-secondary-select-methods '((nnmbox "")))
1065 Note: the @acronym{NNTP} back end stores marks in marks files
1066 (@pxref{NNTP marks}). This feature makes it easy to share marks between
1067 several Gnus installations, but may slow down things a bit when fetching
1068 new articles. @xref{NNTP marks}, for more information.
1071 @node The First Time
1072 @section The First Time
1073 @cindex first time usage
1075 If no startup files exist (@pxref{Startup Files}), Gnus will try to
1076 determine what groups should be subscribed by default.
1078 @vindex gnus-default-subscribed-newsgroups
1079 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
1080 will subscribe you to just those groups in that list, leaving the rest
1081 killed. Your system administrator should have set this variable to
1084 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
1085 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1086 here as @dfn{whatever Lars thinks you should read}.)
1088 You'll also be subscribed to the Gnus documentation group, which should
1089 help you with most common problems.
1091 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
1092 use the normal functions for handling new groups, and not do anything
1096 @node The Server is Down
1097 @section The Server is Down
1098 @cindex server errors
1100 If the default server is down, Gnus will understandably have some
1101 problems starting. However, if you have some mail groups in addition to
1102 the news groups, you may want to start Gnus anyway.
1104 Gnus, being the trusting sort of program, will ask whether to proceed
1105 without a native select method if that server can't be contacted. This
1106 will happen whether the server doesn't actually exist (i.e., you have
1107 given the wrong address) or the server has just momentarily taken ill
1108 for some reason or other. If you decide to continue and have no foreign
1109 groups, you'll find it difficult to actually do anything in the group
1110 buffer. But, hey, that's your problem. Blllrph!
1112 @findex gnus-no-server
1113 @kindex M-x gnus-no-server
1115 If you know that the server is definitely down, or you just want to read
1116 your mail without bothering with the server at all, you can use the
1117 @code{gnus-no-server} command to start Gnus. That might come in handy
1118 if you're in a hurry as well. This command will not attempt to contact
1119 your primary server---instead, it will just activate all groups on level
1120 1 and 2. (You should preferably keep no native groups on those two
1121 levels.) Also @pxref{Group Levels}.
1125 @section Slave Gnusae
1128 You might want to run more than one Emacs with more than one Gnus at the
1129 same time. If you are using different @file{.newsrc} files (e.g., if you
1130 are using the two different Gnusae to read from two different servers),
1131 that is no problem whatsoever. You just do it.
1133 The problem appears when you want to run two Gnusae that use the same
1134 @file{.newsrc} file.
1136 To work around that problem some, we here at the Think-Tank at the Gnus
1137 Towers have come up with a new concept: @dfn{Masters} and
1138 @dfn{slaves}. (We have applied for a patent on this concept, and have
1139 taken out a copyright on those words. If you wish to use those words in
1140 conjunction with each other, you have to send $1 per usage instance to
1141 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1142 Applications}) will be much more expensive, of course.)
1145 Anyway, you start one Gnus up the normal way with @kbd{M-x gnus} (or
1146 however you do it). Each subsequent slave Gnusae should be started with
1147 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1148 files, but instead save @dfn{slave files} that contain information only
1149 on what groups have been read in the slave session. When a master Gnus
1150 starts, it will read (and delete) these slave files, incorporating all
1151 information from them. (The slave files will be read in the sequence
1152 they were created, so the latest changes will have precedence.)
1154 Information from the slave files has, of course, precedence over the
1155 information in the normal (i.e., master) @file{.newsrc} file.
1157 If the @file{.newsrc*} files have not been saved in the master when the
1158 slave starts, you may be prompted as to whether to read an auto-save
1159 file. If you answer ``yes'', the unsaved changes to the master will be
1160 incorporated into the slave. If you answer ``no'', the slave may see some
1161 messages as unread that have been read in the master.
1168 @cindex subscription
1170 @vindex gnus-check-new-newsgroups
1171 If you are satisfied that you really never want to see any new groups,
1172 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1173 also save you some time at startup. Even if this variable is
1174 @code{nil}, you can always subscribe to the new groups just by pressing
1175 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1176 is @code{ask-server} by default. If you set this variable to
1177 @code{always}, then Gnus will query the back ends for new groups even
1178 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1181 * Checking New Groups:: Determining what groups are new.
1182 * Subscription Methods:: What Gnus should do with new groups.
1183 * Filtering New Groups:: Making Gnus ignore certain new groups.
1187 @node Checking New Groups
1188 @subsection Checking New Groups
1190 Gnus normally determines whether a group is new or not by comparing the
1191 list of groups from the active file(s) with the lists of subscribed and
1192 dead groups. This isn't a particularly fast method. If
1193 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
1194 server for new groups since the last time. This is both faster and
1195 cheaper. This also means that you can get rid of the list of killed
1196 groups altogether, so you may set @code{gnus-save-killed-list} to
1197 @code{nil}, which will save time both at startup, at exit, and all over.
1198 Saves disk space, too. Why isn't this the default, then?
1199 Unfortunately, not all servers support this command.
1201 I bet I know what you're thinking now: How do I find out whether my
1202 server supports @code{ask-server}? No? Good, because I don't have a
1203 fail-safe answer. I would suggest just setting this variable to
1204 @code{ask-server} and see whether any new groups appear within the next
1205 few days. If any do, then it works. If none do, then it doesn't
1206 work. I could write a function to make Gnus guess whether the server
1207 supports @code{ask-server}, but it would just be a guess. So I won't.
1208 You could @code{telnet} to the server and say @code{HELP} and see
1209 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1210 it does, then it might work. (But there are servers that lists
1211 @samp{NEWGROUPS} without supporting the function properly.)
1213 This variable can also be a list of select methods. If so, Gnus will
1214 issue an @code{ask-server} command to each of the select methods, and
1215 subscribe them (or not) using the normal methods. This might be handy
1216 if you are monitoring a few servers for new groups. A side effect is
1217 that startup will take much longer, so you can meditate while waiting.
1218 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1221 @node Subscription Methods
1222 @subsection Subscription Methods
1224 @vindex gnus-subscribe-newsgroup-method
1225 What Gnus does when it encounters a new group is determined by the
1226 @code{gnus-subscribe-newsgroup-method} variable.
1228 This variable should contain a function. This function will be called
1229 with the name of the new group as the only parameter.
1231 Some handy pre-fab functions are:
1235 @item gnus-subscribe-zombies
1236 @vindex gnus-subscribe-zombies
1237 Make all new groups zombies. This is the default. You can browse the
1238 zombies later (with @kbd{A z}) and either kill them all off properly
1239 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1241 @item gnus-subscribe-randomly
1242 @vindex gnus-subscribe-randomly
1243 Subscribe all new groups in arbitrary order. This really means that all
1244 new groups will be added at ``the top'' of the group buffer.
1246 @item gnus-subscribe-alphabetically
1247 @vindex gnus-subscribe-alphabetically
1248 Subscribe all new groups in alphabetical order.
1250 @item gnus-subscribe-hierarchically
1251 @vindex gnus-subscribe-hierarchically
1252 Subscribe all new groups hierarchically. The difference between this
1253 function and @code{gnus-subscribe-alphabetically} is slight.
1254 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1255 alphabetical fashion, while this function will enter groups into its
1256 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1257 @samp{comp} hierarchy, this function will not mess that configuration
1258 up. Or something like that.
1260 @item gnus-subscribe-interactively
1261 @vindex gnus-subscribe-interactively
1262 Subscribe new groups interactively. This means that Gnus will ask
1263 you about @strong{all} new groups. The groups you choose to subscribe
1264 to will be subscribed hierarchically.
1266 @item gnus-subscribe-killed
1267 @vindex gnus-subscribe-killed
1268 Kill all new groups.
1270 @item gnus-subscribe-topics
1271 @vindex gnus-subscribe-topics
1272 Put the groups into the topic that has a matching @code{subscribe} topic
1273 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1274 topic parameter that looks like
1280 will mean that all groups that match that regex will be subscribed under
1283 If no topics match the groups, the groups will be subscribed in the
1288 @vindex gnus-subscribe-hierarchical-interactive
1289 A closely related variable is
1290 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1291 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
1292 hierarchical fashion whether to subscribe to new groups or not. Gnus
1293 will ask you for each sub-hierarchy whether you want to descend the
1296 One common mistake is to set the variable a few paragraphs above
1297 (@code{gnus-subscribe-newsgroup-method}) to
1298 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1299 will not work. This is ga-ga. So don't do it.
1302 @node Filtering New Groups
1303 @subsection Filtering New Groups
1305 A nice and portable way to control which new newsgroups should be
1306 subscribed (or ignored) is to put an @dfn{options} line at the start of
1307 the @file{.newsrc} file. Here's an example:
1310 options -n !alt.all !rec.all sci.all
1313 @vindex gnus-subscribe-options-newsgroup-method
1314 This line obviously belongs to a serious-minded intellectual scientific
1315 person (or she may just be plain old boring), because it says that all
1316 groups that have names beginning with @samp{alt} and @samp{rec} should
1317 be ignored, and all groups with names beginning with @samp{sci} should
1318 be subscribed. Gnus will not use the normal subscription method for
1319 subscribing these groups.
1320 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1321 variable defaults to @code{gnus-subscribe-alphabetically}.
1323 @vindex gnus-options-not-subscribe
1324 @vindex gnus-options-subscribe
1325 If you don't want to mess with your @file{.newsrc} file, you can just
1326 set the two variables @code{gnus-options-subscribe} and
1327 @code{gnus-options-not-subscribe}. These two variables do exactly the
1328 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1329 and if the new group matches the former, it will be unconditionally
1330 subscribed, and if it matches the latter, it will be ignored.
1332 @vindex gnus-auto-subscribed-groups
1333 Yet another variable that meddles here is
1334 @code{gnus-auto-subscribed-groups}. It works exactly like
1335 @code{gnus-options-subscribe}, and is therefore really superfluous,
1336 but I thought it would be nice to have two of these. This variable is
1337 more meant for setting some ground rules, while the other variable is
1338 used more for user fiddling. By default this variable makes all new
1339 groups that come from mail back ends (@code{nnml}, @code{nnbabyl},
1340 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir})
1341 subscribed. If you don't like that, just set this variable to
1344 New groups that match this regexp are subscribed using
1345 @code{gnus-subscribe-options-newsgroup-method}.
1348 @node Changing Servers
1349 @section Changing Servers
1350 @cindex changing servers
1352 Sometimes it is necessary to move from one @acronym{NNTP} server to another.
1353 This happens very rarely, but perhaps you change jobs, or one server is
1354 very flaky and you want to use another.
1356 Changing the server is pretty easy, right? You just change
1357 @code{gnus-select-method} to point to the new server?
1361 Article numbers are not (in any way) kept synchronized between different
1362 @acronym{NNTP} servers, and the only way Gnus keeps track of what articles
1363 you have read is by keeping track of article numbers. So when you
1364 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1367 @kindex M-x gnus-group-clear-data-on-native-groups
1368 @findex gnus-group-clear-data-on-native-groups
1369 You can use the @kbd{M-x gnus-group-clear-data-on-native-groups}
1370 command to clear out all data that you have on your native groups.
1373 @kindex M-x gnus-group-clear-data
1374 @findex gnus-group-clear-data
1375 Clear the data from the current group only---nix out marks and the
1376 list of read articles (@code{gnus-group-clear-data}).
1378 After changing servers, you @strong{must} move the cache hierarchy away,
1379 since the cached articles will have wrong article numbers, which will
1380 affect which articles Gnus thinks are read.
1381 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1382 to have it done automatically; for @code{gnus-group-clear-data}, you
1383 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1384 cache for all groups).
1388 @section Startup Files
1389 @cindex startup files
1394 Most common Unix news readers use a shared startup file called
1395 @file{.newsrc}. This file contains all the information about what
1396 groups are subscribed, and which articles in these groups have been
1399 Things got a bit more complicated with @sc{gnus}. In addition to
1400 keeping the @file{.newsrc} file updated, it also used a file called
1401 @file{.newsrc.el} for storing all the information that didn't fit into
1402 the @file{.newsrc} file. (Actually, it also duplicated everything in
1403 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1404 files was the most recently saved, which enabled people to swap between
1405 @sc{gnus} and other newsreaders.
1407 That was kinda silly, so Gnus went one better: In addition to the
1408 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1409 @file{.newsrc.eld}. It will read whichever of these files that are most
1410 recent, but it will never write a @file{.newsrc.el} file. You should
1411 never delete the @file{.newsrc.eld} file---it contains much information
1412 not stored in the @file{.newsrc} file.
1414 @vindex gnus-save-newsrc-file
1415 @vindex gnus-read-newsrc-file
1416 You can turn off writing the @file{.newsrc} file by setting
1417 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1418 the file and save some space, as well as exiting from Gnus faster.
1419 However, this will make it impossible to use other newsreaders than
1420 Gnus. But hey, who would want to, right? Similarly, setting
1421 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
1422 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which can be
1423 convenient if you use a different news reader occasionally, and you
1424 want to read a different subset of the available groups with that
1427 @vindex gnus-save-killed-list
1428 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1429 will not save the list of killed groups to the startup file. This will
1430 save both time (when starting and quitting) and space (on disk). It
1431 will also mean that Gnus has no record of what groups are new or old,
1432 so the automatic new groups subscription methods become meaningless.
1433 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1434 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1435 Groups}). This variable can also be a regular expression. If that's
1436 the case, remove all groups that do not match this regexp before
1437 saving. This can be useful in certain obscure situations that involve
1438 several servers where not all servers support @code{ask-server}.
1440 @vindex gnus-startup-file
1441 @vindex gnus-backup-startup-file
1442 @vindex version-control
1443 The @code{gnus-startup-file} variable says where the startup files are.
1444 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1445 file being whatever that one is, with a @samp{.eld} appended.
1446 If you want version control for this file, set
1447 @code{gnus-backup-startup-file}. It respects the same values as the
1448 @code{version-control} variable.
1450 @vindex gnus-save-newsrc-hook
1451 @vindex gnus-save-quick-newsrc-hook
1452 @vindex gnus-save-standard-newsrc-hook
1453 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1454 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1455 saving the @file{.newsrc.eld} file, and
1456 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1457 @file{.newsrc} file. The latter two are commonly used to turn version
1458 control on or off. Version control is on by default when saving the
1459 startup files. If you want to turn backup creation off, say something like:
1462 (defun turn-off-backup ()
1463 (set (make-local-variable 'backup-inhibited) t))
1465 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1466 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1469 @vindex gnus-init-file
1470 @vindex gnus-site-init-file
1471 When Gnus starts, it will read the @code{gnus-site-init-file}
1472 (@file{.../site-lisp/gnus-init} by default) and @code{gnus-init-file}
1473 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1474 and can be used to avoid cluttering your @file{~/.emacs} and
1475 @file{site-init} files with Gnus stuff. Gnus will also check for files
1476 with the same names as these, but with @file{.elc} and @file{.el}
1477 suffixes. In other words, if you have set @code{gnus-init-file} to
1478 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1479 and finally @file{~/.gnus} (in this order). If Emacs was invoked with
1480 the @option{-q} or @option{--no-init-file} options (@pxref{Initial
1481 Options, ,Initial Options, emacs, The Emacs Manual}), Gnus doesn't read
1482 @code{gnus-init-file}.
1487 @cindex dribble file
1490 Whenever you do something that changes the Gnus data (reading articles,
1491 catching up, killing/subscribing groups), the change is added to a
1492 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1493 Emacs way. If your Emacs should crash before you have saved the
1494 @file{.newsrc} files, all changes you have made can be recovered from
1497 If Gnus detects this file at startup, it will ask the user whether to
1498 read it. The auto save file is deleted whenever the real startup file is
1501 @vindex gnus-use-dribble-file
1502 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
1503 maintain a dribble buffer. The default is @code{t}.
1505 @vindex gnus-dribble-directory
1506 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1507 this variable is @code{nil}, which it is by default, Gnus will dribble
1508 into the directory where the @file{.newsrc} file is located. (This is
1509 normally the user's home directory.) The dribble file will get the same
1510 file permissions as the @file{.newsrc} file.
1512 @vindex gnus-always-read-dribble-file
1513 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1514 read the dribble file on startup without querying the user.
1517 @node The Active File
1518 @section The Active File
1520 @cindex ignored groups
1522 When Gnus starts, or indeed whenever it tries to determine whether new
1523 articles have arrived, it reads the active file. This is a very large
1524 file that lists all the active groups and articles on the server.
1526 @vindex gnus-ignored-newsgroups
1527 Before examining the active file, Gnus deletes all lines that match the
1528 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1529 any groups with bogus names, but you can use this variable to make Gnus
1530 ignore hierarchies you aren't ever interested in. However, this is not
1531 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1532 Groups} for an overview of other variables that can be used instead.
1535 @c @code{nil} by default, and will slow down active file handling somewhat
1536 @c if you set it to anything else.
1538 @vindex gnus-read-active-file
1540 The active file can be rather Huge, so if you have a slow network, you
1541 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
1542 reading the active file. This variable is @code{some} by default.
1544 Gnus will try to make do by getting information just on the groups that
1545 you actually subscribe to.
1547 Note that if you subscribe to lots and lots of groups, setting this
1548 variable to @code{nil} will probably make Gnus slower, not faster. At
1549 present, having this variable @code{nil} will slow Gnus down
1550 considerably, unless you read news over a 2400 baud modem.
1552 This variable can also have the value @code{some}. Gnus will then
1553 attempt to read active info only on the subscribed groups. On some
1554 servers this is quite fast (on sparkling, brand new INN servers that
1555 support the @code{LIST ACTIVE group} command), on others this isn't fast
1556 at all. In any case, @code{some} should be faster than @code{nil}, and
1557 is certainly faster than @code{t} over slow lines.
1559 Some news servers (old versions of Leafnode and old versions of INN, for
1560 instance) do not support the @code{LIST ACTIVE group}. For these
1561 servers, @code{nil} is probably the most efficient value for this
1564 If this variable is @code{nil}, Gnus will ask for group info in total
1565 lock-step, which isn't very fast. If it is @code{some} and you use an
1566 @acronym{NNTP} server, Gnus will pump out commands as fast as it can, and
1567 read all the replies in one swoop. This will normally result in better
1568 performance, but if the server does not support the aforementioned
1569 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1571 If you think that starting up Gnus takes too long, try all the three
1572 different values for this variable and see what works best for you.
1574 In any case, if you use @code{some} or @code{nil}, you should definitely
1575 kill all groups that you aren't interested in to speed things up.
1577 Note that this variable also affects active file retrieval from
1578 secondary select methods.
1581 @node Startup Variables
1582 @section Startup Variables
1586 @item gnus-load-hook
1587 @vindex gnus-load-hook
1588 A hook run while Gnus is being loaded. Note that this hook will
1589 normally be run just once in each Emacs session, no matter how many
1590 times you start Gnus.
1592 @item gnus-before-startup-hook
1593 @vindex gnus-before-startup-hook
1594 A hook called as the first thing when Gnus is started.
1596 @item gnus-startup-hook
1597 @vindex gnus-startup-hook
1598 A hook run as the very last thing after starting up Gnus
1600 @item gnus-started-hook
1601 @vindex gnus-started-hook
1602 A hook that is run as the very last thing after starting up Gnus
1605 @item gnus-setup-news-hook
1606 @vindex gnus-setup-news-hook
1607 A hook that is run after reading the @file{.newsrc} file(s), but before
1608 generating the group buffer.
1610 @item gnus-check-bogus-newsgroups
1611 @vindex gnus-check-bogus-newsgroups
1612 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1613 startup. A @dfn{bogus group} is a group that you have in your
1614 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1615 bogus groups can take quite a while, so to save time and resources it's
1616 best to leave this option off, and do the checking for bogus groups once
1617 in a while from the group buffer instead (@pxref{Group Maintenance}).
1619 @item gnus-inhibit-startup-message
1620 @vindex gnus-inhibit-startup-message
1621 If non-@code{nil}, the startup message won't be displayed. That way,
1622 your boss might not notice as easily that you are reading news instead
1623 of doing your job. Note that this variable is used before
1624 @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1626 @item gnus-no-groups-message
1627 @vindex gnus-no-groups-message
1628 Message displayed by Gnus when no groups are available.
1630 @item gnus-use-backend-marks
1631 @vindex gnus-use-backend-marks
1632 If non-@code{nil}, Gnus will store article marks both in the
1633 @file{.newsrc.eld} file and in the backends. This will slow down
1634 group operation some.
1640 @chapter Group Buffer
1641 @cindex group buffer
1643 @c Alex Schroeder suggests to rearrange this as follows:
1645 @c <kensanata> ok, just save it for reference. I'll go to bed in a minute.
1646 @c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1647 @c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1648 @c 7. Group Score, 8. Group Buffer Format
1649 @c <kensanata> Group Levels should have more information on levels 5 to 9. I
1650 @c suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1651 @c <kensanata> First, "Gnus considers groups... (default 9)."
1652 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1653 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1654 @c <kensanata> Then expand the next paragraph or add some more to it.
1655 @c This short one sentence explains levels 1 and 2, therefore I understand
1656 @c that I should keep important news at 3 and boring news at 4.
1657 @c Say so! Then go on to explain why I should bother with levels 6 to 9.
1658 @c Maybe keep those that you don't want to read temporarily at 6,
1659 @c those that you never want to read at 8, those that offend your
1660 @c human rights at 9...
1663 The @dfn{group buffer} lists all (or parts) of the available groups. It
1664 is the first buffer shown when Gnus starts, and will never be killed as
1665 long as Gnus is active.
1669 \gnusfigure{The Group Buffer}{320}{
1670 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1671 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1672 \put(120,38){\vector(1,2){10}}
1673 \put(40,60){\makebox(0,0)[r]{Mode line}}
1674 \put(40,58){\vector(1,0){30}}
1675 \put(200,28){\makebox(0,0)[t]{Native select method}}
1676 \put(200,26){\vector(-1,2){15}}
1682 * Group Buffer Format:: Information listed and how you can change it.
1683 * Group Maneuvering:: Commands for moving in the group buffer.
1684 * Selecting a Group:: Actually reading news.
1685 * Subscription Commands:: Unsubscribing, killing, subscribing.
1686 * Group Data:: Changing the info for a group.
1687 * Group Levels:: Levels? What are those, then?
1688 * Group Score:: A mechanism for finding out what groups you like.
1689 * Marking Groups:: You can mark groups for later processing.
1690 * Foreign Groups:: Creating and editing groups.
1691 * Group Parameters:: Each group may have different parameters set.
1692 * Listing Groups:: Gnus can list various subsets of the groups.
1693 * Sorting Groups:: Re-arrange the group order.
1694 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1695 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1696 * Exiting Gnus:: Stop reading news and get some work done.
1697 * Group Topics:: A folding group mode divided into topics.
1698 * Non-ASCII Group Names:: Accessing groups of non-English names.
1699 * Searching:: Mail search engines.
1700 * Misc Group Stuff:: Other stuff that you can to do.
1704 @node Group Buffer Format
1705 @section Group Buffer Format
1708 * Group Line Specification:: Deciding how the group buffer is to look.
1709 * Group Mode Line Specification:: The group buffer mode line.
1710 * Group Highlighting:: Having nice colors in the group buffer.
1713 You can customize the Group Mode tool bar, see @kbd{M-x
1714 customize-apropos RET gnus-group-tool-bar}. This feature is only
1717 The tool bar icons are now (de)activated correctly depending on the
1718 cursor position. Therefore, moving around in the Group Buffer is
1719 slower. You can disable this via the variable
1720 @code{gnus-group-update-tool-bar}. Its default value depends on your
1723 @node Group Line Specification
1724 @subsection Group Line Specification
1725 @cindex group buffer format
1727 The default format of the group buffer is nice and dull, but you can
1728 make it as exciting and ugly as you feel like.
1730 Here's a couple of example group lines:
1733 25: news.announce.newusers
1734 * 0: alt.fan.andrea-dworkin
1739 You can see that there are 25 unread articles in
1740 @samp{news.announce.newusers}. There are no unread articles, but some
1741 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1742 asterisk at the beginning of the line?).
1744 @vindex gnus-group-line-format
1745 You can change that format to whatever you want by fiddling with the
1746 @code{gnus-group-line-format} variable. This variable works along the
1747 lines of a @code{format} specification, which is pretty much the same as
1748 a @code{printf} specifications, for those of you who use (feh!) C.
1749 @xref{Formatting Variables}.
1751 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1753 There should always be a colon on the line; the cursor always moves to
1754 the colon after performing an operation. @xref{Positioning
1755 Point}. Nothing else is required---not even the group name. All
1756 displayed text is just window dressing, and is never examined by Gnus.
1757 Gnus stores all real information it needs using text properties.
1759 (Note that if you make a really strange, wonderful, spreadsheet-like
1760 layout, everybody will believe you are hard at work with the accounting
1761 instead of wasting time reading news.)
1763 Here's a list of all available format characters:
1768 An asterisk if the group only has marked articles.
1771 Whether the group is subscribed.
1774 Level of subscribedness.
1777 Number of unread articles.
1780 Number of dormant articles.
1783 Number of ticked articles.
1786 Number of read articles.
1789 Number of unseen articles.
1792 Estimated total number of articles. (This is really @var{max-number}
1793 minus @var{min-number} plus 1.)
1795 Gnus uses this estimation because the @acronym{NNTP} protocol provides
1796 efficient access to @var{max-number} and @var{min-number} but getting
1797 the true unread message count is not possible efficiently. For
1798 hysterical raisins, even the mail back ends, where the true number of
1799 unread messages might be available efficiently, use the same limited
1800 interface. To remove this restriction from Gnus means that the back
1801 end interface has to be changed, which is not an easy job.
1803 The nnml backend (@pxref{Mail Spool}) has a feature called ``group
1804 compaction'' which circumvents this deficiency: the idea is to
1805 renumber all articles from 1, removing all gaps between numbers, hence
1806 getting a correct total count. Other backends may support this in the
1807 future. In order to keep your total article count relatively up to
1808 date, you might want to compact your groups (or even directly your
1809 server) from time to time. @xref{Misc Group Stuff}, @xref{Server Commands}.
1812 Number of unread, unticked, non-dormant articles.
1815 Number of ticked and dormant articles.
1824 Group comment (@pxref{Group Parameters}) or group name if there is no
1825 comment element in the group parameters.
1828 Newsgroup description. You need to read the group descriptions
1829 before these will appear, and to do that, you either have to set
1830 @code{gnus-read-active-file} or use the group buffer @kbd{M-d}
1834 @samp{m} if moderated.
1837 @samp{(m)} if moderated.
1843 If the summary buffer for the group is open or not.
1849 A string that looks like @samp{<%s:%n>} if a foreign select method is
1853 Indentation based on the level of the topic (@pxref{Group Topics}).
1856 @vindex gnus-group-uncollapsed-levels
1857 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1858 variable says how many levels to leave at the end of the group name.
1859 The default is 1---this will mean that group names like
1860 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1863 @vindex gnus-new-mail-mark
1865 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1869 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1872 A string that says when you last read the group (@pxref{Group
1876 The disk space used by the articles fetched by both the cache and
1877 agent. The value is automatically scaled to bytes(B), kilobytes(K),
1878 megabytes(M), or gigabytes(G) to minimize the column width. A format
1879 of %7F is sufficient for a fixed-width column.
1882 User defined specifier. The next character in the format string should
1883 be a letter. Gnus will call the function
1884 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1885 following @samp{%u}. The function will be passed a single dummy
1886 parameter as argument. The function should return a string, which will
1887 be inserted into the buffer just like information from any other
1892 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1893 if no info is available---for instance, if it is a non-activated foreign
1894 group, or a bogus native group.
1897 @node Group Mode Line Specification
1898 @subsection Group Mode Line Specification
1899 @cindex group mode line
1901 @vindex gnus-group-mode-line-format
1902 The mode line can be changed by setting
1903 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1904 doesn't understand that many format specifiers:
1908 The native news server.
1910 The native select method.
1914 @node Group Highlighting
1915 @subsection Group Highlighting
1916 @cindex highlighting
1917 @cindex group highlighting
1919 @vindex gnus-group-highlight
1920 Highlighting in the group buffer is controlled by the
1921 @code{gnus-group-highlight} variable. This is an alist with elements
1922 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1923 something non-@code{nil}, the @var{face} will be used on the line.
1925 Here's an example value for this variable that might look nice if the
1929 (cond (window-system
1930 (setq custom-background-mode 'light)
1931 (defface my-group-face-1
1932 '((t (:foreground "Red" :bold t))) "First group face")
1933 (defface my-group-face-2
1934 '((t (:foreground "DarkSeaGreen4" :bold t)))
1935 "Second group face")
1936 (defface my-group-face-3
1937 '((t (:foreground "Green4" :bold t))) "Third group face")
1938 (defface my-group-face-4
1939 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1940 (defface my-group-face-5
1941 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1943 (setq gnus-group-highlight
1944 '(((> unread 200) . my-group-face-1)
1945 ((and (< level 3) (zerop unread)) . my-group-face-2)
1946 ((< level 3) . my-group-face-3)
1947 ((zerop unread) . my-group-face-4)
1948 (t . my-group-face-5)))
1951 Also @pxref{Faces and Fonts}.
1953 Variables that are dynamically bound when the forms are evaluated
1960 The number of unread articles in the group.
1964 Whether the group is a mail group.
1966 The level of the group.
1968 The score of the group.
1970 The number of ticked articles in the group.
1972 The total number of articles in the group. Or rather,
1973 @var{max-number} minus @var{min-number} plus one.
1975 When using the topic minor mode, this variable is bound to the current
1976 topic being inserted.
1979 When the forms are @code{eval}ed, point is at the beginning of the line
1980 of the group in question, so you can use many of the normal Gnus
1981 functions for snarfing info on the group.
1983 @vindex gnus-group-update-hook
1984 @findex gnus-group-highlight-line
1985 @code{gnus-group-update-hook} is called when a group line is changed.
1986 It will not be called when @code{gnus-visual} is @code{nil}.
1989 @node Group Maneuvering
1990 @section Group Maneuvering
1991 @cindex group movement
1993 All movement commands understand the numeric prefix and will behave as
1994 expected, hopefully.
2000 @findex gnus-group-next-unread-group
2001 Go to the next group that has unread articles
2002 (@code{gnus-group-next-unread-group}).
2008 @findex gnus-group-prev-unread-group
2009 Go to the previous group that has unread articles
2010 (@code{gnus-group-prev-unread-group}).
2014 @findex gnus-group-next-group
2015 Go to the next group (@code{gnus-group-next-group}).
2019 @findex gnus-group-prev-group
2020 Go to the previous group (@code{gnus-group-prev-group}).
2024 @findex gnus-group-next-unread-group-same-level
2025 Go to the next unread group on the same (or lower) level
2026 (@code{gnus-group-next-unread-group-same-level}).
2030 @findex gnus-group-prev-unread-group-same-level
2031 Go to the previous unread group on the same (or lower) level
2032 (@code{gnus-group-prev-unread-group-same-level}).
2035 Three commands for jumping to groups:
2041 @findex gnus-group-jump-to-group
2042 Jump to a group (and make it visible if it isn't already)
2043 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
2048 @findex gnus-group-best-unread-group
2049 Jump to the unread group with the lowest level
2050 (@code{gnus-group-best-unread-group}).
2054 @findex gnus-group-first-unread-group
2055 Jump to the first group with unread articles
2056 (@code{gnus-group-first-unread-group}).
2059 @vindex gnus-group-goto-unread
2060 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2061 commands will move to the next group, not the next unread group. Even
2062 the commands that say they move to the next unread group. The default
2065 @vindex gnus-summary-next-group-on-exit
2066 If @code{gnus-summary-next-group-on-exit} is @code{t}, when a summary is
2067 exited, the point in the group buffer is moved to the next unread group.
2068 Otherwise, the point is set to the group just exited. The default is
2071 @node Selecting a Group
2072 @section Selecting a Group
2073 @cindex group selection
2078 @kindex SPACE (Group)
2079 @findex gnus-group-read-group
2080 Select the current group, switch to the summary buffer and display the
2081 first unread article (@code{gnus-group-read-group}). If there are no
2082 unread articles in the group, or if you give a non-numerical prefix to
2083 this command, Gnus will offer to fetch all the old articles in this
2084 group from the server. If you give a numerical prefix @var{n}, @var{n}
2085 determines the number of articles Gnus will fetch. If @var{n} is
2086 positive, Gnus fetches the @var{n} newest articles, if @var{n} is
2087 negative, Gnus fetches the @code{abs(@var{n})} oldest articles.
2089 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2090 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2091 - 4 2 SPC} fetches the 42 oldest ones.
2093 When you are in the group (in the Summary buffer), you can type
2094 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2099 @findex gnus-group-select-group
2100 Select the current group and switch to the summary buffer
2101 (@code{gnus-group-select-group}). Takes the same arguments as
2102 @code{gnus-group-read-group}---the only difference is that this command
2103 does not display the first unread article automatically upon group
2107 @kindex M-RET (Group)
2108 @findex gnus-group-quick-select-group
2109 This does the same as the command above, but tries to do it with the
2110 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
2111 scoring/killing will be performed, there will be no highlights and no
2112 expunging. This might be useful if you're in a real hurry and have to
2113 enter some humongous group. If you give a 0 prefix to this command
2114 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
2115 which is useful if you want to toggle threading before generating the
2116 summary buffer (@pxref{Summary Generation Commands}).
2119 @kindex M-SPACE (Group)
2120 @findex gnus-group-visible-select-group
2121 This is yet one more command that does the same as the @kbd{RET}
2122 command, but this one does it without expunging and hiding dormants
2123 (@code{gnus-group-visible-select-group}).
2126 @kindex C-M-RET (Group)
2127 @findex gnus-group-select-group-ephemerally
2128 Finally, this command selects the current group ephemerally without
2129 doing any processing of its contents
2130 (@code{gnus-group-select-group-ephemerally}). Even threading has been
2131 turned off. Everything you do in the group after selecting it in this
2132 manner will have no permanent effects.
2136 @vindex gnus-large-newsgroup
2137 The @code{gnus-large-newsgroup} variable says what Gnus should
2138 consider to be a big group. If it is @code{nil}, no groups are
2139 considered big. The default value is 200. If the group has more
2140 (unread and/or ticked) articles than this, Gnus will query the user
2141 before entering the group. The user can then specify how many
2142 articles should be fetched from the server. If the user specifies a
2143 negative number (@var{-n}), the @var{n} oldest articles will be
2144 fetched. If it is positive, the @var{n} articles that have arrived
2145 most recently will be fetched.
2147 @vindex gnus-large-ephemeral-newsgroup
2148 @code{gnus-large-ephemeral-newsgroup} is the same as
2149 @code{gnus-large-newsgroup}, but is only used for ephemeral
2152 @vindex gnus-newsgroup-maximum-articles
2153 In groups in some news servers, there might be a big gap between a few
2154 very old articles that will never be expired and the recent ones. In
2155 such a case, the server will return the data like @code{(1 . 30000000)}
2156 for the @code{LIST ACTIVE group} command, for example. Even if there
2157 are actually only the articles 1-10 and 29999900-30000000, Gnus doesn't
2158 know it at first and prepares for getting 30000000 articles. However,
2159 it will consume hundreds megabytes of memories and might make Emacs get
2160 stuck as the case may be. If you use such news servers, set the
2161 variable @code{gnus-newsgroup-maximum-articles} to a positive number.
2162 The value means that Gnus ignores articles other than this number of the
2163 latest ones in every group. For instance, the value 10000 makes Gnus
2164 get only the articles 29990001-30000000 (if the latest article number is
2165 30000000 in a group). Note that setting this variable to a number might
2166 prevent you from reading very old articles. The default value of the
2167 variable @code{gnus-newsgroup-maximum-articles} is @code{nil}, which
2168 means Gnus never ignores old articles.
2170 @vindex gnus-select-group-hook
2171 @vindex gnus-auto-select-first
2172 @vindex gnus-auto-select-subject
2173 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2174 automatically when entering a group with the @kbd{SPACE} command.
2175 Which article this is controlled by the
2176 @code{gnus-auto-select-subject} variable. Valid values for this
2182 Place point on the subject line of the first unread article.
2185 Place point on the subject line of the first article.
2188 Place point on the subject line of the first unseen article.
2190 @item unseen-or-unread
2191 Place point on the subject line of the first unseen article, and if
2192 there is no such article, place point on the subject line of the first
2196 Place point on the subject line of the highest-scored unread article.
2200 This variable can also be a function. In that case, that function
2201 will be called to place point on a subject line.
2203 If you want to prevent automatic selection in some group (say, in a
2204 binary group with Huge articles) you can set the
2205 @code{gnus-auto-select-first} variable to @code{nil} in
2206 @code{gnus-select-group-hook}, which is called when a group is
2210 @node Subscription Commands
2211 @section Subscription Commands
2212 @cindex subscription
2220 @findex gnus-group-unsubscribe-current-group
2221 @c @icon{gnus-group-unsubscribe}
2222 Toggle subscription to the current group
2223 (@code{gnus-group-unsubscribe-current-group}).
2229 @findex gnus-group-unsubscribe-group
2230 Prompt for a group to subscribe, and then subscribe it. If it was
2231 subscribed already, unsubscribe it instead
2232 (@code{gnus-group-unsubscribe-group}).
2238 @findex gnus-group-kill-group
2239 @c @icon{gnus-group-kill-group}
2240 Kill the current group (@code{gnus-group-kill-group}).
2246 @findex gnus-group-yank-group
2247 Yank the last killed group (@code{gnus-group-yank-group}).
2250 @kindex C-x C-t (Group)
2251 @findex gnus-group-transpose-groups
2252 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2253 really a subscription command, but you can use it instead of a
2254 kill-and-yank sequence sometimes.
2260 @findex gnus-group-kill-region
2261 Kill all groups in the region (@code{gnus-group-kill-region}).
2265 @findex gnus-group-kill-all-zombies
2266 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2269 @kindex S C-k (Group)
2270 @findex gnus-group-kill-level
2271 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2272 These groups can't be yanked back after killing, so this command should
2273 be used with some caution. The only time where this command comes in
2274 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2275 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2276 kill off all unsubscribed groups that do not have message numbers in the
2277 @file{.newsrc} file.
2281 Also @pxref{Group Levels}.
2291 @findex gnus-group-catchup-current
2292 @vindex gnus-group-catchup-group-hook
2293 @c @icon{gnus-group-catchup-current}
2294 Mark all unticked articles in this group as read
2295 (@code{gnus-group-catchup-current}).
2296 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2301 @findex gnus-group-catchup-current-all
2302 Mark all articles in this group, even the ticked ones, as read
2303 (@code{gnus-group-catchup-current-all}).
2307 @findex gnus-group-clear-data
2308 Clear the data from the current group---nix out marks and the list of
2309 read articles (@code{gnus-group-clear-data}).
2311 @item M-x gnus-group-clear-data-on-native-groups
2312 @kindex M-x gnus-group-clear-data-on-native-groups
2313 @findex gnus-group-clear-data-on-native-groups
2314 If you have switched from one @acronym{NNTP} server to another, all your marks
2315 and read ranges have become worthless. You can use this command to
2316 clear out all data that you have on your native groups. Use with
2323 @section Group Levels
2327 All groups have a level of @dfn{subscribedness}. For instance, if a
2328 group is on level 2, it is more subscribed than a group on level 5. You
2329 can ask Gnus to just list groups on a given level or lower
2330 (@pxref{Listing Groups}), or to just check for new articles in groups on
2331 a given level or lower (@pxref{Scanning New Messages}).
2333 Remember: The higher the level of the group, the less important it is.
2339 @findex gnus-group-set-current-level
2340 Set the level of the current group. If a numeric prefix is given, the
2341 next @var{n} groups will have their levels set. The user will be
2342 prompted for a level.
2345 @vindex gnus-level-killed
2346 @vindex gnus-level-zombie
2347 @vindex gnus-level-unsubscribed
2348 @vindex gnus-level-subscribed
2349 Gnus considers groups from levels 1 to
2350 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2351 @code{gnus-level-subscribed} (exclusive) and
2352 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2353 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2354 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2355 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2356 same, but zombie and killed groups have no information on what articles
2357 you have read, etc, stored. This distinction between dead and living
2358 groups isn't done because it is nice or clever, it is done purely for
2359 reasons of efficiency.
2361 It is recommended that you keep all your mail groups (if any) on quite
2362 low levels (e.g. 1 or 2).
2364 Maybe the following description of the default behavior of Gnus helps to
2365 understand what these levels are all about. By default, Gnus shows you
2366 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2367 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2368 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2369 groups are hidden, in a way.
2371 Zombie and killed groups are similar to unsubscribed groups in that they
2372 are hidden by default. But they are different from subscribed and
2373 unsubscribed groups in that Gnus doesn't ask the news server for
2374 information (number of messages, number of unread messages) on zombie
2375 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2376 aren't interested in. If most groups are killed, Gnus is faster.
2378 Why does Gnus distinguish between zombie and killed groups? Well, when
2379 a new group arrives on the server, Gnus by default makes it a zombie
2380 group. This means that you are normally not bothered with new groups,
2381 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2382 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2383 list of killed groups.)
2385 If you want to play with the level variables, you should show some care.
2386 Set them once, and don't touch them ever again. Better yet, don't touch
2387 them at all unless you know exactly what you're doing.
2389 @vindex gnus-level-default-unsubscribed
2390 @vindex gnus-level-default-subscribed
2391 Two closely related variables are @code{gnus-level-default-subscribed}
2392 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2393 which are the levels that new groups will be put on if they are
2394 (un)subscribed. These two variables should, of course, be inside the
2395 relevant valid ranges.
2397 @vindex gnus-keep-same-level
2398 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2399 will only move to groups of the same level (or lower). In
2400 particular, going from the last article in one group to the next group
2401 will go to the next group of the same level (or lower). This might be
2402 handy if you want to read the most important groups before you read the
2405 If this variable is @code{best}, Gnus will make the next newsgroup the
2406 one with the best level.
2408 @vindex gnus-group-default-list-level
2409 All groups with a level less than or equal to
2410 @code{gnus-group-default-list-level} will be listed in the group buffer
2413 @vindex gnus-group-list-inactive-groups
2414 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2415 groups will be listed along with the unread groups. This variable is
2416 @code{t} by default. If it is @code{nil}, inactive groups won't be
2419 @vindex gnus-group-use-permanent-levels
2420 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2421 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2422 use this level as the ``work'' level.
2424 @vindex gnus-activate-level
2425 Gnus will normally just activate (i. e., query the server about) groups
2426 on level @code{gnus-activate-level} or less. If you don't want to
2427 activate unsubscribed groups, for instance, you might set this variable
2428 to 5. The default is 6.
2432 @section Group Score
2437 You would normally keep important groups on high levels, but that scheme
2438 is somewhat restrictive. Don't you wish you could have Gnus sort the
2439 group buffer according to how often you read groups, perhaps? Within
2442 This is what @dfn{group score} is for. You can have Gnus assign a score
2443 to each group through the mechanism described below. You can then sort
2444 the group buffer based on this score. Alternatively, you can sort on
2445 score and then level. (Taken together, the level and the score is
2446 called the @dfn{rank} of the group. A group that is on level 4 and has
2447 a score of 1 has a higher rank than a group on level 5 that has a score
2448 of 300. (The level is the most significant part and the score is the
2449 least significant part.))
2451 @findex gnus-summary-bubble-group
2452 If you want groups you read often to get higher scores than groups you
2453 read seldom you can add the @code{gnus-summary-bubble-group} function to
2454 the @code{gnus-summary-exit-hook} hook. This will result (after
2455 sorting) in a bubbling sort of action. If you want to see that in
2456 action after each summary exit, you can add
2457 @code{gnus-group-sort-groups-by-rank} or
2458 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2459 slow things down somewhat.
2462 @node Marking Groups
2463 @section Marking Groups
2464 @cindex marking groups
2466 If you want to perform some command on several groups, and they appear
2467 subsequently in the group buffer, you would normally just give a
2468 numerical prefix to the command. Most group commands will then do your
2469 bidding on those groups.
2471 However, if the groups are not in sequential order, you can still
2472 perform a command on several groups. You simply mark the groups first
2473 with the process mark and then execute the command.
2481 @findex gnus-group-mark-group
2482 Set the mark on the current group (@code{gnus-group-mark-group}).
2488 @findex gnus-group-unmark-group
2489 Remove the mark from the current group
2490 (@code{gnus-group-unmark-group}).
2494 @findex gnus-group-unmark-all-groups
2495 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2499 @findex gnus-group-mark-region
2500 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2504 @findex gnus-group-mark-buffer
2505 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2509 @findex gnus-group-mark-regexp
2510 Mark all groups that match some regular expression
2511 (@code{gnus-group-mark-regexp}).
2514 Also @pxref{Process/Prefix}.
2516 @findex gnus-group-universal-argument
2517 If you want to execute some command on all groups that have been marked
2518 with the process mark, you can use the @kbd{M-&}
2519 (@code{gnus-group-universal-argument}) command. It will prompt you for
2520 the command to be executed.
2523 @node Foreign Groups
2524 @section Foreign Groups
2525 @cindex foreign groups
2527 Below are some group mode commands for making and editing general foreign
2528 groups, as well as commands to ease the creation of a few
2529 special-purpose groups. All these commands insert the newly created
2530 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2533 Changes from the group editing commands are stored in
2534 @file{~/.newsrc.eld} (@code{gnus-startup-file}). An alternative is the
2535 variable @code{gnus-parameters}, @xref{Group Parameters}.
2541 @findex gnus-group-make-group
2542 @cindex making groups
2543 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2544 for a name, a method and possibly an @dfn{address}. For an easier way
2545 to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}).
2549 @findex gnus-group-read-ephemeral-group
2550 Make an ephemeral group (@code{gnus-group-read-ephemeral-group}). Gnus
2551 will prompt you for a name, a method and an @dfn{address}.
2555 @findex gnus-group-rename-group
2556 @cindex renaming groups
2557 Rename the current group to something else
2558 (@code{gnus-group-rename-group}). This is valid only on some
2559 groups---mail groups mostly. This command might very well be quite slow
2565 @findex gnus-group-customize
2566 Customize the group parameters (@code{gnus-group-customize}).
2570 @findex gnus-group-edit-group-method
2571 @cindex renaming groups
2572 Enter a buffer where you can edit the select method of the current
2573 group (@code{gnus-group-edit-group-method}).
2577 @findex gnus-group-edit-group-parameters
2578 Enter a buffer where you can edit the group parameters
2579 (@code{gnus-group-edit-group-parameters}).
2583 @findex gnus-group-edit-group
2584 Enter a buffer where you can edit the group info
2585 (@code{gnus-group-edit-group}).
2589 @findex gnus-group-make-directory-group
2591 Make a directory group (@pxref{Directory Groups}). You will be prompted
2592 for a directory name (@code{gnus-group-make-directory-group}).
2597 @findex gnus-group-make-help-group
2598 Make the Gnus help group (@code{gnus-group-make-help-group}).
2602 @findex gnus-group-enter-directory
2604 Read an arbitrary directory as if it were a newsgroup with the
2605 @code{nneething} back end (@code{gnus-group-enter-directory}).
2606 @xref{Anything Groups}.
2610 @findex gnus-group-make-doc-group
2611 @cindex ClariNet Briefs
2613 Make a group based on some file or other
2614 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2615 command, you will be prompted for a file name and a file type.
2616 Currently supported types are @code{mbox}, @code{babyl},
2617 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2618 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2619 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2620 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}. If
2621 you run this command without a prefix, Gnus will guess at the file
2622 type. @xref{Document Groups}.
2626 @vindex gnus-useful-groups
2627 @findex gnus-group-make-useful-group
2628 Create one of the groups mentioned in @code{gnus-useful-groups}
2629 (@code{gnus-group-make-useful-group}).
2633 @findex gnus-group-make-web-group
2637 Make an ephemeral group based on a web search
2638 (@code{gnus-group-make-web-group}). If you give a prefix to this
2639 command, make a solid group instead. You will be prompted for the
2640 search engine type and the search string. Valid search engine types
2641 include @code{google}, @code{dejanews}, and @code{gmane}.
2642 @xref{Web Searches}.
2644 If you use the @code{google} search engine, you can limit the search
2645 to a particular group by using a match string like
2646 @samp{shaving group:alt.sysadmin.recovery}.
2650 @findex gnus-group-make-rss-group
2651 Make a group based on an @acronym{RSS} feed
2652 (@code{gnus-group-make-rss-group}). You will be prompted for an URL.
2656 @kindex G DEL (Group)
2657 @findex gnus-group-delete-group
2658 This function will delete the current group
2659 (@code{gnus-group-delete-group}). If given a prefix, this function will
2660 actually delete all the articles in the group, and forcibly remove the
2661 group itself from the face of the Earth. Use a prefix only if you are
2662 absolutely sure of what you are doing. This command can't be used on
2663 read-only groups (like @code{nntp} groups), though.
2667 @findex gnus-group-make-empty-virtual
2668 Make a new, fresh, empty @code{nnvirtual} group
2669 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2673 @findex gnus-group-add-to-virtual
2674 Add the current group to an @code{nnvirtual} group
2675 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2678 @xref{Select Methods}, for more information on the various select
2681 @vindex gnus-activate-foreign-newsgroups
2682 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2683 Gnus will check all foreign groups with this level or lower at startup.
2684 This might take quite a while, especially if you subscribe to lots of
2685 groups from different @acronym{NNTP} servers. Also @pxref{Group Levels};
2686 @code{gnus-activate-level} also affects activation of foreign
2690 The following commands create ephemeral groups. They can be called not
2691 only from the Group buffer, but in any Gnus buffer.
2694 @item gnus-read-ephemeral-gmane-group
2695 @findex gnus-read-ephemeral-gmane-group
2696 @vindex gnus-gmane-group-download-format
2697 Read an ephemeral group on Gmane.org. The articles are downloaded via
2698 HTTP using the URL specified by @code{gnus-gmane-group-download-format}.
2699 Gnus will prompt you for a group name, the start article number and an
2702 @item gnus-read-ephemeral-gmane-group-url
2703 @findex gnus-read-ephemeral-gmane-group-url
2704 This command is similar to @code{gnus-read-ephemeral-gmane-group}, but
2705 the group name and the article number and range are constructed from a
2706 given @acronym{URL}. Supported @acronym{URL} formats include e.g.
2707 @url{http://thread.gmane.org/gmane.foo.bar/12300/focus=12399},
2708 @url{http://thread.gmane.org/gmane.foo.bar/12345/},
2709 @url{http://article.gmane.org/gmane.foo.bar/12345/},
2710 @url{http://permalink.gmane.org/gmane.foo.bar/12345/}, and
2711 @url{http://news.gmane.org/group/gmane.foo.bar/thread=12345}.
2713 @item gnus-read-ephemeral-emacs-bug-group
2714 @findex gnus-read-ephemeral-emacs-bug-group
2715 Read an Emacs bug report in an ephemeral group. Gnus will prompt for a
2716 bug number. The default is the number at point. The @acronym{URL} is
2717 specified in @code{gnus-bug-group-download-format-alist}.
2719 @item gnus-read-ephemeral-debian-bug-group
2720 @findex gnus-read-ephemeral-debian-bug-group
2721 Read a Debian bug report in an ephemeral group. Analog to
2722 @code{gnus-read-ephemeral-emacs-bug-group}.
2725 Some of these command are also useful for article buttons, @xref{Article
2733 '("#\\([0-9]+\\)\\>" 1
2734 (string-match "\\<emacs\\>" (or gnus-newsgroup-name ""))
2735 gnus-read-ephemeral-emacs-bug-group 1))
2739 @node Group Parameters
2740 @section Group Parameters
2741 @cindex group parameters
2743 The group parameters store information local to a particular group.
2745 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
2746 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
2747 presents you with a Customize-like interface. The latter helps avoid
2748 silly Lisp errors.) You might also be interested in reading about topic
2749 parameters (@pxref{Topic Parameters}).
2750 Additionally, you can set group parameters via the
2751 @code{gnus-parameters} variable, see below.
2753 Here's an example group parameter list:
2756 ((to-address . "ding@@gnus.org")
2760 We see that each element consists of a ``dotted pair''---the thing before
2761 the dot is the key, while the thing after the dot is the value. All the
2762 parameters have this form @emph{except} local variable specs, which are
2763 not dotted pairs, but proper lists.
2765 Some parameters have correspondent customizable variables, each of which
2766 is an alist of regexps and values.
2768 The following group parameters can be used:
2773 Address used by when doing followups and new posts.
2776 (to-address . "some@@where.com")
2779 This is primarily useful in mail groups that represent closed mailing
2780 lists---mailing lists where it's expected that everybody that writes to
2781 the mailing list is subscribed to it. Since using this parameter
2782 ensures that the mail only goes to the mailing list itself, it means
2783 that members won't receive two copies of your followups.
2785 Using @code{to-address} will actually work whether the group is foreign
2786 or not. Let's say there's a group on the server that is called
2787 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2788 the articles from a mail-to-news gateway. Posting directly to this
2789 group is therefore impossible---you have to send mail to the mailing
2790 list address instead.
2792 See also @code{gnus-parameter-to-address-alist}.
2796 Address used when doing @kbd{a} in that group.
2799 (to-list . "some@@where.com")
2802 It is totally ignored
2803 when doing a followup---except that if it is present in a news group,
2804 you'll get mail group semantics when doing @kbd{f}.
2806 If you do an @kbd{a} command in a mail group and you have neither a
2807 @code{to-list} group parameter nor a @code{to-address} group parameter,
2808 then a @code{to-list} group parameter will be added automatically upon
2809 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2810 @vindex gnus-add-to-list
2812 @findex gnus-mailing-list-mode
2813 @cindex mail list groups
2814 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2815 entering summary buffer.
2817 See also @code{gnus-parameter-to-list-alist}.
2822 @cindex Mail-Followup-To
2823 @findex gnus-find-subscribed-addresses
2824 If this parameter is set to @code{t}, Gnus will consider the
2825 to-address and to-list parameters for this group as addresses of
2826 mailing lists you are subscribed to. Giving Gnus this information is
2827 (only) a first step in getting it to generate correct Mail-Followup-To
2828 headers for your posts to these lists. The second step is to put the
2829 following in your @file{.gnus.el}
2832 (setq message-subscribed-address-functions
2833 '(gnus-find-subscribed-addresses))
2836 @xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for
2837 a complete treatment of available MFT support.
2841 If the group parameter list has the element @code{(visible . t)},
2842 that group will always be visible in the Group buffer, regardless
2843 of whether it has any unread articles.
2845 This parameter cannot be set via @code{gnus-parameters}. See
2846 @code{gnus-permanently-visible-groups} as an alternative.
2848 @item broken-reply-to
2849 @cindex broken-reply-to
2850 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2851 headers in this group are to be ignored, and for the header to be hidden
2852 if @code{reply-to} is part of @code{gnus-boring-article-headers}. This
2853 can be useful if you're reading a mailing list group where the listserv
2854 has inserted @code{Reply-To} headers that point back to the listserv
2855 itself. That is broken behavior. So there!
2859 Elements like @code{(to-group . "some.group.name")} means that all
2860 posts in that group will be sent to @code{some.group.name}.
2864 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2865 will treat all responses as if they were responses to news articles.
2866 This can be useful if you have a mail group that's really a mirror of a
2871 If @code{(gcc-self . t)} is present in the group parameter list, newly
2872 composed messages will be @code{Gcc}'d to the current group. If
2873 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2874 generated, if @code{(gcc-self . "string")} is present, this string will
2875 be inserted literally as a @code{gcc} header. This parameter takes
2876 precedence over any default @code{Gcc} rules as described later
2877 (@pxref{Archived Messages}).
2879 @strong{Caveat}: Adding @code{(gcc-self . t)} to the parameter list of
2880 @code{nntp} groups (or the like) isn't valid. An @code{nntp} server
2881 doesn't accept articles.
2885 @cindex expiring mail
2886 If the group parameter has an element that looks like @code{(auto-expire
2887 . t)}, all articles read will be marked as expirable. For an
2888 alternative approach, @pxref{Expiring Mail}.
2890 See also @code{gnus-auto-expirable-newsgroups}.
2893 @cindex total-expire
2894 @cindex expiring mail
2895 If the group parameter has an element that looks like
2896 @code{(total-expire . t)}, all read articles will be put through the
2897 expiry process, even if they are not marked as expirable. Use with
2898 caution. Unread, ticked and dormant articles are not eligible for
2901 See also @code{gnus-total-expirable-newsgroups}.
2905 @vindex nnmail-expiry-wait-function
2906 If the group parameter has an element that looks like
2907 @code{(expiry-wait . 10)}, this value will override any
2908 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2909 (@pxref{Expiring Mail}) when expiring expirable messages. The value
2910 can either be a number of days (not necessarily an integer) or the
2911 symbols @code{never} or @code{immediate}.
2914 @cindex expiry-target
2915 Where expired messages end up. This parameter overrides
2916 @code{nnmail-expiry-target}.
2919 @cindex score file group parameter
2920 Elements that look like @code{(score-file . "file")} will make
2921 @file{file} into the current score file for the group in question. All
2922 interactive score entries will be put into this file.
2925 @cindex adapt file group parameter
2926 Elements that look like @code{(adapt-file . "file")} will make
2927 @file{file} into the current adaptive file for the group in question.
2928 All adaptive score entries will be put into this file.
2931 @cindex admin-address
2932 When unsubscribing from a mailing list you should never send the
2933 unsubscription notice to the mailing list itself. Instead, you'd send
2934 messages to the administrative address. This parameter allows you to
2935 put the admin address somewhere convenient.
2939 Elements that look like @code{(display . MODE)} say which articles to
2940 display on entering the group. Valid values are:
2944 Display all articles, both read and unread.
2947 Display the last @var{integer} articles in the group. This is the same as
2948 entering the group with @kbd{C-u @var{integer}}.
2951 Display the default visible articles, which normally includes unread and
2955 Display articles that satisfy a predicate.
2957 Here are some examples:
2961 Display only unread articles.
2964 Display everything except expirable articles.
2966 @item [and (not reply) (not expire)]
2967 Display everything except expirable and articles you've already
2971 The available operators are @code{not}, @code{and} and @code{or}.
2972 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2973 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2974 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2975 @code{cache}, @code{forward}, @code{unseen} and @code{recent}.
2979 The @code{display} parameter works by limiting the summary buffer to
2980 the subset specified. You can pop the limit by using the @kbd{/ w}
2981 command (@pxref{Limiting}).
2985 Elements that look like @code{(comment . "This is a comment")} are
2986 arbitrary comments on the group. You can display comments in the
2987 group line (@pxref{Group Line Specification}).
2991 Elements that look like @code{(charset . iso-8859-1)} will make
2992 @code{iso-8859-1} the default charset; that is, the charset that will be
2993 used for all articles that do not specify a charset.
2995 See also @code{gnus-group-charset-alist}.
2997 @item ignored-charsets
2998 @cindex ignored-charset
2999 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
3000 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
3001 default charset will be used for decoding articles.
3003 See also @code{gnus-group-ignored-charsets-alist}.
3006 @cindex posting-style
3007 You can store additional posting style information for this group
3008 here (@pxref{Posting Styles}). The format is that of an entry in the
3009 @code{gnus-posting-styles} alist, except that there's no regexp matching
3010 the group name (of course). Style elements in this group parameter will
3011 take precedence over the ones found in @code{gnus-posting-styles}.
3013 For instance, if you want a funky name and signature in this group only,
3014 instead of hacking @code{gnus-posting-styles}, you could put something
3015 like this in the group parameters:
3020 ("X-My-Header" "Funky Value")
3021 (signature "Funky Signature"))
3024 If you're using topics to organize your group buffer
3025 (@pxref{Group Topics}), note that posting styles can also be set in
3026 the topics parameters. Posting styles in topic parameters apply to all
3027 groups in this topic. More precisely, the posting-style settings for a
3028 group result from the hierarchical merging of all posting-style
3029 entries in the parameters of this group and all the topics it belongs
3035 If it is set, the value is used as the method for posting message
3036 instead of @code{gnus-post-method}.
3040 If it is set, and the setting of @code{mail-sources} includes a
3041 @code{group} mail source (@pxref{Mail Sources}), the value is a
3042 mail source for this group.
3046 An item like @code{(banner . @var{regexp})} causes any part of an article
3047 that matches the regular expression @var{regexp} to be stripped. Instead of
3048 @var{regexp}, you can also use the symbol @code{signature} which strips the
3049 last signature or any of the elements of the alist
3050 @code{gnus-article-banner-alist}.
3054 This parameter contains a Sieve test that should match incoming mail
3055 that should be placed in this group. From this group parameter, a
3056 Sieve @samp{IF} control structure is generated, having the test as the
3057 condition and @samp{fileinto "group.name";} as the body.
3059 For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve
3060 address "sender" "sieve-admin@@extundo.com")} group parameter, when
3061 translating the group parameter into a Sieve script (@pxref{Sieve
3062 Commands}) the following Sieve code is generated:
3065 if address "sender" "sieve-admin@@extundo.com" @{
3066 fileinto "INBOX.list.sieve";
3070 To generate tests for multiple email-addresses use a group parameter
3071 like @code{(sieve address "sender" ("name@@one.org" else@@two.org"))}.
3072 When generating a sieve script (@pxref{Sieve Commands}) Sieve code
3073 like the following is generated:
3076 if address "sender" ["name@@one.org", "else@@two.org"] @{
3077 fileinto "INBOX.list.sieve";
3081 See @pxref{Sieve Commands} for commands and variables that might be of
3082 interest in relation to the sieve parameter.
3084 The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve,
3085 Top, sieve, Emacs Sieve}.
3087 @item (agent parameters)
3088 If the agent has been enabled, you can set any of the its parameters
3089 to control the behavior of the agent in individual groups. See Agent
3090 Parameters in @ref{Category Syntax}. Most users will choose to set
3091 agent parameters in either an agent category or group topic to
3092 minimize the configuration effort.
3094 @item (@var{variable} @var{form})
3095 You can use the group parameters to set variables local to the group you
3096 are entering. If you want to turn threading off in @samp{news.answers},
3097 you could put @code{(gnus-show-threads nil)} in the group parameters of
3098 that group. @code{gnus-show-threads} will be made into a local variable
3099 in the summary buffer you enter, and the form @code{nil} will be
3100 @code{eval}ed there.
3102 Note that this feature sets the variable locally to the summary buffer
3103 if and only if @var{variable} has been bound as a variable. Otherwise,
3104 only evaluating the form will take place. So, you may want to bind the
3105 variable in advance using @code{defvar} or other if the result of the
3106 form needs to be set to it.
3108 But some variables are evaluated in the article buffer, or in the
3109 message buffer (of a reply or followup or otherwise newly created
3110 message). As a workaround, it might help to add the variable in
3111 question to @code{gnus-newsgroup-variables}. @xref{Various Summary
3112 Stuff}. So if you want to set @code{message-from-style} via the group
3113 parameters, then you may need the following statement elsewhere in your
3114 @file{~/.gnus.el} file:
3117 (add-to-list 'gnus-newsgroup-variables 'message-from-style)
3120 @vindex gnus-list-identifiers
3121 A use for this feature is to remove a mailing list identifier tag in
3122 the subject fields of articles. E.g. if the news group
3125 nntp+news.gnus.org:gmane.text.docbook.apps
3128 has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this
3129 tag can be removed from the article subjects in the summary buffer for
3130 the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")}
3131 into the group parameters for the group.
3133 This can also be used as a group-specific hook function. If you want to
3134 hear a beep when you enter a group, you could put something like
3135 @code{(dummy-variable (ding))} in the parameters of that group. If
3136 @code{dummy-variable} has been bound (see above), it will be set to the
3137 (meaningless) result of the @code{(ding)} form.
3139 Alternatively, since the VARIABLE becomes local to the group, this
3140 pattern can be used to temporarily change a hook. For example, if the
3141 following is added to a group parameter
3144 (gnus-summary-prepared-hook
3145 '(lambda nil (local-set-key "d" (local-key-binding "n"))))
3148 when the group is entered, the 'd' key will not mark the article as
3153 @vindex gnus-parameters
3154 Group parameters can be set via the @code{gnus-parameters} variable too.
3155 But some variables, such as @code{visible}, have no effect (For this
3156 case see @code{gnus-permanently-visible-groups} as an alternative.).
3160 (setq gnus-parameters
3162 (gnus-show-threads nil)
3163 (gnus-use-scoring nil)
3164 (gnus-summary-line-format
3165 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3169 ("^nnimap:\\(foo.bar\\)$"
3173 (gnus-use-scoring t))
3177 (broken-reply-to . t))))
3180 String value of parameters will be subjected to regexp substitution, as
3181 the @code{to-group} example shows.
3183 @vindex gnus-parameters-case-fold-search
3184 By default, whether comparing the group name and one of those regexps
3185 specified in @code{gnus-parameters} is done in a case-sensitive manner
3186 or a case-insensitive manner depends on the value of
3187 @code{case-fold-search} at the time when the comparison is done. The
3188 value of @code{case-fold-search} is typically @code{t}; it means, for
3189 example, the element @code{("INBOX\\.FOO" (total-expire . t))} might be
3190 applied to both the @samp{INBOX.FOO} group and the @samp{INBOX.foo}
3191 group. If you want to make those regexps always case-sensitive, set the
3192 value of the @code{gnus-parameters-case-fold-search} variable to
3193 @code{nil}. Otherwise, set it to @code{t} if you want to compare them
3194 always in a case-insensitive manner.
3196 You can define different sorting to different groups via
3197 @code{gnus-parameters}. Here is an example to sort an @acronym{NNTP}
3198 group by reverse date to see the latest news at the top and an
3199 @acronym{RSS} group by subject. In this example, the first group is the
3200 Debian daily news group @code{gmane.linux.debian.user.news} from
3201 news.gmane.org. The @acronym{RSS} group corresponds to the Debian
3202 weekly news RSS feed
3203 @url{http://packages.debian.org/unstable/newpkg_main.en.rdf},
3209 '(("nntp.*gmane\\.debian\\.user\\.news"
3210 (gnus-show-threads nil)
3211 (gnus-article-sort-functions '((not gnus-article-sort-by-date)))
3212 (gnus-use-adaptive-scoring nil)
3213 (gnus-use-scoring nil))
3215 (gnus-show-threads nil)
3216 (gnus-article-sort-functions 'gnus-article-sort-by-subject)
3217 (gnus-use-adaptive-scoring nil)
3218 (gnus-use-scoring t)
3219 (gnus-score-find-score-files-function 'gnus-score-find-single)
3220 (gnus-summary-line-format "%U%R%z%d %I%(%[ %s %]%)\n"))))
3224 @node Listing Groups
3225 @section Listing Groups
3226 @cindex group listing
3228 These commands all list various slices of the groups available.
3236 @findex gnus-group-list-groups
3237 List all groups that have unread articles
3238 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
3239 command will list only groups of level ARG and lower. By default, it
3240 only lists groups of level five (i.e.,
3241 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3248 @findex gnus-group-list-all-groups
3249 List all groups, whether they have unread articles or not
3250 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
3251 this command will list only groups of level ARG and lower. By default,
3252 it lists groups of level seven or lower (i.e., just subscribed and
3253 unsubscribed groups).
3257 @findex gnus-group-list-level
3258 List all unread groups on a specific level
3259 (@code{gnus-group-list-level}). If given a prefix, also list the groups
3260 with no unread articles.
3264 @findex gnus-group-list-killed
3265 List all killed groups (@code{gnus-group-list-killed}). If given a
3266 prefix argument, really list all groups that are available, but aren't
3267 currently (un)subscribed. This could entail reading the active file
3272 @findex gnus-group-list-zombies
3273 List all zombie groups (@code{gnus-group-list-zombies}).
3277 @findex gnus-group-list-matching
3278 List all unread, subscribed groups with names that match a regexp
3279 (@code{gnus-group-list-matching}).
3283 @findex gnus-group-list-all-matching
3284 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3288 @findex gnus-group-list-active
3289 List absolutely all groups in the active file(s) of the
3290 server(s) you are connected to (@code{gnus-group-list-active}). This
3291 might very well take quite a while. It might actually be a better idea
3292 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3293 thing to match on. Also note that this command may list groups that
3294 don't exist (yet)---these will be listed as if they were killed groups.
3295 Take the output with some grains of salt.
3299 @findex gnus-group-apropos
3300 List all groups that have names that match a regexp
3301 (@code{gnus-group-apropos}).
3305 @findex gnus-group-description-apropos
3306 List all groups that have names or descriptions that match a regexp
3307 (@code{gnus-group-description-apropos}).
3311 @findex gnus-group-list-cached
3312 List all groups with cached articles (@code{gnus-group-list-cached}).
3316 @findex gnus-group-list-dormant
3317 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3321 @findex gnus-group-list-limit
3322 List groups limited within the current selection
3323 (@code{gnus-group-list-limit}).
3327 @findex gnus-group-list-flush
3328 Flush groups from the current selection (@code{gnus-group-list-flush}).
3332 @findex gnus-group-list-plus
3333 List groups plus the current selection (@code{gnus-group-list-plus}).
3337 @vindex gnus-permanently-visible-groups
3338 @cindex visible group parameter
3339 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3340 always be shown, whether they have unread articles or not. You can also
3341 add the @code{visible} element to the group parameters in question to
3342 get the same effect.
3344 @vindex gnus-list-groups-with-ticked-articles
3345 Groups that have just ticked articles in it are normally listed in the
3346 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
3347 @code{nil}, these groups will be treated just like totally empty
3348 groups. It is @code{t} by default.
3351 @node Sorting Groups
3352 @section Sorting Groups
3353 @cindex sorting groups
3355 @kindex C-c C-s (Group)
3356 @findex gnus-group-sort-groups
3357 @vindex gnus-group-sort-function
3358 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3359 group buffer according to the function(s) given by the
3360 @code{gnus-group-sort-function} variable. Available sorting functions
3365 @item gnus-group-sort-by-alphabet
3366 @findex gnus-group-sort-by-alphabet
3367 Sort the group names alphabetically. This is the default.
3369 @item gnus-group-sort-by-real-name
3370 @findex gnus-group-sort-by-real-name
3371 Sort the group alphabetically on the real (unprefixed) group names.
3373 @item gnus-group-sort-by-level
3374 @findex gnus-group-sort-by-level
3375 Sort by group level.
3377 @item gnus-group-sort-by-score
3378 @findex gnus-group-sort-by-score
3379 Sort by group score. @xref{Group Score}.
3381 @item gnus-group-sort-by-rank
3382 @findex gnus-group-sort-by-rank
3383 Sort by group score and then the group level. The level and the score
3384 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3386 @item gnus-group-sort-by-unread
3387 @findex gnus-group-sort-by-unread
3388 Sort by number of unread articles.
3390 @item gnus-group-sort-by-method
3391 @findex gnus-group-sort-by-method
3392 Sort alphabetically on the select method.
3394 @item gnus-group-sort-by-server
3395 @findex gnus-group-sort-by-server
3396 Sort alphabetically on the Gnus server name.
3401 @code{gnus-group-sort-function} can also be a list of sorting
3402 functions. In that case, the most significant sort key function must be
3406 There are also a number of commands for sorting directly according to
3407 some sorting criteria:
3411 @kindex G S a (Group)
3412 @findex gnus-group-sort-groups-by-alphabet
3413 Sort the group buffer alphabetically by group name
3414 (@code{gnus-group-sort-groups-by-alphabet}).
3417 @kindex G S u (Group)
3418 @findex gnus-group-sort-groups-by-unread
3419 Sort the group buffer by the number of unread articles
3420 (@code{gnus-group-sort-groups-by-unread}).
3423 @kindex G S l (Group)
3424 @findex gnus-group-sort-groups-by-level
3425 Sort the group buffer by group level
3426 (@code{gnus-group-sort-groups-by-level}).
3429 @kindex G S v (Group)
3430 @findex gnus-group-sort-groups-by-score
3431 Sort the group buffer by group score
3432 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3435 @kindex G S r (Group)
3436 @findex gnus-group-sort-groups-by-rank
3437 Sort the group buffer by group rank
3438 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3441 @kindex G S m (Group)
3442 @findex gnus-group-sort-groups-by-method
3443 Sort the group buffer alphabetically by back end name@*
3444 (@code{gnus-group-sort-groups-by-method}).
3447 @kindex G S n (Group)
3448 @findex gnus-group-sort-groups-by-real-name
3449 Sort the group buffer alphabetically by real (unprefixed) group name
3450 (@code{gnus-group-sort-groups-by-real-name}).
3454 All the commands below obey the process/prefix convention
3455 (@pxref{Process/Prefix}).
3457 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3458 commands will sort in reverse order.
3460 You can also sort a subset of the groups:
3464 @kindex G P a (Group)
3465 @findex gnus-group-sort-selected-groups-by-alphabet
3466 Sort the groups alphabetically by group name
3467 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3470 @kindex G P u (Group)
3471 @findex gnus-group-sort-selected-groups-by-unread
3472 Sort the groups by the number of unread articles
3473 (@code{gnus-group-sort-selected-groups-by-unread}).
3476 @kindex G P l (Group)
3477 @findex gnus-group-sort-selected-groups-by-level
3478 Sort the groups by group level
3479 (@code{gnus-group-sort-selected-groups-by-level}).
3482 @kindex G P v (Group)
3483 @findex gnus-group-sort-selected-groups-by-score
3484 Sort the groups by group score
3485 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3488 @kindex G P r (Group)
3489 @findex gnus-group-sort-selected-groups-by-rank
3490 Sort the groups by group rank
3491 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3494 @kindex G P m (Group)
3495 @findex gnus-group-sort-selected-groups-by-method
3496 Sort the groups alphabetically by back end name@*
3497 (@code{gnus-group-sort-selected-groups-by-method}).
3500 @kindex G P n (Group)
3501 @findex gnus-group-sort-selected-groups-by-real-name
3502 Sort the groups alphabetically by real (unprefixed) group name
3503 (@code{gnus-group-sort-selected-groups-by-real-name}).
3506 @kindex G P s (Group)
3507 @findex gnus-group-sort-selected-groups
3508 Sort the groups according to @code{gnus-group-sort-function}.
3512 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3516 @node Group Maintenance
3517 @section Group Maintenance
3518 @cindex bogus groups
3523 @findex gnus-group-check-bogus-groups
3524 Find bogus groups and delete them
3525 (@code{gnus-group-check-bogus-groups}).
3529 @findex gnus-group-find-new-groups
3530 Find new groups and process them (@code{gnus-group-find-new-groups}).
3531 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3532 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3533 to query the server for new groups, and subscribe the new groups as
3537 @kindex C-c C-x (Group)
3538 @findex gnus-group-expire-articles
3539 @cindex expiring mail
3540 Run all expirable articles in the current group through the expiry
3541 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3542 all expirable articles in the group that have been around for a while.
3543 (@pxref{Expiring Mail}).
3546 @kindex C-c C-M-x (Group)
3547 @findex gnus-group-expire-all-groups
3548 @cindex expiring mail
3549 Run all expirable articles in all groups through the expiry process
3550 (@code{gnus-group-expire-all-groups}).
3555 @node Browse Foreign Server
3556 @section Browse Foreign Server
3557 @cindex foreign servers
3558 @cindex browsing servers
3563 @findex gnus-group-browse-foreign-server
3564 You will be queried for a select method and a server name. Gnus will
3565 then attempt to contact this server and let you browse the groups there
3566 (@code{gnus-group-browse-foreign-server}).
3569 @findex gnus-browse-mode
3570 A new buffer with a list of available groups will appear. This buffer
3571 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3572 a lot) like a normal group buffer.
3574 Here's a list of keystrokes available in the browse mode:
3579 @findex gnus-group-next-group
3580 Go to the next group (@code{gnus-group-next-group}).
3584 @findex gnus-group-prev-group
3585 Go to the previous group (@code{gnus-group-prev-group}).
3588 @kindex SPACE (Browse)
3589 @findex gnus-browse-read-group
3590 Enter the current group and display the first article
3591 (@code{gnus-browse-read-group}).
3594 @kindex RET (Browse)
3595 @findex gnus-browse-select-group
3596 Enter the current group (@code{gnus-browse-select-group}).
3600 @findex gnus-browse-unsubscribe-current-group
3601 @vindex gnus-browse-subscribe-newsgroup-method
3602 Unsubscribe to the current group, or, as will be the case here,
3603 subscribe to it (@code{gnus-browse-unsubscribe-current-group}). You
3604 can affect the way the new group is entered into the Group buffer
3605 using the variable @code{gnus-browse-subscribe-newsgroup-method}. See
3606 @pxref{Subscription Methods} for available options.
3612 @findex gnus-browse-exit
3613 Exit browse mode (@code{gnus-browse-exit}).
3617 @findex gnus-browse-describe-group
3618 Describe the current group (@code{gnus-browse-describe-group}).
3622 @findex gnus-browse-describe-briefly
3623 Describe browse mode briefly (well, there's not much to describe, is
3624 there) (@code{gnus-browse-describe-briefly}).
3629 @section Exiting Gnus
3630 @cindex exiting Gnus
3632 Yes, Gnus is ex(c)iting.
3637 @findex gnus-group-suspend
3638 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
3639 but it kills all buffers except the Group buffer. I'm not sure why this
3640 is a gain, but then who am I to judge?
3644 @findex gnus-group-exit
3645 @c @icon{gnus-group-exit}
3646 Quit Gnus (@code{gnus-group-exit}).
3650 @findex gnus-group-quit
3651 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3652 The dribble file will be saved, though (@pxref{Auto Save}).
3655 @vindex gnus-exit-gnus-hook
3656 @vindex gnus-suspend-gnus-hook
3657 @vindex gnus-after-exiting-gnus-hook
3658 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
3659 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
3660 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3666 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3667 numbly heavy and herself fall into a hazy trance as the boy sitting
3668 behind her drew repeated lines with his pencil across the back of her
3674 @section Group Topics
3677 If you read lots and lots of groups, it might be convenient to group
3678 them hierarchically according to topics. You put your Emacs groups over
3679 here, your sex groups over there, and the rest (what, two groups or so?)
3680 you put in some misc section that you never bother with anyway. You can
3681 even group the Emacs sex groups as a sub-topic to either the Emacs
3682 groups or the sex groups---or both! Go wild!
3686 \gnusfigure{Group Topics}{400}{
3687 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3698 2: alt.religion.emacs
3701 0: comp.talk.emacs.recovery
3703 8: comp.binaries.fractals
3704 13: comp.sources.unix
3707 @findex gnus-topic-mode
3709 To get this @emph{fab} functionality you simply turn on (ooh!) the
3710 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3711 is a toggling command.)
3713 Go ahead, just try it. I'll still be here when you get back. La de
3714 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3715 Yes, and now press @kbd{l}. There. All your groups are now listed
3716 under @samp{misc}. Doesn't that make you feel all warm and fuzzy?
3719 If you want this permanently enabled, you should add that minor mode to
3720 the hook for the group mode. Put the following line in your
3721 @file{~/.gnus.el} file:
3724 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3728 * Topic Commands:: Interactive E-Z commands.
3729 * Topic Variables:: How to customize the topics the Lisp Way.
3730 * Topic Sorting:: Sorting each topic individually.
3731 * Topic Topology:: A map of the world.
3732 * Topic Parameters:: Parameters that apply to all groups in a topic.
3736 @node Topic Commands
3737 @subsection Topic Commands
3738 @cindex topic commands
3740 When the topic minor mode is turned on, a new @kbd{T} submap will be
3741 available. In addition, a few of the standard keys change their
3742 definitions slightly.
3744 In general, the following kinds of operations are possible on topics.
3745 First of all, you want to create topics. Secondly, you want to put
3746 groups in topics and to move them around until you have an order you
3747 like. The third kind of operation is to show/hide parts of the whole
3748 shebang. You might want to hide a topic including its subtopics and
3749 groups, to get a better overview of the other groups.
3751 Here is a list of the basic keys that you might need to set up topics
3758 @findex gnus-topic-create-topic
3759 Prompt for a new topic name and create it
3760 (@code{gnus-topic-create-topic}).
3764 @kindex T TAB (Topic)
3766 @findex gnus-topic-indent
3767 ``Indent'' the current topic so that it becomes a sub-topic of the
3768 previous topic (@code{gnus-topic-indent}). If given a prefix,
3769 ``un-indent'' the topic instead.
3772 @kindex M-TAB (Topic)
3773 @findex gnus-topic-unindent
3774 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3775 parent of its current parent (@code{gnus-topic-unindent}).
3779 The following two keys can be used to move groups and topics around.
3780 They work like the well-known cut and paste. @kbd{C-k} is like cut and
3781 @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms
3782 kill and yank rather than cut and paste.
3788 @findex gnus-topic-kill-group
3789 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3790 topic will be removed along with the topic.
3794 @findex gnus-topic-yank-group
3795 Yank the previously killed group or topic
3796 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3799 So, to move a topic to the beginning of the list of topics, just hit
3800 @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then,
3801 move the cursor to the beginning of the buffer (just below the ``Gnus''
3802 topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and
3803 paste. Like I said -- E-Z.
3805 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So
3806 you can move topics around as well as groups.
3810 After setting up the topics the way you like them, you might wish to
3811 hide a topic, or to show it again. That's why we have the following
3818 @findex gnus-topic-select-group
3820 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3821 When you perform this command on a group, you'll enter the group, as
3822 usual. When done on a topic line, the topic will be folded (if it was
3823 visible) or unfolded (if it was folded already). So it's basically a
3824 toggling command on topics. In addition, if you give a numerical
3825 prefix, group on that level (and lower) will be displayed.
3829 Now for a list of other commands, in no particular order.
3835 @findex gnus-topic-move-group
3836 Move the current group to some other topic
3837 (@code{gnus-topic-move-group}). This command uses the process/prefix
3838 convention (@pxref{Process/Prefix}).
3842 @findex gnus-topic-jump-to-topic
3843 Go to a topic (@code{gnus-topic-jump-to-topic}).
3847 @findex gnus-topic-copy-group
3848 Copy the current group to some other topic
3849 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3850 convention (@pxref{Process/Prefix}).
3854 @findex gnus-topic-hide-topic
3855 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3856 a prefix, hide the topic permanently.
3860 @findex gnus-topic-show-topic
3861 Show the current topic (@code{gnus-topic-show-topic}). If given
3862 a prefix, show the topic permanently.
3866 @findex gnus-topic-remove-group
3867 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3868 This command is mainly useful if you have the same group in several
3869 topics and wish to remove it from one of the topics. You may also
3870 remove a group from all topics, but in that case, Gnus will add it to
3871 the root topic the next time you start Gnus. In fact, all new groups
3872 (which, naturally, don't belong to any topic) will show up in the root
3875 This command uses the process/prefix convention
3876 (@pxref{Process/Prefix}).
3880 @findex gnus-topic-move-matching
3881 Move all groups that match some regular expression to a topic
3882 (@code{gnus-topic-move-matching}).
3886 @findex gnus-topic-copy-matching
3887 Copy all groups that match some regular expression to a topic
3888 (@code{gnus-topic-copy-matching}).
3892 @findex gnus-topic-toggle-display-empty-topics
3893 Toggle hiding empty topics
3894 (@code{gnus-topic-toggle-display-empty-topics}).
3898 @findex gnus-topic-mark-topic
3899 Mark all groups in the current topic with the process mark
3900 (@code{gnus-topic-mark-topic}). This command works recursively on
3901 sub-topics unless given a prefix.
3904 @kindex T M-# (Topic)
3905 @findex gnus-topic-unmark-topic
3906 Remove the process mark from all groups in the current topic
3907 (@code{gnus-topic-unmark-topic}). This command works recursively on
3908 sub-topics unless given a prefix.
3911 @kindex C-c C-x (Topic)
3912 @findex gnus-topic-expire-articles
3913 @cindex expiring mail
3914 Run all expirable articles in the current group or topic through the
3915 expiry process (if any)
3916 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3920 @findex gnus-topic-rename
3921 Rename a topic (@code{gnus-topic-rename}).
3924 @kindex T DEL (Topic)
3925 @findex gnus-topic-delete
3926 Delete an empty topic (@code{gnus-topic-delete}).
3930 @findex gnus-topic-list-active
3931 List all groups that Gnus knows about in a topics-ified way
3932 (@code{gnus-topic-list-active}).
3935 @kindex T M-n (Topic)
3936 @findex gnus-topic-goto-next-topic
3937 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3940 @kindex T M-p (Topic)
3941 @findex gnus-topic-goto-previous-topic
3942 Go to the previous topic (@code{gnus-topic-goto-previous-topic}).
3946 @findex gnus-topic-edit-parameters
3947 @cindex group parameters
3948 @cindex topic parameters
3950 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3951 @xref{Topic Parameters}.
3956 @node Topic Variables
3957 @subsection Topic Variables
3958 @cindex topic variables
3960 The previous section told you how to tell Gnus which topics to display.
3961 This section explains how to tell Gnus what to display about each topic.
3963 @vindex gnus-topic-line-format
3964 The topic lines themselves are created according to the
3965 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3978 Number of groups in the topic.
3980 Number of unread articles in the topic.
3982 Number of unread articles in the topic and all its subtopics.
3985 @vindex gnus-topic-indent-level
3986 Each sub-topic (and the groups in the sub-topics) will be indented with
3987 @code{gnus-topic-indent-level} times the topic level number of spaces.
3990 @vindex gnus-topic-mode-hook
3991 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3993 @vindex gnus-topic-display-empty-topics
3994 The @code{gnus-topic-display-empty-topics} says whether to display even
3995 topics that have no unread articles in them. The default is @code{t}.
3999 @subsection Topic Sorting
4000 @cindex topic sorting
4002 You can sort the groups in each topic individually with the following
4008 @kindex T S a (Topic)
4009 @findex gnus-topic-sort-groups-by-alphabet
4010 Sort the current topic alphabetically by group name
4011 (@code{gnus-topic-sort-groups-by-alphabet}).
4014 @kindex T S u (Topic)
4015 @findex gnus-topic-sort-groups-by-unread
4016 Sort the current topic by the number of unread articles
4017 (@code{gnus-topic-sort-groups-by-unread}).
4020 @kindex T S l (Topic)
4021 @findex gnus-topic-sort-groups-by-level
4022 Sort the current topic by group level
4023 (@code{gnus-topic-sort-groups-by-level}).
4026 @kindex T S v (Topic)
4027 @findex gnus-topic-sort-groups-by-score
4028 Sort the current topic by group score
4029 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
4032 @kindex T S r (Topic)
4033 @findex gnus-topic-sort-groups-by-rank
4034 Sort the current topic by group rank
4035 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
4038 @kindex T S m (Topic)
4039 @findex gnus-topic-sort-groups-by-method
4040 Sort the current topic alphabetically by back end name
4041 (@code{gnus-topic-sort-groups-by-method}).
4044 @kindex T S e (Topic)
4045 @findex gnus-topic-sort-groups-by-server
4046 Sort the current topic alphabetically by server name
4047 (@code{gnus-topic-sort-groups-by-server}).
4050 @kindex T S s (Topic)
4051 @findex gnus-topic-sort-groups
4052 Sort the current topic according to the function(s) given by the
4053 @code{gnus-group-sort-function} variable
4054 (@code{gnus-topic-sort-groups}).
4058 When given a prefix argument, all these commands will sort in reverse
4059 order. @xref{Sorting Groups}, for more information about group
4063 @node Topic Topology
4064 @subsection Topic Topology
4065 @cindex topic topology
4068 So, let's have a look at an example group buffer:
4075 2: alt.religion.emacs
4078 0: comp.talk.emacs.recovery
4080 8: comp.binaries.fractals
4081 13: comp.sources.unix
4085 So, here we have one top-level topic (@samp{Gnus}), two topics under
4086 that, and one sub-topic under one of the sub-topics. (There is always
4087 just one (1) top-level topic). This topology can be expressed as
4092 (("Emacs -- I wuw it!" visible)
4093 (("Naughty Emacs" visible)))
4097 @vindex gnus-topic-topology
4098 This is in fact how the variable @code{gnus-topic-topology} would look
4099 for the display above. That variable is saved in the @file{.newsrc.eld}
4100 file, and shouldn't be messed with manually---unless you really want
4101 to. Since this variable is read from the @file{.newsrc.eld} file,
4102 setting it in any other startup files will have no effect.
4104 This topology shows what topics are sub-topics of what topics (right),
4105 and which topics are visible. Two settings are currently
4106 allowed---@code{visible} and @code{invisible}.
4109 @node Topic Parameters
4110 @subsection Topic Parameters
4111 @cindex topic parameters
4113 All groups in a topic will inherit group parameters from the parent
4114 (and ancestor) topic parameters. All valid group parameters are valid
4115 topic parameters (@pxref{Group Parameters}). When the agent is
4116 enabled, all agent parameters (See Agent Parameters in @ref{Category
4117 Syntax}) are also valid topic parameters.
4119 In addition, the following parameters are only valid as topic
4124 When subscribing new groups by topic (@pxref{Subscription Methods}), the
4125 @code{subscribe} topic parameter says what groups go in what topic. Its
4126 value should be a regexp to match the groups that should go in that
4129 @item subscribe-level
4130 When subscribing new groups by topic (see the @code{subscribe} parameter),
4131 the group will be subscribed with the level specified in the
4132 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
4136 Group parameters (of course) override topic parameters, and topic
4137 parameters in sub-topics override topic parameters in super-topics. You
4138 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
4139 verb, although you may feel free to disagree with me here.)
4146 2: alt.religion.emacs
4150 0: comp.talk.emacs.recovery
4152 8: comp.binaries.fractals
4153 13: comp.sources.unix
4158 The @samp{Emacs} topic has the topic parameter @code{(score-file
4159 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4160 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4161 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
4162 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4163 . "religion.SCORE")}.
4165 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4166 will get the @file{relief.SCORE} home score file. If you enter the same
4167 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4168 score file. If you enter the group @samp{alt.religion.emacs}, you'll
4169 get the @file{religion.SCORE} home score file.
4171 This seems rather simple and self-evident, doesn't it? Well, yes. But
4172 there are some problems, especially with the @code{total-expiry}
4173 parameter. Say you have a mail group in two topics; one with
4174 @code{total-expiry} and one without. What happens when you do @kbd{M-x
4175 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
4176 of these topics you mean to expire articles from, so anything may
4177 happen. In fact, I hereby declare that it is @dfn{undefined} what
4178 happens. You just have to be careful if you do stuff like that.
4181 @node Non-ASCII Group Names
4182 @section Accessing groups of non-English names
4183 @cindex non-ascii group names
4185 There are some news servers that provide groups of which the names are
4186 expressed with their native languages in the world. For instance, in a
4187 certain news server there are some newsgroups of which the names are
4188 spelled in Chinese, where people are talking in Chinese. You can, of
4189 course, subscribe to such news groups using Gnus. Currently Gnus
4190 supports non-@acronym{ASCII} group names not only with the @code{nntp}
4191 back end but also with the @code{nnml} back end and the @code{nnrss}
4194 Every such group name is encoded by a certain charset in the server
4195 side (in an @acronym{NNTP} server its administrator determines the
4196 charset, but for groups in the other back ends it is determined by you).
4197 Gnus has to display the decoded ones for you in the group buffer and the
4198 article buffer, and needs to use the encoded ones when communicating
4199 with servers. However, Gnus doesn't know what charset is used for each
4200 non-@acronym{ASCII} group name. The following two variables are just
4201 the ones for telling Gnus what charset should be used for each group:
4204 @item gnus-group-name-charset-method-alist
4205 @vindex gnus-group-name-charset-method-alist
4206 An alist of select methods and charsets. The default value is
4207 @code{nil}. The names of groups in the server specified by that select
4208 method are all supposed to use the corresponding charset. For example:
4211 (setq gnus-group-name-charset-method-alist
4212 '(((nntp "news.com.cn") . cn-gb-2312)))
4215 Charsets specified for groups with this variable are preferred to the
4216 ones specified for the same groups with the
4217 @code{gnus-group-name-charset-group-alist} variable (see below).
4219 A select method can be very long, like:
4223 (nntp-address "news.gmane.org")
4224 (nntp-end-of-line "\n")
4225 (nntp-open-connection-function
4226 nntp-open-via-rlogin-and-telnet)
4227 (nntp-via-rlogin-command "ssh")
4228 (nntp-via-rlogin-command-switches
4229 ("-C" "-t" "-e" "none"))
4230 (nntp-via-address @dots{}))
4233 In that case, you can truncate it into @code{(nntp "gmane")} in this
4234 variable. That is, it is enough to contain only the back end name and
4237 @item gnus-group-name-charset-group-alist
4238 @cindex UTF-8 group names
4239 @vindex gnus-group-name-charset-group-alist
4240 An alist of regexp of group name and the charset for group names.
4241 @code{((".*" . utf-8))} is the default value if UTF-8 is supported,
4242 otherwise the default is @code{nil}. For example:
4245 (setq gnus-group-name-charset-group-alist
4246 '(("\\.com\\.cn:" . cn-gb-2312)
4250 Note that this variable is ignored if the match is made with
4251 @code{gnus-group-name-charset-method-alist}.
4254 Those two variables are used also to determine the charset for encoding
4255 and decoding non-@acronym{ASCII} group names that are in the back ends
4256 other than @code{nntp}. It means that it is you who determine it. If
4257 you do nothing, the charset used for group names in those back ends will
4258 all be @code{utf-8} because of the last element of
4259 @code{gnus-group-name-charset-group-alist}.
4261 There is one more important variable for non-@acronym{ASCII} group
4265 @item nnmail-pathname-coding-system
4266 @vindex nnmail-pathname-coding-system
4267 The value of this variable should be a coding system or @code{nil}. The
4268 default is @code{nil} in Emacs, or is the aliasee of the coding system
4269 named @code{file-name} (a certain coding system of which an alias is
4270 @code{file-name}) in XEmacs.
4272 The @code{nnml} back end, the @code{nnrss} back end, the @acronym{NNTP}
4273 marks feature (@pxref{NNTP marks}), the agent, and the cache use
4274 non-@acronym{ASCII} group names in those files and directories. This
4275 variable overrides the value of @code{file-name-coding-system} which
4276 specifies the coding system used when encoding and decoding those file
4277 names and directory names.
4279 In XEmacs (with the @code{mule} feature), @code{file-name-coding-system}
4280 is the only means to specify the coding system used to encode and decode
4281 file names. On the other hand, Emacs uses the value of
4282 @code{default-file-name-coding-system} if @code{file-name-coding-system}
4283 is @code{nil} or it is bound to the value of
4284 @code{nnmail-pathname-coding-system} which is @code{nil}.
4286 Normally the value of @code{default-file-name-coding-system} in Emacs or
4287 @code{nnmail-pathname-coding-system} in XEmacs is initialized according
4288 to the locale, so you will need to do nothing if the value is suitable
4289 to encode and decode non-@acronym{ASCII} group names.
4291 The value of this variable (or @code{default-file-name-coding-system})
4292 does not necessarily need to be the same value that is determined by
4293 @code{gnus-group-name-charset-method-alist} and
4294 @code{gnus-group-name-charset-group-alist}.
4296 If @code{default-file-name-coding-system} or this variable is
4297 initialized by default to @code{iso-latin-1} for example, although you
4298 want to subscribe to the groups spelled in Chinese, that is the most
4299 typical case where you have to customize
4300 @code{nnmail-pathname-coding-system}. The @code{utf-8} coding system is
4301 a good candidate for it. Otherwise, you may change the locale in your
4302 system so that @code{default-file-name-coding-system} or this variable
4303 may be initialized to an appropriate value.
4306 Note that when you copy or move articles from a non-@acronym{ASCII}
4307 group to another group, the charset used to encode and decode group
4308 names should be the same in both groups. Otherwise the Newsgroups
4309 header will be displayed incorrectly in the article buffer.
4316 * nnir:: Searching on IMAP, with swish, namazu, etc.
4317 * nnmairix:: Searching maildir, MH or mbox with Mairix.
4322 FIXME: This node is a stub.
4324 FIXME: Add a brief overview of Gnus search capabilities. A brief
4325 comparison of nnir, nnmairix, contrib/gnus-namazu would be nice
4328 FIXME: Explain difference to @ref{Searching for Articles}, add reference
4334 FIXME: As a first step, convert the commentary of @file{nnir} to texi.
4338 @subsection nnmairix
4342 This paragraph describes how to set up mairix and the back end
4343 @code{nnmairix} for indexing and searching your mail from within
4344 Gnus. Additionally, you can create permanent ``smart'' groups which are
4345 bound to mairix searches and are automatically updated.
4348 * About mairix:: About the mairix mail search engine
4349 * nnmairix requirements:: What you will need for using nnmairix
4350 * What nnmairix does:: What does nnmairix actually do?
4351 * Setting up mairix:: Set up your mairix installation
4352 * Configuring nnmairix:: Set up the nnmairix back end
4353 * nnmairix keyboard shortcuts:: List of available keyboard shortcuts
4354 * Propagating marks:: How to propagate marks from nnmairix groups
4355 * nnmairix tips and tricks:: Some tips, tricks and examples
4356 * nnmairix caveats:: Some more stuff you might want to know
4359 @c FIXME: The markup in this section might need improvement.
4360 @c E.g. adding @samp, @var, @file, @command, etc.
4361 @c Cf. (info "(texinfo)Indicating")
4364 @subsubsection About mairix
4366 Mairix is a tool for indexing and searching words in locally stored
4367 mail. It was written by Richard Curnow and is licensed under the
4368 GPL. Mairix comes with most popular GNU/Linux distributions, but it also
4369 runs under Windows (with cygwin), Mac OS X and Solaris. The homepage can
4371 @uref{http://www.rpcurnow.force9.co.uk/mairix/index.html}
4373 Though mairix might not be as flexible as other search tools like
4374 swish++ or namazu, which you can use via the @code{nnir} back end, it
4375 has the prime advantage of being incredibly fast. On current systems, it
4376 can easily search through headers and message bodies of thousands and
4377 thousands of mails in well under a second. Building the database
4378 necessary for searching might take a minute or two, but only has to be
4379 done once fully. Afterwards, the updates are done incrementally and
4380 therefore are really fast, too. Additionally, mairix is very easy to set
4383 For maximum speed though, mairix should be used with mails stored in
4384 @code{Maildir} or @code{MH} format (this includes the @code{nnml} back
4385 end), although it also works with mbox. Mairix presents the search
4386 results by populating a @emph{virtual} maildir/MH folder with symlinks
4387 which point to the ``real'' message files (if mbox is used, copies are
4388 made). Since mairix already presents search results in such a virtual
4389 mail folder, it is very well suited for using it as an external program
4390 for creating @emph{smart} mail folders, which represent certain mail
4393 @node nnmairix requirements
4394 @subsubsection nnmairix requirements
4396 Mairix searches local mail---that means, mairix absolutely must have
4397 direct access to your mail folders. If your mail resides on another
4398 server (e.g. an @acronym{IMAP} server) and you happen to have shell
4399 access, @code{nnmairix} supports running mairix remotely, e.g. via ssh.
4401 Additionally, @code{nnmairix} only supports the following Gnus back
4402 ends: @code{nnml}, @code{nnmaildir}, and @code{nnimap}. You must use
4403 one of these back ends for using @code{nnmairix}. Other back ends, like
4404 @code{nnmbox}, @code{nnfolder} or @code{nnmh}, won't work.
4406 If you absolutely must use mbox and still want to use @code{nnmairix},
4407 you can set up a local @acronym{IMAP} server, which you then access via
4408 @code{nnimap}. This is a rather massive setup for accessing some mbox
4409 files, so just change to MH or Maildir already... However, if you're
4410 really, really passionate about using mbox, you might want to look into
4411 the package @file{mairix.el}, which comes with Emacs 23.
4413 @node What nnmairix does
4414 @subsubsection What nnmairix does
4416 The back end @code{nnmairix} enables you to call mairix from within Gnus,
4417 either to query mairix with a search term or to update the
4418 database. While visiting a message in the summary buffer, you can use
4419 several pre-defined shortcuts for calling mairix, e.g. to quickly
4420 search for all mails from the sender of the current message or to
4421 display the whole thread associated with the message, even if the
4422 mails are in different folders.
4424 Additionally, you can create permanent @code{nnmairix} groups which are bound
4425 to certain mairix searches. This way, you can easily create a group
4426 containing mails from a certain sender, with a certain subject line or
4427 even for one specific thread based on the Message-ID. If you check for
4428 new mail in these folders (e.g. by pressing @kbd{g} or @kbd{M-g}), they
4429 automatically update themselves by calling mairix.
4431 You might ask why you need @code{nnmairix} at all, since mairix already
4432 creates the group, populates it with links to the mails so that you can
4433 then access it with Gnus, right? Well, this @emph{might} work, but often
4434 does not---at least not without problems. Most probably you will get
4435 strange article counts, and sometimes you might see mails which Gnus
4436 claims have already been canceled and are inaccessible. This is due to
4437 the fact that Gnus isn't really amused when things are happening behind
4438 its back. Another problem can be the mail back end itself, e.g. if you
4439 use mairix with an @acronym{IMAP} server (I had Dovecot complaining
4440 about corrupt index files when mairix changed the contents of the search
4441 group). Using @code{nnmairix} should circumvent these problems.
4443 @code{nnmairix} is not really a mail back end---it's actually more like
4444 a wrapper, sitting between a ``real'' mail back end where mairix stores
4445 the searches and the Gnus front end. You can choose between three
4446 different mail back ends for the mairix folders: @code{nnml},
4447 @code{nnmaildir} or @code{nnimap}. @code{nnmairix} will call the mairix
4448 binary so that the search results are stored in folders named
4449 @code{zz_mairix-<NAME>-<NUMBER>} on this mail back end, but it will
4450 present these folders in the Gnus front end only with @code{<NAME>}.
4451 You can use an existing mail back end where you already store your mail,
4452 but if you're uncomfortable with @code{nnmairix} creating new mail
4453 groups alongside your other mail, you can also create e.g. a new
4454 @code{nnmaildir} or @code{nnml} server exclusively for mairix, but then
4455 make sure those servers do not accidentally receive your new mail
4456 (@pxref{nnmairix caveats}). A special case exists if you want to use
4457 mairix remotely on an IMAP server with @code{nnimap}---here the mairix
4458 folders and your other mail must be on the same @code{nnimap} back end.
4460 @node Setting up mairix
4461 @subsubsection Setting up mairix
4463 First: create a backup of your mail folders (@pxref{nnmairix caveats}).
4465 Setting up mairix is easy: simply create a @file{.mairixrc} file with
4466 (at least) the following entries:
4469 # Your Maildir/MH base folder
4473 This is the base folder for your mails. All the following directories
4474 are relative to this base folder. If you want to use @code{nnmairix}
4475 with @code{nnimap}, this base directory has to point to the mail
4476 directory where the @acronym{IMAP} server stores the mail folders!
4479 maildir= ... your maildir folders which should be indexed ...
4480 mh= ... your nnml/mh folders which should be indexed ...
4481 mbox = ... your mbox files which should be indexed ...
4484 This specifies all your mail folders and mbox files (relative to the
4485 base directory!) you want to index with mairix. Note that the
4486 @code{nnml} back end saves mails in MH format, so you have to put those
4487 directories in the @code{mh} line. See the example at the end of this
4488 section and mairixrc's man-page for further details.
4494 @vindex nnmairix-group-prefix
4495 This should make sure that you don't accidentally index the mairix
4496 search results. You can change the prefix of these folders with the
4497 variable @code{nnmairix-group-prefix}.
4500 mformat= ... 'maildir' or 'mh' ...
4501 database= ... location of database file ...
4504 The @code{format} setting specifies the output format for the mairix
4505 search folder. Set this to @code{mh} if you want to access search results
4506 with @code{nnml}. Otherwise choose @code{maildir}.
4508 To summarize, here is my shortened @file{.mairixrc} file as an example:
4512 maildir=.personal:.work:.logcheck:.sent
4513 mh=../Mail/nnml/*...
4514 mbox=../mboxmail/mailarchive_year*
4517 database=~/.mairixdatabase
4520 In this case, the base directory is @file{~/Maildir}, where all my Maildir
4521 folders are stored. As you can see, the folders are separated by
4522 colons. If you wonder why every folder begins with a dot: this is
4523 because I use Dovecot as @acronym{IMAP} server, which again uses
4524 @code{Maildir++} folders. For testing nnmairix, I also have some
4525 @code{nnml} mail, which is saved in @file{~/Mail/nnml}. Since this has
4526 to be specified relative to the @code{base} directory, the @code{../Mail}
4527 notation is needed. Note that the line ends in @code{*...}, which means
4528 to recursively scan all files under this directory. Without the three
4529 dots, the wildcard @code{*} will not work recursively. I also have some
4530 old mbox files with archived mail lying around in @file{~/mboxmail}.
4531 The other lines should be obvious.
4533 See the man page for @code{mairixrc} for details and further options,
4534 especially regarding wildcard usage, which may be a little different
4535 than you are used to.
4537 Now simply call @code{mairix} to create the index for the first time.
4538 Note that this may take a few minutes, but every following index will do
4539 the updates incrementally and hence is very fast.
4541 @node Configuring nnmairix
4542 @subsubsection Configuring nnmairix
4544 In group mode, type @kbd{G b c}
4545 (@code{nnmairix-create-server-and-default-group}). This will ask you for all
4546 necessary information and create a @code{nnmairix} server as a foreign
4547 server. You will have to specify the following:
4552 The @strong{name} of the @code{nnmairix} server---choose whatever you
4556 The name of the @strong{back end server} where mairix should store its
4557 searches. This must be a full server name, like @code{nnml:mymail}.
4558 Just hit @kbd{TAB} to see the available servers. Currently, servers
4559 which are accessed through @code{nnmaildir}, @code{nnimap} and
4560 @code{nnml} are supported. As explained above, for locally stored
4561 mails, this can be an existing server where you store your mails.
4562 However, you can also create e.g. a new @code{nnmaildir} or @code{nnml}
4563 server exclusively for @code{nnmairix} in your secondary select methods
4564 (@pxref{Finding the News}). If you use a secondary @code{nnml} server
4565 just for mairix, make sure that you explicitly set the server variable
4566 @code{nnml-get-new-mail} to @code{nil}, or you might loose mail
4567 (@pxref{nnmairix caveats}). If you want to use mairix remotely on an
4568 @acronym{IMAP} server, you have to choose the corresponding
4569 @code{nnimap} server here.
4572 @vindex nnmairix-mairix-search-options
4573 The @strong{command} to call the mairix binary. This will usually just
4574 be @code{mairix}, but you can also choose something like @code{ssh
4575 SERVER mairix} if you want to call mairix remotely, e.g. on your
4576 @acronym{IMAP} server. If you want to add some default options to
4577 mairix, you could do this here, but better use the variable
4578 @code{nnmairix-mairix-search-options} instead.
4581 The name of the @strong{default search group}. This will be the group
4582 where all temporary mairix searches are stored, i.e. all searches which
4583 are not bound to permanent @code{nnmairix} groups. Choose whatever you
4587 If the mail back end is @code{nnimap} or @code{nnmaildir}, you will be
4588 asked if you work with @strong{Maildir++}, i.e. with hidden maildir
4589 folders (=beginning with a dot). For example, you have to answer
4590 @samp{yes} here if you work with the Dovecot @acronym{IMAP}
4591 server. Otherwise, you should answer @samp{no} here.
4595 @node nnmairix keyboard shortcuts
4596 @subsubsection nnmairix keyboard shortcuts
4603 @kindex G b c (Group)
4604 @findex nnmairix-create-server-and-default-group
4605 Creates @code{nnmairix} server and default search group for this server
4606 (@code{nnmairix-create-server-and-default-group}). You should have done
4607 this by now (@pxref{Configuring nnmairix}).
4610 @kindex G b s (Group)
4611 @findex nnmairix-search
4612 Prompts for query which is then sent to the mairix binary. Search
4613 results are put into the default search group which is automatically
4614 displayed (@code{nnmairix-search}).
4617 @kindex G b m (Group)
4618 @findex nnmairix-widget-search
4619 Allows you to create a mairix search or a permanent group more
4620 comfortably using graphical widgets, similar to a customization
4621 group. Just try it to see how it works (@code{nnmairix-widget-search}).
4624 @kindex G b i (Group)
4625 @findex nnmairix-search-interactive
4626 Another command for creating a mairix query more comfortably, but uses
4627 only the minibuffer (@code{nnmairix-search-interactive}).
4630 @kindex G b g (Group)
4631 @findex nnmairix-create-search-group
4632 Creates a permanent group which is associated with a search query
4633 (@code{nnmairix-create-search-group}). The @code{nnmairix} back end
4634 automatically calls mairix when you update this group with @kbd{g} or
4638 @kindex G b q (Group)
4639 @findex nnmairix-group-change-query-this-group
4640 Changes the search query for the @code{nnmairix} group under cursor
4641 (@code{nnmairix-group-change-query-this-group}).
4644 @kindex G b t (Group)
4645 @findex nnmairix-group-toggle-threads-this-group
4646 Toggles the 'threads' parameter for the @code{nnmairix} group under cursor,
4647 i.e. if you want see the whole threads of the found messages
4648 (@code{nnmairix-group-toggle-threads-this-group}).
4651 @kindex G b u (Group)
4652 @findex nnmairix-update-database
4653 @vindex nnmairix-mairix-update-options
4654 Calls mairix binary for updating the database
4655 (@code{nnmairix-update-database}). The default parameters are @code{-F}
4656 and @code{-Q} for making this as fast as possible (see variable
4657 @code{nnmairix-mairix-update-options} for defining these default
4661 @kindex G b r (Group)
4662 @findex nnmairix-group-toggle-readmarks-this-group
4663 Keep articles in this @code{nnmairix} group always read or unread, or leave the
4664 marks unchanged (@code{nnmairix-group-toggle-readmarks-this-group}).
4667 @kindex G b d (Group)
4668 @findex nnmairix-group-delete-recreate-this-group
4669 Recreate @code{nnmairix} group on the ``real'' mail back end
4670 (@code{nnmairix-group-delete-recreate-this-group}). You can do this if
4671 you always get wrong article counts with a @code{nnmairix} group.
4674 @kindex G b a (Group)
4675 @findex nnmairix-group-toggle-allowfast-this-group
4676 Toggles the @code{allow-fast} parameters for group under cursor
4677 (@code{nnmairix-group-toggle-allowfast-this-group}). The default
4678 behavior of @code{nnmairix} is to do a mairix search every time you
4679 update or enter the group. With the @code{allow-fast} parameter set,
4680 mairix will only be called when you explicitly update the group, but not
4681 upon entering. This makes entering the group faster, but it may also
4682 lead to dangling symlinks if something changed between updating and
4683 entering the group which is not yet in the mairix database.
4686 @kindex G b p (Group)
4687 @findex nnmairix-group-toggle-propmarks-this-group
4688 Toggle marks propagation for this group
4689 (@code{nnmairix-group-toggle-propmarks-this-group}). (@pxref{Propagating
4693 @kindex G b o (Group)
4694 @findex nnmairix-propagate-marks
4695 Manually propagate marks (@code{nnmairix-propagate-marks}); needed only when
4696 @code{nnmairix-propagate-marks-upon-close} is set to @code{nil}.
4705 @kindex $ m (Summary)
4706 @findex nnmairix-widget-search-from-this-article
4707 Allows you to create a mairix query or group based on the current
4708 message using graphical widgets (same as @code{nnmairix-widget-search})
4709 (@code{nnmairix-widget-search-from-this-article}).
4712 @kindex $ g (Summary)
4713 @findex nnmairix-create-search-group-from-message
4714 Interactively creates a new search group with query based on the current
4715 message, but uses the minibuffer instead of graphical widgets
4716 (@code{nnmairix-create-search-group-from-message}).
4719 @kindex $ t (Summary)
4720 @findex nnmairix-search-thread-this-article
4721 Searches thread for the current article
4722 (@code{nnmairix-search-thread-this-article}). This is effectively a
4723 shortcut for calling @code{nnmairix-search} with @samp{m:msgid} of the
4724 current article and enabled threads.
4727 @kindex $ f (Summary)
4728 @findex nnmairix-search-from-this-article
4729 Searches all messages from sender of the current article
4730 (@code{nnmairix-search-from-this-article}). This is a shortcut for
4731 calling @code{nnmairix-search} with @samp{f:From}.
4734 @kindex $ o (Summary)
4735 @findex nnmairix-goto-original-article
4736 (Only in @code{nnmairix} groups!) Tries determine the group this article
4737 originally came from and displays the article in this group, so that
4738 e.g. replying to this article the correct posting styles/group
4739 parameters are applied (@code{nnmairix-goto-original-article}). This
4740 function will use the registry if available, but can also parse the
4741 article file name as a fallback method.
4744 @kindex $ u (Summary)
4745 @findex nnmairix-remove-tick-mark-original-article
4746 Remove possibly existing tick mark from original article
4747 (@code{nnmairix-remove-tick-mark-original-article}). (@pxref{nnmairix
4752 @node Propagating marks
4753 @subsubsection Propagating marks
4755 First of: you really need a patched mairix binary for using the marks
4756 propagation feature efficiently. Otherwise, you would have to update
4757 the mairix database all the time. You can get the patch at
4759 @uref{http://www.randomsample.de/mairix-maildir-patch.tar}
4761 You need the mairix v0.21 source code for this patch; everything else
4762 is explained in the accompanied readme file. If you don't want to use
4763 marks propagation, you don't have to apply these patches, but they also
4764 fix some annoyances regarding changing maildir flags, so it might still
4767 With the patched mairix binary, you can use @code{nnmairix} as an
4768 alternative to mail splitting (@pxref{Fancy Mail Splitting}). For
4769 example, instead of splitting all mails from @samp{david@@foobar.com}
4770 into a group, you can simply create a search group with the query
4771 @samp{f:david@@foobar.com}. This is actually what ``smart folders'' are
4772 all about: simply put everything in one mail folder and dynamically
4773 create searches instead of splitting. This is more flexible, since you
4774 can dynamically change your folders any time you want to. This also
4775 implies that you will usually read your mails in the @code{nnmairix}
4776 groups instead of your ``real'' mail groups.
4778 There is one problem, though: say you got a new mail from
4779 @samp{david@@foobar.com}; it will now show up in two groups, the
4780 ``real'' group (your INBOX, for example) and in the @code{nnmairix}
4781 search group (provided you have updated the mairix database). Now you
4782 enter the @code{nnmairix} group and read the mail. The mail will be
4783 marked as read, but only in the @code{nnmairix} group---in the ``real''
4784 mail group it will be still shown as unread.
4786 You could now catch up the mail group (@pxref{Group Data}), but this is
4787 tedious and error prone, since you may overlook mails you don't have
4788 created @code{nnmairix} groups for. Of course, you could first use
4789 @code{nnmairix-goto-original-article} (@pxref{nnmairix keyboard
4790 shortcuts}) and then read the mail in the original group, but that's
4791 even more cumbersome.
4793 Clearly, the easiest way would be if marks could somehow be
4794 automatically set for the original article. This is exactly what
4795 @emph{marks propagation} is about.
4797 Marks propagation is deactivated by default. You can activate it for a
4798 certain @code{nnmairix} group with
4799 @code{nnmairix-group-toggle-propmarks-this-group} (bound to @kbd{G b
4800 p}). This function will warn you if you try to use it with your default
4801 search group; the reason is that the default search group is used for
4802 temporary searches, and it's easy to accidentally propagate marks from
4803 this group. However, you can ignore this warning if you really want to.
4805 With marks propagation enabled, all the marks you set in a @code{nnmairix}
4806 group should now be propagated to the original article. For example,
4807 you can now tick an article (by default with @kbd{!}) and this mark should
4808 magically be set for the original article, too.
4810 A few more remarks which you may or may not want to know:
4812 @vindex nnmairix-propagate-marks-upon-close
4813 Marks will not be set immediately, but only upon closing a group. This
4814 not only makes marks propagation faster, it also avoids problems with
4815 dangling symlinks when dealing with maildir files (since changing flags
4816 will change the file name). You can also control when to propagate marks
4817 via @code{nnmairix-propagate-marks-upon-close} (see the doc-string for
4820 Obviously, @code{nnmairix} will have to look up the original group for every
4821 article you want to set marks for. If available, @code{nnmairix} will first use
4822 the registry for determining the original group. The registry is very
4823 fast, hence you should really, really enable the registry when using
4824 marks propagation. If you don't have to worry about RAM and disc space,
4825 set @code{gnus-registry-max-entries} to a large enough value; to be on
4826 the safe side, choose roughly the amount of mails you index with mairix.
4828 @vindex nnmairix-only-use-registry
4829 If you don't want to use the registry or the registry hasn't seen the
4830 original article yet, @code{nnmairix} will use an additional mairix
4831 search for determining the file name of the article. This, of course, is
4832 way slower than the registry---if you set hundreds or even thousands of
4833 marks this way, it might take some time. You can avoid this situation by
4834 setting @code{nnmairix-only-use-registry} to t.
4836 Maybe you also want to propagate marks the other way round, i.e. if you
4837 tick an article in a "real" mail group, you'd like to have the same
4838 article in a @code{nnmairix} group ticked, too. For several good
4839 reasons, this can only be done efficiently if you use maildir. To
4840 immediately contradict myself, let me mention that it WON'T work with
4841 @code{nnmaildir}, since @code{nnmaildir} stores the marks externally and
4842 not in the file name. Therefore, propagating marks to @code{nnmairix}
4843 groups will usually only work if you use an IMAP server which uses
4844 maildir as its file format.
4846 @vindex nnmairix-propagate-marks-to-nnmairix-groups
4847 If you work with this setup, just set
4848 @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t} and see what
4849 happens. If you don't like what you see, just set it to @code{nil} again. One
4850 problem might be that you get a wrong number of unread articles; this
4851 usually happens when you delete or expire articles in the original
4852 groups. When this happens, you can recreate the @code{nnmairix} group on the
4853 back end using @kbd{G b d}.
4855 @node nnmairix tips and tricks
4856 @subsubsection nnmairix tips and tricks
4862 @findex nnmairix-update-groups
4863 I put all my important mail groups at group level 1. The mairix groups
4864 have group level 5, so they do not get checked at start up (@pxref{Group
4867 I use the following to check for mails:
4870 (defun my-check-mail-mairix-update (level)
4872 ;; if no prefix given, set level=1
4873 (gnus-group-get-new-news (or level 1))
4874 (nnmairix-update-groups "mairixsearch" t t)
4875 (gnus-group-list-groups))
4877 (define-key gnus-group-mode-map "g" 'my-check-mail-mairix-update)
4880 Instead of @samp{"mairixsearch"} use the name of your @code{nnmairix}
4881 server. See the doc string for @code{nnmairix-update-groups} for
4885 Example: search group for ticked articles
4887 For example, you can create a group for all ticked articles, where the
4888 articles always stay unread:
4890 Hit @kbd{G b g}, enter group name (e.g. @samp{important}), use
4891 @samp{F:f} as query and do not include threads.
4893 Now activate marks propagation for this group by using @kbd{G b p}. Then
4894 activate the always-unread feature by using @kbd{G b r} twice.
4896 So far so good---but how do you remove the tick marks in the @code{nnmairix}
4897 group? There are two options: You may simply use
4898 @code{nnmairix-remove-tick-mark-original-article} (bound to @kbd{$ u}) to remove
4899 tick marks from the original article. The other possibility is to set
4900 @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t}, but see the above
4901 comments about this option. If it works for you, the tick marks should
4902 also exist in the @code{nnmairix} group and you can remove them as usual,
4903 e.g. by marking an article as read.
4905 When you have removed a tick mark from the original article, this
4906 article should vanish from the @code{nnmairix} group after you have updated the
4907 mairix database and updated the group. Fortunately, there is a function
4908 for doing exactly that: @code{nnmairix-update-groups}. See the previous code
4909 snippet and the doc string for details.
4912 Dealing with auto-subscription of mail groups
4914 As described before, all @code{nnmairix} groups are in fact stored on
4915 the mail back end in the form @samp{zz_mairix-<NAME>-<NUMBER>}. You can
4916 see them when you enter the back end server in the server buffer. You
4917 should not subscribe these groups! Unfortunately, these groups will
4918 usually get @emph{auto-subscribed} when you use @code{nnmaildir} or
4919 @code{nnml}, i.e. you will suddenly see groups of the form
4920 @samp{zz_mairix*} pop up in your group buffer. If this happens to you,
4921 simply kill these groups with C-k. For avoiding this, turn off
4922 auto-subscription completely by setting the variable
4923 @code{gnus-auto-subscribed-groups} to @code{nil} (@pxref{Filtering New
4924 Groups}), or if you like to keep this feature use the following kludge
4925 for turning it off for all groups beginning with @samp{zz_}:
4928 (setq gnus-auto-subscribed-groups
4929 "^\\(nnml\\|nnfolder\\|nnmbox\\|nnmh\\|nnbabyl\\|nnmaildir\\).*:\\([^z]\\|z$\\|\\z[^z]\\|zz$\\|zz[^_]\\|zz_$\\).*")
4934 @node nnmairix caveats
4935 @subsubsection nnmairix caveats
4939 You can create a secondary @code{nnml} server just for nnmairix, but then
4940 you have to explicitly set the corresponding server variable
4941 @code{nnml-get-new-mail} to @code{nil}. Otherwise, new mail might get
4942 put into this secondary server (and would never show up again). Here's
4943 an example server definition:
4946 (nnml "mairix" (nnml-directory "mairix") (nnml-get-new-mail nil))
4949 (The @code{nnmaildir} back end also has a server variabe
4950 @code{get-new-mail}, but its default value is @code{nil}, so you don't
4951 have to explicitly set it if you use a @code{nnmaildir} server just for
4955 If you use the Gnus registry: don't use the registry with
4956 @code{nnmairix} groups (put them in
4957 @code{gnus-registry-unfollowed-groups}). Be @emph{extra careful} if
4958 you use @code{gnus-registry-split-fancy-with-parent}; mails which are
4959 split into @code{nnmairix} groups are usually gone for good as soon as
4960 you check the group for new mail (yes, it has happened to me...).
4963 Therefore: @emph{Never ever} put ``real'' mails into @code{nnmairix}
4964 groups (you shouldn't be able to, anyway).
4967 If you use the Gnus agent (@pxref{Gnus Unplugged}): don't agentize
4968 @code{nnmairix} groups (though I have no idea what happens if you do).
4971 mairix does only support us-ascii characters.
4974 @code{nnmairix} uses a rather brute force method to force Gnus to
4975 completely reread the group on the mail back end after mairix was
4976 called---it simply deletes and re-creates the group on the mail
4977 back end. So far, this has worked for me without any problems, and I
4978 don't see how @code{nnmairix} could delete other mail groups than its
4979 own, but anyway: you really should have a backup of your mail
4983 All necessary information is stored in the group parameters
4984 (@pxref{Group Parameters}). This has the advantage that no active file
4985 is needed, but also implies that when you kill a @code{nnmairix} group,
4986 it is gone for good.
4989 @findex nnmairix-purge-old-groups
4990 If you create and kill a lot of @code{nnmairix} groups, the
4991 ``zz_mairix-*'' groups will accumulate on the mail back end server. To
4992 delete old groups which are no longer needed, call
4993 @code{nnmairix-purge-old-groups}. Note that this assumes that you don't
4994 save any ``real'' mail in folders of the form
4995 @code{zz_mairix-<NAME>-<NUMBER>}. You can change the prefix of
4996 @code{nnmairix} groups by changing the variable
4997 @code{nnmairix-group-prefix}.
5000 The following only applies if you @emph{don't} use the mentioned patch
5001 for mairix (@pxref{Propagating marks}):
5003 A problem can occur when using @code{nnmairix} with maildir folders and
5004 comes with the fact that maildir stores mail flags like @samp{Seen} or
5005 @samp{Replied} by appending chars @samp{S} and @samp{R} to the message
5006 file name, respectively. This implies that currently you would have to
5007 update the mairix database not only when new mail arrives, but also when
5008 mail flags are changing. The same applies to new mails which are indexed
5009 while they are still in the @samp{new} folder but then get moved to
5010 @samp{cur} when Gnus has seen the mail. If you don't update the database
5011 after this has happened, a mairix query can lead to symlinks pointing to
5012 non-existing files. In Gnus, these messages will usually appear with
5013 ``(none)'' entries in the header and can't be accessed. If this happens
5014 to you, using @kbd{G b u} and updating the group will usually fix this.
5018 @node Misc Group Stuff
5019 @section Misc Group Stuff
5022 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
5023 * Group Information:: Information and help on groups and Gnus.
5024 * Group Timestamp:: Making Gnus keep track of when you last read a group.
5025 * File Commands:: Reading and writing the Gnus files.
5026 * Sieve Commands:: Managing Sieve scripts.
5033 @cindex keys, reserved for users (Group)
5034 The key @kbd{v} is reserved for users. You can bind it to some
5035 command or better use it as a prefix key. For example:
5038 (define-key gnus-group-mode-map (kbd "v j d")
5041 (gnus-group-jump-to-group "nndraft:drafts")))
5044 On keys reserved for users in Emacs and on keybindings in general
5045 @xref{Keymaps, Keymaps, , emacs, The Emacs Editor}.
5049 @findex gnus-group-enter-server-mode
5050 Enter the server buffer (@code{gnus-group-enter-server-mode}).
5051 @xref{Server Buffer}.
5055 @findex gnus-group-post-news
5056 Start composing a message (a news by default)
5057 (@code{gnus-group-post-news}). If given a prefix, post to the group
5058 under the point. If the prefix is 1, prompt for a group to post to.
5059 Contrary to what the name of this function suggests, the prepared
5060 article might be a mail instead of a news, if a mail group is specified
5061 with the prefix argument. @xref{Composing Messages}.
5065 @findex gnus-group-mail
5066 Mail a message somewhere (@code{gnus-group-mail}). If given a prefix,
5067 use the posting style of the group under the point. If the prefix is 1,
5068 prompt for a group name to find the posting style.
5069 @xref{Composing Messages}.
5073 @findex gnus-group-news
5074 Start composing a news (@code{gnus-group-news}). If given a prefix,
5075 post to the group under the point. If the prefix is 1, prompt
5076 for group to post to. @xref{Composing Messages}.
5078 This function actually prepares a news even when using mail groups.
5079 This is useful for ``posting'' messages to mail groups without actually
5080 sending them over the network: they're just saved directly to the group
5081 in question. The corresponding back end must have a request-post method
5082 for this to work though.
5086 @findex gnus-group-compact-group
5088 Compact the group under point (@code{gnus-group-compact-group}).
5089 Currently implemented only in nnml (@pxref{Mail Spool}). This removes
5090 gaps between article numbers, hence getting a correct total article
5095 Variables for the group buffer:
5099 @item gnus-group-mode-hook
5100 @vindex gnus-group-mode-hook
5101 is called after the group buffer has been
5104 @item gnus-group-prepare-hook
5105 @vindex gnus-group-prepare-hook
5106 is called after the group buffer is
5107 generated. It may be used to modify the buffer in some strange,
5110 @item gnus-group-prepared-hook
5111 @vindex gnus-group-prepare-hook
5112 is called as the very last thing after the group buffer has been
5113 generated. It may be used to move point around, for instance.
5115 @item gnus-permanently-visible-groups
5116 @vindex gnus-permanently-visible-groups
5117 Groups matching this regexp will always be listed in the group buffer,
5118 whether they are empty or not.
5122 @node Scanning New Messages
5123 @subsection Scanning New Messages
5124 @cindex new messages
5125 @cindex scanning new news
5131 @findex gnus-group-get-new-news
5132 @c @icon{gnus-group-get-new-news}
5133 Check the server(s) for new articles. If the numerical prefix is used,
5134 this command will check only groups of level @var{arg} and lower
5135 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
5136 command will force a total re-reading of the active file(s) from the
5141 @findex gnus-group-get-new-news-this-group
5142 @vindex gnus-goto-next-group-when-activating
5143 @c @icon{gnus-group-get-new-news-this-group}
5144 Check whether new articles have arrived in the current group
5145 (@code{gnus-group-get-new-news-this-group}).
5146 @code{gnus-goto-next-group-when-activating} says whether this command is
5147 to move point to the next group or not. It is @code{t} by default.
5149 @findex gnus-activate-all-groups
5150 @cindex activating groups
5152 @kindex C-c M-g (Group)
5153 Activate absolutely all groups (@code{gnus-activate-all-groups}).
5158 @findex gnus-group-restart
5159 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
5160 file(s), closes the connection to all servers, clears up all run-time
5161 Gnus variables, and then starts Gnus all over again.
5165 @vindex gnus-get-new-news-hook
5166 @code{gnus-get-new-news-hook} is run just before checking for new news.
5168 @vindex gnus-after-getting-new-news-hook
5169 @code{gnus-after-getting-new-news-hook} is run after checking for new
5173 @node Group Information
5174 @subsection Group Information
5175 @cindex group information
5176 @cindex information on groups
5183 @findex gnus-group-fetch-faq
5184 @vindex gnus-group-faq-directory
5187 Try to fetch the @acronym{FAQ} for the current group
5188 (@code{gnus-group-fetch-faq}). Gnus will try to get the @acronym{FAQ}
5189 from @code{gnus-group-faq-directory}, which is usually a directory on
5190 a remote machine. This variable can also be a list of directories.
5191 In that case, giving a prefix to this command will allow you to choose
5192 between the various sites. @code{ange-ftp} (or @code{efs}) will be
5193 used for fetching the file.
5195 If fetching from the first site is unsuccessful, Gnus will attempt to go
5196 through @code{gnus-group-faq-directory} and try to open them one by one.
5200 @findex gnus-group-fetch-control
5201 @vindex gnus-group-fetch-control-use-browse-url
5202 @cindex control message
5203 Fetch the control messages for the group from the archive at
5204 @code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a
5205 group if given a prefix argument.
5207 If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
5208 Gnus will open the control messages in a browser using
5209 @code{browse-url}. Otherwise they are fetched using @code{ange-ftp}
5210 and displayed in an ephemeral group.
5212 Note that the control messages are compressed. To use this command
5213 you need to turn on @code{auto-compression-mode} (@pxref{Compressed
5214 Files, ,Compressed Files, emacs, The Emacs Manual}).
5218 @c @icon{gnus-group-describe-group}
5220 @kindex C-c C-d (Group)
5221 @cindex describing groups
5222 @cindex group description
5223 @findex gnus-group-describe-group
5224 Describe the current group (@code{gnus-group-describe-group}). If given
5225 a prefix, force Gnus to re-read the description from the server.
5229 @findex gnus-group-describe-all-groups
5230 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
5231 prefix, force Gnus to re-read the description file from the server.
5238 @findex gnus-version
5239 Display current Gnus version numbers (@code{gnus-version}).
5243 @findex gnus-group-describe-briefly
5244 Give a very short help message (@code{gnus-group-describe-briefly}).
5247 @kindex C-c C-i (Group)
5250 @findex gnus-info-find-node
5251 Go to the Gnus info node (@code{gnus-info-find-node}).
5255 @node Group Timestamp
5256 @subsection Group Timestamp
5258 @cindex group timestamps
5260 It can be convenient to let Gnus keep track of when you last read a
5261 group. To set the ball rolling, you should add
5262 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
5265 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
5268 After doing this, each time you enter a group, it'll be recorded.
5270 This information can be displayed in various ways---the easiest is to
5271 use the @samp{%d} spec in the group line format:
5274 (setq gnus-group-line-format
5275 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
5278 This will result in lines looking like:
5281 * 0: mail.ding 19961002T012943
5282 0: custom 19961002T012713
5285 As you can see, the date is displayed in compact ISO 8601 format. This
5286 may be a bit too much, so to just display the date, you could say
5290 (setq gnus-group-line-format
5291 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
5294 If you would like greater control of the time format, you can use a
5295 user-defined format spec. Something like the following should do the
5299 (setq gnus-group-line-format
5300 "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
5301 (defun gnus-user-format-function-d (headers)
5302 (let ((time (gnus-group-timestamp gnus-tmp-group)))
5304 (format-time-string "%b %d %H:%M" time)
5310 @subsection File Commands
5311 @cindex file commands
5317 @findex gnus-group-read-init-file
5318 @vindex gnus-init-file
5319 @cindex reading init file
5320 Re-read the init file (@code{gnus-init-file}, which defaults to
5321 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
5325 @findex gnus-group-save-newsrc
5326 @cindex saving .newsrc
5327 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
5328 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
5329 file(s) whether Gnus thinks it is necessary or not.
5332 @c @kindex Z (Group)
5333 @c @findex gnus-group-clear-dribble
5334 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
5339 @node Sieve Commands
5340 @subsection Sieve Commands
5341 @cindex group sieve commands
5343 Sieve is a server-side mail filtering language. In Gnus you can use
5344 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
5345 sieve rules that should apply to each group. Gnus provides two
5346 commands to translate all these group parameters into a proper Sieve
5347 script that can be transfered to the server somehow.
5349 @vindex gnus-sieve-file
5350 @vindex gnus-sieve-region-start
5351 @vindex gnus-sieve-region-end
5352 The generated Sieve script is placed in @code{gnus-sieve-file} (by
5353 default @file{~/.sieve}). The Sieve code that Gnus generate is placed
5354 between two delimiters, @code{gnus-sieve-region-start} and
5355 @code{gnus-sieve-region-end}, so you may write additional Sieve code
5356 outside these delimiters that will not be removed the next time you
5357 regenerate the Sieve script.
5359 @vindex gnus-sieve-crosspost
5360 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
5361 is generated. If it is non-@code{nil} (the default) articles is
5362 placed in all groups that have matching rules, otherwise the article
5363 is only placed in the group with the first matching rule. For
5364 example, the group parameter @samp{(sieve address "sender"
5365 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
5366 code if @code{gnus-sieve-crosspost} is @code{nil}. (When
5367 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
5368 except that the line containing the call to @code{stop} is removed.)
5371 if address "sender" "owner-ding@@hpc.uh.edu" @{
5372 fileinto "INBOX.ding";
5377 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
5383 @findex gnus-sieve-generate
5384 @vindex gnus-sieve-file
5385 @cindex generating sieve script
5386 Regenerate a Sieve script from the @code{sieve} group parameters and
5387 put you into the @code{gnus-sieve-file} without saving it.
5391 @findex gnus-sieve-update
5392 @vindex gnus-sieve-file
5393 @cindex updating sieve script
5394 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
5395 @code{sieve} group parameters, save the file and upload it to the
5396 server using the @code{sieveshell} program.
5401 @node Summary Buffer
5402 @chapter Summary Buffer
5403 @cindex summary buffer
5405 A line for each article is displayed in the summary buffer. You can
5406 move around, read articles, post articles and reply to articles.
5408 The most common way to a summary buffer is to select a group from the
5409 group buffer (@pxref{Selecting a Group}).
5411 You can have as many summary buffers open as you wish.
5413 You can customize the Summary Mode tool bar, see @kbd{M-x
5414 customize-apropos RET gnus-summary-tool-bar}. This feature is only
5418 @cindex keys, reserved for users (Summary)
5419 The key @kbd{v} is reserved for users. You can bind it to some
5420 command or better use it as a prefix key. For example:
5422 (define-key gnus-summary-mode-map (kbd "v -") "LrS") ;; lower subthread
5426 * Summary Buffer Format:: Deciding how the summary buffer is to look.
5427 * Summary Maneuvering:: Moving around the summary buffer.
5428 * Choosing Articles:: Reading articles.
5429 * Paging the Article:: Scrolling the current article.
5430 * Reply Followup and Post:: Posting articles.
5431 * Delayed Articles:: Send articles at a later time.
5432 * Marking Articles:: Marking articles as read, expirable, etc.
5433 * Limiting:: You can limit the summary buffer.
5434 * Threading:: How threads are made.
5435 * Sorting the Summary Buffer:: How articles and threads are sorted.
5436 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
5437 * Article Caching:: You may store articles in a cache.
5438 * Persistent Articles:: Making articles expiry-resistant.
5439 * Sticky Articles:: Article buffers that are not reused.
5440 * Article Backlog:: Having already read articles hang around.
5441 * Saving Articles:: Ways of customizing article saving.
5442 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
5443 * Article Treatment:: The article buffer can be mangled at will.
5444 * MIME Commands:: Doing MIMEy things with the articles.
5445 * Charsets:: Character set issues.
5446 * Article Commands:: Doing various things with the article buffer.
5447 * Summary Sorting:: Sorting the summary buffer in various ways.
5448 * Finding the Parent:: No child support? Get the parent.
5449 * Alternative Approaches:: Reading using non-default summaries.
5450 * Tree Display:: A more visual display of threads.
5451 * Mail Group Commands:: Some commands can only be used in mail groups.
5452 * Various Summary Stuff:: What didn't fit anywhere else.
5453 * Exiting the Summary Buffer:: Returning to the Group buffer,
5454 or reselecting the current group.
5455 * Crosspost Handling:: How crossposted articles are dealt with.
5456 * Duplicate Suppression:: An alternative when crosspost handling fails.
5457 * Security:: Decrypt and Verify.
5458 * Mailing List:: Mailing list minor mode.
5462 @node Summary Buffer Format
5463 @section Summary Buffer Format
5464 @cindex summary buffer format
5468 \gnusfigure{The Summary Buffer}{180}{
5469 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
5470 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
5476 * Summary Buffer Lines:: You can specify how summary lines should look.
5477 * To From Newsgroups:: How to not display your own name.
5478 * Summary Buffer Mode Line:: You can say how the mode line should look.
5479 * Summary Highlighting:: Making the summary buffer all pretty and nice.
5482 @findex mail-extract-address-components
5483 @findex gnus-extract-address-components
5484 @vindex gnus-extract-address-components
5485 Gnus will use the value of the @code{gnus-extract-address-components}
5486 variable as a function for getting the name and address parts of a
5487 @code{From} header. Two pre-defined functions exist:
5488 @code{gnus-extract-address-components}, which is the default, quite
5489 fast, and too simplistic solution; and
5490 @code{mail-extract-address-components}, which works very nicely, but is
5491 slower. The default function will return the wrong answer in 5% of the
5492 cases. If this is unacceptable to you, use the other function instead:
5495 (setq gnus-extract-address-components
5496 'mail-extract-address-components)
5499 @vindex gnus-summary-same-subject
5500 @code{gnus-summary-same-subject} is a string indicating that the current
5501 article has the same subject as the previous. This string will be used
5502 with those specs that require it. The default is @code{""}.
5505 @node Summary Buffer Lines
5506 @subsection Summary Buffer Lines
5508 @vindex gnus-summary-line-format
5509 You can change the format of the lines in the summary buffer by changing
5510 the @code{gnus-summary-line-format} variable. It works along the same
5511 lines as a normal @code{format} string, with some extensions
5512 (@pxref{Formatting Variables}).
5514 There should always be a colon or a point position marker on the line;
5515 the cursor always moves to the point position marker or the colon after
5516 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
5517 possible to change this. Just write a new function
5518 @code{gnus-goto-colon} which does whatever you like with the cursor.)
5519 @xref{Positioning Point}.
5521 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
5523 The following format specification characters and extended format
5524 specification(s) are understood:
5530 Subject string. List identifiers stripped,
5531 @code{gnus-list-identifiers}. @xref{Article Hiding}.
5533 Subject if the article is the root of the thread or the previous article
5534 had a different subject, @code{gnus-summary-same-subject} otherwise.
5535 (@code{gnus-summary-same-subject} defaults to @code{""}.)
5537 Full @code{From} header.
5539 The name (from the @code{From} header).
5541 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
5544 The name (from the @code{From} header). This differs from the @code{n}
5545 spec in that it uses the function designated by the
5546 @code{gnus-extract-address-components} variable, which is slower, but
5547 may be more thorough.
5549 The address (from the @code{From} header). This works the same way as
5552 Number of lines in the article.
5554 Number of characters in the article. This specifier is not supported
5555 in some methods (like nnfolder).
5557 Pretty-printed version of the number of characters in the article;
5558 for example, @samp{1.2k} or @samp{0.4M}.
5560 Indentation based on thread level (@pxref{Customizing Threading}).
5562 A complex trn-style thread tree, showing response-connecting trace
5563 lines. A thread could be drawn like this:
5576 You can customize the appearance with the following options. Note
5577 that it is possible to make the thread display look really neat by
5578 replacing the default @acronym{ASCII} characters with graphic
5579 line-drawing glyphs.
5581 @item gnus-sum-thread-tree-root
5582 @vindex gnus-sum-thread-tree-root
5583 Used for the root of a thread. If @code{nil}, use subject
5584 instead. The default is @samp{> }.
5586 @item gnus-sum-thread-tree-false-root
5587 @vindex gnus-sum-thread-tree-false-root
5588 Used for the false root of a thread (@pxref{Loose Threads}). If
5589 @code{nil}, use subject instead. The default is @samp{> }.
5591 @item gnus-sum-thread-tree-single-indent
5592 @vindex gnus-sum-thread-tree-single-indent
5593 Used for a thread with just one message. If @code{nil}, use subject
5594 instead. The default is @samp{}.
5596 @item gnus-sum-thread-tree-vertical
5597 @vindex gnus-sum-thread-tree-vertical
5598 Used for drawing a vertical line. The default is @samp{| }.
5600 @item gnus-sum-thread-tree-indent
5601 @vindex gnus-sum-thread-tree-indent
5602 Used for indenting. The default is @samp{ }.
5604 @item gnus-sum-thread-tree-leaf-with-other
5605 @vindex gnus-sum-thread-tree-leaf-with-other
5606 Used for a leaf with brothers. The default is @samp{+-> }.
5608 @item gnus-sum-thread-tree-single-leaf
5609 @vindex gnus-sum-thread-tree-single-leaf
5610 Used for a leaf without brothers. The default is @samp{\-> }
5615 Nothing if the article is a root and lots of spaces if it isn't (it
5616 pushes everything after it off the screen).
5618 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
5619 for adopted articles (@pxref{Customizing Threading}).
5621 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
5622 for adopted articles.
5624 One space for each thread level.
5626 Twenty minus thread level spaces.
5628 Unread. @xref{Read Articles}.
5631 This misleadingly named specifier is the @dfn{secondary mark}. This
5632 mark will say whether the article has been replied to, has been cached,
5633 or has been saved. @xref{Other Marks}.
5636 Score as a number (@pxref{Scoring}).
5638 @vindex gnus-summary-zcore-fuzz
5639 Zcore, @samp{+} if above the default level and @samp{-} if below the
5640 default level. If the difference between
5641 @code{gnus-summary-default-score} and the score is less than
5642 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
5650 The @code{Date} in @code{DD-MMM} format.
5652 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
5658 Number of articles in the current sub-thread. Using this spec will slow
5659 down summary buffer generation somewhat.
5661 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
5662 article has any children.
5668 Desired cursor position (instead of after first colon).
5670 Age sensitive date format. Various date format is defined in
5671 @code{gnus-user-date-format-alist}.
5673 User defined specifier. The next character in the format string should
5674 be a letter. Gnus will call the function
5675 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
5676 following @samp{%u}. The function will be passed the current header as
5677 argument. The function should return a string, which will be inserted
5678 into the summary just like information from any other summary specifier.
5681 Text between @samp{%(} and @samp{%)} will be highlighted with
5682 @code{gnus-mouse-face} when the mouse point is placed inside the area.
5683 There can only be one such area.
5685 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
5686 have to be handled with care. For reasons of efficiency, Gnus will
5687 compute what column these characters will end up in, and ``hard-code''
5688 that. This means that it is invalid to have these specs after a
5689 variable-length spec. Well, you might not be arrested, but your summary
5690 buffer will look strange, which is bad enough.
5692 The smart choice is to have these specs as far to the left as possible.
5693 (Isn't that the case with everything, though? But I digress.)
5695 This restriction may disappear in later versions of Gnus.
5698 @node To From Newsgroups
5699 @subsection To From Newsgroups
5703 In some groups (particularly in archive groups), the @code{From} header
5704 isn't very interesting, since all the articles there are written by
5705 you. To display the information in the @code{To} or @code{Newsgroups}
5706 headers instead, you need to decide three things: What information to
5707 gather; where to display it; and when to display it.
5711 @vindex gnus-extra-headers
5712 The reading of extra header information is controlled by the
5713 @code{gnus-extra-headers}. This is a list of header symbols. For
5717 (setq gnus-extra-headers
5718 '(To Newsgroups X-Newsreader))
5721 This will result in Gnus trying to obtain these three headers, and
5722 storing it in header structures for later easy retrieval.
5725 @findex gnus-extra-header
5726 The value of these extra headers can be accessed via the
5727 @code{gnus-extra-header} function. Here's a format line spec that will
5728 access the @code{X-Newsreader} header:
5731 "%~(form (gnus-extra-header 'X-Newsreader))@@"
5735 @vindex gnus-ignored-from-addresses
5736 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
5737 summary line spec returns the @code{To}, @code{Newsreader} or
5738 @code{From} header. If this regexp matches the contents of the
5739 @code{From} header, the value of the @code{To} or @code{Newsreader}
5740 headers are used instead.
5742 To distinguish regular articles from those where the @code{From} field
5743 has been swapped, a string is prefixed to the @code{To} or
5744 @code{Newsgroups} header in the summary line. By default the string is
5745 @samp{-> } for @code{To} and @samp{=> } for @code{Newsgroups}, you can
5746 customize these strings with @code{gnus-summary-to-prefix} and
5747 @code{gnus-summary-newsgroup-prefix}.
5751 @vindex nnmail-extra-headers
5752 A related variable is @code{nnmail-extra-headers}, which controls when
5753 to include extra headers when generating overview (@acronym{NOV}) files.
5754 If you have old overview files, you should regenerate them after
5755 changing this variable, by entering the server buffer using @kbd{^},
5756 and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause
5759 @vindex gnus-summary-line-format
5760 You also have to instruct Gnus to display the data by changing the
5761 @code{%n} spec to the @code{%f} spec in the
5762 @code{gnus-summary-line-format} variable.
5764 In summary, you'd typically put something like the following in
5768 (setq gnus-extra-headers
5770 (setq nnmail-extra-headers gnus-extra-headers)
5771 (setq gnus-summary-line-format
5772 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
5773 (setq gnus-ignored-from-addresses
5777 (The values listed above are the default values in Gnus. Alter them
5780 A note for news server administrators, or for users who wish to try to
5781 convince their news server administrator to provide some additional
5784 The above is mostly useful for mail groups, where you have control over
5785 the @acronym{NOV} files that are created. However, if you can persuade your
5786 nntp admin to add (in the usual implementation, notably INN):
5792 to the end of her @file{overview.fmt} file, then you can use that just
5793 as you would the extra headers from the mail groups.
5796 @node Summary Buffer Mode Line
5797 @subsection Summary Buffer Mode Line
5799 @vindex gnus-summary-mode-line-format
5800 You can also change the format of the summary mode bar (@pxref{Mode Line
5801 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
5802 like. The default is @samp{Gnus: %%b [%A] %Z}.
5804 Here are the elements you can play with:
5810 Unprefixed group name.
5812 Current article number.
5814 Current article score.
5818 Number of unread articles in this group.
5820 Number of unread articles in this group that aren't displayed in the
5823 A string with the number of unread and unselected articles represented
5824 either as @samp{<%U(+%e) more>} if there are both unread and unselected
5825 articles, and just as @samp{<%U more>} if there are just unread articles
5826 and no unselected ones.
5828 Shortish group name. For instance, @samp{rec.arts.anime} will be
5829 shortened to @samp{r.a.anime}.
5831 Subject of the current article.
5833 User-defined spec (@pxref{User-Defined Specs}).
5835 Name of the current score file (@pxref{Scoring}).
5837 Number of dormant articles (@pxref{Unread Articles}).
5839 Number of ticked articles (@pxref{Unread Articles}).
5841 Number of articles that have been marked as read in this session.
5843 Number of articles expunged by the score files.
5847 @node Summary Highlighting
5848 @subsection Summary Highlighting
5852 @item gnus-visual-mark-article-hook
5853 @vindex gnus-visual-mark-article-hook
5854 This hook is run after selecting an article. It is meant to be used for
5855 highlighting the article in some way. It is not run if
5856 @code{gnus-visual} is @code{nil}.
5858 @item gnus-summary-update-hook
5859 @vindex gnus-summary-update-hook
5860 This hook is called when a summary line is changed. It is not run if
5861 @code{gnus-visual} is @code{nil}.
5863 @item gnus-summary-selected-face
5864 @vindex gnus-summary-selected-face
5865 This is the face (or @dfn{font} as some people call it) used to
5866 highlight the current article in the summary buffer.
5868 @item gnus-summary-highlight
5869 @vindex gnus-summary-highlight
5870 Summary lines are highlighted according to this variable, which is a
5871 list where the elements are of the format @code{(@var{form}
5872 . @var{face})}. If you would, for instance, like ticked articles to be
5873 italic and high-scored articles to be bold, you could set this variable
5876 (((eq mark gnus-ticked-mark) . italic)
5877 ((> score default) . bold))
5879 As you may have guessed, if @var{form} returns a non-@code{nil} value,
5880 @var{face} will be applied to the line.
5884 @node Summary Maneuvering
5885 @section Summary Maneuvering
5886 @cindex summary movement
5888 All the straight movement commands understand the numeric prefix and
5889 behave pretty much as you'd expect.
5891 None of these commands select articles.
5896 @kindex M-n (Summary)
5897 @kindex G M-n (Summary)
5898 @findex gnus-summary-next-unread-subject
5899 Go to the next summary line of an unread article
5900 (@code{gnus-summary-next-unread-subject}).
5904 @kindex M-p (Summary)
5905 @kindex G M-p (Summary)
5906 @findex gnus-summary-prev-unread-subject
5907 Go to the previous summary line of an unread article
5908 (@code{gnus-summary-prev-unread-subject}).
5911 @kindex G g (Summary)
5912 @findex gnus-summary-goto-subject
5913 Ask for an article number and then go to the summary line of that article
5914 without displaying the article (@code{gnus-summary-goto-subject}).
5917 If Gnus asks you to press a key to confirm going to the next group, you
5918 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
5919 buffer, searching for the next group to read without actually returning
5920 to the group buffer.
5922 Variables related to summary movement:
5926 @vindex gnus-auto-select-next
5927 @item gnus-auto-select-next
5928 If you issue one of the movement commands (like @kbd{n}) and there are
5929 no more unread articles after the current one, Gnus will offer to go to
5930 the next group. If this variable is @code{t} and the next group is
5931 empty, Gnus will exit summary mode and return to the group buffer. If
5932 this variable is neither @code{t} nor @code{nil}, Gnus will select the
5933 next group with unread articles. As a special case, if this variable
5934 is @code{quietly}, Gnus will select the next group without asking for
5935 confirmation. If this variable is @code{almost-quietly}, the same
5936 will happen only if you are located on the last article in the group.
5937 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
5938 command will go to the next group without confirmation. Also
5939 @pxref{Group Levels}.
5941 @item gnus-auto-select-same
5942 @vindex gnus-auto-select-same
5943 If non-@code{nil}, all the movement commands will try to go to the next
5944 article with the same subject as the current. (@dfn{Same} here might
5945 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
5946 for details (@pxref{Customizing Threading}).) If there are no more
5947 articles with the same subject, go to the first unread article.
5949 This variable is not particularly useful if you use a threaded display.
5951 @item gnus-summary-check-current
5952 @vindex gnus-summary-check-current
5953 If non-@code{nil}, all the ``unread'' movement commands will not proceed
5954 to the next (or previous) article if the current article is unread.
5955 Instead, they will choose the current article.
5957 @item gnus-auto-center-summary
5958 @vindex gnus-auto-center-summary
5959 If non-@code{nil}, Gnus will keep the point in the summary buffer
5960 centered at all times. This makes things quite tidy, but if you have a
5961 slow network connection, or simply do not like this un-Emacsism, you can
5962 set this variable to @code{nil} to get the normal Emacs scrolling
5963 action. This will also inhibit horizontal re-centering of the summary
5964 buffer, which might make it more inconvenient to read extremely long
5967 This variable can also be a number. In that case, center the window at
5968 the given number of lines from the top.
5970 @item gnus-summary-stop-at-end-of-message
5971 @vindex gnus-summary-stop-at-end-of-message
5972 If non-@code{nil}, don't go to the next article when hitting
5973 @kbd{SPC}, and you're at the end of the article.
5978 @node Choosing Articles
5979 @section Choosing Articles
5980 @cindex selecting articles
5983 * Choosing Commands:: Commands for choosing articles.
5984 * Choosing Variables:: Variables that influence these commands.
5988 @node Choosing Commands
5989 @subsection Choosing Commands
5991 None of the following movement commands understand the numeric prefix,
5992 and they all select and display an article.
5994 If you want to fetch new articles or redisplay the group, see
5995 @ref{Exiting the Summary Buffer}.
5999 @kindex SPACE (Summary)
6000 @findex gnus-summary-next-page
6001 Select the current article, or, if that one's read already, the next
6002 unread article (@code{gnus-summary-next-page}).
6004 If you have an article window open already and you press @kbd{SPACE}
6005 again, the article will be scrolled. This lets you conveniently
6006 @kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}.
6011 @kindex G n (Summary)
6012 @findex gnus-summary-next-unread-article
6013 @c @icon{gnus-summary-next-unread}
6014 Go to next unread article (@code{gnus-summary-next-unread-article}).
6019 @findex gnus-summary-prev-unread-article
6020 @c @icon{gnus-summary-prev-unread}
6021 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
6026 @kindex G N (Summary)
6027 @findex gnus-summary-next-article
6028 Go to the next article (@code{gnus-summary-next-article}).
6033 @kindex G P (Summary)
6034 @findex gnus-summary-prev-article
6035 Go to the previous article (@code{gnus-summary-prev-article}).
6038 @kindex G C-n (Summary)
6039 @findex gnus-summary-next-same-subject
6040 Go to the next article with the same subject
6041 (@code{gnus-summary-next-same-subject}).
6044 @kindex G C-p (Summary)
6045 @findex gnus-summary-prev-same-subject
6046 Go to the previous article with the same subject
6047 (@code{gnus-summary-prev-same-subject}).
6051 @kindex G f (Summary)
6053 @findex gnus-summary-first-unread-article
6054 Go to the first unread article
6055 (@code{gnus-summary-first-unread-article}).
6059 @kindex G b (Summary)
6061 @findex gnus-summary-best-unread-article
6062 Go to the unread article with the highest score
6063 (@code{gnus-summary-best-unread-article}). If given a prefix argument,
6064 go to the first unread article that has a score over the default score.
6069 @kindex G l (Summary)
6070 @findex gnus-summary-goto-last-article
6071 Go to the previous article read (@code{gnus-summary-goto-last-article}).
6074 @kindex G o (Summary)
6075 @findex gnus-summary-pop-article
6077 @cindex article history
6078 Pop an article off the summary history and go to this article
6079 (@code{gnus-summary-pop-article}). This command differs from the
6080 command above in that you can pop as many previous articles off the
6081 history as you like, while @kbd{l} toggles the two last read articles.
6082 For a somewhat related issue (if you use these commands a lot),
6083 @pxref{Article Backlog}.
6088 @kindex G j (Summary)
6089 @findex gnus-summary-goto-article
6090 Ask for an article number or @code{Message-ID}, and then go to that
6091 article (@code{gnus-summary-goto-article}).
6096 @node Choosing Variables
6097 @subsection Choosing Variables
6099 Some variables relevant for moving and selecting articles:
6102 @item gnus-auto-extend-newsgroup
6103 @vindex gnus-auto-extend-newsgroup
6104 All the movement commands will try to go to the previous (or next)
6105 article, even if that article isn't displayed in the Summary buffer if
6106 this variable is non-@code{nil}. Gnus will then fetch the article from
6107 the server and display it in the article buffer.
6109 @item gnus-select-article-hook
6110 @vindex gnus-select-article-hook
6111 This hook is called whenever an article is selected. The default is
6112 @code{nil}. If you would like each article to be saved in the Agent as
6113 you read it, putting @code{gnus-agent-fetch-selected-article} on this
6116 @item gnus-mark-article-hook
6117 @vindex gnus-mark-article-hook
6118 @findex gnus-summary-mark-unread-as-read
6119 @findex gnus-summary-mark-read-and-unread-as-read
6120 @findex gnus-unread-mark
6121 This hook is called whenever an article is selected. It is intended to
6122 be used for marking articles as read. The default value is
6123 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
6124 mark of almost any article you read to @code{gnus-read-mark}. The only
6125 articles not affected by this function are ticked, dormant, and
6126 expirable articles. If you'd instead like to just have unread articles
6127 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
6128 instead. It will leave marks like @code{gnus-low-score-mark},
6129 @code{gnus-del-mark} (and so on) alone.
6134 @node Paging the Article
6135 @section Scrolling the Article
6136 @cindex article scrolling
6141 @kindex SPACE (Summary)
6142 @findex gnus-summary-next-page
6143 Pressing @kbd{SPACE} will scroll the current article forward one page,
6144 or, if you have come to the end of the current article, will choose the
6145 next article (@code{gnus-summary-next-page}).
6147 @vindex gnus-article-boring-faces
6148 @vindex gnus-article-skip-boring
6149 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
6150 the article consists only of citations and signature, then it will be
6151 skipped; the next article will be shown instead. You can customize
6152 what is considered uninteresting with
6153 @code{gnus-article-boring-faces}. You can manually view the article's
6154 pages, no matter how boring, using @kbd{C-M-v}.
6157 @kindex DEL (Summary)
6158 @findex gnus-summary-prev-page
6159 Scroll the current article back one page (@code{gnus-summary-prev-page}).
6162 @kindex RET (Summary)
6163 @findex gnus-summary-scroll-up
6164 Scroll the current article one line forward
6165 (@code{gnus-summary-scroll-up}).
6168 @kindex M-RET (Summary)
6169 @findex gnus-summary-scroll-down
6170 Scroll the current article one line backward
6171 (@code{gnus-summary-scroll-down}).
6175 @kindex A g (Summary)
6177 @findex gnus-summary-show-article
6178 @vindex gnus-summary-show-article-charset-alist
6179 (Re)fetch the current article (@code{gnus-summary-show-article}). If
6180 given a prefix, fetch the current article, but don't run any of the
6181 article treatment functions. This will give you a ``raw'' article, just
6182 the way it came from the server.
6184 @cindex charset, view article with different charset
6185 If given a numerical prefix, you can do semi-manual charset stuff.
6186 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
6187 encoded in the @code{cn-gb-2312} charset. If you have
6190 (setq gnus-summary-show-article-charset-alist
6195 then you can say @kbd{C-u 1 g} to get the same effect.
6200 @kindex A < (Summary)
6201 @findex gnus-summary-beginning-of-article
6202 Scroll to the beginning of the article
6203 (@code{gnus-summary-beginning-of-article}).
6208 @kindex A > (Summary)
6209 @findex gnus-summary-end-of-article
6210 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
6214 @kindex A s (Summary)
6216 @findex gnus-summary-isearch-article
6217 Perform an isearch in the article buffer
6218 (@code{gnus-summary-isearch-article}).
6222 @findex gnus-summary-select-article-buffer
6223 Select the article buffer (@code{gnus-summary-select-article-buffer}).
6228 @node Reply Followup and Post
6229 @section Reply, Followup and Post
6232 * Summary Mail Commands:: Sending mail.
6233 * Summary Post Commands:: Sending news.
6234 * Summary Message Commands:: Other Message-related commands.
6235 * Canceling and Superseding::
6239 @node Summary Mail Commands
6240 @subsection Summary Mail Commands
6242 @cindex composing mail
6244 Commands for composing a mail message:
6250 @kindex S r (Summary)
6252 @findex gnus-summary-reply
6253 @c @icon{gnus-summary-mail-reply}
6254 @c @icon{gnus-summary-reply}
6255 Mail a reply to the author of the current article
6256 (@code{gnus-summary-reply}).
6261 @kindex S R (Summary)
6262 @findex gnus-summary-reply-with-original
6263 @c @icon{gnus-summary-reply-with-original}
6264 Mail a reply to the author of the current article and include the
6265 original message (@code{gnus-summary-reply-with-original}). This
6266 command uses the process/prefix convention.
6269 @kindex S w (Summary)
6270 @findex gnus-summary-wide-reply
6271 Mail a wide reply to the author of the current article
6272 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
6273 goes out to all people listed in the @code{To}, @code{From} (or
6274 @code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is
6275 present, that's used instead.
6278 @kindex S W (Summary)
6279 @findex gnus-summary-wide-reply-with-original
6280 Mail a wide reply to the current article and include the original
6281 message (@code{gnus-summary-wide-reply-with-original}). This command uses
6282 the process/prefix convention, but only uses the headers from the
6283 first article to determine the recipients.
6286 @kindex S v (Summary)
6287 @findex gnus-summary-very-wide-reply
6288 Mail a very wide reply to the author of the current article
6289 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
6290 that goes out to all people listed in the @code{To}, @code{From} (or
6291 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
6292 articles. This command uses the process/prefix convention.
6295 @kindex S V (Summary)
6296 @findex gnus-summary-very-wide-reply-with-original
6297 Mail a very wide reply to the author of the current article and include the
6298 original message (@code{gnus-summary-very-wide-reply-with-original}). This
6299 command uses the process/prefix convention.
6302 @kindex S B r (Summary)
6303 @findex gnus-summary-reply-broken-reply-to
6304 Mail a reply to the author of the current article but ignore the
6305 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
6306 If you need this because a mailing list incorrectly sets a
6307 @code{Reply-To} header pointing to the list, you probably want to set
6308 the @code{broken-reply-to} group parameter instead, so things will work
6309 correctly. @xref{Group Parameters}.
6312 @kindex S B R (Summary)
6313 @findex gnus-summary-reply-broken-reply-to-with-original
6314 Mail a reply to the author of the current article and include the
6315 original message but ignore the @code{Reply-To} field
6316 (@code{gnus-summary-reply-broken-reply-to-with-original}).
6320 @kindex S o m (Summary)
6321 @kindex C-c C-f (Summary)
6322 @findex gnus-summary-mail-forward
6323 @c @icon{gnus-summary-mail-forward}
6324 Forward the current article to some other person
6325 (@code{gnus-summary-mail-forward}). If no prefix is given, the message
6326 is forwarded according to the value of (@code{message-forward-as-mime})
6327 and (@code{message-forward-show-mml}); if the prefix is 1, decode the
6328 message and forward directly inline; if the prefix is 2, forward message
6329 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
6330 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
6331 directly inline; otherwise, the message is forwarded as no prefix given
6332 but use the flipped value of (@code{message-forward-as-mime}). By
6333 default, the message is decoded and forwarded as an rfc822 @acronym{MIME}
6339 @kindex S m (Summary)
6340 @findex gnus-summary-mail-other-window
6341 @c @icon{gnus-summary-mail-originate}
6342 Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use
6343 the posting style of the current group. If given a prefix, disable that.
6344 If the prefix is 1, prompt for a group name to find the posting style.
6347 @kindex S i (Summary)
6348 @findex gnus-summary-news-other-window
6349 Prepare a news (@code{gnus-summary-news-other-window}). By default,
6350 post to the current group. If given a prefix, disable that. If the
6351 prefix is 1, prompt for a group to post to.
6353 This function actually prepares a news even when using mail groups.
6354 This is useful for ``posting'' messages to mail groups without actually
6355 sending them over the network: they're just saved directly to the group
6356 in question. The corresponding back end must have a request-post method
6357 for this to work though.
6360 @kindex S D b (Summary)
6361 @findex gnus-summary-resend-bounced-mail
6362 @cindex bouncing mail
6363 If you have sent a mail, but the mail was bounced back to you for some
6364 reason (wrong address, transient failure), you can use this command to
6365 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
6366 will be popped into a mail buffer where you can edit the headers before
6367 sending the mail off again. If you give a prefix to this command, and
6368 the bounced mail is a reply to some other mail, Gnus will try to fetch
6369 that mail and display it for easy perusal of its headers. This might
6370 very well fail, though.
6373 @kindex S D r (Summary)
6374 @findex gnus-summary-resend-message
6375 Not to be confused with the previous command,
6376 @code{gnus-summary-resend-message} will prompt you for an address to
6377 send the current message off to, and then send it to that place. The
6378 headers of the message won't be altered---but lots of headers that say
6379 @code{Resent-To}, @code{Resent-From} and so on will be added. This
6380 means that you actually send a mail to someone that has a @code{To}
6381 header that (probably) points to yourself. This will confuse people.
6382 So, natcherly you'll only do that if you're really eVIl.
6384 This command is mainly used if you have several accounts and want to
6385 ship a mail to a different account of yours. (If you're both
6386 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
6387 to the @code{root} account, you may want to resend it to
6388 @code{postmaster}. Ordnung muss sein!
6390 This command understands the process/prefix convention
6391 (@pxref{Process/Prefix}).
6394 @kindex S D e (Summary)
6395 @findex gnus-summary-resend-message-edit
6397 Like the previous command, but will allow you to edit the message as
6398 if it were a new message before resending.
6401 @kindex S O m (Summary)
6402 @findex gnus-uu-digest-mail-forward
6403 Digest the current series (@pxref{Decoding Articles}) and forward the
6404 result using mail (@code{gnus-uu-digest-mail-forward}). This command
6405 uses the process/prefix convention (@pxref{Process/Prefix}).
6408 @kindex S M-c (Summary)
6409 @findex gnus-summary-mail-crosspost-complaint
6410 @cindex crossposting
6411 @cindex excessive crossposting
6412 Send a complaint about excessive crossposting to the author of the
6413 current article (@code{gnus-summary-mail-crosspost-complaint}).
6415 @findex gnus-crosspost-complaint
6416 This command is provided as a way to fight back against the current
6417 crossposting pandemic that's sweeping Usenet. It will compose a reply
6418 using the @code{gnus-crosspost-complaint} variable as a preamble. This
6419 command understands the process/prefix convention
6420 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
6424 Also @xref{Header Commands, ,Header Commands, message, The Message
6425 Manual}, for more information.
6428 @node Summary Post Commands
6429 @subsection Summary Post Commands
6431 @cindex composing news
6433 Commands for posting a news article:
6439 @kindex S p (Summary)
6440 @findex gnus-summary-post-news
6441 @c @icon{gnus-summary-post-news}
6442 Prepare for posting an article (@code{gnus-summary-post-news}). By
6443 default, post to the current group. If given a prefix, disable that.
6444 If the prefix is 1, prompt for another group instead.
6449 @kindex S f (Summary)
6450 @findex gnus-summary-followup
6451 @c @icon{gnus-summary-followup}
6452 Post a followup to the current article (@code{gnus-summary-followup}).
6456 @kindex S F (Summary)
6458 @c @icon{gnus-summary-followup-with-original}
6459 @findex gnus-summary-followup-with-original
6460 Post a followup to the current article and include the original message
6461 (@code{gnus-summary-followup-with-original}). This command uses the
6462 process/prefix convention.
6465 @kindex S n (Summary)
6466 @findex gnus-summary-followup-to-mail
6467 Post a followup to the current article via news, even if you got the
6468 message through mail (@code{gnus-summary-followup-to-mail}).
6471 @kindex S N (Summary)
6472 @findex gnus-summary-followup-to-mail-with-original
6473 Post a followup to the current article via news, even if you got the
6474 message through mail and include the original message
6475 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
6476 the process/prefix convention.
6479 @kindex S o p (Summary)
6480 @findex gnus-summary-post-forward
6481 Forward the current article to a newsgroup
6482 (@code{gnus-summary-post-forward}).
6483 If no prefix is given, the message is forwarded according to the value
6484 of (@code{message-forward-as-mime}) and
6485 (@code{message-forward-show-mml}); if the prefix is 1, decode the
6486 message and forward directly inline; if the prefix is 2, forward message
6487 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
6488 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
6489 directly inline; otherwise, the message is forwarded as no prefix given
6490 but use the flipped value of (@code{message-forward-as-mime}). By
6491 default, the message is decoded and forwarded as an rfc822 @acronym{MIME} section.
6494 @kindex S O p (Summary)
6495 @findex gnus-uu-digest-post-forward
6497 @cindex making digests
6498 Digest the current series and forward the result to a newsgroup
6499 (@code{gnus-uu-digest-post-forward}). This command uses the
6500 process/prefix convention.
6503 @kindex S u (Summary)
6504 @findex gnus-uu-post-news
6505 @c @icon{gnus-uu-post-news}
6506 Uuencode a file, split it into parts, and post it as a series
6507 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
6510 Also @xref{Header Commands, ,Header Commands, message, The Message
6511 Manual}, for more information.
6514 @node Summary Message Commands
6515 @subsection Summary Message Commands
6519 @kindex S y (Summary)
6520 @findex gnus-summary-yank-message
6521 Yank the current article into an already existing Message composition
6522 buffer (@code{gnus-summary-yank-message}). This command prompts for
6523 what message buffer you want to yank into, and understands the
6524 process/prefix convention (@pxref{Process/Prefix}).
6529 @node Canceling and Superseding
6530 @subsection Canceling Articles
6531 @cindex canceling articles
6532 @cindex superseding articles
6534 Have you ever written something, and then decided that you really,
6535 really, really wish you hadn't posted that?
6537 Well, you can't cancel mail, but you can cancel posts.
6539 @findex gnus-summary-cancel-article
6541 @c @icon{gnus-summary-cancel-article}
6542 Find the article you wish to cancel (you can only cancel your own
6543 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
6544 c} (@code{gnus-summary-cancel-article}). Your article will be
6545 canceled---machines all over the world will be deleting your article.
6546 This command uses the process/prefix convention (@pxref{Process/Prefix}).
6548 Be aware, however, that not all sites honor cancels, so your article may
6549 live on here and there, while most sites will delete the article in
6552 Gnus will use the ``current'' select method when canceling. If you
6553 want to use the standard posting method, use the @samp{a} symbolic
6554 prefix (@pxref{Symbolic Prefixes}).
6556 Gnus ensures that only you can cancel your own messages using a
6557 @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, ,
6558 message, Message Manual}).
6560 If you discover that you have made some mistakes and want to do some
6561 corrections, you can post a @dfn{superseding} article that will replace
6562 your original article.
6564 @findex gnus-summary-supersede-article
6566 Go to the original article and press @kbd{S s}
6567 (@code{gnus-summary-supersede-article}). You will be put in a buffer
6568 where you can edit the article all you want before sending it off the
6571 The same goes for superseding as for canceling, only more so: Some
6572 sites do not honor superseding. On those sites, it will appear that you
6573 have posted almost the same article twice.
6575 If you have just posted the article, and change your mind right away,
6576 there is a trick you can use to cancel/supersede the article without
6577 waiting for the article to appear on your site first. You simply return
6578 to the post buffer (which is called @code{*sent ...*}). There you will
6579 find the article you just posted, with all the headers intact. Change
6580 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
6581 header by substituting one of those words for the word
6582 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
6583 you would do normally. The previous article will be
6584 canceled/superseded.
6586 Just remember, kids: There is no 'c' in 'supersede'.
6588 @node Delayed Articles
6589 @section Delayed Articles
6590 @cindex delayed sending
6591 @cindex send delayed
6593 Sometimes, you might wish to delay the sending of a message. For
6594 example, you might wish to arrange for a message to turn up just in time
6595 to remind your about the birthday of your Significant Other. For this,
6596 there is the @code{gnus-delay} package. Setup is simple:
6599 (gnus-delay-initialize)
6602 @findex gnus-delay-article
6603 Normally, to send a message you use the @kbd{C-c C-c} command from
6604 Message mode. To delay a message, use @kbd{C-c C-j}
6605 (@code{gnus-delay-article}) instead. This will ask you for how long the
6606 message should be delayed. Possible answers are:
6610 A time span. Consists of an integer and a letter. For example,
6611 @code{42d} means to delay for 42 days. Available letters are @code{m}
6612 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
6613 (months) and @code{Y} (years).
6616 A specific date. Looks like @code{YYYY-MM-DD}. The message will be
6617 delayed until that day, at a specific time (eight o'clock by default).
6618 See also @code{gnus-delay-default-hour}.
6621 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
6622 stuff. The deadline will be at that time today, except if that time has
6623 already passed, then it's at the given time tomorrow. So if it's ten
6624 o'clock in the morning and you specify @code{11:15}, then the deadline
6625 is one hour and fifteen minutes hence. But if you specify @code{9:20},
6626 that means a time tomorrow.
6629 The action of the @code{gnus-delay-article} command is influenced by a
6630 couple of variables:
6633 @item gnus-delay-default-hour
6634 @vindex gnus-delay-default-hour
6635 When you specify a specific date, the message will be due on that hour
6636 on the given date. Possible values are integers 0 through 23.
6638 @item gnus-delay-default-delay
6639 @vindex gnus-delay-default-delay
6640 This is a string and gives the default delay. It can be of any of the
6641 formats described above.
6643 @item gnus-delay-group
6644 @vindex gnus-delay-group
6645 Delayed articles will be kept in this group on the drafts server until
6646 they are due. You probably don't need to change this. The default
6647 value is @code{"delayed"}.
6649 @item gnus-delay-header
6650 @vindex gnus-delay-header
6651 The deadline for each article will be stored in a header. This variable
6652 is a string and gives the header name. You probably don't need to
6653 change this. The default value is @code{"X-Gnus-Delayed"}.
6656 The way delaying works is like this: when you use the
6657 @code{gnus-delay-article} command, you give a certain delay. Gnus
6658 calculates the deadline of the message and stores it in the
6659 @code{X-Gnus-Delayed} header and puts the message in the
6660 @code{nndraft:delayed} group.
6662 @findex gnus-delay-send-queue
6663 And whenever you get new news, Gnus looks through the group for articles
6664 which are due and sends them. It uses the @code{gnus-delay-send-queue}
6665 function for this. By default, this function is added to the hook
6666 @code{gnus-get-new-news-hook}. But of course, you can change this.
6667 Maybe you want to use the demon to send drafts? Just tell the demon to
6668 execute the @code{gnus-delay-send-queue} function.
6671 @item gnus-delay-initialize
6672 @findex gnus-delay-initialize
6673 By default, this function installs @code{gnus-delay-send-queue} in
6674 @code{gnus-get-new-news-hook}. But it accepts the optional second
6675 argument @code{no-check}. If it is non-@code{nil},
6676 @code{gnus-get-new-news-hook} is not changed. The optional first
6677 argument is ignored.
6679 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
6680 Presumably, you want to use the demon for sending due delayed articles.
6681 Just don't forget to set that up :-)
6684 When delaying an article with @kbd{C-c C-j}, Message mode will
6685 automatically add a @code{"Date"} header with the current time. In
6686 many cases you probably want the @code{"Date"} header to reflect the
6687 time the message is sent instead. To do this, you have to delete
6688 @code{Date} from @code{message-draft-headers}.
6691 @node Marking Articles
6692 @section Marking Articles
6693 @cindex article marking
6694 @cindex article ticking
6697 There are several marks you can set on an article.
6699 You have marks that decide the @dfn{readedness} (whoo, neato-keano
6700 neologism ohoy!) of the article. Alphabetic marks generally mean
6701 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
6703 In addition, you also have marks that do not affect readedness.
6706 There's a plethora of commands for manipulating these marks.
6710 * Unread Articles:: Marks for unread articles.
6711 * Read Articles:: Marks for read articles.
6712 * Other Marks:: Marks that do not affect readedness.
6713 * Setting Marks:: How to set and remove marks.
6714 * Generic Marking Commands:: How to customize the marking.
6715 * Setting Process Marks:: How to mark articles for later processing.
6719 @node Unread Articles
6720 @subsection Unread Articles
6722 The following marks mark articles as (kinda) unread, in one form or
6727 @vindex gnus-ticked-mark
6728 Marked as ticked (@code{gnus-ticked-mark}).
6730 @dfn{Ticked articles} are articles that will remain visible always. If
6731 you see an article that you find interesting, or you want to put off
6732 reading it, or replying to it, until sometime later, you'd typically
6733 tick it. However, articles can be expired (from news servers by the
6734 news server software, Gnus itself never expires ticked messages), so if
6735 you want to keep an article forever, you'll have to make it persistent
6736 (@pxref{Persistent Articles}).
6739 @vindex gnus-dormant-mark
6740 Marked as dormant (@code{gnus-dormant-mark}).
6742 @dfn{Dormant articles} will only appear in the summary buffer if there
6743 are followups to it. If you want to see them even if they don't have
6744 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
6745 Otherwise (except for the visibility issue), they are just like ticked
6749 @vindex gnus-unread-mark
6750 Marked as unread (@code{gnus-unread-mark}).
6752 @dfn{Unread articles} are articles that haven't been read at all yet.
6757 @subsection Read Articles
6758 @cindex expirable mark
6760 All the following marks mark articles as read.
6765 @vindex gnus-del-mark
6766 These are articles that the user has marked as read with the @kbd{d}
6767 command manually, more or less (@code{gnus-del-mark}).
6770 @vindex gnus-read-mark
6771 Articles that have actually been read (@code{gnus-read-mark}).
6774 @vindex gnus-ancient-mark
6775 Articles that were marked as read in previous sessions and are now
6776 @dfn{old} (@code{gnus-ancient-mark}).
6779 @vindex gnus-killed-mark
6780 Marked as killed (@code{gnus-killed-mark}).
6783 @vindex gnus-kill-file-mark
6784 Marked as killed by kill files (@code{gnus-kill-file-mark}).
6787 @vindex gnus-low-score-mark
6788 Marked as read by having too low a score (@code{gnus-low-score-mark}).
6791 @vindex gnus-catchup-mark
6792 Marked as read by a catchup (@code{gnus-catchup-mark}).
6795 @vindex gnus-canceled-mark
6796 Canceled article (@code{gnus-canceled-mark})
6799 @vindex gnus-sparse-mark
6800 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
6804 @vindex gnus-duplicate-mark
6805 Article marked as read by duplicate suppression
6806 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
6810 All these marks just mean that the article is marked as read, really.
6811 They are interpreted differently when doing adaptive scoring, though.
6813 One more special mark, though:
6817 @vindex gnus-expirable-mark
6818 Marked as expirable (@code{gnus-expirable-mark}).
6820 Marking articles as @dfn{expirable} (or have them marked as such
6821 automatically) doesn't make much sense in normal groups---a user doesn't
6822 control expiring of news articles, but in mail groups, for instance,
6823 articles marked as @dfn{expirable} can be deleted by Gnus at
6829 @subsection Other Marks
6830 @cindex process mark
6833 There are some marks that have nothing to do with whether the article is
6839 You can set a bookmark in the current article. Say you are reading a
6840 long thesis on cats' urinary tracts, and have to go home for dinner
6841 before you've finished reading the thesis. You can then set a bookmark
6842 in the article, and Gnus will jump to this bookmark the next time it
6843 encounters the article. @xref{Setting Marks}.
6846 @vindex gnus-replied-mark
6847 All articles that you have replied to or made a followup to (i.e., have
6848 answered) will be marked with an @samp{A} in the second column
6849 (@code{gnus-replied-mark}).
6852 @vindex gnus-forwarded-mark
6853 All articles that you have forwarded will be marked with an @samp{F} in
6854 the second column (@code{gnus-forwarded-mark}).
6857 @vindex gnus-cached-mark
6858 Articles stored in the article cache will be marked with an @samp{*} in
6859 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
6862 @vindex gnus-saved-mark
6863 Articles ``saved'' (in some manner or other; not necessarily
6864 religiously) are marked with an @samp{S} in the second column
6865 (@code{gnus-saved-mark}).
6868 @vindex gnus-recent-mark
6869 Articles that according to the server haven't been shown to the user
6870 before are marked with a @samp{N} in the second column
6871 (@code{gnus-recent-mark}). Note that not all servers support this
6872 mark, in which case it simply never appears. Compare with
6873 @code{gnus-unseen-mark}.
6876 @vindex gnus-unseen-mark
6877 Articles that haven't been seen before in Gnus by the user are marked
6878 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
6879 Compare with @code{gnus-recent-mark}.
6882 @vindex gnus-downloaded-mark
6883 When using the Gnus agent (@pxref{Agent Basics}), articles may be
6884 downloaded for unplugged (offline) viewing. If you are using the
6885 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
6886 (The variable @code{gnus-downloaded-mark} controls which character to
6890 @vindex gnus-undownloaded-mark
6891 When using the Gnus agent (@pxref{Agent Basics}), some articles might
6892 not have been downloaded. Such articles cannot be viewed while you
6893 are unplugged (offline). If you are using the @samp{%O} spec, these
6894 articles get the @samp{-} mark in that spec. (The variable
6895 @code{gnus-undownloaded-mark} controls which character to use.)
6898 @vindex gnus-downloadable-mark
6899 The Gnus agent (@pxref{Agent Basics}) downloads some articles
6900 automatically, but it is also possible to explicitly mark articles for
6901 download, even if they would not be downloaded automatically. Such
6902 explicitly-marked articles get the @samp{%} mark in the first column.
6903 (The variable @code{gnus-downloadable-mark} controls which character to
6907 @vindex gnus-not-empty-thread-mark
6908 @vindex gnus-empty-thread-mark
6909 If the @samp{%e} spec is used, the presence of threads or not will be
6910 marked with @code{gnus-not-empty-thread-mark} and
6911 @code{gnus-empty-thread-mark} in the third column, respectively.
6914 @vindex gnus-process-mark
6915 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
6916 variety of commands react to the presence of the process mark. For
6917 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
6918 all articles that have been marked with the process mark. Articles
6919 marked with the process mark have a @samp{#} in the second column.
6923 You might have noticed that most of these ``non-readedness'' marks
6924 appear in the second column by default. So if you have a cached, saved,
6925 replied article that you have process-marked, what will that look like?
6927 Nothing much. The precedence rules go as follows: process -> cache ->
6928 replied -> saved. So if the article is in the cache and is replied,
6929 you'll only see the cache mark and not the replied mark.
6933 @subsection Setting Marks
6934 @cindex setting marks
6936 All the marking commands understand the numeric prefix.
6941 @kindex M c (Summary)
6942 @kindex M-u (Summary)
6943 @findex gnus-summary-clear-mark-forward
6944 @cindex mark as unread
6945 Clear all readedness-marks from the current article
6946 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
6952 @kindex M t (Summary)
6953 @findex gnus-summary-tick-article-forward
6954 Tick the current article (@code{gnus-summary-tick-article-forward}).
6955 @xref{Article Caching}.
6960 @kindex M ? (Summary)
6961 @findex gnus-summary-mark-as-dormant
6962 Mark the current article as dormant
6963 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
6967 @kindex M d (Summary)
6969 @findex gnus-summary-mark-as-read-forward
6970 Mark the current article as read
6971 (@code{gnus-summary-mark-as-read-forward}).
6975 @findex gnus-summary-mark-as-read-backward
6976 Mark the current article as read and move point to the previous line
6977 (@code{gnus-summary-mark-as-read-backward}).
6982 @kindex M k (Summary)
6983 @findex gnus-summary-kill-same-subject-and-select
6984 Mark all articles that have the same subject as the current one as read,
6985 and then select the next unread article
6986 (@code{gnus-summary-kill-same-subject-and-select}).
6990 @kindex M K (Summary)
6991 @kindex C-k (Summary)
6992 @findex gnus-summary-kill-same-subject
6993 Mark all articles that have the same subject as the current one as read
6994 (@code{gnus-summary-kill-same-subject}).
6997 @kindex M C (Summary)
6998 @findex gnus-summary-catchup
6999 @c @icon{gnus-summary-catchup}
7000 Mark all unread articles as read (@code{gnus-summary-catchup}).
7003 @kindex M C-c (Summary)
7004 @findex gnus-summary-catchup-all
7005 Mark all articles in the group as read---even the ticked and dormant
7006 articles (@code{gnus-summary-catchup-all}).
7009 @kindex M H (Summary)
7010 @findex gnus-summary-catchup-to-here
7011 Catchup the current group to point (before the point)
7012 (@code{gnus-summary-catchup-to-here}).
7015 @kindex M h (Summary)
7016 @findex gnus-summary-catchup-from-here
7017 Catchup the current group from point (after the point)
7018 (@code{gnus-summary-catchup-from-here}).
7021 @kindex C-w (Summary)
7022 @findex gnus-summary-mark-region-as-read
7023 Mark all articles between point and mark as read
7024 (@code{gnus-summary-mark-region-as-read}).
7027 @kindex M V k (Summary)
7028 @findex gnus-summary-kill-below
7029 Kill all articles with scores below the default score (or below the
7030 numeric prefix) (@code{gnus-summary-kill-below}).
7034 @kindex M e (Summary)
7036 @findex gnus-summary-mark-as-expirable
7037 Mark the current article as expirable
7038 (@code{gnus-summary-mark-as-expirable}).
7041 @kindex M b (Summary)
7042 @findex gnus-summary-set-bookmark
7043 Set a bookmark in the current article
7044 (@code{gnus-summary-set-bookmark}).
7047 @kindex M B (Summary)
7048 @findex gnus-summary-remove-bookmark
7049 Remove the bookmark from the current article
7050 (@code{gnus-summary-remove-bookmark}).
7053 @kindex M V c (Summary)
7054 @findex gnus-summary-clear-above
7055 Clear all marks from articles with scores over the default score (or
7056 over the numeric prefix) (@code{gnus-summary-clear-above}).
7059 @kindex M V u (Summary)
7060 @findex gnus-summary-tick-above
7061 Tick all articles with scores over the default score (or over the
7062 numeric prefix) (@code{gnus-summary-tick-above}).
7065 @kindex M V m (Summary)
7066 @findex gnus-summary-mark-above
7067 Prompt for a mark, and mark all articles with scores over the default
7068 score (or over the numeric prefix) with this mark
7069 (@code{gnus-summary-clear-above}).
7072 @vindex gnus-summary-goto-unread
7073 The @code{gnus-summary-goto-unread} variable controls what action should
7074 be taken after setting a mark. If non-@code{nil}, point will move to
7075 the next/previous unread article. If @code{nil}, point will just move
7076 one line up or down. As a special case, if this variable is
7077 @code{never}, all the marking commands as well as other commands (like
7078 @kbd{SPACE}) will move to the next article, whether it is unread or not.
7079 The default is @code{t}.
7082 @node Generic Marking Commands
7083 @subsection Generic Marking Commands
7085 Some people would like the command that ticks an article (@kbd{!}) go to
7086 the next article. Others would like it to go to the next unread
7087 article. Yet others would like it to stay on the current article. And
7088 even though I haven't heard of anybody wanting it to go to the
7089 previous (unread) article, I'm sure there are people that want that as
7092 Multiply these five behaviors with five different marking commands, and
7093 you get a potentially complex set of variable to control what each
7096 To sidestep that mess, Gnus provides commands that do all these
7097 different things. They can be found on the @kbd{M M} map in the summary
7098 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
7099 to list in this manual.
7101 While you can use these commands directly, most users would prefer
7102 altering the summary mode keymap. For instance, if you would like the
7103 @kbd{!} command to go to the next article instead of the next unread
7104 article, you could say something like:
7108 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
7109 (defun my-alter-summary-map ()
7110 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
7118 (defun my-alter-summary-map ()
7119 (local-set-key "!" "MM!n"))
7123 @node Setting Process Marks
7124 @subsection Setting Process Marks
7125 @cindex setting process marks
7127 Process marks are displayed as @code{#} in the summary buffer, and are
7128 used for marking articles in such a way that other commands will
7129 process these articles. For instance, if you process mark four
7130 articles and then use the @kbd{*} command, Gnus will enter these four
7131 articles into the cache. For more information,
7132 @pxref{Process/Prefix}.
7139 @kindex M P p (Summary)
7140 @findex gnus-summary-mark-as-processable
7141 Mark the current article with the process mark
7142 (@code{gnus-summary-mark-as-processable}).
7143 @findex gnus-summary-unmark-as-processable
7147 @kindex M P u (Summary)
7148 @kindex M-# (Summary)
7149 Remove the process mark, if any, from the current article
7150 (@code{gnus-summary-unmark-as-processable}).
7153 @kindex M P U (Summary)
7154 @findex gnus-summary-unmark-all-processable
7155 Remove the process mark from all articles
7156 (@code{gnus-summary-unmark-all-processable}).
7159 @kindex M P i (Summary)
7160 @findex gnus-uu-invert-processable
7161 Invert the list of process marked articles
7162 (@code{gnus-uu-invert-processable}).
7165 @kindex M P R (Summary)
7166 @findex gnus-uu-mark-by-regexp
7167 Mark articles that have a @code{Subject} header that matches a regular
7168 expression (@code{gnus-uu-mark-by-regexp}).
7171 @kindex M P G (Summary)
7172 @findex gnus-uu-unmark-by-regexp
7173 Unmark articles that have a @code{Subject} header that matches a regular
7174 expression (@code{gnus-uu-unmark-by-regexp}).
7177 @kindex M P r (Summary)
7178 @findex gnus-uu-mark-region
7179 Mark articles in region (@code{gnus-uu-mark-region}).
7182 @kindex M P g (Summary)
7183 @findex gnus-uu-unmark-region
7184 Unmark articles in region (@code{gnus-uu-unmark-region}).
7187 @kindex M P t (Summary)
7188 @findex gnus-uu-mark-thread
7189 Mark all articles in the current (sub)thread
7190 (@code{gnus-uu-mark-thread}).
7193 @kindex M P T (Summary)
7194 @findex gnus-uu-unmark-thread
7195 Unmark all articles in the current (sub)thread
7196 (@code{gnus-uu-unmark-thread}).
7199 @kindex M P v (Summary)
7200 @findex gnus-uu-mark-over
7201 Mark all articles that have a score above the prefix argument
7202 (@code{gnus-uu-mark-over}).
7205 @kindex M P s (Summary)
7206 @findex gnus-uu-mark-series
7207 Mark all articles in the current series (@code{gnus-uu-mark-series}).
7210 @kindex M P S (Summary)
7211 @findex gnus-uu-mark-sparse
7212 Mark all series that have already had some articles marked
7213 (@code{gnus-uu-mark-sparse}).
7216 @kindex M P a (Summary)
7217 @findex gnus-uu-mark-all
7218 Mark all articles in series order (@code{gnus-uu-mark-all}).
7221 @kindex M P b (Summary)
7222 @findex gnus-uu-mark-buffer
7223 Mark all articles in the buffer in the order they appear
7224 (@code{gnus-uu-mark-buffer}).
7227 @kindex M P k (Summary)
7228 @findex gnus-summary-kill-process-mark
7229 Push the current process mark set onto the stack and unmark all articles
7230 (@code{gnus-summary-kill-process-mark}).
7233 @kindex M P y (Summary)
7234 @findex gnus-summary-yank-process-mark
7235 Pop the previous process mark set from the stack and restore it
7236 (@code{gnus-summary-yank-process-mark}).
7239 @kindex M P w (Summary)
7240 @findex gnus-summary-save-process-mark
7241 Push the current process mark set onto the stack
7242 (@code{gnus-summary-save-process-mark}).
7246 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
7247 set process marks based on article body contents.
7254 It can be convenient to limit the summary buffer to just show some
7255 subset of the articles currently in the group. The effect most limit
7256 commands have is to remove a few (or many) articles from the summary
7259 Limiting commands work on subsets of the articles already fetched from
7260 the servers. These commands don't query the server for additional
7267 @kindex / / (Summary)
7268 @findex gnus-summary-limit-to-subject
7269 Limit the summary buffer to articles that match some subject
7270 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
7274 @kindex / a (Summary)
7275 @findex gnus-summary-limit-to-author
7276 Limit the summary buffer to articles that match some author
7277 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
7281 @kindex / R (Summary)
7282 @findex gnus-summary-limit-to-recipient
7283 Limit the summary buffer to articles that match some recipient
7284 (@code{gnus-summary-limit-to-recipient}). If given a prefix, exclude
7288 @kindex / A (Summary)
7289 @findex gnus-summary-limit-to-address
7290 Limit the summary buffer to articles in which contents of From, To or Cc
7291 header match a given address (@code{gnus-summary-limit-to-address}). If
7292 given a prefix, exclude matching articles.
7295 @kindex / S (Summary)
7296 @findex gnus-summary-limit-to-singletons
7297 Limit the summary buffer to articles that aren't part of any displayed
7298 threads (@code{gnus-summary-limit-to-singletons}). If given a prefix,
7299 limit to articles that are part of displayed threads.
7302 @kindex / x (Summary)
7303 @findex gnus-summary-limit-to-extra
7304 Limit the summary buffer to articles that match one of the ``extra''
7305 headers (@pxref{To From Newsgroups})
7306 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
7311 @kindex / u (Summary)
7313 @findex gnus-summary-limit-to-unread
7314 Limit the summary buffer to articles not marked as read
7315 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
7316 buffer to articles strictly unread. This means that ticked and
7317 dormant articles will also be excluded.
7320 @kindex / m (Summary)
7321 @findex gnus-summary-limit-to-marks
7322 Ask for a mark and then limit to all articles that have been marked
7323 with that mark (@code{gnus-summary-limit-to-marks}).
7326 @kindex / t (Summary)
7327 @findex gnus-summary-limit-to-age
7328 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
7329 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
7330 articles younger than that number of days.
7333 @kindex / n (Summary)
7334 @findex gnus-summary-limit-to-articles
7335 With prefix @samp{n}, limit the summary buffer to the next @samp{n}
7336 articles. If not given a prefix, use the process marked articles
7337 instead. (@code{gnus-summary-limit-to-articles}).
7340 @kindex / w (Summary)
7341 @findex gnus-summary-pop-limit
7342 Pop the previous limit off the stack and restore it
7343 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
7347 @kindex / . (Summary)
7348 @findex gnus-summary-limit-to-unseen
7349 Limit the summary buffer to the unseen articles
7350 (@code{gnus-summary-limit-to-unseen}).
7353 @kindex / v (Summary)
7354 @findex gnus-summary-limit-to-score
7355 Limit the summary buffer to articles that have a score at or above some
7356 score (@code{gnus-summary-limit-to-score}).
7359 @kindex / p (Summary)
7360 @findex gnus-summary-limit-to-display-predicate
7361 Limit the summary buffer to articles that satisfy the @code{display}
7362 group parameter predicate
7363 (@code{gnus-summary-limit-to-display-predicate}). @xref{Group
7364 Parameters}, for more on this predicate.
7367 @kindex / r (Summary)
7368 @findex gnus-summary-limit-to-replied
7369 Limit the summary buffer to replied articles
7370 (@code{gnus-summary-limit-to-replied}). If given a prefix, exclude
7375 @kindex M S (Summary)
7376 @kindex / E (Summary)
7377 @findex gnus-summary-limit-include-expunged
7378 Include all expunged articles in the limit
7379 (@code{gnus-summary-limit-include-expunged}).
7382 @kindex / D (Summary)
7383 @findex gnus-summary-limit-include-dormant
7384 Include all dormant articles in the limit
7385 (@code{gnus-summary-limit-include-dormant}).
7388 @kindex / * (Summary)
7389 @findex gnus-summary-limit-include-cached
7390 Include all cached articles in the limit
7391 (@code{gnus-summary-limit-include-cached}).
7394 @kindex / d (Summary)
7395 @findex gnus-summary-limit-exclude-dormant
7396 Exclude all dormant articles from the limit
7397 (@code{gnus-summary-limit-exclude-dormant}).
7400 @kindex / M (Summary)
7401 @findex gnus-summary-limit-exclude-marks
7402 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
7405 @kindex / T (Summary)
7406 @findex gnus-summary-limit-include-thread
7407 Include all the articles in the current thread in the limit.
7410 @kindex / c (Summary)
7411 @findex gnus-summary-limit-exclude-childless-dormant
7412 Exclude all dormant articles that have no children from the limit@*
7413 (@code{gnus-summary-limit-exclude-childless-dormant}).
7416 @kindex / C (Summary)
7417 @findex gnus-summary-limit-mark-excluded-as-read
7418 Mark all excluded unread articles as read
7419 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
7420 also mark excluded ticked and dormant articles as read.
7423 @kindex / b (Summary)
7424 @findex gnus-summary-limit-to-bodies
7425 Limit the summary buffer to articles that have bodies that match a
7426 certain regexp (@code{gnus-summary-limit-to-bodies}). If given a
7427 prefix, reverse the limit. This command is quite slow since it
7428 requires selecting each article to find the matches.
7431 @kindex / h (Summary)
7432 @findex gnus-summary-limit-to-headers
7433 Like the previous command, only limit to headers instead
7434 (@code{gnus-summary-limit-to-headers}).
7439 The following commands aren't limiting commands, but use the @kbd{/}
7444 @kindex / N (Summary)
7445 @findex gnus-summary-insert-new-articles
7446 Insert all new articles in the summary buffer. It scans for new emails
7447 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
7450 @kindex / o (Summary)
7451 @findex gnus-summary-insert-old-articles
7452 Insert all old articles in the summary buffer. If given a numbered
7453 prefix, fetch this number of articles.
7461 @cindex article threading
7463 Gnus threads articles by default. @dfn{To thread} is to put responses
7464 to articles directly after the articles they respond to---in a
7465 hierarchical fashion.
7467 Threading is done by looking at the @code{References} headers of the
7468 articles. In a perfect world, this would be enough to build pretty
7469 trees, but unfortunately, the @code{References} header is often broken
7470 or simply missing. Weird news propagation exacerbates the problem,
7471 so one has to employ other heuristics to get pleasing results. A
7472 plethora of approaches exists, as detailed in horrible detail in
7473 @ref{Customizing Threading}.
7475 First, a quick overview of the concepts:
7479 The top-most article in a thread; the first article in the thread.
7482 A tree-like article structure.
7485 A small(er) section of this tree-like structure.
7488 Threads often lose their roots due to article expiry, or due to the root
7489 already having been read in a previous session, and not displayed in the
7490 summary buffer. We then typically have many sub-threads that really
7491 belong to one thread, but are without connecting roots. These are
7492 called loose threads.
7494 @item thread gathering
7495 An attempt to gather loose threads into bigger threads.
7497 @item sparse threads
7498 A thread where the missing articles have been ``guessed'' at, and are
7499 displayed as empty lines in the summary buffer.
7505 * Customizing Threading:: Variables you can change to affect the threading.
7506 * Thread Commands:: Thread based commands in the summary buffer.
7510 @node Customizing Threading
7511 @subsection Customizing Threading
7512 @cindex customizing threading
7515 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
7516 * Filling In Threads:: Making the threads displayed look fuller.
7517 * More Threading:: Even more variables for fiddling with threads.
7518 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
7523 @subsubsection Loose Threads
7526 @cindex loose threads
7529 @item gnus-summary-make-false-root
7530 @vindex gnus-summary-make-false-root
7531 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
7532 and create a dummy root at the top. (Wait a minute. Root at the top?
7533 Yup.) Loose subtrees occur when the real root has expired, or you've
7534 read or killed the root in a previous session.
7536 When there is no real root of a thread, Gnus will have to fudge
7537 something. This variable says what fudging method Gnus should use.
7538 There are four possible values:
7542 \gnusfigure{The Summary Buffer}{390}{
7543 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
7544 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
7545 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
7546 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
7551 @cindex adopting articles
7556 Gnus will make the first of the orphaned articles the parent. This
7557 parent will adopt all the other articles. The adopted articles will be
7558 marked as such by pointy brackets (@samp{<>}) instead of the standard
7559 square brackets (@samp{[]}). This is the default method.
7562 @vindex gnus-summary-dummy-line-format
7563 @vindex gnus-summary-make-false-root-always
7564 Gnus will create a dummy summary line that will pretend to be the
7565 parent. This dummy line does not correspond to any real article, so
7566 selecting it will just select the first real article after the dummy
7567 article. @code{gnus-summary-dummy-line-format} is used to specify the
7568 format of the dummy roots. It accepts only one format spec: @samp{S},
7569 which is the subject of the article. @xref{Formatting Variables}.
7570 If you want all threads to have a dummy root, even the non-gathered
7571 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
7574 Gnus won't actually make any article the parent, but simply leave the
7575 subject field of all orphans except the first empty. (Actually, it will
7576 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
7580 Don't make any article parent at all. Just gather the threads and
7581 display them after one another.
7584 Don't gather loose threads.
7587 @item gnus-summary-gather-subject-limit
7588 @vindex gnus-summary-gather-subject-limit
7589 Loose threads are gathered by comparing subjects of articles. If this
7590 variable is @code{nil}, Gnus requires an exact match between the
7591 subjects of the loose threads before gathering them into one big
7592 super-thread. This might be too strict a requirement, what with the
7593 presence of stupid newsreaders that chop off long subject lines. If
7594 you think so, set this variable to, say, 20 to require that only the
7595 first 20 characters of the subjects have to match. If you set this
7596 variable to a really low number, you'll find that Gnus will gather
7597 everything in sight into one thread, which isn't very helpful.
7599 @cindex fuzzy article gathering
7600 If you set this variable to the special value @code{fuzzy}, Gnus will
7601 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
7604 @item gnus-simplify-subject-fuzzy-regexp
7605 @vindex gnus-simplify-subject-fuzzy-regexp
7606 This can either be a regular expression or list of regular expressions
7607 that match strings that will be removed from subjects if fuzzy subject
7608 simplification is used.
7610 @item gnus-simplify-ignored-prefixes
7611 @vindex gnus-simplify-ignored-prefixes
7612 If you set @code{gnus-summary-gather-subject-limit} to something as low
7613 as 10, you might consider setting this variable to something sensible:
7615 @c Written by Michael Ernst <mernst@cs.rice.edu>
7617 (setq gnus-simplify-ignored-prefixes
7623 "wanted" "followup" "summary\\( of\\)?"
7624 "help" "query" "problem" "question"
7625 "answer" "reference" "announce"
7626 "How can I" "How to" "Comparison of"
7631 (mapconcat 'identity
7632 '("for" "for reference" "with" "about")
7634 "\\)?\\]?:?[ \t]*"))
7637 All words that match this regexp will be removed before comparing two
7640 @item gnus-simplify-subject-functions
7641 @vindex gnus-simplify-subject-functions
7642 If non-@code{nil}, this variable overrides
7643 @code{gnus-summary-gather-subject-limit}. This variable should be a
7644 list of functions to apply to the @code{Subject} string iteratively to
7645 arrive at the simplified version of the string.
7647 Useful functions to put in this list include:
7650 @item gnus-simplify-subject-re
7651 @findex gnus-simplify-subject-re
7652 Strip the leading @samp{Re:}.
7654 @item gnus-simplify-subject-fuzzy
7655 @findex gnus-simplify-subject-fuzzy
7658 @item gnus-simplify-whitespace
7659 @findex gnus-simplify-whitespace
7660 Remove excessive whitespace.
7662 @item gnus-simplify-all-whitespace
7663 @findex gnus-simplify-all-whitespace
7664 Remove all whitespace.
7667 You may also write your own functions, of course.
7670 @item gnus-summary-gather-exclude-subject
7671 @vindex gnus-summary-gather-exclude-subject
7672 Since loose thread gathering is done on subjects only, that might lead
7673 to many false hits, especially with certain common subjects like
7674 @samp{} and @samp{(none)}. To make the situation slightly better,
7675 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
7676 what subjects should be excluded from the gathering process.@*
7677 The default is @samp{^ *$\\|^(none)$}.
7679 @item gnus-summary-thread-gathering-function
7680 @vindex gnus-summary-thread-gathering-function
7681 Gnus gathers threads by looking at @code{Subject} headers. This means
7682 that totally unrelated articles may end up in the same ``thread'', which
7683 is confusing. An alternate approach is to look at all the
7684 @code{Message-ID}s in all the @code{References} headers to find matches.
7685 This will ensure that no gathered threads ever include unrelated
7686 articles, but it also means that people who have posted with broken
7687 newsreaders won't be gathered properly. The choice is yours---plague or
7691 @item gnus-gather-threads-by-subject
7692 @findex gnus-gather-threads-by-subject
7693 This function is the default gathering function and looks at
7694 @code{Subject}s exclusively.
7696 @item gnus-gather-threads-by-references
7697 @findex gnus-gather-threads-by-references
7698 This function looks at @code{References} headers exclusively.
7701 If you want to test gathering by @code{References}, you could say
7705 (setq gnus-summary-thread-gathering-function
7706 'gnus-gather-threads-by-references)
7712 @node Filling In Threads
7713 @subsubsection Filling In Threads
7716 @item gnus-fetch-old-headers
7717 @vindex gnus-fetch-old-headers
7718 If non-@code{nil}, Gnus will attempt to build old threads by fetching
7719 more old headers---headers to articles marked as read. If you would
7720 like to display as few summary lines as possible, but still connect as
7721 many loose threads as possible, you should set this variable to
7722 @code{some} or a number. If you set it to a number, no more than that
7723 number of extra old headers will be fetched. In either case, fetching
7724 old headers only works if the back end you are using carries overview
7725 files---this would normally be @code{nntp}, @code{nnspool},
7726 @code{nnml}, and @code{nnmaildir}. Also remember that if the root of
7727 the thread has been expired by the server, there's not much Gnus can
7730 This variable can also be set to @code{invisible}. This won't have any
7731 visible effects, but is useful if you use the @kbd{A T} command a lot
7732 (@pxref{Finding the Parent}).
7734 The server has to support @acronym{NOV} for any of this to work.
7736 @cindex Gmane, gnus-fetch-old-headers
7737 This feature can seriously impact performance it ignores all locally
7738 cached header entries. Setting it to @code{t} for groups for a server
7739 that doesn't expire articles (such as news.gmane.org), leads to very
7740 slow summary generation.
7742 @item gnus-fetch-old-ephemeral-headers
7743 @vindex gnus-fetch-old-ephemeral-headers
7744 Same as @code{gnus-fetch-old-headers}, but only used for ephemeral
7747 @item gnus-build-sparse-threads
7748 @vindex gnus-build-sparse-threads
7749 Fetching old headers can be slow. A low-rent similar effect can be
7750 gotten by setting this variable to @code{some}. Gnus will then look at
7751 the complete @code{References} headers of all articles and try to string
7752 together articles that belong in the same thread. This will leave
7753 @dfn{gaps} in the threading display where Gnus guesses that an article
7754 is missing from the thread. (These gaps appear like normal summary
7755 lines. If you select a gap, Gnus will try to fetch the article in
7756 question.) If this variable is @code{t}, Gnus will display all these
7757 ``gaps'' without regard for whether they are useful for completing the
7758 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
7759 off sparse leaf nodes that don't lead anywhere. This variable is
7760 @code{nil} by default.
7762 @item gnus-read-all-available-headers
7763 @vindex gnus-read-all-available-headers
7764 This is a rather obscure variable that few will find useful. It's
7765 intended for those non-news newsgroups where the back end has to fetch
7766 quite a lot to present the summary buffer, and where it's impossible to
7767 go back to parents of articles. This is mostly the case in the
7770 If you don't use those, then it's safe to leave this as the default
7771 @code{nil}. If you want to use this variable, it should be a regexp
7772 that matches the group name, or @code{t} for all groups.
7777 @node More Threading
7778 @subsubsection More Threading
7781 @item gnus-show-threads
7782 @vindex gnus-show-threads
7783 If this variable is @code{nil}, no threading will be done, and all of
7784 the rest of the variables here will have no effect. Turning threading
7785 off will speed group selection up a bit, but it is sure to make reading