1 \input texinfo @c -*-texinfo-*- -*- coding: iso-latin-1 -*-
4 @settitle T-gnus 6.15 Manual
10 * Gnus: (gnus). The newsreader Gnus.
15 @setchapternewpage odd
19 \documentclass[twoside,a4paper,openright,11pt]{book}
20 \usepackage[latin1]{inputenc}
21 \usepackage{pagestyle}
29 \newcommand{\gnuschaptername}{}
30 \newcommand{\gnussectionname}{}
32 \newcommand{\gnusbackslash}{/}
34 \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}}
35 \newcommand{\gnusuref}[1]{\gnustt{#1}}
36 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
37 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
39 \newcommand{\gnuskindex}[1]{\index{#1}}
40 \newcommand{\gnusindex}[1]{\index{#1}}
42 \newcommand{\gnustt}[1]{{\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}}
43 \newcommand{\gnuscode}[1]{\gnustt{#1}}
44 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}''}
45 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
46 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
47 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
48 \newcommand{\gnusdfn}[1]{\textit{#1}}
49 \newcommand{\gnusi}[1]{\textit{#1}}
50 \newcommand{\gnusstrong}[1]{\textbf{#1}}
51 \newcommand{\gnusemph}[1]{\textit{#1}}
52 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
53 \newcommand{\gnussc}[1]{\textsc{#1}}
54 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
55 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
56 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
58 \newcommand{\gnusbullet}{{${\bullet}$}}
59 \newcommand{\gnusdollar}{\$}
60 \newcommand{\gnusampersand}{\&}
61 \newcommand{\gnuspercent}{\%}
62 \newcommand{\gnushash}{\#}
63 \newcommand{\gnushat}{\symbol{"5E}}
64 \newcommand{\gnusunderline}{\symbol{"5F}}
65 \newcommand{\gnusnot}{$\neg$}
66 \newcommand{\gnustilde}{\symbol{"7E}}
67 \newcommand{\gnusless}{{$<$}}
68 \newcommand{\gnusgreater}{{$>$}}
69 \newcommand{\gnusbraceleft}{{$>$}}
70 \newcommand{\gnusbraceright}{{$>$}}
72 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
73 \newcommand{\gnusinteresting}{
74 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
77 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
79 \newcommand{\gnuspagechapter}[1]{
86 \newcommand{\gnuschapter}[2]{
88 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
90 \renewcommand{\gnussectionname}{}
91 \renewcommand{\gnuschaptername}{#2}
94 \begin{picture}(500,500)(0,0)
95 \put(480,350){\makebox(0,0)[tr]{#1}}
96 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
101 \newcommand{\gnusfigure}[3]{
103 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
110 \newcommand{\gnusicon}[1]{
111 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=tmp/#1-up.ps,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=tmp/#1-up.ps,height=1cm}}}
114 \newcommand{\gnuspicon}[1]{
115 \margindex{\epsfig{figure=#1,width=2cm}}
118 \newcommand{\gnusxface}[2]{
119 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
122 \newcommand{\gnussmiley}[2]{
123 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
126 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
128 \newcommand{\gnussection}[1]{
129 \renewcommand{\gnussectionname}{#1}
133 \newenvironment{codelist}%
138 \newenvironment{kbdlist}%
144 \newenvironment{dfnlist}%
149 \newenvironment{stronglist}%
154 \newenvironment{samplist}%
159 \newenvironment{varlist}%
164 \newenvironment{emphlist}%
169 \newlength\gnusheadtextwidth
170 \setlength{\gnusheadtextwidth}{\headtextwidth}
171 \addtolength{\gnusheadtextwidth}{1cm}
173 \newpagestyle{gnuspreamble}%
178 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
182 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
191 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
193 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
198 \newpagestyle{gnusindex}%
203 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
207 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
215 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
217 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
227 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
231 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
239 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
241 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
246 \pagenumbering{roman}
247 \pagestyle{gnuspreamble}
257 %\addtolength{\oddsidemargin}{-5cm}
258 %\addtolength{\evensidemargin}{-5cm}
260 \addtolength{\textheight}{2cm}
262 \gnustitle{\gnustitlename}\\
265 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
268 \gnusauthor{by Lars Magne Ingebrigtsen}
275 \thispagestyle{empty}
277 Copyright \copyright{} 1995, 1996, 1997, 1998, 1999, 2000
278 Free Software Foundation, Inc.
281 Permission is granted to copy, distribute and/or modify this document
282 under the terms of the GNU Free Documentation License, Version 1.1 or
283 any later version published by the Free Software Foundation; with no
284 Invariant Sections, with the Front-Cover texts being ``A GNU
285 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
286 license is included in the section entitled ``GNU Free Documentation
287 License'' in the Emacs manual.
289 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
290 this GNU Manual, like GNU software. Copies published by the Free
291 Software Foundation raise funds for GNU development.''
293 This document is part of a collection distributed under the GNU Free
294 Documentation License. If you want to distribute this document
295 separately from the collection, you can do so by adding a copy of the
296 license to the document, as described in section 6 of the license.
304 This file documents gnus, the GNU Emacs newsreader.
306 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
308 Permission is granted to copy, distribute and/or modify this document
309 under the terms of the GNU Free Documentation License, Version 1.1 or
310 any later version published by the Free Software Foundation; with the
311 Invariant Sections being none, with the Front-Cover texts being ``A GNU
312 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
313 license is included in the section entitled ``GNU Free Documentation
314 License'' in the Emacs manual.
316 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
317 this GNU Manual, like GNU software. Copies published by the Free
318 Software Foundation raise funds for GNU development.''
320 This document is part of a collection distributed under the GNU Free
321 Documentation License. If you want to distribute this document
322 separately from the collection, you can do so by adding a copy of the
323 license to the document, as described in section 6 of the license.
329 @title T-gnus 6.15 Manual
331 @author by Lars Magne Ingebrigtsen
334 @vskip 0pt plus 1filll
335 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
337 Permission is granted to copy, distribute and/or modify this document
338 under the terms of the GNU Free Documentation License, Version 1.1 or
339 any later version published by the Free Software Foundation; with no
340 Invariant Sections, with the Front-Cover texts being ``A GNU
341 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
342 license is included in the section entitled ``GNU Free Documentation
343 License'' in the Emacs manual.
345 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
346 this GNU Manual, like GNU software. Copies published by the Free
347 Software Foundation raise funds for GNU development.''
349 This document is part of a collection distributed under the GNU Free
350 Documentation License. If you want to distribute this document
351 separately from the collection, you can do so by adding a copy of the
352 license to the document, as described in section 6 of the license.
361 @top The gnus Newsreader
365 You can read news (and mail) from within Emacs by using gnus. The news
366 can be gotten by any nefarious means you can think of---@sc{nntp}, local
367 spool or your mbox file. All at the same time, if you want to push your
370 T-gnus provides MIME features based on SEMI API. So T-gnus supports
371 your right to read strange messages including big images or other
372 various kinds of formats. T-gnus also supports
373 internationalization/localization and multiscript features based on MULE
374 API. So T-gnus does not discriminate various language communities.
375 Oh, if you are a Klingon, please wait Unicode Next Generation.
377 This manual corresponds to T-gnus 6.15.
388 Gnus is the advanced, self-documenting, customizable, extensible
389 unreal-time newsreader for GNU Emacs.
391 Oops. That sounds oddly familiar, so let's start over again to avoid
392 being accused of plagiarism:
394 Gnus is a message-reading laboratory. It will let you look at just
395 about anything as if it were a newsgroup. You can read mail with it,
396 you can browse directories with it, you can @code{ftp} with it---you
397 can even read news with it!
399 Gnus tries to empower people who read news the same way Emacs empowers
400 people who edit text. Gnus sets no limits to what the user should be
401 allowed to do. Users are encouraged to extend gnus to make it behave
402 like they want it to behave. A program should not control people;
403 people should be empowered to do what they want by using (or abusing)
409 * Starting Up:: Finding news can be a pain.
410 * Group Buffer:: Selecting, subscribing and killing groups.
411 * Summary Buffer:: Reading, saving and posting articles.
412 * Article Buffer:: Displaying and handling articles.
413 * Composing Messages:: Information on sending mail and news.
414 * Select Methods:: Gnus reads all messages from various select methods.
415 * Scoring:: Assigning values to articles.
416 * Various:: General purpose settings.
417 * The End:: Farewell and goodbye.
418 * Appendices:: Terminology, Emacs intro, FAQ, History, Internals.
419 * Index:: Variable, function and concept index.
420 * Key Index:: Key Index.
423 --- The Detailed Node Listing ---
427 * Finding the News:: Choosing a method for getting news.
428 * The First Time:: What does Gnus do the first time you start it?
429 * The Server is Down:: How can I read my mail then?
430 * Slave Gnusae:: You can have more than one Gnus active at a time.
431 * Fetching a Group:: Starting Gnus just to read a group.
432 * New Groups:: What is Gnus supposed to do with new groups?
433 * Startup Files:: Those pesky startup files---@file{.newsrc}.
434 * Auto Save:: Recovering from a crash.
435 * The Active File:: Reading the active file over a slow line Takes Time.
436 * Changing Servers:: You may want to move from one server to another.
437 * Startup Variables:: Other variables you might change.
441 * Checking New Groups:: Determining what groups are new.
442 * Subscription Methods:: What Gnus should do with new groups.
443 * Filtering New Groups:: Making Gnus ignore certain new groups.
447 * Group Buffer Format:: Information listed and how you can change it.
448 * Group Maneuvering:: Commands for moving in the group buffer.
449 * Selecting a Group:: Actually reading news.
450 * Group Data:: Changing the info for a group.
451 * Subscription Commands:: Unsubscribing, killing, subscribing.
452 * Group Levels:: Levels? What are those, then?
453 * Group Score:: A mechanism for finding out what groups you like.
454 * Marking Groups:: You can mark groups for later processing.
455 * Foreign Groups:: Creating and editing groups.
456 * Group Parameters:: Each group may have different parameters set.
457 * Listing Groups:: Gnus can list various subsets of the groups.
458 * Sorting Groups:: Re-arrange the group order.
459 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
460 * Browse Foreign Server:: You can browse a server. See what it has to offer.
461 * Exiting Gnus:: Stop reading news and get some work done.
462 * Group Topics:: A folding group mode divided into topics.
463 * Misc Group Stuff:: Other stuff that you can to do.
467 * Group Line Specification:: Deciding how the group buffer is to look.
468 * Group Modeline Specification:: The group buffer modeline.
469 * Group Highlighting:: Having nice colors in the group buffer.
473 * Topic Variables:: How to customize the topics the Lisp Way.
474 * Topic Commands:: Interactive E-Z commands.
475 * Topic Sorting:: Sorting each topic individually.
476 * Topic Topology:: A map of the world.
477 * Topic Parameters:: Parameters that apply to all groups in a topic.
481 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
482 * Group Information:: Information and help on groups and Gnus.
483 * Group Timestamp:: Making Gnus keep track of when you last read a group.
484 * File Commands:: Reading and writing the Gnus files.
488 * Summary Buffer Format:: Deciding how the summary buffer is to look.
489 * Summary Maneuvering:: Moving around the summary buffer.
490 * Choosing Articles:: Reading articles.
491 * Paging the Article:: Scrolling the current article.
492 * Reply Followup and Post:: Posting articles.
493 * Marking Articles:: Marking articles as read, expirable, etc.
494 * Limiting:: You can limit the summary buffer.
495 * Threading:: How threads are made.
496 * Sorting the Summary Buffer:: How articles and threads are sorted.
497 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
498 * Article Caching:: You may store articles in a cache.
499 * Persistent Articles:: Making articles expiry-resistant.
500 * Article Backlog:: Having already read articles hang around.
501 * Saving Articles:: Ways of customizing article saving.
502 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
503 * Article Treatment:: The article buffer can be mangled at will.
504 * MIME Commands:: Doing MIMEy things with the articles.
505 * Charsets:: Character set issues.
506 * Article Commands:: Doing various things with the article buffer.
507 * Summary Sorting:: Sorting the summary buffer in various ways.
508 * Finding the Parent:: No child support? Get the parent.
509 * Alternative Approaches:: Reading using non-default summaries.
510 * Tree Display:: A more visual display of threads.
511 * Mail Group Commands:: Some commands can only be used in mail groups.
512 * Various Summary Stuff:: What didn't fit anywhere else.
513 * Exiting the Summary Buffer:: Returning to the Group buffer.
514 * Crosspost Handling:: How crossposted articles are dealt with.
515 * Duplicate Suppression:: An alternative when crosspost handling fails.
516 * Security:: Decrypt and Verify.
518 Summary Buffer Format
520 * Summary Buffer Lines:: You can specify how summary lines should look.
521 * To From Newsgroups:: How to not display your own name.
522 * Summary Buffer Mode Line:: You can say how the mode line should look.
523 * Summary Highlighting:: Making the summary buffer all pretty and nice.
527 * Choosing Commands:: Commands for choosing articles.
528 * Choosing Variables:: Variables that influence these commands.
530 Reply, Followup and Post
532 * Summary Mail Commands:: Sending mail.
533 * Summary Post Commands:: Sending news.
534 * Summary Message Commands:: Other Message-related commands.
535 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
539 * Unread Articles:: Marks for unread articles.
540 * Read Articles:: Marks for read articles.
541 * Other Marks:: Marks that do not affect readedness.
542 * Setting Marks:: How to set and remove marks.
543 * Generic Marking Commands:: How to customize the marking.
544 * Setting Process Marks:: How to mark articles for later processing.
548 * Customizing Threading:: Variables you can change to affect the threading.
549 * Thread Commands:: Thread based commands in the summary buffer.
551 Customizing Threading
553 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
554 * Filling In Threads:: Making the threads displayed look fuller.
555 * More Threading:: Even more variables for fiddling with threads.
556 * Low-Level Threading:: You thought it was over... but you were wrong!
560 * Uuencoded Articles:: Uudecode articles.
561 * Shell Archives:: Unshar articles.
562 * PostScript Files:: Split PostScript.
563 * Other Files:: Plain save and binhex.
564 * Decoding Variables:: Variables for a happy decoding.
565 * Viewing Files:: You want to look at the result of the decoding?
569 * Rule Variables:: Variables that say how a file is to be viewed.
570 * Other Decode Variables:: Other decode variables.
571 * Uuencoding and Posting:: Variables for customizing uuencoding.
575 * Article Highlighting:: You want to make the article look like fruit salad.
576 * Article Fontisizing:: Making emphasized text look nice.
577 * Article Hiding:: You also want to make certain info go away.
578 * Article Washing:: Lots of way-neat functions to make life better.
579 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
580 * Article Date:: Grumble, UT!
581 * Article Signature:: What is a signature?
582 * Article Miscellania:: Various other stuff.
584 Alternative Approaches
586 * Pick and Read:: First mark articles and then read them.
587 * Binary Groups:: Auto-decode all articles.
589 Various Summary Stuff
591 * Summary Group Information:: Information oriented commands.
592 * Searching for Articles:: Multiple article commands.
593 * Summary Generation Commands:: (Re)generating the summary buffer.
594 * Really Various Summary Commands:: Those pesky non-conformant commands.
598 * Hiding Headers:: Deciding what headers should be displayed.
599 * Using MIME:: Pushing articles through @sc{mime} before reading them.
600 * Customizing Articles:: Tailoring the look of the articles.
601 * Article Keymap:: Keystrokes available in the article buffer.
602 * Misc Article:: Other stuff.
606 * Mail:: Mailing and replying.
607 * Posting Server:: What server should you post via?
608 * Mail and Post:: Mailing and posting at the same time.
609 * Archived Messages:: Where Gnus stores the messages you've sent.
610 * Posting Styles:: An easier way to specify who you are.
611 * Drafts:: Postponing messages and rejected messages.
612 * Rejected Articles:: What happens if the server doesn't like your article?
613 * Using GPG:: How to use GPG and MML to sign and encrypt messages
617 * Server Buffer:: Making and editing virtual servers.
618 * Getting News:: Reading USENET news with Gnus.
619 * Getting Mail:: Reading your personal mail with Gnus.
620 * Browsing the Web:: Getting messages from a plethora of Web sources.
621 * Other Sources:: Reading directories, files, SOUP packets.
622 * Combined Groups:: Combining groups into one group.
623 * Gnus Unplugged:: Reading news and mail offline.
627 * Server Buffer Format:: You can customize the look of this buffer.
628 * Server Commands:: Commands to manipulate servers.
629 * Example Methods:: Examples server specifications.
630 * Creating a Virtual Server:: An example session.
631 * Server Variables:: Which variables to set.
632 * Servers and Methods:: You can use server names as select methods.
633 * Unavailable Servers:: Some servers you try to contact may be down.
637 * NNTP:: Reading news from an @sc{nntp} server.
638 * News Spool:: Reading news from the local spool.
642 * Mail in a Newsreader:: Important introductory notes.
643 * Getting Started Reading Mail:: A simple cookbook example.
644 * Splitting Mail:: How to create mail groups.
645 * Mail Sources:: How to tell Gnus where to get mail from.
646 * Mail Backend Variables:: Variables for customizing mail handling.
647 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
648 * Group Mail Splitting:: Use group customize to drive mail splitting.
649 * Incorporating Old Mail:: What about the old mail you have?
650 * Expiring Mail:: Getting rid of unwanted mail.
651 * Washing Mail:: Removing cruft from the mail you get.
652 * Duplicates:: Dealing with duplicated mail.
653 * Not Reading Mail:: Using mail backends for reading other files.
654 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
658 * Mail Source Specifiers:: How to specify what a mail source is.
659 * Mail Source Customization:: Some variables that influence things.
660 * Fetching Mail:: Using the mail source specifiers.
662 Choosing a Mail Backend
664 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
665 * Rmail Babyl:: Emacs programs use the rmail babyl format.
666 * Mail Spool:: Store your mail in a private spool?
667 * MH Spool:: An mhspool-like backend.
668 * Mail Folders:: Having one file for each group.
669 * Comparing Mail Backends:: An in-depth looks at pros and cons.
673 * Web Searches:: Creating groups from articles that match a string.
674 * Slashdot:: Reading the Slashdot comments.
675 * Ultimate:: The Ultimate Bulletin Board systems.
676 * Web Archive:: Reading mailing list archived on web.
677 * RSS:: Reading RDF site summary.
678 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
682 * Directory Groups:: You can read a directory as if it was a newsgroup.
683 * Anything Groups:: Dired? Who needs dired?
684 * Document Groups:: Single files can be the basis of a group.
685 * SOUP:: Reading @sc{soup} packets ``offline''.
686 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
687 * IMAP:: Using Gnus as a @sc{imap} client.
691 * Document Server Internals:: How to add your own document types.
695 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
696 * SOUP Groups:: A backend for reading @sc{soup} packets.
697 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
701 * Splitting in IMAP:: Splitting mail with nnimap.
702 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
703 * Expunging mailboxes:: Equivalent of a "compress mailbox" button.
707 * Virtual Groups:: Combining articles from many groups.
708 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
712 * Agent Basics:: How it all is supposed to work.
713 * Agent Categories:: How to tell the Gnus Agent what to download.
714 * Agent Commands:: New commands for all the buffers.
715 * Agent Expiry:: How to make old articles go away.
716 * Agent and IMAP:: How to use the Agent with IMAP.
717 * Outgoing Messages:: What happens when you post/mail something?
718 * Agent Variables:: Customizing is fun.
719 * Example Setup:: An example @file{.gnus.el} file for offline people.
720 * Batching Agents:: How to fetch news from a @code{cron} job.
721 * Agent Caveats:: What you think it'll do and what it does.
725 * Category Syntax:: What a category looks like.
726 * Category Buffer:: A buffer for maintaining categories.
727 * Category Variables:: Customize'r'Us.
731 * Group Agent Commands::
732 * Summary Agent Commands::
733 * Server Agent Commands::
737 * Summary Score Commands:: Adding score entries for the current group.
738 * Group Score Commands:: General score commands.
739 * Score Variables:: Customize your scoring. (My, what terminology).
740 * Score File Format:: What a score file may contain.
741 * Score File Editing:: You can edit score files by hand as well.
742 * Adaptive Scoring:: Big Sister Gnus knows what you read.
743 * Home Score File:: How to say where new score entries are to go.
744 * Followups To Yourself:: Having Gnus notice when people answer you.
745 * Scoring Tips:: How to score effectively.
746 * Reverse Scoring:: That problem child of old is not problem.
747 * Global Score Files:: Earth-spanning, ear-splitting score files.
748 * Kill Files:: They are still here, but they can be ignored.
749 * Converting Kill Files:: Translating kill files to score files.
750 * GroupLens:: Getting predictions on what you like to read.
751 * Advanced Scoring:: Using logical expressions to build score rules.
752 * Score Decays:: It can be useful to let scores wither away.
756 * Using GroupLens:: How to make Gnus use GroupLens.
757 * Rating Articles:: Letting GroupLens know how you rate articles.
758 * Displaying Predictions:: Displaying predictions given by GroupLens.
759 * GroupLens Variables:: Customizing GroupLens.
763 * Advanced Scoring Syntax:: A definition.
764 * Advanced Scoring Examples:: What they look like.
765 * Advanced Scoring Tips:: Getting the most out of it.
769 * Process/Prefix:: A convention used by many treatment commands.
770 * Interactive:: Making Gnus ask you many questions.
771 * Symbolic Prefixes:: How to supply some Gnus functions with options.
772 * Formatting Variables:: You can specify what buffers should look like.
773 * Windows Configuration:: Configuring the Gnus buffer windows.
774 * Faces and Fonts:: How to change how faces look.
775 * Compilation:: How to speed Gnus up.
776 * Mode Lines:: Displaying information in the mode lines.
777 * Highlighting and Menus:: Making buffers look all nice and cozy.
778 * Buttons:: Get tendinitis in ten easy steps!
779 * Daemons:: Gnus can do things behind your back.
780 * NoCeM:: How to avoid spam and other fatty foods.
781 * Undo:: Some actions can be undone.
782 * Moderation:: What to do if you're a moderator.
783 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
784 * Fuzzy Matching:: What's the big fuzz?
785 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
786 * Various Various:: Things that are really various.
790 * Formatting Basics:: A formatting variable is basically a format string.
791 * Mode Line Formatting:: Some rules about mode line formatting variables.
792 * Advanced Formatting:: Modifying output in various ways.
793 * User-Defined Specs:: Having Gnus call your own functions.
794 * Formatting Fonts:: Making the formatting look colorful and nice.
798 * Picons:: How to display pictures of what your reading.
799 * Smileys:: Show all those happy faces the way they were meant to be shown.
800 * Toolbar:: Click'n'drool.
801 * XVarious:: Other XEmacsy Gnusey variables.
805 * Picon Basics:: What are picons and How do I get them.
806 * Picon Requirements:: Don't go further if you aren't using XEmacs.
807 * Easy Picons:: Displaying Picons---the easy way.
808 * Hard Picons:: The way you should do it. You'll learn something.
809 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
813 * History:: How Gnus got where it is today.
814 * On Writing Manuals:: Why this is not a beginner's guide.
815 * Terminology:: We use really difficult, like, words here.
816 * Customization:: Tailoring Gnus to your needs.
817 * Troubleshooting:: What you might try if things do not work.
818 * Gnus Reference Guide:: Rilly, rilly technical stuff.
819 * Emacs for Heathens:: A short introduction to Emacsian terms.
820 * Frequently Asked Questions:: A question-and-answer session.
824 * Gnus Versions:: What Gnus versions have been released.
825 * Other Gnus Versions:: Other Gnus versions that also have been released.
826 * Why?:: What's the point of Gnus?
827 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
828 * Conformity:: Gnus tries to conform to all standards.
829 * Emacsen:: Gnus can be run on a few modern Emacsen.
830 * Gnus Development:: How Gnus is developed.
831 * Contributors:: Oodles of people.
832 * New Features:: Pointers to some of the new stuff in Gnus.
836 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
837 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
838 * Red Gnus:: Third time best---Gnus 5.4/5.5.
839 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
840 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
844 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
845 * Slow Terminal Connection:: You run a remote Emacs.
846 * Little Disk Space:: You feel that having large setup files is icky.
847 * Slow Machine:: You feel like buying a faster machine.
851 * Gnus Utility Functions:: Common functions and variable to use.
852 * Backend Interface:: How Gnus communicates with the servers.
853 * Score File Syntax:: A BNF definition of the score file standard.
854 * Headers:: How Gnus stores headers internally.
855 * Ranges:: A handy format for storing mucho numbers.
856 * Group Info:: The group info format.
857 * Extended Interactive:: Symbolic prefixes and stuff.
858 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
859 * Various File Formats:: Formats of files that Gnus use.
863 * Required Backend Functions:: Functions that must be implemented.
864 * Optional Backend Functions:: Functions that need not be implemented.
865 * Error Messaging:: How to get messages and report errors.
866 * Writing New Backends:: Extending old backends.
867 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
868 * Mail-like Backends:: Some tips on mail backends.
872 * Active File Format:: Information on articles and groups available.
873 * Newsgroups File Format:: Group descriptions.
877 * Keystrokes:: Entering text and executing commands.
878 * Emacs Lisp:: The built-in Emacs programming language.
884 @chapter Starting gnus
889 If your system administrator has set things up properly, starting gnus
890 and reading news is extremely easy---you just type @kbd{M-x gnus} in
893 @findex gnus-other-frame
894 @kindex M-x gnus-other-frame
895 If you want to start gnus in a different frame, you can use the command
896 @kbd{M-x gnus-other-frame} instead.
898 If things do not go smoothly at startup, you have to twiddle some
899 variables in your @file{~/.gnus} file. This file is similar to
900 @file{~/.emacs}, but is read when gnus starts.
902 If you puzzle at any terms used in this manual, please refer to the
903 terminology section (@pxref{Terminology}).
906 * Finding the News:: Choosing a method for getting news.
907 * The First Time:: What does gnus do the first time you start it?
908 * The Server is Down:: How can I read my mail then?
909 * Slave Gnusae:: You can have more than one gnus active at a time.
910 * Fetching a Group:: Starting gnus just to read a group.
911 * New Groups:: What is gnus supposed to do with new groups?
912 * Startup Files:: Those pesky startup files---@file{.newsrc}.
913 * Auto Save:: Recovering from a crash.
914 * The Active File:: Reading the active file over a slow line Takes Time.
915 * Changing Servers:: You may want to move from one server to another.
916 * Startup Variables:: Other variables you might change.
920 @node Finding the News
921 @section Finding the News
924 @vindex gnus-select-method
926 The @code{gnus-select-method} variable says where gnus should look for
927 news. This variable should be a list where the first element says
928 @dfn{how} and the second element says @dfn{where}. This method is your
929 native method. All groups not fetched with this method are
932 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
933 you want to get your daily dosage of news from, you'd say:
936 (setq gnus-select-method '(nntp "news.somewhere.edu"))
939 If you want to read directly from the local spool, say:
942 (setq gnus-select-method '(nnspool ""))
945 If you can use a local spool, you probably should, as it will almost
946 certainly be much faster.
948 @vindex gnus-nntpserver-file
950 @cindex @sc{nntp} server
951 If this variable is not set, gnus will take a look at the
952 @code{NNTPSERVER} environment variable. If that variable isn't set,
953 gnus will see whether @code{gnus-nntpserver-file}
954 (@file{/etc/nntpserver} by default) has any opinions on the matter. If
955 that fails as well, gnus will try to use the machine running Emacs as an @sc{nntp} server. That's a long shot, though.
957 @vindex gnus-nntp-server
958 If @code{gnus-nntp-server} is set, this variable will override
959 @code{gnus-select-method}. You should therefore set
960 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
962 @vindex gnus-secondary-servers
963 @vindex gnus-nntp-server
964 You can also make gnus prompt you interactively for the name of an
965 @sc{nntp} server. If you give a non-numerical prefix to @code{gnus}
966 (i.e., @kbd{C-u M-x gnus}), gnus will let you choose between the servers
967 in the @code{gnus-secondary-servers} list (if any). You can also just
968 type in the name of any server you feel like visiting. (Note that this
969 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
970 gnus} later in the same Emacs session, Gnus will contact the same
973 @findex gnus-group-browse-foreign-server
975 However, if you use one @sc{nntp} server regularly and are just
976 interested in a couple of groups from a different server, you would be
977 better served by using the @kbd{B} command in the group buffer. It will
978 let you have a look at what groups are available, and you can subscribe
979 to any of the groups you want to. This also makes @file{.newsrc}
980 maintenance much tidier. @xref{Foreign Groups}.
982 @vindex gnus-secondary-select-methods
984 A slightly different approach to foreign groups is to set the
985 @code{gnus-secondary-select-methods} variable. The select methods
986 listed in this variable are in many ways just as native as the
987 @code{gnus-select-method} server. They will also be queried for active
988 files during startup (if that's required), and new newsgroups that
989 appear on these servers will be subscribed (or not) just as native
992 For instance, if you use the @code{nnmbox} backend to read your mail, you
993 would typically set this variable to
996 (setq gnus-secondary-select-methods '((nnmbox "")))
1000 @node The First Time
1001 @section The First Time
1002 @cindex first time usage
1004 If no startup files exist, gnus will try to determine what groups should
1005 be subscribed by default.
1007 @vindex gnus-default-subscribed-newsgroups
1008 If the variable @code{gnus-default-subscribed-newsgroups} is set, gnus
1009 will subscribe you to just those groups in that list, leaving the rest
1010 killed. Your system administrator should have set this variable to
1013 Since she hasn't, gnus will just subscribe you to a few arbitrarily
1014 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1015 here as @dfn{whatever Lars thinks you should read}.)
1017 You'll also be subscribed to the gnus documentation group, which should
1018 help you with most common problems.
1020 If @code{gnus-default-subscribed-newsgroups} is @code{t}, gnus will just
1021 use the normal functions for handling new groups, and not do anything
1025 @node The Server is Down
1026 @section The Server is Down
1027 @cindex server errors
1029 If the default server is down, gnus will understandably have some
1030 problems starting. However, if you have some mail groups in addition to
1031 the news groups, you may want to start gnus anyway.
1033 Gnus, being the trusting sort of program, will ask whether to proceed
1034 without a native select method if that server can't be contacted. This
1035 will happen whether the server doesn't actually exist (i.e., you have
1036 given the wrong address) or the server has just momentarily taken ill
1037 for some reason or other. If you decide to continue and have no foreign
1038 groups, you'll find it difficult to actually do anything in the group
1039 buffer. But, hey, that's your problem. Blllrph!
1041 @findex gnus-no-server
1042 @kindex M-x gnus-no-server
1044 If you know that the server is definitely down, or you just want to read
1045 your mail without bothering with the server at all, you can use the
1046 @code{gnus-no-server} command to start gnus. That might come in handy
1047 if you're in a hurry as well. This command will not attempt to contact
1048 your primary server---instead, it will just activate all groups on level
1049 1 and 2. (You should preferably keep no native groups on those two
1050 levels.) Also @pxref{Group Levels}.
1054 @section Slave Gnusae
1057 You might want to run more than one Emacs with more than one gnus at the
1058 same time. If you are using different @file{.newsrc} files (e.g., if you
1059 are using the two different gnusae to read from two different servers),
1060 that is no problem whatsoever. You just do it.
1062 The problem appears when you want to run two Gnusae that use the same
1063 @code{.newsrc} file.
1065 To work around that problem some, we here at the Think-Tank at the gnus
1066 Towers have come up with a new concept: @dfn{Masters} and
1067 @dfn{slaves}. (We have applied for a patent on this concept, and have
1068 taken out a copyright on those words. If you wish to use those words in
1069 conjunction with each other, you have to send $1 per usage instance to
1070 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1071 Applications}) will be much more expensive, of course.)
1073 Anyway, you start one gnus up the normal way with @kbd{M-x gnus} (or
1074 however you do it). Each subsequent slave gnusae should be started with
1075 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1076 files, but instead save @dfn{slave files} that contain information only
1077 on what groups have been read in the slave session. When a master gnus
1078 starts, it will read (and delete) these slave files, incorporating all
1079 information from them. (The slave files will be read in the sequence
1080 they were created, so the latest changes will have precedence.)
1082 Information from the slave files has, of course, precedence over the
1083 information in the normal (i.e., master) @code{.newsrc} file.
1086 @node Fetching a Group
1087 @section Fetching a Group
1088 @cindex fetching a group
1090 @findex gnus-fetch-group
1091 It is sometimes convenient to be able to just say ``I want to read this
1092 group and I don't care whether gnus has been started or not''. This is
1093 perhaps more useful for people who write code than for users, but the
1094 command @code{gnus-fetch-group} provides this functionality in any case.
1095 It takes the group name as a parameter.
1101 @cindex subscription
1103 @vindex gnus-check-new-newsgroups
1104 If you are satisfied that you really never want to see any new groups,
1105 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1106 also save you some time at startup. Even if this variable is
1107 @code{nil}, you can always subscribe to the new groups just by pressing
1108 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1109 is @code{ask-server} by default. If you set this variable to
1110 @code{always}, then gnus will query the backends for new groups even
1111 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1114 * Checking New Groups:: Determining what groups are new.
1115 * Subscription Methods:: What gnus should do with new groups.
1116 * Filtering New Groups:: Making gnus ignore certain new groups.
1120 @node Checking New Groups
1121 @subsection Checking New Groups
1123 Gnus normally determines whether a group is new or not by comparing the
1124 list of groups from the active file(s) with the lists of subscribed and
1125 dead groups. This isn't a particularly fast method. If
1126 @code{gnus-check-new-newsgroups} is @code{ask-server}, gnus will ask the
1127 server for new groups since the last time. This is both faster and
1128 cheaper. This also means that you can get rid of the list of killed
1129 groups altogether, so you may set @code{gnus-save-killed-list} to
1130 @code{nil}, which will save time both at startup, at exit, and all over.
1131 Saves disk space, too. Why isn't this the default, then?
1132 Unfortunately, not all servers support this command.
1134 I bet I know what you're thinking now: How do I find out whether my
1135 server supports @code{ask-server}? No? Good, because I don't have a
1136 fail-safe answer. I would suggest just setting this variable to
1137 @code{ask-server} and see whether any new groups appear within the next
1138 few days. If any do, then it works. If none do, then it doesn't
1139 work. I could write a function to make gnus guess whether the server
1140 supports @code{ask-server}, but it would just be a guess. So I won't.
1141 You could @code{telnet} to the server and say @code{HELP} and see
1142 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1143 it does, then it might work. (But there are servers that lists
1144 @samp{NEWGROUPS} without supporting the function properly.)
1146 This variable can also be a list of select methods. If so, gnus will
1147 issue an @code{ask-server} command to each of the select methods, and
1148 subscribe them (or not) using the normal methods. This might be handy
1149 if you are monitoring a few servers for new groups. A side effect is
1150 that startup will take much longer, so you can meditate while waiting.
1151 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1154 @node Subscription Methods
1155 @subsection Subscription Methods
1157 @vindex gnus-subscribe-newsgroup-method
1158 What gnus does when it encounters a new group is determined by the
1159 @code{gnus-subscribe-newsgroup-method} variable.
1161 This variable should contain a function. This function will be called
1162 with the name of the new group as the only parameter.
1164 Some handy pre-fab functions are:
1168 @item gnus-subscribe-zombies
1169 @vindex gnus-subscribe-zombies
1170 Make all new groups zombies. This is the default. You can browse the
1171 zombies later (with @kbd{A z}) and either kill them all off properly
1172 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1174 @item gnus-subscribe-randomly
1175 @vindex gnus-subscribe-randomly
1176 Subscribe all new groups in arbitrary order. This really means that all
1177 new groups will be added at ``the top'' of the group buffer.
1179 @item gnus-subscribe-alphabetically
1180 @vindex gnus-subscribe-alphabetically
1181 Subscribe all new groups in alphabetical order.
1183 @item gnus-subscribe-hierarchically
1184 @vindex gnus-subscribe-hierarchically
1185 Subscribe all new groups hierarchically. The difference between this
1186 function and @code{gnus-subscribe-alphabetically} is slight.
1187 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1188 alphabetical fashion, while this function will enter groups into its
1189 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1190 @samp{comp} hierarchy, this function will not mess that configuration
1191 up. Or something like that.
1193 @item gnus-subscribe-interactively
1194 @vindex gnus-subscribe-interactively
1195 Subscribe new groups interactively. This means that gnus will ask
1196 you about @strong{all} new groups. The groups you choose to subscribe
1197 to will be subscribed hierarchically.
1199 @item gnus-subscribe-killed
1200 @vindex gnus-subscribe-killed
1201 Kill all new groups.
1203 @item gnus-subscribe-topics
1204 @vindex gnus-subscribe-topics
1205 Put the groups into the topic that has a matching @code{subscribe} topic
1206 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1207 topic parameter that looks like
1213 will mean that all groups that match that regex will be subscribed under
1216 If no topics match the groups, the groups will be subscribed in the
1221 @vindex gnus-subscribe-hierarchical-interactive
1222 A closely related variable is
1223 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1224 mouthful.) If this variable is non-@code{nil}, gnus will ask you in a
1225 hierarchical fashion whether to subscribe to new groups or not. Gnus
1226 will ask you for each sub-hierarchy whether you want to descend the
1229 One common mistake is to set the variable a few paragraphs above
1230 (@code{gnus-subscribe-newsgroup-method}) to
1231 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1232 will not work. This is ga-ga. So don't do it.
1235 @node Filtering New Groups
1236 @subsection Filtering New Groups
1238 A nice and portable way to control which new newsgroups should be
1239 subscribed (or ignored) is to put an @dfn{options} line at the start of
1240 the @file{.newsrc} file. Here's an example:
1243 options -n !alt.all !rec.all sci.all
1246 @vindex gnus-subscribe-options-newsgroup-method
1247 This line obviously belongs to a serious-minded intellectual scientific
1248 person (or she may just be plain old boring), because it says that all
1249 groups that have names beginning with @samp{alt} and @samp{rec} should
1250 be ignored, and all groups with names beginning with @samp{sci} should
1251 be subscribed. Gnus will not use the normal subscription method for
1252 subscribing these groups.
1253 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1254 variable defaults to @code{gnus-subscribe-alphabetically}.
1256 @vindex gnus-options-not-subscribe
1257 @vindex gnus-options-subscribe
1258 If you don't want to mess with your @file{.newsrc} file, you can just
1259 set the two variables @code{gnus-options-subscribe} and
1260 @code{gnus-options-not-subscribe}. These two variables do exactly the
1261 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1262 and if the new group matches the former, it will be unconditionally
1263 subscribed, and if it matches the latter, it will be ignored.
1265 @vindex gnus-auto-subscribed-groups
1266 Yet another variable that meddles here is
1267 @code{gnus-auto-subscribed-groups}. It works exactly like
1268 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
1269 thought it would be nice to have two of these. This variable is more
1270 meant for setting some ground rules, while the other variable is used
1271 more for user fiddling. By default this variable makes all new groups
1272 that come from mail backends (@code{nnml}, @code{nnbabyl},
1273 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed. If you
1274 don't like that, just set this variable to @code{nil}.
1276 New groups that match this regexp are subscribed using
1277 @code{gnus-subscribe-options-newsgroup-method}.
1280 @node Changing Servers
1281 @section Changing Servers
1282 @cindex changing servers
1284 Sometimes it is necessary to move from one @sc{nntp} server to another.
1285 This happens very rarely, but perhaps you change jobs, or one server is
1286 very flaky and you want to use another.
1288 Changing the server is pretty easy, right? You just change
1289 @code{gnus-select-method} to point to the new server?
1293 Article numbers are not (in any way) kept synchronized between different
1294 @sc{nntp} servers, and the only way Gnus keeps track of what articles
1295 you have read is by keeping track of article numbers. So when you
1296 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1299 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1300 file from one server to another. They all have one thing in
1301 common---they take a looong time to run. You don't want to use these
1302 functions more than absolutely necessary.
1304 @kindex M-x gnus-change-server
1305 @findex gnus-change-server
1306 If you have access to both servers, Gnus can request the headers for all
1307 the articles you have read and compare @code{Message-ID}s and map the
1308 article numbers of the read articles and article marks. The @kbd{M-x
1309 gnus-change-server} command will do this for all your native groups. It
1310 will prompt for the method you want to move to.
1312 @kindex M-x gnus-group-move-group-to-server
1313 @findex gnus-group-move-group-to-server
1314 You can also move individual groups with the @kbd{M-x
1315 gnus-group-move-group-to-server} command. This is useful if you want to
1316 move a (foreign) group from one server to another.
1318 @kindex M-x gnus-group-clear-data-on-native-groups
1319 @findex gnus-group-clear-data-on-native-groups
1320 If you don't have access to both the old and new server, all your marks
1321 and read ranges have become worthless. You can use the @kbd{M-x
1322 gnus-group-clear-data-on-native-groups} command to clear out all data
1323 that you have on your native groups. Use with caution.
1325 After changing servers, you @strong{must} move the cache hierarchy away,
1326 since the cached articles will have wrong article numbers, which will
1327 affect which articles Gnus thinks are read.
1331 @section Startup Files
1332 @cindex startup files
1337 Now, you all know about the @file{.newsrc} file. All subscription
1338 information is traditionally stored in this file.
1340 Things got a bit more complicated with @sc{gnus}. In addition to
1341 keeping the @file{.newsrc} file updated, it also used a file called
1342 @file{.newsrc.el} for storing all the information that didn't fit into
1343 the @file{.newsrc} file. (Actually, it also duplicated everything in
1344 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1345 files was the most recently saved, which enabled people to swap between
1346 @sc{gnus} and other newsreaders.
1348 That was kinda silly, so Gnus went one better: In addition to the
1349 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1350 @file{.newsrc.eld}. It will read whichever of these files that are most
1351 recent, but it will never write a @file{.newsrc.el} file. You should
1352 never delete the @file{.newsrc.eld} file---it contains much information
1353 not stored in the @file{.newsrc} file.
1355 @vindex gnus-save-newsrc-file
1356 @vindex gnus-read-newsrc-file
1357 You can turn off writing the @file{.newsrc} file by setting
1358 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1359 the file and save some space, as well as exiting from gnus faster.
1360 However, this will make it impossible to use other newsreaders than
1361 gnus. But hey, who would want to, right? Similarly, setting
1362 @code{gnus-read-newsrc-file} to @code{nil} makes gnus ignore the
1363 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1364 convenient if you have a tendency to use Netscape once in a while.
1366 @vindex gnus-save-killed-list
1367 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1368 will not save the list of killed groups to the startup file. This will
1369 save both time (when starting and quitting) and space (on disk). It
1370 will also mean that Gnus has no record of what groups are new or old,
1371 so the automatic new groups subscription methods become meaningless.
1372 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1373 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1374 Groups}). This variable can also be a regular expression. If that's
1375 the case, remove all groups that do not match this regexp before
1376 saving. This can be useful in certain obscure situations that involve
1377 several servers where not all servers support @code{ask-server}.
1379 @vindex gnus-startup-file
1380 The @code{gnus-startup-file} variable says where the startup files are.
1381 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1382 file being whatever that one is, with a @samp{.eld} appended.
1384 @vindex gnus-save-newsrc-hook
1385 @vindex gnus-save-quick-newsrc-hook
1386 @vindex gnus-save-standard-newsrc-hook
1387 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1388 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1389 saving the @file{.newsrc.eld} file, and
1390 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1391 @file{.newsrc} file. The latter two are commonly used to turn version
1392 control on or off. Version control is on by default when saving the
1393 startup files. If you want to turn backup creation off, say something like:
1396 (defun turn-off-backup ()
1397 (set (make-local-variable 'backup-inhibited) t))
1399 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1400 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1403 @vindex gnus-init-file
1404 When gnus starts, it will read the @code{gnus-site-init-file}
1405 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1406 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1407 and can be used to avoid cluttering your @file{~/.emacs} and
1408 @file{site-init} files with gnus stuff. Gnus will also check for files
1409 with the same names as these, but with @file{.elc} and @file{.el}
1410 suffixes. In other words, if you have set @code{gnus-init-file} to
1411 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1412 and finally @file{~/.gnus} (in this order).
1418 @cindex dribble file
1421 Whenever you do something that changes the gnus data (reading articles,
1422 catching up, killing/subscribing groups), the change is added to a
1423 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1424 Emacs way. If your Emacs should crash before you have saved the
1425 @file{.newsrc} files, all changes you have made can be recovered from
1428 If gnus detects this file at startup, it will ask the user whether to
1429 read it. The auto save file is deleted whenever the real startup file is
1432 @vindex gnus-use-dribble-file
1433 If @code{gnus-use-dribble-file} is @code{nil}, gnus won't create and
1434 maintain a dribble buffer. The default is @code{t}.
1436 @vindex gnus-dribble-directory
1437 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1438 this variable is @code{nil}, which it is by default, gnus will dribble
1439 into the directory where the @file{.newsrc} file is located. (This is
1440 normally the user's home directory.) The dribble file will get the same
1441 file permissions as the @code{.newsrc} file.
1443 @vindex gnus-always-read-dribble-file
1444 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1445 read the dribble file on startup without querying the user.
1448 @node The Active File
1449 @section The Active File
1451 @cindex ignored groups
1453 When gnus starts, or indeed whenever it tries to determine whether new
1454 articles have arrived, it reads the active file. This is a very large
1455 file that lists all the active groups and articles on the server.
1457 @vindex gnus-ignored-newsgroups
1458 Before examining the active file, gnus deletes all lines that match the
1459 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1460 any groups with bogus names, but you can use this variable to make gnus
1461 ignore hierarchies you aren't ever interested in. However, this is not
1462 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1463 Groups} for an overview of other variables that can be used instead.
1466 @c @code{nil} by default, and will slow down active file handling somewhat
1467 @c if you set it to anything else.
1469 @vindex gnus-read-active-file
1471 The active file can be rather Huge, so if you have a slow network, you
1472 can set @code{gnus-read-active-file} to @code{nil} to prevent gnus from
1473 reading the active file. This variable is @code{some} by default.
1475 Gnus will try to make do by getting information just on the groups that
1476 you actually subscribe to.
1478 Note that if you subscribe to lots and lots of groups, setting this
1479 variable to @code{nil} will probably make gnus slower, not faster. At
1480 present, having this variable @code{nil} will slow gnus down
1481 considerably, unless you read news over a 2400 baud modem.
1483 This variable can also have the value @code{some}. Gnus will then
1484 attempt to read active info only on the subscribed groups. On some
1485 servers this is quite fast (on sparkling, brand new INN servers that
1486 support the @code{LIST ACTIVE group} command), on others this isn't fast
1487 at all. In any case, @code{some} should be faster than @code{nil}, and
1488 is certainly faster than @code{t} over slow lines.
1490 Some news servers (old versions of Leafnode and old versions of INN, for
1491 instance) do not support the @code{LIST ACTIVE group}. For these
1492 servers, @code{nil} is probably the most efficient value for this
1495 If this variable is @code{nil}, gnus will ask for group info in total
1496 lock-step, which isn't very fast. If it is @code{some} and you use an
1497 @sc{nntp} server, gnus will pump out commands as fast as it can, and
1498 read all the replies in one swoop. This will normally result in better
1499 performance, but if the server does not support the aforementioned
1500 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1502 If you think that starting up Gnus takes too long, try all the three
1503 different values for this variable and see what works best for you.
1505 In any case, if you use @code{some} or @code{nil}, you should definitely
1506 kill all groups that you aren't interested in to speed things up.
1508 Note that this variable also affects active file retrieval from
1509 secondary select methods.
1512 @node Startup Variables
1513 @section Startup Variables
1517 @item gnus-load-hook
1518 @vindex gnus-load-hook
1519 A hook run while gnus is being loaded. Note that this hook will
1520 normally be run just once in each Emacs session, no matter how many
1521 times you start gnus.
1523 @item gnus-before-startup-hook
1524 @vindex gnus-before-startup-hook
1525 A hook run after starting up gnus successfully.
1527 @item gnus-startup-hook
1528 @vindex gnus-startup-hook
1529 A hook run as the very last thing after starting up gnus
1531 @item gnus-started-hook
1532 @vindex gnus-started-hook
1533 A hook that is run as the very last thing after starting up gnus
1536 @item gnus-setup-news-hook
1537 @vindex gnus-setup-news-hook
1538 A hook that is run after reading the @file{.newsrc} file(s), but before
1539 generating the group buffer.
1541 @item gnus-check-bogus-newsgroups
1542 @vindex gnus-check-bogus-newsgroups
1543 If non-@code{nil}, gnus will check for and delete all bogus groups at
1544 startup. A @dfn{bogus group} is a group that you have in your
1545 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1546 bogus groups can take quite a while, so to save time and resources it's
1547 best to leave this option off, and do the checking for bogus groups once
1548 in a while from the group buffer instead (@pxref{Group Maintenance}).
1550 @item gnus-inhibit-startup-message
1551 @vindex gnus-inhibit-startup-message
1552 If non-@code{nil}, the startup message won't be displayed. That way,
1553 your boss might not notice as easily that you are reading news instead
1554 of doing your job. Note that this variable is used before
1555 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1557 @item gnus-no-groups-message
1558 @vindex gnus-no-groups-message
1559 Message displayed by gnus when no groups are available.
1561 @item gnus-play-startup-jingle
1562 @vindex gnus-play-startup-jingle
1563 If non-@code{nil}, play the gnus jingle at startup.
1565 @item gnus-startup-jingle
1566 @vindex gnus-startup-jingle
1567 Jingle to be played if the above variable is non-@code{nil}. The
1568 default is @samp{Tuxedomoon.Jingle4.au}.
1574 @chapter Group Buffer
1575 @cindex group buffer
1577 The @dfn{group buffer} lists all (or parts) of the available groups. It
1578 is the first buffer shown when gnus starts, and will never be killed as
1579 long as gnus is active.
1583 \gnusfigure{The Group Buffer}{320}{
1584 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1585 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1586 \put(120,38){\vector(1,2){10}}
1587 \put(40,60){\makebox(0,0)[r]{Mode line}}
1588 \put(40,58){\vector(1,0){30}}
1589 \put(200,28){\makebox(0,0)[t]{Native select method}}
1590 \put(200,26){\vector(-1,2){15}}
1596 * Group Buffer Format:: Information listed and how you can change it.
1597 * Group Maneuvering:: Commands for moving in the group buffer.
1598 * Selecting a Group:: Actually reading news.
1599 * Group Data:: Changing the info for a group.
1600 * Subscription Commands:: Unsubscribing, killing, subscribing.
1601 * Group Levels:: Levels? What are those, then?
1602 * Group Score:: A mechanism for finding out what groups you like.
1603 * Marking Groups:: You can mark groups for later processing.
1604 * Foreign Groups:: Creating and editing groups.
1605 * Group Parameters:: Each group may have different parameters set.
1606 * Listing Groups:: Gnus can list various subsets of the groups.
1607 * Sorting Groups:: Re-arrange the group order.
1608 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1609 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1610 * Exiting Gnus:: Stop reading news and get some work done.
1611 * Group Topics:: A folding group mode divided into topics.
1612 * Misc Group Stuff:: Other stuff that you can to do.
1616 @node Group Buffer Format
1617 @section Group Buffer Format
1620 * Group Line Specification:: Deciding how the group buffer is to look.
1621 * Group Modeline Specification:: The group buffer modeline.
1622 * Group Highlighting:: Having nice colors in the group buffer.
1626 @node Group Line Specification
1627 @subsection Group Line Specification
1628 @cindex group buffer format
1630 The default format of the group buffer is nice and dull, but you can
1631 make it as exciting and ugly as you feel like.
1633 Here's a couple of example group lines:
1636 25: news.announce.newusers
1637 * 0: alt.fan.andrea-dworkin
1642 You can see that there are 25 unread articles in
1643 @samp{news.announce.newusers}. There are no unread articles, but some
1644 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1645 asterisk at the beginning of the line?).
1647 @vindex gnus-group-line-format
1648 You can change that format to whatever you want by fiddling with the
1649 @code{gnus-group-line-format} variable. This variable works along the
1650 lines of a @code{format} specification, which is pretty much the same as
1651 a @code{printf} specifications, for those of you who use (feh!) C.
1652 @xref{Formatting Variables}.
1654 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1656 There should always be a colon on the line; the cursor always moves to
1657 the colon after performing an operation. Nothing else is required---not
1658 even the group name. All displayed text is just window dressing, and is
1659 never examined by gnus. Gnus stores all real information it needs using
1662 (Note that if you make a really strange, wonderful, spreadsheet-like
1663 layout, everybody will believe you are hard at work with the accounting
1664 instead of wasting time reading news.)
1666 Here's a list of all available format characters:
1671 An asterisk if the group only has marked articles.
1674 Whether the group is subscribed.
1677 Level of subscribedness.
1680 Number of unread articles.
1683 Number of dormant articles.
1686 Number of ticked articles.
1689 Number of read articles.
1692 Estimated total number of articles. (This is really @var{max-number}
1693 minus @var{min-number} plus 1.)
1695 Gnus uses this estimation because the NNTP protocol provides efficient
1696 access to @var{max-number} and @var{min-number} but getting the true
1697 unread message count is not possible efficiently. For hysterical
1698 raisins, even the mail backends, where the true number of unread
1699 messages might be available efficiently, use the same limited
1700 interface. To remove this restriction from Gnus means that the
1701 backend interface has to be changed, which is not an easy job. If you
1702 want to work on this, please contact the Gnus mailing list.
1705 Number of unread, unticked, non-dormant articles.
1708 Number of ticked and dormant articles.
1717 Newsgroup description.
1720 @samp{m} if moderated.
1723 @samp{(m)} if moderated.
1732 A string that looks like @samp{<%s:%n>} if a foreign select method is
1736 Indentation based on the level of the topic (@pxref{Group Topics}).
1739 @vindex gnus-group-uncollapsed-levels
1740 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1741 variable says how many levels to leave at the end of the group name.
1742 The default is 1---this will mean that group names like
1743 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1746 @vindex gnus-new-mail-mark
1748 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1752 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1755 A string that says when you last read the group (@pxref{Group
1759 User defined specifier. The next character in the format string should
1760 be a letter. Gnus will call the function
1761 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1762 following @samp{%u}. The function will be passed a single dummy
1763 parameter as argument. The function should return a string, which will
1764 be inserted into the buffer just like information from any other
1769 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1770 if no info is available---for instance, if it is a non-activated foreign
1771 group, or a bogus native group.
1774 @node Group Modeline Specification
1775 @subsection Group Modeline Specification
1776 @cindex group modeline
1778 @vindex gnus-group-mode-line-format
1779 The mode line can be changed by setting
1780 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1781 doesn't understand that many format specifiers:
1785 The native news server.
1787 The native select method.
1791 @node Group Highlighting
1792 @subsection Group Highlighting
1793 @cindex highlighting
1794 @cindex group highlighting
1796 @vindex gnus-group-highlight
1797 Highlighting in the group buffer is controlled by the
1798 @code{gnus-group-highlight} variable. This is an alist with elements
1799 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1800 something non-@code{nil}, the @var{face} will be used on the line.
1802 Here's an example value for this variable that might look nice if the
1806 (cond (window-system
1807 (setq custom-background-mode 'light)
1808 (defface my-group-face-1
1809 '((t (:foreground "Red" :bold t))) "First group face")
1810 (defface my-group-face-2
1811 '((t (:foreground "DarkSeaGreen4" :bold t))) "Second group face")
1812 (defface my-group-face-3
1813 '((t (:foreground "Green4" :bold t))) "Third group face")
1814 (defface my-group-face-4
1815 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1816 (defface my-group-face-5
1817 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1819 (setq gnus-group-highlight
1820 '(((> unread 200) . my-group-face-1)
1821 ((and (< level 3) (zerop unread)) . my-group-face-2)
1822 ((< level 3) . my-group-face-3)
1823 ((zerop unread) . my-group-face-4)
1824 (t . my-group-face-5)))
1827 Also @pxref{Faces and Fonts}.
1829 Variables that are dynamically bound when the forms are evaluated
1836 The number of unread articles in the group.
1840 Whether the group is a mail group.
1842 The level of the group.
1844 The score of the group.
1846 The number of ticked articles in the group.
1848 The total number of articles in the group. Or rather, MAX-NUMBER minus
1849 MIN-NUMBER plus one.
1851 When using the topic minor mode, this variable is bound to the current
1852 topic being inserted.
1855 When the forms are @code{eval}ed, point is at the beginning of the line
1856 of the group in question, so you can use many of the normal gnus
1857 functions for snarfing info on the group.
1859 @vindex gnus-group-update-hook
1860 @findex gnus-group-highlight-line
1861 @code{gnus-group-update-hook} is called when a group line is changed.
1862 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1863 calls @code{gnus-group-highlight-line} by default.
1866 @node Group Maneuvering
1867 @section Group Maneuvering
1868 @cindex group movement
1870 All movement commands understand the numeric prefix and will behave as
1871 expected, hopefully.
1877 @findex gnus-group-next-unread-group
1878 Go to the next group that has unread articles
1879 (@code{gnus-group-next-unread-group}).
1885 @findex gnus-group-prev-unread-group
1886 Go to the previous group that has unread articles
1887 (@code{gnus-group-prev-unread-group}).
1891 @findex gnus-group-next-group
1892 Go to the next group (@code{gnus-group-next-group}).
1896 @findex gnus-group-prev-group
1897 Go to the previous group (@code{gnus-group-prev-group}).
1901 @findex gnus-group-next-unread-group-same-level
1902 Go to the next unread group on the same (or lower) level
1903 (@code{gnus-group-next-unread-group-same-level}).
1907 @findex gnus-group-prev-unread-group-same-level
1908 Go to the previous unread group on the same (or lower) level
1909 (@code{gnus-group-prev-unread-group-same-level}).
1912 Three commands for jumping to groups:
1918 @findex gnus-group-jump-to-group
1919 Jump to a group (and make it visible if it isn't already)
1920 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
1925 @findex gnus-group-best-unread-group
1926 Jump to the unread group with the lowest level
1927 (@code{gnus-group-best-unread-group}).
1931 @findex gnus-group-first-unread-group
1932 Jump to the first group with unread articles
1933 (@code{gnus-group-first-unread-group}).
1936 @vindex gnus-group-goto-unread
1937 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1938 commands will move to the next group, not the next unread group. Even
1939 the commands that say they move to the next unread group. The default
1943 @node Selecting a Group
1944 @section Selecting a Group
1945 @cindex group selection
1950 @kindex SPACE (Group)
1951 @findex gnus-group-read-group
1952 Select the current group, switch to the summary buffer and display the
1953 first unread article (@code{gnus-group-read-group}). If there are no
1954 unread articles in the group, or if you give a non-numerical prefix to
1955 this command, gnus will offer to fetch all the old articles in this
1956 group from the server. If you give a numerical prefix @var{N}, @var{N}
1957 determines the number of articles gnus will fetch. If @var{N} is
1958 positive, gnus fetches the @var{N} newest articles, if @var{N} is
1959 negative, Gnus fetches the @code{abs(@var{N})} oldest articles.
1961 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
1962 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
1963 - 4 2 SPC} fetches the 42 oldest ones.
1965 When you are in the group (in the Summary buffer), you can type
1966 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
1971 @findex gnus-group-select-group
1972 Select the current group and switch to the summary buffer
1973 (@code{gnus-group-select-group}). Takes the same arguments as
1974 @code{gnus-group-read-group}---the only difference is that this command
1975 does not display the first unread article automatically upon group
1979 @kindex M-RET (Group)
1980 @findex gnus-group-quick-select-group
1981 This does the same as the command above, but tries to do it with the
1982 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
1983 scoring/killing will be performed, there will be no highlights and no
1984 expunging. This might be useful if you're in a real hurry and have to
1985 enter some humongous group. If you give a 0 prefix to this command
1986 (i.e., @kbd{0 M-RET}), gnus won't even generate the summary buffer,
1987 which is useful if you want to toggle threading before generating the
1988 summary buffer (@pxref{Summary Generation Commands}).
1991 @kindex M-SPACE (Group)
1992 @findex gnus-group-visible-select-group
1993 This is yet one more command that does the same as the @kbd{RET}
1994 command, but this one does it without expunging and hiding dormants
1995 (@code{gnus-group-visible-select-group}).
1998 @kindex M-C-RET (Group)
1999 @findex gnus-group-select-group-ephemerally
2000 Finally, this command selects the current group ephemerally without
2001 doing any processing of its contents
2002 (@code{gnus-group-select-group-ephemerally}). Even threading has been
2003 turned off. Everything you do in the group after selecting it in this
2004 manner will have no permanent effects.
2008 @vindex gnus-large-newsgroup
2009 The @code{gnus-large-newsgroup} variable says what gnus should consider
2010 to be a big group. This is 200 by default. If the group has more
2011 (unread and/or ticked) articles than this, gnus will query the user
2012 before entering the group. The user can then specify how many articles
2013 should be fetched from the server. If the user specifies a negative
2014 number (@code{-n}), the @code{n} oldest articles will be fetched. If it
2015 is positive, the @code{n} articles that have arrived most recently will
2018 @vindex gnus-select-group-hook
2019 @vindex gnus-auto-select-first
2020 @code{gnus-auto-select-first} control whether any articles are selected
2021 automatically when entering a group with the @kbd{SPACE} command.
2026 Don't select any articles when entering the group. Just display the
2027 full summary buffer.
2030 Select the first unread article when entering the group.
2033 Select the highest scored article in the group when entering the
2038 This variable can also be a function. In that case, that function will
2039 be called to place point on a subject line, and/or select some article.
2040 Useful functions include:
2043 @item gnus-summary-first-unread-subject
2044 Place point on the subject line of the first unread article, but
2045 don't select the article.
2047 @item gnus-summary-first-unread-article
2048 Select the first unread article.
2050 @item gnus-summary-best-unread-article
2051 Select the highest-scored unread article.
2055 If you want to prevent automatic selection in some group (say, in a
2056 binary group with Huge articles) you can set this variable to @code{nil}
2057 in @code{gnus-select-group-hook}, which is called when a group is
2061 @node Subscription Commands
2062 @section Subscription Commands
2063 @cindex subscription
2071 @findex gnus-group-unsubscribe-current-group
2072 @c @icon{gnus-group-unsubscribe}
2073 Toggle subscription to the current group
2074 (@code{gnus-group-unsubscribe-current-group}).
2080 @findex gnus-group-unsubscribe-group
2081 Prompt for a group to subscribe, and then subscribe it. If it was
2082 subscribed already, unsubscribe it instead
2083 (@code{gnus-group-unsubscribe-group}).
2089 @findex gnus-group-kill-group
2090 @c @icon{gnus-group-kill-group}
2091 Kill the current group (@code{gnus-group-kill-group}).
2097 @findex gnus-group-yank-group
2098 Yank the last killed group (@code{gnus-group-yank-group}).
2101 @kindex C-x C-t (Group)
2102 @findex gnus-group-transpose-groups
2103 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2104 really a subscription command, but you can use it instead of a
2105 kill-and-yank sequence sometimes.
2111 @findex gnus-group-kill-region
2112 Kill all groups in the region (@code{gnus-group-kill-region}).
2116 @findex gnus-group-kill-all-zombies
2117 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2120 @kindex S C-k (Group)
2121 @findex gnus-group-kill-level
2122 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2123 These groups can't be yanked back after killing, so this command should
2124 be used with some caution. The only time where this command comes in
2125 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2126 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2127 kill off all unsubscribed groups that do not have message numbers in the
2128 @file{.newsrc} file.
2132 Also @pxref{Group Levels}.
2142 @findex gnus-group-catchup-current
2143 @vindex gnus-group-catchup-group-hook
2144 @c @icon{gnus-group-catchup-current}
2145 Mark all unticked articles in this group as read
2146 (@code{gnus-group-catchup-current}).
2147 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2152 @findex gnus-group-catchup-current-all
2153 Mark all articles in this group, even the ticked ones, as read
2154 (@code{gnus-group-catchup-current-all}).
2158 @findex gnus-group-clear-data
2159 Clear the data from the current group---nix out marks and the list of
2160 read articles (@code{gnus-group-clear-data}).
2162 @item M-x gnus-group-clear-data-on-native-groups
2163 @kindex M-x gnus-group-clear-data-on-native-groups
2164 @findex gnus-group-clear-data-on-native-groups
2165 If you have switched from one @sc{nntp} server to another, all your marks
2166 and read ranges have become worthless. You can use this command to
2167 clear out all data that you have on your native groups. Use with
2174 @section Group Levels
2178 All groups have a level of @dfn{subscribedness}. For instance, if a
2179 group is on level 2, it is more subscribed than a group on level 5. You
2180 can ask gnus to just list groups on a given level or lower
2181 (@pxref{Listing Groups}), or to just check for new articles in groups on
2182 a given level or lower (@pxref{Scanning New Messages}).
2184 Remember: The higher the level of the group, the less important it is.
2190 @findex gnus-group-set-current-level
2191 Set the level of the current group. If a numeric prefix is given, the
2192 next @var{n} groups will have their levels set. The user will be
2193 prompted for a level.
2196 @vindex gnus-level-killed
2197 @vindex gnus-level-zombie
2198 @vindex gnus-level-unsubscribed
2199 @vindex gnus-level-subscribed
2200 Gnus considers groups from levels 1 to
2201 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2202 @code{gnus-level-subscribed} (exclusive) and
2203 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2204 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2205 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2206 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2207 same, but zombie and killed groups have no information on what articles
2208 you have read, etc, stored. This distinction between dead and living
2209 groups isn't done because it is nice or clever, it is done purely for
2210 reasons of efficiency.
2212 It is recommended that you keep all your mail groups (if any) on quite
2213 low levels (e.g. 1 or 2).
2215 Maybe the following description of the default behavior of Gnus helps to
2216 understand what these levels are all about. By default, Gnus shows you
2217 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2218 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2219 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2220 groups are hidden, in a way.
2222 Zombie and killed groups are similar to unsubscribed groups in that they
2223 are hidden by default. But they are different from subscribed and
2224 unsubscribed groups in that Gnus doesn't ask the news server for
2225 information (number of messages, number of unread messages) on zombie
2226 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2227 aren't interested in. If most groups are killed, Gnus is faster.
2229 Why does Gnus distinguish between zombie and killed groups? Well, when
2230 a new group arrives on the server, Gnus by default makes it a zombie
2231 group. This means that you are normally not bothered with new groups,
2232 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2233 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2234 list of killed groups.)
2236 If you want to play with the level variables, you should show some care.
2237 Set them once, and don't touch them ever again. Better yet, don't touch
2238 them at all unless you know exactly what you're doing.
2240 @vindex gnus-level-default-unsubscribed
2241 @vindex gnus-level-default-subscribed
2242 Two closely related variables are @code{gnus-level-default-subscribed}
2243 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2244 which are the levels that new groups will be put on if they are
2245 (un)subscribed. These two variables should, of course, be inside the
2246 relevant valid ranges.
2248 @vindex gnus-keep-same-level
2249 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2250 will only move to groups of the same level (or lower). In
2251 particular, going from the last article in one group to the next group
2252 will go to the next group of the same level (or lower). This might be
2253 handy if you want to read the most important groups before you read the
2256 If this variable is @code{best}, Gnus will make the next newsgroup the
2257 one with the best level.
2259 @vindex gnus-group-default-list-level
2260 All groups with a level less than or equal to
2261 @code{gnus-group-default-list-level} will be listed in the group buffer
2264 @vindex gnus-group-list-inactive-groups
2265 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2266 groups will be listed along with the unread groups. This variable is
2267 @code{t} by default. If it is @code{nil}, inactive groups won't be
2270 @vindex gnus-group-use-permanent-levels
2271 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2272 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2273 use this level as the ``work'' level.
2275 @vindex gnus-activate-level
2276 Gnus will normally just activate (i. e., query the server about) groups
2277 on level @code{gnus-activate-level} or less. If you don't want to
2278 activate unsubscribed groups, for instance, you might set this variable
2279 to 5. The default is 6.
2283 @section Group Score
2288 You would normally keep important groups on high levels, but that scheme
2289 is somewhat restrictive. Don't you wish you could have Gnus sort the
2290 group buffer according to how often you read groups, perhaps? Within
2293 This is what @dfn{group score} is for. You can have Gnus assign a score
2294 to each group through the mechanism described below. You can then sort
2295 the group buffer based on this score. Alternatively, you can sort on
2296 score and then level. (Taken together, the level and the score is
2297 called the @dfn{rank} of the group. A group that is on level 4 and has
2298 a score of 1 has a higher rank than a group on level 5 that has a score
2299 of 300. (The level is the most significant part and the score is the
2300 least significant part.))
2302 @findex gnus-summary-bubble-group
2303 If you want groups you read often to get higher scores than groups you
2304 read seldom you can add the @code{gnus-summary-bubble-group} function to
2305 the @code{gnus-summary-exit-hook} hook. This will result (after
2306 sorting) in a bubbling sort of action. If you want to see that in
2307 action after each summary exit, you can add
2308 @code{gnus-group-sort-groups-by-rank} or
2309 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2310 slow things down somewhat.
2313 @node Marking Groups
2314 @section Marking Groups
2315 @cindex marking groups
2317 If you want to perform some command on several groups, and they appear
2318 subsequently in the group buffer, you would normally just give a
2319 numerical prefix to the command. Most group commands will then do your
2320 bidding on those groups.
2322 However, if the groups are not in sequential order, you can still
2323 perform a command on several groups. You simply mark the groups first
2324 with the process mark and then execute the command.
2332 @findex gnus-group-mark-group
2333 Set the mark on the current group (@code{gnus-group-mark-group}).
2339 @findex gnus-group-unmark-group
2340 Remove the mark from the current group
2341 (@code{gnus-group-unmark-group}).
2345 @findex gnus-group-unmark-all-groups
2346 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2350 @findex gnus-group-mark-region
2351 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2355 @findex gnus-group-mark-buffer
2356 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2360 @findex gnus-group-mark-regexp
2361 Mark all groups that match some regular expression
2362 (@code{gnus-group-mark-regexp}).
2365 Also @pxref{Process/Prefix}.
2367 @findex gnus-group-universal-argument
2368 If you want to execute some command on all groups that have been marked
2369 with the process mark, you can use the @kbd{M-&}
2370 (@code{gnus-group-universal-argument}) command. It will prompt you for
2371 the command to be executed.
2374 @node Foreign Groups
2375 @section Foreign Groups
2376 @cindex foreign groups
2378 Below are some group mode commands for making and editing general foreign
2379 groups, as well as commands to ease the creation of a few
2380 special-purpose groups. All these commands insert the newly created
2381 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2388 @findex gnus-group-make-group
2389 @cindex making groups
2390 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2391 for a name, a method and possibly an @dfn{address}. For an easier way
2392 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
2396 @findex gnus-group-rename-group
2397 @cindex renaming groups
2398 Rename the current group to something else
2399 (@code{gnus-group-rename-group}). This is valid only on some
2400 groups---mail groups mostly. This command might very well be quite slow
2406 @findex gnus-group-customize
2407 Customize the group parameters (@code{gnus-group-customize}).
2411 @findex gnus-group-edit-group-method
2412 @cindex renaming groups
2413 Enter a buffer where you can edit the select method of the current
2414 group (@code{gnus-group-edit-group-method}).
2418 @findex gnus-group-edit-group-parameters
2419 Enter a buffer where you can edit the group parameters
2420 (@code{gnus-group-edit-group-parameters}).
2424 @findex gnus-group-edit-group
2425 Enter a buffer where you can edit the group info
2426 (@code{gnus-group-edit-group}).
2430 @findex gnus-group-make-directory-group
2432 Make a directory group (@pxref{Directory Groups}). You will be prompted
2433 for a directory name (@code{gnus-group-make-directory-group}).
2438 @findex gnus-group-make-help-group
2439 Make the gnus help group (@code{gnus-group-make-help-group}).
2443 @cindex (ding) archive
2444 @cindex archive group
2445 @findex gnus-group-make-archive-group
2446 @vindex gnus-group-archive-directory
2447 @vindex gnus-group-recent-archive-directory
2448 Make a gnus archive group (@code{gnus-group-make-archive-group}). By
2449 default a group pointing to the most recent articles will be created
2450 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2451 group will be created from @code{gnus-group-archive-directory}.
2455 @findex gnus-group-make-kiboze-group
2457 Make a kiboze group. You will be prompted for a name, for a regexp to
2458 match groups to be ``included'' in the kiboze group, and a series of
2459 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2460 @xref{Kibozed Groups}.
2464 @findex gnus-group-enter-directory
2466 Read an arbitrary directory as if it were a newsgroup with the
2467 @code{nneething} backend (@code{gnus-group-enter-directory}).
2468 @xref{Anything Groups}.
2472 @findex gnus-group-make-doc-group
2473 @cindex ClariNet Briefs
2475 Make a group based on some file or other
2476 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2477 command, you will be prompted for a file name and a file type.
2478 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
2479 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
2480 @code{rfc934}, @code{rfc822-forward}, @code{nsmail} and @code{forward}.
2481 If you run this command without a prefix, Gnus will guess at the file
2482 type. @xref{Document Groups}.
2486 @vindex gnus-useful-groups
2487 @findex gnus-group-make-useful-group
2488 Create one of the groups mentioned in @code{gnus-useful-groups}
2489 (@code{gnus-group-make-useful-group}).
2493 @findex gnus-group-make-web-group
2498 Make an ephemeral group based on a web search
2499 (@code{gnus-group-make-web-group}). If you give a prefix to this
2500 command, make a solid group instead. You will be prompted for the
2501 search engine type and the search string. Valid search engine types
2502 include @code{dejanews}, @code{altavista} and @code{reference}.
2503 @xref{Web Searches}.
2505 If you use the @code{dejanews} search engine, you can limit the search
2506 to a particular group by using a match string like
2507 @samp{~g alt.sysadmin.recovery shaving}.
2510 @kindex G DEL (Group)
2511 @findex gnus-group-delete-group
2512 This function will delete the current group
2513 (@code{gnus-group-delete-group}). If given a prefix, this function will
2514 actually delete all the articles in the group, and forcibly remove the
2515 group itself from the face of the Earth. Use a prefix only if you are
2516 absolutely sure of what you are doing. This command can't be used on
2517 read-only groups (like @code{nntp} group), though.
2521 @findex gnus-group-make-empty-virtual
2522 Make a new, fresh, empty @code{nnvirtual} group
2523 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2527 @findex gnus-group-add-to-virtual
2528 Add the current group to an @code{nnvirtual} group
2529 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2532 @xref{Select Methods}, for more information on the various select
2535 @vindex gnus-activate-foreign-newsgroups
2536 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2537 gnus will check all foreign groups with this level or lower at startup.
2538 This might take quite a while, especially if you subscribe to lots of
2539 groups from different @sc{nntp} servers. Also @pxref{Group Levels};
2540 @code{gnus-activate-level} also affects activation of foreign
2544 @node Group Parameters
2545 @section Group Parameters
2546 @cindex group parameters
2548 The group parameters store information local to a particular group.
2549 Here's an example group parameter list:
2552 ((to-address . "ding@@gnus.org")
2556 We see that each element consists of a "dotted pair"---the thing before
2557 the dot is the key, while the thing after the dot is the value. All the
2558 parameters have this form @emph{except} local variable specs, which are
2559 not dotted pairs, but proper lists.
2561 Some parameters have correspondant customizable variables, each of which
2562 is an alist of regexps and values.
2564 The following group parameters can be used:
2569 Address used by when doing followups and new posts.
2572 (to-address . "some@@where.com")
2575 This is primarily useful in mail groups that represent closed mailing
2576 lists---mailing lists where it's expected that everybody that writes to
2577 the mailing list is subscribed to it. Since using this parameter
2578 ensures that the mail only goes to the mailing list itself, it means
2579 that members won't receive two copies of your followups.
2581 Using @code{to-address} will actually work whether the group is foreign
2582 or not. Let's say there's a group on the server that is called
2583 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2584 the articles from a mail-to-news gateway. Posting directly to this
2585 group is therefore impossible---you have to send mail to the mailing
2586 list address instead.
2588 See also @code{gnus-parameter-to-address-alist}.
2592 Address used when doing @kbd{a} in that group.
2595 (to-list . "some@@where.com")
2598 It is totally ignored
2599 when doing a followup---except that if it is present in a news group,
2600 you'll get mail group semantics when doing @kbd{f}.
2602 If you do an @kbd{a} command in a mail group and you have neither a
2603 @code{to-list} group parameter nor a @code{to-address} group parameter,
2604 then a @code{to-list} group parameter will be added automatically upon
2605 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2606 @vindex gnus-add-to-list
2608 If you do an @kbd{a} command in a mail group and you don't have a
2609 @code{to-list} group parameter, one will be added automatically upon
2610 sending the message.
2612 See also @code{gnus-parameter-to-list-alist}.
2616 If the group parameter list has the element @code{(visible . t)},
2617 that group will always be visible in the Group buffer, regardless
2618 of whether it has any unread articles.
2620 @item broken-reply-to
2621 @cindex broken-reply-to
2622 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2623 headers in this group are to be ignored. This can be useful if you're
2624 reading a mailing list group where the listserv has inserted
2625 @code{Reply-To} headers that point back to the listserv itself. This is
2626 broken behavior. So there!
2630 Elements like @code{(to-group . "some.group.name")} means that all
2631 posts in that group will be sent to @code{some.group.name}.
2635 If you have @code{(newsgroup . t)} in the group parameter list, gnus
2636 will treat all responses as if they were responses to news articles.
2637 This can be useful if you have a mail group that's really a mirror of a
2642 If @code{(gcc-self . t)} is present in the group parameter list, newly
2643 composed messages will be @code{Gcc}'d to the current group. If
2644 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2645 generated, if @code{(gcc-self . "string")} is present, this string will
2646 be inserted literally as a @code{gcc} header. This parameter takes
2647 precedence over any default @code{Gcc} rules as described later
2648 (@pxref{Archived Messages}).
2652 If the group parameter has an element that looks like @code{(auto-expire
2653 . t)}, all articles read will be marked as expirable. For an
2654 alternative approach, @pxref{Expiring Mail}.
2656 See also @code{gnus-auto-expirable-newsgroups}.
2659 @cindex total-expire
2660 If the group parameter has an element that looks like
2661 @code{(total-expire . t)}, all read articles will be put through the
2662 expiry process, even if they are not marked as expirable. Use with
2663 caution. Unread, ticked and dormant articles are not eligible for
2666 See also @code{gnus-total-expirable-newsgroups}.
2670 @vindex nnmail-expiry-wait-function
2671 If the group parameter has an element that looks like @code{(expiry-wait
2672 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2673 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2674 The value can either be a number of days (not necessarily an integer) or
2675 the symbols @code{never} or @code{immediate}.
2678 @cindex score file group parameter
2679 Elements that look like @code{(score-file . "file")} will make
2680 @file{file} into the current score file for the group in question. All
2681 interactive score entries will be put into this file.
2684 @cindex adapt file group parameter
2685 Elements that look like @code{(adapt-file . "file")} will make
2686 @file{file} into the current adaptive file for the group in question.
2687 All adaptive score entries will be put into this file.
2690 When unsubscribing from a mailing list you should never send the
2691 unsubscription notice to the mailing list itself. Instead, you'd send
2692 messages to the administrative address. This parameter allows you to
2693 put the admin address somewhere convenient.
2696 Elements that look like @code{(display . MODE)} say which articles to
2697 display on entering the group. Valid values are:
2701 Display all articles, both read and unread.
2704 Display the default visible articles, which normally includes unread and
2709 Elements that look like @code{(comment . "This is a comment")}
2710 are arbitrary comments on the group. They are currently ignored by
2711 gnus, but provide a place for you to store information on particular
2715 Elements that look like @code{(charset . iso-8859-1)} will make
2716 @code{iso-8859-1} the default charset; that is, the charset that will be
2717 used for all articles that do not specify a charset.
2719 See also @code{gnus-group-charset-alist}.
2721 @item ignored-charsets
2722 Elements that look like @code{(ignored-charsets x-known iso-8859-1)}
2723 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2724 default charset will be used for decoding articles.
2726 See also @code{gnus-group-ignored-charsets-alist}.
2729 You can store additional posting style information for this group only
2730 here (@pxref{Posting Styles}). The format is that of an entry in the
2731 @code{gnus-posting-styles} alist, except that there's no regexp matching
2732 the group name (of course). Style elements in this group parameter will
2733 take precedence over the ones found in @code{gnus-posting-styles}.
2735 For instance, if you want a funky name and signature in this group only,
2736 instead of hacking @code{gnus-posting-styles}, you could put something
2737 like this in the group parameters:
2742 (signature "Funky Signature"))
2746 An item like @code{(banner . "regex")} causes any part of an article
2747 that matches the regular expression "regex" to be stripped. Instead of
2748 "regex", you can also use the symbol @code{signature} which strips the
2749 last signature or any of the elements of the alist
2750 @code{gnus-article-banner-alist}.
2752 @item (@var{variable} @var{form})
2753 You can use the group parameters to set variables local to the group you
2754 are entering. If you want to turn threading off in @samp{news.answers},
2755 you could put @code{(gnus-show-threads nil)} in the group parameters of
2756 that group. @code{gnus-show-threads} will be made into a local variable
2757 in the summary buffer you enter, and the form @code{nil} will be
2758 @code{eval}ed there.
2760 This can also be used as a group-specific hook function, if you'd like.
2761 If you want to hear a beep when you enter a group, you could put
2762 something like @code{(dummy-variable (ding))} in the parameters of that
2763 group. @code{dummy-variable} will be set to the result of the
2764 @code{(ding)} form, but who cares?
2768 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
2769 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
2770 presents you with a Customize-like interface. The latter helps avoid
2771 silly Lisp errors.) You might also be interested in reading about topic
2772 parameters (@pxref{Topic Parameters}).
2775 @node Listing Groups
2776 @section Listing Groups
2777 @cindex group listing
2779 These commands all list various slices of the groups available.
2787 @findex gnus-group-list-groups
2788 List all groups that have unread articles
2789 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
2790 command will list only groups of level ARG and lower. By default, it
2791 only lists groups of level five (i. e.,
2792 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2799 @findex gnus-group-list-all-groups
2800 List all groups, whether they have unread articles or not
2801 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
2802 this command will list only groups of level ARG and lower. By default,
2803 it lists groups of level seven or lower (i.e., just subscribed and
2804 unsubscribed groups).
2808 @findex gnus-group-list-level
2809 List all unread groups on a specific level
2810 (@code{gnus-group-list-level}). If given a prefix, also list the groups
2811 with no unread articles.
2815 @findex gnus-group-list-killed
2816 List all killed groups (@code{gnus-group-list-killed}). If given a
2817 prefix argument, really list all groups that are available, but aren't
2818 currently (un)subscribed. This could entail reading the active file
2823 @findex gnus-group-list-zombies
2824 List all zombie groups (@code{gnus-group-list-zombies}).
2828 @findex gnus-group-list-matching
2829 List all unread, subscribed groups with names that match a regexp
2830 (@code{gnus-group-list-matching}).
2834 @findex gnus-group-list-all-matching
2835 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2839 @findex gnus-group-list-active
2840 List absolutely all groups in the active file(s) of the
2841 server(s) you are connected to (@code{gnus-group-list-active}). This
2842 might very well take quite a while. It might actually be a better idea
2843 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2844 thing to match on. Also note that this command may list groups that
2845 don't exist (yet)---these will be listed as if they were killed groups.
2846 Take the output with some grains of salt.
2850 @findex gnus-group-apropos
2851 List all groups that have names that match a regexp
2852 (@code{gnus-group-apropos}).
2856 @findex gnus-group-description-apropos
2857 List all groups that have names or descriptions that match a regexp
2858 (@code{gnus-group-description-apropos}).
2862 @findex gnus-group-list-cached
2863 List all groups with cached articles (@code{gnus-group-list-cached}).
2867 @findex gnus-group-list-dormant
2868 List all groups with dormant articles (@code{gnus-group-list-dormant}).
2872 @findex gnus-group-list-limit
2873 List groups limited within the current selection
2874 (@code{gnus-group-list-limit}).
2878 @findex gnus-group-list-flush
2879 Flush groups from the current selection (@code{gnus-group-list-flush}).
2883 @findex gnus-group-list-plus
2884 List groups plus the current selection (@code{gnus-group-list-plus}).
2888 @vindex gnus-permanently-visible-groups
2889 @cindex visible group parameter
2890 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2891 always be shown, whether they have unread articles or not. You can also
2892 add the @code{visible} element to the group parameters in question to
2893 get the same effect.
2895 @vindex gnus-list-groups-with-ticked-articles
2896 Groups that have just ticked articles in it are normally listed in the
2897 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
2898 @code{nil}, these groups will be treated just like totally empty
2899 groups. It is @code{t} by default.
2902 @node Sorting Groups
2903 @section Sorting Groups
2904 @cindex sorting groups
2906 @kindex C-c C-s (Group)
2907 @findex gnus-group-sort-groups
2908 @vindex gnus-group-sort-function
2909 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2910 group buffer according to the function(s) given by the
2911 @code{gnus-group-sort-function} variable. Available sorting functions
2916 @item gnus-group-sort-by-alphabet
2917 @findex gnus-group-sort-by-alphabet
2918 Sort the group names alphabetically. This is the default.
2920 @item gnus-group-sort-by-real-name
2921 @findex gnus-group-sort-by-real-name
2922 Sort the group alphabetically on the real (unprefixed) group names.
2924 @item gnus-group-sort-by-level
2925 @findex gnus-group-sort-by-level
2926 Sort by group level.
2928 @item gnus-group-sort-by-score
2929 @findex gnus-group-sort-by-score
2930 Sort by group score. @xref{Group Score}.
2932 @item gnus-group-sort-by-rank
2933 @findex gnus-group-sort-by-rank
2934 Sort by group score and then the group level. The level and the score
2935 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
2937 @item gnus-group-sort-by-unread
2938 @findex gnus-group-sort-by-unread
2939 Sort by number of unread articles.
2941 @item gnus-group-sort-by-method
2942 @findex gnus-group-sort-by-method
2943 Sort alphabetically on the select method.
2945 @item gnus-group-sort-by-server
2946 @findex gnus-group-sort-by-server
2947 Sort alphabetically on the Gnus server name.
2952 @code{gnus-group-sort-function} can also be a list of sorting
2953 functions. In that case, the most significant sort key function must be
2957 There are also a number of commands for sorting directly according to
2958 some sorting criteria:
2962 @kindex G S a (Group)
2963 @findex gnus-group-sort-groups-by-alphabet
2964 Sort the group buffer alphabetically by group name
2965 (@code{gnus-group-sort-groups-by-alphabet}).
2968 @kindex G S u (Group)
2969 @findex gnus-group-sort-groups-by-unread
2970 Sort the group buffer by the number of unread articles
2971 (@code{gnus-group-sort-groups-by-unread}).
2974 @kindex G S l (Group)
2975 @findex gnus-group-sort-groups-by-level
2976 Sort the group buffer by group level
2977 (@code{gnus-group-sort-groups-by-level}).
2980 @kindex G S v (Group)
2981 @findex gnus-group-sort-groups-by-score
2982 Sort the group buffer by group score
2983 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
2986 @kindex G S r (Group)
2987 @findex gnus-group-sort-groups-by-rank
2988 Sort the group buffer by group rank
2989 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
2992 @kindex G S m (Group)
2993 @findex gnus-group-sort-groups-by-method
2994 Sort the group buffer alphabetically by backend name
2995 (@code{gnus-group-sort-groups-by-method}).
2999 All the commands below obey the process/prefix convention
3000 (@pxref{Process/Prefix}).
3002 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3003 commands will sort in reverse order.
3005 You can also sort a subset of the groups:
3009 @kindex G P a (Group)
3010 @findex gnus-group-sort-selected-groups-by-alphabet
3011 Sort the groups alphabetically by group name
3012 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3015 @kindex G P u (Group)
3016 @findex gnus-group-sort-selected-groups-by-unread
3017 Sort the groups by the number of unread articles
3018 (@code{gnus-group-sort-selected-groups-by-unread}).
3021 @kindex G P l (Group)
3022 @findex gnus-group-sort-selected-groups-by-level
3023 Sort the groups by group level
3024 (@code{gnus-group-sort-selected-groups-by-level}).
3027 @kindex G P v (Group)
3028 @findex gnus-group-sort-selected-groups-by-score
3029 Sort the groups by group score
3030 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3033 @kindex G P r (Group)
3034 @findex gnus-group-sort-selected-groups-by-rank
3035 Sort the groups by group rank
3036 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3039 @kindex G P m (Group)
3040 @findex gnus-group-sort-selected-groups-by-method
3041 Sort the groups alphabetically by backend name
3042 (@code{gnus-group-sort-selected-groups-by-method}).
3046 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3050 @node Group Maintenance
3051 @section Group Maintenance
3052 @cindex bogus groups
3057 @findex gnus-group-check-bogus-groups
3058 Find bogus groups and delete them
3059 (@code{gnus-group-check-bogus-groups}).
3063 @findex gnus-group-find-new-groups
3064 Find new groups and process them (@code{gnus-group-find-new-groups}).
3065 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3066 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3067 to query the server for new groups, and subscribe the new groups as
3071 @kindex C-c C-x (Group)
3072 @findex gnus-group-expire-articles
3073 Run all expirable articles in the current group through the expiry
3074 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3075 all expirable articles in the group that have been around for a while.
3076 (@pxref{Expiring Mail}).
3079 @kindex C-c M-C-x (Group)
3080 @findex gnus-group-expire-all-groups
3081 Run all expirable articles in all groups through the expiry process
3082 (@code{gnus-group-expire-all-groups}).
3087 @node Browse Foreign Server
3088 @section Browse Foreign Server
3089 @cindex foreign servers
3090 @cindex browsing servers
3095 @findex gnus-group-browse-foreign-server
3096 You will be queried for a select method and a server name. Gnus will
3097 then attempt to contact this server and let you browse the groups there
3098 (@code{gnus-group-browse-foreign-server}).
3101 @findex gnus-browse-mode
3102 A new buffer with a list of available groups will appear. This buffer
3103 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3104 a lot) like a normal group buffer.
3106 Here's a list of keystrokes available in the browse mode:
3111 @findex gnus-group-next-group
3112 Go to the next group (@code{gnus-group-next-group}).
3116 @findex gnus-group-prev-group
3117 Go to the previous group (@code{gnus-group-prev-group}).
3120 @kindex SPACE (Browse)
3121 @findex gnus-browse-read-group
3122 Enter the current group and display the first article
3123 (@code{gnus-browse-read-group}).
3126 @kindex RET (Browse)
3127 @findex gnus-browse-select-group
3128 Enter the current group (@code{gnus-browse-select-group}).
3132 @findex gnus-browse-unsubscribe-current-group
3133 Unsubscribe to the current group, or, as will be the case here,
3134 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3140 @findex gnus-browse-exit
3141 Exit browse mode (@code{gnus-browse-exit}).
3145 @findex gnus-browse-describe-briefly
3146 Describe browse mode briefly (well, there's not much to describe, is
3147 there) (@code{gnus-browse-describe-briefly}).
3152 @section Exiting gnus
3153 @cindex exiting gnus
3155 Yes, gnus is ex(c)iting.
3160 @findex gnus-group-suspend
3161 Suspend gnus (@code{gnus-group-suspend}). This doesn't really exit gnus,
3162 but it kills all buffers except the Group buffer. I'm not sure why this
3163 is a gain, but then who am I to judge?
3167 @findex gnus-group-exit
3168 @c @icon{gnus-group-exit}
3169 Quit gnus (@code{gnus-group-exit}).
3173 @findex gnus-group-quit
3174 Quit gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3175 The dribble file will be saved, though (@pxref{Auto Save}).
3178 @vindex gnus-exit-gnus-hook
3179 @vindex gnus-suspend-gnus-hook
3180 @code{gnus-suspend-gnus-hook} is called when you suspend gnus and
3181 @code{gnus-exit-gnus-hook} is called when you quit gnus, while
3182 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3187 If you wish to completely unload gnus and all its adherents, you can use
3188 the @code{gnus-unload} command. This command is also very handy when
3189 trying to customize meta-variables.
3194 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3195 numbly heavy and herself fall into a hazy trance as the boy sitting
3196 behind her drew repeated lines with his pencil across the back of her
3202 @section Group Topics
3205 If you read lots and lots of groups, it might be convenient to group
3206 them hierarchically according to topics. You put your Emacs groups over
3207 here, your sex groups over there, and the rest (what, two groups or so?)
3208 you put in some misc section that you never bother with anyway. You can
3209 even group the Emacs sex groups as a sub-topic to either the Emacs
3210 groups or the sex groups---or both! Go wild!
3214 \gnusfigure{Group Topics}{400}{
3215 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
3226 2: alt.religion.emacs
3229 0: comp.talk.emacs.recovery
3231 8: comp.binaries.fractals
3232 13: comp.sources.unix
3235 @findex gnus-topic-mode
3237 To get this @emph{fab} functionality you simply turn on (ooh!) the
3238 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3239 is a toggling command.)
3241 Go ahead, just try it. I'll still be here when you get back. La de
3242 dum... Nice tune, that... la la la... What, you're back? Yes, and now
3243 press @kbd{l}. There. All your groups are now listed under
3244 @samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and
3247 If you want this permanently enabled, you should add that minor mode to
3248 the hook for the group mode:
3251 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3255 * Topic Variables:: How to customize the topics the Lisp Way.
3256 * Topic Commands:: Interactive E-Z commands.
3257 * Topic Sorting:: Sorting each topic individually.
3258 * Topic Topology:: A map of the world.
3259 * Topic Parameters:: Parameters that apply to all groups in a topic.
3263 @node Topic Variables
3264 @subsection Topic Variables
3265 @cindex topic variables
3267 Now, if you select a topic, it will fold/unfold that topic, which is
3268 really neat, I think.
3270 @vindex gnus-topic-line-format
3271 The topic lines themselves are created according to the
3272 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3285 Number of groups in the topic.
3287 Number of unread articles in the topic.
3289 Number of unread articles in the topic and all its subtopics.
3292 @vindex gnus-topic-indent-level
3293 Each sub-topic (and the groups in the sub-topics) will be indented with
3294 @code{gnus-topic-indent-level} times the topic level number of spaces.
3297 @vindex gnus-topic-mode-hook
3298 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3300 @vindex gnus-topic-display-empty-topics
3301 The @code{gnus-topic-display-empty-topics} says whether to display even
3302 topics that have no unread articles in them. The default is @code{t}.
3305 @node Topic Commands
3306 @subsection Topic Commands
3307 @cindex topic commands
3309 When the topic minor mode is turned on, a new @kbd{T} submap will be
3310 available. In addition, a few of the standard keys change their
3311 definitions slightly.
3317 @findex gnus-topic-create-topic
3318 Prompt for a new topic name and create it
3319 (@code{gnus-topic-create-topic}).
3323 @findex gnus-topic-move-group
3324 Move the current group to some other topic
3325 (@code{gnus-topic-move-group}). This command uses the process/prefix
3326 convention (@pxref{Process/Prefix}).
3330 @findex gnus-topic-jump-to-topic
3331 Go to a topic (@code{gnus-topic-jump-to-topic}).
3335 @findex gnus-topic-copy-group
3336 Copy the current group to some other topic
3337 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3338 convention (@pxref{Process/Prefix}).
3342 @findex gnus-topic-hide-topic
3343 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3344 a prefix, hide the topic permanently.
3348 @findex gnus-topic-show-topic
3349 Show the current topic (@code{gnus-topic-show-topic}). If given
3350 a prefix, show the topic permanently.
3354 @findex gnus-topic-remove-group
3355 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3356 This command is mainly useful if you have the same group in several
3357 topics and wish to remove it from one of the topics. You may also
3358 remove a group from all topics, but in that case, Gnus will add it to
3359 the root topic the next time you start Gnus. In fact, all new groups
3360 (which, naturally, don't belong to any topic) will show up in the root
3363 This command uses the process/prefix convention
3364 (@pxref{Process/Prefix}).
3368 @findex gnus-topic-move-matching
3369 Move all groups that match some regular expression to a topic
3370 (@code{gnus-topic-move-matching}).
3374 @findex gnus-topic-copy-matching
3375 Copy all groups that match some regular expression to a topic
3376 (@code{gnus-topic-copy-matching}).
3380 @findex gnus-topic-toggle-display-empty-topics
3381 Toggle hiding empty topics
3382 (@code{gnus-topic-toggle-display-empty-topics}).
3386 @findex gnus-topic-mark-topic
3387 Mark all groups in the current topic with the process mark
3388 (@code{gnus-topic-mark-topic}).
3391 @kindex T M-# (Topic)
3392 @findex gnus-topic-unmark-topic
3393 Remove the process mark from all groups in the current topic
3394 (@code{gnus-topic-unmark-topic}).
3398 @kindex T TAB (Topic)
3400 @findex gnus-topic-indent
3401 ``Indent'' the current topic so that it becomes a sub-topic of the
3402 previous topic (@code{gnus-topic-indent}). If given a prefix,
3403 ``un-indent'' the topic instead.
3406 @kindex M-TAB (Topic)
3407 @findex gnus-topic-unindent
3408 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3409 parent of its current parent (@code{gnus-topic-unindent}).
3413 @findex gnus-topic-select-group
3415 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3416 When you perform this command on a group, you'll enter the group, as
3417 usual. When done on a topic line, the topic will be folded (if it was
3418 visible) or unfolded (if it was folded already). So it's basically a
3419 toggling command on topics. In addition, if you give a numerical
3420 prefix, group on that level (and lower) will be displayed.
3423 @kindex C-c C-x (Topic)
3424 @findex gnus-topic-expire-articles
3425 Run all expirable articles in the current group or topic through the
3426 expiry process (if any)
3427 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3431 @findex gnus-topic-kill-group
3432 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3433 topic will be removed along with the topic.
3437 @findex gnus-topic-yank-group
3438 Yank the previously killed group or topic
3439 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3444 @findex gnus-topic-rename
3445 Rename a topic (@code{gnus-topic-rename}).
3448 @kindex T DEL (Topic)
3449 @findex gnus-topic-delete
3450 Delete an empty topic (@code{gnus-topic-delete}).
3454 @findex gnus-topic-list-active
3455 List all groups that gnus knows about in a topics-ified way
3456 (@code{gnus-topic-list-active}).
3460 @findex gnus-topic-edit-parameters
3461 @cindex group parameters
3462 @cindex topic parameters
3464 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3465 @xref{Topic Parameters}.
3471 @subsection Topic Sorting
3472 @cindex topic sorting
3474 You can sort the groups in each topic individually with the following
3480 @kindex T S a (Topic)
3481 @findex gnus-topic-sort-groups-by-alphabet
3482 Sort the current topic alphabetically by group name
3483 (@code{gnus-topic-sort-groups-by-alphabet}).
3486 @kindex T S u (Topic)
3487 @findex gnus-topic-sort-groups-by-unread
3488 Sort the current topic by the number of unread articles
3489 (@code{gnus-topic-sort-groups-by-unread}).
3492 @kindex T S l (Topic)
3493 @findex gnus-topic-sort-groups-by-level
3494 Sort the current topic by group level
3495 (@code{gnus-topic-sort-groups-by-level}).
3498 @kindex T S v (Topic)
3499 @findex gnus-topic-sort-groups-by-score
3500 Sort the current topic by group score
3501 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
3504 @kindex T S r (Topic)
3505 @findex gnus-topic-sort-groups-by-rank
3506 Sort the current topic by group rank
3507 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
3510 @kindex T S m (Topic)
3511 @findex gnus-topic-sort-groups-by-method
3512 Sort the current topic alphabetically by backend name
3513 (@code{gnus-topic-sort-groups-by-method}).
3517 @xref{Sorting Groups}, for more information about group sorting.
3520 @node Topic Topology
3521 @subsection Topic Topology
3522 @cindex topic topology
3525 So, let's have a look at an example group buffer:
3531 2: alt.religion.emacs
3534 0: comp.talk.emacs.recovery
3536 8: comp.binaries.fractals
3537 13: comp.sources.unix
3540 So, here we have one top-level topic (@samp{Gnus}), two topics under
3541 that, and one sub-topic under one of the sub-topics. (There is always
3542 just one (1) top-level topic). This topology can be expressed as
3547 (("Emacs -- I wuw it!" visible)
3548 (("Naughty Emacs" visible)))
3552 @vindex gnus-topic-topology
3553 This is in fact how the variable @code{gnus-topic-topology} would look
3554 for the display above. That variable is saved in the @file{.newsrc.eld}
3555 file, and shouldn't be messed with manually---unless you really want
3556 to. Since this variable is read from the @file{.newsrc.eld} file,
3557 setting it in any other startup files will have no effect.
3559 This topology shows what topics are sub-topics of what topics (right),
3560 and which topics are visible. Two settings are currently
3561 allowed---@code{visible} and @code{invisible}.
3564 @node Topic Parameters
3565 @subsection Topic Parameters
3566 @cindex topic parameters
3568 All groups in a topic will inherit group parameters from the parent (and
3569 ancestor) topic parameters. All valid group parameters are valid topic
3570 parameters (@pxref{Group Parameters}).
3572 In addition, the following parameters are only valid as topic
3577 When subscribing new groups by topic (@pxref{Subscription Methods}), the
3578 @code{subscribe} topic parameter says what groups go in what topic. Its
3579 value should be a regexp to match the groups that should go in that
3584 Group parameters (of course) override topic parameters, and topic
3585 parameters in sub-topics override topic parameters in super-topics. You
3586 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
3587 verb, although you may feel free to disagree with me here.)
3593 2: alt.religion.emacs
3597 0: comp.talk.emacs.recovery
3599 8: comp.binaries.fractals
3600 13: comp.sources.unix
3604 The @samp{Emacs} topic has the topic parameter @code{(score-file
3605 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
3606 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
3607 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
3608 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
3609 . "religion.SCORE")}.
3611 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
3612 will get the @file{relief.SCORE} home score file. If you enter the same
3613 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
3614 score file. If you enter the group @samp{alt.religion.emacs}, you'll
3615 get the @file{religion.SCORE} home score file.
3617 This seems rather simple and self-evident, doesn't it? Well, yes. But
3618 there are some problems, especially with the @code{total-expiry}
3619 parameter. Say you have a mail group in two topics; one with
3620 @code{total-expiry} and one without. What happens when you do @kbd{M-x
3621 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
3622 of these topics you mean to expire articles from, so anything may
3623 happen. In fact, I hereby declare that it is @dfn{undefined} what
3624 happens. You just have to be careful if you do stuff like that.
3627 @node Misc Group Stuff
3628 @section Misc Group Stuff
3631 * Scanning New Messages:: Asking gnus to see whether new messages have arrived.
3632 * Group Information:: Information and help on groups and gnus.
3633 * Group Timestamp:: Making gnus keep track of when you last read a group.
3634 * File Commands:: Reading and writing the gnus files.
3641 @findex gnus-group-enter-server-mode
3642 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3643 @xref{Server Buffer}.
3647 @findex gnus-group-post-news
3648 Post an article to a group (@code{gnus-group-post-news}). If given a
3649 prefix, the current group name will be used as the default.
3653 @findex gnus-group-mail
3654 Mail a message somewhere (@code{gnus-group-mail}).
3658 Variables for the group buffer:
3662 @item gnus-group-mode-hook
3663 @vindex gnus-group-mode-hook
3664 is called after the group buffer has been
3667 @item gnus-group-prepare-hook
3668 @vindex gnus-group-prepare-hook
3669 is called after the group buffer is
3670 generated. It may be used to modify the buffer in some strange,
3673 @item gnus-group-prepared-hook
3674 @vindex gnus-group-prepare-hook
3675 is called as the very last thing after the group buffer has been
3676 generated. It may be used to move point around, for instance.
3678 @item gnus-permanently-visible-groups
3679 @vindex gnus-permanently-visible-groups
3680 Groups matching this regexp will always be listed in the group buffer,
3681 whether they are empty or not.
3683 @item gnus-group-name-charset-method-alist
3684 @vindex gnus-group-name-charset-method-alist
3685 An alist of method and the charset for group names. It is used to show
3686 non-ASCII group names.
3690 (setq gnus-group-name-charset-method-alist
3691 '(((nntp "news.com.cn") . cn-gb-2312)))
3694 @item gnus-group-name-charset-group-alist
3695 @vindex gnus-group-name-charset-group-alist
3696 An alist of regexp of group name and the charset for group names.
3697 It is used to show non-ASCII group names.
3701 (setq gnus-group-name-charset-group-alist
3702 '(("\\.com\\.cn:" . cn-gb-2312)))
3707 @node Scanning New Messages
3708 @subsection Scanning New Messages
3709 @cindex new messages
3710 @cindex scanning new news
3716 @findex gnus-group-get-new-news
3717 @c @icon{gnus-group-get-new-news}
3718 Check the server(s) for new articles. If the numerical prefix is used,
3719 this command will check only groups of level @var{arg} and lower
3720 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
3721 command will force a total re-reading of the active file(s) from the
3726 @findex gnus-group-get-new-news-this-group
3727 @vindex gnus-goto-next-group-when-activating
3728 @c @icon{gnus-group-get-new-news-this-group}
3729 Check whether new articles have arrived in the current group
3730 (@code{gnus-group-get-new-news-this-group}).
3731 @code{gnus-goto-next-group-when-activating} says whether this command is
3732 to move point to the next group or not. It is @code{t} by default.
3734 @findex gnus-activate-all-groups
3735 @cindex activating groups
3737 @kindex C-c M-g (Group)
3738 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3743 @findex gnus-group-restart
3744 Restart gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
3745 file(s), closes the connection to all servers, clears up all run-time
3746 gnus variables, and then starts gnus all over again.
3750 @vindex gnus-get-new-news-hook
3751 @code{gnus-get-new-news-hook} is run just before checking for new news.
3753 @vindex gnus-after-getting-new-news-hook
3754 @code{gnus-after-getting-new-news-hook} is run after checking for new
3758 @node Group Information
3759 @subsection Group Information
3760 @cindex group information
3761 @cindex information on groups
3768 @findex gnus-group-fetch-faq
3769 @vindex gnus-group-faq-directory
3772 Try to fetch the FAQ for the current group
3773 (@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from
3774 @code{gnus-group-faq-directory}, which is usually a directory on a
3775 remote machine. This variable can also be a list of directories. In
3776 that case, giving a prefix to this command will allow you to choose
3777 between the various sites. @code{ange-ftp} (or @code{efs}) will be used
3778 for fetching the file.
3780 If fetching from the first site is unsuccessful, gnus will attempt to go
3781 through @code{gnus-group-faq-directory} and try to open them one by one.
3785 @c @icon{gnus-group-describe-group}
3787 @kindex C-c C-d (Group)
3788 @cindex describing groups
3789 @cindex group description
3790 @findex gnus-group-describe-group
3791 Describe the current group (@code{gnus-group-describe-group}). If given
3792 a prefix, force Gnus to re-read the description from the server.
3796 @findex gnus-group-describe-all-groups
3797 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
3798 prefix, force gnus to re-read the description file from the server.
3805 @findex gnus-version
3806 Display current gnus version numbers (@code{gnus-version}).
3810 @findex gnus-group-describe-briefly
3811 Give a very short help message (@code{gnus-group-describe-briefly}).
3814 @kindex C-c C-i (Group)
3817 @findex gnus-info-find-node
3818 Go to the gnus info node (@code{gnus-info-find-node}).
3822 @node Group Timestamp
3823 @subsection Group Timestamp
3825 @cindex group timestamps
3827 It can be convenient to let gnus keep track of when you last read a
3828 group. To set the ball rolling, you should add
3829 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3832 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3835 After doing this, each time you enter a group, it'll be recorded.
3837 This information can be displayed in various ways---the easiest is to
3838 use the @samp{%d} spec in the group line format:
3841 (setq gnus-group-line-format
3842 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3845 This will result in lines looking like:
3848 * 0: mail.ding 19961002T012943
3849 0: custom 19961002T012713
3852 As you can see, the date is displayed in compact ISO 8601 format. This
3853 may be a bit too much, so to just display the date, you could say
3857 (setq gnus-group-line-format
3858 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3863 @subsection File Commands
3864 @cindex file commands
3870 @findex gnus-group-read-init-file
3871 @vindex gnus-init-file
3872 @cindex reading init file
3873 Re-read the init file (@code{gnus-init-file}, which defaults to
3874 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3878 @findex gnus-group-save-newsrc
3879 @cindex saving .newsrc
3880 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3881 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
3882 file(s) whether Gnus thinks it is necessary or not.
3885 @c @kindex Z (Group)
3886 @c @findex gnus-group-clear-dribble
3887 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3892 @node Summary Buffer
3893 @chapter Summary Buffer
3894 @cindex summary buffer
3896 A line for each article is displayed in the summary buffer. You can
3897 move around, read articles, post articles and reply to articles.
3899 The most common way to a summary buffer is to select a group from the
3900 group buffer (@pxref{Selecting a Group}).
3902 You can have as many summary buffers open as you wish.
3905 * Summary Buffer Format:: Deciding how the summary buffer is to look.
3906 * Summary Maneuvering:: Moving around the summary buffer.
3907 * Choosing Articles:: Reading articles.
3908 * Paging the Article:: Scrolling the current article.
3909 * Reply Followup and Post:: Posting articles.
3910 * Marking Articles:: Marking articles as read, expirable, etc.
3911 * Limiting:: You can limit the summary buffer.
3912 * Threading:: How threads are made.
3913 * Sorting the Summary Buffer:: How articles and threads are sorted.
3914 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
3915 * Article Caching:: You may store articles in a cache.
3916 * Persistent Articles:: Making articles expiry-resistant.
3917 * Article Backlog:: Having already read articles hang around.
3918 * Saving Articles:: Ways of customizing article saving.
3919 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
3920 * Article Treatment:: The article buffer can be mangled at will.
3921 * MIME Commands:: Doing MIMEy things with the articles.
3922 * Charsets:: Character set issues.
3923 * Article Commands:: Doing various things with the article buffer.
3924 * Summary Sorting:: Sorting the summary buffer in various ways.
3925 * Finding the Parent:: No child support? Get the parent.
3926 * Alternative Approaches:: Reading using non-default summaries.
3927 * Tree Display:: A more visual display of threads.
3928 * Mail Group Commands:: Some commands can only be used in mail groups.
3929 * Various Summary Stuff:: What didn't fit anywhere else.
3930 * Exiting the Summary Buffer:: Returning to the Group buffer,
3931 or reselecting the current group.
3932 * Crosspost Handling:: How crossposted articles are dealt with.
3933 * Duplicate Suppression:: An alternative when crosspost handling fails.
3934 * Security:: Decrypt and Verify.
3938 @node Summary Buffer Format
3939 @section Summary Buffer Format
3940 @cindex summary buffer format
3944 \gnusfigure{The Summary Buffer}{180}{
3945 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3946 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3952 * Summary Buffer Lines:: You can specify how summary lines should look.
3953 * To From Newsgroups:: How to not display your own name.
3954 * Summary Buffer Mode Line:: You can say how the mode line should look.
3955 * Summary Highlighting:: Making the summary buffer all pretty and nice.
3958 @findex mail-extract-address-components
3959 @findex gnus-extract-address-components
3960 @vindex gnus-extract-address-components
3961 Gnus will use the value of the @code{gnus-extract-address-components}
3962 variable as a function for getting the name and address parts of a
3963 @code{From} header. Three pre-defined functions exist:
3964 @code{gnus-extract-address-components}, which is the default, quite
3965 fast, and too simplistic solution;
3966 @code{mail-extract-address-components}, which works nicely, but is
3967 slower; and @code{std11-extract-address-components}, which works very
3968 nicely, but is slower. The default function will return the wrong
3969 answer in 5% of the cases. If this is unacceptable to you, use the
3970 other function instead:
3973 (setq gnus-extract-address-components
3974 'mail-extract-address-components)
3977 @vindex gnus-summary-same-subject
3978 @code{gnus-summary-same-subject} is a string indicating that the current
3979 article has the same subject as the previous. This string will be used
3980 with those specs that require it. The default is @code{""}.
3983 @node Summary Buffer Lines
3984 @subsection Summary Buffer Lines
3986 @vindex gnus-summary-line-format
3987 You can change the format of the lines in the summary buffer by changing
3988 the @code{gnus-summary-line-format} variable. It works along the same
3989 lines as a normal @code{format} string, with some extensions
3990 (@pxref{Formatting Variables}).
3992 There should always be a colon on the line; the cursor always moves to
3993 the colon after performing an operation.
3995 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3997 The following format specification characters are understood:
4003 Subject string. List identifiers stripped,
4004 @code{gnus-list-identifies}. @xref{Article Hiding}.
4006 Subject if the article is the root of the thread or the previous article
4007 had a different subject, @code{gnus-summary-same-subject} otherwise.
4008 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4010 Full @code{From} header.
4012 The name (from the @code{From} header).
4014 The name, code @code{To} header or the @code{Newsgroups} header
4015 (@pxref{To From Newsgroups}).
4017 The name (from the @code{From} header). This differs from the @code{n}
4018 spec in that it uses the function designated by the
4019 @code{gnus-extract-address-components} variable, which is slower, but
4020 may be more thorough.
4022 The address (from the @code{From} header). This works the same way as
4025 Number of lines in the article.
4027 Number of characters in the article. This specifier is not supported in some
4028 methods (like nnfolder).
4030 Indentation based on thread level (@pxref{Customizing Threading}).
4032 Nothing if the article is a root and lots of spaces if it isn't (it
4033 pushes everything after it off the screen).
4035 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4036 for adopted articles (@pxref{Customizing Threading}).
4038 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4039 for adopted articles.
4041 One space for each thread level.
4043 Twenty minus thread level spaces.
4048 This misleadingly named specifier is the @dfn{secondary mark}. This
4049 mark will say whether the article has been replied to, has been cached,
4053 Score as a number (@pxref{Scoring}).
4055 @vindex gnus-summary-zcore-fuzz
4056 Zcore, @samp{+} if above the default level and @samp{-} if below the
4057 default level. If the difference between
4058 @code{gnus-summary-default-score} and the score is less than
4059 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4067 The @code{Date} in @code{DD-MMM} format.
4069 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4075 Number of articles in the current sub-thread. Using this spec will slow
4076 down summary buffer generation somewhat.
4078 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4079 article has any children.
4085 User defined specifier. The next character in the format string should
4086 be a letter. Gnus will call the function
4087 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
4088 following @samp{%u}. The function will be passed the current header as
4089 argument. The function should return a string, which will be inserted
4090 into the summary just like information from any other summary specifier.
4093 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4094 have to be handled with care. For reasons of efficiency, gnus will
4095 compute what column these characters will end up in, and ``hard-code''
4096 that. This means that it is invalid to have these specs after a
4097 variable-length spec. Well, you might not be arrested, but your summary
4098 buffer will look strange, which is bad enough.
4100 The smart choice is to have these specs as far to the left as possible.
4101 (Isn't that the case with everything, though? But I digress.)
4103 This restriction may disappear in later versions of gnus.
4106 @node To From Newsgroups
4107 @subsection To From Newsgroups
4111 In some groups (particularly in archive groups), the @code{From} header
4112 isn't very interesting, since all the articles there are written by
4113 you. To display the information in the @code{To} or @code{Newsgroups}
4114 headers instead, you need to decide three things: What information to
4115 gather; where to display it; and when to display it.
4119 @vindex gnus-extra-headers
4120 The reading of extra header information is controlled by the
4121 @code{gnus-extra-headers}. This is a list of header symbols. For
4125 (setq gnus-extra-headers
4126 '(To Newsgroups X-Newsreader))
4129 This will result in Gnus trying to obtain these three headers, and
4130 storing it in header structures for later easy retrieval.
4133 @findex gnus-extra-header
4134 The value of these extra headers can be accessed via the
4135 @code{gnus-extra-header} function. Here's a format line spec that will
4136 access the @code{X-Newsreader} header:
4139 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4143 @vindex gnus-ignored-from-addresses
4144 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4145 summary line spec returns the @code{To}, @code{Newsreader} or
4146 @code{From} header. If this regexp matches the contents of the
4147 @code{From} header, the value of the @code{To} or @code{Newsreader}
4148 headers are used instead.
4152 @vindex nnmail-extra-headers
4153 A related variable is @code{nnmail-extra-headers}, which controls when
4154 to include extra headers when generating overview (@sc{nov}) files. If
4155 you have old overview files, you should regenerate them after changing
4158 @vindex gnus-summary-line-format
4159 You also have to instruct Gnus to display the data by changing the
4160 @code{%n} spec to the @code{%f} spec in the
4161 @code{gnus-summary-line-format} variable.
4163 In summary, you'd typically put something like the following in
4167 (setq gnus-extra-headers
4169 (setq nnmail-extra-headers gnus-extra-headers)
4170 (setq gnus-summary-line-format
4171 "%U%R%z%I%(%[%4L: %-20,20f%]%) %s\n")
4172 (setq gnus-ignored-from-addresses
4176 Now, this is mostly useful for mail groups, where you have control over
4177 the @sc{nov} files that are created. However, if you can persuade your
4184 to the end of her @file{overview.fmt} file, then you can use that just
4185 as you would the extra headers from the mail groups.
4188 @node Summary Buffer Mode Line
4189 @subsection Summary Buffer Mode Line
4191 @vindex gnus-summary-mode-line-format
4192 You can also change the format of the summary mode bar (@pxref{Mode Line
4193 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
4194 like. The default is @samp{Gnus: %%b [%A] %Z}.
4196 Here are the elements you can play with:
4202 Unprefixed group name.
4204 Current article number.
4206 Current article score.
4210 Number of unread articles in this group.
4212 Number of unread articles in this group that aren't displayed in the
4215 A string with the number of unread and unselected articles represented
4216 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4217 articles, and just as @samp{<%U more>} if there are just unread articles
4218 and no unselected ones.
4220 Shortish group name. For instance, @samp{rec.arts.anime} will be
4221 shortened to @samp{r.a.anime}.
4223 Subject of the current article.
4225 User-defined spec (@pxref{User-Defined Specs}).
4227 Name of the current score file (@pxref{Scoring}).
4229 Number of dormant articles (@pxref{Unread Articles}).
4231 Number of ticked articles (@pxref{Unread Articles}).
4233 Number of articles that have been marked as read in this session.
4235 Number of articles expunged by the score files.
4239 @node Summary Highlighting
4240 @subsection Summary Highlighting
4244 @item gnus-visual-mark-article-hook
4245 @vindex gnus-visual-mark-article-hook
4246 This hook is run after selecting an article. It is meant to be used for
4247 highlighting the article in some way. It is not run if
4248 @code{gnus-visual} is @code{nil}.
4250 @item gnus-summary-update-hook
4251 @vindex gnus-summary-update-hook
4252 This hook is called when a summary line is changed. It is not run if
4253 @code{gnus-visual} is @code{nil}.
4255 @item gnus-summary-selected-face
4256 @vindex gnus-summary-selected-face
4257 This is the face (or @dfn{font} as some people call it) used to
4258 highlight the current article in the summary buffer.
4260 @item gnus-summary-highlight
4261 @vindex gnus-summary-highlight
4262 Summary lines are highlighted according to this variable, which is a
4263 list where the elements are of the format @code{(@var{form}
4264 . @var{face})}. If you would, for instance, like ticked articles to be
4265 italic and high-scored articles to be bold, you could set this variable
4268 (((eq mark gnus-ticked-mark) . italic)
4269 ((> score default) . bold))
4271 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4272 @var{face} will be applied to the line.
4276 @node Summary Maneuvering
4277 @section Summary Maneuvering
4278 @cindex summary movement
4280 All the straight movement commands understand the numeric prefix and
4281 behave pretty much as you'd expect.
4283 None of these commands select articles.
4288 @kindex M-n (Summary)
4289 @kindex G M-n (Summary)
4290 @findex gnus-summary-next-unread-subject
4291 Go to the next summary line of an unread article
4292 (@code{gnus-summary-next-unread-subject}).
4296 @kindex M-p (Summary)
4297 @kindex G M-p (Summary)
4298 @findex gnus-summary-prev-unread-subject
4299 Go to the previous summary line of an unread article
4300 (@code{gnus-summary-prev-unread-subject}).
4303 @kindex G g (Summary)
4304 @findex gnus-summary-goto-subject
4305 Ask for an article number and then go to the summary line of that article
4306 without displaying the article (@code{gnus-summary-goto-subject}).
4309 If gnus asks you to press a key to confirm going to the next group, you
4310 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4311 buffer, searching for the next group to read without actually returning
4312 to the group buffer.
4314 Variables related to summary movement:
4318 @vindex gnus-auto-select-next
4319 @item gnus-auto-select-next
4320 If you issue one of the movement commands (like @kbd{n}) and there are
4321 no more unread articles after the current one, gnus will offer to go to
4322 the next group. If this variable is @code{t} and the next group is
4323 empty, gnus will exit summary mode and return to the group buffer. If
4324 this variable is neither @code{t} nor @code{nil}, gnus will select the
4325 next group, no matter whether it has any unread articles or not. As a
4326 special case, if this variable is @code{quietly}, gnus will select the
4327 next group without asking for confirmation. If this variable is
4328 @code{almost-quietly}, the same will happen only if you are located on
4329 the last article in the group. Finally, if this variable is
4330 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
4331 without confirmation. Also @pxref{Group Levels}.
4333 @item gnus-auto-select-same
4334 @vindex gnus-auto-select-same
4335 If non-@code{nil}, all the movement commands will try to go to the next
4336 article with the same subject as the current. (@dfn{Same} here might
4337 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
4338 for details (@pxref{Customizing Threading}).) If there are no more
4339 articles with the same subject, go to the first unread article.
4341 This variable is not particularly useful if you use a threaded display.
4343 @item gnus-summary-check-current
4344 @vindex gnus-summary-check-current
4345 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4346 to the next (or previous) article if the current article is unread.
4347 Instead, they will choose the current article.
4349 @item gnus-auto-center-summary
4350 @vindex gnus-auto-center-summary
4351 If non-@code{nil}, gnus will keep the point in the summary buffer
4352 centered at all times. This makes things quite tidy, but if you have a
4353 slow network connection, or simply do not like this un-Emacsism, you can
4354 set this variable to @code{nil} to get the normal Emacs scrolling
4355 action. This will also inhibit horizontal re-centering of the summary
4356 buffer, which might make it more inconvenient to read extremely long
4359 This variable can also be a number. In that case, center the window at
4360 the given number of lines from the top.
4365 @node Choosing Articles
4366 @section Choosing Articles
4367 @cindex selecting articles
4370 * Choosing Commands:: Commands for choosing articles.
4371 * Choosing Variables:: Variables that influence these commands.
4375 @node Choosing Commands
4376 @subsection Choosing Commands
4378 None of the following movement commands understand the numeric prefix,
4379 and they all select and display an article.
4381 If you want to fetch new articles or redisplay the group, see
4382 @ref{Exiting the Summary Buffer}.
4386 @kindex SPACE (Summary)
4387 @findex gnus-summary-next-page
4388 Select the current article, or, if that one's read already, the next
4389 unread article (@code{gnus-summary-next-page}).
4394 @kindex G n (Summary)
4395 @findex gnus-summary-next-unread-article
4396 @c @icon{gnus-summary-next-unread}
4397 Go to next unread article (@code{gnus-summary-next-unread-article}).
4402 @findex gnus-summary-prev-unread-article
4403 @c @icon{gnus-summary-prev-unread}
4404 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
4409 @kindex G N (Summary)
4410 @findex gnus-summary-next-article
4411 Go to the next article (@code{gnus-summary-next-article}).
4416 @kindex G P (Summary)
4417 @findex gnus-summary-prev-article
4418 Go to the previous article (@code{gnus-summary-prev-article}).
4421 @kindex G C-n (Summary)
4422 @findex gnus-summary-next-same-subject
4423 Go to the next article with the same subject
4424 (@code{gnus-summary-next-same-subject}).
4427 @kindex G C-p (Summary)
4428 @findex gnus-summary-prev-same-subject
4429 Go to the previous article with the same subject
4430 (@code{gnus-summary-prev-same-subject}).
4434 @kindex G f (Summary)
4436 @findex gnus-summary-first-unread-article
4437 Go to the first unread article
4438 (@code{gnus-summary-first-unread-article}).
4442 @kindex G b (Summary)
4444 @findex gnus-summary-best-unread-article
4445 Go to the article with the highest score
4446 (@code{gnus-summary-best-unread-article}).
4451 @kindex G l (Summary)
4452 @findex gnus-summary-goto-last-article
4453 Go to the previous article read (@code{gnus-summary-goto-last-article}).
4456 @kindex G o (Summary)
4457 @findex gnus-summary-pop-article
4459 @cindex article history
4460 Pop an article off the summary history and go to this article
4461 (@code{gnus-summary-pop-article}). This command differs from the
4462 command above in that you can pop as many previous articles off the
4463 history as you like, while @kbd{l} toggles the two last read articles.
4464 For a somewhat related issue (if you use these commands a lot),
4465 @pxref{Article Backlog}.
4470 @kindex G j (Summary)
4471 @findex gnus-summary-goto-article
4472 Ask for an article number or @code{Message-ID}, and then go to that
4473 article (@code{gnus-summary-goto-article}).
4478 @node Choosing Variables
4479 @subsection Choosing Variables
4481 Some variables relevant for moving and selecting articles:
4484 @item gnus-auto-extend-newsgroup
4485 @vindex gnus-auto-extend-newsgroup
4486 All the movement commands will try to go to the previous (or next)
4487 article, even if that article isn't displayed in the Summary buffer if
4488 this variable is non-@code{nil}. Gnus will then fetch the article from
4489 the server and display it in the article buffer.
4491 @item gnus-select-article-hook
4492 @vindex gnus-select-article-hook
4493 This hook is called whenever an article is selected. By default it
4494 exposes any threads hidden under the selected article.
4496 @item gnus-mark-article-hook
4497 @vindex gnus-mark-article-hook
4498 @findex gnus-summary-mark-unread-as-read
4499 @findex gnus-summary-mark-read-and-unread-as-read
4500 @findex gnus-unread-mark
4501 This hook is called whenever an article is selected. It is intended to
4502 be used for marking articles as read. The default value is
4503 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
4504 mark of almost any article you read to @code{gnus-unread-mark}. The
4505 only articles not affected by this function are ticked, dormant, and
4506 expirable articles. If you'd instead like to just have unread articles
4507 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
4508 instead. It will leave marks like @code{gnus-low-score-mark},
4509 @code{gnus-del-mark} (and so on) alone.
4514 @node Paging the Article
4515 @section Scrolling the Article
4516 @cindex article scrolling
4521 @kindex SPACE (Summary)
4522 @findex gnus-summary-next-page
4523 Pressing @kbd{SPACE} will scroll the current article forward one page,
4524 or, if you have come to the end of the current article, will choose the
4525 next article (@code{gnus-summary-next-page}).
4528 @kindex DEL (Summary)
4529 @findex gnus-summary-prev-page
4530 Scroll the current article back one page (@code{gnus-summary-prev-page}).
4533 @kindex RET (Summary)
4534 @findex gnus-summary-scroll-up
4535 Scroll the current article one line forward
4536 (@code{gnus-summary-scroll-up}).
4539 @kindex M-RET (Summary)
4540 @findex gnus-summary-scroll-down
4541 Scroll the current article one line backward
4542 (@code{gnus-summary-scroll-down}).
4546 @kindex A g (Summary)
4548 @findex gnus-summary-show-article
4549 @vindex gnus-summary-show-article-charset-alist
4550 (Re)fetch the current article (@code{gnus-summary-show-article}). If
4551 given a prefix, fetch the current article, but don't run any of the
4552 article treatment functions. This will give you a ``raw'' article, just
4553 the way it came from the server.
4555 If given a numerical prefix, you can do semi-manual charset stuff.
4556 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
4557 encoded in the @code{cn-gb-2312} charset. If you have
4560 (setq gnus-summary-show-article-charset-alist
4565 then you can say @kbd{C-u 1 g} to get the same effect.
4570 @kindex A < (Summary)
4571 @findex gnus-summary-beginning-of-article
4572 Scroll to the beginning of the article
4573 (@code{gnus-summary-beginning-of-article}).
4578 @kindex A > (Summary)
4579 @findex gnus-summary-end-of-article
4580 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
4584 @kindex A s (Summary)
4586 @findex gnus-summary-isearch-article
4587 Perform an isearch in the article buffer
4588 (@code{gnus-summary-isearch-article}).
4592 @findex gnus-summary-select-article-buffer
4593 Select the article buffer (@code{gnus-summary-select-article-buffer}).
4598 @node Reply Followup and Post
4599 @section Reply, Followup and Post
4602 * Summary Mail Commands:: Sending mail.
4603 * Summary Post Commands:: Sending news.
4604 * Summary Message Commands:: Other Message-related commands.
4605 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
4609 @node Summary Mail Commands
4610 @subsection Summary Mail Commands
4612 @cindex composing mail
4614 Commands for composing a mail message:
4620 @kindex S r (Summary)
4622 @findex gnus-summary-reply
4623 @c @icon{gnus-summary-mail-reply}
4624 @c @icon{gnus-summary-reply}
4625 Mail a reply to the author of the current article
4626 (@code{gnus-summary-reply}).
4631 @kindex S R (Summary)
4632 @findex gnus-summary-reply-with-original
4633 @c @icon{gnus-summary-reply-with-original}
4634 Mail a reply to the author of the current article and include the
4635 original message (@code{gnus-summary-reply-with-original}). This
4636 command uses the process/prefix convention.
4639 @kindex S w (Summary)
4640 @findex gnus-summary-wide-reply
4641 Mail a wide reply to the author of the current article
4642 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
4643 goes out to all people listed in the @code{To}, @code{From} (or
4644 @code{Reply-to}) and @code{Cc} headers.
4647 @kindex S W (Summary)
4648 @findex gnus-summary-wide-reply-with-original
4649 Mail a wide reply to the current article and include the original
4650 message (@code{gnus-summary-wide-reply-with-original}). This command uses
4651 the process/prefix convention.
4654 @kindex S v (Summary)
4655 @findex gnus-summary-very-wide-reply
4656 Mail a very wide reply to the author of the current article
4657 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
4658 that goes out to all people listed in the @code{To}, @code{From} (or
4659 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
4660 articles. This command uses the process/prefix convention.
4663 @kindex S W (Summary)
4664 @findex gnus-summary-wide-reply-with-original
4665 Mail a very wide reply to the current article and include the original
4666 message (@code{gnus-summary-wide-reply-with-original}). This command uses
4667 the process/prefix convention.
4671 @kindex S o m (Summary)
4672 @kindex C-c C-f (Summary)
4673 @findex gnus-summary-mail-forward
4674 @c @icon{gnus-summary-mail-forward}
4675 Forward the current article to some other person
4676 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
4677 headers of the forwarded article.
4682 @kindex S m (Summary)
4683 @findex gnus-summary-mail-other-window
4684 @c @icon{gnus-summary-mail-originate}
4685 Send a mail to some other person
4686 (@code{gnus-summary-mail-other-window}).
4689 @kindex S D b (Summary)
4690 @findex gnus-summary-resend-bounced-mail
4691 @cindex bouncing mail
4692 If you have sent a mail, but the mail was bounced back to you for some
4693 reason (wrong address, transient failure), you can use this command to
4694 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
4695 will be popped into a mail buffer where you can edit the headers before
4696 sending the mail off again. If you give a prefix to this command, and
4697 the bounced mail is a reply to some other mail, gnus will try to fetch
4698 that mail and display it for easy perusal of its headers. This might
4699 very well fail, though.
4702 @kindex S D r (Summary)
4703 @findex gnus-summary-resend-message
4704 Not to be confused with the previous command,
4705 @code{gnus-summary-resend-message} will prompt you for an address to
4706 send the current message off to, and then send it to that place. The
4707 headers of the message won't be altered---but lots of headers that say
4708 @code{Resent-To}, @code{Resent-From} and so on will be added. This
4709 means that you actually send a mail to someone that has a @code{To}
4710 header that (probably) points to yourself. This will confuse people.
4711 So, natcherly you'll only do that if you're really eVIl.
4713 This command is mainly used if you have several accounts and want to
4714 ship a mail to a different account of yours. (If you're both
4715 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4716 to the @code{root} account, you may want to resend it to
4717 @code{postmaster}. Ordnung muß sein!
4719 This command understands the process/prefix convention
4720 (@pxref{Process/Prefix}).
4723 @kindex S O m (Summary)
4724 @findex gnus-summary-digest-mail-forward
4725 Digest the current series (@pxref{Decoding Articles}) and forward the
4726 result using mail (@code{gnus-summary-digest-mail-forward}). This
4727 command uses the process/prefix convention (@pxref{Process/Prefix}).
4730 @kindex S M-c (Summary)
4731 @findex gnus-summary-mail-crosspost-complaint
4732 @cindex crossposting
4733 @cindex excessive crossposting
4734 Send a complaint about excessive crossposting to the author of the
4735 current article (@code{gnus-summary-mail-crosspost-complaint}).
4737 @findex gnus-crosspost-complaint
4738 This command is provided as a way to fight back against the current
4739 crossposting pandemic that's sweeping Usenet. It will compose a reply
4740 using the @code{gnus-crosspost-complaint} variable as a preamble. This
4741 command understands the process/prefix convention
4742 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
4746 Also @pxref{(message)Header Commands} for more information.
4749 @node Summary Post Commands
4750 @subsection Summary Post Commands
4752 @cindex composing news
4754 Commands for posting a news article:
4760 @kindex S p (Summary)
4761 @findex gnus-summary-post-news
4762 @c @icon{gnus-summary-post-news}
4763 Post an article to the current group
4764 (@code{gnus-summary-post-news}).
4769 @kindex S f (Summary)
4770 @findex gnus-summary-followup
4771 @c @icon{gnus-summary-followup}
4772 Post a followup to the current article (@code{gnus-summary-followup}).
4776 @kindex S F (Summary)
4778 @c @icon{gnus-summary-followup-with-original}
4779 @findex gnus-summary-followup-with-original
4780 Post a followup to the current article and include the original message
4781 (@code{gnus-summary-followup-with-original}). This command uses the
4782 process/prefix convention.
4785 @kindex S n (Summary)
4786 @findex gnus-summary-followup-to-mail
4787 Post a followup to the current article via news, even if you got the
4788 message through mail (@code{gnus-summary-followup-to-mail}).
4791 @kindex S N (Summary)
4792 @findex gnus-summary-followup-to-mail-with-original
4793 Post a followup to the current article via news, even if you got the
4794 message through mail and include the original message
4795 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
4796 the process/prefix convention.
4799 @kindex S o p (Summary)
4800 @findex gnus-summary-post-forward
4801 Forward the current article to a newsgroup
4802 (@code{gnus-summary-post-forward}). If given a prefix, include the full
4803 headers of the forwarded article.
4806 @kindex S O p (Summary)
4807 @findex gnus-summary-digest-post-forward
4809 @cindex making digests
4810 Digest the current series and forward the result to a newsgroup
4811 (@code{gnus-summary-digest-post-forward}). This command uses the
4812 process/prefix convention.
4815 @kindex S u (Summary)
4816 @findex gnus-uu-post-news
4817 @c @icon{gnus-uu-post-news}
4818 Uuencode a file, split it into parts, and post it as a series
4819 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
4822 Also @pxref{(message)Header Commands} for more information.
4825 @node Summary Message Commands
4826 @subsection Summary Message Commands
4830 @kindex S y (Summary)
4831 @findex gnus-summary-yank-message
4832 Yank the current article into an already existing Message composition
4833 buffer (@code{gnus-summary-yank-message}). This command prompts for
4834 what message buffer you want to yank into, and understands the
4835 process/prefix convention (@pxref{Process/Prefix}).
4840 @node Canceling and Superseding
4841 @subsection Canceling Articles
4842 @cindex canceling articles
4843 @cindex superseding articles
4845 Have you ever written something, and then decided that you really,
4846 really, really wish you hadn't posted that?
4848 Well, you can't cancel mail, but you can cancel posts.
4850 @findex gnus-summary-cancel-article
4852 @c @icon{gnus-summary-cancel-article}
4853 Find the article you wish to cancel (you can only cancel your own
4854 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
4855 c} (@code{gnus-summary-cancel-article}). Your article will be
4856 canceled---machines all over the world will be deleting your article.
4857 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4859 Be aware, however, that not all sites honor cancels, so your article may
4860 live on here and there, while most sites will delete the article in
4863 Gnus will use the ``current'' select method when canceling. If you
4864 want to use the standard posting method, use the @samp{a} symbolic
4865 prefix (@pxref{Symbolic Prefixes}).
4867 If you discover that you have made some mistakes and want to do some
4868 corrections, you can post a @dfn{superseding} article that will replace
4869 your original article.
4871 @findex gnus-summary-supersede-article
4873 Go to the original article and press @kbd{S s}
4874 (@code{gnus-summary-supersede-article}). You will be put in a buffer
4875 where you can edit the article all you want before sending it off the
4878 The same goes for superseding as for canceling, only more so: Some
4879 sites do not honor superseding. On those sites, it will appear that you
4880 have posted almost the same article twice.
4882 If you have just posted the article, and change your mind right away,
4883 there is a trick you can use to cancel/supersede the article without
4884 waiting for the article to appear on your site first. You simply return
4885 to the post buffer (which is called @code{*sent ...*}). There you will
4886 find the article you just posted, with all the headers intact. Change
4887 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4888 header by substituting one of those words for the word
4889 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
4890 you would do normally. The previous article will be
4891 canceled/superseded.
4893 Just remember, kids: There is no 'c' in 'supersede'.
4896 @node Marking Articles
4897 @section Marking Articles
4898 @cindex article marking
4899 @cindex article ticking
4902 There are several marks you can set on an article.
4904 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4905 neologism ohoy!) of the article. Alphabetic marks generally mean
4906 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4908 In addition, you also have marks that do not affect readedness.
4911 * Unread Articles:: Marks for unread articles.
4912 * Read Articles:: Marks for read articles.
4913 * Other Marks:: Marks that do not affect readedness.
4917 There's a plethora of commands for manipulating these marks:
4921 * Setting Marks:: How to set and remove marks.
4922 * Generic Marking Commands:: How to customize the marking.
4923 * Setting Process Marks:: How to mark articles for later processing.
4927 @node Unread Articles
4928 @subsection Unread Articles
4930 The following marks mark articles as (kinda) unread, in one form or
4935 @vindex gnus-ticked-mark
4936 Marked as ticked (@code{gnus-ticked-mark}).
4938 @dfn{Ticked articles} are articles that will remain visible always. If
4939 you see an article that you find interesting, or you want to put off
4940 reading it, or replying to it, until sometime later, you'd typically
4941 tick it. However, articles can be expired (from news servers by the
4942 news server software, Gnus itself never expires ticked messages), so if
4943 you want to keep an article forever, you'll have to make it persistent
4944 (@pxref{Persistent Articles}).
4947 @vindex gnus-dormant-mark
4948 Marked as dormant (@code{gnus-dormant-mark}).
4950 @dfn{Dormant articles} will only appear in the summary buffer if there
4951 are followups to it. If you want to see them even if they don't have
4952 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4953 Otherwise (except for the visibility issue), they are just like ticked
4957 @vindex gnus-unread-mark
4958 Marked as unread (@code{gnus-unread-mark}).
4960 @dfn{Unread articles} are articles that haven't been read at all yet.
4965 @subsection Read Articles
4966 @cindex expirable mark
4968 All the following marks mark articles as read.
4973 @vindex gnus-del-mark
4974 These are articles that the user has marked as read with the @kbd{d}
4975 command manually, more or less (@code{gnus-del-mark}).
4978 @vindex gnus-read-mark
4979 Articles that have actually been read (@code{gnus-read-mark}).
4982 @vindex gnus-ancient-mark
4983 Articles that were marked as read in previous sessions and are now
4984 @dfn{old} (@code{gnus-ancient-mark}).
4987 @vindex gnus-killed-mark
4988 Marked as killed (@code{gnus-killed-mark}).
4991 @vindex gnus-kill-file-mark
4992 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4995 @vindex gnus-low-score-mark
4996 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4999 @vindex gnus-catchup-mark
5000 Marked as read by a catchup (@code{gnus-catchup-mark}).
5003 @vindex gnus-canceled-mark
5004 Canceled article (@code{gnus-canceled-mark})
5007 @vindex gnus-souped-mark
5008 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
5011 @vindex gnus-sparse-mark
5012 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
5016 @vindex gnus-duplicate-mark
5017 Article marked as read by duplicate suppression
5018 (@code{gnus-duplicated-mark}). @xref{Duplicate Suppression}.
5022 All these marks just mean that the article is marked as read, really.
5023 They are interpreted differently when doing adaptive scoring, though.
5025 One more special mark, though:
5029 @vindex gnus-expirable-mark
5030 Marked as expirable (@code{gnus-expirable-mark}).
5032 Marking articles as @dfn{expirable} (or have them marked as such
5033 automatically) doesn't make much sense in normal groups---a user doesn't
5034 control expiring of news articles, but in mail groups, for instance,
5035 articles marked as @dfn{expirable} can be deleted by gnus at
5041 @subsection Other Marks
5042 @cindex process mark
5045 There are some marks that have nothing to do with whether the article is
5051 You can set a bookmark in the current article. Say you are reading a
5052 long thesis on cats' urinary tracts, and have to go home for dinner
5053 before you've finished reading the thesis. You can then set a bookmark
5054 in the article, and gnus will jump to this bookmark the next time it
5055 encounters the article. @xref{Setting Marks}.
5058 @vindex gnus-replied-mark
5059 All articles that you have replied to or made a followup to (i.e., have
5060 answered) will be marked with an @samp{A} in the second column
5061 (@code{gnus-replied-mark}).
5063 @vindex gnus-forwarded-mark
5064 All articles that you have forwarded will be marked with an @samp{O} in
5065 the second column (@code{gnus-forwarded-mark}).
5068 @vindex gnus-cached-mark
5069 Articles stored in the article cache will be marked with an @samp{*} in
5070 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
5073 @vindex gnus-saved-mark
5074 Articles ``saved'' (in some manner or other; not necessarily
5075 religiously) are marked with an @samp{S} in the second column
5076 (@code{gnus-saved-mark}).
5079 @vindex gnus-not-empty-thread-mark
5080 @vindex gnus-empty-thread-mark
5081 If the @samp{%e} spec is used, the presence of threads or not will be
5082 marked with @code{gnus-not-empty-thread-mark} and
5083 @code{gnus-empty-thread-mark} in the third column, respectively.
5086 @vindex gnus-process-mark
5087 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
5088 variety of commands react to the presence of the process mark. For
5089 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5090 all articles that have been marked with the process mark. Articles
5091 marked with the process mark have a @samp{#} in the second column.
5095 You might have noticed that most of these ``non-readedness'' marks
5096 appear in the second column by default. So if you have a cached, saved,
5097 replied article that you have process-marked, what will that look like?
5099 Nothing much. The precedence rules go as follows: process -> cache ->
5100 replied -> saved. So if the article is in the cache and is replied,
5101 you'll only see the cache mark and not the replied mark.
5105 @subsection Setting Marks
5106 @cindex setting marks
5108 All the marking commands understand the numeric prefix.
5113 @kindex M c (Summary)
5114 @kindex M-u (Summary)
5115 @findex gnus-summary-clear-mark-forward
5116 @cindex mark as unread
5117 Clear all readedness-marks from the current article
5118 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
5124 @kindex M t (Summary)
5125 @findex gnus-summary-tick-article-forward
5126 Tick the current article (@code{gnus-summary-tick-article-forward}).
5127 @xref{Article Caching}.
5132 @kindex M ? (Summary)
5133 @findex gnus-summary-mark-as-dormant
5134 Mark the current article as dormant
5135 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
5139 @kindex M d (Summary)
5141 @findex gnus-summary-mark-as-read-forward
5142 Mark the current article as read
5143 (@code{gnus-summary-mark-as-read-forward}).
5147 @findex gnus-summary-mark-as-read-backward
5148 Mark the current article as read and move point to the previous line
5149 (@code{gnus-summary-mark-as-read-backward}).
5154 @kindex M k (Summary)
5155 @findex gnus-summary-kill-same-subject-and-select
5156 Mark all articles that have the same subject as the current one as read,
5157 and then select the next unread article
5158 (@code{gnus-summary-kill-same-subject-and-select}).
5162 @kindex M K (Summary)
5163 @kindex C-k (Summary)
5164 @findex gnus-summary-kill-same-subject
5165 Mark all articles that have the same subject as the current one as read
5166 (@code{gnus-summary-kill-same-subject}).
5169 @kindex M C (Summary)
5170 @findex gnus-summary-catchup
5171 @c @icon{gnus-summary-catchup}
5172 Mark all unread articles as read (@code{gnus-summary-catchup}).
5175 @kindex M C-c (Summary)
5176 @findex gnus-summary-catchup-all
5177 Mark all articles in the group as read---even the ticked and dormant
5178 articles (@code{gnus-summary-catchup-all}).
5181 @kindex M H (Summary)
5182 @findex gnus-summary-catchup-to-here
5183 Catchup the current group to point (before the point)
5184 (@code{gnus-summary-catchup-to-here}).
5187 @kindex M h (Summary)
5188 @findex gnus-summary-catchup-from-here
5189 Catchup the current group from point (after the point)
5190 (@code{gnus-summary-catchup-from-here}).
5193 @kindex C-w (Summary)
5194 @findex gnus-summary-mark-region-as-read
5195 Mark all articles between point and mark as read
5196 (@code{gnus-summary-mark-region-as-read}).
5199 @kindex M V k (Summary)
5200 @findex gnus-summary-kill-below
5201 Kill all articles with scores below the default score (or below the
5202 numeric prefix) (@code{gnus-summary-kill-below}).
5206 @kindex M e (Summary)
5208 @findex gnus-summary-mark-as-expirable
5209 Mark the current article as expirable
5210 (@code{gnus-summary-mark-as-expirable}).
5213 @kindex M b (Summary)
5214 @findex gnus-summary-set-bookmark
5215 Set a bookmark in the current article
5216 (@code{gnus-summary-set-bookmark}).
5219 @kindex M B (Summary)
5220 @findex gnus-summary-remove-bookmark
5221 Remove the bookmark from the current article
5222 (@code{gnus-summary-remove-bookmark}).
5225 @kindex M V c (Summary)
5226 @findex gnus-summary-clear-above
5227 Clear all marks from articles with scores over the default score (or
5228 over the numeric prefix) (@code{gnus-summary-clear-above}).
5231 @kindex M V u (Summary)
5232 @findex gnus-summary-tick-above
5233 Tick all articles with scores over the default score (or over the
5234 numeric prefix) (@code{gnus-summary-tick-above}).
5237 @kindex M V m (Summary)
5238 @findex gnus-summary-mark-above
5239 Prompt for a mark, and mark all articles with scores over the default
5240 score (or over the numeric prefix) with this mark
5241 (@code{gnus-summary-clear-above}).
5244 @vindex gnus-summary-goto-unread
5245 The @code{gnus-summary-goto-unread} variable controls what action should
5246 be taken after setting a mark. If non-@code{nil}, point will move to
5247 the next/previous unread article. If @code{nil}, point will just move
5248 one line up or down. As a special case, if this variable is
5249 @code{never}, all the marking commands as well as other commands (like
5250 @kbd{SPACE}) will move to the next article, whether it is unread or not.
5251 The default is @code{t}.
5254 @node Generic Marking Commands
5255 @subsection Generic Marking Commands
5257 Some people would like the command that ticks an article (@kbd{!}) go to
5258 the next article. Others would like it to go to the next unread
5259 article. Yet others would like it to stay on the current article. And
5260 even though I haven't heard of anybody wanting it to go to the
5261 previous (unread) article, I'm sure there are people that want that as
5264 Multiply these five behaviors with five different marking commands, and
5265 you get a potentially complex set of variable to control what each
5268 To sidestep that mess, Gnus provides commands that do all these
5269 different things. They can be found on the @kbd{M M} map in the summary
5270 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
5271 to list in this manual.
5273 While you can use these commands directly, most users would prefer
5274 altering the summary mode keymap. For instance, if you would like the
5275 @kbd{!} command to go to the next article instead of the next unread
5276 article, you could say something like:
5279 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
5280 (defun my-alter-summary-map ()
5281 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
5287 (defun my-alter-summary-map ()
5288 (local-set-key "!" "MM!n"))
5292 @node Setting Process Marks
5293 @subsection Setting Process Marks
5294 @cindex setting process marks
5301 @kindex M P p (Summary)
5302 @findex gnus-summary-mark-as-processable
5303 Mark the current article with the process mark
5304 (@code{gnus-summary-mark-as-processable}).
5305 @findex gnus-summary-unmark-as-processable
5309 @kindex M P u (Summary)
5310 @kindex M-# (Summary)
5311 Remove the process mark, if any, from the current article
5312 (@code{gnus-summary-unmark-as-processable}).
5315 @kindex M P U (Summary)
5316 @findex gnus-summary-unmark-all-processable
5317 Remove the process mark from all articles
5318 (@code{gnus-summary-unmark-all-processable}).
5321 @kindex M P i (Summary)
5322 @findex gnus-uu-invert-processable
5323 Invert the list of process marked articles
5324 (@code{gnus-uu-invert-processable}).
5327 @kindex M P R (Summary)
5328 @findex gnus-uu-mark-by-regexp
5329 Mark articles that have a @code{Subject} header that matches a regular
5330 expression (@code{gnus-uu-mark-by-regexp}).
5333 @kindex M P G (Summary)
5334 @findex gnus-uu-unmark-by-regexp
5335 Unmark articles that have a @code{Subject} header that matches a regular
5336 expression (@code{gnus-uu-unmark-by-regexp}).
5339 @kindex M P r (Summary)
5340 @findex gnus-uu-mark-region
5341 Mark articles in region (@code{gnus-uu-mark-region}).
5344 @kindex M P t (Summary)
5345 @findex gnus-uu-mark-thread
5346 Mark all articles in the current (sub)thread
5347 (@code{gnus-uu-mark-thread}).
5350 @kindex M P T (Summary)
5351 @findex gnus-uu-unmark-thread
5352 Unmark all articles in the current (sub)thread
5353 (@code{gnus-uu-unmark-thread}).
5356 @kindex M P v (Summary)
5357 @findex gnus-uu-mark-over
5358 Mark all articles that have a score above the prefix argument
5359 (@code{gnus-uu-mark-over}).
5362 @kindex M P s (Summary)
5363 @findex gnus-uu-mark-series
5364 Mark all articles in the current series (@code{gnus-uu-mark-series}).
5367 @kindex M P S (Summary)
5368 @findex gnus-uu-mark-sparse
5369 Mark all series that have already had some articles marked
5370 (@code{gnus-uu-mark-sparse}).
5373 @kindex M P a (Summary)
5374 @findex gnus-uu-mark-all
5375 Mark all articles in series order (@code{gnus-uu-mark-series}).
5378 @kindex M P b (Summary)
5379 @findex gnus-uu-mark-buffer
5380 Mark all articles in the buffer in the order they appear
5381 (@code{gnus-uu-mark-buffer}).
5384 @kindex M P k (Summary)
5385 @findex gnus-summary-kill-process-mark
5386 Push the current process mark set onto the stack and unmark all articles
5387 (@code{gnus-summary-kill-process-mark}).
5390 @kindex M P y (Summary)
5391 @findex gnus-summary-yank-process-mark
5392 Pop the previous process mark set from the stack and restore it
5393 (@code{gnus-summary-yank-process-mark}).
5396 @kindex M P w (Summary)
5397 @findex gnus-summary-save-process-mark
5398 Push the current process mark set onto the stack
5399 (@code{gnus-summary-save-process-mark}).
5403 Also see the @kbd{&} command in @pxref{Searching for Articles} for how to
5404 set process marks based on article body contents.
5411 It can be convenient to limit the summary buffer to just show some
5412 subset of the articles currently in the group. The effect most limit
5413 commands have is to remove a few (or many) articles from the summary
5416 All limiting commands work on subsets of the articles already fetched
5417 from the servers. None of these commands query the server for
5418 additional articles.
5424 @kindex / / (Summary)
5425 @findex gnus-summary-limit-to-subject
5426 Limit the summary buffer to articles that match some subject
5427 (@code{gnus-summary-limit-to-subject}).
5430 @kindex / a (Summary)
5431 @findex gnus-summary-limit-to-author
5432 Limit the summary buffer to articles that match some author
5433 (@code{gnus-summary-limit-to-author}).
5436 @kindex / x (Summary)
5437 @findex gnus-summary-limit-to-extra
5438 Limit the summary buffer to articles that match one of the ``extra''
5439 headers (@pxref{To From Newsgroups})
5440 (@code{gnus-summary-limit-to-extra}).
5444 @kindex / u (Summary)
5446 @findex gnus-summary-limit-to-unread
5447 Limit the summary buffer to articles not marked as read
5448 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
5449 buffer to articles strictly unread. This means that ticked and
5450 dormant articles will also be excluded.
5453 @kindex / m (Summary)
5454 @findex gnus-summary-limit-to-marks
5455 Ask for a mark and then limit to all articles that have been marked
5456 with that mark (@code{gnus-summary-limit-to-marks}).
5459 @kindex / t (Summary)
5460 @findex gnus-summary-limit-to-age
5461 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
5462 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
5463 articles younger than that number of days.
5466 @kindex / n (Summary)
5467 @findex gnus-summary-limit-to-articles
5468 Limit the summary buffer to the current article
5469 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
5470 convention (@pxref{Process/Prefix}).
5473 @kindex / w (Summary)
5474 @findex gnus-summary-pop-limit
5475 Pop the previous limit off the stack and restore it
5476 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
5480 @kindex / v (Summary)
5481 @findex gnus-summary-limit-to-score
5482 Limit the summary buffer to articles that have a score at or above some
5483 score (@code{gnus-summary-limit-to-score}).
5487 @kindex M S (Summary)
5488 @kindex / E (Summary)
5489 @findex gnus-summary-limit-include-expunged
5490 Include all expunged articles in the limit
5491 (@code{gnus-summary-limit-include-expunged}).
5494 @kindex / D (Summary)
5495 @findex gnus-summary-limit-include-dormant
5496 Include all dormant articles in the limit
5497 (@code{gnus-summary-limit-include-dormant}).
5500 @kindex / * (Summary)
5501 @findex gnus-summary-limit-include-cached
5502 Include all cached articles in the limit
5503 (@code{gnus-summary-limit-include-cached}).
5506 @kindex / d (Summary)
5507 @findex gnus-summary-limit-exclude-dormant
5508 Exclude all dormant articles from the limit
5509 (@code{gnus-summary-limit-exclude-dormant}).
5512 @kindex / M (Summary)
5513 @findex gnus-summary-limit-exclude-marks
5514 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
5517 @kindex / T (Summary)
5518 @findex gnus-summary-limit-include-thread
5519 Include all the articles in the current thread in the limit.
5522 @kindex / c (Summary)
5523 @findex gnus-summary-limit-exclude-childless-dormant
5524 Exclude all dormant articles that have no children from the limit
5525 (@code{gnus-summary-limit-exclude-childless-dormant}).
5528 @kindex / C (Summary)
5529 @findex gnus-summary-limit-mark-excluded-as-read
5530 Mark all excluded unread articles as read
5531 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
5532 also mark excluded ticked and dormant articles as read.
5540 @cindex article threading
5542 Gnus threads articles by default. @dfn{To thread} is to put responses
5543 to articles directly after the articles they respond to---in a
5544 hierarchical fashion.
5546 Threading is done by looking at the @code{References} headers of the
5547 articles. In a perfect world, this would be enough to build pretty
5548 trees, but unfortunately, the @code{References} header is often broken
5549 or simply missing. Weird news propagation exacerbates the problem,
5550 so one has to employ other heuristics to get pleasing results. A
5551 plethora of approaches exists, as detailed in horrible detail in
5552 @pxref{Customizing Threading}.
5554 First, a quick overview of the concepts:
5558 The top-most article in a thread; the first article in the thread.
5561 A tree-like article structure.
5564 A small(er) section of this tree-like structure.
5567 Threads often lose their roots due to article expiry, or due to the root
5568 already having been read in a previous session, and not displayed in the
5569 summary buffer. We then typically have many sub-threads that really
5570 belong to one thread, but are without connecting roots. These are
5571 called loose threads.
5573 @item thread gathering
5574 An attempt to gather loose threads into bigger threads.
5576 @item sparse threads
5577 A thread where the missing articles have been ``guessed'' at, and are
5578 displayed as empty lines in the summary buffer.
5584 * Customizing Threading:: Variables you can change to affect the threading.
5585 * Thread Commands:: Thread based commands in the summary buffer.
5589 @node Customizing Threading
5590 @subsection Customizing Threading
5591 @cindex customizing threading
5594 * Loose Threads:: How gnus gathers loose threads into bigger threads.
5595 * Filling In Threads:: Making the threads displayed look fuller.
5596 * More Threading:: Even more variables for fiddling with threads.
5597 * Low-Level Threading:: You thought it was over... but you were wrong!
5602 @subsubsection Loose Threads
5605 @cindex loose threads
5608 @item gnus-summary-make-false-root
5609 @vindex gnus-summary-make-false-root
5610 If non-@code{nil}, gnus will gather all loose subtrees into one big tree
5611 and create a dummy root at the top. (Wait a minute. Root at the top?
5612 Yup.) Loose subtrees occur when the real root has expired, or you've
5613 read or killed the root in a previous session.
5615 When there is no real root of a thread, gnus will have to fudge
5616 something. This variable says what fudging method gnus should use.
5617 There are four possible values:
5621 \gnusfigure{The Summary Buffer}{390}{
5622 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
5623 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
5624 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
5625 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
5630 @cindex adopting articles
5635 Gnus will make the first of the orphaned articles the parent. This
5636 parent will adopt all the other articles. The adopted articles will be
5637 marked as such by pointy brackets (@samp{<>}) instead of the standard
5638 square brackets (@samp{[]}). This is the default method.
5641 @vindex gnus-summary-dummy-line-format
5642 Gnus will create a dummy summary line that will pretend to be the
5643 parent. This dummy line does not correspond to any real article, so
5644 selecting it will just select the first real article after the dummy
5645 article. @code{gnus-summary-dummy-line-format} is used to specify the
5646 format of the dummy roots. It accepts only one format spec: @samp{S},
5647 which is the subject of the article. @xref{Formatting Variables}.
5650 Gnus won't actually make any article the parent, but simply leave the
5651 subject field of all orphans except the first empty. (Actually, it will
5652 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
5656 Don't make any article parent at all. Just gather the threads and
5657 display them after one another.
5660 Don't gather loose threads.
5663 @item gnus-summary-gather-subject-limit
5664 @vindex gnus-summary-gather-subject-limit
5665 Loose threads are gathered by comparing subjects of articles. If this
5666 variable is @code{nil}, gnus requires an exact match between the
5667 subjects of the loose threads before gathering them into one big
5668 super-thread. This might be too strict a requirement, what with the
5669 presence of stupid newsreaders that chop off long subject lines. If
5670 you think so, set this variable to, say, 20 to require that only the
5671 first 20 characters of the subjects have to match. If you set this
5672 variable to a really low number, you'll find that gnus will gather
5673 everything in sight into one thread, which isn't very helpful.
5675 @cindex fuzzy article gathering
5676 If you set this variable to the special value @code{fuzzy}, gnus will
5677 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
5680 @item gnus-simplify-subject-fuzzy-regexp
5681 @vindex gnus-simplify-subject-fuzzy-regexp
5682 This can either be a regular expression or list of regular expressions
5683 that match strings that will be removed from subjects if fuzzy subject
5684 simplification is used.
5686 @item gnus-simplify-ignored-prefixes
5687 @vindex gnus-simplify-ignored-prefixes
5688 If you set @code{gnus-summary-gather-subject-limit} to something as low
5689 as 10, you might consider setting this variable to something sensible:
5691 @c Written by Michael Ernst <mernst@cs.rice.edu>
5693 (setq gnus-simplify-ignored-prefixes
5699 "wanted" "followup" "summary\\( of\\)?"
5700 "help" "query" "problem" "question"
5701 "answer" "reference" "announce"
5702 "How can I" "How to" "Comparison of"
5707 (mapconcat 'identity
5708 '("for" "for reference" "with" "about")
5710 "\\)?\\]?:?[ \t]*"))
5713 All words that match this regexp will be removed before comparing two
5716 @item gnus-simplify-subject-functions
5717 @vindex gnus-simplify-subject-functions
5718 If non-@code{nil}, this variable overrides
5719 @code{gnus-summary-gather-subject-limit}. This variable should be a
5720 list of functions to apply to the @code{Subject} string iteratively to
5721 arrive at the simplified version of the string.
5723 Useful functions to put in this list include:
5726 @item gnus-simplify-subject-re
5727 @findex gnus-simplify-subject-re
5728 Strip the leading @samp{Re:}.
5730 @item gnus-simplify-subject-fuzzy
5731 @findex gnus-simplify-subject-fuzzy
5734 @item gnus-simplify-whitespace
5735 @findex gnus-simplify-whitespace
5736 Remove excessive whitespace.
5739 You may also write your own functions, of course.
5742 @item gnus-summary-gather-exclude-subject
5743 @vindex gnus-summary-gather-exclude-subject
5744 Since loose thread gathering is done on subjects only, that might lead
5745 to many false hits, especially with certain common subjects like
5746 @samp{} and @samp{(none)}. To make the situation slightly better,
5747 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
5748 what subjects should be excluded from the gathering process.@*
5749 The default is @samp{^ *$\\|^(none)$}.
5751 @item gnus-summary-thread-gathering-function
5752 @vindex gnus-summary-thread-gathering-function
5753 Gnus gathers threads by looking at @code{Subject} headers. This means
5754 that totally unrelated articles may end up in the same ``thread'', which
5755 is confusing. An alternate approach is to look at all the
5756 @code{Message-ID}s in all the @code{References} headers to find matches.
5757 This will ensure that no gathered threads ever include unrelated
5758 articles, but it also means that people who have posted with broken
5759 newsreaders won't be gathered properly. The choice is yours---plague or
5763 @item gnus-gather-threads-by-subject
5764 @findex gnus-gather-threads-by-subject
5765 This function is the default gathering function and looks at
5766 @code{Subject}s exclusively.
5768 @item gnus-gather-threads-by-references
5769 @findex gnus-gather-threads-by-references
5770 This function looks at @code{References} headers exclusively.
5773 If you want to test gathering by @code{References}, you could say
5777 (setq gnus-summary-thread-gathering-function
5778 'gnus-gather-threads-by-references)
5784 @node Filling In Threads
5785 @subsubsection Filling In Threads
5788 @item gnus-fetch-old-headers
5789 @vindex gnus-fetch-old-headers
5790 If non-@code{nil}, gnus will attempt to build old threads by fetching
5791 more old headers---headers to articles marked as read. If you
5792 would like to display as few summary lines as possible, but still
5793 connect as many loose threads as possible, you should set this variable
5794 to @code{some} or a number. If you set it to a number, no more than
5795 that number of extra old headers will be fetched. In either case,
5796 fetching old headers only works if the backend you are using carries
5797 overview files---this would normally be @code{nntp}, @code{nnspool} and
5798 @code{nnml}. Also remember that if the root of the thread has been
5799 expired by the server, there's not much gnus can do about that.
5801 This variable can also be set to @code{invisible}. This won't have any
5802 visible effects, but is useful if you use the @kbd{A T} command a lot
5803 (@pxref{Finding the Parent}).
5805 @item gnus-build-sparse-threads
5806 @vindex gnus-build-sparse-threads
5807 Fetching old headers can be slow. A low-rent similar effect can be
5808 gotten by setting this variable to @code{some}. Gnus will then look at
5809 the complete @code{References} headers of all articles and try to string
5810 together articles that belong in the same thread. This will leave
5811 @dfn{gaps} in the threading display where gnus guesses that an article
5812 is missing from the thread. (These gaps appear like normal summary
5813 lines. If you select a gap, gnus will try to fetch the article in
5814 question.) If this variable is @code{t}, gnus will display all these
5815 ``gaps'' without regard for whether they are useful for completing the
5816 thread or not. Finally, if this variable is @code{more}, gnus won't cut
5817 off sparse leaf nodes that don't lead anywhere. This variable is
5818 @code{nil} by default.
5820 @item gnus-read-all-available-headers
5821 @vindex gnus-read-all-available-headers
5822 This is a rather obscure variable that few will find useful. It's
5823 intended for those non-news newsgroups where the backend has to fetch
5824 quite a lot to present the summary buffer, and where it's impossible to
5825 go back to parents of articles. This is mostly the case in the
5826 web-based groups, like the @code{nnultimate} groups.
5828 If you don't use those, then it's safe to leave this as the default
5829 @code{nil}. If you want to use this variable, it should be a regexp
5830 that matches the group name, or @code{t} for all groups.
5835 @node More Threading
5836 @subsubsection More Threading
5839 @item gnus-show-threads
5840 @vindex gnus-show-threads
5841 If this variable is @code{nil}, no threading will be done, and all of
5842 the rest of the variables here will have no effect. Turning threading
5843 off will speed group selection up a bit, but it is sure to make reading
5844 slower and more awkward.
5846 @item gnus-thread-hide-subtree
5847 @vindex gnus-thread-hide-subtree
5848 If non-@code{nil}, all threads will be hidden when the summary buffer is
5851 @item gnus-thread-expunge-below
5852 @vindex gnus-thread-expunge-below
5853 All threads that have a total score (as defined by
5854 @code{gnus-thread-score-function}) less than this number will be
5855 expunged. This variable is @code{nil} by default, which means that no
5856 threads are expunged.
5858 @item gnus-thread-hide-killed
5859 @vindex gnus-thread-hide-killed
5860 if you kill a thread and this variable is non-@code{nil}, the subtree
5863 @item gnus-thread-ignore-subject
5864 @vindex gnus-thread-ignore-subject
5865 Sometimes somebody changes the subject in the middle of a thread. If
5866 this variable is non-@code{nil}, which is the default, the subject
5867 change is ignored. If it is @code{nil}, a change in the subject will
5868 result in a new thread.
5870 @item gnus-thread-indent-level
5871 @vindex gnus-thread-indent-level
5872 This is a number that says how much each sub-thread should be indented.
5875 @item gnus-sort-gathered-threads-function
5876 @vindex gnus-sort-gathered-threads-function
5877 Sometimes, particularly with mailing lists, the order in which mails
5878 arrive locally is not necessarily the same as the order in which they
5879 arrived on the mailing list. Consequently, when sorting sub-threads
5880 using the default @code{gnus-thread-sort-by-number}, responses can end
5881 up appearing before the article to which they are responding to.
5882 Setting this variable to an alternate value
5883 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
5884 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
5885 more logical sub-thread ordering in such instances.
5890 @node Low-Level Threading
5891 @subsubsection Low-Level Threading
5895 @item gnus-parse-headers-hook
5896 @vindex gnus-parse-headers-hook
5897 Hook run before parsing any headers. The default value is
5898 @code{(gnus-set-summary-default-charset)}, which sets up local value of
5899 @code{default-mime-charset} in summary buffer based on variable
5900 @code{gnus-newsgroup-default-charset-alist}.
5902 @item gnus-alter-header-function
5903 @vindex gnus-alter-header-function
5904 If non-@code{nil}, this function will be called to allow alteration of
5905 article header structures. The function is called with one parameter,
5906 the article header vector, which it may alter in any way. For instance,
5907 if you have a mail-to-news gateway which alters the @code{Message-ID}s
5908 in systematic ways (by adding prefixes and such), you can use this
5909 variable to un-scramble the @code{Message-ID}s so that they are more
5910 meaningful. Here's one example:
5913 (setq gnus-alter-header-function 'my-alter-message-id)
5915 (defun my-alter-message-id (header)
5916 (let ((id (mail-header-id header)))
5918 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
5920 (concat (match-string 1 id) "@@" (match-string 2 id))
5927 @node Thread Commands
5928 @subsection Thread Commands
5929 @cindex thread commands
5935 @kindex T k (Summary)
5936 @kindex M-C-k (Summary)
5937 @findex gnus-summary-kill-thread
5938 Mark all articles in the current (sub-)thread as read
5939 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
5940 remove all marks instead. If the prefix argument is negative, tick
5945 @kindex T l (Summary)
5946 @kindex M-C-l (Summary)
5947 @findex gnus-summary-lower-thread
5948 Lower the score of the current (sub-)thread
5949 (@code{gnus-summary-lower-thread}).
5952 @kindex T i (Summary)
5953 @findex gnus-summary-raise-thread
5954 Increase the score of the current (sub-)thread
5955 (@code{gnus-summary-raise-thread}).
5958 @kindex T # (Summary)
5959 @findex gnus-uu-mark-thread
5960 Set the process mark on the current (sub-)thread
5961 (@code{gnus-uu-mark-thread}).
5964 @kindex T M-# (Summary)
5965 @findex gnus-uu-unmark-thread
5966 Remove the process mark from the current (sub-)thread
5967 (@code{gnus-uu-unmark-thread}).
5970 @kindex T T (Summary)
5971 @findex gnus-summary-toggle-threads
5972 Toggle threading (@code{gnus-summary-toggle-threads}).
5975 @kindex T s (Summary)
5976 @findex gnus-summary-show-thread
5977 Expose the (sub-)thread hidden under the current article, if any
5978 (@code{gnus-summary-show-thread}).
5981 @kindex T h (Summary)
5982 @findex gnus-summary-hide-thread
5983 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5986 @kindex T S (Summary)
5987 @findex gnus-summary-show-all-threads
5988 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5991 @kindex T H (Summary)
5992 @findex gnus-summary-hide-all-threads
5993 Hide all threads (@code{gnus-summary-hide-all-threads}).
5996 @kindex T t (Summary)
5997 @findex gnus-summary-rethread-current
5998 Re-thread the current article's thread
5999 (@code{gnus-summary-rethread-current}). This works even when the
6000 summary buffer is otherwise unthreaded.
6003 @kindex T ^ (Summary)
6004 @findex gnus-summary-reparent-thread
6005 Make the current article the child of the marked (or previous) article
6006 (@code{gnus-summary-reparent-thread}).
6010 The following commands are thread movement commands. They all
6011 understand the numeric prefix.
6016 @kindex T n (Summary)
6018 @kindex M-C-n (Summary)
6020 @kindex M-down (Summary)
6021 @findex gnus-summary-next-thread
6022 Go to the next thread (@code{gnus-summary-next-thread}).
6025 @kindex T p (Summary)
6027 @kindex M-C-p (Summary)
6029 @kindex M-up (Summary)
6030 @findex gnus-summary-prev-thread
6031 Go to the previous thread (@code{gnus-summary-prev-thread}).
6034 @kindex T d (Summary)
6035 @findex gnus-summary-down-thread
6036 Descend the thread (@code{gnus-summary-down-thread}).
6039 @kindex T u (Summary)
6040 @findex gnus-summary-up-thread
6041 Ascend the thread (@code{gnus-summary-up-thread}).
6044 @kindex T o (Summary)
6045 @findex gnus-summary-top-thread
6046 Go to the top of the thread (@code{gnus-summary-top-thread}).
6049 @vindex gnus-thread-operation-ignore-subject
6050 If you ignore subject while threading, you'll naturally end up with
6051 threads that have several different subjects in them. If you then issue
6052 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
6053 wish to kill the entire thread, but just those parts of the thread that
6054 have the same subject as the current article. If you like this idea,
6055 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
6056 is non-@code{nil} (which it is by default), subjects will be ignored
6057 when doing thread commands. If this variable is @code{nil}, articles in
6058 the same thread with different subjects will not be included in the
6059 operation in question. If this variable is @code{fuzzy}, only articles
6060 that have subjects fuzzily equal will be included (@pxref{Fuzzy
6064 @node Sorting the Summary Buffer
6065 @section Sorting the Summary Buffer
6067 @findex gnus-thread-sort-by-total-score
6068 @findex gnus-thread-sort-by-date
6069 @findex gnus-thread-sort-by-score
6070 @findex gnus-thread-sort-by-subject
6071 @findex gnus-thread-sort-by-author
6072 @findex gnus-thread-sort-by-number
6073 @vindex gnus-thread-sort-functions
6074 If you are using a threaded summary display, you can sort the threads by
6075 setting @code{gnus-thread-sort-functions}, which can be either a single
6076 function, a list of functions, or a list containing functions and
6077 @code{(not some-function)} elements.
6079 By default, sorting is done on article numbers. Ready-made sorting
6080 predicate functions include @code{gnus-thread-sort-by-number},
6081 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
6082 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
6083 @code{gnus-thread-sort-by-total-score}.
6085 Each function takes two threads and returns non-@code{nil} if the first
6086 thread should be sorted before the other. Note that sorting really is
6087 normally done by looking only at the roots of each thread.
6089 If you use more than one function, the primary sort key should be the
6090 last function in the list. You should probably always include
6091 @code{gnus-thread-sort-by-number} in the list of sorting
6092 functions---preferably first. This will ensure that threads that are
6093 equal with respect to the other sort criteria will be displayed in
6094 ascending article order.
6096 If you would like to sort by reverse score, then by subject, and finally
6097 by number, you could do something like:
6100 (setq gnus-thread-sort-functions
6101 '(gnus-thread-sort-by-number
6102 gnus-thread-sort-by-subject
6103 (not gnus-thread-sort-by-total-score)))
6106 The threads that have highest score will be displayed first in the
6107 summary buffer. When threads have the same score, they will be sorted
6108 alphabetically. The threads that have the same score and the same
6109 subject will be sorted by number, which is (normally) the sequence in
6110 which the articles arrived.
6112 If you want to sort by score and then reverse arrival order, you could
6116 (setq gnus-thread-sort-functions
6118 (not (gnus-thread-sort-by-number t1 t2)))
6119 gnus-thread-sort-by-score))
6122 @vindex gnus-thread-score-function
6123 The function in the @code{gnus-thread-score-function} variable (default
6124 @code{+}) is used for calculating the total score of a thread. Useful
6125 functions might be @code{max}, @code{min}, or squared means, or whatever
6128 @findex gnus-article-sort-functions
6129 @findex gnus-article-sort-by-date
6130 @findex gnus-article-sort-by-score
6131 @findex gnus-article-sort-by-subject
6132 @findex gnus-article-sort-by-author
6133 @findex gnus-article-sort-by-number
6134 If you are using an unthreaded display for some strange reason or other,
6135 you have to fiddle with the @code{gnus-article-sort-functions} variable.
6136 It is very similar to the @code{gnus-thread-sort-functions}, except that
6137 it uses slightly different functions for article comparison. Available
6138 sorting predicate functions are @code{gnus-article-sort-by-number},
6139 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
6140 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
6142 If you want to sort an unthreaded summary display by subject, you could
6146 (setq gnus-article-sort-functions
6147 '(gnus-article-sort-by-number
6148 gnus-article-sort-by-subject))
6153 @node Asynchronous Fetching
6154 @section Asynchronous Article Fetching
6155 @cindex asynchronous article fetching
6156 @cindex article pre-fetch
6159 If you read your news from an @sc{nntp} server that's far away, the
6160 network latencies may make reading articles a chore. You have to wait
6161 for a while after pressing @kbd{n} to go to the next article before the
6162 article appears. Why can't gnus just go ahead and fetch the article
6163 while you are reading the previous one? Why not, indeed.
6165 First, some caveats. There are some pitfalls to using asynchronous
6166 article fetching, especially the way gnus does it.
6168 Let's say you are reading article 1, which is short, and article 2 is
6169 quite long, and you are not interested in reading that. Gnus does not
6170 know this, so it goes ahead and fetches article 2. You decide to read
6171 article 3, but since gnus is in the process of fetching article 2, the
6172 connection is blocked.
6174 To avoid these situations, gnus will open two (count 'em two)
6175 connections to the server. Some people may think this isn't a very nice
6176 thing to do, but I don't see any real alternatives. Setting up that
6177 extra connection takes some time, so gnus startup will be slower.
6179 Gnus will fetch more articles than you will read. This will mean that
6180 the link between your machine and the @sc{nntp} server will become more
6181 loaded than if you didn't use article pre-fetch. The server itself will
6182 also become more loaded---both with the extra article requests, and the
6185 Ok, so now you know that you shouldn't really use this thing... unless
6188 @vindex gnus-asynchronous
6189 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
6190 happen automatically.
6192 @vindex gnus-use-article-prefetch
6193 You can control how many articles are to be pre-fetched by setting
6194 @code{gnus-use-article-prefetch}. This is 30 by default, which means
6195 that when you read an article in the group, the backend will pre-fetch
6196 the next 30 articles. If this variable is @code{t}, the backend will
6197 pre-fetch all the articles it can without bound. If it is
6198 @code{nil}, no pre-fetching will be done.
6200 @vindex gnus-async-prefetch-article-p
6201 @findex gnus-async-read-p
6202 There are probably some articles that you don't want to pre-fetch---read
6203 articles, for instance. The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched. This function should
6204 return non-@code{nil} when the article in question is to be
6205 pre-fetched. The default is @code{gnus-async-read-p}, which returns
6206 @code{nil} on read articles. The function is called with an article
6207 data structure as the only parameter.
6209 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
6212 (defun my-async-short-unread-p (data)
6213 "Return non-nil for short, unread articles."
6214 (and (gnus-data-unread-p data)
6215 (< (mail-header-lines (gnus-data-header data))
6218 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
6221 These functions will be called many, many times, so they should
6222 preferably be short and sweet to avoid slowing down gnus too much.
6223 It's probably a good idea to byte-compile things like this.
6225 @vindex gnus-prefetched-article-deletion-strategy
6226 Articles have to be removed from the asynch buffer sooner or later. The
6227 @code{gnus-prefetched-article-deletion-strategy} says when to remove
6228 articles. This is a list that may contain the following elements:
6232 Remove articles when they are read.
6235 Remove articles when exiting the group.
6238 The default value is @code{(read exit)}.
6240 @c @vindex gnus-use-header-prefetch
6241 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
6242 @c from the next group.
6245 @node Article Caching
6246 @section Article Caching
6247 @cindex article caching
6250 If you have an @emph{extremely} slow @sc{nntp} connection, you may
6251 consider turning article caching on. Each article will then be stored
6252 locally under your home directory. As you may surmise, this could
6253 potentially use @emph{huge} amounts of disk space, as well as eat up all
6254 your inodes so fast it will make your head swim. In vodka.
6256 Used carefully, though, it could be just an easier way to save articles.
6258 @vindex gnus-use-long-file-name
6259 @vindex gnus-cache-directory
6260 @vindex gnus-use-cache
6261 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
6262 all articles ticked or marked as dormant will then be copied
6263 over to your local cache (@code{gnus-cache-directory}). Whether this
6264 cache is flat or hierarchical is controlled by the
6265 @code{gnus-use-long-file-name} variable, as usual.
6267 When re-selecting a ticked or dormant article, it will be fetched from the
6268 cache instead of from the server. As articles in your cache will never
6269 expire, this might serve as a method of saving articles while still
6270 keeping them where they belong. Just mark all articles you want to save
6271 as dormant, and don't worry.
6273 When an article is marked as read, is it removed from the cache.
6275 @vindex gnus-cache-remove-articles
6276 @vindex gnus-cache-enter-articles
6277 The entering/removal of articles from the cache is controlled by the
6278 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
6279 variables. Both are lists of symbols. The first is @code{(ticked
6280 dormant)} by default, meaning that ticked and dormant articles will be
6281 put in the cache. The latter is @code{(read)} by default, meaning that
6282 articles marked as read are removed from the cache. Possibly
6283 symbols in these two lists are @code{ticked}, @code{dormant},
6284 @code{unread} and @code{read}.
6286 @findex gnus-jog-cache
6287 So where does the massive article-fetching and storing come into the
6288 picture? The @code{gnus-jog-cache} command will go through all
6289 subscribed newsgroups, request all unread articles, score them, and
6290 store them in the cache. You should only ever, ever ever ever, use this
6291 command if 1) your connection to the @sc{nntp} server is really, really,
6292 really slow and 2) you have a really, really, really huge disk.
6293 Seriously. One way to cut down on the number of articles downloaded is
6294 to score unwanted articles down and have them marked as read. They will
6295 not then be downloaded by this command.
6297 @vindex gnus-uncacheable-groups
6298 @vindex gnus-cacheable-groups
6299 It is likely that you do not want caching on all groups. For instance,
6300 if your @code{nnml} mail is located under your home directory, it makes no
6301 sense to cache it somewhere else under your home directory. Unless you
6302 feel that it's neat to use twice as much space.
6304 To limit the caching, you could set @code{gnus-cacheable-groups} to a
6305 regexp of groups to cache, @samp{^nntp} for instance, or set the
6306 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
6307 Both variables are @code{nil} by default. If a group matches both
6308 variables, the group is not cached.
6310 @findex gnus-cache-generate-nov-databases
6311 @findex gnus-cache-generate-active
6312 @vindex gnus-cache-active-file
6313 The cache stores information on what articles it contains in its active
6314 file (@code{gnus-cache-active-file}). If this file (or any other parts
6315 of the cache) becomes all messed up for some reason or other, gnus
6316 offers two functions that will try to set things right. @kbd{M-x
6317 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
6318 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
6322 @node Persistent Articles
6323 @section Persistent Articles
6324 @cindex persistent articles
6326 Closely related to article caching, we have @dfn{persistent articles}.
6327 In fact, it's just a different way of looking at caching, and much more
6328 useful in my opinion.
6330 Say you're reading a newsgroup, and you happen on to some valuable gem
6331 that you want to keep and treasure forever. You'd normally just save it
6332 (using one of the many saving commands) in some file. The problem with
6333 that is that it's just, well, yucky. Ideally you'd prefer just having
6334 the article remain in the group where you found it forever; untouched by
6335 the expiry going on at the news server.
6337 This is what a @dfn{persistent article} is---an article that just won't
6338 be deleted. It's implemented using the normal cache functions, but
6339 you use two explicit commands for managing persistent articles:
6345 @findex gnus-cache-enter-article
6346 Make the current article persistent (@code{gnus-cache-enter-article}).
6349 @kindex M-* (Summary)
6350 @findex gnus-cache-remove-article
6351 Remove the current article from the persistent articles
6352 (@code{gnus-cache-remove-article}). This will normally delete the
6356 Both these commands understand the process/prefix convention.
6358 To avoid having all ticked articles (and stuff) entered into the cache,
6359 you should set @code{gnus-use-cache} to @code{passive} if you're just
6360 interested in persistent articles:
6363 (setq gnus-use-cache 'passive)
6367 @node Article Backlog
6368 @section Article Backlog
6370 @cindex article backlog
6372 If you have a slow connection, but the idea of using caching seems
6373 unappealing to you (and it is, really), you can help the situation some
6374 by switching on the @dfn{backlog}. This is where gnus will buffer
6375 already read articles so that it doesn't have to re-fetch articles
6376 you've already read. This only helps if you are in the habit of
6377 re-selecting articles you've recently read, of course. If you never do
6378 that, turning the backlog on will slow gnus down a little bit, and
6379 increase memory usage some.
6381 @vindex gnus-keep-backlog
6382 If you set @code{gnus-keep-backlog} to a number @var{n}, gnus will store
6383 at most @var{n} old articles in a buffer for later re-fetching. If this
6384 variable is non-@code{nil} and is not a number, gnus will store
6385 @emph{all} read articles, which means that your Emacs will grow without
6386 bound before exploding and taking your machine down with you. I put
6387 that in there just to keep y'all on your toes.
6389 This variable is @code{nil} by default.
6392 @node Saving Articles
6393 @section Saving Articles
6394 @cindex saving articles
6396 Gnus can save articles in a number of ways. Below is the documentation
6397 for saving articles in a fairly straight-forward fashion (i.e., little
6398 processing of the article is done before it is saved). For a different
6399 approach (uudecoding, unsharing) you should use @code{gnus-uu}
6400 (@pxref{Decoding Articles}).
6402 @vindex gnus-save-all-headers
6403 If @code{gnus-save-all-headers} is non-@code{nil}, gnus will not delete
6404 unwanted headers before saving the article.
6406 @vindex gnus-saved-headers
6407 If the preceding variable is @code{nil}, all headers that match the
6408 @code{gnus-saved-headers} regexp will be kept, while the rest will be
6409 deleted before saving.
6415 @kindex O o (Summary)
6417 @findex gnus-summary-save-article
6418 @c @icon{gnus-summary-save-article}
6419 Save the current article using the default article saver
6420 (@code{gnus-summary-save-article}).
6423 @kindex O m (Summary)
6424 @findex gnus-summary-save-article-mail
6425 Save the current article in mail format
6426 (@code{gnus-summary-save-article-mail}).
6429 @kindex O r (Summary)
6430 @findex gnus-summary-save-article-rmail
6431 Save the current article in rmail format
6432 (@code{gnus-summary-save-article-rmail}).
6435 @kindex O f (Summary)
6436 @findex gnus-summary-save-article-file
6437 @c @icon{gnus-summary-save-article-file}
6438 Save the current article in plain file format
6439 (@code{gnus-summary-save-article-file}).
6442 @kindex O F (Summary)
6443 @findex gnus-summary-write-article-file
6444 Write the current article in plain file format, overwriting any previous
6445 file contents (@code{gnus-summary-write-article-file}).
6448 @kindex O b (Summary)
6449 @findex gnus-summary-save-article-body-file
6450 Save the current article body in plain file format
6451 (@code{gnus-summary-save-article-body-file}).
6454 @kindex O h (Summary)
6455 @findex gnus-summary-save-article-folder
6456 Save the current article in mh folder format
6457 (@code{gnus-summary-save-article-folder}).
6460 @kindex O v (Summary)
6461 @findex gnus-summary-save-article-vm
6462 Save the current article in a VM folder
6463 (@code{gnus-summary-save-article-vm}).
6466 @kindex O p (Summary)
6467 @findex gnus-summary-pipe-output
6468 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
6469 the current article to a process (@code{gnus-summary-pipe-output}).
6472 @vindex gnus-prompt-before-saving
6473 All these commands use the process/prefix convention
6474 (@pxref{Process/Prefix}). If you save bunches of articles using these
6475 functions, you might get tired of being prompted for files to save each
6476 and every article in. The prompting action is controlled by
6477 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
6478 default, giving you that excessive prompting action you know and
6479 loathe. If you set this variable to @code{t} instead, you'll be prompted
6480 just once for each series of articles you save. If you like to really
6481 have Gnus do all your thinking for you, you can even set this variable
6482 to @code{nil}, which means that you will never be prompted for files to
6483 save articles in. Gnus will simply save all the articles in the default
6487 @vindex gnus-default-article-saver
6488 You can customize the @code{gnus-default-article-saver} variable to make
6489 gnus do what you want it to. You can use any of the six ready-made
6490 functions below, or you can create your own.
6494 @item gnus-summary-save-in-rmail
6495 @findex gnus-summary-save-in-rmail
6496 @vindex gnus-rmail-save-name
6497 @findex gnus-plain-save-name
6498 This is the default format, @dfn{babyl}. Uses the function in the
6499 @code{gnus-rmail-save-name} variable to get a file name to save the
6500 article in. The default is @code{gnus-plain-save-name}.
6502 @item gnus-summary-save-in-mail
6503 @findex gnus-summary-save-in-mail
6504 @vindex gnus-mail-save-name
6505 Save in a Unix mail (mbox) file. Uses the function in the
6506 @code{gnus-mail-save-name} variable to get a file name to save the
6507 article in. The default is @code{gnus-plain-save-name}.
6509 @item gnus-summary-save-in-file
6510 @findex gnus-summary-save-in-file
6511 @vindex gnus-file-save-name
6512 @findex gnus-numeric-save-name
6513 Append the article straight to an ordinary file. Uses the function in
6514 the @code{gnus-file-save-name} variable to get a file name to save the
6515 article in. The default is @code{gnus-numeric-save-name}.
6517 @item gnus-summary-save-body-in-file
6518 @findex gnus-summary-save-body-in-file
6519 Append the article body to an ordinary file. Uses the function in the
6520 @code{gnus-file-save-name} variable to get a file name to save the
6521 article in. The default is @code{gnus-numeric-save-name}.
6523 @item gnus-summary-save-in-folder
6524 @findex gnus-summary-save-in-folder
6525 @findex gnus-folder-save-name
6526 @findex gnus-Folder-save-name
6527 @vindex gnus-folder-save-name
6530 Save the article to an MH folder using @code{rcvstore} from the MH
6531 library. Uses the function in the @code{gnus-folder-save-name} variable
6532 to get a file name to save the article in. The default is
6533 @code{gnus-folder-save-name}, but you can also use
6534 @code{gnus-Folder-save-name}, which creates capitalized names.
6536 @item gnus-summary-save-in-vm
6537 @findex gnus-summary-save-in-vm
6538 Save the article in a VM folder. You have to have the VM mail
6539 reader to use this setting.
6542 @vindex gnus-article-save-directory
6543 All of these functions, except for the last one, will save the article
6544 in the @code{gnus-article-save-directory}, which is initialized from the
6545 @code{SAVEDIR} environment variable. This is @file{~/News/} by
6548 As you can see above, the functions use different functions to find a
6549 suitable name of a file to save the article in. Below is a list of
6550 available functions that generate names:
6554 @item gnus-Numeric-save-name
6555 @findex gnus-Numeric-save-name
6556 File names like @file{~/News/Alt.andrea-dworkin/45}.
6558 @item gnus-numeric-save-name
6559 @findex gnus-numeric-save-name
6560 File names like @file{~/News/alt.andrea-dworkin/45}.
6562 @item gnus-Plain-save-name
6563 @findex gnus-Plain-save-name
6564 File names like @file{~/News/Alt.andrea-dworkin}.
6566 @item gnus-plain-save-name
6567 @findex gnus-plain-save-name
6568 File names like @file{~/News/alt.andrea-dworkin}.
6570 @item gnus-sender-save-name
6571 @findex gnus-sender-save-name
6572 File names like @file{~/News/larsi}.
6575 @vindex gnus-split-methods
6576 You can have gnus suggest where to save articles by plonking a regexp into
6577 the @code{gnus-split-methods} alist. For instance, if you would like to
6578 save articles related to gnus in the file @file{gnus-stuff}, and articles
6579 related to VM in @code{vm-stuff}, you could set this variable to something
6583 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
6584 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
6585 (my-choosing-function "../other-dir/my-stuff")
6586 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
6589 We see that this is a list where each element is a list that has two
6590 elements---the @dfn{match} and the @dfn{file}. The match can either be
6591 a string (in which case it is used as a regexp to match on the article
6592 head); it can be a symbol (which will be called as a function with the
6593 group name as a parameter); or it can be a list (which will be
6594 @code{eval}ed). If any of these actions have a non-@code{nil} result,
6595 the @dfn{file} will be used as a default prompt. In addition, the
6596 result of the operation itself will be used if the function or form
6597 called returns a string or a list of strings.
6599 You basically end up with a list of file names that might be used when
6600 saving the current article. (All ``matches'' will be used.) You will
6601 then be prompted for what you really want to use as a name, with file
6602 name completion over the results from applying this variable.
6604 This variable is @code{((gnus-article-archive-name))} by default, which
6605 means that gnus will look at the articles it saves for an
6606 @code{Archive-name} line and use that as a suggestion for the file
6609 Here's an example function to clean up file names somewhat. If you have
6610 lots of mail groups called things like
6611 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
6612 these group names before creating the file name to save to. The
6613 following will do just that:
6616 (defun my-save-name (group)
6617 (when (string-match "^nnml:mail." group)
6618 (substring group (match-end 0))))
6620 (setq gnus-split-methods
6621 '((gnus-article-archive-name)
6626 @vindex gnus-use-long-file-name
6627 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
6628 @code{nil}, all the preceding functions will replace all periods
6629 (@samp{.}) in the group names with slashes (@samp{/})---which means that
6630 the functions will generate hierarchies of directories instead of having
6631 all the files in the top level directory
6632 (@file{~/News/alt/andrea-dworkin} instead of
6633 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
6634 on most systems. However, for historical reasons, this is @code{nil} on
6635 Xenix and usg-unix-v machines by default.
6637 This function also affects kill and score file names. If this variable
6638 is a list, and the list contains the element @code{not-score}, long file
6639 names will not be used for score files, if it contains the element
6640 @code{not-save}, long file names will not be used for saving, and if it
6641 contains the element @code{not-kill}, long file names will not be used
6644 If you'd like to save articles in a hierarchy that looks something like
6648 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
6649 (setq gnus-default-article-saver
6650 'gnus-summary-save-in-file) ; no encoding
6653 Then just save with @kbd{o}. You'd then read this hierarchy with
6654 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
6655 the top level directory as the argument (@file{~/News/}). Then just walk
6656 around to the groups/directories with @code{nneething}.
6659 @node Decoding Articles
6660 @section Decoding Articles
6661 @cindex decoding articles
6663 Sometime users post articles (or series of articles) that have been
6664 encoded in some way or other. Gnus can decode them for you.
6667 * Uuencoded Articles:: Uudecode articles.
6668 * Shell Archives:: Unshar articles.
6669 * PostScript Files:: Split PostScript.
6670 * Other Files:: Plain save and binhex.
6671 * Decoding Variables:: Variables for a happy decoding.
6672 * Viewing Files:: You want to look at the result of the decoding?
6676 @cindex article series
6677 All these functions use the process/prefix convention
6678 (@pxref{Process/Prefix}) for finding out what articles to work on, with
6679 the extension that a ``single article'' means ``a single series''. Gnus
6680 can find out by itself what articles belong to a series, decode all the
6681 articles and unpack/view/save the resulting file(s).
6683 Gnus guesses what articles are in the series according to the following
6684 simplish rule: The subjects must be (nearly) identical, except for the
6685 last two numbers of the line. (Spaces are largely ignored, however.)
6687 For example: If you choose a subject called @samp{cat.gif (2/3)}, gnus
6688 will find all the articles that match the regexp @samp{^cat.gif
6689 ([0-9]+/[0-9]+).*$}.
6691 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
6692 series}, will not be properly recognized by any of the automatic viewing
6693 commands, and you have to mark the articles manually with @kbd{#}.
6696 @node Uuencoded Articles
6697 @subsection Uuencoded Articles
6699 @cindex uuencoded articles
6704 @kindex X u (Summary)
6705 @findex gnus-uu-decode-uu
6706 @c @icon{gnus-uu-decode-uu}
6707 Uudecodes the current series (@code{gnus-uu-decode-uu}).
6710 @kindex X U (Summary)
6711 @findex gnus-uu-decode-uu-and-save
6712 Uudecodes and saves the current series
6713 (@code{gnus-uu-decode-uu-and-save}).
6716 @kindex X v u (Summary)
6717 @findex gnus-uu-decode-uu-view
6718 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
6721 @kindex X v U (Summary)
6722 @findex gnus-uu-decode-uu-and-save-view
6723 Uudecodes, views and saves the current series
6724 (@code{gnus-uu-decode-uu-and-save-view}).
6728 Remember that these all react to the presence of articles marked with
6729 the process mark. If, for instance, you'd like to decode and save an
6730 entire newsgroup, you'd typically do @kbd{M P a}
6731 (@code{gnus-uu-mark-all}) and then @kbd{X U}
6732 (@code{gnus-uu-decode-uu-and-save}).
6734 All this is very much different from how @code{gnus-uu} worked with
6735 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
6736 the sun. This version of @code{gnus-uu} generally assumes that you mark
6737 articles in some way (@pxref{Setting Process Marks}) and then press
6740 @vindex gnus-uu-notify-files
6741 Note: When trying to decode articles that have names matching
6742 @code{gnus-uu-notify-files}, which is hard-coded to
6743 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
6744 automatically post an article on @samp{comp.unix.wizards} saying that
6745 you have just viewed the file in question. This feature can't be turned
6749 @node Shell Archives
6750 @subsection Shell Archives
6752 @cindex shell archives
6753 @cindex shared articles
6755 Shell archives (``shar files'') used to be a popular way to distribute
6756 sources, but it isn't used all that much today. In any case, we have
6757 some commands to deal with these:
6762 @kindex X s (Summary)
6763 @findex gnus-uu-decode-unshar
6764 Unshars the current series (@code{gnus-uu-decode-unshar}).
6767 @kindex X S (Summary)
6768 @findex gnus-uu-decode-unshar-and-save
6769 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
6772 @kindex X v s (Summary)
6773 @findex gnus-uu-decode-unshar-view
6774 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
6777 @kindex X v S (Summary)
6778 @findex gnus-uu-decode-unshar-and-save-view
6779 Unshars, views and saves the current series
6780 (@code{gnus-uu-decode-unshar-and-save-view}).
6784 @node PostScript Files
6785 @subsection PostScript Files
6791 @kindex X p (Summary)
6792 @findex gnus-uu-decode-postscript
6793 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
6796 @kindex X P (Summary)
6797 @findex gnus-uu-decode-postscript-and-save
6798 Unpack and save the current PostScript series
6799 (@code{gnus-uu-decode-postscript-and-save}).
6802 @kindex X v p (Summary)
6803 @findex gnus-uu-decode-postscript-view
6804 View the current PostScript series
6805 (@code{gnus-uu-decode-postscript-view}).
6808 @kindex X v P (Summary)
6809 @findex gnus-uu-decode-postscript-and-save-view
6810 View and save the current PostScript series
6811 (@code{gnus-uu-decode-postscript-and-save-view}).
6816 @subsection Other Files
6820 @kindex X o (Summary)
6821 @findex gnus-uu-decode-save
6822 Save the current series
6823 (@code{gnus-uu-decode-save}).
6826 @kindex X b (Summary)
6827 @findex gnus-uu-decode-binhex
6828 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
6829 doesn't really work yet.
6833 @node Decoding Variables
6834 @subsection Decoding Variables
6836 Adjective, not verb.
6839 * Rule Variables:: Variables that say how a file is to be viewed.
6840 * Other Decode Variables:: Other decode variables.
6841 * Uuencoding and Posting:: Variables for customizing uuencoding.
6845 @node Rule Variables
6846 @subsubsection Rule Variables
6847 @cindex rule variables
6849 Gnus uses @dfn{rule variables} to decide how to view a file. All these
6850 variables are of the form
6853 (list '(regexp1 command2)
6860 @item gnus-uu-user-view-rules
6861 @vindex gnus-uu-user-view-rules
6863 This variable is consulted first when viewing files. If you wish to use,
6864 for instance, @code{sox} to convert an @samp{.au} sound file, you could
6867 (setq gnus-uu-user-view-rules
6868 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
6871 @item gnus-uu-user-view-rules-end
6872 @vindex gnus-uu-user-view-rules-end
6873 This variable is consulted if gnus couldn't make any matches from the
6874 user and default view rules.
6876 @item gnus-uu-user-archive-rules
6877 @vindex gnus-uu-user-archive-rules
6878 This variable can be used to say what commands should be used to unpack
6883 @node Other Decode Variables
6884 @subsubsection Other Decode Variables
6887 @vindex gnus-uu-grabbed-file-functions
6889 @item gnus-uu-grabbed-file-functions
6890 All functions in this list will be called right after each file has been
6891 successfully decoded---so that you can move or view files right away,
6892 and don't have to wait for all files to be decoded before you can do
6893 anything. Ready-made functions you can put in this list are:
6897 @item gnus-uu-grab-view
6898 @findex gnus-uu-grab-view
6901 @item gnus-uu-grab-move
6902 @findex gnus-uu-grab-move
6903 Move the file (if you're using a saving function.)
6906 @item gnus-uu-be-dangerous
6907 @vindex gnus-uu-be-dangerous
6908 Specifies what to do if unusual situations arise during decoding. If
6909 @code{nil}, be as conservative as possible. If @code{t}, ignore things
6910 that didn't work, and overwrite existing files. Otherwise, ask each
6913 @item gnus-uu-ignore-files-by-name
6914 @vindex gnus-uu-ignore-files-by-name
6915 Files with name matching this regular expression won't be viewed.
6917 @item gnus-uu-ignore-files-by-type
6918 @vindex gnus-uu-ignore-files-by-type
6919 Files with a @sc{mime} type matching this variable won't be viewed.
6920 Note that Gnus tries to guess what type the file is based on the name.
6921 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
6924 @item gnus-uu-tmp-dir
6925 @vindex gnus-uu-tmp-dir
6926 Where @code{gnus-uu} does its work.
6928 @item gnus-uu-do-not-unpack-archives
6929 @vindex gnus-uu-do-not-unpack-archives
6930 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
6931 looking for files to display.
6933 @item gnus-uu-view-and-save
6934 @vindex gnus-uu-view-and-save
6935 Non-@code{nil} means that the user will always be asked to save a file
6938 @item gnus-uu-ignore-default-view-rules
6939 @vindex gnus-uu-ignore-default-view-rules
6940 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
6943 @item gnus-uu-ignore-default-archive-rules
6944 @vindex gnus-uu-ignore-default-archive-rules
6945 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
6948 @item gnus-uu-kill-carriage-return
6949 @vindex gnus-uu-kill-carriage-return
6950 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
6953 @item gnus-uu-unmark-articles-not-decoded
6954 @vindex gnus-uu-unmark-articles-not-decoded
6955 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
6956 decoded articles as unread.
6958 @item gnus-uu-correct-stripped-uucode
6959 @vindex gnus-uu-correct-stripped-uucode
6960 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
6961 uuencoded files that have had trailing spaces deleted.
6963 @item gnus-uu-pre-uudecode-hook
6964 @vindex gnus-uu-pre-uudecode-hook
6965 Hook run before sending a message to @code{uudecode}.
6967 @item gnus-uu-view-with-metamail
6968 @vindex gnus-uu-view-with-metamail
6970 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
6971 commands defined by the rule variables and just fudge a @sc{mime}
6972 content type based on the file name. The result will be fed to
6973 @code{metamail} for viewing.
6975 @item gnus-uu-save-in-digest
6976 @vindex gnus-uu-save-in-digest
6977 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
6978 decoding, will save in digests. If this variable is @code{nil},
6979 @code{gnus-uu} will just save everything in a file without any
6980 embellishments. The digesting almost conforms to RFC 1153---no easy way
6981 to specify any meaningful volume and issue numbers were found, so I
6982 simply dropped them.
6987 @node Uuencoding and Posting
6988 @subsubsection Uuencoding and Posting
6992 @item gnus-uu-post-include-before-composing
6993 @vindex gnus-uu-post-include-before-composing
6994 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6995 before you compose the article. If this variable is @code{t}, you can
6996 either include an encoded file with @kbd{C-c C-i} or have one included
6997 for you when you post the article.
6999 @item gnus-uu-post-length
7000 @vindex gnus-uu-post-length
7001 Maximum length of an article. The encoded file will be split into how
7002 many articles it takes to post the entire file.
7004 @item gnus-uu-post-threaded
7005 @vindex gnus-uu-post-threaded
7006 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
7007 thread. This may not be smart, as no other decoder I have seen is able
7008 to follow threads when collecting uuencoded articles. (Well, I have
7009 seen one package that does that---@code{gnus-uu}, but somehow, I don't
7010 think that counts...) Default is @code{nil}.
7012 @item gnus-uu-post-separate-description
7013 @vindex gnus-uu-post-separate-description
7014 Non-@code{nil} means that the description will be posted in a separate
7015 article. The first article will typically be numbered (0/x). If this
7016 variable is @code{nil}, the description the user enters will be included
7017 at the beginning of the first article, which will be numbered (1/x).
7018 Default is @code{t}.
7024 @subsection Viewing Files
7025 @cindex viewing files
7026 @cindex pseudo-articles
7028 After decoding, if the file is some sort of archive, gnus will attempt
7029 to unpack the archive and see if any of the files in the archive can be
7030 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
7031 containing the files @file{pic1.jpg} and @file{pic2.gif}, gnus will
7032 uncompress and de-tar the main file, and then view the two pictures.
7033 This unpacking process is recursive, so if the archive contains archives
7034 of archives, it'll all be unpacked.
7036 Finally, gnus will normally insert a @dfn{pseudo-article} for each
7037 extracted file into the summary buffer. If you go to these
7038 ``articles'', you will be prompted for a command to run (usually Gnus
7039 will make a suggestion), and then the command will be run.
7041 @vindex gnus-view-pseudo-asynchronously
7042 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
7043 until the viewing is done before proceeding.
7045 @vindex gnus-view-pseudos
7046 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
7047 the pseudo-articles into the summary buffer, but view them
7048 immediately. If this variable is @code{not-confirm}, the user won't even
7049 be asked for a confirmation before viewing is done.
7051 @vindex gnus-view-pseudos-separately
7052 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
7053 pseudo-article will be created for each file to be viewed. If
7054 @code{nil}, all files that use the same viewing command will be given as
7055 a list of parameters to that command.
7057 @vindex gnus-insert-pseudo-articles
7058 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
7059 pseudo-articles when decoding. It is @code{t} by default.
7061 So; there you are, reading your @emph{pseudo-articles} in your
7062 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
7063 Why isn't anything real anymore? How did we get here?
7066 @node Article Treatment
7067 @section Article Treatment
7069 Reading through this huge manual, you may have quite forgotten that the
7070 object of newsreaders is to actually, like, read what people have
7071 written. Reading articles. Unfortunately, people are quite bad at
7072 writing, so there are tons of functions and variables to make reading
7073 these articles easier.
7076 * Article Highlighting:: You want to make the article look like fruit salad.
7077 * Article Fontisizing:: Making emphasized text look nice.
7078 * Article Hiding:: You also want to make certain info go away.
7079 * Article Washing:: Lots of way-neat functions to make life better.
7080 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
7081 * Article Date:: Grumble, UT!
7082 * Article Signature:: What is a signature?
7083 * Article Miscellania:: Various other stuff.
7087 @node Article Highlighting
7088 @subsection Article Highlighting
7089 @cindex highlighting
7091 Not only do you want your article buffer to look like fruit salad, but
7092 you want it to look like technicolor fruit salad.
7097 @kindex W H a (Summary)
7098 @findex gnus-article-highlight
7099 @findex gnus-article-maybe-highlight
7100 Do much highlighting of the current article
7101 (@code{gnus-article-highlight}). This function highlights header, cited
7102 text, the signature, and adds buttons to the body and the head.
7105 @kindex W H h (Summary)
7106 @findex gnus-article-highlight-headers
7107 @vindex gnus-header-face-alist
7108 Highlight the headers (@code{gnus-article-highlight-headers}). The
7109 highlighting will be done according to the @code{gnus-header-face-alist}
7110 variable, which is a list where each element has the form
7111 @code{(@var{regexp} @var{name} @var{content})}.
7112 @var{regexp} is a regular expression for matching the
7113 header, @var{name} is the face used for highlighting the header name
7114 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
7115 the header value. The first match made will be used. Note that
7116 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
7119 @kindex W H c (Summary)
7120 @findex gnus-article-highlight-citation
7121 Highlight cited text (@code{gnus-article-highlight-citation}).
7123 Some variables to customize the citation highlights:
7126 @vindex gnus-cite-parse-max-size
7128 @item gnus-cite-parse-max-size
7129 If the article size if bigger than this variable (which is 25000 by
7130 default), no citation highlighting will be performed.
7132 @item gnus-cite-max-prefix
7133 @vindex gnus-cite-max-prefix
7134 Maximum possible length for a citation prefix (default 20).
7136 @item gnus-cite-face-list
7137 @vindex gnus-cite-face-list
7138 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
7139 When there are citations from multiple articles in the same message,
7140 gnus will try to give each citation from each article its own face.
7141 This should make it easier to see who wrote what.
7143 @item gnus-supercite-regexp
7144 @vindex gnus-supercite-regexp
7145 Regexp matching normal Supercite attribution lines.
7147 @item gnus-supercite-secondary-regexp
7148 @vindex gnus-supercite-secondary-regexp
7149 Regexp matching mangled Supercite attribution lines.
7151 @item gnus-cite-minimum-match-count
7152 @vindex gnus-cite-minimum-match-count
7153 Minimum number of identical prefixes we have to see before we believe
7154 that it's a citation.
7156 @item gnus-cite-attribution-prefix
7157 @vindex gnus-cite-attribution-prefix
7158 Regexp matching the beginning of an attribution line.
7160 @item gnus-cite-attribution-suffix
7161 @vindex gnus-cite-attribution-suffix
7162 Regexp matching the end of an attribution line.
7164 @item gnus-cite-attribution-face
7165 @vindex gnus-cite-attribution-face
7166 Face used for attribution lines. It is merged with the face for the
7167 cited text belonging to the attribution.
7173 @kindex W H s (Summary)
7174 @vindex gnus-signature-separator
7175 @vindex gnus-signature-face
7176 @findex gnus-article-highlight-signature
7177 Highlight the signature (@code{gnus-article-highlight-signature}).
7178 Everything after @code{gnus-signature-separator} (@pxref{Article
7179 Signature}) in an article will be considered a signature and will be
7180 highlighted with @code{gnus-signature-face}, which is @code{italic} by
7185 @xref{Customizing Articles}, for how to highlight articles automatically.
7188 @node Article Fontisizing
7189 @subsection Article Fontisizing
7191 @cindex article emphasis
7193 @findex gnus-article-emphasize
7194 @kindex W e (Summary)
7195 People commonly add emphasis to words in news articles by writing things
7196 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
7197 this look nicer by running the article through the @kbd{W e}
7198 (@code{gnus-article-emphasize}) command.
7200 @vindex gnus-emphasis-alist
7201 How the emphasis is computed is controlled by the
7202 @code{gnus-emphasis-alist} variable. This is an alist where the first
7203 element is a regular expression to be matched. The second is a number
7204 that says what regular expression grouping is used to find the entire
7205 emphasized word. The third is a number that says what regexp grouping
7206 should be displayed and highlighted. (The text between these two
7207 groupings will be hidden.) The fourth is the face used for
7211 (setq gnus-emphasis-alist
7212 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
7213 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
7222 @vindex gnus-emphasis-underline
7223 @vindex gnus-emphasis-bold
7224 @vindex gnus-emphasis-italic
7225 @vindex gnus-emphasis-underline-bold
7226 @vindex gnus-emphasis-underline-italic
7227 @vindex gnus-emphasis-bold-italic
7228 @vindex gnus-emphasis-underline-bold-italic
7229 By default, there are seven rules, and they use the following faces:
7230 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
7231 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
7232 @code{gnus-emphasis-underline-italic},
7233 @code{gnus-emphasis-underline-bold}, and
7234 @code{gnus-emphasis-underline-bold-italic}.
7236 If you want to change these faces, you can either use @kbd{M-x
7237 customize}, or you can use @code{copy-face}. For instance, if you want
7238 to make @code{gnus-emphasis-italic} use a red face instead, you could
7242 (copy-face 'red 'gnus-emphasis-italic)
7245 @vindex gnus-group-highlight-words-alist
7247 If you want to highlight arbitrary words, you can use the
7248 @code{gnus-group-highlight-words-alist} variable, which uses the same
7249 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
7250 parameter (@pxref{Group Parameters}) can also be used.
7252 @xref{Customizing Articles}, for how to fontize articles automatically.
7255 @node Article Hiding
7256 @subsection Article Hiding
7257 @cindex article hiding
7259 Or rather, hiding certain things in each article. There usually is much
7260 too much cruft in most articles.
7265 @kindex W W a (Summary)
7266 @findex gnus-article-hide
7267 Do quite a lot of hiding on the article buffer
7268 (@kbd{gnus-article-hide}). In particular, this function will hide
7269 headers, PGP, cited text and the signature.
7272 @kindex W W h (Summary)
7273 @findex gnus-article-toggle-headers
7274 Toggle hiding of headers (@code{gnus-article-toggle-headers}). @xref{Hiding
7278 @kindex W W b (Summary)
7279 @findex gnus-article-hide-boring-headers
7280 Hide headers that aren't particularly interesting
7281 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
7284 @kindex W W s (Summary)
7285 @findex gnus-article-hide-signature
7286 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
7290 @kindex W W l (Summary)
7291 @findex gnus-article-hide-list-identifiers
7292 @vindex gnus-list-identifiers
7293 Strip list identifiers specified in @code{gnus-list-identifiers}. These
7294 are strings some mailing list servers add to the beginning of all
7295 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
7296 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
7297 may not contain @code{\\(..\\)}.
7301 @item gnus-list-identifiers
7302 @vindex gnus-list-identifiers
7303 A regular expression that matches list identifiers to be removed from
7304 subject. This can also be a list of regular expressions.
7309 @kindex W W p (Summary)
7310 @findex gnus-article-hide-pgp
7311 @vindex gnus-article-hide-pgp-hook
7312 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). The
7313 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
7314 signature has been hidden. For example, to automatically verify
7315 articles that have signatures in them do:
7317 ;;; Hide pgp cruft if any.
7319 (setq gnus-treat-strip-pgp t)
7321 ;;; After hiding pgp, verify the message;
7322 ;;; only happens if pgp signature is found.
7324 (add-hook 'gnus-article-hide-pgp-hook
7327 (set-buffer gnus-original-article-buffer)
7332 @kindex W W P (Summary)
7333 @findex gnus-article-hide-pem
7334 Hide @sc{pem} (privacy enhanced messages) cruft
7335 (@code{gnus-article-hide-pem}).
7338 @kindex W W B (Summary)
7339 @findex gnus-article-strip-banner
7342 @cindex stripping advertisements
7343 @cindex advertisements
7344 Strip the banner specified by the @code{banner} group parameter
7345 (@code{gnus-article-strip-banner}). This is mainly used to hide those
7346 annoying banners and/or signatures that some mailing lists and moderated
7347 groups adds to all the messages. The way to use this function is to add
7348 the @code{banner} group parameter (@pxref{Group Parameters}) to the
7349 group you want banners stripped from. The parameter either be a string,
7350 which will be interpreted as a regular expression matching text to be
7351 removed, or the symbol @code{signature}, meaning that the (last)
7352 signature should be removed, or other symbol, meaning that the
7353 corresponding regular expression in @code{gnus-article-banner-alist} is
7357 @kindex W W c (Summary)
7358 @findex gnus-article-hide-citation
7359 Hide citation (@code{gnus-article-hide-citation}). Some variables for
7360 customizing the hiding:
7364 @item gnus-cited-opened-text-button-line-format
7365 @itemx gnus-cited-closed-text-button-line-format
7366 @vindex gnus-cited-closed-text-button-line-format
7367 @vindex gnus-cited-opened-text-button-line-format
7368 Gnus adds buttons to show where the cited text has been hidden, and to
7369 allow toggle hiding the text. The format of the variable is specified
7370 by these format-like variable (@pxref{Formatting Variables}). These
7375 Starting point of the hidden text.
7377 Ending point of the hidden text.
7379 Number of characters in the hidden region.
7381 Number of lines of hidden text.
7384 @item gnus-cited-lines-visible
7385 @vindex gnus-cited-lines-visible
7386 The number of lines at the beginning of the cited text to leave
7387 shown. This can also be a cons cell with the number of lines at the top
7388 and bottom of the text, respectively, to remain visible.
7393 @kindex W W C-c (Summary)
7394 @findex gnus-article-hide-citation-maybe
7396 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
7397 following two variables:
7400 @item gnus-cite-hide-percentage
7401 @vindex gnus-cite-hide-percentage
7402 If the cited text is of a bigger percentage than this variable (default
7403 50), hide the cited text.
7405 @item gnus-cite-hide-absolute
7406 @vindex gnus-cite-hide-absolute
7407 The cited text must have at least this length (default 10) before it
7412 @kindex W W C (Summary)
7413 @findex gnus-article-hide-citation-in-followups
7414 Hide cited text in articles that aren't roots
7415 (@code{gnus-article-hide-citation-in-followups}). This isn't very
7416 useful as an interactive command, but might be a handy function to stick
7417 have happen automatically (@pxref{Customizing Articles}).
7421 All these ``hiding'' commands are toggles, but if you give a negative
7422 prefix to these commands, they will show what they have previously
7423 hidden. If you give a positive prefix, they will always hide.
7425 Also @pxref{Article Highlighting} for further variables for
7426 citation customization.
7428 @xref{Customizing Articles}, for how to hide article elements
7432 @node Article Washing
7433 @subsection Article Washing
7435 @cindex article washing
7437 We call this ``article washing'' for a really good reason. Namely, the
7438 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
7440 @dfn{Washing} is defined by us as ``changing something from something to
7441 something else'', but normally results in something looking better.
7444 @xref{Customizing Articles}, if you want to change how Gnus displays
7445 articles by default.
7450 This is not really washing, it's sort of the opposite of washing. If
7451 you type this, you see the article exactly as it exists on disk or on
7455 @kindex W l (Summary)
7456 @findex gnus-summary-stop-page-breaking
7457 Remove page breaks from the current article
7458 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
7462 @kindex W r (Summary)
7463 @findex gnus-summary-caesar-message
7464 @c @icon{gnus-summary-caesar-message}
7465 Do a Caesar rotate (rot13) on the article buffer
7466 (@code{gnus-summary-caesar-message}).
7467 Unreadable articles that tell you to read them with Caesar rotate or rot13.
7468 (Typically offensive jokes and such.)
7470 It's commonly called ``rot13'' because each letter is rotated 13
7471 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
7472 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
7473 is rumored to have employed this form of, uh, somewhat weak encryption.
7477 @kindex W t (Summary)
7479 @findex gnus-article-toggle-headers
7480 Toggle whether to display all headers in the article buffer
7481 (@code{gnus-article-toggle-headers}).
7484 @kindex W v (Summary)
7485 @findex gnus-summary-verbose-header
7486 Toggle whether to display all headers in the article buffer permanently
7487 (@code{gnus-summary-verbose-header}).
7490 @kindex W m (Summary)
7491 @findex gnus-summary-toggle-mime
7492 Toggle whether to run the article through @sc{mime} before displaying
7493 (@code{gnus-summary-toggle-mime}).
7496 @kindex W o (Summary)
7497 @findex gnus-article-treat-overstrike
7498 Treat overstrike (@code{gnus-article-treat-overstrike}).
7501 @kindex W d (Summary)
7502 @findex gnus-article-treat-dumbquotes
7503 @vindex gnus-article-dumbquotes-map
7505 @cindex M****s*** sm*rtq**t*s
7507 Treat M****s*** sm*rtq**t*s according to
7508 @code{gnus-article-dumbquotes-map}
7509 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
7510 whether a character is a sm*rtq**t* or not, so it should only be used
7513 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
7514 an attempt to provide more quoting characters. If you see something
7515 like @code{\222} or @code{\264} where you're expecting some kind of
7516 apostrophe or quotation mark, then try this wash.
7519 @kindex W w (Summary)
7520 @findex gnus-article-fill-cited-article
7521 Do word wrap (@code{gnus-article-fill-cited-article}).
7523 You can give the command a numerical prefix to specify the width to use
7527 @kindex W Q (Summary)
7528 @findex gnus-article-fill-long-lines
7529 Fill long lines (@code{gnus-article-fill-long-lines}).
7532 @kindex W C (Summary)
7533 @findex gnus-article-capitalize-sentences
7534 Capitalize the first word in each sentence
7535 (@code{gnus-article-capitalize-sentences}).
7538 @kindex W c (Summary)
7539 @findex gnus-article-remove-cr
7540 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
7541 (this takes care of DOS line endings), and then translate any remaining
7542 CRs into LF (this takes care of Mac line endings)
7543 (@code{gnus-article-remove-cr}).
7546 @kindex W 6 (Summary)
7547 @findex gnus-article-de-base64-unreadable
7548 Treat base64 (@code{gnus-article-de-base64-unreadable}).
7549 Base64 is one common @sc{mime} encoding employed when sending non-ASCII
7550 (i. e., 8-bit) articles. Note that the this is usually done
7551 automatically by Gnus if the message in question has a
7552 @code{Content-Transfer-Encoding} header that says that this encoding has
7554 If a prefix is given, a charset will be asked for.
7557 @kindex W Z (Summary)
7558 @findex gnus-article-decode-HZ
7559 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
7560 common encoding employed when sending Chinese articles. It typically
7561 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
7564 @kindex W h (Summary)
7565 @findex gnus-article-wash-html
7566 Treat HTML (@code{gnus-article-wash-html}).
7567 Note that the this is usually done automatically by Gnus if the message
7568 in question has a @code{Content-Type} header that says that this type
7570 If a prefix is given, a charset will be asked for.
7573 @kindex W f (Summary)
7575 @findex gnus-article-display-x-face
7576 @findex gnus-article-x-face-command
7577 @vindex gnus-article-x-face-command
7578 @vindex gnus-article-x-face-too-ugly
7585 Look for and display any X-Face headers
7586 (@code{gnus-article-display-x-face}). The command executed by this
7587 function is given by the @code{gnus-article-x-face-command} variable.
7588 If this variable is a string, this string will be executed in a
7589 sub-shell. If it is a function, this function will be called with the
7590 face as the argument. If the @code{gnus-article-x-face-too-ugly} (which
7591 is a regexp) matches the @code{From} header, the face will not be shown.
7592 The default action under Emacs is to fork off the @code{display}
7593 program@footnote{@code{display} is from the ImageMagick package. For the
7594 @code{uncompface} and @code{icontopbm} programs look for a package
7595 like `compface' or `faces-xface' on a GNU/Linux system.}
7596 to view the face. Under XEmacs or Emacs 21+ with suitable image
7597 support, the default action is to display the face before the
7598 @code{From} header. (It's nicer if XEmacs has been compiled with X-Face
7599 support---that will make display somewhat faster. If there's no native
7600 X-Face support, Gnus will try to convert the @code{X-Face} header using
7601 external programs from the @code{pbmplus} package and
7602 friends.@footnote{On a GNU/Linux system look for packages with names
7603 like @code{netpbm} or @code{libgr-progs}.}) If you
7604 want to have this function in the display hook, it should probably come
7608 @kindex W b (Summary)
7609 @findex gnus-article-add-buttons
7610 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
7611 @xref{Article Buttons}.
7614 @kindex W B (Summary)
7615 @findex gnus-article-add-buttons-to-head
7616 Add clickable buttons to the article headers
7617 (@code{gnus-article-add-buttons-to-head}).
7620 @kindex W p (Summary)
7621 @findex gnus-article-verify-x-pgp-sig
7622 Verify a signed control message (@code{gnus-article-verify-x-pgp-sig}).
7623 Control messages such as @code{newgroup} and @code{checkgroups} are
7624 usually signed by the hierarchy maintainer. You need to add the PGP
7625 public key of the maintainer to your keyring to verify the
7626 message.@footnote{PGP keys for many hierarchies are available at
7627 @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
7630 @kindex W W H (Summary)
7631 @findex gnus-article-strip-headers-from-body
7632 Strip headers like the @code{X-No-Archive} header from the beginning of
7633 article bodies (@code{gnus-article-strip-headers-from-body}).
7636 @kindex W E l (Summary)
7637 @findex gnus-article-strip-leading-blank-lines
7638 Remove all blank lines from the beginning of the article
7639 (@code{gnus-article-strip-leading-blank-lines}).
7642 @kindex W E m (Summary)
7643 @findex gnus-article-strip-multiple-blank-lines
7644 Replace all blank lines with empty lines and then all multiple empty
7645 lines with a single empty line.
7646 (@code{gnus-article-strip-multiple-blank-lines}).
7649 @kindex W E t (Summary)
7650 @findex gnus-article-remove-trailing-blank-lines
7651 Remove all blank lines at the end of the article
7652 (@code{gnus-article-remove-trailing-blank-lines}).
7655 @kindex W E a (Summary)
7656 @findex gnus-article-strip-blank-lines
7657 Do all the three commands above
7658 (@code{gnus-article-strip-blank-lines}).
7661 @kindex W E A (Summary)
7662 @findex gnus-article-strip-all-blank-lines
7663 Remove all blank lines
7664 (@code{gnus-article-strip-all-blank-lines}).
7667 @kindex W E s (Summary)
7668 @findex gnus-article-strip-leading-space
7669 Remove all white space from the beginning of all lines of the article
7670 body (@code{gnus-article-strip-leading-space}).
7673 @kindex W E e (Summary)
7674 @findex gnus-article-strip-trailing-space
7675 Remove all white space from the end of all lines of the article
7676 body (@code{gnus-article-strip-trailing-space}).
7680 @xref{Customizing Articles}, for how to wash articles automatically.
7683 @node Article Buttons
7684 @subsection Article Buttons
7687 People often include references to other stuff in articles, and it would
7688 be nice if Gnus could just fetch whatever it is that people talk about
7689 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
7690 button on these references.
7692 Gnus adds @dfn{buttons} to certain standard references by default:
7693 Well-formed URLs, mail addresses and Message-IDs. This is controlled by
7694 two variables, one that handles article bodies and one that handles
7699 @item gnus-button-alist
7700 @vindex gnus-button-alist
7701 This is an alist where each entry has this form:
7704 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
7710 All text that match this regular expression will be considered an
7711 external reference. Here's a typical regexp that matches embedded URLs:
7712 @samp{<URL:\\([^\n\r>]*\\)>}.
7715 Gnus has to know which parts of the matches is to be highlighted. This
7716 is a number that says what sub-expression of the regexp is to be
7717 highlighted. If you want it all highlighted, you use 0 here.
7720 This form will be @code{eval}ed, and if the result is non-@code{nil},
7721 this is considered a match. This is useful if you want extra sifting to
7722 avoid false matches.
7725 This function will be called when you click on this button.
7728 As with @var{button-par}, this is a sub-expression number, but this one
7729 says which part of the match is to be sent as data to @var{function}.
7733 So the full entry for buttonizing URLs is then
7736 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
7739 @item gnus-header-button-alist
7740 @vindex gnus-header-button-alist
7741 This is just like the other alist, except that it is applied to the
7742 article head only, and that each entry has an additional element that is
7743 used to say what headers to apply the buttonize coding to:
7746 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
7749 @var{header} is a regular expression.
7751 @item gnus-button-url-regexp
7752 @vindex gnus-button-url-regexp
7753 A regular expression that matches embedded URLs. It is used in the
7754 default values of the variables above.
7756 @item gnus-article-button-face
7757 @vindex gnus-article-button-face
7758 Face used on buttons.
7760 @item gnus-article-mouse-face
7761 @vindex gnus-article-mouse-face
7762 Face used when the mouse cursor is over a button.
7766 @xref{Customizing Articles}, for how to buttonize articles automatically.
7770 @subsection Article Date
7772 The date is most likely generated in some obscure timezone you've never
7773 heard of, so it's quite nice to be able to find out what the time was
7774 when the article was sent.
7779 @kindex W T u (Summary)
7780 @findex gnus-article-date-ut
7781 Display the date in UT (aka. GMT, aka ZULU)
7782 (@code{gnus-article-date-ut}).
7785 @kindex W T i (Summary)
7786 @findex gnus-article-date-iso8601
7788 Display the date in international format, aka. ISO 8601
7789 (@code{gnus-article-date-iso8601}).
7792 @kindex W T l (Summary)
7793 @findex gnus-article-date-local
7794 Display the date in the local timezone (@code{gnus-article-date-local}).
7797 @kindex W T p (Summary)
7798 @findex gnus-article-date-english
7799 Display the date in a format that's easily pronounceable in English
7800 (@code{gnus-article-date-english}).
7803 @kindex W T s (Summary)
7804 @vindex gnus-article-time-format
7805 @findex gnus-article-date-user
7806 @findex format-time-string
7807 Display the date using a user-defined format
7808 (@code{gnus-article-date-user}). The format is specified by the
7809 @code{gnus-article-time-format} variable, and is a string that's passed
7810 to @code{format-time-string}. See the documentation of that variable
7811 for a list of possible format specs.
7814 @kindex W T e (Summary)
7815 @findex gnus-article-date-lapsed
7816 @findex gnus-start-date-timer
7817 @findex gnus-stop-date-timer
7818 Say how much time has elapsed between the article was posted and now
7819 (@code{gnus-article-date-lapsed}). It looks something like:
7822 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
7825 The value of @code{gnus-article-date-lapsed-new-header} determines
7826 whether this header will just be added below the old Date one, or will
7829 An advantage of using Gnus to read mail is that it converts simple bugs
7830 into wonderful absurdities.
7832 If you want to have this line updated continually, you can put
7835 (gnus-start-date-timer)
7838 in your @file{.gnus.el} file, or you can run it off of some hook. If
7839 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
7843 @kindex W T o (Summary)
7844 @findex gnus-article-date-original
7845 Display the original date (@code{gnus-article-date-original}). This can
7846 be useful if you normally use some other conversion function and are
7847 worried that it might be doing something totally wrong. Say, claiming
7848 that the article was posted in 1854. Although something like that is
7849 @emph{totally} impossible. Don't you trust me? *titter*
7853 @xref{Customizing Articles}, for how to display the date in your
7854 preferred format automatically.
7857 @node Article Signature
7858 @subsection Article Signature
7860 @cindex article signature
7862 @vindex gnus-signature-separator
7863 Each article is divided into two parts---the head and the body. The
7864 body can be divided into a signature part and a text part. The variable
7865 that says what is to be considered a signature is
7866 @code{gnus-signature-separator}. This is normally the standard
7867 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
7868 non-standard signature separators, so this variable can also be a list
7869 of regular expressions to be tested, one by one. (Searches are done
7870 from the end of the body towards the beginning.) One likely value is:
7873 (setq gnus-signature-separator
7874 '("^-- $" ; The standard
7875 "^-- *$" ; A common mangling
7876 "^-------*$" ; Many people just use a looong
7877 ; line of dashes. Shame!
7878 "^ *--------*$" ; Double-shame!
7879 "^________*$" ; Underscores are also popular
7880 "^========*$")) ; Pervert!
7883 The more permissive you are, the more likely it is that you'll get false
7886 @vindex gnus-signature-limit
7887 @code{gnus-signature-limit} provides a limit to what is considered a
7888 signature when displaying articles.
7892 If it is an integer, no signature may be longer (in characters) than
7895 If it is a floating point number, no signature may be longer (in lines)
7898 If it is a function, the function will be called without any parameters,
7899 and if it returns @code{nil}, there is no signature in the buffer.
7901 If it is a string, it will be used as a regexp. If it matches, the text
7902 in question is not a signature.
7905 This variable can also be a list where the elements may be of the types
7906 listed above. Here's an example:
7909 (setq gnus-signature-limit
7910 '(200.0 "^---*Forwarded article"))
7913 This means that if there are more than 200 lines after the signature
7914 separator, or the text after the signature separator is matched by
7915 the regular expression @samp{^---*Forwarded article}, then it isn't a
7916 signature after all.
7919 @node Article Miscellania
7920 @subsection Article Miscellania
7924 @kindex A t (Summary)
7925 @findex gnus-article-babel
7926 Translate the article from one language to another
7927 (@code{gnus-article-babel}).
7933 @section @sc{mime} Commands
7934 @cindex MIME decoding
7936 @cindex viewing attachments
7938 The following commands all understand the numerical prefix. For
7939 instance, @kbd{3 b} means ``view the third @sc{mime} part''.
7945 @kindex K v (Summary)
7946 View the @sc{mime} part.
7949 @kindex K o (Summary)
7950 Save the @sc{mime} part.
7953 @kindex K c (Summary)
7954 Copy the @sc{mime} part.
7957 @kindex K e (Summary)
7958 View the @sc{mime} part externally.
7961 @kindex K i (Summary)
7962 View the @sc{mime} part internally.
7965 @kindex K | (Summary)
7966 Pipe the @sc{mime} part to an external command.
7969 The rest of these @sc{mime} commands do not use the numerical prefix in
7974 @kindex K b (Summary)
7975 Make all the @sc{mime} parts have buttons in front of them. This is
7976 mostly useful if you wish to save (or perform other actions) on inlined
7980 @kindex K m (Summary)
7981 @findex gnus-summary-repair-multipart
7982 Some multipart messages are transmitted with missing or faulty headers.
7983 This command will attempt to ``repair'' these messages so that they can
7984 be viewed in a more pleasant manner
7985 (@code{gnus-summary-repair-multipart}).
7988 @kindex X m (Summary)
7989 @findex gnus-summary-save-parts
7990 Save all parts matching a @sc{mime} type to a directory
7991 (@code{gnus-summary-save-parts}). Understands the process/prefix
7992 convention (@pxref{Process/Prefix}).
7995 @kindex M-t (Summary)
7996 @findex gnus-summary-display-buttonized
7997 Toggle the buttonized display of the article buffer
7998 (@code{gnus-summary-toggle-display-buttonized}).
8001 @kindex W M w (Summary)
8002 Decode RFC 2047-encoded words in the article headers
8003 (@code{gnus-article-decode-mime-words}).
8006 @kindex W M c (Summary)
8007 Decode encoded article bodies as well as charsets
8008 (@code{gnus-article-decode-charset}).
8010 This command looks in the @code{Content-Type} header to determine the
8011 charset. If there is no such header in the article, you can give it a
8012 prefix, which will prompt for the charset to decode as. In regional
8013 groups where people post using some common encoding (but do not include
8014 MIME headers), you can set the @code{charset} group/topic parameter to
8015 the required charset (@pxref{Group Parameters}).
8018 @kindex W M v (Summary)
8019 View all the @sc{mime} parts in the current article
8020 (@code{gnus-mime-view-all-parts}).
8027 @item gnus-ignored-mime-types
8028 @vindex gnus-ignored-mime-types
8029 This is a list of regexps. @sc{mime} types that match a regexp from
8030 this list will be completely ignored by Gnus. The default value is
8033 To have all Vcards be ignored, you'd say something like this:
8036 (setq gnus-ignored-mime-types
8040 @item gnus-unbuttonized-mime-types
8041 @vindex gnus-unbuttonized-mime-types
8042 This is a list of regexps. @sc{mime} types that match a regexp from
8043 this list won't have @sc{mime} buttons inserted unless they aren't
8044 displayed. The default value is @code{(".*/.*")}.
8046 @item gnus-article-mime-part-function
8047 @vindex gnus-article-mime-part-function
8048 For each @sc{mime} part, this function will be called with the @sc{mime}
8049 handle as the parameter. The function is meant to be used to allow
8050 users to gather information from the article (e. g., add Vcard info to
8051 the bbdb database) or to do actions based on parts (e. g., automatically
8052 save all jpegs into some directory).
8054 Here's an example function the does the latter:
8057 (defun my-save-all-jpeg-parts (handle)
8058 (when (equal (car (mm-handle-type handle)) "image/jpeg")
8060 (insert (mm-get-part handle))
8061 (write-region (point-min) (point-max)
8062 (read-file-name "Save jpeg to: ")))))
8063 (setq gnus-article-mime-part-function
8064 'my-save-all-jpeg-parts)
8067 @vindex gnus-mime-multipart-functions
8068 @item gnus-mime-multipart-functions
8069 Alist of @sc{mime} multipart types and functions to handle them.
8071 @vindex mm-file-name-rewrite-functions
8072 @item mm-file-name-rewrite-functions
8073 List of functions used for rewriting file names of @sc{mime} parts.
8074 Each function takes a file name as input and returns a file name.
8076 Ready-made functions include@*
8077 @code{mm-file-name-delete-whitespace},
8078 @code{mm-file-name-trim-whitespace},
8079 @code{mm-file-name-collapse-whitespace}, and
8080 @code{mm-file-name-replace-whitespace}. The later uses the value of
8081 the variable @code{mm-file-name-replace-whitespace} to replace each
8082 whitespace character in a file name with that string; default value
8083 is @code{"_"} (a single underscore).
8084 @findex mm-file-name-delete-whitespace
8085 @findex mm-file-name-trim-whitespace
8086 @findex mm-file-name-collapse-whitespace
8087 @findex mm-file-name-replace-whitespace
8088 @vindex mm-file-name-replace-whitespace
8090 The standard functions @code{capitalize}, @code{downcase},
8091 @code{upcase}, and @code{upcase-initials} may be useful, too.
8093 Everybody knows that whitespace characters in file names are evil,
8094 except those who don't know. If you receive lots of attachments from
8095 such unenlightened users, you can make live easier by adding
8098 (setq mm-file-name-rewrite-functions
8099 '(mm-file-name-trim-whitespace
8100 mm-file-name-collapse-whitespace
8101 mm-file-name-replace-whitespace))
8105 to your @file{.gnus} file.
8114 People use different charsets, and we have @sc{mime} to let us know what
8115 charsets they use. Or rather, we wish we had. Many people use
8116 newsreaders and mailers that do not understand or use @sc{mime}, and
8117 just send out messages without saying what character sets they use. To
8118 help a bit with this, some local news hierarchies have policies that say
8119 what character set is the default. For instance, the @samp{fj}
8120 hierarchy uses @code{iso-2022-jp-2}.
8122 @vindex gnus-group-charset-alist
8123 This knowledge is encoded in the @code{gnus-group-charset-alist}
8124 variable, which is an alist of regexps (to match full group names) and
8125 default charsets to be used when reading these groups.
8127 In addition, some people do use soi-disant @sc{mime}-aware agents that
8128 aren't. These blithely mark messages as being in @code{iso-8859-1} even
8129 if they really are in @code{koi-8}. To help here, the
8130 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
8131 charsets that are listed here will be ignored. The variable can be set
8132 on a group-by-group basis using the group parameters (@pxref{Group
8133 Parameters}). The default value is @code{(unknown-8bit)}, which is
8134 something some agents insist on having in there.
8136 @vindex gnus-group-posting-charset-alist
8137 When posting, @code{gnus-group-posting-charset-alist} is used to
8138 determine which charsets should not be encoded using the @sc{mime}
8139 encodings. For instance, some hierarchies discourage using
8140 quoted-printable header encoding.
8142 This variable is an alist of regexps and permitted unencoded charsets
8143 for posting. Each element of the alist has the form @code{(}@var{test
8144 header body-list}@code{)}, where:
8148 is either a regular expression matching the newsgroup header or a
8151 is the charset which may be left unencoded in the header (@code{nil}
8152 means encode all charsets),
8154 is a list of charsets which may be encoded using 8bit content-transfer
8155 encoding in the body, or one of the special values @code{nil} (always
8156 encode using quoted-printable) or @code{t} (always use 8bit).
8163 @cindex coding system aliases
8164 @cindex preferred charset
8166 Other charset tricks that may be useful, although not Gnus-specific:
8168 If there are several @sc{mime} charsets that encode the same Emacs
8169 charset, you can choose what charset to use by saying the following:
8172 (put-charset-property 'cyrillic-iso8859-5
8173 'preferred-coding-system 'koi8-r)
8176 This means that Russian will be encoded using @code{koi8-r} instead of
8177 the default @code{iso-8859-5} @sc{mime} charset.
8179 If you want to read messages in @code{koi8-u}, you can cheat and say
8182 (define-coding-system-alias 'koi8-u 'koi8-r)
8185 This will almost do the right thing.
8187 And finally, to read charsets like @code{windows-1251}, you can say
8191 (codepage-setup 1251)
8192 (define-coding-system-alias 'windows-1251 'cp1251)
8196 @node Article Commands
8197 @section Article Commands
8204 @kindex A P (Summary)
8205 @vindex gnus-ps-print-hook
8206 @findex gnus-summary-print-article
8207 Generate and print a PostScript image of the article buffer
8208 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be
8209 run just before printing the buffer.
8214 @node Summary Sorting
8215 @section Summary Sorting
8216 @cindex summary sorting
8218 You can have the summary buffer sorted in various ways, even though I
8219 can't really see why you'd want that.
8224 @kindex C-c C-s C-n (Summary)
8225 @findex gnus-summary-sort-by-number
8226 Sort by article number (@code{gnus-summary-sort-by-number}).
8229 @kindex C-c C-s C-a (Summary)
8230 @findex gnus-summary-sort-by-author
8231 Sort by author (@code{gnus-summary-sort-by-author}).
8234 @kindex C-c C-s C-s (Summary)
8235 @findex gnus-summary-sort-by-subject
8236 Sort by subject (@code{gnus-summary-sort-by-subject}).
8239 @kindex C-c C-s C-d (Summary)
8240 @findex gnus-summary-sort-by-date
8241 Sort by date (@code{gnus-summary-sort-by-date}).
8244 @kindex C-c C-s C-l (Summary)
8245 @findex gnus-summary-sort-by-lines
8246 Sort by lines (@code{gnus-summary-sort-by-lines}).
8249 @kindex C-c C-s C-c (Summary)
8250 @findex gnus-summary-sort-by-chars
8251 Sort by article length (@code{gnus-summary-sort-by-chars}).
8254 @kindex C-c C-s C-i (Summary)
8255 @findex gnus-summary-sort-by-score
8256 Sort by score (@code{gnus-summary-sort-by-score}).
8259 @kindex C-c C-s C-o (Summary)
8260 @findex gnus-summary-sort-by-original
8261 Sort using the default sorting method
8262 (@code{gnus-summary-sort-by-original}).
8265 These functions will work both when you use threading and when you don't
8266 use threading. In the latter case, all summary lines will be sorted,
8267 line by line. In the former case, sorting will be done on a
8268 root-by-root basis, which might not be what you were looking for. To
8269 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
8273 @node Finding the Parent
8274 @section Finding the Parent
8275 @cindex parent articles
8276 @cindex referring articles
8281 @findex gnus-summary-refer-parent-article
8282 If you'd like to read the parent of the current article, and it is not
8283 displayed in the summary buffer, you might still be able to. That is,
8284 if the current group is fetched by @sc{nntp}, the parent hasn't expired
8285 and the @code{References} in the current article are not mangled, you
8286 can just press @kbd{^} or @kbd{A r}
8287 (@code{gnus-summary-refer-parent-article}). If everything goes well,
8288 you'll get the parent. If the parent is already displayed in the
8289 summary buffer, point will just move to this article.
8291 If given a positive numerical prefix, fetch that many articles back into
8292 the ancestry. If given a negative numerical prefix, fetch just that
8293 ancestor. So if you say @kbd{3 ^}, gnus will fetch the parent, the
8294 grandparent and the grandgrandparent of the current article. If you say
8295 @kbd{-3 ^}, gnus will only fetch the grandgrandparent of the current
8299 @findex gnus-summary-refer-references
8300 @kindex A R (Summary)
8301 Fetch all articles mentioned in the @code{References} header of the
8302 article (@code{gnus-summary-refer-references}).
8305 @findex gnus-summary-refer-thread
8306 @kindex A T (Summary)
8307 Display the full thread where the current article appears
8308 (@code{gnus-summary-refer-thread}). This command has to fetch all the
8309 headers in the current group to work, so it usually takes a while. If
8310 you do it often, you may consider setting @code{gnus-fetch-old-headers}
8311 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
8312 visible effects normally, but it'll make this command work a whole lot
8313 faster. Of course, it'll make group entry somewhat slow.
8315 @vindex gnus-refer-thread-limit
8316 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
8317 articles before the first displayed in the current group) headers to
8318 fetch when doing this command. The default is 200. If @code{t}, all
8319 the available headers will be fetched. This variable can be overridden
8320 by giving the @kbd{A T} command a numerical prefix.
8323 @findex gnus-summary-refer-article
8324 @kindex M-^ (Summary)
8326 @cindex fetching by Message-ID
8327 You can also ask the @sc{nntp} server for an arbitrary article, no
8328 matter what group it belongs to. @kbd{M-^}
8329 (@code{gnus-summary-refer-article}) will ask you for a
8330 @code{Message-ID}, which is one of those long, hard-to-read thingies
8331 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
8332 have to get it all exactly right. No fuzzy searches, I'm afraid.
8335 The current select method will be used when fetching by
8336 @code{Message-ID} from non-news select method, but you can override this
8337 by giving this command a prefix.
8339 @vindex gnus-refer-article-method
8340 If the group you are reading is located on a backend that does not
8341 support fetching by @code{Message-ID} very well (like @code{nnspool}),
8342 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
8343 would, perhaps, be best if the @sc{nntp} server you consult is the one
8344 updating the spool you are reading from, but that's not really
8347 It can also be a list of select methods, as well as the special symbol
8348 @code{current}, which means to use the current select method. If it
8349 is a list, Gnus will try all the methods in the list until it finds a
8352 Here's an example setting that will first try the current method, and
8353 then ask Deja if that fails:
8356 (setq gnus-refer-article-method
8358 (nnweb "refer" (nnweb-type dejanews))))
8361 Most of the mail backends support fetching by @code{Message-ID}, but do
8362 not do a particularly excellent job at it. That is, @code{nnmbox} and
8363 @code{nnbabyl} are able to locate articles from any groups, while
8364 @code{nnml} and @code{nnfolder} are only able to locate articles that
8365 have been posted to the current group. (Anything else would be too time
8366 consuming.) @code{nnmh} does not support this at all.
8369 @node Alternative Approaches
8370 @section Alternative Approaches
8372 Different people like to read news using different methods. This being
8373 gnus, we offer a small selection of minor modes for the summary buffers.
8376 * Pick and Read:: First mark articles and then read them.
8377 * Binary Groups:: Auto-decode all articles.
8382 @subsection Pick and Read
8383 @cindex pick and read
8385 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
8386 a two-phased reading interface. The user first marks in a summary
8387 buffer the articles she wants to read. Then she starts reading the
8388 articles with just an article buffer displayed.
8390 @findex gnus-pick-mode
8391 @kindex M-x gnus-pick-mode
8392 Gnus provides a summary buffer minor mode that allows
8393 this---@code{gnus-pick-mode}. This basically means that a few process
8394 mark commands become one-keystroke commands to allow easy marking, and
8395 it provides one additional command for switching to the summary buffer.
8397 Here are the available keystrokes when using pick mode:
8402 @findex gnus-pick-article-or-thread
8403 Pick the article or thread on the current line
8404 (@code{gnus-pick-article-or-thread}). If the variable
8405 @code{gnus-thread-hide-subtree} is true, then this key selects the
8406 entire thread when used at the first article of the thread. Otherwise,
8407 it selects just the article. If given a numerical prefix, go to that
8408 thread or article and pick it. (The line number is normally displayed
8409 at the beginning of the summary pick lines.)
8412 @kindex SPACE (Pick)
8413 @findex gnus-pick-next-page
8414 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
8415 at the end of the buffer, start reading the picked articles.
8419 @findex gnus-pick-unmark-article-or-thread.
8420 Unpick the thread or article
8421 (@code{gnus-pick-unmark-article-or-thread}). If the variable
8422 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
8423 thread if used at the first article of the thread. Otherwise it unpicks
8424 just the article. You can give this key a numerical prefix to unpick
8425 the thread or article at that line.
8429 @findex gnus-pick-start-reading
8430 @vindex gnus-pick-display-summary
8431 Start reading the picked articles (@code{gnus-pick-start-reading}). If
8432 given a prefix, mark all unpicked articles as read first. If
8433 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
8434 will still be visible when you are reading.
8438 All the normal summary mode commands are still available in the
8439 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
8440 which is mapped to the same function
8441 @code{gnus-summary-tick-article-forward}.
8443 If this sounds like a good idea to you, you could say:
8446 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
8449 @vindex gnus-pick-mode-hook
8450 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
8452 @vindex gnus-mark-unpicked-articles-as-read
8453 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
8454 all unpicked articles as read. The default is @code{nil}.
8456 @vindex gnus-summary-pick-line-format
8457 The summary line format in pick mode is slightly different from the
8458 standard format. At the beginning of each line the line number is
8459 displayed. The pick mode line format is controlled by the
8460 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
8461 Variables}). It accepts the same format specs that
8462 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
8466 @subsection Binary Groups
8467 @cindex binary groups
8469 @findex gnus-binary-mode
8470 @kindex M-x gnus-binary-mode
8471 If you spend much time in binary groups, you may grow tired of hitting
8472 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
8473 is a minor mode for summary buffers that makes all ordinary Gnus article
8474 selection functions uudecode series of articles and display the result
8475 instead of just displaying the articles the normal way.
8478 @findex gnus-binary-show-article
8479 The only way, in fact, to see the actual articles is the @kbd{g}
8480 command, when you have turned on this mode
8481 (@code{gnus-binary-show-article}).
8483 @vindex gnus-binary-mode-hook
8484 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
8488 @section Tree Display
8491 @vindex gnus-use-trees
8492 If you don't like the normal gnus summary display, you might try setting
8493 @code{gnus-use-trees} to @code{t}. This will create (by default) an
8494 additional @dfn{tree buffer}. You can execute all summary mode commands
8497 There are a few variables to customize the tree display, of course:
8500 @item gnus-tree-mode-hook
8501 @vindex gnus-tree-mode-hook
8502 A hook called in all tree mode buffers.
8504 @item gnus-tree-mode-line-format
8505 @vindex gnus-tree-mode-line-format
8506 A format string for the mode bar in the tree mode buffers (@pxref{Mode
8507 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
8508 of valid specs, @pxref{Summary Buffer Mode Line}.
8510 @item gnus-selected-tree-face
8511 @vindex gnus-selected-tree-face
8512 Face used for highlighting the selected article in the tree buffer. The
8513 default is @code{modeline}.
8515 @item gnus-tree-line-format
8516 @vindex gnus-tree-line-format
8517 A format string for the tree nodes. The name is a bit of a misnomer,
8518 though---it doesn't define a line, but just the node. The default value
8519 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
8520 the name of the poster. It is vital that all nodes are of the same
8521 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
8527 The name of the poster.
8529 The @code{From} header.
8531 The number of the article.
8533 The opening bracket.
8535 The closing bracket.
8540 @xref{Formatting Variables}.
8542 Variables related to the display are:
8545 @item gnus-tree-brackets
8546 @vindex gnus-tree-brackets
8547 This is used for differentiating between ``real'' articles and
8548 ``sparse'' articles. The format is @code{((@var{real-open} . @var{real-close})
8549 (@var{sparse-open} . @var{sparse-close}) (@var{dummy-open} . @var{dummy-close}))}, and the
8550 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
8552 @item gnus-tree-parent-child-edges
8553 @vindex gnus-tree-parent-child-edges
8554 This is a list that contains the characters used for connecting parent
8555 nodes to their children. The default is @code{(?- ?\\ ?|)}.
8559 @item gnus-tree-minimize-window
8560 @vindex gnus-tree-minimize-window
8561 If this variable is non-@code{nil}, gnus will try to keep the tree
8562 buffer as small as possible to allow more room for the other gnus
8563 windows. If this variable is a number, the tree buffer will never be
8564 higher than that number. The default is @code{t}. Note that if you
8565 have several windows displayed side-by-side in a frame and the tree
8566 buffer is one of these, minimizing the tree window will also resize all
8567 other windows displayed next to it.
8569 @item gnus-generate-tree-function
8570 @vindex gnus-generate-tree-function
8571 @findex gnus-generate-horizontal-tree
8572 @findex gnus-generate-vertical-tree
8573 The function that actually generates the thread tree. Two predefined
8574 functions are available: @code{gnus-generate-horizontal-tree} and
8575 @code{gnus-generate-vertical-tree} (which is the default).
8579 Here's an example from a horizontal tree buffer:
8582 @{***@}-(***)-[odd]-[Gun]
8592 Here's the same thread displayed in a vertical tree buffer:
8596 |--------------------------\-----\-----\
8597 (***) [Bjo] [Gun] [Gun]
8599 [odd] [Jan] [odd] (***) [Jor]
8601 [Gun] [Eri] [Eri] [odd]
8606 If you're using horizontal trees, it might be nice to display the trees
8607 side-by-side with the summary buffer. You could add something like the
8608 following to your @file{.gnus.el} file:
8611 (setq gnus-use-trees t
8612 gnus-generate-tree-function 'gnus-generate-horizontal-tree
8613 gnus-tree-minimize-window nil)
8614 (gnus-add-configuration
8618 (summary 0.75 point)
8623 @xref{Windows Configuration}.
8626 @node Mail Group Commands
8627 @section Mail Group Commands
8628 @cindex mail group commands
8630 Some commands only make sense in mail groups. If these commands are
8631 invalid in the current group, they will raise a hell and let you know.
8633 All these commands (except the expiry and edit commands) use the
8634 process/prefix convention (@pxref{Process/Prefix}).
8639 @kindex B e (Summary)
8640 @findex gnus-summary-expire-articles
8641 Run all expirable articles in the current group through the expiry
8642 process (@code{gnus-summary-expire-articles}). That is, delete all
8643 expirable articles in the group that have been around for a while.
8644 (@pxref{Expiring Mail}).
8647 @kindex B M-C-e (Summary)
8648 @findex gnus-summary-expire-articles-now
8649 Delete all the expirable articles in the group
8650 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
8651 articles eligible for expiry in the current group will
8652 disappear forever into that big @file{/dev/null} in the sky.
8655 @kindex B DEL (Summary)
8656 @findex gnus-summary-delete-article
8657 @c @icon{gnus-summary-mail-delete}
8658 Delete the mail article. This is ``delete'' as in ``delete it from your
8659 disk forever and ever, never to return again.'' Use with caution.
8660 (@code{gnus-summary-delete-article}).
8663 @kindex B m (Summary)
8665 @findex gnus-summary-move-article
8666 @vindex gnus-preserve-marks
8667 Move the article from one mail group to another
8668 (@code{gnus-summary-move-article}). Marks will be preserved if
8669 @var{gnus-preserve-marks} is non-@code{nil} (which is the default).
8672 @kindex B c (Summary)
8674 @findex gnus-summary-copy-article
8675 @c @icon{gnus-summary-mail-copy}
8676 Copy the article from one group (mail group or not) to a mail group
8677 (@code{gnus-summary-copy-article}). Marks will be preserved if
8678 @var{gnus-preserve-marks} is non-@code{nil} (which is the default).
8681 @kindex B B (Summary)
8682 @cindex crosspost mail
8683 @findex gnus-summary-crosspost-article
8684 Crosspost the current article to some other group
8685 (@code{gnus-summary-crosspost-article}). This will create a new copy of
8686 the article in the other group, and the Xref headers of the article will
8687 be properly updated.
8690 @kindex B i (Summary)
8691 @findex gnus-summary-import-article
8692 Import an arbitrary file into the current mail newsgroup
8693 (@code{gnus-summary-import-article}). You will be prompted for a file
8694 name, a @code{From} header and a @code{Subject} header.
8697 @kindex B r (Summary)
8698 @findex gnus-summary-respool-article
8699 Respool the mail article (@code{gnus-summary-respool-article}).
8700 @code{gnus-summary-respool-default-method} will be used as the default
8701 select method when respooling. This variable is @code{nil} by default,
8702 which means that the current group select method will be used instead.
8703 Marks will be preserved if @var{gnus-preserve-marks} is non-@code{nil}
8704 (which is the default).
8708 @kindex B w (Summary)
8710 @findex gnus-summary-edit-article
8711 @kindex C-c C-c (Article)
8712 Edit the current article (@code{gnus-summary-edit-article}). To finish
8713 editing and make the changes permanent, type @kbd{C-c C-c}
8714 (@kbd{gnus-summary-edit-article-done}). If you give a prefix to the
8715 @kbd{C-c C-c} command, gnus won't re-highlight the article.
8718 @kindex B q (Summary)
8719 @findex gnus-summary-respool-query
8720 If you want to re-spool an article, you might be curious as to what group
8721 the article will end up in before you do the re-spooling. This command
8722 will tell you (@code{gnus-summary-respool-query}).
8725 @kindex B t (Summary)
8726 @findex gnus-summary-respool-trace
8727 Similarly, this command will display all fancy splitting patterns used
8728 when repooling, if any (@code{gnus-summary-respool-trace}).
8731 @kindex B p (Summary)
8732 @findex gnus-summary-article-posted-p
8733 Some people have a tendency to send you "courtesy" copies when they
8734 follow up to articles you have posted. These usually have a
8735 @code{Newsgroups} header in them, but not always. This command
8736 (@code{gnus-summary-article-posted-p}) will try to fetch the current
8737 article from your news server (or rather, from
8738 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
8739 report back whether it found the article or not. Even if it says that
8740 it didn't find the article, it may have been posted anyway---mail
8741 propagation is much faster than news propagation, and the news copy may
8742 just not have arrived yet.
8746 @vindex gnus-move-split-methods
8747 @cindex moving articles
8748 If you move (or copy) articles regularly, you might wish to have gnus
8749 suggest where to put the articles. @code{gnus-move-split-methods} is a
8750 variable that uses the same syntax as @code{gnus-split-methods}
8751 (@pxref{Saving Articles}). You may customize that variable to create
8752 suggestions you find reasonable. (Note that
8753 @code{gnus-move-split-methods} uses group names where
8754 @code{gnus-split-methods} uses file names.)
8757 (setq gnus-move-split-methods
8758 '(("^From:.*Lars Magne" "nnml:junk")
8759 ("^Subject:.*gnus" "nnfolder:important")
8760 (".*" "nnml:misc")))
8764 @node Various Summary Stuff
8765 @section Various Summary Stuff
8768 * Summary Group Information:: Information oriented commands.
8769 * Searching for Articles:: Multiple article commands.
8770 * Summary Generation Commands:: (Re)generating the summary buffer.
8771 * Really Various Summary Commands:: Those pesky non-conformant commands.
8775 @vindex gnus-summary-mode-hook
8776 @item gnus-summary-mode-hook
8777 This hook is called when creating a summary mode buffer.
8779 @vindex gnus-summary-generate-hook
8780 @item gnus-summary-generate-hook
8781 This is called as the last thing before doing the threading and the
8782 generation of the summary buffer. It's quite convenient for customizing
8783 the threading variables based on what data the newsgroup has. This hook
8784 is called from the summary buffer after most summary buffer variables
8787 @vindex gnus-summary-prepare-hook
8788 @item gnus-summary-prepare-hook
8789 It is called after the summary buffer has been generated. You might use
8790 it to, for instance, highlight lines or modify the look of the buffer in
8791 some other ungodly manner. I don't care.
8793 @vindex gnus-summary-prepared-hook
8794 @item gnus-summary-prepared-hook
8795 A hook called as the very last thing after the summary buffer has been
8798 @vindex gnus-summary-ignore-duplicates
8799 @item gnus-summary-ignore-duplicates
8800 When gnus discovers two articles that have the same @code{Message-ID},
8801 it has to do something drastic. No articles are allowed to have the
8802 same @code{Message-ID}, but this may happen when reading mail from some
8803 sources. Gnus allows you to customize what happens with this variable.
8804 If it is @code{nil} (which is the default), gnus will rename the
8805 @code{Message-ID} (for display purposes only) and display the article as
8806 any other article. If this variable is @code{t}, it won't display the
8807 article---it'll be as if it never existed.
8809 @vindex gnus-alter-articles-to-read-function
8810 @item gnus-alter-articles-to-read-function
8811 This function, which takes two parameters (the group name and the list
8812 of articles to be selected), is called to allow the user to alter the
8813 list of articles to be selected.
8815 For instance, the following function adds the list of cached articles to
8816 the list in one particular group:
8819 (defun my-add-cached-articles (group articles)
8820 (if (string= group "some.group")
8821 (append gnus-newsgroup-cached articles)
8828 @node Summary Group Information
8829 @subsection Summary Group Information
8834 @kindex H f (Summary)
8835 @findex gnus-summary-fetch-faq
8836 @vindex gnus-group-faq-directory
8837 Try to fetch the FAQ (list of frequently asked questions) for the
8838 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
8839 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
8840 on a remote machine. This variable can also be a list of directories.
8841 In that case, giving a prefix to this command will allow you to choose
8842 between the various sites. @code{ange-ftp} or @code{efs} will probably
8843 be used for fetching the file.
8846 @kindex H d (Summary)
8847 @findex gnus-summary-describe-group
8848 Give a brief description of the current group
8849 (@code{gnus-summary-describe-group}). If given a prefix, force
8850 rereading the description from the server.
8853 @kindex H h (Summary)
8854 @findex gnus-summary-describe-briefly
8855 Give an extremely brief description of the most important summary
8856 keystrokes (@code{gnus-summary-describe-briefly}).
8859 @kindex H i (Summary)
8860 @findex gnus-info-find-node
8861 Go to the gnus info node (@code{gnus-info-find-node}).
8865 @node Searching for Articles
8866 @subsection Searching for Articles
8871 @kindex M-s (Summary)
8872 @findex gnus-summary-search-article-forward
8873 Search through all subsequent articles for a regexp
8874 (@code{gnus-summary-search-article-forward}).
8877 @kindex M-r (Summary)
8878 @findex gnus-summary-search-article-backward
8879 Search through all previous articles for a regexp
8880 (@code{gnus-summary-search-article-backward}).
8884 @findex gnus-summary-execute-command
8885 This command will prompt you for a header, a regular expression to match
8886 on this field, and a command to be executed if the match is made
8887 (@code{gnus-summary-execute-command}). If the header is an empty
8888 string, the match is done on the entire article. If given a prefix,
8889 search backward instead.
8891 For instance, @kbd{& RET some.*string #} will put the process mark on
8892 all articles that have heads or bodies that match @samp{some.*string}.
8895 @kindex M-& (Summary)
8896 @findex gnus-summary-universal-argument
8897 Perform any operation on all articles that have been marked with
8898 the process mark (@code{gnus-summary-universal-argument}).
8901 @node Summary Generation Commands
8902 @subsection Summary Generation Commands
8907 @kindex Y g (Summary)
8908 @findex gnus-summary-prepare
8909 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
8912 @kindex Y c (Summary)
8913 @findex gnus-summary-insert-cached-articles
8914 Pull all cached articles (for the current group) into the summary buffer
8915 (@code{gnus-summary-insert-cached-articles}).
8920 @node Really Various Summary Commands
8921 @subsection Really Various Summary Commands
8927 @kindex C-d (Summary)
8928 @kindex A D (Summary)
8929 @findex gnus-summary-enter-digest-group
8930 If the current article is a collection of other articles (for instance,
8931 a digest), you might use this command to enter a group based on the that
8932 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
8933 guess what article type is currently displayed unless you give a prefix
8934 to this command, which forces a ``digest'' interpretation. Basically,
8935 whenever you see a message that is a collection of other messages of
8936 some format, you @kbd{C-d} and read these messages in a more convenient
8940 @kindex M-C-d (Summary)
8941 @findex gnus-summary-read-document
8942 This command is very similar to the one above, but lets you gather
8943 several documents into one biiig group
8944 (@code{gnus-summary-read-document}). It does this by opening several
8945 @code{nndoc} groups for each document, and then opening an
8946 @code{nnvirtual} group on top of these @code{nndoc} groups. This
8947 command understands the process/prefix convention
8948 (@pxref{Process/Prefix}).
8951 @kindex C-t (Summary)
8952 @findex gnus-summary-toggle-truncation
8953 Toggle truncation of summary lines
8954 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
8955 line centering function in the summary buffer, so it's not a good idea
8956 to have truncation switched off while reading articles.
8960 @findex gnus-summary-expand-window
8961 Expand the summary buffer window (@code{gnus-summary-expand-window}).
8962 If given a prefix, force an @code{article} window configuration.
8965 @kindex M-C-e (Summary)
8966 @findex gnus-summary-edit-parameters
8967 Edit the group parameters (@pxref{Group Parameters}) of the current
8968 group (@code{gnus-summary-edit-parameters}).
8971 @kindex M-C-a (Summary)
8972 @findex gnus-summary-customize-parameters
8973 Customize the group parameters (@pxref{Group Parameters}) of the current
8974 group (@code{gnus-summary-customize-parameters}).
8979 @node Exiting the Summary Buffer
8980 @section Exiting the Summary Buffer
8981 @cindex summary exit
8982 @cindex exiting groups
8984 Exiting from the summary buffer will normally update all info on the
8985 group and return you to the group buffer.
8991 @kindex Z Z (Summary)
8993 @findex gnus-summary-exit
8994 @vindex gnus-summary-exit-hook
8995 @vindex gnus-summary-prepare-exit-hook
8996 @c @icon{gnus-summary-exit}
8997 Exit the current group and update all information on the group
8998 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
8999 called before doing much of the exiting, which calls
9000 @code{gnus-summary-expire-articles} by default.
9001 @code{gnus-summary-exit-hook} is called after finishing the exit
9002 process. @code{gnus-group-no-more-groups-hook} is run when returning to
9003 group mode having no more (unread) groups.
9007 @kindex Z E (Summary)
9009 @findex gnus-summary-exit-no-update
9010 Exit the current group without updating any information on the group
9011 (@code{gnus-summary-exit-no-update}).
9015 @kindex Z c (Summary)
9017 @findex gnus-summary-catchup-and-exit
9018 @c @icon{gnus-summary-catchup-and-exit}
9019 Mark all unticked articles in the group as read and then exit
9020 (@code{gnus-summary-catchup-and-exit}).
9023 @kindex Z C (Summary)
9024 @findex gnus-summary-catchup-all-and-exit
9025 Mark all articles, even the ticked ones, as read and then exit
9026 (@code{gnus-summary-catchup-all-and-exit}).
9029 @kindex Z n (Summary)
9030 @findex gnus-summary-catchup-and-goto-next-group
9031 Mark all articles as read and go to the next group
9032 (@code{gnus-summary-catchup-and-goto-next-group}).
9035 @kindex Z R (Summary)
9036 @findex gnus-summary-reselect-current-group
9037 Exit this group, and then enter it again
9038 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
9039 all articles, both read and unread.
9043 @kindex Z G (Summary)
9044 @kindex M-g (Summary)
9045 @findex gnus-summary-rescan-group
9046 @c @icon{gnus-summary-mail-get}
9047 Exit the group, check for new articles in the group, and select the
9048 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
9049 articles, both read and unread.
9052 @kindex Z N (Summary)
9053 @findex gnus-summary-next-group
9054 Exit the group and go to the next group
9055 (@code{gnus-summary-next-group}).
9058 @kindex Z P (Summary)
9059 @findex gnus-summary-prev-group
9060 Exit the group and go to the previous group
9061 (@code{gnus-summary-prev-group}).
9064 @kindex Z s (Summary)
9065 @findex gnus-summary-save-newsrc
9066 Save the current number of read/marked articles in the dribble buffer
9067 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
9068 given a prefix, also save the @file{.newsrc} file(s). Using this
9069 command will make exit without updating (the @kbd{Q} command) worthless.
9072 @vindex gnus-exit-group-hook
9073 @code{gnus-exit-group-hook} is called when you exit the current group
9074 with an ``updating'' exit. For instance @kbd{Q}
9075 (@code{gnus-summary-exit-no-update}) does not call this hook.
9077 @findex gnus-summary-wake-up-the-dead
9078 @findex gnus-dead-summary-mode
9079 @vindex gnus-kill-summary-on-exit
9080 If you're in the habit of exiting groups, and then changing your mind
9081 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
9082 If you do that, gnus won't kill the summary buffer when you exit it.
9083 (Quelle surprise!) Instead it will change the name of the buffer to
9084 something like @samp{*Dead Summary ... *} and install a minor mode
9085 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
9086 buffer, you'll find that all keys are mapped to a function called
9087 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
9088 summary buffer will result in a live, normal summary buffer.
9090 There will never be more than one dead summary buffer at any one time.
9092 @vindex gnus-use-cross-reference
9093 The data on the current group will be updated (which articles you have
9094 read, which articles you have replied to, etc.) when you exit the
9095 summary buffer. If the @code{gnus-use-cross-reference} variable is
9096 @code{t} (which is the default), articles that are cross-referenced to
9097 this group and are marked as read, will also be marked as read in the
9098 other subscribed groups they were cross-posted to. If this variable is
9099 neither @code{nil} nor @code{t}, the article will be marked as read in
9100 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
9103 @node Crosspost Handling
9104 @section Crosspost Handling
9108 Marking cross-posted articles as read ensures that you'll never have to
9109 read the same article more than once. Unless, of course, somebody has
9110 posted it to several groups separately. Posting the same article to
9111 several groups (not cross-posting) is called @dfn{spamming}, and you are
9112 by law required to send nasty-grams to anyone who perpetrates such a
9113 heinous crime. You may want to try NoCeM handling to filter out spam
9116 Remember: Cross-posting is kinda ok, but posting the same article
9117 separately to several groups is not. Massive cross-posting (aka.
9118 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
9119 @code{gnus-summary-mail-crosspost-complaint} command to complain about
9120 excessive crossposting (@pxref{Summary Mail Commands}).
9122 @cindex cross-posting
9125 One thing that may cause Gnus to not do the cross-posting thing
9126 correctly is if you use an @sc{nntp} server that supports @sc{xover}
9127 (which is very nice, because it speeds things up considerably) which
9128 does not include the @code{Xref} header in its @sc{nov} lines. This is
9129 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
9130 even with @sc{xover} by registering the @code{Xref} lines of all
9131 articles you actually read, but if you kill the articles, or just mark
9132 them as read without reading them, Gnus will not get a chance to snoop
9133 the @code{Xref} lines out of these articles, and will be unable to use
9134 the cross reference mechanism.
9136 @cindex LIST overview.fmt
9137 @cindex overview.fmt
9138 To check whether your @sc{nntp} server includes the @code{Xref} header
9139 in its overview files, try @samp{telnet your.nntp.server nntp},
9140 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
9141 overview.fmt}. This may not work, but if it does, and the last line you
9142 get does not read @samp{Xref:full}, then you should shout and whine at
9143 your news admin until she includes the @code{Xref} header in the
9146 @vindex gnus-nov-is-evil
9147 If you want Gnus to get the @code{Xref}s right all the time, you have to
9148 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
9153 For an alternative approach, @pxref{Duplicate Suppression}.
9156 @node Duplicate Suppression
9157 @section Duplicate Suppression
9159 By default, gnus tries to make sure that you don't have to read the same
9160 article more than once by utilizing the crossposting mechanism
9161 (@pxref{Crosspost Handling}). However, that simple and efficient
9162 approach may not work satisfactory for some users for various
9167 The @sc{nntp} server may fail to generate the @code{Xref} header. This
9168 is evil and not very common.
9171 The @sc{nntp} server may fail to include the @code{Xref} header in the
9172 @file{.overview} data bases. This is evil and all too common, alas.
9175 You may be reading the same group (or several related groups) from
9176 different @sc{nntp} servers.
9179 You may be getting mail that duplicates articles posted to groups.
9182 I'm sure there are other situations where @code{Xref} handling fails as
9183 well, but these four are the most common situations.
9185 If, and only if, @code{Xref} handling fails for you, then you may
9186 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
9187 will remember the @code{Message-ID}s of all articles you have read or
9188 otherwise marked as read, and then, as if by magic, mark them as read
9189 all subsequent times you see them---in @emph{all} groups. Using this
9190 mechanism is quite likely to be somewhat inefficient, but not overly
9191 so. It's certainly preferable to reading the same articles more than
9194 Duplicate suppression is not a very subtle instrument. It's more like a
9195 sledge hammer than anything else. It works in a very simple
9196 fashion---if you have marked an article as read, it adds this Message-ID
9197 to a cache. The next time it sees this Message-ID, it will mark the
9198 article as read with the @samp{M} mark. It doesn't care what group it
9202 @item gnus-suppress-duplicates
9203 @vindex gnus-suppress-duplicates
9204 If non-@code{nil}, suppress duplicates.
9206 @item gnus-save-duplicate-list
9207 @vindex gnus-save-duplicate-list
9208 If non-@code{nil}, save the list of duplicates to a file. This will
9209 make startup and shutdown take longer, so the default is @code{nil}.
9210 However, this means that only duplicate articles read in a single gnus
9211 session are suppressed.
9213 @item gnus-duplicate-list-length
9214 @vindex gnus-duplicate-list-length
9215 This variable says how many @code{Message-ID}s to keep in the duplicate
9216 suppression list. The default is 10000.
9218 @item gnus-duplicate-file
9219 @vindex gnus-duplicate-file
9220 The name of the file to store the duplicate suppression list in. The
9221 default is @file{~/News/suppression}.
9224 If you have a tendency to stop and start gnus often, setting
9225 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
9226 you leave gnus running for weeks on end, you may have it @code{nil}. On
9227 the other hand, saving the list makes startup and shutdown much slower,
9228 so that means that if you stop and start gnus often, you should set
9229 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
9230 to you to figure out, I think.
9235 Gnus is able to verify PGP or S/MIME signed messages or decrypt PGP
9240 To verify or decrypt PGP messages, you have to install mailcrypt or
9246 @item mm-verify-option
9247 @vindex mm-verify-option
9248 Option of verifying signed parts. @code{never}, not verify;
9249 @code{always}, always verify; @code{known}, only verify known
9250 protocols. Otherwise, ask user.
9252 @item mm-decrypt-option
9253 @vindex mm-decrypt-option
9254 Option of decrypting encrypted parts. @code{never}, no decryption;
9255 @code{always}, always decrypt @code{known}, only decrypt known
9256 protocols. Otherwise, ask user.
9260 @node Article Buffer
9261 @chapter Article Buffer
9262 @cindex article buffer
9264 The articles are displayed in the article buffer, of which there is only
9265 one. All the summary buffers share the same article buffer unless you
9266 tell gnus otherwise.
9269 * Hiding Headers:: Deciding what headers should be displayed.
9270 * Using MIME:: Pushing articles through @sc{mime} before reading them.
9271 * Customizing Articles:: Tailoring the look of the articles.
9272 * Article Keymap:: Keystrokes available in the article buffer.
9273 * Misc Article:: Other stuff.
9277 @node Hiding Headers
9278 @section Hiding Headers
9279 @cindex hiding headers
9280 @cindex deleting headers
9282 The top section of each article is the @dfn{head}. (The rest is the
9283 @dfn{body}, but you may have guessed that already.)
9285 @vindex gnus-show-all-headers
9286 There is a lot of useful information in the head: the name of the person
9287 who wrote the article, the date it was written and the subject of the
9288 article. That's well and nice, but there's also lots of information
9289 most people do not want to see---what systems the article has passed
9290 through before reaching you, the @code{Message-ID}, the
9291 @code{References}, etc. ad nauseum---and you'll probably want to get rid
9292 of some of those lines. If you want to keep all those lines in the
9293 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
9295 Gnus provides you with two variables for sifting headers:
9299 @item gnus-visible-headers
9300 @vindex gnus-visible-headers
9301 If this variable is non-@code{nil}, it should be a regular expression
9302 that says what headers you wish to keep in the article buffer. All
9303 headers that do not match this variable will be hidden.
9305 For instance, if you only want to see the name of the person who wrote
9306 the article and the subject, you'd say:
9309 (setq gnus-visible-headers "^From:\\|^Subject:")
9312 This variable can also be a list of regexps to match headers to
9315 @item gnus-ignored-headers
9316 @vindex gnus-ignored-headers
9317 This variable is the reverse of @code{gnus-visible-headers}. If this
9318 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
9319 should be a regular expression that matches all lines that you want to
9320 hide. All lines that do not match this variable will remain visible.
9322 For instance, if you just want to get rid of the @code{References} field
9323 and the @code{Xref} field, you might say:
9326 (setq gnus-ignored-headers "^References:\\|^Xref:")
9329 This variable can also be a list of regexps to match headers to
9332 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
9333 variable will have no effect.
9337 @vindex gnus-sorted-header-list
9338 Gnus can also sort the headers for you. (It does this by default.) You
9339 can control the sorting by setting the @code{gnus-sorted-header-list}
9340 variable. It is a list of regular expressions that says in what order
9341 the headers are to be displayed.
9343 For instance, if you want the name of the author of the article first,
9344 and then the subject, you might say something like:
9347 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
9350 Any headers that are to remain visible, but are not listed in this
9351 variable, will be displayed in random order after all the headers listed in this variable.
9353 @findex gnus-article-hide-boring-headers
9354 @vindex gnus-boring-article-headers
9355 You can hide further boring headers by setting
9356 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
9357 does depends on the @code{gnus-boring-article-headers} variable. It's a
9358 list, but this list doesn't actually contain header names. Instead is
9359 lists various @dfn{boring conditions} that Gnus can check and remove
9362 These conditions are:
9365 Remove all empty headers.
9367 Remove the @code{Followup-To} header if it is identical to the
9368 @code{Newsgroups} header.
9370 Remove the @code{Reply-To} header if it lists the same address as the
9373 Remove the @code{Newsgroups} header if it only contains the current group
9376 Remove the @code{To} header if it only contains the address identical to
9377 the current groups's @code{to-address} parameter.
9379 Remove the @code{Date} header if the article is less than three days
9382 Remove the @code{To} header if it is very long.
9384 Remove all @code{To} headers if there are more than one.
9387 To include these three elements, you could say something like;
9390 (setq gnus-boring-article-headers
9391 '(empty followup-to reply-to))
9394 This is also the default value for this variable.
9398 @section Using @sc{mime}
9401 Mime is a standard for waving your hands through the air, aimlessly,
9402 while people stand around yawning.
9404 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
9405 while all newsreaders die of fear.
9407 @sc{mime} may specify what character set the article uses, the encoding
9408 of the characters, and it also makes it possible to embed pictures and
9409 other naughty stuff in innocent-looking articles.
9411 @vindex gnus-show-mime
9412 @vindex gnus-article-display-method-for-mime
9413 @vindex gnus-strict-mime
9414 @findex gnus-article-display-mime-message
9415 Gnus handles @sc{mime} by pushing the articles through
9416 @code{gnus-article-display-method-for-mime}, which is
9417 @code{gnus-article-display-mime-message} by default. This function
9418 calls the SEMI MIME-View program to actually do the work. For more
9419 information on SEMI MIME-View, see its manual page (however it is not
9420 existed yet, sorry).
9422 Set @code{gnus-show-mime} to @code{t} if you want to use
9423 @sc{mime} all the time. However, if @code{gnus-strict-mime} is
9424 non-@code{nil}, the @sc{mime} method will only be used if there are
9425 @sc{mime} headers in the article. If you have @code{gnus-show-mime}
9426 set, then you'll see some unfortunate display glitches in the article
9427 buffer. These can't be avoided.
9429 In GNUS or Gnus, it might be best to just use the toggling functions
9430 from the summary buffer to avoid getting nasty surprises. (For instance,
9431 you enter the group @samp{alt.sing-a-long} and, before you know it,
9432 @sc{mime} has decoded the sound file in the article and some horrible
9433 sing-a-long song comes screaming out your speakers, and you can't find
9434 the volume button, because there isn't one, and people are starting to
9435 look at you, and you try to stop the program, but you can't, and you
9436 can't find the program to control the volume, and everybody else in the
9437 room suddenly decides to look at you disdainfully, and you'll feel
9440 Any similarity to real events and people is purely coincidental. Ahem.
9442 To avoid such kind of situation, gnus stops to use
9443 @code{metamail-buffer}. So now, you can set @code{gnus-show-mime} to
9444 non-@code{nil} every-time, then you can push button in the article
9445 buffer when there are nobody else.
9447 Also see @pxref{MIME Commands}.
9450 @node Customizing Articles
9451 @section Customizing Articles
9452 @cindex article customization
9454 A slew of functions for customizing how the articles are to look like
9455 exist. You can call these functions interactively, or you can have them
9456 called automatically when you select the articles.
9458 To have them called automatically, you should set the corresponding
9459 ``treatment'' variable. For instance, to have headers hidden, you'd set
9460 @code{gnus-treat-hide-headers}. Below is a list of variables that can
9461 be set, but first we discuss the values these variables can have.
9463 Note: Some values, while valid, make little sense. Check the list below
9464 for sensible values.
9468 @code{nil}: Don't do this treatment.
9471 @code{t}: Do this treatment on all body parts.
9474 @code{head}: Do the treatment on the headers.
9477 @code{last}: Do this treatment on the last part.
9480 An integer: Do this treatment on all body parts that have a length less
9484 A list of strings: Do this treatment on all body parts that are in
9485 articles that are read in groups that have names that match one of the
9486 regexps in the list.
9489 A list where the first element is not a string:
9491 The list is evaluated recursively. The first element of the list is a
9492 predicate. The following predicates are recognized: @code{or},
9493 @code{and}, @code{not} and @code{typep}. Here's an example:
9497 (typep "text/x-vcard"))
9501 @code{mime}: Do this treatment if the value of @code{gnus-show-mime}' is
9506 You may have noticed that the word @dfn{part} is used here. This refers
9507 to the fact that some messages are @sc{mime} multipart articles that may
9508 be divided into several parts. Articles that are not multiparts are
9509 considered to contain just a single part.
9511 @vindex gnus-article-treat-types
9512 Are the treatments applied to all sorts of multipart parts? Yes, if you
9513 want to, but by default, only @samp{text/plain} parts are given the
9514 treatment. This is controlled by the @code{gnus-article-treat-types}
9515 variable, which is a list of regular expressions that are matched to the
9516 type of the part. This variable is ignored if the value of the
9517 controlling variable is a predicate list, as described above.
9519 The following treatment options are available. The easiest way to
9520 customize this is to examine the @code{gnus-article-treat} customization
9521 group. Values in parenthesis are suggested sensible values. Others are
9522 possible but those listed are probably sufficient for most people.
9525 @item gnus-treat-highlight-signature (t, last)
9526 @item gnus-treat-buttonize (t, integer)
9527 @item gnus-treat-buttonize-head (head)
9528 @item gnus-treat-emphasize (t, head, integer)
9529 @item gnus-treat-fill-article (t, integer)
9530 @item gnus-treat-strip-cr (t, integer)
9531 @item gnus-treat-hide-headers (head)
9532 @item gnus-treat-hide-boring-headers (head)
9533 @item gnus-treat-hide-signature (t, last)
9534 @item gnus-treat-hide-citation (t, integer)
9535 @item gnus-treat-hide-citation-maybe (t, integer)
9536 @item gnus-treat-strip-pgp (t, last, integer)
9537 @item gnus-treat-x-pgp-sig (head)
9538 @item gnus-treat-strip-pem (t, last, integer)
9539 @item gnus-treat-highlight-headers (head)
9540 @item gnus-treat-highlight-citation (t, integer)
9541 @item gnus-treat-highlight-signature (t, last, integer)
9542 @item gnus-treat-date-ut (head)
9543 @item gnus-treat-date-local (head)
9544 @item gnus-treat-date-english (head)
9545 @item gnus-treat-date-lapsed (head)
9546 @item gnus-treat-date-original (head)
9547 @item gnus-treat-date-iso8601 (head)
9548 @item gnus-treat-date-user-defined (head)
9549 @item gnus-treat-strip-headers-in-body (t, integer)
9550 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
9551 @item gnus-treat-strip-leading-blank-lines (t, integer)
9552 @item gnus-treat-strip-multiple-blank-lines (t, integer)
9553 @item gnus-treat-overstrike (t, integer)
9554 @item gnus-treat-display-xface (head)
9555 @item gnus-treat-display-smileys (t, integer)
9556 @item gnus-treat-display-picons (head)
9557 @item gnus-treat-capitalize-sentences (t, integer)
9558 @item gnus-treat-fill-long-lines (t, integer)
9559 @item gnus-treat-play-sounds
9560 @item gnus-treat-translate
9561 @item gnus-treat-decode-article-as-default-mime-charset
9564 @vindex gnus-part-display-hook
9565 You can, of course, write your own functions to be called from
9566 @code{gnus-part-display-hook}. The functions are called narrowed to the
9567 part, and you can do anything you like, pretty much. There is no
9568 information that you have to keep in the buffer---you can change
9572 @node Article Keymap
9573 @section Article Keymap
9575 Most of the keystrokes in the summary buffer can also be used in the
9576 article buffer. They should behave as if you typed them in the summary
9577 buffer, which means that you don't actually have to have a summary
9578 buffer displayed while reading. You can do it all from the article
9581 A few additional keystrokes are available:
9586 @kindex SPACE (Article)
9587 @findex gnus-article-next-page
9588 Scroll forwards one page (@code{gnus-article-next-page}).
9591 @kindex DEL (Article)
9592 @findex gnus-article-prev-page
9593 Scroll backwards one page (@code{gnus-article-prev-page}).
9596 @kindex C-c ^ (Article)
9597 @findex gnus-article-refer-article
9598 If point is in the neighborhood of a @code{Message-ID} and you press
9599 @kbd{C-c ^}, Gnus will try to get that article from the server
9600 (@code{gnus-article-refer-article}).
9603 @kindex C-c C-m (Article)
9604 @findex gnus-article-mail
9605 Send a reply to the address near point (@code{gnus-article-mail}). If
9606 given a prefix, include the mail.
9610 @findex gnus-article-show-summary
9611 Reconfigure the buffers so that the summary buffer becomes visible
9612 (@code{gnus-article-show-summary}).
9616 @findex gnus-article-describe-briefly
9617 Give a very brief description of the available keystrokes
9618 (@code{gnus-article-describe-briefly}).
9621 @kindex TAB (Article)
9622 @findex gnus-article-next-button
9623 Go to the next button, if any (@code{gnus-article-next-button}). This
9624 only makes sense if you have buttonizing turned on.
9627 @kindex M-TAB (Article)
9628 @findex gnus-article-prev-button
9629 Go to the previous button, if any (@code{gnus-article-prev-button}).
9635 @section Misc Article
9639 @item gnus-single-article-buffer
9640 @vindex gnus-single-article-buffer
9641 If non-@code{nil}, use the same article buffer for all the groups.
9642 (This is the default.) If @code{nil}, each group will have its own
9645 @vindex gnus-article-decode-hook
9646 @item gnus-article-decode-hook
9648 Hook used to decode @sc{mime} articles. The default value is
9649 @code{(article-decode-charset article-decode-encoded-words)}
9651 @vindex gnus-article-prepare-hook
9652 @item gnus-article-prepare-hook
9653 This hook is called right after the article has been inserted into the
9654 article buffer. It is mainly intended for functions that do something
9655 depending on the contents; it should probably not be used for changing
9656 the contents of the article buffer.
9658 @item gnus-article-mode-hook
9659 @vindex gnus-article-mode-hook
9660 Hook called in article mode buffers.
9662 @item gnus-article-mode-syntax-table
9663 @vindex gnus-article-mode-syntax-table
9664 Syntax table used in article buffers. It is initialized from
9665 @code{text-mode-syntax-table}.
9667 @vindex gnus-article-mode-line-format
9668 @item gnus-article-mode-line-format
9669 This variable is a format string along the same lines as
9670 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}). It
9671 accepts the same format specifications as that variable, with two
9676 The @dfn{wash status} of the article. This is a short string with one
9677 character for each possible article wash operation that may have been
9680 The number of @sc{mime} parts in the article.
9683 @vindex gnus-break-pages
9685 @item gnus-break-pages
9686 Controls whether @dfn{page breaking} is to take place. If this variable
9687 is non-@code{nil}, the articles will be divided into pages whenever a
9688 page delimiter appears in the article. If this variable is @code{nil},
9689 paging will not be done.
9691 @item gnus-page-delimiter
9692 @vindex gnus-page-delimiter
9693 This is the delimiter mentioned above. By default, it is @samp{^L}
9698 @node Composing Messages
9699 @chapter Composing Messages
9700 @cindex composing messages
9703 @cindex sending mail
9709 @kindex C-c C-c (Post)
9710 All commands for posting and mailing will put you in a message buffer
9711 where you can edit the article all you like, before you send the
9712 article by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The
9713 Message Manual}. Where the message will be posted/mailed to depends
9714 on your setup (@pxref{Posting Server}).
9717 * Mail:: Mailing and replying.
9718 * Posting Server:: What server should you post via?
9719 * Mail and Post:: Mailing and posting at the same time.
9720 * Archived Messages:: Where gnus stores the messages you've sent.
9721 * Posting Styles:: An easier way to specify who you are.
9722 * Drafts:: Postponing messages and rejected messages.
9723 * Rejected Articles:: What happens if the server doesn't like your article?
9724 * Using GPG:: How to use GPG and MML to sign and encrypt messages
9727 Also see @pxref{Canceling and Superseding} for information on how to
9728 remove articles you shouldn't have posted.
9734 Variables for customizing outgoing mail:
9737 @item gnus-uu-digest-headers
9738 @vindex gnus-uu-digest-headers
9739 List of regexps to match headers included in digested messages. The
9740 headers will be included in the sequence they are matched.
9742 @item gnus-add-to-list
9743 @vindex gnus-add-to-list
9744 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
9745 that have none when you do a @kbd{a}.
9750 @node Posting Server
9751 @section Posting Server
9753 When you press those magical @kbd{C-c C-c} keys to ship off your latest
9754 (extremely intelligent, of course) article, where does it go?
9756 Thank you for asking. I hate you.
9758 @vindex gnus-post-method
9760 It can be quite complicated. Normally, Gnus will post using the same
9761 select method as you're reading from (which might be convenient if
9762 you're reading lots of groups from different private servers).
9763 However. If the server you're reading from doesn't allow posting,
9764 just reading, you probably want to use some other server to post your
9765 (extremely intelligent and fabulously interesting) articles. You can
9766 then set the @code{gnus-post-method} to some other method:
9769 (setq gnus-post-method '(nnspool ""))
9772 Now, if you've done this, and then this server rejects your article, or
9773 this server is down, what do you do then? To override this variable you
9774 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
9775 the ``current'' server, to get back the default behavior, for posting.
9777 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
9778 gnus will prompt you for what method to use for posting.
9780 You can also set @code{gnus-post-method} to a list of select methods.
9781 If that's the case, gnus will always prompt you for what method to use
9784 Finally, if you want to always post using the native select method,
9785 you can set this variable to @code{nil}.
9789 @section Mail and Post
9791 Here's a list of variables relevant to both mailing and
9795 @item gnus-mailing-list-groups
9796 @findex gnus-mailing-list-groups
9797 @cindex mailing lists
9799 If your news server offers groups that are really mailing lists
9800 gatewayed to the @sc{nntp} server, you can read those groups without
9801 problems, but you can't post/followup to them without some difficulty.
9802 One solution is to add a @code{to-address} to the group parameters
9803 (@pxref{Group Parameters}). An easier thing to do is set the
9804 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
9805 really are mailing lists. Then, at least, followups to the mailing
9806 lists will work most of the time. Posting to these groups (@kbd{a}) is
9807 still a pain, though.
9811 You may want to do spell-checking on messages that you send out. Or, if
9812 you don't want to spell-check by hand, you could add automatic
9813 spell-checking via the @code{ispell} package:
9816 @findex ispell-message
9818 (add-hook 'message-send-hook 'ispell-message)
9821 If you want to change the @code{ispell} dictionary based on what group
9822 you're in, you could say something like the following:
9825 (add-hook 'gnus-select-group-hook
9829 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
9830 (ispell-change-dictionary "deutsch"))
9832 (ispell-change-dictionary "english")))))
9835 Modify to suit your needs.
9838 @node Archived Messages
9839 @section Archived Messages
9840 @cindex archived messages
9841 @cindex sent messages
9843 Gnus provides a few different methods for storing the mail and news you
9844 send. The default method is to use the @dfn{archive virtual server} to
9845 store the messages. If you want to disable this completely, the
9846 @code{gnus-message-archive-group} variable should be @code{nil}, which
9849 @vindex gnus-message-archive-method
9850 @code{gnus-message-archive-method} says what virtual server gnus is to
9851 use to store sent messages. The default is:
9855 (nnfolder-directory "~/Mail/archive")
9856 (nnfolder-active-file "~/Mail/archive/active")
9857 (nnfolder-get-new-mail nil)
9858 (nnfolder-inhibit-expiry t))
9861 You can, however, use any mail select method (@code{nnml},
9862 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
9863 for doing this sort of thing, though. If you don't like the default
9864 directory chosen, you could say something like:
9867 (setq gnus-message-archive-method
9868 '(nnfolder "archive"
9869 (nnfolder-inhibit-expiry t)
9870 (nnfolder-active-file "~/News/sent-mail/active")
9871 (nnfolder-directory "~/News/sent-mail/")))
9874 @vindex gnus-message-archive-group
9876 Gnus will insert @code{Gcc} headers in all outgoing messages that point
9877 to one or more group(s) on that server. Which group to use is
9878 determined by the @code{gnus-message-archive-group} variable.
9880 This variable can be used to do the following:
9884 Messages will be saved in that group.
9886 Note that you can include a select method in the group name, then the
9887 message will not be stored in the select method given by
9888 @code{gnus-message-archive-method}, but in the select method specified
9889 by the group name, instead. Suppose @code{gnus-message-archive-method}
9890 has the default value shown above. Then setting
9891 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
9892 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
9893 value @code{"nnml:foo"}, then outgoing messages will be stored in
9895 @item a list of strings
9896 Messages will be saved in all those groups.
9897 @item an alist of regexps, functions and forms
9898 When a key ``matches'', the result is used.
9900 No message archiving will take place. This is the default.
9905 Just saving to a single group called @samp{MisK}:
9907 (setq gnus-message-archive-group "MisK")
9910 Saving to two groups, @samp{MisK} and @samp{safe}:
9912 (setq gnus-message-archive-group '("MisK" "safe"))
9915 Save to different groups based on what group you are in:
9917 (setq gnus-message-archive-group
9918 '(("^alt" "sent-to-alt")
9919 ("mail" "sent-to-mail")
9920 (".*" "sent-to-misc")))
9925 (setq gnus-message-archive-group
9926 '((if (message-news-p)
9931 How about storing all news messages in one file, but storing all mail
9932 messages in one file per month:
9935 (setq gnus-message-archive-group
9936 '((if (message-news-p)
9938 (concat "mail." (format-time-string "%Y-%m")))))
9941 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
9942 use a different value for @code{gnus-message-archive-group} there.)
9944 Now, when you send a message off, it will be stored in the appropriate
9945 group. (If you want to disable storing for just one particular message,
9946 you can just remove the @code{Gcc} header that has been inserted.) The
9947 archive group will appear in the group buffer the next time you start
9948 gnus, or the next time you press @kbd{F} in the group buffer. You can
9949 enter it and read the articles in it just like you'd read any other
9950 group. If the group gets really big and annoying, you can simply rename
9951 if (using @kbd{G r} in the group buffer) to something
9952 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
9953 continue to be stored in the old (now empty) group.
9955 That's the default method of archiving sent messages. Gnus offers a
9956 different way for the people who don't like the default method. In that
9957 case you should set @code{gnus-message-archive-group} to @code{nil};
9958 this will disable archiving.
9961 @item gnus-outgoing-message-group
9962 @vindex gnus-outgoing-message-group
9963 All outgoing messages will be put in this group. If you want to store
9964 all your outgoing mail and articles in the group @samp{nnml:archive},
9965 you set this variable to that value. This variable can also be a list of
9968 If you want to have greater control over what group to put each
9969 message in, you can set this variable to a function that checks the
9970 current newsgroup name and then returns a suitable group name (or list
9973 This variable can be used instead of @code{gnus-message-archive-group},
9974 but the latter is the preferred method.
9976 @item gnus-inews-mark-gcc-as-read
9977 @vindex gnus-inews-mark-gcc-as-read
9978 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
9983 @node Posting Styles
9984 @section Posting Styles
9985 @cindex posting styles
9988 All them variables, they make my head swim.
9990 So what if you want a different @code{Organization} and signature based
9991 on what groups you post to? And you post both from your home machine
9992 and your work machine, and you want different @code{From} lines, and so
9995 @vindex gnus-posting-styles
9996 One way to do stuff like that is to write clever hooks that change the
9997 variables you need to have changed. That's a bit boring, so somebody
9998 came up with the bright idea of letting the user specify these things in
9999 a handy alist. Here's an example of a @code{gnus-posting-styles}
10004 (signature "Peace and happiness")
10005 (organization "What me?"))
10007 (signature "Death to everybody"))
10008 ("comp.emacs.i-love-it"
10009 (organization "Emacs is it")))
10012 As you might surmise from this example, this alist consists of several
10013 @dfn{styles}. Each style will be applicable if the first element
10014 ``matches'', in some form or other. The entire alist will be iterated
10015 over, from the beginning towards the end, and each match will be
10016 applied, which means that attributes in later styles that match override
10017 the same attributes in earlier matching styles. So
10018 @samp{comp.programming.literate} will have the @samp{Death to everybody}
10019 signature and the @samp{What me?} @code{Organization} header.
10021 The first element in each style is called the @code{match}. If it's a
10022 string, then Gnus will try to regexp match it against the group name.
10023 If it is the symbol @code{header}, then Gnus will look for header (the
10024 next element in the match) in the original article , and compare that to
10025 the last regexp in the match. If it's a function symbol, that function
10026 will be called with no arguments. If it's a variable symbol, then the
10027 variable will be referenced. If it's a list, then that list will be
10028 @code{eval}ed. In any case, if this returns a non-@code{nil} value,
10029 then the style is said to @dfn{match}.
10031 Each style may contain a arbitrary amount of @dfn{attributes}. Each
10032 attribute consists of a @code{(@var{name} @var{value})} pair. The
10033 attribute name can be one of @code{signature}, @code{signature-file},
10034 @code{organization}, @code{address}, @code{name} or @code{body}. The
10035 attribute name can also be a string. In that case, this will be used as
10036 a header name, and the value will be inserted in the headers of the
10037 article; if the value is @code{nil}, the header name will be removed.
10038 If the attribute name is @code{eval}, the form is evaluated, and the
10039 result is thrown away.
10041 The attribute value can be a string (used verbatim), a function with
10042 zero arguments (the return value will be used), a variable (its value
10043 will be used) or a list (it will be @code{eval}ed and the return value
10044 will be used). The functions and sexps are called/@code{eval}ed in the
10045 message buffer that is being set up. The headers of the current article
10046 are available through the @code{message-reply-headers} variable.
10048 If you wish to check whether the message you are about to compose is
10049 meant to be a news article or a mail message, you can check the values
10050 of the @code{message-news-p} and @code{message-mail-p} functions.
10052 @findex message-mail-p
10053 @findex message-news-p
10055 So here's a new example:
10058 (setq gnus-posting-styles
10060 (signature-file "~/.signature")
10062 ("X-Home-Page" (getenv "WWW_HOME"))
10063 (organization "People's Front Against MWM"))
10065 (signature my-funny-signature-randomizer))
10066 ((equal (system-name) "gnarly")
10067 (signature my-quote-randomizer))
10069 (signature my-news-signature))
10070 (header "to" "larsi.*org"
10071 (Organization "Somewhere, Inc."))
10072 ((posting-from-work-p)
10073 (signature-file "~/.work-signature")
10074 (address "user@@bar.foo")
10075 (body "You are fired.\n\nSincerely, your boss.")
10076 (organization "Important Work, Inc"))
10078 (From (save-excursion
10079 (set-buffer gnus-article-buffer)
10080 (message-fetch-field "to"))))
10082 (signature-file "~/.mail-signature"))))
10085 The @samp{nnml:.*} rule means that you use the @code{To} address as the
10086 @code{From} address in all your outgoing replies, which might be handy
10087 if you fill many roles.
10094 If you are writing a message (mail or news) and suddenly remember that
10095 you have a steak in the oven (or some pesto in the food processor, you
10096 craaazy vegetarians), you'll probably wish there was a method to save
10097 the message you are writing so that you can continue editing it some
10098 other day, and send it when you feel its finished.
10100 Well, don't worry about it. Whenever you start composing a message of
10101 some sort using the gnus mail and post commands, the buffer you get will
10102 automatically associate to an article in a special @dfn{draft} group.
10103 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
10104 article will be saved there. (Auto-save files also go to the draft
10108 @vindex nndraft-directory
10109 The draft group is a special group (which is implemented as an
10110 @code{nndraft} group, if you absolutely have to know) called
10111 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
10112 @code{nndraft} is to store its files. What makes this group special is
10113 that you can't tick any articles in it or mark any articles as
10114 read---all articles in the group are permanently unread.
10116 If the group doesn't exist, it will be created and you'll be subscribed
10117 to it. The only way to make it disappear from the Group buffer is to
10120 @c @findex gnus-dissociate-buffer-from-draft
10121 @c @kindex C-c M-d (Mail)
10122 @c @kindex C-c M-d (Post)
10123 @c @findex gnus-associate-buffer-with-draft
10124 @c @kindex C-c C-d (Mail)
10125 @c @kindex C-c C-d (Post)
10126 @c If you're writing some super-secret message that you later want to
10127 @c encode with PGP before sending, you may wish to turn the auto-saving
10128 @c (and association with the draft group) off. You never know who might be
10129 @c interested in reading all your extremely valuable and terribly horrible
10130 @c and interesting secrets. The @kbd{C-c M-d}
10131 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
10132 @c If you change your mind and want to turn the auto-saving back on again,
10133 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
10135 @c @vindex gnus-use-draft
10136 @c To leave association with the draft group off by default, set
10137 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
10139 @findex gnus-draft-edit-message
10140 @kindex D e (Draft)
10141 When you want to continue editing the article, you simply enter the
10142 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
10143 that. You will be placed in a buffer where you left off.
10145 Rejected articles will also be put in this draft group (@pxref{Rejected
10148 @findex gnus-draft-send-all-messages
10149 @findex gnus-draft-send-message
10150 If you have lots of rejected messages you want to post (or mail) without
10151 doing further editing, you can use the @kbd{D s} command
10152 (@code{gnus-draft-send-message}). This command understands the
10153 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
10154 command (@code{gnus-draft-send-all-messages}) will ship off all messages
10157 If you have some messages that you wish not to send, you can use the
10158 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
10159 as unsendable. This is a toggling command.
10162 @node Rejected Articles
10163 @section Rejected Articles
10164 @cindex rejected articles
10166 Sometimes a news server will reject an article. Perhaps the server
10167 doesn't like your face. Perhaps it just feels miserable. Perhaps
10168 @emph{there be demons}. Perhaps you have included too much cited text.
10169 Perhaps the disk is full. Perhaps the server is down.
10171 These situations are, of course, totally beyond the control of gnus.
10172 (Gnus, of course, loves the way you look, always feels great, has angels
10173 fluttering around inside of it, doesn't care about how much cited text
10174 you include, never runs full and never goes down.) So gnus saves these
10175 articles until some later time when the server feels better.
10177 The rejected articles will automatically be put in a special draft group
10178 (@pxref{Drafts}). When the server comes back up again, you'd then
10179 typically enter that group and send all the articles off.
10185 Gnus has an ALPHA support to GPG that's provided by @file{gpg.el}. See
10186 @code{mm-verify-option} and @code{mm-decrypt-option} to enable Gnus to
10187 verify or decrypt messages accordingly.
10189 To use this correctly with GPG, you'll need the following lisp code in your
10190 @file{~/.emacs} or @file{~/.gnus}:
10194 (setq mml2015-use 'gpg)
10195 (setq gpg-temp-directory (expand-file-name "~/.gnupg/tmp"))
10198 The @code{gpg-temp-directory} need to point to a directory with permissions set
10199 to 700, for your own safety.
10201 If you want to benefit of PGP2.6 compatibility, you might create a script named
10202 @file{gpg-2comp} with these instructions:
10206 exec gpg --rfc1991 "$@@"
10209 If you don't want to use such compatibility, you can add the following line to
10210 your @file{~/.emacs} or @file{~/.gnus}:
10213 (setq gpg-command-default-alist (quote ((gpg . "gpg") (gpg-2comp . "gpg"))))
10216 To sign or encrypt your message you may choose to use the MML Security
10217 menu or @kbd{C-c C-m s p} to sign your message using PGP/MIME, @kbd{C-c
10218 C-m s s} to sign your message using S/MIME. There's also @kbd{C-c C-m c
10219 p} to encrypt your message with PGP/MIME and @kbd{C-c C-m c s} to
10220 encrypt using S/MIME.
10222 Gnus will ask for your passphrase and then it will send your message, if
10223 you've typed it correctly.
10225 @node Select Methods
10226 @chapter Select Methods
10227 @cindex foreign groups
10228 @cindex select methods
10230 A @dfn{foreign group} is a group not read by the usual (or
10231 default) means. It could be, for instance, a group from a different
10232 @sc{nntp} server, it could be a virtual group, or it could be your own
10233 personal mail group.
10235 A foreign group (or any group, really) is specified by a @dfn{name} and
10236 a @dfn{select method}. To take the latter first, a select method is a
10237 list where the first element says what backend to use (e.g. @code{nntp},
10238 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
10239 name}. There may be additional elements in the select method, where the
10240 value may have special meaning for the backend in question.
10242 One could say that a select method defines a @dfn{virtual server}---so
10243 we do just that (@pxref{Server Buffer}).
10245 The @dfn{name} of the group is the name the backend will recognize the
10248 For instance, the group @samp{soc.motss} on the @sc{nntp} server
10249 @samp{some.where.edu} will have the name @samp{soc.motss} and select
10250 method @code{(nntp "some.where.edu")}. Gnus will call this group
10251 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
10252 backend just knows this group as @samp{soc.motss}.
10254 The different methods all have their peculiarities, of course.
10257 * Server Buffer:: Making and editing virtual servers.
10258 * Getting News:: Reading USENET news with Gnus.
10259 * Getting Mail:: Reading your personal mail with Gnus.
10260 * Browsing the Web:: Getting messages from a plethora of Web sources.
10261 * Other Sources:: Reading directories, files, SOUP packets.
10262 * Combined Groups:: Combining groups into one group.
10263 * Gnus Unplugged:: Reading news and mail offline.
10267 @node Server Buffer
10268 @section Server Buffer
10270 Traditionally, a @dfn{server} is a machine or a piece of software that
10271 one connects to, and then requests information from. Gnus does not
10272 connect directly to any real servers, but does all transactions through
10273 one backend or other. But that's just putting one layer more between
10274 the actual media and Gnus, so we might just as well say that each
10275 backend represents a virtual server.
10277 For instance, the @code{nntp} backend may be used to connect to several
10278 different actual @sc{nntp} servers, or, perhaps, to many different ports
10279 on the same actual @sc{nntp} server. You tell Gnus which backend to
10280 use, and what parameters to set by specifying a @dfn{select method}.
10282 These select method specifications can sometimes become quite
10283 complicated---say, for instance, that you want to read from the
10284 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
10285 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
10286 Anyway, if you had to specify that for each group that used this
10287 server, that would be too much work, so Gnus offers a way of naming
10288 select methods, which is what you do in the server buffer.
10290 To enter the server buffer, use the @kbd{^}
10291 (@code{gnus-group-enter-server-mode}) command in the group buffer.
10294 * Server Buffer Format:: You can customize the look of this buffer.
10295 * Server Commands:: Commands to manipulate servers.
10296 * Example Methods:: Examples server specifications.
10297 * Creating a Virtual Server:: An example session.
10298 * Server Variables:: Which variables to set.
10299 * Servers and Methods:: You can use server names as select methods.
10300 * Unavailable Servers:: Some servers you try to contact may be down.
10303 @vindex gnus-server-mode-hook
10304 @code{gnus-server-mode-hook} is run when creating the server buffer.
10307 @node Server Buffer Format
10308 @subsection Server Buffer Format
10309 @cindex server buffer format
10311 @vindex gnus-server-line-format
10312 You can change the look of the server buffer lines by changing the
10313 @code{gnus-server-line-format} variable. This is a @code{format}-like
10314 variable, with some simple extensions:
10319 How the news is fetched---the backend name.
10322 The name of this server.
10325 Where the news is to be fetched from---the address.
10328 The opened/closed/denied status of the server.
10331 @vindex gnus-server-mode-line-format
10332 The mode line can also be customized by using the
10333 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
10334 Formatting}). The following specs are understood:
10344 Also @pxref{Formatting Variables}.
10347 @node Server Commands
10348 @subsection Server Commands
10349 @cindex server commands
10355 @findex gnus-server-add-server
10356 Add a new server (@code{gnus-server-add-server}).
10360 @findex gnus-server-edit-server
10361 Edit a server (@code{gnus-server-edit-server}).
10364 @kindex SPACE (Server)
10365 @findex gnus-server-read-server
10366 Browse the current server (@code{gnus-server-read-server}).
10370 @findex gnus-server-exit
10371 Return to the group buffer (@code{gnus-server-exit}).
10375 @findex gnus-server-kill-server
10376 Kill the current server (@code{gnus-server-kill-server}).
10380 @findex gnus-server-yank-server
10381 Yank the previously killed server (@code{gnus-server-yank-server}).
10385 @findex gnus-server-copy-server
10386 Copy the current server (@code{gnus-server-copy-server}).
10390 @findex gnus-server-list-servers
10391 List all servers (@code{gnus-server-list-servers}).
10395 @findex gnus-server-scan-server
10396 Request that the server scan its sources for new articles
10397 (@code{gnus-server-scan-server}). This is mainly sensible with mail
10402 @findex gnus-server-regenerate-server
10403 Request that the server regenerate all its data structures
10404 (@code{gnus-server-regenerate-server}). This can be useful if you have
10405 a mail backend that has gotten out of sync.
10410 @node Example Methods
10411 @subsection Example Methods
10413 Most select methods are pretty simple and self-explanatory:
10416 (nntp "news.funet.fi")
10419 Reading directly from the spool is even simpler:
10425 As you can see, the first element in a select method is the name of the
10426 backend, and the second is the @dfn{address}, or @dfn{name}, if you
10429 After these two elements, there may be an arbitrary number of
10430 @code{(@var{variable} @var{form})} pairs.
10432 To go back to the first example---imagine that you want to read from
10433 port 15 on that machine. This is what the select method should
10437 (nntp "news.funet.fi" (nntp-port-number 15))
10440 You should read the documentation to each backend to find out what
10441 variables are relevant, but here's an @code{nnmh} example:
10443 @code{nnmh} is a mail backend that reads a spool-like structure. Say
10444 you have two structures that you wish to access: One is your private
10445 mail spool, and the other is a public one. Here's the possible spec for
10449 (nnmh "private" (nnmh-directory "~/private/mail/"))
10452 (This server is then called @samp{private}, but you may have guessed
10455 Here's the method for a public spool:
10459 (nnmh-directory "/usr/information/spool/")
10460 (nnmh-get-new-mail nil))
10466 If you are behind a firewall and only have access to the @sc{nntp}
10467 server from the firewall machine, you can instruct Gnus to @code{rlogin}
10468 on the firewall machine and telnet from there to the @sc{nntp} server.
10469 Doing this can be rather fiddly, but your virtual server definition
10470 should probably look something like this:
10474 (nntp-address "the.firewall.machine")
10475 (nntp-open-connection-function nntp-open-rlogin)
10476 (nntp-end-of-line "\n")
10477 (nntp-rlogin-parameters
10478 ("telnet" "the.real.nntp.host" "nntp")))
10481 If you want to use the wonderful @code{ssh} program to provide a
10482 compressed connection over the modem line, you could create a virtual
10483 server that would look something like this:
10487 (nntp-address "copper.uio.no")
10488 (nntp-rlogin-program "ssh")
10489 (nntp-open-connection-function nntp-open-rlogin)
10490 (nntp-end-of-line "\n")
10491 (nntp-rlogin-parameters
10492 ("telnet" "news.uio.no" "nntp")))
10495 This means that you have to have set up @code{ssh-agent} correctly to
10496 provide automatic authorization, of course. And to get a compressed
10497 connection, you have to have the @samp{Compression} option in the
10498 @code{ssh} @file{config} file.
10501 @node Creating a Virtual Server
10502 @subsection Creating a Virtual Server
10504 If you're saving lots of articles in the cache by using persistent
10505 articles, you may want to create a virtual server to read the cache.
10507 First you need to add a new server. The @kbd{a} command does that. It
10508 would probably be best to use @code{nnspool} to read the cache. You
10509 could also use @code{nnml} or @code{nnmh}, though.
10511 Type @kbd{a nnspool RET cache RET}.
10513 You should now have a brand new @code{nnspool} virtual server called
10514 @samp{cache}. You now need to edit it to have the right definitions.
10515 Type @kbd{e} to edit the server. You'll be entered into a buffer that
10516 will contain the following:
10526 (nnspool-spool-directory "~/News/cache/")
10527 (nnspool-nov-directory "~/News/cache/")
10528 (nnspool-active-file "~/News/cache/active"))
10531 Type @kbd{C-c C-c} to return to the server buffer. If you now press
10532 @kbd{RET} over this virtual server, you should be entered into a browse
10533 buffer, and you should be able to enter any of the groups displayed.
10536 @node Server Variables
10537 @subsection Server Variables
10539 One sticky point when defining variables (both on backends and in Emacs
10540 in general) is that some variables are typically initialized from other
10541 variables when the definition of the variables is being loaded. If you
10542 change the "base" variable after the variables have been loaded, you
10543 won't change the "derived" variables.
10545 This typically affects directory and file variables. For instance,
10546 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
10547 directory variables are initialized from that variable, so
10548 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
10549 new virtual @code{nnml} server, it will @emph{not} suffice to set just
10550 @code{nnml-directory}---you have to explicitly set all the file
10551 variables to be what you want them to be. For a complete list of
10552 variables for each backend, see each backend's section later in this
10553 manual, but here's an example @code{nnml} definition:
10557 (nnml-directory "~/my-mail/")
10558 (nnml-active-file "~/my-mail/active")
10559 (nnml-newsgroups-file "~/my-mail/newsgroups"))
10563 @node Servers and Methods
10564 @subsection Servers and Methods
10566 Wherever you would normally use a select method
10567 (e.g. @code{gnus-secondary-select-method}, in the group select method,
10568 when browsing a foreign server) you can use a virtual server name
10569 instead. This could potentially save lots of typing. And it's nice all
10573 @node Unavailable Servers
10574 @subsection Unavailable Servers
10576 If a server seems to be unreachable, Gnus will mark that server as
10577 @code{denied}. That means that any subsequent attempt to make contact
10578 with that server will just be ignored. ``It can't be opened,'' Gnus
10579 will tell you, without making the least effort to see whether that is
10580 actually the case or not.
10582 That might seem quite naughty, but it does make sense most of the time.
10583 Let's say you have 10 groups subscribed to on server
10584 @samp{nephelococcygia.com}. This server is located somewhere quite far
10585 away from you and the machine is quite slow, so it takes 1 minute just
10586 to find out that it refuses connection to you today. If Gnus were to
10587 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
10588 attempt to do that. Once it has gotten a single ``connection refused'',
10589 it will regard that server as ``down''.
10591 So, what happens if the machine was only feeling unwell temporarily?
10592 How do you test to see whether the machine has come up again?
10594 You jump to the server buffer (@pxref{Server Buffer}) and poke it
10595 with the following commands:
10601 @findex gnus-server-open-server
10602 Try to establish connection to the server on the current line
10603 (@code{gnus-server-open-server}).
10607 @findex gnus-server-close-server
10608 Close the connection (if any) to the server
10609 (@code{gnus-server-close-server}).
10613 @findex gnus-server-deny-server
10614 Mark the current server as unreachable
10615 (@code{gnus-server-deny-server}).
10618 @kindex M-o (Server)
10619 @findex gnus-server-open-all-servers
10620 Open the connections to all servers in the buffer
10621 (@code{gnus-server-open-all-servers}).
10624 @kindex M-c (Server)
10625 @findex gnus-server-close-all-servers
10626 Close the connections to all servers in the buffer
10627 (@code{gnus-server-close-all-servers}).
10631 @findex gnus-server-remove-denials
10632 Remove all marks to whether Gnus was denied connection from any servers
10633 (@code{gnus-server-remove-denials}).
10639 @section Getting News
10640 @cindex reading news
10641 @cindex news backends
10643 A newsreader is normally used for reading news. Gnus currently provides
10644 only two methods of getting news---it can read from an @sc{nntp} server,
10645 or it can read from a local spool.
10648 * NNTP:: Reading news from an @sc{nntp} server.
10649 * News Spool:: Reading news from the local spool.
10654 @subsection @sc{nntp}
10657 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
10658 You just specify @code{nntp} as method and the address of the @sc{nntp}
10659 server as the, uhm, address.
10661 If the @sc{nntp} server is located at a non-standard port, setting the
10662 third element of the select method to this port number should allow you
10663 to connect to the right port. You'll have to edit the group info for
10664 that (@pxref{Foreign Groups}).
10666 The name of the foreign group can be the same as a native group. In
10667 fact, you can subscribe to the same group from as many different servers
10668 you feel like. There will be no name collisions.
10670 The following variables can be used to create a virtual @code{nntp}
10675 @item nntp-server-opened-hook
10676 @vindex nntp-server-opened-hook
10677 @cindex @sc{mode reader}
10679 @cindex authentification
10680 @cindex nntp authentification
10681 @findex nntp-send-authinfo
10682 @findex nntp-send-mode-reader
10683 is run after a connection has been made. It can be used to send
10684 commands to the @sc{nntp} server after it has been contacted. By
10685 default it sends the command @code{MODE READER} to the server with the
10686 @code{nntp-send-mode-reader} function. This function should always be
10687 present in this hook.
10689 @item nntp-authinfo-function
10690 @vindex nntp-authinfo-function
10691 @findex nntp-send-authinfo
10692 @vindex nntp-authinfo-file
10693 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
10694 server. The default function is @code{nntp-send-authinfo}, which looks
10695 through your @file{~/.authinfo} (or whatever you've set the
10696 @code{nntp-authinfo-file} variable to) for applicable entries. If none
10697 are found, it will prompt you for a login name and a password. The
10698 format of the @file{~/.authinfo} file is (almost) the same as the
10699 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
10700 manual page, but here are the salient facts:
10704 The file contains one or more line, each of which define one server.
10707 Each line may contain an arbitrary number of token/value pairs.
10709 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
10710 @samp{default}. In addition Gnus introduces two new tokens, not present
10711 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
10712 @samp{force}. (This is the only way the @file{.authinfo} file format
10713 deviates from the @file{.netrc} file format.) @samp{port} is used to
10714 indicate what port on the server the credentials apply to and
10715 @samp{force} is explained below.
10719 Here's an example file:
10722 machine news.uio.no login larsi password geheimnis
10723 machine nntp.ifi.uio.no login larsi force yes
10726 The token/value pairs may appear in any order; @samp{machine} doesn't
10727 have to be first, for instance.
10729 In this example, both login name and password have been supplied for the
10730 former server, while the latter has only the login name listed, and the
10731 user will be prompted for the password. The latter also has the
10732 @samp{force} tag, which means that the authinfo will be sent to the
10733 @var{nntp} server upon connection; the default (i.e., when there is not
10734 @samp{force} tag) is to not send authinfo to the @var{nntp} server
10735 until the @var{nntp} server asks for it.
10737 You can also add @samp{default} lines that will apply to all servers
10738 that don't have matching @samp{machine} lines.
10744 This will force sending @samp{AUTHINFO} commands to all servers not
10745 previously mentioned.
10747 Remember to not leave the @file{~/.authinfo} file world-readable.
10749 @item nntp-server-action-alist
10750 @vindex nntp-server-action-alist
10751 This is a list of regexps to match on server types and actions to be
10752 taken when matches are made. For instance, if you want Gnus to beep
10753 every time you connect to innd, you could say something like:
10756 (setq nntp-server-action-alist
10757 '(("innd" (ding))))
10760 You probably don't want to do that, though.
10762 The default value is
10765 '(("nntpd 1\\.5\\.11t"
10766 (remove-hook 'nntp-server-opened-hook
10767 'nntp-send-mode-reader)))
10770 This ensures that Gnus doesn't send the @code{MODE READER} command to
10771 nntpd 1.5.11t, since that command chokes that server, I've been told.
10773 @item nntp-maximum-request
10774 @vindex nntp-maximum-request
10775 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
10776 will collect headers by sending a series of @code{head} commands. To
10777 speed things up, the backend sends lots of these commands without
10778 waiting for reply, and then reads all the replies. This is controlled
10779 by the @code{nntp-maximum-request} variable, and is 400 by default. If
10780 your network is buggy, you should set this to 1.
10782 @item nntp-connection-timeout
10783 @vindex nntp-connection-timeout
10784 If you have lots of foreign @code{nntp} groups that you connect to
10785 regularly, you're sure to have problems with @sc{nntp} servers not
10786 responding properly, or being too loaded to reply within reasonable
10787 time. This is can lead to awkward problems, which can be helped
10788 somewhat by setting @code{nntp-connection-timeout}. This is an integer
10789 that says how many seconds the @code{nntp} backend should wait for a
10790 connection before giving up. If it is @code{nil}, which is the default,
10791 no timeouts are done.
10793 @c @item nntp-command-timeout
10794 @c @vindex nntp-command-timeout
10795 @c @cindex PPP connections
10796 @c @cindex dynamic IP addresses
10797 @c If you're running Gnus on a machine that has a dynamically assigned
10798 @c address, Gnus may become confused. If the address of your machine
10799 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
10800 @c waiting forever for replies from the server. To help with this
10801 @c unfortunate problem, you can set this command to a number. Gnus will
10802 @c then, if it sits waiting for a reply from the server longer than that
10803 @c number of seconds, shut down the connection, start a new one, and resend
10804 @c the command. This should hopefully be transparent to the user. A
10805 @c likely number is 30 seconds.
10807 @c @item nntp-retry-on-break
10808 @c @vindex nntp-retry-on-break
10809 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
10810 @c hangs. This will have much the same effect as the command timeout
10811 @c described above.
10813 @item nntp-server-hook
10814 @vindex nntp-server-hook
10815 This hook is run as the last step when connecting to an @sc{nntp}
10818 @findex nntp-open-rlogin
10819 @findex nntp-open-telnet
10820 @findex nntp-open-network-stream
10821 @item nntp-open-connection-function
10822 @vindex nntp-open-connection-function
10823 This function is used to connect to the remote system. Four pre-made
10824 functions are supplied:
10827 @item nntp-open-network-stream
10828 This is the default, and simply connects to some port or other on the
10831 @item nntp-open-rlogin
10832 Does an @samp{rlogin} on the
10833 remote system, and then does a @samp{telnet} to the @sc{nntp} server
10836 @code{nntp-open-rlogin}-related variables:
10840 @item nntp-rlogin-program
10841 @vindex nntp-rlogin-program
10842 Program used to log in on remote machines. The default is @samp{rsh},
10843 but @samp{ssh} is a popular alternative.
10845 @item nntp-rlogin-parameters
10846 @vindex nntp-rlogin-parameters
10847 This list will be used as the parameter list given to @code{rsh}.
10849 @item nntp-rlogin-user-name
10850 @vindex nntp-rlogin-user-name
10851 User name on the remote system.
10855 @item nntp-open-telnet
10856 Does a @samp{telnet} to the remote system and then another @samp{telnet}
10857 to get to the @sc{nntp} server.
10859 @code{nntp-open-telnet}-related variables:
10862 @item nntp-telnet-command
10863 @vindex nntp-telnet-command
10864 Command used to start @code{telnet}.
10866 @item nntp-telnet-switches
10867 @vindex nntp-telnet-switches
10868 List of strings to be used as the switches to the @code{telnet} command.
10870 @item nntp-telnet-user-name
10871 @vindex nntp-telnet-user-name
10872 User name for log in on the remote system.
10874 @item nntp-telnet-passwd
10875 @vindex nntp-telnet-passwd
10876 Password to use when logging in.
10878 @item nntp-telnet-parameters
10879 @vindex nntp-telnet-parameters
10880 A list of strings executed as a command after logging in
10883 @item nntp-telnet-shell-prompt
10884 @vindex nntp-telnet-shell-prompt
10885 Regexp matching the shell prompt on the remote machine. The default is
10886 @samp{bash\\|\$ *\r?$\\|> *\r?}.
10888 @item nntp-open-telnet-envuser
10889 @vindex nntp-open-telnet-envuser
10890 If non-@code{nil}, the @code{telnet} session (client and server both)
10891 will support the @code{ENVIRON} option and not prompt for login name.
10892 This works for Solaris @code{telnet}, for instance.
10896 @findex nntp-open-ssl-stream
10897 @item nntp-open-ssl-stream
10898 Opens a connection to a server over a @dfn{secure} channel. To use this
10899 you must have SSLay installed
10900 (@uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
10901 @file{ssl.el} (from the W3 distribution, for instance). You then
10902 define a server as follows:
10905 ;; Type `C-c C-c' after you've finished editing.
10907 ;; "snews" is port 563 and is predefined
10908 ;; in our /etc/services
10910 (nntp "snews.bar.com"
10911 (nntp-open-connection-function
10912 nntp-open-ssl-stream)
10913 (nntp-port-number "snews")
10914 (nntp-address "snews.bar.com"))
10919 @item nntp-end-of-line
10920 @vindex nntp-end-of-line
10921 String to use as end-of-line marker when talking to the @sc{nntp}
10922 server. This is @samp{\r\n} by default, but should be @samp{\n} when
10923 using @code{rlogin} to talk to the server.
10925 @item nntp-rlogin-user-name
10926 @vindex nntp-rlogin-user-name
10927 User name on the remote system when using the @code{rlogin} connect
10931 @vindex nntp-address
10932 The address of the remote system running the @sc{nntp} server.
10934 @item nntp-port-number
10935 @vindex nntp-port-number
10936 Port number to connect to when using the @code{nntp-open-network-stream}
10939 @item nntp-list-options
10940 @vindex nntp-list-options
10941 List of newsgroup name used for a option of the LIST command to restrict
10942 the listing output to only the specified newsgroups. Each newsgroup name
10943 can be a shell-style wildcard, for instance, @dfn{fj.*}, @dfn{japan.*},
10944 etc. Fortunately, if the server can accept such a option, it will
10945 probably make gnus run faster. You may use it as a server variable as
10949 (setq gnus-select-method
10950 '(nntp "news.somewhere.edu"
10951 (nntp-list-options ("fj.*" "japan.*"))))
10954 @item nntp-options-subscribe
10955 @vindex nntp-options-subscribe
10956 Regexp matching the newsgroup names which will be subscribed
10957 unconditionally. Use @dfn{ } instead of @dfn{$} for a regexp string.
10958 It may be effective as well as @code{nntp-list-options} even though the
10959 server could not accept a shell-style wildcard as a option of the LIST
10960 command. You may use it as a server variable as follows:
10963 (setq gnus-select-method
10964 '(nntp "news.somewhere.edu"
10965 (nntp-options-subscribe "^fj\\.\\|^japan\\.")))
10968 @item nntp-options-not-subscribe
10969 @vindex nntp-options-not-subscribe
10970 Regexp matching the newsgroup names which will not be subscribed
10971 unconditionally. Use @dfn{ } instead of @dfn{$} for a regexp string.
10972 It may be effective as well as @code{nntp-list-options} even though the
10973 server could not accept a shell-style wildcard as a option of the LIST
10974 command. You may use it as a server variable as follows:
10977 (setq gnus-select-method
10978 '(nntp "news.somewhere.edu"
10979 (nntp-options-not-subscribe "\\.binaries\\.")))
10982 @item nntp-buggy-select
10983 @vindex nntp-buggy-select
10984 Set this to non-@code{nil} if your select routine is buggy.
10986 @item nntp-nov-is-evil
10987 @vindex nntp-nov-is-evil
10988 If the @sc{nntp} server does not support @sc{nov}, you could set this
10989 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
10992 @item nntp-xover-commands
10993 @vindex nntp-xover-commands
10996 List of strings used as commands to fetch @sc{nov} lines from a
10997 server. The default value of this variable is @code{("XOVER"
11001 @vindex nntp-nov-gap
11002 @code{nntp} normally sends just one big request for @sc{nov} lines to
11003 the server. The server responds with one huge list of lines. However,
11004 if you have read articles 2-5000 in the group, and only want to read
11005 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
11006 lines that you will not need. This variable says how
11007 big a gap between two consecutive articles is allowed to be before the
11008 @code{XOVER} request is split into several request. Note that if your
11009 network is fast, setting this variable to a really small number means
11010 that fetching will probably be slower. If this variable is @code{nil},
11011 @code{nntp} will never split requests. The default is 5.
11013 @item nntp-prepare-server-hook
11014 @vindex nntp-prepare-server-hook
11015 A hook run before attempting to connect to an @sc{nntp} server.
11017 @item nntp-warn-about-losing-connection
11018 @vindex nntp-warn-about-losing-connection
11019 If this variable is non-@code{nil}, some noise will be made when a
11020 server closes connection.
11022 @item nntp-record-commands
11023 @vindex nntp-record-commands
11024 If non-@code{nil}, @code{nntp} will log all commands it sends to the
11025 @sc{nntp} server (along with a timestamp) in the @samp{*nntp-log*}
11026 buffer. This is useful if you are debugging a Gnus/@sc{nntp} connection
11027 that doesn't seem to work.
11033 @subsection News Spool
11037 Subscribing to a foreign group from the local spool is extremely easy,
11038 and might be useful, for instance, to speed up reading groups that
11039 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
11042 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
11043 anything else) as the address.
11045 If you have access to a local spool, you should probably use that as the
11046 native select method (@pxref{Finding the News}). It is normally faster
11047 than using an @code{nntp} select method, but might not be. It depends.
11048 You just have to try to find out what's best at your site.
11052 @item nnspool-inews-program
11053 @vindex nnspool-inews-program
11054 Program used to post an article.
11056 @item nnspool-inews-switches
11057 @vindex nnspool-inews-switches
11058 Parameters given to the inews program when posting an article.
11060 @item nnspool-spool-directory
11061 @vindex nnspool-spool-directory
11062 Where @code{nnspool} looks for the articles. This is normally
11063 @file{/usr/spool/news/}.
11065 @item nnspool-nov-directory
11066 @vindex nnspool-nov-directory
11067 Where @code{nnspool} will look for @sc{nov} files. This is normally
11068 @file{/usr/spool/news/over.view/}.
11070 @item nnspool-lib-dir
11071 @vindex nnspool-lib-dir
11072 Where the news lib dir is (@file{/usr/lib/news/} by default).
11074 @item nnspool-active-file
11075 @vindex nnspool-active-file
11076 The path to the active file.
11078 @item nnspool-newsgroups-file
11079 @vindex nnspool-newsgroups-file
11080 The path to the group descriptions file.
11082 @item nnspool-history-file
11083 @vindex nnspool-history-file
11084 The path to the news history file.
11086 @item nnspool-active-times-file
11087 @vindex nnspool-active-times-file
11088 The path to the active date file.
11090 @item nnspool-nov-is-evil
11091 @vindex nnspool-nov-is-evil
11092 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
11095 @item nnspool-sift-nov-with-sed
11096 @vindex nnspool-sift-nov-with-sed
11098 If non-@code{nil}, which is the default, use @code{sed} to get the
11099 relevant portion from the overview file. If nil, @code{nnspool} will
11100 load the entire file into a buffer and process it there.
11106 @section Getting Mail
11107 @cindex reading mail
11110 Reading mail with a newsreader---isn't that just plain WeIrD? But of
11114 * Mail in a Newsreader:: Important introductory notes.
11115 * Getting Started Reading Mail:: A simple cookbook example.
11116 * Splitting Mail:: How to create mail groups.
11117 * Mail Sources:: How to tell Gnus where to get mail from.
11118 * Mail Backend Variables:: Variables for customizing mail handling.
11119 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
11120 * Group Mail Splitting:: Use group customize to drive mail splitting.
11121 * Incorporating Old Mail:: What about the old mail you have?
11122 * Expiring Mail:: Getting rid of unwanted mail.
11123 * Washing Mail:: Removing gruft from the mail you get.
11124 * Duplicates:: Dealing with duplicated mail.
11125 * Not Reading Mail:: Using mail backends for reading other files.
11126 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
11130 @node Mail in a Newsreader
11131 @subsection Mail in a Newsreader
11133 If you are used to traditional mail readers, but have decided to switch
11134 to reading mail with Gnus, you may find yourself experiencing something
11135 of a culture shock.
11137 Gnus does not behave like traditional mail readers. If you want to make
11138 it behave that way, you can, but it's an uphill battle.
11140 Gnus, by default, handles all its groups using the same approach. This
11141 approach is very newsreaderly---you enter a group, see the new/unread
11142 messages, and when you read the messages, they get marked as read, and
11143 you don't see them any more. (Unless you explicitly ask for them.)
11145 In particular, you do not do anything explicitly to delete messages.
11147 Does this mean that all the messages that have been marked as read are
11148 deleted? How awful!
11150 But, no, it means that old messages are @dfn{expired} according to some
11151 scheme or other. For news messages, the expire process is controlled by
11152 the news administrator; for mail, the expire process is controlled by
11153 you. The expire process for mail is covered in depth in @pxref{Expiring
11156 What many Gnus users find, after using it a while for both news and
11157 mail, is that the transport mechanism has very little to do with how
11158 they want to treat a message.
11160 Many people subscribe to several mailing lists. These are transported
11161 via SMTP, and are therefore mail. But we might go for weeks without
11162 answering, or even reading these messages very carefully. We may not
11163 need to save them because if we should need to read one again, they are
11164 archived somewhere else.
11166 Some people have local news groups which have only a handful of readers.
11167 These are transported via @sc{nntp}, and are therefore news. But we may need
11168 to read and answer a large fraction of the messages very carefully in
11169 order to do our work. And there may not be an archive, so we may need
11170 to save the interesting messages the same way we would personal mail.
11172 The important distinction turns out to be not the transport mechanism,
11173 but other factors such as how interested we are in the subject matter,
11174 or how easy it is to retrieve the message if we need to read it again.
11176 Gnus provides many options for sorting mail into ``groups'' which behave
11177 like newsgroups, and for treating each group (whether mail or news)
11180 Some users never get comfortable using the Gnus (ahem) paradigm and wish
11181 that Gnus should grow up and be a male, er, mail reader. It is possible
11182 to whip Gnus into a more mailreaderly being, but, as said before, it's
11183 not easy. People who prefer proper mail readers should try @sc{vm}
11184 instead, which is an excellent, and proper, mail reader.
11186 I don't mean to scare anybody off, but I want to make it clear that you
11187 may be required to learn a new way of thinking about messages. After
11188 you've been subjected to The Gnus Way, you will come to love it. I can
11189 guarantee it. (At least the guy who sold me the Emacs Subliminal
11190 Brain-Washing Functions that I've put into Gnus did guarantee it. You
11191 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
11195 @node Getting Started Reading Mail
11196 @subsection Getting Started Reading Mail
11198 It's quite easy to use Gnus to read your new mail. You just plonk the
11199 mail backend of your choice into @code{gnus-secondary-select-methods},
11200 and things will happen automatically.
11202 For instance, if you want to use @code{nnml} (which is a "one file per
11203 mail" backend), you could put the following in your @file{.gnus} file:
11206 (setq gnus-secondary-select-methods
11207 '((nnml "private")))
11210 Now, the next time you start Gnus, this backend will be queried for new
11211 articles, and it will move all the messages in your spool file to its
11212 directory, which is @code{~/Mail/} by default. The new group that will
11213 be created (@samp{mail.misc}) will be subscribed, and you can read it
11214 like any other group.
11216 You will probably want to split the mail into several groups, though:
11219 (setq nnmail-split-methods
11220 '(("junk" "^From:.*Lars Ingebrigtsen")
11221 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
11225 This will result in three new @code{nnml} mail groups being created:
11226 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
11227 mail that doesn't fit into the first two groups will be placed in the
11230 This should be sufficient for reading mail with Gnus. You might want to
11231 give the other sections in this part of the manual a perusal, though.
11232 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
11235 @node Splitting Mail
11236 @subsection Splitting Mail
11237 @cindex splitting mail
11238 @cindex mail splitting
11240 @vindex nnmail-split-methods
11241 The @code{nnmail-split-methods} variable says how the incoming mail is
11242 to be split into groups.
11245 (setq nnmail-split-methods
11246 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
11247 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
11248 ("mail.other" "")))
11251 This variable is a list of lists, where the first element of each of
11252 these lists is the name of the mail group (they do not have to be called
11253 something beginning with @samp{mail}, by the way), and the second
11254 element is a regular expression used on the header of each mail to
11255 determine if it belongs in this mail group. The first string may
11256 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
11257 insert sub-expressions from the matched text. For instance:
11260 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
11263 The second element can also be a function. In that case, it will be
11264 called narrowed to the headers with the first element of the rule as the
11265 argument. It should return a non-@code{nil} value if it thinks that the
11266 mail belongs in that group.
11268 The last of these groups should always be a general one, and the regular
11269 expression should @emph{always} be @samp{} so that it matches any mails
11270 that haven't been matched by any of the other regexps. (These rules are
11271 processed from the beginning of the alist toward the end. The first
11272 rule to make a match will "win", unless you have crossposting enabled.
11273 In that case, all matching rules will "win".)
11275 If you like to tinker with this yourself, you can set this variable to a
11276 function of your choice. This function will be called without any
11277 arguments in a buffer narrowed to the headers of an incoming mail
11278 message. The function should return a list of group names that it
11279 thinks should carry this mail message.
11281 Note that the mail backends are free to maul the poor, innocent,
11282 incoming headers all they want to. They all add @code{Lines} headers;
11283 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
11284 @code{From<SPACE>} line to something else.
11286 @vindex nnmail-crosspost
11287 The mail backends all support cross-posting. If several regexps match,
11288 the mail will be ``cross-posted'' to all those groups.
11289 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
11290 that no articles are crossposted to the general (@samp{}) group.
11292 @vindex nnmail-crosspost-link-function
11295 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
11296 the crossposted articles. However, not all file systems support hard
11297 links. If that's the case for you, set
11298 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
11299 variable is @code{add-name-to-file} by default.)
11301 @kindex M-x nnmail-split-history
11302 @kindex nnmail-split-history
11303 If you wish to see where the previous mail split put the messages, you
11304 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
11305 where re-spooling messages would put the messages, you can use
11306 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
11309 Gnus gives you all the opportunity you could possibly want for shooting
11310 yourself in the foot. Let's say you create a group that will contain
11311 all the mail you get from your boss. And then you accidentally
11312 unsubscribe from the group. Gnus will still put all the mail from your
11313 boss in the unsubscribed group, and so, when your boss mails you ``Have
11314 that report ready by Monday or you're fired!'', you'll never see it and,
11315 come Tuesday, you'll still believe that you're gainfully employed while
11316 you really should be out collecting empty bottles to save up for next
11317 month's rent money.
11321 @subsection Mail Sources
11323 Mail can be gotten from many different sources---the mail spool, from a
11324 POP mail server, from a procmail directory, or from a maildir, for
11328 * Mail Source Specifiers:: How to specify what a mail source is.
11329 * Mail Source Customization:: Some variables that influence things.
11330 * Fetching Mail:: Using the mail source specifiers.
11334 @node Mail Source Specifiers
11335 @subsubsection Mail Source Specifiers
11337 @cindex mail server
11340 @cindex mail source
11342 You tell Gnus how to fetch mail by setting @code{mail-sources}
11343 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
11348 (pop :server "pop3.mailserver.com" :user "myname")
11351 As can be observed, a mail source specifier is a list where the first
11352 element is a @dfn{mail source type}, followed by an arbitrary number of
11353 @dfn{keywords}. Keywords that are not explicitly specified are given
11356 The following mail source types are available:
11360 Get mail from a single file; typically from the mail spool.
11366 The path of the file. Defaults to the value of the @code{MAIL}
11367 environment variable or @file{/usr/mail/spool/user-name}.
11370 An example file mail source:
11373 (file :path "/usr/spool/mail/user-name")
11376 Or using the default path:
11382 If the mail spool file is not located on the local machine, it's best to
11383 use POP or @sc{imap} or the like to fetch the mail. You can not use ange-ftp
11384 file names here---it has no way to lock the mail spool while moving the
11387 If it's impossible to set up a proper server, you can use ssh instead.
11391 '((file :prescript "ssh host bin/getmail >%t")))
11394 The @samp{getmail} script would look something like the following:
11398 # getmail - move mail from spool to stdout
11401 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
11403 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
11406 Alter this script to fit find the @samp{movemail} you want to use.
11410 Get mail from several files in a directory. This is typically used when
11411 you have procmail split the incoming mail into several files. Setting
11412 @code{nnmail-scan-directory-mail-source-once} to non-nil forces Gnus to
11413 scan the mail source only once. This is particularly useful if you want
11414 to scan mail groups at a specified level.
11420 The path of the directory where the files are. There is no default
11424 Only files ending with this suffix are used. The default is
11428 Only files that have this predicate return non-@code{nil} are returned.
11429 The default is @code{identity}. This is used as an additional
11430 filter---only files that have the right suffix @emph{and} satisfy this
11431 predicate are considered.
11435 Script run before/after fetching mail.
11439 An example directory mail source:
11442 (directory :path "/home/user-name/procmail-dir/"
11447 Get mail from a POP server.
11453 The name of the POP server. The default is taken from the
11454 @code{MAILHOST} environment variable.
11457 The port number of the POP server. This can be a number (eg,
11458 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
11459 string, it should be a service name as listed in @file{/etc/services} on
11460 Unix systems. The default is @samp{"pop3"}. On some systems you might
11461 need to specify it as @samp{"pop-3"} instead.
11464 The user name to give to the POP server. The default is the login
11468 The password to give to the POP server. If not specified, the user is
11472 The program to use to fetch mail from the POP server. This should be
11473 a @code{format}-like string. Here's an example:
11476 fetchmail %u@@%s -P %p %t
11479 The valid format specifier characters are:
11483 The name of the file the mail is to be moved to. This must always be
11484 included in this string.
11487 The name of the server.
11490 The port number of the server.
11493 The user name to use.
11496 The password to use.
11499 The values used for these specs are taken from the values you give the
11500 corresponding keywords.
11503 A script to be run before fetching the mail. The syntax is the same as
11504 the @code{:program} keyword. This can also be a function to be run.
11507 A script to be run after fetching the mail. The syntax is the same as
11508 the @code{:program} keyword. This can also be a function to be run.
11511 The function to use to fetch mail from the POP server. The function is
11512 called with one parameter---the name of the file where the mail should
11515 @item :authentication
11516 This can be either the symbol @code{password} or the symbol @code{apop}
11517 and says what authentication scheme to use. The default is
11522 If the @code{:program} and @code{:function} keywords aren't specified,
11523 @code{pop3-movemail} will be used.
11525 Here are some examples. Fetch from the default POP server, using the
11526 default user name, and default fetcher:
11532 Fetch from a named server with a named user and password:
11535 (pop :server "my.pop.server"
11536 :user "user-name" :password "secret")
11539 Use @samp{movemail} to move the mail:
11542 (pop :program "movemail po:%u %t %p")
11546 Get mail from a maildir. This is a type of mailbox that is supported by
11547 at least qmail and postfix, where each file in a special directory
11548 contains exactly one mail.
11554 The path of the directory where the mails are stored. The default is
11555 taken from the @code{MAILDIR} environment variable or
11558 The subdirectories of the Maildir. The default is
11559 @samp{("new" "cur")}.
11561 @c If you sometimes look at your mail through a pop3 daemon before fetching
11562 @c them with Gnus, you may also have to fetch your mails from the
11563 @c @code{cur} directory inside the maildir, like in the first example
11566 You can also get mails from remote hosts (because maildirs don't suffer
11567 from locking problems).
11571 Two example maildir mail sources:
11574 (maildir :path "/home/user-name/Maildir/"
11575 :subdirs ("cur" "new"))
11579 (maildir :path "/user@@remotehost.org:~/Maildir/"
11584 Get mail from a @sc{imap} server. If you don't want to use @sc{imap}
11585 as intended, as a network mail reading protocol (ie with nnimap), for
11586 some reason or other, Gnus let you treat it similar to a POP server
11587 and fetches articles from a given @sc{imap} mailbox. @xref{IMAP}, for
11594 The name of the @sc{imap} server. The default is taken from the
11595 @code{MAILHOST} environment variable.
11598 The port number of the @sc{imap} server. The default is @samp{143}, or
11599 @samp{993} for SSL connections.
11602 The user name to give to the @sc{imap} server. The default is the login
11606 The password to give to the @sc{imap} server. If not specified, the user is
11610 What stream to use for connecting to the server, this is one of the
11611 symbols in @code{imap-stream-alist}. Right now, this means
11612 @samp{kerberos4}, @samp{ssl} or the default @samp{network}.
11614 @item :authentication
11615 Which authenticator to use for authenticating to the server, this is one
11616 of the symbols in @code{imap-authenticator-alist}. Right now, this
11617 means @samp{kerberos4}, @samp{cram-md5}, @samp{anonymous} or the default
11621 When using the `shell' :stream, the contents of this variable is
11622 mapped into the `imap-shell-program' variable. This should be a
11623 @code{format}-like string (or list of strings). Here's an example:
11629 The valid format specifier characters are:
11633 The name of the server.
11636 User name from `imap-default-user'.
11639 The port number of the server.
11642 The values used for these specs are taken from the values you give the
11643 corresponding keywords.
11646 The name of the mailbox to get mail from. The default is @samp{INBOX}
11647 which normally is the mailbox which receive incoming mail.
11650 The predicate used to find articles to fetch. The default, @samp{UNSEEN
11651 UNDELETED}, is probably the best choice for most people, but if you
11652 sometimes peek in your mailbox with a @sc{imap} client and mark some
11653 articles as read (or; SEEN) you might want to set this to @samp{nil}.
11654 Then all articles in the mailbox is fetched, no matter what. For a
11655 complete list of predicates, see RFC 2060 §6.4.4.
11658 How to flag fetched articles on the server, the default @samp{\Deleted}
11659 will mark them as deleted, an alternative would be @samp{\Seen} which
11660 would simply mark them as read. These are the two most likely choices,
11661 but more flags are defined in RFC 2060 §2.3.2.
11664 If non-nil, don't remove all articles marked as deleted in the mailbox
11665 after finishing the fetch.
11669 An example @sc{imap} mail source:
11672 (imap :server "mail.mycorp.com"
11674 :fetchflag "\\Seen")
11678 Get mail from a webmail server, such as www.hotmail.com,
11679 webmail.netscape.com, www.netaddress.com, www.my-deja.com.
11681 NOTE: Now mail.yahoo.com provides POP3 service, so @sc{pop} mail source
11684 NOTE: Webmail largely depends cookies. A "one-line-cookie" patch is
11685 required for url "4.0pre.46".
11687 WARNING: Mails may lost. NO WARRANTY.
11693 The type of the webmail server. The default is @code{hotmail}. The
11694 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
11697 The user name to give to the webmail server. The default is the login
11701 The password to give to the webmail server. If not specified, the user is
11705 If non-nil, only fetch unread articles and don't move them to trash
11706 folder after finishing the fetch.
11710 An example webmail source:
11713 (webmail :subtype 'hotmail
11715 :password "secret")
11720 @item Common Keywords
11721 Common keywords can be used in any type of mail source.
11727 If non-nil, fetch the mail even when Gnus is unplugged. If you use
11728 directory source to get mail, you can specify it as in this example:
11732 '((directory :path "/home/pavel/.Spool/"
11737 Gnus will then fetch your mail even when you are unplugged. This is
11738 useful when you use local mail and news.
11743 @subsubsection Function Interface
11745 Some of the above keywords specify a Lisp function to be executed.
11746 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
11747 the value of the keyword while the function is executing. For example,
11748 consider the following mail-source setting:
11751 (setq mail-sources '((pop :user "jrl"
11752 :server "pophost" :function fetchfunc)))
11755 While the function @code{fetchfunc} is executing, the symbol @code{user}
11756 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
11757 @code{"pophost"}. The symbols @code{port}, @code{password},
11758 @code{program}, @code{prescript}, @code{postscript}, @code{function},
11759 and @code{authentication} are also bound (to their default values).
11761 See above for a list of keywords for each type of mail source.
11764 @node Mail Source Customization
11765 @subsubsection Mail Source Customization
11767 The following is a list of variables that influence how the mail is
11768 fetched. You would normally not need to set or change any of these
11772 @item mail-source-crash-box
11773 @vindex mail-source-crash-box
11774 File where mail will be stored while processing it. The default is
11775 @file{~/.emacs-mail-crash-box}.
11777 @item mail-source-delete-incoming
11778 @vindex mail-source-delete-incoming
11779 If non-@code{nil}, delete incoming files after handling them.
11781 @item mail-source-directory
11782 @vindex mail-source-directory
11783 Directory where files (if any) will be stored. The default is
11784 @file{~/Mail/}. At present, the only thing this is used for is to say
11785 where the incoming files will be stored if the previous variable is
11788 @item mail-source-incoming-file-prefix
11789 @vindex mail-source-incoming-file-prefix
11790 Prefix for file name for storing incoming mail. The default is
11791 @file{Incoming}, in which case files will end up with names like
11792 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
11793 relevant if @code{mail-source-delete-incoming} is @code{nil}.
11795 @item mail-source-default-file-modes
11796 @vindex mail-source-default-file-modes
11797 All new mail files will get this file mode. The default is 384.
11802 @node Fetching Mail
11803 @subsubsection Fetching Mail
11805 @vindex mail-sources
11806 @vindex nnmail-spool-file
11807 The way to actually tell Gnus where to get new mail from is to set
11808 @code{mail-sources} to a list of mail source specifiers
11809 (@pxref{Mail Source Specifiers}).
11811 If this variable (and the obsolescent @code{nnmail-spool-file}) is
11812 @code{nil}, the mail backends will never attempt to fetch mail by
11815 If you want to fetch mail both from your local spool as well as a POP
11816 mail server, you'd say something like:
11821 (pop :server "pop3.mail.server"
11822 :password "secret")))
11825 Or, if you don't want to use any of the keyword defaults:
11829 '((file :path "/var/spool/mail/user-name")
11830 (pop :server "pop3.mail.server"
11833 :password "secret")))
11837 When you use a mail backend, Gnus will slurp all your mail from your
11838 inbox and plonk it down in your home directory. Gnus doesn't move any
11839 mail if you're not using a mail backend---you have to do a lot of magic
11840 invocations first. At the time when you have finished drawing the
11841 pentagram, lightened the candles, and sacrificed the goat, you really
11842 shouldn't be too surprised when Gnus moves your mail.
11846 @node Mail Backend Variables
11847 @subsection Mail Backend Variables
11849 These variables are (for the most part) pertinent to all the various
11853 @vindex nnmail-read-incoming-hook
11854 @item nnmail-read-incoming-hook
11855 The mail backends all call this hook after reading new mail. You can
11856 use this hook to notify any mail watch programs, if you want to.
11858 @vindex nnmail-split-hook
11859 @item nnmail-split-hook
11860 @findex article-decode-encoded-words
11861 @findex RFC 1522 decoding
11862 @findex RFC 2047 decoding
11863 Hook run in the buffer where the mail headers of each message is kept
11864 just before the splitting based on these headers is done. The hook is
11865 free to modify the buffer contents in any way it sees fit---the buffer
11866 is discarded after the splitting has been done, and no changes performed
11867 in the buffer will show up in any files.
11868 @code{gnus-article-decode-encoded-words} is one likely function to add
11871 @vindex nnmail-pre-get-new-mail-hook
11872 @vindex nnmail-post-get-new-mail-hook
11873 @item nnmail-pre-get-new-mail-hook
11874 @itemx nnmail-post-get-new-mail-hook
11875 These are two useful hooks executed when treating new incoming
11876 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
11877 starting to handle the new mail) and
11878 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
11879 is done). Here's and example of using these two hooks to change the
11880 default file modes the new mail files get:
11883 (add-hook 'gnus-pre-get-new-mail-hook
11884 (lambda () (set-default-file-modes 511)))
11886 (add-hook 'gnus-post-get-new-mail-hook
11887 (lambda () (set-default-file-modes 551)))
11890 @item nnmail-use-long-file-names
11891 @vindex nnmail-use-long-file-names
11892 If non-@code{nil}, the mail backends will use long file and directory
11893 names. Groups like @samp{mail.misc} will end up in directories
11894 (assuming use of @code{nnml} backend) or files (assuming use of
11895 @code{nnfolder} backend) like @file{mail.misc}. If it is @code{nil},
11896 the same group will end up in @file{mail/misc}.
11898 @item nnmail-delete-file-function
11899 @vindex nnmail-delete-file-function
11900 @findex delete-file
11901 Function called to delete files. It is @code{delete-file} by default.
11903 @item nnmail-cache-accepted-message-ids
11904 @vindex nnmail-cache-accepted-message-ids
11905 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
11906 the backend (via @code{Gcc}, for instance) into the mail duplication
11907 discovery cache. The default is @code{nil}.
11912 @node Fancy Mail Splitting
11913 @subsection Fancy Mail Splitting
11914 @cindex mail splitting
11915 @cindex fancy mail splitting
11917 @vindex nnmail-split-fancy
11918 @findex nnmail-split-fancy
11919 If the rather simple, standard method for specifying how to split mail
11920 doesn't allow you to do what you want, you can set
11921 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
11922 play with the @code{nnmail-split-fancy} variable.
11924 Let's look at an example value of this variable first:
11927 ;; Messages from the mailer daemon are not crossposted to any of
11928 ;; the ordinary groups. Warnings are put in a separate group
11929 ;; from real errors.
11930 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
11932 ;; Non-error messages are crossposted to all relevant
11933 ;; groups, but we don't crosspost between the group for the
11934 ;; (ding) list and the group for other (ding) related mail.
11935 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
11936 ("subject" "ding" "ding.misc"))
11937 ;; Other mailing lists...
11938 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
11939 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
11940 ;; Both lists below have the same suffix, so prevent
11941 ;; cross-posting to mkpkg.list of messages posted only to
11942 ;; the bugs- list, but allow cross-posting when the
11943 ;; message was really cross-posted.
11944 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
11945 (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
11947 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
11948 ;; Unmatched mail goes to the catch all group.
11952 This variable has the format of a @dfn{split}. A split is a (possibly)
11953 recursive structure where each split may contain other splits. Here are
11954 the five possible split syntaxes:
11959 @samp{group}: If the split is a string, that will be taken as a group
11960 name. Normal regexp match expansion will be done. See below for
11964 @code{(@var{field} @var{value} @code{[-} @var{restrict}
11965 @code{[@dots{}]}@code{]} @var{split})}: If the split is a list, the
11966 first element of which is a string, then store the message as
11967 specified by @var{split}, if header @var{field} (a regexp) contains
11968 @var{value} (also a regexp). If @var{restrict} (yet another regexp)
11969 matches some string after @var{field} and before the end of the
11970 matched @var{value}, the @var{split} is ignored. If none of the
11971 @var{restrict} clauses match, @var{split} is processed.
11974 @code{(| @var{split}@dots{})}: If the split is a list, and the first
11975 element is @code{|} (vertical bar), then process each @var{split} until
11976 one of them matches. A @var{split} is said to match if it will cause
11977 the mail message to be stored in one or more groups.
11980 @code{(& @var{split}@dots{})}: If the split is a list, and the first
11981 element is @code{&}, then process all @var{split}s in the list.
11984 @code{junk}: If the split is the symbol @code{junk}, then don't save
11985 this message. Use with extreme caution.
11988 @code{(: @var{function} @var{arg1} @var{arg2} @dots{})}: If the split is
11989 a list, and the first element is @code{:}, then the second element will
11990 be called as a function with @var{args} given as arguments. The
11991 function should return a @var{split}.
11994 For instance, the following function could be used to split based on the
11995 body of the messages:
11998 (defun split-on-body ()
12000 (set-buffer " *nnmail incoming*")
12001 (goto-char (point-min))
12002 (when (re-search-forward "Some.*string" nil t)
12006 The @samp{" *nnmail incoming*"} is narrowed to the message in question
12007 when the @code{:} function is run.
12010 @code{(! @var{func} @var{split})}: If the split is a list, and the first
12011 element is @code{!}, then SPLIT will be processed, and FUNC will be
12012 called as a function with the result of SPLIT as argument. FUNC should
12016 @code{nil}: If the split is @code{nil}, it is ignored.
12020 In these splits, @var{field} must match a complete field name.
12021 @var{value} must match a complete word according to the fundamental mode
12022 syntax table. You can use @code{.*} in the regexps to match partial
12023 field names or words. In other words, all @var{value}'s are wrapped in
12024 @samp{\<} and @samp{\>} pairs.
12026 @vindex nnmail-split-abbrev-alist
12027 @var{field} and @var{value} can also be lisp symbols, in that case they
12028 are expanded as specified by the variable
12029 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
12030 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
12033 @vindex nnmail-split-fancy-syntax-table
12034 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
12035 when all this splitting is performed.
12037 If you want to have Gnus create groups dynamically based on some
12038 information in the headers (i.e., do @code{replace-match}-like
12039 substitutions in the group names), you can say things like:
12042 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
12045 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
12046 will be filed in @samp{mail.debian.foo}.
12048 If the string contains the element @samp{\&}, then the previously
12049 matched string will be substituted. Similarly, the elements @samp{\\1}
12050 up to @samp{\\9} will be substituted with the text matched by the
12051 groupings 1 through 9.
12053 @findex nnmail-split-fancy-with-parent
12054 @code{nnmail-split-fancy-with-parent} is a function which allows you to
12055 split followups into the same groups their parents are in. Sometimes
12056 you can't make splitting rules for all your mail. For example, your
12057 boss might send you personal mail regarding different projects you are
12058 working on, and as you can't tell your boss to put a distinguishing
12059 string into the subject line, you have to resort to manually moving the
12060 messages into the right group. With this function, you only have to do
12061 it once per thread.
12063 To use this feature, you have to set @code{nnmail-treat-duplicates} to a
12064 non-nil value. And then you can include
12065 @code{nnmail-split-fancy-with-parent} using the colon feature, like so:
12067 (setq nnmail-split-fancy
12068 '(| (: nnmail-split-fancy-with-parent)
12069 ;; other splits go here
12073 This feature works as follows: when @code{nnmail-treat-duplicates} is
12074 non-nil, Gnus records the message id of every message it sees in the
12075 file specified by the variable @code{nnmail-message-id-cache-file},
12076 together with the group it is in (the group is omitted for non-mail
12077 messages). When mail splitting is invoked, the function
12078 @code{nnmail-split-fancy-with-parent} then looks at the References (and
12079 In-Reply-To) header of each message to split and searches the file
12080 specified by @code{nnmail-message-id-cache-file} for the message ids.
12081 When it has found a parent, it returns the corresponding group name. It
12082 is recommended that you set @code{nnmail-message-id-cache-length} to a
12083 somewhat higher number than the default so that the message ids are
12084 still in the cache. (A value of 5000 appears to create a file some 300
12086 @vindex nnmail-cache-accepted-message-ids
12087 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
12088 also records the message ids of moved articles, so that the followup
12089 messages goes into the new group.
12092 @node Group Mail Splitting
12093 @subsection Group Mail Splitting
12094 @cindex mail splitting
12095 @cindex group mail splitting
12097 @findex gnus-group-split
12098 If you subscribe to dozens of mailing lists but you don't want to
12099 maintain mail splitting rules manually, group mail splitting is for you.
12100 You just have to set @var{to-list} and/or @var{to-address} in group
12101 parameters or group customization and set @code{nnmail-split-methods} to
12102 @code{gnus-group-split}. This splitting function will scan all groups
12103 for those parameters and split mail accordingly, i.e., messages posted
12104 from or to the addresses specified in the parameters @var{to-list} or
12105 @var{to-address} of a mail group will be stored in that group.
12107 Sometimes, mailing lists have multiple addresses, and you may want mail
12108 splitting to recognize them all: just set the @var{extra-aliases} group
12109 parameter to the list of additional addresses and it's done. If you'd
12110 rather use a regular expression, set @var{split-regexp}.
12112 All these parameters in a group will be used to create an
12113 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
12114 the @var{value} is a single regular expression that matches
12115 @var{to-list}, @var{to-address}, all of @var{extra-aliases} and all
12116 matches of @var{split-regexp}, and the @var{split} is the name of the
12117 group. @var{restrict}s are also supported: just set the
12118 @var{split-exclude} parameter to a list of regular expressions.
12120 If you can't get the right split to be generated using all these
12121 parameters, or you just need something fancier, you can set the
12122 parameter @var{split-spec} to an @code{nnmail-split-fancy} split. In
12123 this case, all other aforementioned parameters will be ignored by
12124 @code{gnus-group-split}. In particular, @var{split-spec} may be set to
12125 @code{nil}, in which case the group will be ignored by
12126 @code{gnus-group-split}.
12128 @vindex gnus-group-split-default-catch-all-group
12129 @code{gnus-group-split} will do cross-posting on all groups that match,
12130 by defining a single @code{&} fancy split containing one split for each
12131 group. If a message doesn't match any split, it will be stored in the
12132 group named in @code{gnus-group-split-default-catch-all-group}, unless
12133 some group has @var{split-spec} set to @code{catch-all}, in which case
12134 that group is used as the catch-all group. Even though this variable is
12135 often used just to name a group, it may also be set to an arbitrarily
12136 complex fancy split (after all, a group name is a fancy split), and this
12137 may be useful to split mail that doesn't go to any mailing list to
12138 personal mail folders. Note that this fancy split is added as the last
12139 element of a @code{|} split list that also contains a @code{&} split
12140 with the rules extracted from group parameters.
12142 It's time for an example. Assume the following group parameters have
12147 ((to-address . "bar@@femail.com")
12148 (split-regexp . ".*@@femail\\.com"))
12150 ((to-list . "foo@@nowhere.gov")
12151 (extra-aliases "foo@@localhost" "foo-redist@@home")
12152 (split-exclude "bugs-foo" "rambling-foo")
12153 (admin-address . "foo-request@@nowhere.gov"))
12155 ((split-spec . catch-all))
12158 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
12159 behave as if @code{nnmail-split-fancy} had been selected and variable
12160 @code{nnmail-split-fancy} had been set as follows:
12163 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
12164 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
12165 - "bugs-foo" - "rambling-foo" "mail.foo"))
12169 @findex gnus-group-split-fancy
12170 If you'd rather not use group splitting for all your mail groups, you
12171 may use it for only some of them, by using @code{nnmail-split-fancy}
12175 (: gnus-mlsplt-fancy GROUPS NO-CROSSPOST CATCH-ALL)
12178 @var{groups} may be a regular expression or a list of group names whose
12179 parameters will be scanned to generate the output split.
12180 @var{no-crosspost} can be used to disable cross-posting; in this case, a
12181 single @code{|} split will be output. @var{catch-all} is the fallback
12182 fancy split, used like @var{gnus-group-split-default-catch-all-group}.
12183 If @var{catch-all} is @code{nil}, or if @var{split-regexp} matches the
12184 empty string in any selected group, no catch-all split will be issued.
12185 Otherwise, if some group has @var{split-spec} set to @code{catch-all},
12186 this group will override the value of the @var{catch-all} argument.
12188 @findex gnus-group-split-setup
12189 Unfortunately, scanning all groups and their parameters can be quite
12190 slow, especially considering that it has to be done for every message.
12191 But don't despair! The function @code{gnus-group-split-setup} can be
12192 used to enable @code{gnus-group-split} in a much more efficient way. It
12193 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
12194 @code{nnmail-split-fancy} to the split produced by
12195 @code{gnus-group-split-fancy}. Thus, the group parameters are only
12196 scanned once, no matter how many messages are split.
12198 @findex gnus-group-split-update
12199 However, if you change group parameters, you'd have to update
12200 @code{nnmail-split-fancy} manually. You can do it by running
12201 @code{gnus-group-split-update}. If you'd rather have it updated
12202 automatically, just tell @code{gnus-group-split-setup} to do it for
12203 you. For example, add to your @file{.gnus}:
12206 (gnus-group-split-setup AUTO-UPDATE CATCH-ALL)
12209 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
12210 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
12211 have to worry about updating @code{nnmail-split-fancy} again. If you
12212 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
12213 @code{gnus-group-split-default-catch-all-group} will be set to its
12216 @vindex gnus-group-split-updated-hook
12217 Because you may want to change @code{nnmail-split-fancy} after it is set
12218 by @code{gnus-group-split-update}, this function will run
12219 @code{gnus-group-split-updated-hook} just before finishing.
12221 @node Incorporating Old Mail
12222 @subsection Incorporating Old Mail
12224 Most people have lots of old mail stored in various file formats. If
12225 you have set up Gnus to read mail using one of the spiffy Gnus mail
12226 backends, you'll probably wish to have that old mail incorporated into
12229 Doing so can be quite easy.
12231 To take an example: You're reading mail using @code{nnml}
12232 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
12233 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
12234 file filled with important, but old, mail. You want to move it into
12235 your @code{nnml} groups.
12241 Go to the group buffer.
12244 Type `G f' and give the path to the mbox file when prompted to create an
12245 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
12248 Type `SPACE' to enter the newly created group.
12251 Type `M P b' to process-mark all articles in this group's buffer
12252 (@pxref{Setting Process Marks}).
12255 Type `B r' to respool all the process-marked articles, and answer
12256 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
12259 All the mail messages in the mbox file will now also be spread out over
12260 all your @code{nnml} groups. Try entering them and check whether things
12261 have gone without a glitch. If things look ok, you may consider
12262 deleting the mbox file, but I wouldn't do that unless I was absolutely
12263 sure that all the mail has ended up where it should be.
12265 Respooling is also a handy thing to do if you're switching from one mail
12266 backend to another. Just respool all the mail in the old mail groups
12267 using the new mail backend.
12270 @node Expiring Mail
12271 @subsection Expiring Mail
12272 @cindex article expiry
12274 Traditional mail readers have a tendency to remove mail articles when
12275 you mark them as read, in some way. Gnus takes a fundamentally
12276 different approach to mail reading.
12278 Gnus basically considers mail just to be news that has been received in
12279 a rather peculiar manner. It does not think that it has the power to
12280 actually change the mail, or delete any mail messages. If you enter a
12281 mail group, and mark articles as ``read'', or kill them in some other
12282 fashion, the mail articles will still exist on the system. I repeat:
12283 Gnus will not delete your old, read mail. Unless you ask it to, of
12286 To make Gnus get rid of your unwanted mail, you have to mark the
12287 articles as @dfn{expirable}. This does not mean that the articles will
12288 disappear right away, however. In general, a mail article will be
12289 deleted from your system if, 1) it is marked as expirable, AND 2) it is
12290 more than one week old. If you do not mark an article as expirable, it
12291 will remain on your system until hell freezes over. This bears
12292 repeating one more time, with some spurious capitalizations: IF you do
12293 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
12295 @vindex gnus-auto-expirable-newsgroups
12296 You do not have to mark articles as expirable by hand. Groups that
12297 match the regular expression @code{gnus-auto-expirable-newsgroups} will
12298 have all articles that you read marked as expirable automatically. All
12299 articles marked as expirable have an @samp{E} in the first
12300 column in the summary buffer.
12302 By default, if you have auto expiry switched on, Gnus will mark all the
12303 articles you read as expirable, no matter if they were read or unread
12304 before. To avoid having articles marked as read marked as expirable
12305 automatically, you can put something like the following in your
12308 @vindex gnus-mark-article-hook
12310 (remove-hook 'gnus-mark-article-hook
12311 'gnus-summary-mark-read-and-unread-as-read)
12312 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
12315 Note that making a group auto-expirable doesn't mean that all read
12316 articles are expired---only the articles marked as expirable
12317 will be expired. Also note that using the @kbd{d} command won't make
12318 articles expirable---only semi-automatic marking of articles as read will
12319 mark the articles as expirable in auto-expirable groups.
12321 Let's say you subscribe to a couple of mailing lists, and you want the
12322 articles you have read to disappear after a while:
12325 (setq gnus-auto-expirable-newsgroups
12326 "mail.nonsense-list\\|mail.nice-list")
12329 Another way to have auto-expiry happen is to have the element
12330 @code{auto-expire} in the group parameters of the group.
12332 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
12333 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
12334 don't really mix very well.
12336 @vindex nnmail-expiry-wait
12337 The @code{nnmail-expiry-wait} variable supplies the default time an
12338 expirable article has to live. Gnus starts counting days from when the
12339 message @emph{arrived}, not from when it was sent. The default is seven
12342 Gnus also supplies a function that lets you fine-tune how long articles
12343 are to live, based on what group they are in. Let's say you want to
12344 have one month expiry period in the @samp{mail.private} group, a one day
12345 expiry period in the @samp{mail.junk} group, and a six day expiry period
12348 @vindex nnmail-expiry-wait-function
12350 (setq nnmail-expiry-wait-function
12352 (cond ((string= group "mail.private")
12354 ((string= group "mail.junk")
12356 ((string= group "important")
12362 The group names this function is fed are ``unadorned'' group
12363 names---no @samp{nnml:} prefixes and the like.
12365 The @code{nnmail-expiry-wait} variable and
12366 @code{nnmail-expiry-wait-function} function can either be a number (not
12367 necessarily an integer) or one of the symbols @code{immediate} or
12370 You can also use the @code{expiry-wait} group parameter to selectively
12371 change the expiry period (@pxref{Group Parameters}).
12373 @vindex nnmail-expiry-target
12374 The normal action taken when expiring articles is to delete them.
12375 However, in some circumstances it might make more sense to move them to
12376 other groups instead of deleting them. The variable @code{nnmail-expiry-target}
12377 (and the @code{expiry-target} group parameter) controls this. The
12378 variable supplies a default value for all groups, which can be
12379 overridden for specific groups by the group parameter.
12380 default value is @code{delete}, but this can also be a string (which
12381 should be the name of the group the message should be moved to), or a
12382 function (which will be called in a buffer narrowed to the message in
12383 question, and with the name of the group being moved from as its
12384 parameter) which should return a target -- either a group name or
12387 Here's an example for specifying a group name:
12389 (setq nnmail-expiry-target "nnml:expired")
12393 @vindex nnmail-keep-last-article
12394 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
12395 expire the final article in a mail newsgroup. This is to make life
12396 easier for procmail users.
12398 @vindex gnus-total-expirable-newsgroups
12399 By the way: That line up there, about Gnus never expiring non-expirable
12400 articles, is a lie. If you put @code{total-expire} in the group
12401 parameters, articles will not be marked as expirable, but all read
12402 articles will be put through the expiry process. Use with extreme
12403 caution. Even more dangerous is the
12404 @code{gnus-total-expirable-newsgroups} variable. All groups that match
12405 this regexp will have all read articles put through the expiry process,
12406 which means that @emph{all} old mail articles in the groups in question
12407 will be deleted after a while. Use with extreme caution, and don't come
12408 crying to me when you discover that the regexp you used matched the
12409 wrong group and all your important mail has disappeared. Be a
12410 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
12413 Most people make most of their mail groups total-expirable, though.
12415 @vindex gnus-inhibit-user-auto-expire
12416 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
12417 commands will not mark an article as expirable, even if the group has
12418 auto-expire turned on.
12422 @subsection Washing Mail
12423 @cindex mail washing
12424 @cindex list server brain damage
12425 @cindex incoming mail treatment
12427 Mailers and list servers are notorious for doing all sorts of really,
12428 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
12429 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
12430 end of all lines passing through our server, so let's do that!!!!1!''
12431 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
12432 considered to be self-evident were not discussed. So. Here we are.
12434 Case in point: The German version of Microsoft Exchange adds @samp{AW:
12435 } to the subjects of replies instead of @samp{Re: }. I could pretend to
12436 be shocked and dismayed by this, but I haven't got the energy. It is to
12439 Gnus provides a plethora of functions for washing articles while
12440 displaying them, but it might be nicer to do the filtering before
12441 storing the mail to disc. For that purpose, we have three hooks and
12442 various functions that can be put in these hooks.
12445 @item nnmail-prepare-incoming-hook
12446 @vindex nnmail-prepare-incoming-hook
12447 This hook is called before doing anything with the mail and is meant for
12448 grand, sweeping gestures. It is called in a buffer that contains all
12449 the new, incoming mail. Functions to be used include:
12452 @item nnheader-ms-strip-cr
12453 @findex nnheader-ms-strip-cr
12454 Remove trailing carriage returns from each line. This is default on
12455 Emacs running on MS machines.
12459 @item nnmail-prepare-incoming-header-hook
12460 @vindex nnmail-prepare-incoming-header-hook
12461 This hook is called narrowed to each header. It can be used when
12462 cleaning up the headers. Functions that can be used include:
12465 @item nnmail-remove-leading-whitespace
12466 @findex nnmail-remove-leading-whitespace
12467 Clear leading white space that ``helpful'' listservs have added to the
12468 headers to make them look nice. Aaah.
12470 @item nnmail-remove-list-identifiers
12471 @findex nnmail-remove-list-identifiers
12472 Some list servers add an identifier---for example, @samp{(idm)}---to the
12473 beginning of all @code{Subject} headers. I'm sure that's nice for
12474 people who use stone age mail readers. This function will remove
12475 strings that match the @code{nnmail-list-identifiers} regexp, which can
12476 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
12479 For instance, if you want to remove the @samp{(idm)} and the
12480 @samp{nagnagnag} identifiers:
12483 (setq nnmail-list-identifiers
12484 '("(idm)" "nagnagnag"))
12487 This can also be done non-destructively with
12488 @code{gnus-list-identifiers}, @xref{Article Hiding}.
12490 @item nnmail-remove-tabs
12491 @findex nnmail-remove-tabs
12492 Translate all @samp{TAB} characters into @samp{SPACE} characters.
12494 @item nnmail-fix-eudora-headers
12495 @findex nnmail-fix-eudora-headers
12497 Eudora produces broken @code{References} headers, but OK
12498 @code{In-Reply-To} headers. This function will get rid of the
12499 @code{References} headers.
12503 @item nnmail-prepare-incoming-message-hook
12504 @vindex nnmail-prepare-incoming-message-hook
12505 This hook is called narrowed to each message. Functions to be used
12509 @item article-de-quoted-unreadable
12510 @findex article-de-quoted-unreadable
12511 Decode Quoted Readable encoding.
12518 @subsection Duplicates
12520 @vindex nnmail-treat-duplicates
12521 @vindex nnmail-message-id-cache-length
12522 @vindex nnmail-message-id-cache-file
12523 @cindex duplicate mails
12524 If you are a member of a couple of mailing lists, you will sometimes
12525 receive two copies of the same mail. This can be quite annoying, so
12526 @code{nnmail} checks for and treats any duplicates it might find. To do
12527 this, it keeps a cache of old @code{Message-ID}s---
12528 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
12529 default. The approximate maximum number of @code{Message-ID}s stored
12530 there is controlled by the @code{nnmail-message-id-cache-length}
12531 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
12532 stored.) If all this sounds scary to you, you can set
12533 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
12534 default), and @code{nnmail} won't delete duplicate mails. Instead it
12535 will insert a warning into the head of the mail saying that it thinks
12536 that this is a duplicate of a different message.
12538 This variable can also be a function. If that's the case, the function
12539 will be called from a buffer narrowed to the message in question with
12540 the @code{Message-ID} as a parameter. The function must return either
12541 @code{nil}, @code{warn}, or @code{delete}.
12543 You can turn this feature off completely by setting the variable to
12546 If you want all the duplicate mails to be put into a special
12547 @dfn{duplicates} group, you could do that using the normal mail split
12551 (setq nnmail-split-fancy
12552 '(| ;; Messages duplicates go to a separate group.
12553 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
12554 ;; Message from daemons, postmaster, and the like to another.
12555 (any mail "mail.misc")
12562 (setq nnmail-split-methods
12563 '(("duplicates" "^Gnus-Warning:")
12568 Here's a neat feature: If you know that the recipient reads her mail
12569 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
12570 @code{delete}, you can send her as many insults as you like, just by
12571 using a @code{Message-ID} of a mail that you know that she's already
12572 received. Think of all the fun! She'll never see any of it! Whee!
12575 @node Not Reading Mail
12576 @subsection Not Reading Mail
12578 If you start using any of the mail backends, they have the annoying
12579 habit of assuming that you want to read mail with them. This might not
12580 be unreasonable, but it might not be what you want.
12582 If you set @code{mail-sources} and @code{nnmail-spool-file} to
12583 @code{nil}, none of the backends will ever attempt to read incoming
12584 mail, which should help.
12586 @vindex nnbabyl-get-new-mail
12587 @vindex nnmbox-get-new-mail
12588 @vindex nnml-get-new-mail
12589 @vindex nnmh-get-new-mail
12590 @vindex nnfolder-get-new-mail
12591 This might be too much, if, for instance, you are reading mail quite
12592 happily with @code{nnml} and just want to peek at some old @sc{rmail}
12593 file you have stashed away with @code{nnbabyl}. All backends have
12594 variables called backend-@code{get-new-mail}. If you want to disable
12595 the @code{nnbabyl} mail reading, you edit the virtual server for the
12596 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
12598 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
12599 narrowed to the article to be saved before saving it when reading
12603 @node Choosing a Mail Backend
12604 @subsection Choosing a Mail Backend
12606 Gnus will read the mail spool when you activate a mail group. The mail
12607 file is first copied to your home directory. What happens after that
12608 depends on what format you want to store your mail in.
12610 There are five different mail backends in the standard Gnus, and more
12611 backends are available separately. The mail backend most people use
12612 (because it is the fastest and most flexible) is @code{nnml}
12613 (@pxref{Mail Spool}).
12616 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
12617 * Rmail Babyl:: Emacs programs use the rmail babyl format.
12618 * Mail Spool:: Store your mail in a private spool?
12619 * MH Spool:: An mhspool-like backend.
12620 * Mail Folders:: Having one file for each group.
12621 * Comparing Mail Backends:: An in-depth looks at pros and cons.
12625 @node Unix Mail Box
12626 @subsubsection Unix Mail Box
12628 @cindex unix mail box
12630 @vindex nnmbox-active-file
12631 @vindex nnmbox-mbox-file
12632 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
12633 mail. @code{nnmbox} will add extra headers to each mail article to say
12634 which group it belongs in.
12636 Virtual server settings:
12639 @item nnmbox-mbox-file
12640 @vindex nnmbox-mbox-file
12641 The name of the mail box in the user's home directory. Default is
12644 @item nnmbox-active-file
12645 @vindex nnmbox-active-file
12646 The name of the active file for the mail box. Default is
12647 @file{~/.mbox-active}.
12649 @item nnmbox-get-new-mail
12650 @vindex nnmbox-get-new-mail
12651 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
12652 into groups. Default is @code{t}.
12657 @subsubsection Rmail Babyl
12661 @vindex nnbabyl-active-file
12662 @vindex nnbabyl-mbox-file
12663 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
12664 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
12665 mail article to say which group it belongs in.
12667 Virtual server settings:
12670 @item nnbabyl-mbox-file
12671 @vindex nnbabyl-mbox-file
12672 The name of the rmail mbox file. The default is @file{~/RMAIL}
12674 @item nnbabyl-active-file
12675 @vindex nnbabyl-active-file
12676 The name of the active file for the rmail box. The default is
12677 @file{~/.rmail-active}
12679 @item nnbabyl-get-new-mail
12680 @vindex nnbabyl-get-new-mail
12681 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
12687 @subsubsection Mail Spool
12689 @cindex mail @sc{nov} spool
12691 The @dfn{nnml} spool mail format isn't compatible with any other known
12692 format. It should be used with some caution.
12694 @vindex nnml-directory
12695 If you use this backend, Gnus will split all incoming mail into files,
12696 one file for each mail, and put the articles into the corresponding
12697 directories under the directory specified by the @code{nnml-directory}
12698 variable. The default value is @file{~/Mail/}.
12700 You do not have to create any directories beforehand; Gnus will take
12703 If you have a strict limit as to how many files you are allowed to store
12704 in your account, you should not use this backend. As each mail gets its
12705 own file, you might very well occupy thousands of inodes within a few
12706 weeks. If this is no problem for you, and it isn't a problem for you
12707 having your friendly systems administrator walking around, madly,
12708 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
12709 know that this is probably the fastest format to use. You do not have
12710 to trudge through a big mbox file just to read your new mail.
12712 @code{nnml} is probably the slowest backend when it comes to article
12713 splitting. It has to create lots of files, and it also generates
12714 @sc{nov} databases for the incoming mails. This makes it the fastest
12715 backend when it comes to reading mail.
12717 Virtual server settings:
12720 @item nnml-directory
12721 @vindex nnml-directory
12722 All @code{nnml} directories will be placed under this directory.
12723 The default is the value of `message-directory' (whose default value is
12726 @item nnml-active-file
12727 @vindex nnml-active-file
12728 The active file for the @code{nnml} server. The default is
12729 @file{~/Mail/active"}.
12731 @item nnml-newsgroups-file
12732 @vindex nnml-newsgroups-file
12733 The @code{nnml} group descriptions file. @xref{Newsgroups File
12734 Format}. The default is @file{~/Mail/newsgroups"}.
12736 @item nnml-get-new-mail
12737 @vindex nnml-get-new-mail
12738 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
12741 @item nnml-nov-is-evil
12742 @vindex nnml-nov-is-evil
12743 If non-@code{nil}, this backend will ignore any @sc{nov} files. The
12744 default is @code{nil}
12746 @item nnml-nov-file-name
12747 @vindex nnml-nov-file-name
12748 The name of the @sc{nov} files. The default is @file{.overview}.
12750 @item nnml-prepare-save-mail-hook
12751 @vindex nnml-prepare-save-mail-hook
12752 Hook run narrowed to an article before saving.
12756 @findex nnml-generate-nov-databases
12757 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
12758 you can do a complete update by typing @kbd{M-x
12759 nnml-generate-nov-databases}. This command will trawl through the
12760 entire @code{nnml} hierarchy, looking at each and every article, so it
12761 might take a while to complete. A better interface to this
12762 functionality can be found in the server buffer (@pxref{Server
12767 @subsubsection MH Spool
12769 @cindex mh-e mail spool
12771 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
12772 @sc{nov} databases and it doesn't keep an active file. This makes
12773 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
12774 makes it easier to write procmail scripts for.
12776 Virtual server settings:
12779 @item nnmh-directory
12780 @vindex nnmh-directory
12781 All @code{nnmh} directories will be located under this directory. The
12782 default is the value of @code{message-directory} (whose default is
12785 @item nnmh-get-new-mail
12786 @vindex nnmh-get-new-mail
12787 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
12791 @vindex nnmh-be-safe
12792 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
12793 sure that the articles in the folder are actually what Gnus thinks they
12794 are. It will check date stamps and stat everything in sight, so
12795 setting this to @code{t} will mean a serious slow-down. If you never
12796 use anything but Gnus to read the @code{nnmh} articles, you do not have
12797 to set this variable to @code{t}. The default is @code{nil}.
12802 @subsubsection Mail Folders
12804 @cindex mbox folders
12805 @cindex mail folders
12807 @code{nnfolder} is a backend for storing each mail group in a separate
12808 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
12809 will add extra headers to keep track of article numbers and arrival
12812 Virtual server settings:
12815 @item nnfolder-directory
12816 @vindex nnfolder-directory
12817 All the @code{nnfolder} mail boxes will be stored under this directory.
12818 The default is the value of @code{message-directory} (whose default is
12821 @item nnfolder-active-file
12822 @vindex nnfolder-active-file
12823 The name of the active file. The default is @file{~/Mail/active}.
12825 @item nnfolder-newsgroups-file
12826 @vindex nnfolder-newsgroups-file
12827 The name of the group descriptions file. @xref{Newsgroups File
12828 Format}. The default is @file{~/Mail/newsgroups"}
12830 @item nnfolder-get-new-mail
12831 @vindex nnfolder-get-new-mail
12832 If non-@code{nil}, @code{nnfolder} will read incoming mail. The default
12835 @item nnfolder-save-buffer-hook
12836 @vindex nnfolder-save-buffer-hook
12837 @cindex backup files
12838 Hook run before saving the folders. Note that Emacs does the normal
12839 backup renaming of files even with the @code{nnfolder} buffers. If you
12840 wish to switch this off, you could say something like the following in
12841 your @file{.emacs} file:
12844 (defun turn-off-backup ()
12845 (set (make-local-variable 'backup-inhibited) t))
12847 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
12850 @item nnfolder-delete-mail-hook
12851 @vindex nnfolder-delete-mail-hook
12852 Hook run in a buffer narrowed to the message that is to be deleted.
12853 This function can be used to copy the message to somewhere else, or to
12854 extract some information from it before removing it.
12856 @item nnfolder-nov-is-evil
12857 @vindex nnfolder-nov-is-evil
12858 If non-@code{nil}, this backend will ignore any @sc{nov} files. The
12859 default is @code{nil}.
12864 @findex nnfolder-generate-active-file
12865 @kindex M-x nnfolder-generate-active-file
12866 If you have lots of @code{nnfolder}-like files you'd like to read with
12867 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
12868 command to make @code{nnfolder} aware of all likely files in
12869 @code{nnfolder-directory}. This only works if you use long file names,
12872 @node Comparing Mail Backends
12873 @subsubsection Comparing Mail Backends
12875 First, just for terminology, the @dfn{backend} is the common word for a
12876 low-level access method---a transport, if you will, by which something
12877 is acquired. The sense is that one's mail has to come from somewhere,
12878 and so selection of a suitable backend is required in order to get that
12879 mail within spitting distance of Gnus.
12881 The same concept exists for Usenet itself: Though access to articles is
12882 typically done by @sc{nntp} these days, once upon a midnight dreary, everyone
12883 in the world got at Usenet by running a reader on the machine where the
12884 articles lay (the machine which today we call an @sc{nntp} server), and
12885 access was by the reader stepping into the articles' directory spool
12886 area directly. One can still select between either the @code{nntp} or
12887 @code{nnspool} backends, to select between these methods, if one happens
12888 actually to live on the server (or can see its spool directly, anyway,
12891 The goal in selecting a mail backend is to pick one which
12892 simultaneously represents a suitable way of dealing with the original
12893 format plus leaving mail in a form that is convenient to use in the
12894 future. Here are some high and low points on each:
12899 UNIX systems have historically had a single, very common, and well-
12900 defined format. All messages arrive in a single @dfn{spool file}, and
12901 they are delineated by a line whose regular expression matches
12902 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
12903 to make it clear in this instance that this is not the RFC-specified
12904 @samp{From:} header.) Because Emacs and therefore Gnus emanate
12905 historically from the Unix environment, it is simplest if one does not
12906 mess a great deal with the original mailbox format, so if one chooses
12907 this backend, Gnus' primary activity in getting mail from the real spool
12908 area to Gnus' preferred directory is simply to copy it, with no
12909 (appreciable) format change in the process. It is the ``dumbest'' way
12910 to move mail into availability in the Gnus environment. This makes it
12911 fast to move into place, but slow to parse, when Gnus has to look at
12916 Once upon a time, there was the DEC-10 and DEC-20, running operating
12917 systems called TOPS and related things, and the usual (only?) mail
12918 reading environment was a thing called Babyl. I don't know what format
12919 was used for mail landing on the system, but Babyl had its own internal
12920 format to which mail was converted, primarily involving creating a
12921 spool-file-like entity with a scheme for inserting Babyl-specific
12922 headers and status bits above the top of each message in the file.
12923 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
12924 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
12925 to understand the mail files folks already had in existence. Gnus (and
12926 VM, for that matter) continue to support this format because it's
12927 perceived as having some good qualities in those mailer-specific
12928 headers/status bits stuff. RMAIL itself still exists as well, of
12929 course, and is still maintained by Stallman.
12931 Both of the above forms leave your mail in a single file on your
12932 filesystem, and they must parse that entire file each time you take a
12937 @code{nnml} is the backend which smells the most as though you were
12938 actually operating with an @code{nnspool}-accessed Usenet system. (In
12939 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
12940 lo these years ago.) One's mail is taken from the original spool file,
12941 and is then cut up into individual message files, 1:1. It maintains a
12942 Usenet-style active file (analogous to what one finds in an INN- or
12943 CNews-based news system in (for instance) @file{/var/lib/news/active},
12944 or what is returned via the @samp{NNTP LIST} verb) and also creates
12945 @dfn{overview} files for efficient group entry, as has been defined for
12946 @sc{nntp} servers for some years now. It is slower in mail-splitting,
12947 due to the creation of lots of files, updates to the @code{nnml} active
12948 file, and additions to overview files on a per-message basis, but it is
12949 extremely fast on access because of what amounts to the indexing support
12950 provided by the active file and overviews.
12952 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
12953 resource which defines available places in the filesystem to put new
12954 files. Sysadmins take a dim view of heavy inode occupation within
12955 tight, shared filesystems. But if you live on a personal machine where
12956 the filesystem is your own and space is not at a premium, @code{nnml}
12959 It is also problematic using this backend if you are living in a
12960 FAT16-based Windows world, since much space will be wasted on all these
12965 The Rand MH mail-reading system has been around UNIX systems for a very
12966 long time; it operates by splitting one's spool file of messages into
12967 individual files, but with little or no indexing support -- @code{nnmh}
12968 is considered to be semantically equivalent to ``@code{nnml} without
12969 active file or overviews''. This is arguably the worst choice, because
12970 one gets the slowness of individual file creation married to the
12971 slowness of access parsing when learning what's new in one's groups.
12975 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
12976 method described above) on a per-group basis. That is, @code{nnmbox}
12977 itself puts *all* one's mail in one file; @code{nnfolder} provides a
12978 little bit of optimization to this so that each of one's mail groups has
12979 a Unix mail box file. It's faster than @code{nnmbox} because each group
12980 can be parsed separately, and still provides the simple Unix mail box
12981 format requiring minimal effort in moving the mail around. In addition,
12982 it maintains an ``active'' file making it much faster for Gnus to figure
12983 out how many messages there are in each separate group.
12985 If you have groups that are expected to have a massive amount of
12986 messages, @code{nnfolder} is not the best choice, but if you receive
12987 only a moderate amount of mail, @code{nnfolder} is probably the most
12988 friendly mail backend all over.
12993 @node Browsing the Web
12994 @section Browsing the Web
12996 @cindex browsing the web
13000 Web-based discussion forums are getting more and more popular. On many
13001 subjects, the web-based forums have become the most important forums,
13002 eclipsing the importance of mailing lists and news groups. The reason
13003 is easy to understand---they are friendly to new users; you just point
13004 and click, and there's the discussion. With mailing lists, you have to
13005 go through a cumbersome subscription procedure, and most people don't
13006 even know what a news group is.
13008 The problem with this scenario is that web browsers are not very good at
13009 being newsreaders. They do not keep track of what articles you've read;
13010 they do not allow you to score on subjects you're interested in; they do
13011 not allow off-line browsing; they require you to click around and drive
13012 you mad in the end.
13014 So---if web browsers suck at reading discussion forums, why not use Gnus
13017 Gnus has been getting a bit of a collection of backends for providing
13018 interfaces to these sources.
13021 * Web Searches:: Creating groups from articles that match a string.
13022 * Slashdot:: Reading the Slashdot comments.
13023 * Ultimate:: The Ultimate Bulletin Board systems.
13024 * Web Archive:: Reading mailing list archived on web.
13025 * RSS:: Reading RDF site summary.
13026 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
13029 All the web sources require Emacs/w3 and the url library to work.
13031 The main caveat with all these web sources is that they probably won't
13032 work for a very long time. Gleaning information from the @sc{html} data
13033 is guesswork at best, and when the layout is altered, the Gnus backend
13034 will fail. If you have reasonably new versions of these backends,
13035 though, you should be ok.
13037 One thing all these Web methods have in common is that the Web sources
13038 are often down, unavailable or just plain too slow to be fun. In those
13039 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
13040 Unplugged}) handle downloading articles, and then you can read them at
13041 leisure from your local disk. No more World Wide Wait for you.
13045 @subsection Web Searches
13049 @cindex InReference
13050 @cindex Usenet searches
13051 @cindex searching the Usenet
13053 It's, like, too neat to search the Usenet for articles that match a
13054 string, but it, like, totally @emph{sucks}, like, totally, to use one of
13055 those, like, Web browsers, and you, like, have to, rilly, like, look at
13056 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
13057 searches without having to use a browser.
13059 The @code{nnweb} backend allows an easy interface to the mighty search
13060 engine. You create an @code{nnweb} group, enter a search pattern, and
13061 then enter the group and read the articles like you would any normal
13062 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
13063 Groups}) will do this in an easy-to-use fashion.
13065 @code{nnweb} groups don't really lend themselves to being solid
13066 groups---they have a very fleeting idea of article numbers. In fact,
13067 each time you enter an @code{nnweb} group (not even changing the search
13068 pattern), you are likely to get the articles ordered in a different
13069 manner. Not even using duplicate suppression (@pxref{Duplicate
13070 Suppression}) will help, since @code{nnweb} doesn't even know the
13071 @code{Message-ID} of the articles before reading them using some search
13072 engines (DejaNews, for instance). The only possible way to keep track
13073 of which articles you've read is by scoring on the @code{Date}
13074 header---mark all articles posted before the last date you read the
13077 If the search engine changes its output substantially, @code{nnweb}
13078 won't be able to parse it and will fail. One could hardly fault the Web
13079 providers if they were to do this---their @emph{raison d'être} is to
13080 make money off of advertisements, not to provide services to the
13081 community. Since @code{nnweb} washes the ads off all the articles, one
13082 might think that the providers might be somewhat miffed. We'll see.
13084 You must have the @code{url} and @code{w3} package installed to be able
13085 to use @code{nnweb}.
13087 Virtual server variables:
13092 What search engine type is being used. The currently supported types
13093 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
13097 @vindex nnweb-search
13098 The search string to feed to the search engine.
13100 @item nnweb-max-hits
13101 @vindex nnweb-max-hits
13102 Advisory maximum number of hits per search to display. The default is
13105 @item nnweb-type-definition
13106 @vindex nnweb-type-definition
13107 Type-to-definition alist. This alist says what @code{nnweb} should do
13108 with the various search engine types. The following elements must be
13113 Function to decode the article and provide something that Gnus
13117 Function to create an article number to message header and URL alist.
13120 Function to send the search string to the search engine.
13123 The address the aforementioned function should send the search string
13127 Format string URL to fetch an article by @code{Message-ID}.
13134 @subsection Slashdot
13138 Slashdot (@uref{http://slashdot.org/}) is a popular news site, with
13139 lively discussion following the news articles. @code{nnslashdot} will
13140 let you read this forum in a convenient manner.
13142 The easiest way to read this source is to put something like the
13143 following in your @file{.gnus.el} file:
13146 (setq gnus-secondary-select-methods
13147 '((nnslashdot "")))
13150 This will make Gnus query the @code{nnslashdot} backend for new comments
13151 and groups. The @kbd{F} command will subscribe each new news article as
13152 a new Gnus group, and you can read the comments by entering these
13153 groups. (Note that the default subscription method is to subscribe new
13154 groups as zombies. Other methods are available (@pxref{Subscription
13157 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
13158 command is the most handy tool (@pxref{Foreign Groups}).
13160 When following up to @code{nnslashdot} comments (or posting new
13161 comments), some light @sc{html}izations will be performed. In
13162 particular, text quoted with @samp{> } will be quoted with
13163 @code{blockquote} instead, and signatures will have @code{br} added to
13164 the end of each line. Other than that, you can just write @sc{html}
13165 directly into the message buffer. Note that Slashdot filters out some
13168 The following variables can be altered to change its behavior:
13171 @item nnslashdot-threaded
13172 Whether @code{nnslashdot} should display threaded groups or not. The
13173 default is @code{t}. To be able to display threads, @code{nnslashdot}
13174 has to retrieve absolutely all comments in a group upon entry. If a
13175 threaded display is not required, @code{nnslashdot} will only retrieve
13176 the comments that are actually wanted by the user. Threading is nicer,
13177 but much, much slower than untreaded.
13179 @item nnslashdot-login-name
13180 @vindex nnslashdot-login-name
13181 The login name to use when posting.
13183 @item nnslashdot-password
13184 @vindex nnslashdot-password
13185 The password to use when posting.
13187 @item nnslashdot-directory
13188 @vindex nnslashdot-directory
13189 Where @code{nnslashdot} will store its files. The default is
13190 @samp{~/News/slashdot/}.
13192 @item nnslashdot-active-url
13193 @vindex nnslashdot-active-url
13194 The @sc{url} format string that will be used to fetch the information on
13195 news articles and comments. Default:
13196 @samp{http://slashdot.org/search.pl?section=&min=%d}.
13198 @item nnslashdot-comments-url
13199 @vindex nnslashdot-comments-url
13200 The @sc{url} format string that will be used to fetch comments. The
13202 @samp{http://slashdot.org/comments.pl?sid=%s&threshold=%d&commentsort=%d&mode=flat&startat=%d}.
13204 @item nnslashdot-article-url
13205 @vindex nnslashdot-article-url
13206 The @sc{url} format string that will be used to fetch the news article. The
13208 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
13210 @item nnslashdot-threshold
13211 @vindex nnslashdot-threshold
13212 The score threshold. The default is -1.
13214 @item nnslashdot-group-number
13215 @vindex nnslashdot-group-number
13216 The number of old groups, in addition to the ten latest, to keep
13217 updated. The default is 0.
13224 @subsection Ultimate
13226 @cindex Ultimate Bulletin Board
13228 The Ultimate Bulletin Board (@uref{http://www.ultimatebb.com/}) is
13229 probably the most popular Web bulletin board system used. It has a
13230 quite regular and nice interface, and it's possible to get the
13231 information Gnus needs to keep groups updated.
13233 The easiest way to get started with @code{nnultimate} is to say
13234 something like the following in the group buffer: @kbd{B nnultimate RET
13235 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @sc{url}
13236 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
13237 you're interested in; there's quite a list of them on the Ultimate web
13238 site.) Then subscribe to the groups you're interested in from the
13239 server buffer, and read them from the group buffer.
13241 The following @code{nnultimate} variables can be altered:
13244 @item nnultimate-directory
13245 @vindex nnultimate-directory
13246 The directory where @code{nnultimate} stores its files. The default is
13247 @samp{~/News/ultimate/}.
13252 @subsection Web Archive
13254 @cindex Web Archive
13256 Some mailing lists only have archives on Web servers, such as
13257 @uref{http://www.egroups.com/} and
13258 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
13259 interface, and it's possible to get the information Gnus needs to keep
13262 The easiest way to get started with @code{nnwarchive} is to say
13263 something like the following in the group buffer: @kbd{M-x
13264 gnus-group-make-warchive-group RET an_egroup RET egroups RET
13265 www.egroups.com RET your@@email.address RET}. (Substitute the
13266 @sc{an_egroup} with the mailing list you subscribed, the
13267 @sc{your@@email.address} with your email address.), or to browse the
13268 backend by @kbd{B nnwarchive RET mail-archive RET}.
13270 The following @code{nnwarchive} variables can be altered:
13273 @item nnwarchive-directory
13274 @vindex nnwarchive-directory
13275 The directory where @code{nnwarchive} stores its files. The default is
13276 @samp{~/News/warchive/}.
13278 @item nnwarchive-login
13279 @vindex nnwarchive-login
13280 The account name on the web server.
13282 @item nnwarchive-passwd
13283 @vindex nnwarchive-passwd
13284 The password for your account on the web server.
13292 Some sites have RDF site summary (RSS)
13293 @uref{http://purl.org/rss/1.0/spec}. It has a quite regular and nice
13294 interface, and it's possible to get the information Gnus needs to keep
13297 The easiest way to get started with @code{nnrss} is to say something
13298 like the following in the group buffer: @kbd{B nnrss RET RET}, then
13301 The following @code{nnrss} variables can be altered:
13304 @item nnrss-directory
13305 @vindex nnrss-directory
13306 The directory where @code{nnrss} stores its files. The default is
13307 @samp{~/News/rss/}.
13311 The following code may be helpful, if you want to show the description in
13312 the summary buffer.
13315 (add-to-list 'nnmail-extra-headers nnrss-description-field)
13316 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
13318 (defun gnus-user-format-function-X (header)
13320 (assq nnrss-description-field (mail-header-extra header))))
13321 (if descr (concat "\n\t" (cdr descr)) "")))
13324 @node Customizing w3
13325 @subsection Customizing w3
13331 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
13332 pages. Emacs/w3 is documented in its own manual, but there are some
13333 things that may be more relevant for Gnus users.
13335 For instance, a common question is how to make Emacs/w3 follow links
13336 using the @code{browse-url} functions (which will call some external web
13337 browser like Netscape). Here's one way:
13340 (eval-after-load "w3"
13342 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
13343 (defun w3-fetch (&optional url target)
13344 (interactive (list (w3-read-url-with-default)))
13345 (if (eq major-mode 'gnus-article-mode)
13347 (w3-fetch-orig url target)))))
13350 Put that in your @file{.emacs} file, and hitting links in w3-rendered
13351 @sc{html} in the Gnus article buffers will use @code{browse-url} to
13355 @node Other Sources
13356 @section Other Sources
13358 Gnus can do more than just read news or mail. The methods described
13359 below allow Gnus to view directories and files as if they were
13363 * Directory Groups:: You can read a directory as if it was a newsgroup.
13364 * Anything Groups:: Dired? Who needs dired?
13365 * Document Groups:: Single files can be the basis of a group.
13366 * SOUP:: Reading @sc{soup} packets ``offline''.
13367 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
13368 * IMAP:: Using Gnus as a @sc{imap} client.
13372 @node Directory Groups
13373 @subsection Directory Groups
13375 @cindex directory groups
13377 If you have a directory that has lots of articles in separate files in
13378 it, you might treat it as a newsgroup. The files have to have numerical
13381 This might be an opportune moment to mention @code{ange-ftp} (and its
13382 successor @code{efs}), that most wonderful of all wonderful Emacs
13383 packages. When I wrote @code{nndir}, I didn't think much about it---a
13384 backend to read directories. Big deal.
13386 @code{ange-ftp} changes that picture dramatically. For instance, if you
13387 enter the @code{ange-ftp} file name
13388 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
13389 @code{ange-ftp} or @code{efs} will actually allow you to read this
13390 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
13392 @code{nndir} will use @sc{nov} files if they are present.
13394 @code{nndir} is a ``read-only'' backend---you can't delete or expire
13395 articles with this method. You can use @code{nnmh} or @code{nnml} for
13396 whatever you use @code{nndir} for, so you could switch to any of those
13397 methods if you feel the need to have a non-read-only @code{nndir}.
13400 @node Anything Groups
13401 @subsection Anything Groups
13404 From the @code{nndir} backend (which reads a single spool-like
13405 directory), it's just a hop and a skip to @code{nneething}, which
13406 pretends that any arbitrary directory is a newsgroup. Strange, but
13409 When @code{nneething} is presented with a directory, it will scan this
13410 directory and assign article numbers to each file. When you enter such
13411 a group, @code{nneething} must create ``headers'' that Gnus can use.
13412 After all, Gnus is a newsreader, in case you're forgetting.
13413 @code{nneething} does this in a two-step process. First, it snoops each
13414 file in question. If the file looks like an article (i.e., the first
13415 few lines look like headers), it will use this as the head. If this is
13416 just some arbitrary file without a head (e.g. a C source file),
13417 @code{nneething} will cobble up a header out of thin air. It will use
13418 file ownership, name and date and do whatever it can with these
13421 All this should happen automatically for you, and you will be presented
13422 with something that looks very much like a newsgroup. Totally like a
13423 newsgroup, to be precise. If you select an article, it will be displayed
13424 in the article buffer, just as usual.
13426 If you select a line that represents a directory, Gnus will pop you into
13427 a new summary buffer for this @code{nneething} group. And so on. You can
13428 traverse the entire disk this way, if you feel like, but remember that
13429 Gnus is not dired, really, and does not intend to be, either.
13431 There are two overall modes to this action---ephemeral or solid. When
13432 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
13433 will not store information on what files you have read, and what files
13434 are new, and so on. If you create a solid @code{nneething} group the
13435 normal way with @kbd{G m}, Gnus will store a mapping table between
13436 article numbers and file names, and you can treat this group like any
13437 other groups. When you activate a solid @code{nneething} group, you will
13438 be told how many unread articles it contains, etc., etc.
13443 @item nneething-map-file-directory
13444 @vindex nneething-map-file-directory
13445 All the mapping files for solid @code{nneething} groups will be stored
13446 in this directory, which defaults to @file{~/.nneething/}.
13448 @item nneething-exclude-files
13449 @vindex nneething-exclude-files
13450 All files that match this regexp will be ignored. Nice to use to exclude
13451 auto-save files and the like, which is what it does by default.
13453 @item nneething-include-files
13454 @vindex nneething-include-files
13455 Regexp saying what files to include in the group. If this variable is
13456 non-@code{nil}, only files matching this regexp will be included.
13458 @item nneething-map-file
13459 @vindex nneething-map-file
13460 Name of the map files.
13464 @node Document Groups
13465 @subsection Document Groups
13467 @cindex documentation group
13470 @code{nndoc} is a cute little thing that will let you read a single file
13471 as a newsgroup. Several files types are supported:
13478 The babyl (rmail) mail box.
13483 The standard Unix mbox file.
13485 @cindex MMDF mail box
13487 The MMDF mail box format.
13490 Several news articles appended into a file.
13493 @cindex rnews batch files
13494 The rnews batch transport format.
13495 @cindex forwarded messages
13498 Forwarded articles.
13501 Netscape mail boxes.
13504 MIME multipart messages.
13506 @item standard-digest
13507 The standard (RFC 1153) digest format.
13510 Non-standard digest format---matches most things, but does it badly.
13513 You can also use the special ``file type'' @code{guess}, which means
13514 that @code{nndoc} will try to guess what file type it is looking at.
13515 @code{digest} means that @code{nndoc} should guess what digest type the
13518 @code{nndoc} will not try to change the file or insert any extra headers into
13519 it---it will simply, like, let you use the file as the basis for a
13520 group. And that's it.
13522 If you have some old archived articles that you want to insert into your
13523 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
13524 that. Say you have an old @file{RMAIL} file with mail that you now want
13525 to split into your new @code{nnml} groups. You look at that file using
13526 @code{nndoc} (using the @kbd{G f} command in the group buffer
13527 (@pxref{Foreign Groups})), set the process mark on all the articles in
13528 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
13529 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
13530 file is now also stored in lots of @code{nnml} directories, and you can
13531 delete that pesky @file{RMAIL} file. If you have the guts!
13533 Virtual server variables:
13536 @item nndoc-article-type
13537 @vindex nndoc-article-type
13538 This should be one of @code{mbox}, @code{babyl}, @code{digest},
13539 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
13540 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
13541 @code{slack-digest}, @code{clari-briefs}, @code{nsmail} or @code{guess}.
13543 @item nndoc-post-type
13544 @vindex nndoc-post-type
13545 This variable says whether Gnus is to consider the group a news group or
13546 a mail group. There are two valid values: @code{mail} (the default)
13551 * Document Server Internals:: How to add your own document types.
13555 @node Document Server Internals
13556 @subsubsection Document Server Internals
13558 Adding new document types to be recognized by @code{nndoc} isn't
13559 difficult. You just have to whip up a definition of what the document
13560 looks like, write a predicate function to recognize that document type,
13561 and then hook into @code{nndoc}.
13563 First, here's an example document type definition:
13567 (article-begin . "^\^A\^A\^A\^A\n")
13568 (body-end . "^\^A\^A\^A\^A\n"))
13571 The definition is simply a unique @dfn{name} followed by a series of
13572 regexp pseudo-variable settings. Below are the possible
13573 variables---don't be daunted by the number of variables; most document
13574 types can be defined with very few settings:
13577 @item first-article
13578 If present, @code{nndoc} will skip past all text until it finds
13579 something that match this regexp. All text before this will be
13582 @item article-begin
13583 This setting has to be present in all document type definitions. It
13584 says what the beginning of each article looks like.
13586 @item head-begin-function
13587 If present, this should be a function that moves point to the head of
13590 @item nndoc-head-begin
13591 If present, this should be a regexp that matches the head of the
13594 @item nndoc-head-end
13595 This should match the end of the head of the article. It defaults to
13596 @samp{^$}---the empty line.
13598 @item body-begin-function
13599 If present, this function should move point to the beginning of the body
13603 This should match the beginning of the body of the article. It defaults
13606 @item body-end-function
13607 If present, this function should move point to the end of the body of
13611 If present, this should match the end of the body of the article.
13614 If present, this should match the end of the file. All text after this
13615 regexp will be totally ignored.
13619 So, using these variables @code{nndoc} is able to dissect a document
13620 file into a series of articles, each with a head and a body. However, a
13621 few more variables are needed since not all document types are all that
13622 news-like---variables needed to transform the head or the body into
13623 something that's palatable for Gnus:
13626 @item prepare-body-function
13627 If present, this function will be called when requesting an article. It
13628 will be called with point at the start of the body, and is useful if the
13629 document has encoded some parts of its contents.
13631 @item article-transform-function
13632 If present, this function is called when requesting an article. It's
13633 meant to be used for more wide-ranging transformation of both head and
13634 body of the article.
13636 @item generate-head-function
13637 If present, this function is called to generate a head that Gnus can
13638 understand. It is called with the article number as a parameter, and is
13639 expected to generate a nice head for the article in question. It is
13640 called when requesting the headers of all articles.
13644 Let's look at the most complicated example I can come up with---standard
13649 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
13650 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
13651 (prepare-body-function . nndoc-unquote-dashes)
13652 (body-end-function . nndoc-digest-body-end)
13653 (head-end . "^ ?$")
13654 (body-begin . "^ ?\n")
13655 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
13656 (subtype digest guess))
13659 We see that all text before a 70-width line of dashes is ignored; all
13660 text after a line that starts with that @samp{^End of} is also ignored;
13661 each article begins with a 30-width line of dashes; the line separating
13662 the head from the body may contain a single space; and that the body is
13663 run through @code{nndoc-unquote-dashes} before being delivered.
13665 To hook your own document definition into @code{nndoc}, use the
13666 @code{nndoc-add-type} function. It takes two parameters---the first is
13667 the definition itself and the second (optional) parameter says where in
13668 the document type definition alist to put this definition. The alist is
13669 traversed sequentially, and @code{nndoc-TYPE-type-p} is called for a given type @code{TYPE}. So @code{nndoc-mmdf-type-p} is called to see whether a document
13670 is of @code{mmdf} type, and so on. These type predicates should return
13671 @code{nil} if the document is not of the correct type; @code{t} if it is
13672 of the correct type; and a number if the document might be of the
13673 correct type. A high number means high probability; a low number means
13674 low probability with @samp{0} being the lowest valid number.
13682 In the PC world people often talk about ``offline'' newsreaders. These
13683 are thingies that are combined reader/news transport monstrosities.
13684 With built-in modem programs. Yecchh!
13686 Of course, us Unix Weenie types of human beans use things like
13687 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
13688 transport things like Ghod intended. And then we just use normal
13691 However, it can sometimes be convenient to do something that's a bit
13692 easier on the brain if you have a very slow modem, and you're not really
13693 that interested in doing things properly.
13695 A file format called @sc{soup} has been developed for transporting news
13696 and mail from servers to home machines and back again. It can be a bit
13699 First some terminology:
13704 This is the machine that is connected to the outside world and where you
13705 get news and/or mail from.
13708 This is the machine that you want to do the actual reading and responding
13709 on. It is typically not connected to the rest of the world in any way.
13712 Something that contains messages and/or commands. There are two kinds
13716 @item message packets
13717 These are packets made at the server, and typically contain lots of
13718 messages for you to read. These are called @file{SoupoutX.tgz} by
13719 default, where @var{x} is a number.
13721 @item response packets
13722 These are packets made at the home machine, and typically contains
13723 replies that you've written. These are called @file{SoupinX.tgz} by
13724 default, where @var{x} is a number.
13734 You log in on the server and create a @sc{soup} packet. You can either
13735 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
13736 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
13737 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
13740 You transfer the packet home. Rail, boat, car or modem will do fine.
13743 You put the packet in your home directory.
13746 You fire up Gnus on your home machine using the @code{nnsoup} backend as
13747 the native or secondary server.
13750 You read articles and mail and answer and followup to the things you
13751 want (@pxref{SOUP Replies}).
13754 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
13758 You transfer this packet to the server.
13761 You use Gnus to mail this packet out with the @kbd{G s s} command.
13764 You then repeat until you die.
13768 So you basically have a bipartite system---you use @code{nnsoup} for
13769 reading and Gnus for packing/sending these @sc{soup} packets.
13772 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
13773 * SOUP Groups:: A backend for reading @sc{soup} packets.
13774 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
13778 @node SOUP Commands
13779 @subsubsection SOUP Commands
13781 These are commands for creating and manipulating @sc{soup} packets.
13785 @kindex G s b (Group)
13786 @findex gnus-group-brew-soup
13787 Pack all unread articles in the current group
13788 (@code{gnus-group-brew-soup}). This command understands the
13789 process/prefix convention.
13792 @kindex G s w (Group)
13793 @findex gnus-soup-save-areas
13794 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
13797 @kindex G s s (Group)
13798 @findex gnus-soup-send-replies
13799 Send all replies from the replies packet
13800 (@code{gnus-soup-send-replies}).
13803 @kindex G s p (Group)
13804 @findex gnus-soup-pack-packet
13805 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
13808 @kindex G s r (Group)
13809 @findex nnsoup-pack-replies
13810 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
13813 @kindex O s (Summary)
13814 @findex gnus-soup-add-article
13815 This summary-mode command adds the current article to a @sc{soup} packet
13816 (@code{gnus-soup-add-article}). It understands the process/prefix
13817 convention (@pxref{Process/Prefix}).
13822 There are a few variables to customize where Gnus will put all these
13827 @item gnus-soup-directory
13828 @vindex gnus-soup-directory
13829 Directory where Gnus will save intermediate files while composing
13830 @sc{soup} packets. The default is @file{~/SoupBrew/}.
13832 @item gnus-soup-replies-directory
13833 @vindex gnus-soup-replies-directory
13834 This is what Gnus will use as a temporary directory while sending our
13835 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
13837 @item gnus-soup-prefix-file
13838 @vindex gnus-soup-prefix-file
13839 Name of the file where Gnus stores the last used prefix. The default is
13840 @samp{gnus-prefix}.
13842 @item gnus-soup-packer
13843 @vindex gnus-soup-packer
13844 A format string command for packing a @sc{soup} packet. The default is
13845 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
13847 @item gnus-soup-unpacker
13848 @vindex gnus-soup-unpacker
13849 Format string command for unpacking a @sc{soup} packet. The default is
13850 @samp{gunzip -c %s | tar xvf -}.
13852 @item gnus-soup-packet-directory
13853 @vindex gnus-soup-packet-directory
13854 Where Gnus will look for reply packets. The default is @file{~/}.
13856 @item gnus-soup-packet-regexp
13857 @vindex gnus-soup-packet-regexp
13858 Regular expression matching @sc{soup} reply packets in
13859 @code{gnus-soup-packet-directory}.
13865 @subsubsection @sc{soup} Groups
13868 @code{nnsoup} is the backend for reading @sc{soup} packets. It will
13869 read incoming packets, unpack them, and put them in a directory where
13870 you can read them at leisure.
13872 These are the variables you can use to customize its behavior:
13876 @item nnsoup-tmp-directory
13877 @vindex nnsoup-tmp-directory
13878 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
13879 directory. (@file{/tmp/} by default.)
13881 @item nnsoup-directory
13882 @vindex nnsoup-directory
13883 @code{nnsoup} then moves each message and index file to this directory.
13884 The default is @file{~/SOUP/}.
13886 @item nnsoup-replies-directory
13887 @vindex nnsoup-replies-directory
13888 All replies will be stored in this directory before being packed into a
13889 reply packet. The default is @file{~/SOUP/replies/"}.
13891 @item nnsoup-replies-format-type
13892 @vindex nnsoup-replies-format-type
13893 The @sc{soup} format of the replies packets. The default is @samp{?n}
13894 (rnews), and I don't think you should touch that variable. I probably
13895 shouldn't even have documented it. Drats! Too late!
13897 @item nnsoup-replies-index-type
13898 @vindex nnsoup-replies-index-type
13899 The index type of the replies packet. The default is @samp{?n}, which
13900 means ``none''. Don't fiddle with this one either!
13902 @item nnsoup-active-file
13903 @vindex nnsoup-active-file
13904 Where @code{nnsoup} stores lots of information. This is not an ``active
13905 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
13906 this file or mess it up in any way, you're dead. The default is
13907 @file{~/SOUP/active}.
13909 @item nnsoup-packer
13910 @vindex nnsoup-packer
13911 Format string command for packing a reply @sc{soup} packet. The default
13912 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
13914 @item nnsoup-unpacker
13915 @vindex nnsoup-unpacker
13916 Format string command for unpacking incoming @sc{soup} packets. The
13917 default is @samp{gunzip -c %s | tar xvf -}.
13919 @item nnsoup-packet-directory
13920 @vindex nnsoup-packet-directory
13921 Where @code{nnsoup} will look for incoming packets. The default is
13924 @item nnsoup-packet-regexp
13925 @vindex nnsoup-packet-regexp
13926 Regular expression matching incoming @sc{soup} packets. The default is
13929 @item nnsoup-always-save
13930 @vindex nnsoup-always-save
13931 If non-@code{nil}, save the replies buffer after each posted message.
13937 @subsubsection SOUP Replies
13939 Just using @code{nnsoup} won't mean that your postings and mailings end
13940 up in @sc{soup} reply packets automagically. You have to work a bit
13941 more for that to happen.
13943 @findex nnsoup-set-variables
13944 The @code{nnsoup-set-variables} command will set the appropriate
13945 variables to ensure that all your followups and replies end up in the
13948 In specific, this is what it does:
13951 (setq message-send-news-function 'nnsoup-request-post)
13952 (setq message-send-mail-function 'nnsoup-request-mail)
13955 And that's it, really. If you only want news to go into the @sc{soup}
13956 system you just use the first line. If you only want mail to be
13957 @sc{soup}ed you use the second.
13960 @node Mail-To-News Gateways
13961 @subsection Mail-To-News Gateways
13962 @cindex mail-to-news gateways
13965 If your local @code{nntp} server doesn't allow posting, for some reason
13966 or other, you can post using one of the numerous mail-to-news gateways.
13967 The @code{nngateway} backend provides the interface.
13969 Note that you can't read anything from this backend---it can only be
13975 @item nngateway-address
13976 @vindex nngateway-address
13977 This is the address of the mail-to-news gateway.
13979 @item nngateway-header-transformation
13980 @vindex nngateway-header-transformation
13981 News headers often have to be transformed in some odd way or other
13982 for the mail-to-news gateway to accept it. This variable says what
13983 transformation should be called, and defaults to
13984 @code{nngateway-simple-header-transformation}. The function is called
13985 narrowed to the headers to be transformed and with one parameter---the
13988 This default function just inserts a new @code{To} header based on the
13989 @code{Newsgroups} header and the gateway address.
13990 For instance, an article with this @code{Newsgroups} header:
13993 Newsgroups: alt.religion.emacs
13996 will get this @code{From} header inserted:
13999 To: alt-religion-emacs@@GATEWAY
14002 The following pre-defined functions exist:
14004 @findex nngateway-simple-header-transformation
14007 @item nngateway-simple-header-transformation
14008 Creates a @code{To} header that looks like
14009 @var{newsgroup}@@@code{nngateway-address}.
14011 @findex nngateway-mail2news-header-transformation
14013 @item nngateway-mail2news-header-transformation
14014 Creates a @code{To} header that looks like
14015 @code{nngateway-address}.
14020 (setq gnus-post-method
14022 "mail2news@@replay.com"
14023 (nngateway-header-transformation
14024 nngateway-mail2news-header-transformation)))
14032 So, to use this, simply say something like:
14035 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
14041 @subsection @sc{imap}
14045 @sc{imap} is a network protocol for reading mail (or news, or ...),
14046 think of it as a modernized @sc{nntp}. Connecting to a @sc{imap}
14047 server is much similar to connecting to a news server, you just
14048 specify the network address of the server.
14050 @sc{imap} has two properties. First, @sc{imap} can do everything that
14051 POP can, it can hence be viewed as POP++. Secondly, @sc{imap} is a
14052 mail storage protocol, similar to @sc{nntp} being a news storage
14053 protocol. (@sc{imap} offers more features than @sc{nntp} because news
14054 is more or less read-only whereas mail is read-write.)
14056 If you want to use @sc{imap} as POP++, use an imap entry in
14057 mail-sources. With this, Gnus will fetch mails from the @sc{imap}
14058 server and store them on the local disk. This is not the usage
14059 described in this section. @xref{Mail Sources}.
14061 If you want to use @sc{imap} as a mail storage protocol, use an nnimap
14062 entry in gnus-secondary-select-methods. With this, Gnus will
14063 manipulate mails stored on the @sc{imap} server. This is the kind of
14064 usage explained in this section.
14066 A server configuration in @code{~/.gnus} with a few @sc{imap} servers
14067 might look something like this:
14070 (setq gnus-secondary-select-methods
14071 '((nnimap "simpleserver") ; no special configuration
14072 ; perhaps a ssh port forwarded server:
14074 (nnimap-address "localhost")
14075 (nnimap-server-port 1430))
14076 ; a UW server running on localhost
14078 (nnimap-server-port 143)
14079 (nnimap-address "localhost")
14080 (nnimap-list-pattern ("INBOX" "mail/*")))
14081 ; anonymous public cyrus server:
14082 (nnimap "cyrus.andrew.cmu.edu"
14083 (nnimap-authenticator anonymous)
14084 (nnimap-list-pattern "archive.*")
14085 (nnimap-stream network))
14086 ; a ssl server on a non-standard port:
14088 (nnimap-address "vic20.somewhere.com")
14089 (nnimap-server-port 9930)
14090 (nnimap-stream ssl))))
14093 The following variables can be used to create a virtual @code{nnimap}
14098 @item nnimap-address
14099 @vindex nnimap-address
14101 The address of the remote @sc{imap} server. Defaults to the virtual
14102 server name if not specified.
14104 @item nnimap-server-port
14105 @vindex nnimap-server-port
14106 Port on server to contact. Defaults to port 143, or 993 for SSL.
14108 Note that this should be a integer, example server specification:
14111 (nnimap "mail.server.com"
14112 (nnimap-server-port 4711))
14115 @item nnimap-list-pattern
14116 @vindex nnimap-list-pattern
14117 String or list of strings of mailboxes to limit available groups to.
14118 This is used when the server has very many mailboxes and you're only
14119 interested in a few -- some servers export your home directory via
14120 @sc{imap}, you'll probably want to limit the mailboxes to those in
14121 @file{~/Mail/*} then.
14123 The string can also be a cons of REFERENCE and the string as above, what
14124 REFERENCE is used for is server specific, but on the University of
14125 Washington server it's a directory that will be concatenated with the
14128 Example server specification:
14131 (nnimap "mail.server.com"
14132 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
14133 ("~friend/Mail/" . "list/*"))))
14136 @item nnimap-stream
14137 @vindex nnimap-stream
14138 The type of stream used to connect to your server. By default, nnimap
14139 will detect and automatically use all of the below, with the exception
14140 of SSL. (SSL is being replaced by STARTTLS, which can be automatically
14141 detected, but it's not widely deployed yet).
14143 Example server specification:
14146 (nnimap "mail.server.com"
14147 (nnimap-stream ssl))
14150 Please note that the value of @code{nnimap-stream} is a symbol!
14154 @dfn{gssapi:} Connect with GSSAPI (usually kerberos 5). Requires the
14155 @samp{imtest} program.
14157 @dfn{kerberos4:} Connect with kerberos 4. Requires the @samp{imtest} program.
14159 @dfn{starttls:} Connect via the STARTTLS extension (similar to
14160 SSL). Requires the external library @samp{starttls.el} and program
14163 @dfn{ssl:} Connect through SSL. Requires OpenSSL (the
14164 program @samp{openssl}) or SSLeay (@samp{s_client}).
14166 @dfn{shell:} Use a shell command to start @sc{imap} connection.
14168 @dfn{network:} Plain, TCP/IP network connection.
14171 @vindex imap-kerberos4-program
14172 The @samp{imtest} program is shipped with Cyrus IMAPD. If you're
14173 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
14174 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
14175 to make @code{imap.el} use a pty instead of a pipe when communicating
14176 with @samp{imtest}. You will then suffer from a line length
14177 restrictions on IMAP commands, which might make Gnus seem to hang
14178 indefinitely if you have many articles in a mailbox. The variable
14179 @code{imap-kerberos4-program} contain parameters to pass to the imtest
14182 @vindex imap-ssl-program
14183 For SSL connections, the OpenSSL program is available from
14184 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
14185 and nnimap support it too - although the most recent versions of
14186 SSLeay, 0.9.x, are known to have serious bugs making it
14187 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
14188 work. The variable @code{imap-ssl-program} contain parameters to pass
14191 @vindex imap-shell-program
14192 @vindex imap-shell-host
14193 For @sc{imap} connections using the @code{shell} stream, the variable
14194 @code{imap-shell-program} specify what program to call.
14196 @item nnimap-authenticator
14197 @vindex nnimap-authenticator
14199 The authenticator used to connect to the server. By default, nnimap
14200 will use the most secure authenticator your server is capable of.
14202 Example server specification:
14205 (nnimap "mail.server.com"
14206 (nnimap-authenticator anonymous))
14209 Please note that the value of @code{nnimap-authenticator} is a symbol!
14213 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Require
14214 external program @code{imtest}.
14216 @dfn{kerberos4:} Kerberos authentication. Require external program
14219 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Require
14220 external library @code{digest-md5.el}.
14222 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
14224 @dfn{login:} Plain-text username/password via LOGIN.
14226 @dfn{anonymous:} Login as `anonymous', supplying your emailadress as password.
14229 @item nnimap-expunge-on-close
14231 @vindex nnimap-expunge-on-close
14232 Unlike Parmenides the @sc{imap} designers has decided that things that
14233 doesn't exist actually does exist. More specifically, @sc{imap} has
14234 this concept of marking articles @code{Deleted} which doesn't actually
14235 delete them, and this (marking them @code{Deleted}, that is) is what
14236 nnimap does when you delete a article in Gnus (with @kbd{G DEL} or
14239 Since the articles aren't really removed when we mark them with the
14240 @code{Deleted} flag we'll need a way to actually delete them. Feel like
14241 running in circles yet?
14243 Traditionally, nnimap has removed all articles marked as @code{Deleted}
14244 when closing a mailbox but this is now configurable by this server
14247 The possible options are:
14252 The default behavior, delete all articles marked as "Deleted" when
14255 Never actually delete articles. Currently there is no way of showing
14256 the articles marked for deletion in nnimap, but other @sc{imap} clients
14257 may allow you to do this. If you ever want to run the EXPUNGE command
14258 manually, @xref{Expunging mailboxes}.
14260 When closing mailboxes, nnimap will ask if you wish to expunge deleted
14265 @item nnimap-expunge-search-string
14267 @vindex nnimap-expunge-search-string
14269 This variable contain the IMAP search command sent to server when
14270 searching for articles eligible for expiring. The default is
14271 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
14272 UID set and the second @code{%s} is replaced by a date.
14274 Probably the only useful value to change this to is
14275 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
14276 messages instead of the internal article date. See section 6.4.4 of
14277 RFC 2060 for more information on valid strings.
14279 @item nnimap-authinfo-file
14280 @vindex nnimap-authinfo-file
14282 A file containing credentials used to log in on servers. The format is
14283 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
14284 variable @code{nntp-authinfo-file} for exact syntax; also see
14290 * Splitting in IMAP:: Splitting mail with nnimap.
14291 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
14292 * Expunging mailboxes:: Equivalent of a "compress mailbox" button.
14297 @node Splitting in IMAP
14298 @subsubsection Splitting in @sc{imap}
14299 @cindex splitting imap mail
14301 Splitting is something Gnus users has loved and used for years, and now
14302 the rest of the world is catching up. Yeah, dream on, not many
14303 @sc{imap} server has server side splitting and those that have splitting
14304 seem to use some non-standard protocol. This means that @sc{imap}
14305 support for Gnus has to do it's own splitting.
14309 Here are the variables of interest:
14313 @item nnimap-split-crosspost
14314 @cindex splitting, crosspost
14316 @vindex nnimap-split-crosspost
14318 If non-nil, do crossposting if several split methods match the mail. If
14319 nil, the first match in @code{nnimap-split-rule} found will be used.
14321 Nnmail equivalent: @code{nnmail-crosspost}.
14323 @item nnimap-split-inbox
14324 @cindex splitting, inbox
14326 @vindex nnimap-split-inbox
14328 A string or a list of strings that gives the name(s) of @sc{imap}
14329 mailboxes to split from. Defaults to nil, which means that splitting is
14333 (setq nnimap-split-inbox
14334 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
14337 No nnmail equivalent.
14339 @item nnimap-split-rule
14340 @cindex Splitting, rules
14341 @vindex nnimap-split-rule
14343 New mail found in @code{nnimap-split-inbox} will be split according to
14346 This variable contains a list of lists, where the first element in the
14347 sublist gives the name of the @sc{imap} mailbox to move articles
14348 matching the regexp in the second element in the sublist. Got that?
14349 Neither did I, we need examples.
14352 (setq nnimap-split-rule
14354 "^Sender: owner-nnimap@@vic20.globalcom.se")
14355 ("INBOX.junk" "^Subject:.*MAKE MONEY")
14356 ("INBOX.private" "")))
14359 This will put all articles from the nnimap mailing list into mailbox
14360 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
14361 into INBOX.junk and everything else in INBOX.private.
14363 The first string may contain `\\1' forms, like the ones used by
14364 replace-match to insert sub-expressions from the matched text. For
14368 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
14371 The second element can also be a function. In that case, it will be
14372 called with the first element of the rule as the argument, in a buffer
14373 containing the headers of the article. It should return a non-nil value
14374 if it thinks that the mail belongs in that group.
14376 Nnmail users might recollect that the last regexp had to be empty to
14377 match all articles (like in the example above). This is not required in
14378 nnimap. Articles not matching any of the regexps will not be moved out
14379 of your inbox. (This might affect performance if you keep lots of
14380 unread articles in your inbox, since the splitting code would go over
14381 them every time you fetch new mail.)
14383 These rules are processed from the beginning of the alist toward the
14384 end. The first rule to make a match will "win", unless you have
14385 crossposting enabled. In that case, all matching rules will "win".
14387 This variable can also have a function as its value, the function will
14388 be called with the headers narrowed and should return a group where it
14389 thinks the article should be split to. See @code{nnimap-split-fancy}.
14391 The splitting code tries to create mailboxes if it need too.
14393 To allow for different split rules on different virtual servers, and
14394 even different split rules in different inboxes on the same server,
14395 the syntax of this variable have been extended along the lines of:
14398 (setq nnimap-split-rule
14399 '(("my1server" (".*" (("ding" "ding@@gnus.org")
14400 ("junk" "From:.*Simon")))
14401 ("my2server" ("INBOX" nnimap-split-fancy))
14402 ("my[34]server" (".*" (("private" "To:.*Simon")
14403 ("junk" my-junk-func)))))
14406 The virtual server name is in fact a regexp, so that the same rules
14407 may apply to several servers. In the example, the servers
14408 @code{my3server} and @code{my4server} both use the same rules.
14409 Similarly, the inbox string is also a regexp. The actual splitting
14410 rules are as before, either a function, or a list with group/regexp or
14411 group/function elements.
14413 Nnmail equivalent: @code{nnmail-split-methods}.
14415 @item nnimap-split-predicate
14417 @vindex nnimap-split-predicate
14419 Mail matching this predicate in @code{nnimap-split-inbox} will be
14420 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
14422 This might be useful if you use another @sc{imap} client to read mail in
14423 your inbox but would like Gnus to split all articles in the inbox
14424 regardless of readedness. Then you might change this to
14427 @item nnimap-split-fancy
14428 @cindex splitting, fancy
14429 @findex nnimap-split-fancy
14430 @vindex nnimap-split-fancy
14432 It's possible to set @code{nnimap-split-rule} to
14433 @code{nnmail-split-fancy} if you want to use fancy
14434 splitting. @xref{Fancy Mail Splitting}.
14436 However, to be able to have different fancy split rules for nnmail and
14437 nnimap backends you can set @code{nnimap-split-rule} to
14438 @code{nnimap-split-fancy} and define the nnimap specific fancy split
14439 rule in @code{nnimap-split-fancy}.
14444 (setq nnimap-split-rule 'nnimap-split-fancy
14445 nnimap-split-fancy ...)
14448 Nnmail equivalent: @code{nnmail-split-fancy}.
14452 @node Editing IMAP ACLs
14453 @subsubsection Editing @sc{imap} ACLs
14454 @cindex editing imap acls
14455 @cindex Access Control Lists
14456 @cindex Editing @sc{imap} ACLs
14458 @findex gnus-group-nnimap-edit-acl
14460 ACL stands for Access Control List. ACLs are used in @sc{imap} for
14461 limiting (or enabling) other users access to your mail boxes. Not all
14462 @sc{imap} servers support this, this function will give an error if it
14465 To edit a ACL for a mailbox, type @kbd{G l}
14466 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with a ACL
14467 editing window with detailed instructions.
14469 Some possible uses:
14473 Giving "anyone" the "lrs" rights (lookup, read, keep seen/unseen flags)
14474 on your mailing list mailboxes enables other users on the same server to
14475 follow the list without subscribing to it.
14477 At least with the Cyrus server, you are required to give the user
14478 "anyone" posting ("p") capabilities to have "plussing" work (that is,
14479 mail sent to user+mailbox@@domain ending up in the @sc{imap} mailbox
14483 @node Expunging mailboxes
14484 @subsubsection Expunging mailboxes
14488 @cindex Manual expunging
14490 @findex gnus-group-nnimap-expunge
14492 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
14493 you may want the option of expunging all deleted articles in a mailbox
14494 manually. This is exactly what @kbd{G x} does.
14496 Currently there is no way of showing deleted articles, you can just
14501 @node Combined Groups
14502 @section Combined Groups
14504 Gnus allows combining a mixture of all the other group types into bigger
14508 * Virtual Groups:: Combining articles from many groups.
14509 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
14513 @node Virtual Groups
14514 @subsection Virtual Groups
14516 @cindex virtual groups
14517 @cindex merging groups
14519 An @dfn{nnvirtual group} is really nothing more than a collection of
14522 For instance, if you are tired of reading many small groups, you can
14523 put them all in one big group, and then grow tired of reading one
14524 big, unwieldy group. The joys of computing!
14526 You specify @code{nnvirtual} as the method. The address should be a
14527 regexp to match component groups.
14529 All marks in the virtual group will stick to the articles in the
14530 component groups. So if you tick an article in a virtual group, the
14531 article will also be ticked in the component group from whence it came.
14532 (And vice versa---marks from the component groups will also be shown in
14533 the virtual group.)
14535 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
14536 newsgroups into one, big, happy newsgroup:
14539 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
14542 The component groups can be native or foreign; everything should work
14543 smoothly, but if your computer explodes, it was probably my fault.
14545 Collecting the same group from several servers might actually be a good
14546 idea if users have set the Distribution header to limit distribution.
14547 If you would like to read @samp{soc.motss} both from a server in Japan
14548 and a server in Norway, you could use the following as the group regexp:
14551 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
14554 (Remember, though, that if you're creating the group with @kbd{G m}, you
14555 shouldn't double the backslashes, and you should leave off the quote
14556 characters at the beginning and the end of the string.)
14558 This should work kinda smoothly---all articles from both groups should
14559 end up in this one, and there should be no duplicates. Threading (and
14560 the rest) will still work as usual, but there might be problems with the
14561 sequence of articles. Sorting on date might be an option here
14562 (@pxref{Selecting a Group}).
14564 One limitation, however---all groups included in a virtual
14565 group have to be alive (i.e., subscribed or unsubscribed). Killed or
14566 zombie groups can't be component groups for @code{nnvirtual} groups.
14568 @vindex nnvirtual-always-rescan
14569 If the @code{nnvirtual-always-rescan} is non-@code{nil},
14570 @code{nnvirtual} will always scan groups for unread articles when
14571 entering a virtual group. If this variable is @code{nil} (which is the
14572 default) and you read articles in a component group after the virtual
14573 group has been activated, the read articles from the component group
14574 will show up when you enter the virtual group. You'll also see this
14575 effect if you have two virtual groups that have a component group in
14576 common. If that's the case, you should set this variable to @code{t}.
14577 Or you can just tap @code{M-g} on the virtual group every time before
14578 you enter it---it'll have much the same effect.
14580 @code{nnvirtual} can have both mail and news groups as component groups.
14581 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
14582 has to ask the backend of the component group the article comes from
14583 whether it is a news or mail backend. However, when you do a @kbd{^},
14584 there is typically no sure way for the component backend to know this,
14585 and in that case @code{nnvirtual} tells Gnus that the article came from a
14586 not-news backend. (Just to be on the safe side.)
14588 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
14589 line from the article you respond to in these cases.
14593 @node Kibozed Groups
14594 @subsection Kibozed Groups
14598 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
14599 the news feed''. @code{nnkiboze} is a backend that will do this for
14600 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
14601 with useless requests! Oh happiness!
14603 @kindex G k (Group)
14604 To create a kibozed group, use the @kbd{G k} command in the group
14607 The address field of the @code{nnkiboze} method is, as with
14608 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
14609 @code{nnkiboze} group. That's where most similarities between @code{nnkiboze}
14610 and @code{nnvirtual} end.
14612 In addition to this regexp detailing component groups, an @code{nnkiboze} group
14613 must have a score file to say what articles are to be included in
14614 the group (@pxref{Scoring}).
14616 @kindex M-x nnkiboze-generate-groups
14617 @findex nnkiboze-generate-groups
14618 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
14619 @code{nnkiboze} groups you want to have. This command will take time. Lots of
14620 time. Oodles and oodles of time. Gnus has to fetch the headers from
14621 all the articles in all the component groups and run them through the
14622 scoring process to determine if there are any articles in the groups
14623 that are to be part of the @code{nnkiboze} groups.
14625 Please limit the number of component groups by using restrictive
14626 regexps. Otherwise your sysadmin may become annoyed with you, and the
14627 @sc{nntp} site may throw you off and never let you back in again.
14628 Stranger things have happened.
14630 @code{nnkiboze} component groups do not have to be alive---they can be dead,
14631 and they can be foreign. No restrictions.
14633 @vindex nnkiboze-directory
14634 The generation of an @code{nnkiboze} group means writing two files in
14635 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
14636 contains the @sc{nov} header lines for all the articles in the group,
14637 and the other is an additional @file{.newsrc} file to store information
14638 on what groups have been searched through to find component articles.
14640 Articles marked as read in the @code{nnkiboze} group will have
14641 their @sc{nov} lines removed from the @sc{nov} file.
14644 @node Gnus Unplugged
14645 @section Gnus Unplugged
14650 @cindex Gnus Unplugged
14652 In olden times (ca. February '88), people used to run their newsreaders
14653 on big machines with permanent connections to the net. News transport
14654 was dealt with by news servers, and all the newsreaders had to do was to
14655 read news. Believe it or not.
14657 Nowadays most people read news and mail at home, and use some sort of
14658 modem to connect to the net. To avoid running up huge phone bills, it
14659 would be nice to have a way to slurp down all the news and mail, hang up
14660 the phone, read for several hours, and then upload any responses you
14661 have to make. And then you repeat the procedure.
14663 Of course, you can use news servers for doing this as well. I've used
14664 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
14665 for some years, but doing that's a bore. Moving the news server
14666 functionality up to the newsreader makes sense if you're the only person
14667 reading news on a machine.
14669 Using Gnus as an ``offline'' newsreader is quite simple.
14673 First, set up Gnus as you would do if you were running it on a machine
14674 that has full connection to the net. Go ahead. I'll still be waiting
14678 Then, put the following magical incantation at the end of your
14679 @file{.gnus.el} file:
14686 That's it. Gnus is now an ``offline'' newsreader.
14688 Of course, to use it as such, you have to learn a few new commands.
14691 * Agent Basics:: How it all is supposed to work.
14692 * Agent Categories:: How to tell the Gnus Agent what to download.
14693 * Agent Commands:: New commands for all the buffers.
14694 * Agent Expiry:: How to make old articles go away.
14695 * Agent and IMAP:: How to use the Agent with IMAP.
14696 * Outgoing Messages:: What happens when you post/mail something?
14697 * Agent Variables:: Customizing is fun.
14698 * Example Setup:: An example @file{.gnus.el} file for offline people.
14699 * Batching Agents:: How to fetch news from a @code{cron} job.
14700 * Agent Caveats:: What you think it'll do and what it does.
14705 @subsection Agent Basics
14707 First, let's get some terminology out of the way.
14709 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
14710 connection to the net (and notified the Agent that this is the case).
14711 When the connection to the net is up again (and Gnus knows this), the
14712 Agent is @dfn{plugged}.
14714 The @dfn{local} machine is the one you're running on, and which isn't
14715 connected to the net continuously.
14717 @dfn{Downloading} means fetching things from the net to your local
14718 machine. @dfn{Uploading} is doing the opposite.
14720 Let's take a typical Gnus session using the Agent.
14725 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
14726 Agent in a disconnected state. You can read all the news that you have
14727 already fetched while in this mode.
14730 You then decide to see whether any new news has arrived. You connect
14731 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
14732 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
14733 as usual. To check for new mail in unplugged mode, see (@pxref{Mail
14734 Source Specifiers}).
14737 You can then read the new news immediately, or you can download the news
14738 onto your local machine. If you want to do the latter, you press @kbd{g}
14739 to check if there are any new news and then @kbd{J
14740 s} to fetch all the eligible articles in all the groups. (To let Gnus
14741 know which articles you want to download, @pxref{Agent Categories}.)
14744 After fetching the articles, you press @kbd{J j} to make Gnus become
14745 unplugged again, and you shut down the PPP thing (or whatever). And
14746 then you read the news offline.
14749 And then you go to step 2.
14752 Here are some things you should do the first time (or so) that you use
14758 Decide which servers should be covered by the Agent. If you have a mail
14759 backend, it would probably be nonsensical to have it covered by the
14760 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
14761 @kbd{J a} the server (or servers) that you wish to have covered by the
14762 Agent (@pxref{Server Agent Commands}). This will typically be only the
14763 primary select method, which is listed on the bottom in the buffer.
14766 Decide on download policy. @xref{Agent Categories}.
14773 @node Agent Categories
14774 @subsection Agent Categories
14776 One of the main reasons to integrate the news transport layer into the
14777 newsreader is to allow greater control over what articles to download.
14778 There's not much point in downloading huge amounts of articles, just to
14779 find out that you're not interested in reading any of them. It's better
14780 to be somewhat more conservative in choosing what to download, and then
14781 mark the articles for downloading manually if it should turn out that
14782 you're interested in the articles anyway.
14784 The main way to control what is to be downloaded is to create a
14785 @dfn{category} and then assign some (or all) groups to this category.
14786 Groups that do not belong in any other category belong to the
14787 @code{default} category. Gnus has its own buffer for creating and
14788 managing categories.
14791 * Category Syntax:: What a category looks like.
14792 * Category Buffer:: A buffer for maintaining categories.
14793 * Category Variables:: Customize'r'Us.
14797 @node Category Syntax
14798 @subsubsection Category Syntax
14800 A category consists of two things.
14804 A predicate which (generally) gives a rough outline of which articles
14805 are eligible for downloading; and
14808 a score rule which (generally) gives you a finer granularity when
14809 deciding what articles to download. (Note that this @dfn{download
14810 score} is not necessarily related to normal scores.)
14813 A predicate in its simplest form can be a single predicate such as
14814 @code{true} or @code{false}. These two will download every available
14815 article or nothing respectively. In the case of these two special
14816 predicates an additional score rule is superfluous.
14818 Predicates of @code{high} or @code{low} download articles in respect of
14819 their scores in relationship to @code{gnus-agent-high-score} and
14820 @code{gnus-agent-low-score} as described below.
14822 To gain even finer control of what is to be regarded eligible for
14823 download a predicate can consist of a number of predicates with logical
14824 operators sprinkled in between.
14826 Perhaps some examples are in order.
14828 Here's a simple predicate. (It's the default predicate, in fact, used
14829 for all groups that don't belong to any other category.)
14835 Quite simple, eh? This predicate is true if and only if the article is
14836 short (for some value of ``short'').
14838 Here's a more complex predicate:
14847 This means that an article should be downloaded if it has a high score,
14848 or if the score is not low and the article is not long. You get the
14851 The available logical operators are @code{or}, @code{and} and
14852 @code{not}. (If you prefer, you can use the more ``C''-ish operators
14853 @samp{|}, @code{&} and @code{!} instead.)
14855 The following predicates are pre-defined, but if none of these fit what
14856 you want to do, you can write your own.
14860 True iff the article is shorter than @code{gnus-agent-short-article}
14861 lines; default 100.
14864 True iff the article is longer than @code{gnus-agent-long-article}
14865 lines; default 200.
14868 True iff the article has a download score less than
14869 @code{gnus-agent-low-score}; default 0.
14872 True iff the article has a download score greater than
14873 @code{gnus-agent-high-score}; default 0.
14876 True iff the Gnus Agent guesses that the article is spam. The
14877 heuristics may change over time, but at present it just computes a
14878 checksum and sees whether articles match.
14887 If you want to create your own predicate function, here's what you have
14888 to know: The functions are called with no parameters, but the
14889 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
14892 For example, you could decide that you don't want to download articles
14893 that were posted more than a certain number of days ago (e.g. posted
14894 more than @code{gnus-agent-expire-days} ago) you might write a function
14895 something along the lines of the following:
14898 (defun my-article-old-p ()
14899 "Say whether an article is old."
14900 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
14901 (- (time-to-days (current-time)) gnus-agent-expire-days)))
14904 with the predicate then defined as:
14907 (not my-article-old-p)
14910 or you could append your predicate to the predefined
14911 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
14912 wherever. (Note: this would have to be at a point *after*
14913 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
14916 (setq gnus-category-predicate-alist
14917 (append gnus-category-predicate-alist
14918 '((old . my-article-old-p))))
14921 and simply specify your predicate as:
14927 If/when using something like the above, be aware that there are many
14928 misconfigured systems/mailers out there and so an article's date is not
14929 always a reliable indication of when it was posted. Hell, some people
14930 just don't give a damn.
14932 The above predicates apply to *all* the groups which belong to the
14933 category. However, if you wish to have a specific predicate for an
14934 individual group within a category, or you're just too lazy to set up a
14935 new category, you can enter a group's individual predicate in it's group
14936 parameters like so:
14939 (agent-predicate . short)
14942 This is the group parameter equivalent of the agent category default.
14943 Note that when specifying a single word predicate like this, the
14944 @code{agent-predicate} specification must be in dotted pair notation.
14946 The equivalent of the longer example from above would be:
14949 (agent-predicate or high (and (not low) (not long)))
14952 The outer parenthesis required in the category specification are not
14953 entered here as, not being in dotted pair notation, the value of the
14954 predicate is assumed to be a list.
14957 Now, the syntax of the download score is the same as the syntax of
14958 normal score files, except that all elements that require actually
14959 seeing the article itself are verboten. This means that only the
14960 following headers can be scored on: @code{Subject}, @code{From},
14961 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
14962 @code{Lines}, and @code{Xref}.
14964 As with predicates, the specification of the @code{download score rule}
14965 to use in respect of a group can be in either the category definition if
14966 it's to be applicable to all groups in therein, or a group's parameters
14967 if it's to be specific to that group.
14969 In both of these places the @code{download score rule} can take one of
14976 This has the same syntax as a normal gnus score file except only a
14977 subset of scoring keywords are available as mentioned above.
14983 Category specification
14987 ("Lars Ingebrigtsen" 1000000 nil s))
14993 Group Parameter specification
14996 (agent-score ("from"
14997 ("Lars Ingebrigtsen" 1000000 nil s))
15002 Again, note the omission of the outermost parenthesis here.
15008 These score files must *only* contain the permitted scoring keywords
15015 Category specification
15018 ("~/News/agent.SCORE")
15024 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
15028 Group Parameter specification
15031 (agent-score "~/News/agent.SCORE")
15034 Additional score files can be specified as above. Need I say anything
15039 Use @code{normal} score files
15041 If you don't want to maintain two sets of scoring rules for a group, and
15042 your desired @code{downloading} criteria for a group are the same as your
15043 @code{reading} criteria then you can tell the agent to refer to your
15044 @code{normal} score files when deciding what to download.
15046 These directives in either the category definition or a group's
15047 parameters will cause the agent to read in all the applicable score
15048 files for a group, *filtering out* those sections that do not
15049 relate to one of the permitted subset of scoring keywords.
15053 Category Specification
15060 Group Parameter specification
15063 (agent-score . file)
15068 @node Category Buffer
15069 @subsubsection Category Buffer
15071 You'd normally do all category maintenance from the category buffer.
15072 When you enter it for the first time (with the @kbd{J c} command from
15073 the group buffer), you'll only see the @code{default} category.
15075 The following commands are available in this buffer:
15079 @kindex q (Category)
15080 @findex gnus-category-exit
15081 Return to the group buffer (@code{gnus-category-exit}).
15084 @kindex k (Category)
15085 @findex gnus-category-kill
15086 Kill the current category (@code{gnus-category-kill}).
15089 @kindex c (Category)
15090 @findex gnus-category-copy
15091 Copy the current category (@code{gnus-category-copy}).
15094 @kindex a (Category)
15095 @findex gnus-category-add
15096 Add a new category (@code{gnus-category-add}).
15099 @kindex p (Category)
15100 @findex gnus-category-edit-predicate
15101 Edit the predicate of the current category
15102 (@code{gnus-category-edit-predicate}).
15105 @kindex g (Category)
15106 @findex gnus-category-edit-groups
15107 Edit the list of groups belonging to the current category
15108 (@code{gnus-category-edit-groups}).
15111 @kindex s (Category)
15112 @findex gnus-category-edit-score
15113 Edit the download score rule of the current category
15114 (@code{gnus-category-edit-score}).
15117 @kindex l (Category)
15118 @findex gnus-category-list
15119 List all the categories (@code{gnus-category-list}).
15123 @node Category Variables
15124 @subsubsection Category Variables
15127 @item gnus-category-mode-hook
15128 @vindex gnus-category-mode-hook
15129 Hook run in category buffers.
15131 @item gnus-category-line-format
15132 @vindex gnus-category-line-format
15133 Format of the lines in the category buffer (@pxref{Formatting
15134 Variables}). Valid elements are:
15138 The name of the category.
15141 The number of groups in the category.
15144 @item gnus-category-mode-line-format
15145 @vindex gnus-category-mode-line-format
15146 Format of the category mode line (@pxref{Mode Line Formatting}).
15148 @item gnus-agent-short-article
15149 @vindex gnus-agent-short-article
15150 Articles that have fewer lines than this are short. Default 100.
15152 @item gnus-agent-long-article
15153 @vindex gnus-agent-long-article
15154 Articles that have more lines than this are long. Default 200.
15156 @item gnus-agent-low-score
15157 @vindex gnus-agent-low-score
15158 Articles that have a score lower than this have a low score. Default
15161 @item gnus-agent-high-score
15162 @vindex gnus-agent-high-score
15163 Articles that have a score higher than this have a high score. Default
15169 @node Agent Commands
15170 @subsection Agent Commands
15172 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
15173 (@code{gnus-agent-toggle-plugged} command works in all modes, and
15174 toggles the plugged/unplugged state of the Gnus Agent.
15178 * Group Agent Commands::
15179 * Summary Agent Commands::
15180 * Server Agent Commands::
15183 You can run a complete batch fetch from the command line with the
15184 following incantation:
15186 @cindex gnus-agent-batch-fetch
15188 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
15193 @node Group Agent Commands
15194 @subsubsection Group Agent Commands
15198 @kindex J u (Agent Group)
15199 @findex gnus-agent-fetch-groups
15200 Fetch all eligible articles in the current group
15201 (@code{gnus-agent-fetch-groups}).
15204 @kindex J c (Agent Group)
15205 @findex gnus-enter-category-buffer
15206 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
15209 @kindex J s (Agent Group)
15210 @findex gnus-agent-fetch-session
15211 Fetch all eligible articles in all groups
15212 (@code{gnus-agent-fetch-session}).
15215 @kindex J S (Agent Group)
15216 @findex gnus-group-send-drafts
15217 Send all sendable messages in the draft group
15218 (@code{gnus-group-send-drafts}). @xref{Drafts}.
15221 @kindex J a (Agent Group)
15222 @findex gnus-agent-add-group
15223 Add the current group to an Agent category
15224 (@code{gnus-agent-add-group}). This command understands the
15225 process/prefix convention (@pxref{Process/Prefix}).
15228 @kindex J r (Agent Group)
15229 @findex gnus-agent-remove-group
15230 Remove the current group from its category, if any
15231 (@code{gnus-agent-remove-group}). This command understands the
15232 process/prefix convention (@pxref{Process/Prefix}).
15235 @kindex J Y (Agent Group)
15236 @findex gnus-agent-synchronize-flags
15237 Synchronize flags changed while unplugged with remote server, if any.
15243 @node Summary Agent Commands
15244 @subsubsection Summary Agent Commands
15248 @kindex J # (Agent Summary)
15249 @findex gnus-agent-mark-article
15250 Mark the article for downloading (@code{gnus-agent-mark-article}).
15253 @kindex J M-# (Agent Summary)
15254 @findex gnus-agent-unmark-article
15255 Remove the downloading mark from the article
15256 (@code{gnus-agent-unmark-article}).
15259 @kindex @@ (Agent Summary)
15260 @findex gnus-agent-toggle-mark
15261 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
15264 @kindex J c (Agent Summary)
15265 @findex gnus-agent-catchup
15266 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
15271 @node Server Agent Commands
15272 @subsubsection Server Agent Commands
15276 @kindex J a (Agent Server)
15277 @findex gnus-agent-add-server
15278 Add the current server to the list of servers covered by the Gnus Agent
15279 (@code{gnus-agent-add-server}).
15282 @kindex J r (Agent Server)
15283 @findex gnus-agent-remove-server
15284 Remove the current server from the list of servers covered by the Gnus
15285 Agent (@code{gnus-agent-remove-server}).
15291 @subsection Agent Expiry
15293 @vindex gnus-agent-expire-days
15294 @findex gnus-agent-expire
15295 @kindex M-x gnus-agent-expire
15296 @cindex Agent expiry
15297 @cindex Gnus Agent expiry
15300 @code{nnagent} doesn't handle expiry. Instead, there's a special
15301 @code{gnus-agent-expire} command that will expire all read articles that
15302 are older than @code{gnus-agent-expire-days} days. It can be run
15303 whenever you feel that you're running out of space. It's not
15304 particularly fast or efficient, and it's not a particularly good idea to
15305 interrupt it (with @kbd{C-g} or anything else) once you've started it.
15307 @vindex gnus-agent-expire-all
15308 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
15309 expire all articles---unread, read, ticked and dormant. If @code{nil}
15310 (which is the default), only read articles are eligible for expiry, and
15311 unread, ticked and dormant articles will be kept indefinitely.
15314 @node Agent and IMAP
15315 @subsection Agent and IMAP
15317 The Agent work with any Gnus backend, including nnimap. However,
15318 since there are some conceptual differences between @sc{nntp} and
15319 @sc{imap}, this section (should) provide you with some information to
15320 make Gnus Agent work smoother as a @sc{imap} Disconnected Mode client.
15322 The first thing to keep in mind is that all flags (read, ticked, etc)
15323 are kept on the @sc{imap} server, rather than in @code{.newsrc} as is the
15324 case for nntp. Thus Gnus need to remember flag changes when
15325 disconnected, and synchronize these flags when you plug back in.
15327 Gnus keep track of flag changes when reading nnimap groups under the
15328 Agent by default. When you plug back in, by default Gnus will check if
15329 you have any changed any flags and ask if you wish to synchronize these
15330 with the server. This behavior is customizable with
15331 @code{gnus-agent-synchronize-flags}.
15333 @vindex gnus-agent-synchronize-flags
15334 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
15335 never automatically synchronize flags. If it is @code{ask}, the
15336 default, the Agent will check if you made any changes and if so ask if
15337 you wish to synchronize these when you re-connect. If it has any other
15338 value, all flags will be synchronized automatically.
15340 If you do not wish to automatically synchronize flags when you
15341 re-connect, this can be done manually with the
15342 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
15343 in the group buffer by default.
15345 Some things are currently not implemented in the Agent that you'd might
15346 expect from a disconnected @sc{imap} client, including:
15351 Copying/moving articles into nnimap groups when unplugged.
15354 Creating/deleting nnimap groups when unplugged.
15358 Technical note: the synchronization algorithm does not work by "pushing"
15359 all local flags to the server, but rather incrementally update the
15360 server view of flags by changing only those flags that were changed by
15361 the user. Thus, if you set one flag on a article, quit the group and
15362 re-select the group and remove the flag; the flag will be set and
15363 removed from the server when you "synchronize". The queued flag
15364 operations can be found in the per-server @code{flags} file in the Agent
15365 directory. It's emptied when you synchronize flags.
15368 @node Outgoing Messages
15369 @subsection Outgoing Messages
15371 When Gnus is unplugged, all outgoing messages (both mail and news) are
15372 stored in the draft groups (@pxref{Drafts}). You can view them there
15373 after posting, and edit them at will.
15375 When Gnus is plugged again, you can send the messages either from the
15376 draft group with the special commands available there, or you can use
15377 the @kbd{J S} command in the group buffer to send all the sendable
15378 messages in the draft group.
15382 @node Agent Variables
15383 @subsection Agent Variables
15386 @item gnus-agent-directory
15387 @vindex gnus-agent-directory
15388 Where the Gnus Agent will store its files. The default is
15389 @file{~/News/agent/}.
15391 @item gnus-agent-handle-level
15392 @vindex gnus-agent-handle-level
15393 Groups on levels (@pxref{Group Levels}) higher than this variable will
15394 be ignored by the Agent. The default is @code{gnus-level-subscribed},
15395 which means that only subscribed group will be considered by the Agent
15398 @item gnus-agent-plugged-hook
15399 @vindex gnus-agent-plugged-hook
15400 Hook run when connecting to the network.
15402 @item gnus-agent-unplugged-hook
15403 @vindex gnus-agent-unplugged-hook
15404 Hook run when disconnecting from the network.
15409 @node Example Setup
15410 @subsection Example Setup
15412 If you don't want to read this manual, and you have a fairly standard
15413 setup, you may be able to use something like the following as your
15414 @file{.gnus.el} file to get started.
15417 ;;; Define how Gnus is to fetch news. We do this over @sc{nntp}
15418 ;;; from your ISP's server.
15419 (setq gnus-select-method '(nntp "news.your-isp.com"))
15421 ;;; Define how Gnus is to read your mail. We read mail from
15422 ;;; your ISP's POP server.
15423 (setq mail-sources '((pop :server "pop.your-isp.com")))
15425 ;;; Say how Gnus is to store the mail. We use nnml groups.
15426 (setq gnus-secondary-select-methods '((nnml "")))
15428 ;;; Make Gnus into an offline newsreader.
15432 That should be it, basically. Put that in your @file{~/.gnus.el} file,
15433 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
15436 If this is the first time you've run Gnus, you will be subscribed
15437 automatically to a few default newsgroups. You'll probably want to
15438 subscribe to more groups, and to do that, you have to query the
15439 @sc{nntp} server for a complete list of groups with the @kbd{A A}
15440 command. This usually takes quite a while, but you only have to do it
15443 After reading and parsing a while, you'll be presented with a list of
15444 groups. Subscribe to the ones you want to read with the @kbd{u}
15445 command. @kbd{l} to make all the killed groups disappear after you've
15446 subscribe to all the groups you want to read. (@kbd{A k} will bring
15447 back all the killed groups.)
15449 You can now read the groups at once, or you can download the articles
15450 with the @kbd{J s} command. And then read the rest of this manual to
15451 find out which of the other gazillion things you want to customize.
15454 @node Batching Agents
15455 @subsection Batching Agents
15457 Having the Gnus Agent fetch articles (and post whatever messages you've
15458 written) is quite easy once you've gotten things set up properly. The
15459 following shell script will do everything that is necessary:
15463 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
15467 @node Agent Caveats
15468 @subsection Agent Caveats
15470 The Gnus Agent doesn't seem to work like most other offline
15471 newsreaders. Here are some common questions that some imaginary people
15475 @item If I read an article while plugged, do they get entered into the
15480 @item If I read an article while plugged, and the article already exists
15481 in the Agent, will it get downloaded once more?
15487 In short, when Gnus is unplugged, it only looks into the locally stored
15488 articles; when it's plugged, it only talks to your ISP.
15495 Other people use @dfn{kill files}, but we here at Gnus Towers like
15496 scoring better than killing, so we'd rather switch than fight. They do
15497 something completely different as well, so sit up straight and pay
15500 @vindex gnus-summary-mark-below
15501 All articles have a default score (@code{gnus-summary-default-score}),
15502 which is 0 by default. This score may be raised or lowered either
15503 interactively or by score files. Articles that have a score lower than
15504 @code{gnus-summary-mark-below} are marked as read.
15506 Gnus will read any @dfn{score files} that apply to the current group
15507 before generating the summary buffer.
15509 There are several commands in the summary buffer that insert score
15510 entries based on the current article. You can, for instance, ask Gnus to
15511 lower or increase the score of all articles with a certain subject.
15513 There are two sorts of scoring entries: Permanent and temporary.
15514 Temporary score entries are self-expiring entries. Any entries that are
15515 temporary and have not been used for, say, a week, will be removed
15516 silently to help keep the sizes of the score files down.
15519 * Summary Score Commands:: Adding score entries for the current group.
15520 * Group Score Commands:: General score commands.
15521 * Score Variables:: Customize your scoring. (My, what terminology).
15522 * Score File Format:: What a score file may contain.
15523 * Score File Editing:: You can edit score files by hand as well.
15524 * Adaptive Scoring:: Big Sister Gnus knows what you read.
15525 * Home Score File:: How to say where new score entries are to go.
15526 * Followups To Yourself:: Having Gnus notice when people answer you.
15527 * Scoring Tips:: How to score effectively.
15528 * Reverse Scoring:: That problem child of old is not problem.
15529 * Global Score Files:: Earth-spanning, ear-splitting score files.
15530 * Kill Files:: They are still here, but they can be ignored.
15531 * Converting Kill Files:: Translating kill files to score files.
15532 * GroupLens:: Getting predictions on what you like to read.
15533 * Advanced Scoring:: Using logical expressions to build score rules.
15534 * Score Decays:: It can be useful to let scores wither away.
15538 @node Summary Score Commands
15539 @section Summary Score Commands
15540 @cindex score commands
15542 The score commands that alter score entries do not actually modify real
15543 score files. That would be too inefficient. Gnus maintains a cache of
15544 previously loaded score files, one of which is considered the
15545 @dfn{current score file alist}. The score commands simply insert
15546 entries into this list, and upon group exit, this list is saved.
15548 The current score file is by default the group's local score file, even
15549 if no such score file actually exists. To insert score commands into
15550 some other score file (e.g. @file{all.SCORE}), you must first make this
15551 score file the current one.
15553 General score commands that don't actually change the score file:
15558 @kindex V s (Summary)
15559 @findex gnus-summary-set-score
15560 Set the score of the current article (@code{gnus-summary-set-score}).
15563 @kindex V S (Summary)
15564 @findex gnus-summary-current-score
15565 Display the score of the current article
15566 (@code{gnus-summary-current-score}).
15569 @kindex V t (Summary)
15570 @findex gnus-score-find-trace
15571 Display all score rules that have been used on the current article
15572 (@code{gnus-score-find-trace}).
15575 @kindex V R (Summary)
15576 @findex gnus-summary-rescore
15577 Run the current summary through the scoring process
15578 (@code{gnus-summary-rescore}). This might be useful if you're playing
15579 around with your score files behind Gnus' back and want to see the
15580 effect you're having.
15583 @kindex V c (Summary)
15584 @findex gnus-score-change-score-file
15585 Make a different score file the current
15586 (@code{gnus-score-change-score-file}).
15589 @kindex V e (Summary)
15590 @findex gnus-score-edit-current-scores
15591 Edit the current score file (@code{gnus-score-edit-current-scores}).
15592 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
15596 @kindex V f (Summary)
15597 @findex gnus-score-edit-file
15598 Edit a score file and make this score file the current one
15599 (@code{gnus-score-edit-file}).
15602 @kindex V F (Summary)
15603 @findex gnus-score-flush-cache
15604 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
15605 after editing score files.
15608 @kindex V C (Summary)
15609 @findex gnus-score-customize
15610 Customize a score file in a visually pleasing manner
15611 (@code{gnus-score-customize}).
15615 The rest of these commands modify the local score file.
15620 @kindex V m (Summary)
15621 @findex gnus-score-set-mark-below
15622 Prompt for a score, and mark all articles with a score below this as
15623 read (@code{gnus-score-set-mark-below}).
15626 @kindex V x (Summary)
15627 @findex gnus-score-set-expunge-below
15628 Prompt for a score, and add a score rule to the current score file to
15629 expunge all articles below this score
15630 (@code{gnus-score-set-expunge-below}).
15633 The keystrokes for actually making score entries follow a very regular
15634 pattern, so there's no need to list all the commands. (Hundreds of
15637 @findex gnus-summary-increase-score
15638 @findex gnus-summary-lower-score
15642 The first key is either @kbd{I} (upper case i) for increasing the score
15643 or @kbd{L} for lowering the score.
15645 The second key says what header you want to score on. The following
15646 keys are available:
15650 Score on the author name.
15653 Score on the subject line.
15656 Score on the @code{Xref} line---i.e., the cross-posting line.
15659 Score on the @code{References} line.
15665 Score on the number of lines.
15668 Score on the @code{Message-ID} header.
15671 Score on followups---this matches the author name, and adds scores to
15672 the followups to this author. (Using this key leads to the creation of
15673 @file{ADAPT} files.)
15682 Score on thread. (Using this key leads to the creation of @file{ADAPT}
15688 The third key is the match type. Which match types are valid depends on
15689 what headers you are scoring on.
15701 Substring matching.
15704 Fuzzy matching (@pxref{Fuzzy Matching}).
15733 Greater than number.
15738 The fourth and final key says whether this is a temporary (i.e., expiring)
15739 score entry, or a permanent (i.e., non-expiring) score entry, or whether
15740 it is to be done immediately, without adding to the score file.
15744 Temporary score entry.
15747 Permanent score entry.
15750 Immediately scoring.
15755 So, let's say you want to increase the score on the current author with
15756 exact matching permanently: @kbd{I a e p}. If you want to lower the
15757 score based on the subject line, using substring matching, and make a
15758 temporary score entry: @kbd{L s s t}. Pretty easy.
15760 To make things a bit more complicated, there are shortcuts. If you use
15761 a capital letter on either the second or third keys, Gnus will use
15762 defaults for the remaining one or two keystrokes. The defaults are
15763 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
15764 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
15766 These functions take both the numerical prefix and the symbolic prefix
15767 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
15768 (or increase) the score of the article. A symbolic prefix of @code{a}
15769 says to use the @file{all.SCORE} file for the command instead of the
15770 current score file.
15772 @vindex gnus-score-mimic-keymap
15773 The @code{gnus-score-mimic-keymap} says whether these commands will
15774 pretend they are keymaps or not.
15777 @node Group Score Commands
15778 @section Group Score Commands
15779 @cindex group score commands
15781 There aren't many of these as yet, I'm afraid.
15786 @kindex W f (Group)
15787 @findex gnus-score-flush-cache
15788 Gnus maintains a cache of score alists to avoid having to reload them
15789 all the time. This command will flush the cache
15790 (@code{gnus-score-flush-cache}).
15794 You can do scoring from the command line by saying something like:
15796 @findex gnus-batch-score
15797 @cindex batch scoring
15799 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
15803 @node Score Variables
15804 @section Score Variables
15805 @cindex score variables
15809 @item gnus-use-scoring
15810 @vindex gnus-use-scoring
15811 If @code{nil}, Gnus will not check for score files, and will not, in
15812 general, do any score-related work. This is @code{t} by default.
15814 @item gnus-kill-killed
15815 @vindex gnus-kill-killed
15816 If this variable is @code{nil}, Gnus will never apply score files to
15817 articles that have already been through the kill process. While this
15818 may save you lots of time, it also means that if you apply a kill file
15819 to a group, and then change the kill file and want to run it over you
15820 group again to kill more articles, it won't work. You have to set this
15821 variable to @code{t} to do that. (It is @code{t} by default.)
15823 @item gnus-kill-files-directory
15824 @vindex gnus-kill-files-directory
15825 All kill and score files will be stored in this directory, which is
15826 initialized from the @code{SAVEDIR} environment variable by default.
15827 This is @file{~/News/} by default.
15829 @item gnus-score-file-suffix
15830 @vindex gnus-score-file-suffix
15831 Suffix to add to the group name to arrive at the score file name
15832 (@samp{SCORE} by default.)
15834 @item gnus-score-uncacheable-files
15835 @vindex gnus-score-uncacheable-files
15836 @cindex score cache
15837 All score files are normally cached to avoid excessive re-loading of
15838 score files. However, if this might make your Emacs grow big and
15839 bloated, so this regexp can be used to weed out score files unlikely to be needed again. It would be a bad idea to deny caching of
15840 @file{all.SCORE}, while it might be a good idea to not cache
15841 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
15842 variable is @samp{ADAPT$} by default, so no adaptive score files will
15845 @item gnus-save-score
15846 @vindex gnus-save-score
15847 If you have really complicated score files, and do lots of batch
15848 scoring, then you might set this variable to @code{t}. This will make
15849 Gnus save the scores into the @file{.newsrc.eld} file.
15851 If you do not set this to @code{t}, then manual scores (like those set
15852 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
15853 across group visits.
15855 @item gnus-score-interactive-default-score
15856 @vindex gnus-score-interactive-default-score
15857 Score used by all the interactive raise/lower commands to raise/lower
15858 score with. Default is 1000, which may seem excessive, but this is to
15859 ensure that the adaptive scoring scheme gets enough room to play with.
15860 We don't want the small changes from the adaptive scoring to overwrite
15861 manually entered data.
15863 @item gnus-summary-default-score
15864 @vindex gnus-summary-default-score
15865 Default score of an article, which is 0 by default.
15867 @item gnus-summary-expunge-below
15868 @vindex gnus-summary-expunge-below
15869 Don't display the summary lines of articles that have scores lower than
15870 this variable. This is @code{nil} by default, which means that no
15871 articles will be hidden. This variable is local to the summary buffers,
15872 and has to be set from @code{gnus-summary-mode-hook}.
15874 @item gnus-score-over-mark
15875 @vindex gnus-score-over-mark
15876 Mark (in the third column) used for articles with a score over the
15877 default. Default is @samp{+}.
15879 @item gnus-score-below-mark
15880 @vindex gnus-score-below-mark
15881 Mark (in the third column) used for articles with a score below the
15882 default. Default is @samp{-}.
15884 @item gnus-score-find-score-files-function
15885 @vindex gnus-score-find-score-files-function
15886 Function used to find score files for the current group. This function
15887 is called with the name of the group as the argument.
15889 Predefined functions available are:
15892 @item gnus-score-find-single
15893 @findex gnus-score-find-single
15894 Only apply the group's own score file.
15896 @item gnus-score-find-bnews
15897 @findex gnus-score-find-bnews
15898 Apply all score files that match, using bnews syntax. This is the
15899 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
15900 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
15901 @file{gnu.all.SCORE} would all apply. In short, the instances of
15902 @samp{all} in the score file names are translated into @samp{.*}, and
15903 then a regexp match is done.
15905 This means that if you have some score entries that you want to apply to
15906 all groups, then you put those entries in the @file{all.SCORE} file.
15908 The score files are applied in a semi-random order, although Gnus will
15909 try to apply the more general score files before the more specific score
15910 files. It does this by looking at the number of elements in the score
15911 file names---discarding the @samp{all} elements.
15913 @item gnus-score-find-hierarchical
15914 @findex gnus-score-find-hierarchical
15915 Apply all score files from all the parent groups. This means that you
15916 can't have score files like @file{all.SCORE}, but you can have
15917 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
15921 This variable can also be a list of functions. In that case, all these
15922 functions will be called with the group name as argument, and all the
15923 returned lists of score files will be applied. These functions can also
15924 return lists of score alists directly. In that case, the functions that
15925 return these non-file score alists should probably be placed before the
15926 ``real'' score file functions, to ensure that the last score file
15927 returned is the local score file. Phu.
15929 For example, to do hierarchical scoring but use a non-server-specific
15930 overall score file, you could use the value
15932 (list (lambda (group) ("all.SCORE"))
15933 'gnus-score-find-hierarchical)
15936 @item gnus-score-expiry-days
15937 @vindex gnus-score-expiry-days
15938 This variable says how many days should pass before an unused score file
15939 entry is expired. If this variable is @code{nil}, no score file entries
15940 are expired. It's 7 by default.
15942 @item gnus-update-score-entry-dates
15943 @vindex gnus-update-score-entry-dates
15944 If this variable is non-@code{nil}, matching score entries will have
15945 their dates updated. (This is how Gnus controls expiry---all
15946 non-matching entries will become too old while matching entries will
15947 stay fresh and young.) However, if you set this variable to @code{nil},
15948 even matching entries will grow old and will have to face that oh-so
15951 @item gnus-score-after-write-file-function
15952 @vindex gnus-score-after-write-file-function
15953 Function called with the name of the score file just written.
15955 @item gnus-score-thread-simplify
15956 @vindex gnus-score-thread-simplify
15957 If this variable is non-@code{nil}, article subjects will be simplified
15958 for subject scoring purposes in the same manner as with
15959 threading---according to the current value of
15960 gnus-simplify-subject-functions. If the scoring entry uses
15961 @code{substring} or @code{exact} matching, the match will also be
15962 simplified in this manner.
15967 @node Score File Format
15968 @section Score File Format
15969 @cindex score file format
15971 A score file is an @code{emacs-lisp} file that normally contains just a
15972 single form. Casual users are not expected to edit these files;
15973 everything can be changed from the summary buffer.
15975 Anyway, if you'd like to dig into it yourself, here's an example:
15979 ("Lars Ingebrigtsen" -10000)
15981 ("larsi\\|lmi" -50000 nil R))
15983 ("Ding is Badd" nil 728373))
15985 ("alt.politics" -1000 728372 s))
15990 (mark-and-expunge -10)
15994 (files "/hom/larsi/News/gnu.SCORE")
15995 (exclude-files "all.SCORE")
15996 (local (gnus-newsgroup-auto-expire t)
15997 (gnus-summary-make-false-root empty))
16001 This example demonstrates most score file elements. For a different
16002 approach, see @pxref{Advanced Scoring}.
16004 Even though this looks much like lisp code, nothing here is actually
16005 @code{eval}ed. The lisp reader is used to read this form, though, so it
16006 has to be valid syntactically, if not semantically.
16008 Six keys are supported by this alist:
16013 If the key is a string, it is the name of the header to perform the
16014 match on. Scoring can only be performed on these eight headers:
16015 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
16016 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
16017 these headers, there are three strings to tell Gnus to fetch the entire
16018 article and do the match on larger parts of the article: @code{Body}
16019 will perform the match on the body of the article, @code{Head} will
16020 perform the match on the head of the article, and @code{All} will
16021 perform the match on the entire article. Note that using any of these
16022 last three keys will slow down group entry @emph{considerably}. The
16023 final ``header'' you can score on is @code{Followup}. These score
16024 entries will result in new score entries being added for all follow-ups
16025 to articles that matches these score entries.
16027 Following this key is a arbitrary number of score entries, where each
16028 score entry has one to four elements.
16032 The first element is the @dfn{match element}. On most headers this will
16033 be a string, but on the Lines and Chars headers, this must be an
16037 If the second element is present, it should be a number---the @dfn{score
16038 element}. This number should be an integer in the neginf to posinf
16039 interval. This number is added to the score of the article if the match
16040 is successful. If this element is not present, the
16041 @code{gnus-score-interactive-default-score} number will be used
16042 instead. This is 1000 by default.
16045 If the third element is present, it should be a number---the @dfn{date
16046 element}. This date says when the last time this score entry matched,
16047 which provides a mechanism for expiring the score entries. It this
16048 element is not present, the score entry is permanent. The date is
16049 represented by the number of days since December 31, 1 BCE.
16052 If the fourth element is present, it should be a symbol---the @dfn{type
16053 element}. This element specifies what function should be used to see
16054 whether this score entry matches the article. What match types that can
16055 be used depends on what header you wish to perform the match on.
16058 @item From, Subject, References, Xref, Message-ID
16059 For most header types, there are the @code{r} and @code{R} (regexp), as
16060 well as @code{s} and @code{S} (substring) types, and @code{e} and
16061 @code{E} (exact match), and @code{w} (word match) types. If this
16062 element is not present, Gnus will assume that substring matching should
16063 be used. @code{R}, @code{S}, and @code{E} differ from the others in
16064 that the matches will be done in a case-sensitive manner. All these
16065 one-letter types are really just abbreviations for the @code{regexp},
16066 @code{string}, @code{exact}, and @code{word} types, which you can use
16067 instead, if you feel like.
16070 These two headers use different match types: @code{<}, @code{>},
16071 @code{=}, @code{>=} and @code{<=}.
16073 These predicates are true if
16076 (PREDICATE HEADER MATCH)
16079 evaluates to non-@code{nil}. For instance, the advanced match
16080 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
16087 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
16088 the match, we get the score added if the article has less than 4 lines.
16089 (It's easy to get confused and think it's the other way around. But
16090 it's not. I think.)
16092 When matching on @code{Lines}, be careful because some backends (like
16093 @code{nndir}) do not generate @code{Lines} header, so every article ends
16094 up being marked as having 0 lines. This can lead to strange results if
16095 you happen to lower score of the articles with few lines.
16098 For the Date header we have three kinda silly match types:
16099 @code{before}, @code{at} and @code{after}. I can't really imagine this
16100 ever being useful, but, like, it would feel kinda silly not to provide
16101 this function. Just in case. You never know. Better safe than sorry.
16102 Once burnt, twice shy. Don't judge a book by its cover. Never not have
16103 sex on a first date. (I have been told that at least one person, and I
16104 quote, ``found this function indispensable'', however.)
16108 A more useful match type is @code{regexp}. With it, you can match the
16109 date string using a regular expression. The date is normalized to
16110 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
16111 you want to match all articles that have been posted on April 1st in
16112 every year, you could use @samp{....0401.........} as a match string,
16113 for instance. (Note that the date is kept in its original time zone, so
16114 this will match articles that were posted when it was April 1st where
16115 the article was posted from. Time zones are such wholesome fun for the
16118 @item Head, Body, All
16119 These three match keys use the same match types as the @code{From} (etc)
16123 This match key is somewhat special, in that it will match the
16124 @code{From} header, and affect the score of not only the matching
16125 articles, but also all followups to the matching articles. This allows
16126 you e.g. increase the score of followups to your own articles, or
16127 decrease the score of followups to the articles of some known
16128 trouble-maker. Uses the same match types as the @code{From} header
16129 uses. (Using this match key will lead to creation of @file{ADAPT}
16133 This match key works along the same lines as the @code{Followup} match
16134 key. If you say that you want to score on a (sub-)thread started by an
16135 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
16136 match. This will add a new @samp{thread} match for each article that
16137 has @var{x} in its @code{References} header. (These new @samp{thread}
16138 matches will use the @code{Message-ID}s of these matching articles.)
16139 This will ensure that you can raise/lower the score of an entire thread,
16140 even though some articles in the thread may not have complete
16141 @code{References} headers. Note that using this may lead to
16142 undeterministic scores of the articles in the thread. (Using this match
16143 key will lead to creation of @file{ADAPT} files.)
16147 @cindex Score File Atoms
16149 The value of this entry should be a number. Any articles with a score
16150 lower than this number will be marked as read.
16153 The value of this entry should be a number. Any articles with a score
16154 lower than this number will be removed from the summary buffer.
16156 @item mark-and-expunge
16157 The value of this entry should be a number. Any articles with a score
16158 lower than this number will be marked as read and removed from the
16161 @item thread-mark-and-expunge
16162 The value of this entry should be a number. All articles that belong to
16163 a thread that has a total score below this number will be marked as read
16164 and removed from the summary buffer. @code{gnus-thread-score-function}
16165 says how to compute the total score for a thread.
16168 The value of this entry should be any number of file names. These files
16169 are assumed to be score files as well, and will be loaded the same way
16172 @item exclude-files
16173 The clue of this entry should be any number of files. These files will
16174 not be loaded, even though they would normally be so, for some reason or
16178 The value of this entry will be @code{eval}el. This element will be
16179 ignored when handling global score files.
16182 Read-only score files will not be updated or saved. Global score files
16183 should feature this atom (@pxref{Global Score Files}). (Note:
16184 @dfn{Global} here really means @dfn{global}; not your personal
16185 apply-to-all-groups score files.)
16188 The value of this entry should be a number. Articles that do not have
16189 parents will get this number added to their scores. Imagine you follow
16190 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
16191 will only follow a few of the threads, also want to see any new threads.
16193 You can do this with the following two score file entries:
16197 (mark-and-expunge -100)
16200 When you enter the group the first time, you will only see the new
16201 threads. You then raise the score of the threads that you find
16202 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
16203 rest. Next time you enter the group, you will see new articles in the
16204 interesting threads, plus any new threads.
16206 I.e.---the orphan score atom is for high-volume groups where a few
16207 interesting threads which can't be found automatically by ordinary
16208 scoring rules exist.
16211 This entry controls the adaptive scoring. If it is @code{t}, the
16212 default adaptive scoring rules will be used. If it is @code{ignore}, no
16213 adaptive scoring will be performed on this group. If it is a list, this
16214 list will be used as the adaptive scoring rules. If it isn't present,
16215 or is something other than @code{t} or @code{ignore}, the default
16216 adaptive scoring rules will be used. If you want to use adaptive
16217 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
16218 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
16219 not want adaptive scoring. If you only want adaptive scoring in a few
16220 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
16221 insert @code{(adapt t)} in the score files of the groups where you want
16225 All adaptive score entries will go to the file named by this entry. It
16226 will also be applied when entering the group. This atom might be handy
16227 if you want to adapt on several groups at once, using the same adaptive
16228 file for a number of groups.
16231 @cindex local variables
16232 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
16233 Each @var{var} will be made buffer-local to the current summary buffer,
16234 and set to the value specified. This is a convenient, if somewhat
16235 strange, way of setting variables in some groups if you don't like hooks
16236 much. Note that the @var{value} won't be evaluated.
16240 @node Score File Editing
16241 @section Score File Editing
16243 You normally enter all scoring commands from the summary buffer, but you
16244 might feel the urge to edit them by hand as well, so we've supplied you
16245 with a mode for that.
16247 It's simply a slightly customized @code{emacs-lisp} mode, with these
16248 additional commands:
16253 @kindex C-c C-c (Score)
16254 @findex gnus-score-edit-done
16255 Save the changes you have made and return to the summary buffer
16256 (@code{gnus-score-edit-done}).
16259 @kindex C-c C-d (Score)
16260 @findex gnus-score-edit-insert-date
16261 Insert the current date in numerical format
16262 (@code{gnus-score-edit-insert-date}). This is really the day number, if
16263 you were wondering.
16266 @kindex C-c C-p (Score)
16267 @findex gnus-score-pretty-print
16268 The adaptive score files are saved in an unformatted fashion. If you
16269 intend to read one of these files, you want to @dfn{pretty print} it
16270 first. This command (@code{gnus-score-pretty-print}) does that for
16275 Type @kbd{M-x gnus-score-mode} to use this mode.
16277 @vindex gnus-score-mode-hook
16278 @code{gnus-score-menu-hook} is run in score mode buffers.
16280 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
16281 e} to begin editing score files.
16284 @node Adaptive Scoring
16285 @section Adaptive Scoring
16286 @cindex adaptive scoring
16288 If all this scoring is getting you down, Gnus has a way of making it all
16289 happen automatically---as if by magic. Or rather, as if by artificial
16290 stupidity, to be precise.
16292 @vindex gnus-use-adaptive-scoring
16293 When you read an article, or mark an article as read, or kill an
16294 article, you leave marks behind. On exit from the group, Gnus can sniff
16295 these marks and add score elements depending on what marks it finds.
16296 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
16297 @code{t} or @code{(line)}. If you want score adaptively on separate
16298 words appearing in the subjects, you should set this variable to
16299 @code{(word)}. If you want to use both adaptive methods, set this
16300 variable to @code{(word line)}.
16302 @vindex gnus-default-adaptive-score-alist
16303 To give you complete control over the scoring process, you can customize
16304 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
16305 might look something like this:
16308 (setq gnus-default-adaptive-score-alist
16309 '((gnus-unread-mark)
16310 (gnus-ticked-mark (from 4))
16311 (gnus-dormant-mark (from 5))
16312 (gnus-del-mark (from -4) (subject -1))
16313 (gnus-read-mark (from 4) (subject 2))
16314 (gnus-expirable-mark (from -1) (subject -1))
16315 (gnus-killed-mark (from -1) (subject -3))
16316 (gnus-kill-file-mark)
16317 (gnus-ancient-mark)
16318 (gnus-low-score-mark)
16319 (gnus-catchup-mark (from -1) (subject -1))))
16322 As you see, each element in this alist has a mark as a key (either a
16323 variable name or a ``real'' mark---a character). Following this key is
16324 a arbitrary number of header/score pairs. If there are no header/score
16325 pairs following the key, no adaptive scoring will be done on articles
16326 that have that key as the article mark. For instance, articles with
16327 @code{gnus-unread-mark} in the example above will not get adaptive score
16330 Each article can have only one mark, so just a single of these rules
16331 will be applied to each article.
16333 To take @code{gnus-del-mark} as an example---this alist says that all
16334 articles that have that mark (i.e., are marked with @samp{D}) will have a
16335 score entry added to lower based on the @code{From} header by -4, and
16336 lowered by @code{Subject} by -1. Change this to fit your prejudices.
16338 If you have marked 10 articles with the same subject with
16339 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
16340 That means that that subject will get a score of ten times -1, which
16341 should be, unless I'm much mistaken, -10.
16343 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
16344 the read articles will be marked with the @samp{E} mark. This'll
16345 probably make adaptive scoring slightly impossible, so auto-expiring and
16346 adaptive scoring doesn't really mix very well.
16348 The headers you can score on are @code{from}, @code{subject},
16349 @code{message-id}, @code{references}, @code{xref}, @code{lines},
16350 @code{chars} and @code{date}. In addition, you can score on
16351 @code{followup}, which will create an adaptive score entry that matches
16352 on the @code{References} header using the @code{Message-ID} of the
16353 current article, thereby matching the following thread.
16355 You can also score on @code{thread}, which will try to score all
16356 articles that appear in a thread. @code{thread} matches uses a
16357 @code{Message-ID} to match on the @code{References} header of the
16358 article. If the match is made, the @code{Message-ID} of the article is
16359 added to the @code{thread} rule. (Think about it. I'd recommend two
16360 aspirins afterwards.)
16362 If you use this scheme, you should set the score file atom @code{mark}
16363 to something small---like -300, perhaps, to avoid having small random
16364 changes result in articles getting marked as read.
16366 After using adaptive scoring for a week or so, Gnus should start to
16367 become properly trained and enhance the authors you like best, and kill
16368 the authors you like least, without you having to say so explicitly.
16370 You can control what groups the adaptive scoring is to be performed on
16371 by using the score files (@pxref{Score File Format}). This will also
16372 let you use different rules in different groups.
16374 @vindex gnus-adaptive-file-suffix
16375 The adaptive score entries will be put into a file where the name is the
16376 group name with @code{gnus-adaptive-file-suffix} appended. The default
16379 @vindex gnus-score-exact-adapt-limit
16380 When doing adaptive scoring, substring or fuzzy matching would probably
16381 give you the best results in most cases. However, if the header one
16382 matches is short, the possibility for false positives is great, so if
16383 the length of the match is less than
16384 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
16385 this variable is @code{nil}, exact matching will always be used to avoid
16388 @vindex gnus-default-adaptive-word-score-alist
16389 As mentioned above, you can adapt either on individual words or entire
16390 headers. If you adapt on words, the
16391 @code{gnus-default-adaptive-word-score-alist} variable says what score
16392 each instance of a word should add given a mark.
16395 (setq gnus-default-adaptive-word-score-alist
16396 `((,gnus-read-mark . 30)
16397 (,gnus-catchup-mark . -10)
16398 (,gnus-killed-mark . -20)
16399 (,gnus-del-mark . -15)))
16402 This is the default value. If you have adaption on words enabled, every
16403 word that appears in subjects of articles marked with
16404 @code{gnus-read-mark} will result in a score rule that increase the
16405 score with 30 points.
16407 @vindex gnus-default-ignored-adaptive-words
16408 @vindex gnus-ignored-adaptive-words
16409 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
16410 will be ignored. If you wish to add more words to be ignored, use the
16411 @code{gnus-ignored-adaptive-words} list instead.
16413 @vindex gnus-adaptive-word-length-limit
16414 Some may feel that short words shouldn't count when doing adaptive
16415 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
16416 an integer. Words shorter than this number will be ignored. This
16417 variable defaults til @code{nil}.
16419 @vindex gnus-adaptive-word-syntax-table
16420 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
16421 syntax table in effect. It is similar to the standard syntax table, but
16422 it considers numbers to be non-word-constituent characters.
16424 @vindex gnus-adaptive-word-minimum
16425 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
16426 word scoring process will never bring down the score of an article to
16427 below this number. The default is @code{nil}.
16429 @vindex gnus-adaptive-word-no-group-words
16430 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
16431 won't adaptively word score any of the words in the group name. Useful
16432 for groups like @samp{comp.editors.emacs}, where most of the subject
16433 lines contain the word @samp{emacs}.
16435 After using this scheme for a while, it might be nice to write a
16436 @code{gnus-psychoanalyze-user} command to go through the rules and see
16437 what words you like and what words you don't like. Or perhaps not.
16439 Note that the adaptive word scoring thing is highly experimental and is
16440 likely to change in the future. Initial impressions seem to indicate
16441 that it's totally useless as it stands. Some more work (involving more
16442 rigorous statistical methods) will have to be done to make this useful.
16445 @node Home Score File
16446 @section Home Score File
16448 The score file where new score file entries will go is called the
16449 @dfn{home score file}. This is normally (and by default) the score file
16450 for the group itself. For instance, the home score file for
16451 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
16453 However, this may not be what you want. It is often convenient to share
16454 a common home score file among many groups---all @samp{emacs} groups
16455 could perhaps use the same home score file.
16457 @vindex gnus-home-score-file
16458 The variable that controls this is @code{gnus-home-score-file}. It can
16463 A string. Then this file will be used as the home score file for all
16467 A function. The result of this function will be used as the home score
16468 file. The function will be called with the name of the group as the
16472 A list. The elements in this list can be:
16476 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
16477 group name, the @var{file-name} will be used as the home score file.
16480 A function. If the function returns non-nil, the result will be used as
16481 the home score file.
16484 A string. Use the string as the home score file.
16487 The list will be traversed from the beginning towards the end looking
16492 So, if you want to use just a single score file, you could say:
16495 (setq gnus-home-score-file
16496 "my-total-score-file.SCORE")
16499 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
16500 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
16502 @findex gnus-hierarchial-home-score-file
16504 (setq gnus-home-score-file
16505 'gnus-hierarchial-home-score-file)
16508 This is a ready-made function provided for your convenience.
16509 Other functions include
16512 @item gnus-current-home-score-file
16513 @findex gnus-current-home-score-file
16514 Return the ``current'' regular score file. This will make scoring
16515 commands add entry to the ``innermost'' matching score file.
16519 If you want to have one score file for the @samp{emacs} groups and
16520 another for the @samp{comp} groups, while letting all other groups use
16521 their own home score files:
16524 (setq gnus-home-score-file
16525 ;; All groups that match the regexp "\\.emacs"
16526 '(("\\.emacs" "emacs.SCORE")
16527 ;; All the comp groups in one score file
16528 ("^comp" "comp.SCORE")))
16531 @vindex gnus-home-adapt-file
16532 @code{gnus-home-adapt-file} works exactly the same way as
16533 @code{gnus-home-score-file}, but says what the home adaptive score file
16534 is instead. All new adaptive file entries will go into the file
16535 specified by this variable, and the same syntax is allowed.
16537 In addition to using @code{gnus-home-score-file} and
16538 @code{gnus-home-adapt-file}, you can also use group parameters
16539 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
16540 Parameters}) to achieve much the same. Group and topic parameters take
16541 precedence over this variable.
16544 @node Followups To Yourself
16545 @section Followups To Yourself
16547 Gnus offers two commands for picking out the @code{Message-ID} header in
16548 the current buffer. Gnus will then add a score rule that scores using
16549 this @code{Message-ID} on the @code{References} header of other
16550 articles. This will, in effect, increase the score of all articles that
16551 respond to the article in the current buffer. Quite useful if you want
16552 to easily note when people answer what you've said.
16556 @item gnus-score-followup-article
16557 @findex gnus-score-followup-article
16558 This will add a score to articles that directly follow up your own
16561 @item gnus-score-followup-thread
16562 @findex gnus-score-followup-thread
16563 This will add a score to all articles that appear in a thread ``below''
16567 @vindex message-sent-hook
16568 These two functions are both primarily meant to be used in hooks like
16569 @code{message-sent-hook}, like this:
16571 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
16575 If you look closely at your own @code{Message-ID}, you'll notice that
16576 the first two or three characters are always the same. Here's two of
16580 <x6u3u47icf.fsf@@eyesore.no>
16581 <x6sp9o7ibw.fsf@@eyesore.no>
16584 So ``my'' ident on this machine is @samp{x6}. This can be
16585 exploited---the following rule will raise the score on all followups to
16590 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
16594 Whether it's the first two or first three characters that are ``yours''
16595 is system-dependent.
16599 @section Scoring Tips
16600 @cindex scoring tips
16606 @cindex scoring crossposts
16607 If you want to lower the score of crossposts, the line to match on is
16608 the @code{Xref} header.
16610 ("xref" (" talk.politics.misc:" -1000))
16613 @item Multiple crossposts
16614 If you want to lower the score of articles that have been crossposted to
16615 more than, say, 3 groups:
16618 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
16622 @item Matching on the body
16623 This is generally not a very good idea---it takes a very long time.
16624 Gnus actually has to fetch each individual article from the server. But
16625 you might want to anyway, I guess. Even though there are three match
16626 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
16627 and stick with it in each score file. If you use any two, each article
16628 will be fetched @emph{twice}. If you want to match a bit on the
16629 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
16632 @item Marking as read
16633 You will probably want to mark articles that have scores below a certain
16634 number as read. This is most easily achieved by putting the following
16635 in your @file{all.SCORE} file:
16639 You may also consider doing something similar with @code{expunge}.
16641 @item Negated character classes
16642 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
16643 That will match newlines, which might lead to, well, The Unknown. Say
16644 @code{[^abcd\n]*} instead.
16648 @node Reverse Scoring
16649 @section Reverse Scoring
16650 @cindex reverse scoring
16652 If you want to keep just articles that have @samp{Sex with Emacs} in the
16653 subject header, and expunge all other articles, you could put something
16654 like this in your score file:
16658 ("Sex with Emacs" 2))
16663 So, you raise all articles that match @samp{Sex with Emacs} and mark the
16664 rest as read, and expunge them to boot.
16667 @node Global Score Files
16668 @section Global Score Files
16669 @cindex global score files
16671 Sure, other newsreaders have ``global kill files''. These are usually
16672 nothing more than a single kill file that applies to all groups, stored
16673 in the user's home directory. Bah! Puny, weak newsreaders!
16675 What I'm talking about here are Global Score Files. Score files from
16676 all over the world, from users everywhere, uniting all nations in one
16677 big, happy score file union! Ange-score! New and untested!
16679 @vindex gnus-global-score-files
16680 All you have to do to use other people's score files is to set the
16681 @code{gnus-global-score-files} variable. One entry for each score file,
16682 or each score file directory. Gnus will decide by itself what score
16683 files are applicable to which group.
16685 To use the score file
16686 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
16687 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
16691 (setq gnus-global-score-files
16692 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
16693 "/ftp@@ftp.some-where:/pub/score/"))
16696 @findex gnus-score-search-global-directories
16698 Simple, eh? Directory names must end with a @samp{/}. These
16699 directories are typically scanned only once during each Gnus session.
16700 If you feel the need to manually re-scan the remote directories, you can
16701 use the @code{gnus-score-search-global-directories} command.
16703 Note that, at present, using this option will slow down group entry
16704 somewhat. (That is---a lot.)
16706 If you want to start maintaining score files for other people to use,
16707 just put your score file up for anonymous ftp and announce it to the
16708 world. Become a retro-moderator! Participate in the retro-moderator
16709 wars sure to ensue, where retro-moderators battle it out for the
16710 sympathy of the people, luring them to use their score files on false
16711 premises! Yay! The net is saved!
16713 Here are some tips for the would-be retro-moderator, off the top of my
16719 Articles heavily crossposted are probably junk.
16721 To lower a single inappropriate article, lower by @code{Message-ID}.
16723 Particularly brilliant authors can be raised on a permanent basis.
16725 Authors that repeatedly post off-charter for the group can safely be
16726 lowered out of existence.
16728 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
16729 articles completely.
16732 Use expiring score entries to keep the size of the file down. You
16733 should probably have a long expiry period, though, as some sites keep
16734 old articles for a long time.
16737 ... I wonder whether other newsreaders will support global score files
16738 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
16739 Wave, xrn and 1stReader are bound to implement scoring. Should we start
16740 holding our breath yet?
16744 @section Kill Files
16747 Gnus still supports those pesky old kill files. In fact, the kill file
16748 entries can now be expiring, which is something I wrote before Daniel
16749 Quinlan thought of doing score files, so I've left the code in there.
16751 In short, kill processing is a lot slower (and I do mean @emph{a lot})
16752 than score processing, so it might be a good idea to rewrite your kill
16753 files into score files.
16755 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
16756 forms into this file, which means that you can use kill files as some
16757 sort of primitive hook function to be run on group entry, even though
16758 that isn't a very good idea.
16760 Normal kill files look like this:
16763 (gnus-kill "From" "Lars Ingebrigtsen")
16764 (gnus-kill "Subject" "ding")
16768 This will mark every article written by me as read, and remove the
16769 marked articles from the summary buffer. Very useful, you'll agree.
16771 Other programs use a totally different kill file syntax. If Gnus
16772 encounters what looks like a @code{rn} kill file, it will take a stab at
16775 Two summary functions for editing a GNUS kill file:
16780 @kindex M-k (Summary)
16781 @findex gnus-summary-edit-local-kill
16782 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
16785 @kindex M-K (Summary)
16786 @findex gnus-summary-edit-global-kill
16787 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
16790 Two group mode functions for editing the kill files:
16795 @kindex M-k (Group)
16796 @findex gnus-group-edit-local-kill
16797 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
16800 @kindex M-K (Group)
16801 @findex gnus-group-edit-global-kill
16802 Edit the general kill file (@code{gnus-group-edit-global-kill}).
16805 Kill file variables:
16808 @item gnus-kill-file-name
16809 @vindex gnus-kill-file-name
16810 A kill file for the group @samp{soc.motss} is normally called
16811 @file{soc.motss.KILL}. The suffix appended to the group name to get
16812 this file name is detailed by the @code{gnus-kill-file-name} variable.
16813 The ``global'' kill file (not in the score file sense of ``global'', of
16814 course) is just called @file{KILL}.
16816 @vindex gnus-kill-save-kill-file
16817 @item gnus-kill-save-kill-file
16818 If this variable is non-@code{nil}, Gnus will save the
16819 kill file after processing, which is necessary if you use expiring
16822 @item gnus-apply-kill-hook
16823 @vindex gnus-apply-kill-hook
16824 @findex gnus-apply-kill-file-unless-scored
16825 @findex gnus-apply-kill-file
16826 A hook called to apply kill files to a group. It is
16827 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
16828 kill file if you have a score file for the same group, you can set this
16829 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
16830 kill files to be processed, you should set this variable to @code{nil}.
16832 @item gnus-kill-file-mode-hook
16833 @vindex gnus-kill-file-mode-hook
16834 A hook called in kill-file mode buffers.
16839 @node Converting Kill Files
16840 @section Converting Kill Files
16842 @cindex converting kill files
16844 If you have loads of old kill files, you may want to convert them into
16845 score files. If they are ``regular'', you can use
16846 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
16849 The kill to score conversion package isn't included in Gnus by default.
16850 You can fetch it from
16851 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
16853 If your old kill files are very complex---if they contain more
16854 non-@code{gnus-kill} forms than not, you'll have to convert them by
16855 hand. Or just let them be as they are. Gnus will still use them as
16863 GroupLens is a collaborative filtering system that helps you work
16864 together with other people to find the quality news articles out of the
16865 huge volume of news articles generated every day.
16867 To accomplish this the GroupLens system combines your opinions about
16868 articles you have already read with the opinions of others who have done
16869 likewise and gives you a personalized prediction for each unread news
16870 article. Think of GroupLens as a matchmaker. GroupLens watches how you
16871 rate articles, and finds other people that rate articles the same way.
16872 Once it has found some people you agree with it tells you, in the form
16873 of a prediction, what they thought of the article. You can use this
16874 prediction to help you decide whether or not you want to read the
16878 * Using GroupLens:: How to make Gnus use GroupLens.
16879 * Rating Articles:: Letting GroupLens know how you rate articles.
16880 * Displaying Predictions:: Displaying predictions given by GroupLens.
16881 * GroupLens Variables:: Customizing GroupLens.
16885 @node Using GroupLens
16886 @subsection Using GroupLens
16888 To use GroupLens you must register a pseudonym with your local Better
16890 @uref{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
16891 better bit in town at the moment.
16893 Once you have registered you'll need to set a couple of variables.
16897 @item gnus-use-grouplens
16898 @vindex gnus-use-grouplens
16899 Setting this variable to a non-@code{nil} value will make Gnus hook into
16900 all the relevant GroupLens functions.
16902 @item grouplens-pseudonym
16903 @vindex grouplens-pseudonym
16904 This variable should be set to the pseudonym you got when registering
16905 with the Better Bit Bureau.
16907 @item grouplens-newsgroups
16908 @vindex grouplens-newsgroups
16909 A list of groups that you want to get GroupLens predictions for.
16913 That's the minimum of what you need to get up and running with GroupLens.
16914 Once you've registered, GroupLens will start giving you scores for
16915 articles based on the average of what other people think. But, to get
16916 the real benefit of GroupLens you need to start rating articles
16917 yourself. Then the scores GroupLens gives you will be personalized for
16918 you, based on how the people you usually agree with have already rated.
16921 @node Rating Articles
16922 @subsection Rating Articles
16924 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
16925 Where 1 means something like this article is a waste of bandwidth and 5
16926 means that the article was really good. The basic question to ask
16927 yourself is, "on a scale from 1 to 5 would I like to see more articles
16930 There are four ways to enter a rating for an article in GroupLens.
16935 @kindex r (GroupLens)
16936 @findex bbb-summary-rate-article
16937 This function will prompt you for a rating on a scale of one to five.
16940 @kindex k (GroupLens)
16941 @findex grouplens-score-thread
16942 This function will prompt you for a rating, and rate all the articles in
16943 the thread. This is really useful for some of those long running giant
16944 threads in rec.humor.
16948 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
16949 the score of the article you're reading.
16954 @kindex n (GroupLens)
16955 @findex grouplens-next-unread-article
16956 Rate the article and go to the next unread article.
16959 @kindex , (GroupLens)
16960 @findex grouplens-best-unread-article
16961 Rate the article and go to the next unread article with the highest score.
16965 If you want to give the current article a score of 4 and then go to the
16966 next article, just type @kbd{4 n}.
16969 @node Displaying Predictions
16970 @subsection Displaying Predictions
16972 GroupLens makes a prediction for you about how much you will like a
16973 news article. The predictions from GroupLens are on a scale from 1 to
16974 5, where 1 is the worst and 5 is the best. You can use the predictions
16975 from GroupLens in one of three ways controlled by the variable
16976 @code{gnus-grouplens-override-scoring}.
16978 @vindex gnus-grouplens-override-scoring
16979 There are three ways to display predictions in grouplens. You may
16980 choose to have the GroupLens scores contribute to, or override the
16981 regular gnus scoring mechanism. override is the default; however, some
16982 people prefer to see the Gnus scores plus the grouplens scores. To get
16983 the separate scoring behavior you need to set
16984 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
16985 GroupLens predictions combined with the grouplens scores set it to
16986 @code{'override} and to combine the scores set
16987 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
16988 the combine option you will also want to set the values for
16989 @code{grouplens-prediction-offset} and
16990 @code{grouplens-score-scale-factor}.
16992 @vindex grouplens-prediction-display
16993 In either case, GroupLens gives you a few choices for how you would like
16994 to see your predictions displayed. The display of predictions is
16995 controlled by the @code{grouplens-prediction-display} variable.
16997 The following are valid values for that variable.
17000 @item prediction-spot
17001 The higher the prediction, the further to the right an @samp{*} is
17004 @item confidence-interval
17005 A numeric confidence interval.
17007 @item prediction-bar
17008 The higher the prediction, the longer the bar.
17010 @item confidence-bar
17011 Numerical confidence.
17013 @item confidence-spot
17014 The spot gets bigger with more confidence.
17016 @item prediction-num
17017 Plain-old numeric value.
17019 @item confidence-plus-minus
17020 Prediction +/- confidence.
17025 @node GroupLens Variables
17026 @subsection GroupLens Variables
17030 @item gnus-summary-grouplens-line-format
17031 The summary line format used in GroupLens-enhanced summary buffers. It
17032 accepts the same specs as the normal summary line format (@pxref{Summary
17033 Buffer Lines}). The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
17036 @item grouplens-bbb-host
17037 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
17040 @item grouplens-bbb-port
17041 Port of the host running the bbbd server. The default is 9000.
17043 @item grouplens-score-offset
17044 Offset the prediction by this value. In other words, subtract the
17045 prediction value by this number to arrive at the effective score. The
17048 @item grouplens-score-scale-factor
17049 This variable allows the user to magnify the effect of GroupLens scores.
17050 The scale factor is applied after the offset. The default is 1.
17055 @node Advanced Scoring
17056 @section Advanced Scoring
17058 Scoring on Subjects and From headers is nice enough, but what if you're
17059 really interested in what a person has to say only when she's talking
17060 about a particular subject? Or what if you really don't want to
17061 read what person A has to say when she's following up to person B, but
17062 want to read what she says when she's following up to person C?
17064 By using advanced scoring rules you may create arbitrarily complex
17068 * Advanced Scoring Syntax:: A definition.
17069 * Advanced Scoring Examples:: What they look like.
17070 * Advanced Scoring Tips:: Getting the most out of it.
17074 @node Advanced Scoring Syntax
17075 @subsection Advanced Scoring Syntax
17077 Ordinary scoring rules have a string as the first element in the rule.
17078 Advanced scoring rules have a list as the first element. The second
17079 element is the score to be applied if the first element evaluated to a
17080 non-@code{nil} value.
17082 These lists may consist of three logical operators, one redirection
17083 operator, and various match operators.
17090 This logical operator will evaluate each of its arguments until it finds
17091 one that evaluates to @code{false}, and then it'll stop. If all arguments
17092 evaluate to @code{true} values, then this operator will return
17097 This logical operator will evaluate each of its arguments until it finds
17098 one that evaluates to @code{true}. If no arguments are @code{true},
17099 then this operator will return @code{false}.
17104 This logical operator only takes a single argument. It returns the
17105 logical negation of the value of its argument.
17109 There is an @dfn{indirection operator} that will make its arguments
17110 apply to the ancestors of the current article being scored. For
17111 instance, @code{1-} will make score rules apply to the parent of the
17112 current article. @code{2-} will make score rules apply to the
17113 grandparent of the current article. Alternatively, you can write
17114 @code{^^}, where the number of @code{^}s (carets) says how far back into
17115 the ancestry you want to go.
17117 Finally, we have the match operators. These are the ones that do the
17118 real work. Match operators are header name strings followed by a match
17119 and a match type. A typical match operator looks like @samp{("from"
17120 "Lars Ingebrigtsen" s)}. The header names are the same as when using
17121 simple scoring, and the match types are also the same.
17124 @node Advanced Scoring Examples
17125 @subsection Advanced Scoring Examples
17127 Let's say you want to increase the score of articles written by Lars
17128 when he's talking about Gnus:
17132 ("from" "Lars Ingebrigtsen")
17133 ("subject" "Gnus"))
17139 When he writes long articles, he sometimes has something nice to say:
17143 ("from" "Lars Ingebrigtsen")
17150 However, when he responds to things written by Reig Eigil Logge, you
17151 really don't want to read what he's written:
17155 ("from" "Lars Ingebrigtsen")
17156 (1- ("from" "Reig Eigir Logge")))
17160 Everybody that follows up Redmondo when he writes about disappearing
17161 socks should have their scores raised, but only when they talk about
17162 white socks. However, when Lars talks about socks, it's usually not
17169 ("from" "redmondo@@.*no" r)
17170 ("body" "disappearing.*socks" t)))
17171 (! ("from" "Lars Ingebrigtsen"))
17172 ("body" "white.*socks"))
17176 The possibilities are endless.
17179 @node Advanced Scoring Tips
17180 @subsection Advanced Scoring Tips
17182 The @code{&} and @code{|} logical operators do short-circuit logic.
17183 That is, they stop processing their arguments when it's clear what the
17184 result of the operation will be. For instance, if one of the arguments
17185 of an @code{&} evaluates to @code{false}, there's no point in evaluating
17186 the rest of the arguments. This means that you should put slow matches
17187 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
17188 @samp{subject}) first.
17190 The indirection arguments (@code{1-} and so on) will make their
17191 arguments work on previous generations of the thread. If you say
17202 Then that means "score on the from header of the grandparent of the
17203 current article". An indirection is quite fast, but it's better to say:
17209 ("subject" "Gnus")))
17216 (1- ("from" "Lars"))
17217 (1- ("subject" "Gnus")))
17222 @section Score Decays
17223 @cindex score decays
17226 You may find that your scores have a tendency to grow without
17227 bounds, especially if you're using adaptive scoring. If scores get too
17228 big, they lose all meaning---they simply max out and it's difficult to
17229 use them in any sensible way.
17231 @vindex gnus-decay-scores
17232 @findex gnus-decay-score
17233 @vindex gnus-decay-score-function
17234 Gnus provides a mechanism for decaying scores to help with this problem.
17235 When score files are loaded and @code{gnus-decay-scores} is
17236 non-@code{nil}, Gnus will run the score files through the decaying
17237 mechanism thereby lowering the scores of all non-permanent score rules.
17238 The decay itself if performed by the @code{gnus-decay-score-function}
17239 function, which is @code{gnus-decay-score} by default. Here's the
17240 definition of that function:
17243 (defun gnus-decay-score (score)
17245 This is done according to `gnus-score-decay-constant'
17246 and `gnus-score-decay-scale'."
17249 (* (if (< score 0) 1 -1)
17251 (max gnus-score-decay-constant
17253 gnus-score-decay-scale)))))))
17256 @vindex gnus-score-decay-scale
17257 @vindex gnus-score-decay-constant
17258 @code{gnus-score-decay-constant} is 3 by default and
17259 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
17263 Scores between -3 and 3 will be set to 0 when this function is called.
17266 Scores with magnitudes between 3 and 60 will be shrunk by 3.
17269 Scores with magnitudes greater than 60 will be shrunk by 5% of the
17273 If you don't like this decay function, write your own. It is called
17274 with the score to be decayed as its only parameter, and it should return
17275 the new score, which should be an integer.
17277 Gnus will try to decay scores once a day. If you haven't run Gnus for
17278 four days, Gnus will decay the scores four times, for instance.
17285 * Process/Prefix:: A convention used by many treatment commands.
17286 * Interactive:: Making Gnus ask you many questions.
17287 * Symbolic Prefixes:: How to supply some Gnus functions with options.
17288 * Formatting Variables:: You can specify what buffers should look like.
17289 * Windows Configuration:: Configuring the Gnus buffer windows.
17290 * Faces and Fonts:: How to change how faces look.
17291 * Compilation:: How to speed Gnus up.
17292 * Mode Lines:: Displaying information in the mode lines.
17293 * Highlighting and Menus:: Making buffers look all nice and cozy.
17294 * Buttons:: Get tendinitis in ten easy steps!
17295 * Daemons:: Gnus can do things behind your back.
17296 * NoCeM:: How to avoid spam and other fatty foods.
17297 * Undo:: Some actions can be undone.
17298 * Moderation:: What to do if you're a moderator.
17299 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
17300 * Fuzzy Matching:: What's the big fuzz?
17301 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
17302 * Various Various:: Things that are really various.
17306 @node Process/Prefix
17307 @section Process/Prefix
17308 @cindex process/prefix convention
17310 Many functions, among them functions for moving, decoding and saving
17311 articles, use what is known as the @dfn{Process/Prefix convention}.
17313 This is a method for figuring out what articles the user wants the
17314 command to be performed on.
17318 If the numeric prefix is N, perform the operation on the next N
17319 articles, starting with the current one. If the numeric prefix is
17320 negative, perform the operation on the previous N articles, starting
17321 with the current one.
17323 @vindex transient-mark-mode
17324 If @code{transient-mark-mode} in non-@code{nil} and the region is
17325 active, all articles in the region will be worked upon.
17327 If there is no numeric prefix, but some articles are marked with the
17328 process mark, perform the operation on the articles marked with
17331 If there is neither a numeric prefix nor any articles marked with the
17332 process mark, just perform the operation on the current article.
17334 Quite simple, really, but it needs to be made clear so that surprises
17337 Commands that react to the process mark will push the current list of
17338 process marked articles onto a stack and will then clear all process
17339 marked articles. You can restore the previous configuration with the
17340 @kbd{M P y} command (@pxref{Setting Process Marks}).
17342 @vindex gnus-summary-goto-unread
17343 One thing that seems to shock & horrify lots of people is that, for
17344 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
17345 Since each @kbd{d} (which marks the current article as read) by default
17346 goes to the next unread article after marking, this means that @kbd{3 d}
17347 will mark the next three unread articles as read, no matter what the
17348 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
17349 @code{nil} for a more straightforward action.
17351 Many commands do not use the process/prefix convention. All commands
17352 that do explicitly say so in this manual. To apply the process/prefix
17353 convention to commands that do not use it, you can use the @kbd{M-&}
17354 command. For instance, to mark all the articles in the group as
17355 expirable, you could say `M P b M-& E'.
17359 @section Interactive
17360 @cindex interaction
17364 @item gnus-novice-user
17365 @vindex gnus-novice-user
17366 If this variable is non-@code{nil}, you are either a newcomer to the
17367 World of Usenet, or you are very cautious, which is a nice thing to be,
17368 really. You will be given questions of the type ``Are you sure you want
17369 to do this?'' before doing anything dangerous. This is @code{t} by
17372 @item gnus-expert-user
17373 @vindex gnus-expert-user
17374 If this variable is non-@code{nil}, you will seldom be asked any
17375 questions by Gnus. It will simply assume you know what you're doing, no
17376 matter how strange.
17378 @item gnus-interactive-catchup
17379 @vindex gnus-interactive-catchup
17380 Require confirmation before catching up a group if non-@code{nil}. It
17381 is @code{t} by default.
17383 @item gnus-interactive-exit
17384 @vindex gnus-interactive-exit
17385 Require confirmation before exiting Gnus. This variable is @code{t} by
17390 @node Symbolic Prefixes
17391 @section Symbolic Prefixes
17392 @cindex symbolic prefixes
17394 Quite a lot of Emacs commands react to the (numeric) prefix. For
17395 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
17396 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
17397 rule of 900 to the current article.
17399 This is all nice and well, but what if you want to give a command some
17400 additional information? Well, what most commands do is interpret the
17401 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
17402 doesn't want a backup file to be created when saving the current buffer,
17403 for instance. But what if you want to save without making a backup
17404 file, and you want Emacs to flash lights and play a nice tune at the
17405 same time? You can't, and you're probably perfectly happy that way.
17407 @kindex M-i (Summary)
17408 @findex gnus-symbolic-argument
17409 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
17410 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
17411 character typed in is the value. You can stack as many @kbd{M-i}
17412 prefixes as you want. @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
17413 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b M-C-u} means
17414 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
17415 @code{b}''. You get the drift.
17417 Typing in symbolic prefixes to commands that don't accept them doesn't
17418 hurt, but it doesn't do any good either. Currently not many Gnus
17419 functions make use of the symbolic prefix.
17421 If you're interested in how Gnus implements this, @pxref{Extended
17425 @node Formatting Variables
17426 @section Formatting Variables
17427 @cindex formatting variables
17429 Throughout this manual you've probably noticed lots of variables called
17430 things like @code{gnus-group-line-format} and
17431 @code{gnus-summary-mode-line-format}. These control how Gnus is to
17432 output lines in the various buffers. There's quite a lot of them.
17433 Fortunately, they all use the same syntax, so there's not that much to
17436 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
17437 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
17438 lots of percentages everywhere.
17441 * Formatting Basics:: A formatting variable is basically a format string.
17442 * Mode Line Formatting:: Some rules about mode line formatting variables.
17443 * Advanced Formatting:: Modifying output in various ways.
17444 * User-Defined Specs:: Having Gnus call your own functions.
17445 * Formatting Fonts:: Making the formatting look colorful and nice.
17448 Currently Gnus uses the following formatting variables:
17449 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
17450 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
17451 @code{gnus-group-mode-line-format},
17452 @code{gnus-summary-mode-line-format},
17453 @code{gnus-article-mode-line-format},
17454 @code{gnus-server-mode-line-format}, and
17455 @code{gnus-summary-pick-line-format}.
17457 All these format variables can also be arbitrary elisp forms. In that
17458 case, they will be @code{eval}ed to insert the required lines.
17460 @kindex M-x gnus-update-format
17461 @findex gnus-update-format
17462 Gnus includes a command to help you while creating your own format
17463 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
17464 update the spec in question and pop you to a buffer where you can
17465 examine the resulting lisp code to be run to generate the line.
17469 @node Formatting Basics
17470 @subsection Formatting Basics
17472 Each @samp{%} element will be replaced by some string or other when the
17473 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
17474 spec, and pad with spaces to get a 5-character field''.
17476 As with normal C and Emacs Lisp formatting strings, the numerical
17477 modifier between the @samp{%} and the formatting type character will
17478 @dfn{pad} the output so that it is always at least that long.
17479 @samp{%5y} will make the field always (at least) five characters wide by
17480 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
17483 You may also wish to limit the length of the field to protect against
17484 particularly wide values. For that you can say @samp{%4,6y}, which
17485 means that the field will never be more than 6 characters wide and never
17486 less than 4 characters wide.
17489 @node Mode Line Formatting
17490 @subsection Mode Line Formatting
17492 Mode line formatting variables (e.g.,
17493 @code{gnus-summary-mode-line-format}) follow the same rules as other,
17494 buffer line oriented formatting variables (@pxref{Formatting Basics})
17495 with the following two differences:
17500 There must be no newline (@samp{\n}) at the end.
17503 The special @samp{%%b} spec can be used to display the buffer name.
17504 Well, it's no spec at all, really---@samp{%%} is just a way to quote
17505 @samp{%} to allow it to pass through the formatting machinery unmangled,
17506 so that Emacs receives @samp{%b}, which is something the Emacs mode line
17507 display interprets to mean ``show the buffer name''. For a full list of
17508 mode line specs Emacs understands, see the documentation of the
17509 @code{mode-line-format} variable.
17514 @node Advanced Formatting
17515 @subsection Advanced Formatting
17517 It is frequently useful to post-process the fields in some way.
17518 Padding, limiting, cutting off parts and suppressing certain values can
17519 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
17520 look like @samp{%~(cut 3)~(ignore "0")y}.
17522 These are the valid modifiers:
17527 Pad the field to the left with spaces until it reaches the required
17531 Pad the field to the right with spaces until it reaches the required
17536 Cut off characters from the left until it reaches the specified length.
17539 Cut off characters from the right until it reaches the specified
17544 Cut off the specified number of characters from the left.
17547 Cut off the specified number of characters from the right.
17550 Return an empty string if the field is equal to the specified value.
17553 Use the specified form as the field value when the @samp{@@} spec is
17557 Let's take an example. The @samp{%o} spec in the summary mode lines
17558 will return a date in compact ISO8601 format---@samp{19960809T230410}.
17559 This is quite a mouthful, so we want to shave off the century number and
17560 the time, leaving us with a six-character date. That would be
17561 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
17562 maxing, and we need the padding to ensure that the date is never less
17563 than 6 characters to make it look nice in columns.)
17565 Ignoring is done first; then cutting; then maxing; and then as the very
17566 last operation, padding.
17568 @vindex gnus-compile-user-specs
17569 If @code{gnus-compile-user-specs} is set to @code{nil} (@code{t} by
17570 default) with your strong personality, and use a lots of these advanced
17571 thingies, you'll find that Gnus gets quite slow. This can be helped
17572 enormously by running @kbd{M-x gnus-compile} when you are satisfied with
17573 the look of your lines.
17574 @xref{Compilation}.
17577 @node User-Defined Specs
17578 @subsection User-Defined Specs
17580 All the specs allow for inserting user defined specifiers---@samp{u}.
17581 The next character in the format string should be a letter. Gnus
17582 will call the function @code{gnus-user-format-function-}@samp{X}, where
17583 @samp{X} is the letter following @samp{%u}. The function will be passed
17584 a single parameter---what the parameter means depends on what buffer
17585 it's being called from. The function should return a string, which will
17586 be inserted into the buffer just like information from any other
17587 specifier. This function may also be called with dummy values, so it
17588 should protect against that.
17590 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
17591 much the same without defining new functions. Here's an example:
17592 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
17593 given here will be evaluated to yield the current line number, and then
17597 @node Formatting Fonts
17598 @subsection Formatting Fonts
17600 There are specs for highlighting, and these are shared by all the format
17601 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
17602 the special @code{mouse-face} property set, which means that it will be
17603 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
17606 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
17607 normal faces set using @code{gnus-face-0}, which is @code{bold} by
17608 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
17609 and so on. Create as many faces as you wish. The same goes for the
17610 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
17611 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
17613 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
17614 @code{balloon-help} property set to @code{gnus-balloon-face-0}. If you
17615 say @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The
17616 @code{gnus-balloon-face-*} variables should be either strings or symbols
17617 naming functions that return a string. Under @code{balloon-help-mode},
17618 when the mouse passes over text with this property set, a balloon window
17619 will appear and display the string. Please refer to the doc string of
17620 @code{balloon-help-mode} for more information on this.
17622 Here's an alternative recipe for the group buffer:
17625 ;; Create three face types.
17626 (setq gnus-face-1 'bold)
17627 (setq gnus-face-3 'italic)
17629 ;; We want the article count to be in
17630 ;; a bold and green face. So we create
17631 ;; a new face called `my-green-bold'.
17632 (copy-face 'bold 'my-green-bold)
17634 (set-face-foreground 'my-green-bold "ForestGreen")
17635 (setq gnus-face-2 'my-green-bold)
17637 ;; Set the new & fancy format.
17638 (setq gnus-group-line-format
17639 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
17642 I'm sure you'll be able to use this scheme to create totally unreadable
17643 and extremely vulgar displays. Have fun!
17645 Note that the @samp{%(} specs (and friends) do not make any sense on the
17646 mode-line variables.
17649 @node Windows Configuration
17650 @section Windows Configuration
17651 @cindex windows configuration
17653 No, there's nothing here about X, so be quiet.
17655 @vindex gnus-use-full-window
17656 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
17657 other windows and occupy the entire Emacs screen by itself. It is
17658 @code{t} by default.
17660 Setting this variable to @code{nil} kinda works, but there are
17661 glitches. Use at your own peril.
17663 @vindex gnus-buffer-configuration
17664 @code{gnus-buffer-configuration} describes how much space each Gnus
17665 buffer should be given. Here's an excerpt of this variable:
17668 ((group (vertical 1.0 (group 1.0 point)
17669 (if gnus-carpal (group-carpal 4))))
17670 (article (vertical 1.0 (summary 0.25 point)
17674 This is an alist. The @dfn{key} is a symbol that names some action or
17675 other. For instance, when displaying the group buffer, the window
17676 configuration function will use @code{group} as the key. A full list of
17677 possible names is listed below.
17679 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
17680 should occupy. To take the @code{article} split as an example -
17683 (article (vertical 1.0 (summary 0.25 point)
17687 This @dfn{split} says that the summary buffer should occupy 25% of upper
17688 half of the screen, and that it is placed over the article buffer. As
17689 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
17690 reaching for that calculator there). However, the special number
17691 @code{1.0} is used to signal that this buffer should soak up all the
17692 rest of the space available after the rest of the buffers have taken
17693 whatever they need. There should be only one buffer with the @code{1.0}
17694 size spec per split.
17696 Point will be put in the buffer that has the optional third element
17697 @code{point}. In a @code{frame} split, the last subsplit having a leaf
17698 split where the tag @code{frame-focus} is a member (i.e. is the third or
17699 fourth element in the list, depending on whether the @code{point} tag is
17700 present) gets focus.
17702 Here's a more complicated example:
17705 (article (vertical 1.0 (group 4)
17706 (summary 0.25 point)
17707 (if gnus-carpal (summary-carpal 4))
17711 If the size spec is an integer instead of a floating point number,
17712 then that number will be used to say how many lines a buffer should
17713 occupy, not a percentage.
17715 If the @dfn{split} looks like something that can be @code{eval}ed (to be
17716 precise---if the @code{car} of the split is a function or a subr), this
17717 split will be @code{eval}ed. If the result is non-@code{nil}, it will
17718 be used as a split. This means that there will be three buffers if
17719 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
17722 Not complicated enough for you? Well, try this on for size:
17725 (article (horizontal 1.0
17730 (summary 0.25 point)
17735 Whoops. Two buffers with the mystery 100% tag. And what's that
17736 @code{horizontal} thingie?
17738 If the first element in one of the split is @code{horizontal}, Gnus will
17739 split the window horizontally, giving you two windows side-by-side.
17740 Inside each of these strips you may carry on all you like in the normal
17741 fashion. The number following @code{horizontal} says what percentage of
17742 the screen is to be given to this strip.
17744 For each split, there @emph{must} be one element that has the 100% tag.
17745 The splitting is never accurate, and this buffer will eat any leftover
17746 lines from the splits.
17748 To be slightly more formal, here's a definition of what a valid split
17752 split = frame | horizontal | vertical | buffer | form
17753 frame = "(frame " size *split ")"
17754 horizontal = "(horizontal " size *split ")"
17755 vertical = "(vertical " size *split ")"
17756 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
17757 size = number | frame-params
17758 buf-name = group | article | summary ...
17761 The limitations are that the @code{frame} split can only appear as the
17762 top-level split. @var{form} should be an Emacs Lisp form that should
17763 return a valid split. We see that each split is fully recursive, and
17764 may contain any number of @code{vertical} and @code{horizontal} splits.
17766 @vindex gnus-window-min-width
17767 @vindex gnus-window-min-height
17768 @cindex window height
17769 @cindex window width
17770 Finding the right sizes can be a bit complicated. No window may be less
17771 than @code{gnus-window-min-height} (default 1) characters high, and all
17772 windows must be at least @code{gnus-window-min-width} (default 1)
17773 characters wide. Gnus will try to enforce this before applying the
17774 splits. If you want to use the normal Emacs window width/height limit,
17775 you can just set these two variables to @code{nil}.
17777 If you're not familiar with Emacs terminology, @code{horizontal} and
17778 @code{vertical} splits may work the opposite way of what you'd expect.
17779 Windows inside a @code{horizontal} split are shown side-by-side, and
17780 windows within a @code{vertical} split are shown above each other.
17782 @findex gnus-configure-frame
17783 If you want to experiment with window placement, a good tip is to call
17784 @code{gnus-configure-frame} directly with a split. This is the function
17785 that does all the real work when splitting buffers. Below is a pretty
17786 nonsensical configuration with 5 windows; two for the group buffer and
17787 three for the article buffer. (I said it was nonsensical.) If you
17788 @code{eval} the statement below, you can get an idea of how that would
17789 look straight away, without going through the normal Gnus channels.
17790 Play with it until you're satisfied, and then use
17791 @code{gnus-add-configuration} to add your new creation to the buffer
17792 configuration list.
17795 (gnus-configure-frame
17799 (article 0.3 point))
17807 You might want to have several frames as well. No prob---just use the
17808 @code{frame} split:
17811 (gnus-configure-frame
17814 (summary 0.25 point frame-focus)
17816 (vertical ((height . 5) (width . 15)
17817 (user-position . t)
17818 (left . -1) (top . 1))
17823 This split will result in the familiar summary/article window
17824 configuration in the first (or ``main'') frame, while a small additional
17825 frame will be created where picons will be shown. As you can see,
17826 instead of the normal @code{1.0} top-level spec, each additional split
17827 should have a frame parameter alist as the size spec.
17828 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
17829 Reference Manual}. Under XEmacs, a frame property list will be
17830 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
17832 The list of all possible keys for @code{gnus-buffer-configuration} can
17833 be found in its default value.
17835 Note that the @code{message} key is used for both
17836 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
17837 it is desirable to distinguish between the two, something like this
17841 (message (horizontal 1.0
17842 (vertical 1.0 (message 1.0 point))
17844 (if (buffer-live-p gnus-summary-buffer)
17849 One common desire for a multiple frame split is to have a separate frame
17850 for composing mail and news while leaving the original frame intact. To
17851 accomplish that, something like the following can be done:
17856 (if (not (buffer-live-p gnus-summary-buffer))
17857 (car (cdr (assoc 'group gnus-buffer-configuration)))
17858 (car (cdr (assoc 'summary gnus-buffer-configuration))))
17859 (vertical ((user-position . t) (top . 1) (left . 1)
17860 (name . "Message"))
17861 (message 1.0 point))))
17864 @findex gnus-add-configuration
17865 Since the @code{gnus-buffer-configuration} variable is so long and
17866 complicated, there's a function you can use to ease changing the config
17867 of a single setting: @code{gnus-add-configuration}. If, for instance,
17868 you want to change the @code{article} setting, you could say:
17871 (gnus-add-configuration
17872 '(article (vertical 1.0
17874 (summary .25 point)
17878 You'd typically stick these @code{gnus-add-configuration} calls in your
17879 @file{.gnus.el} file or in some startup hook---they should be run after
17880 Gnus has been loaded.
17882 @vindex gnus-always-force-window-configuration
17883 If all windows mentioned in the configuration are already visible, Gnus
17884 won't change the window configuration. If you always want to force the
17885 ``right'' window configuration, you can set
17886 @code{gnus-always-force-window-configuration} to non-@code{nil}.
17888 If you're using tree displays (@pxref{Tree Display}), and the tree
17889 window is displayed vertically next to another window, you may also want
17890 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
17893 @subsection Example Window Configurations
17897 Narrow left hand side occupied by group buffer. Right hand side split
17898 between summary buffer (top one-sixth) and article buffer (bottom).
17913 (gnus-add-configuration
17916 (vertical 25 (group 1.0))
17918 (summary 0.16 point)
17921 (gnus-add-configuration
17924 (vertical 25 (group 1.0))
17925 (vertical 1.0 (summary 1.0 point)))))
17931 @node Faces and Fonts
17932 @section Faces and Fonts
17937 Fiddling with fonts and faces used to be very difficult, but these days
17938 it is very simple. You simply say @kbd{M-x customize-face}, pick out
17939 the face you want to alter, and alter it via the standard Customize
17944 @section Compilation
17945 @cindex compilation
17946 @cindex byte-compilation
17948 @findex gnus-compile
17950 Remember all those line format specification variables?
17951 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
17952 on. By default, T-gnus will use the byte-compiled codes of these
17953 variables and we can keep a slow-down to a minimum. However, if you set
17954 @code{gnus-compile-user-specs} to @code{nil} (@code{t} by default),
17955 unfortunately, changing them will mean a quite significant slow-down.
17956 (The default values of these variables have byte-compiled functions
17957 associated with them, while the user-generated versions do not, of
17960 To help with this, you can run @kbd{M-x gnus-compile} after you've
17961 fiddled around with the variables and feel that you're (kind of)
17962 satisfied. This will result in the new specs being byte-compiled, and
17963 you'll get top speed again. Note that T-gnus will not save these
17964 compiled specs in the @file{.newsrc.eld} file.
17967 @item gnus-compile-user-specs
17968 @vindex gnus-compile-user-specs
17969 If it is non-nil, the user-defined format specs will be byte-compiled
17970 automatically. The default value of this variable is @code{t}. It has
17971 an effect on the values of @code{gnus-*-line-format-spec}.
17976 @section Mode Lines
17979 @vindex gnus-updated-mode-lines
17980 @code{gnus-updated-mode-lines} says what buffers should keep their mode
17981 lines updated. It is a list of symbols. Supported symbols include
17982 @code{group}, @code{article}, @code{summary}, @code{server},
17983 @code{browse}, and @code{tree}. If the corresponding symbol is present,
17984 Gnus will keep that mode line updated with information that may be
17985 pertinent. If this variable is @code{nil}, screen refresh may be
17988 @cindex display-time
17990 @vindex gnus-mode-non-string-length
17991 By default, Gnus displays information on the current article in the mode
17992 lines of the summary and article buffers. The information Gnus wishes
17993 to display (e.g. the subject of the article) is often longer than the
17994 mode lines, and therefore have to be cut off at some point. The
17995 @code{gnus-mode-non-string-length} variable says how long the other
17996 elements on the line is (i.e., the non-info part). If you put
17997 additional elements on the mode line (e.g. a clock), you should modify
18000 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
18002 (add-hook 'display-time-hook
18003 (lambda () (setq gnus-mode-non-string-length
18005 (if line-number-mode 5 0)
18006 (if column-number-mode 4 0)
18007 (length display-time-string)))))
18010 If this variable is @code{nil} (which is the default), the mode line
18011 strings won't be chopped off, and they won't be padded either. Note
18012 that the default is unlikely to be desirable, as even the percentage
18013 complete in the buffer may be crowded off the mode line; the user should
18014 configure this variable appropriately for her configuration.
18017 @node Highlighting and Menus
18018 @section Highlighting and Menus
18020 @cindex highlighting
18023 @vindex gnus-visual
18024 The @code{gnus-visual} variable controls most of the Gnus-prettifying
18025 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
18026 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
18029 This variable can be a list of visual properties that are enabled. The
18030 following elements are valid, and are all included by default:
18033 @item group-highlight
18034 Do highlights in the group buffer.
18035 @item summary-highlight
18036 Do highlights in the summary buffer.
18037 @item article-highlight
18038 Do highlights in the article buffer.
18040 Turn on highlighting in all buffers.
18042 Create menus in the group buffer.
18044 Create menus in the summary buffers.
18046 Create menus in the article buffer.
18048 Create menus in the browse buffer.
18050 Create menus in the server buffer.
18052 Create menus in the score buffers.
18054 Create menus in all buffers.
18057 So if you only want highlighting in the article buffer and menus in all
18058 buffers, you could say something like:
18061 (setq gnus-visual '(article-highlight menu))
18064 If you want highlighting only and no menus whatsoever, you'd say:
18067 (setq gnus-visual '(highlight))
18070 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
18071 in all Gnus buffers.
18073 Other general variables that influence the look of all buffers include:
18076 @item gnus-mouse-face
18077 @vindex gnus-mouse-face
18078 This is the face (i.e., font) used for mouse highlighting in Gnus. No
18079 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
18083 There are hooks associated with the creation of all the different menus:
18087 @item gnus-article-menu-hook
18088 @vindex gnus-article-menu-hook
18089 Hook called after creating the article mode menu.
18091 @item gnus-group-menu-hook
18092 @vindex gnus-group-menu-hook
18093 Hook called after creating the group mode menu.
18095 @item gnus-summary-menu-hook
18096 @vindex gnus-summary-menu-hook
18097 Hook called after creating the summary mode menu.
18099 @item gnus-server-menu-hook
18100 @vindex gnus-server-menu-hook
18101 Hook called after creating the server mode menu.
18103 @item gnus-browse-menu-hook
18104 @vindex gnus-browse-menu-hook
18105 Hook called after creating the browse mode menu.
18107 @item gnus-score-menu-hook
18108 @vindex gnus-score-menu-hook
18109 Hook called after creating the score mode menu.
18120 Those new-fangled @dfn{mouse} contraptions is very popular with the
18121 young, hep kids who don't want to learn the proper way to do things
18122 these days. Why, I remember way back in the summer of '89, when I was
18123 using Emacs on a Tops 20 system. Three hundred users on one single
18124 machine, and every user was running Simula compilers. Bah!
18128 @vindex gnus-carpal
18129 Well, you can make Gnus display bufferfuls of buttons you can click to
18130 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
18131 really. Tell the chiropractor I sent you.
18136 @item gnus-carpal-mode-hook
18137 @vindex gnus-carpal-mode-hook
18138 Hook run in all carpal mode buffers.
18140 @item gnus-carpal-button-face
18141 @vindex gnus-carpal-button-face
18142 Face used on buttons.
18144 @item gnus-carpal-header-face
18145 @vindex gnus-carpal-header-face
18146 Face used on carpal buffer headers.
18148 @item gnus-carpal-group-buffer-buttons
18149 @vindex gnus-carpal-group-buffer-buttons
18150 Buttons in the group buffer.
18152 @item gnus-carpal-summary-buffer-buttons
18153 @vindex gnus-carpal-summary-buffer-buttons
18154 Buttons in the summary buffer.
18156 @item gnus-carpal-server-buffer-buttons
18157 @vindex gnus-carpal-server-buffer-buttons
18158 Buttons in the server buffer.
18160 @item gnus-carpal-browse-buffer-buttons
18161 @vindex gnus-carpal-browse-buffer-buttons
18162 Buttons in the browse buffer.
18165 All the @code{buttons} variables are lists. The elements in these list
18166 are either cons cells where the @code{car} contains a text to be displayed and
18167 the @code{cdr} contains a function symbol, or a simple string.
18175 Gnus, being larger than any program ever written (allegedly), does lots
18176 of strange stuff that you may wish to have done while you're not
18177 present. For instance, you may want it to check for new mail once in a
18178 while. Or you may want it to close down all connections to all servers
18179 when you leave Emacs idle. And stuff like that.
18181 Gnus will let you do stuff like that by defining various
18182 @dfn{handlers}. Each handler consists of three elements: A
18183 @var{function}, a @var{time}, and an @var{idle} parameter.
18185 Here's an example of a handler that closes connections when Emacs has
18186 been idle for thirty minutes:
18189 (gnus-demon-close-connections nil 30)
18192 Here's a handler that scans for PGP headers every hour when Emacs is
18196 (gnus-demon-scan-pgp 60 t)
18199 This @var{time} parameter and than @var{idle} parameter work together
18200 in a strange, but wonderful fashion. Basically, if @var{idle} is
18201 @code{nil}, then the function will be called every @var{time} minutes.
18203 If @var{idle} is @code{t}, then the function will be called after
18204 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
18205 the function will never be called. But once Emacs goes idle, the
18206 function will be called every @var{time} minutes.
18208 If @var{idle} is a number and @var{time} is a number, the function will
18209 be called every @var{time} minutes only when Emacs has been idle for
18210 @var{idle} minutes.
18212 If @var{idle} is a number and @var{time} is @code{nil}, the function
18213 will be called once every time Emacs has been idle for @var{idle}
18216 And if @var{time} is a string, it should look like @samp{07:31}, and
18217 the function will then be called once every day somewhere near that
18218 time. Modified by the @var{idle} parameter, of course.
18220 @vindex gnus-demon-timestep
18221 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
18222 seconds. This is 60 by default. If you change that variable,
18223 all the timings in the handlers will be affected.)
18225 So, if you want to add a handler, you could put something like this in
18226 your @file{.gnus} file:
18228 @findex gnus-demon-add-handler
18230 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
18233 @findex gnus-demon-add-nocem
18234 @findex gnus-demon-add-scanmail
18235 @findex gnus-demon-add-rescan
18236 @findex gnus-demon-add-scan-timestamps
18237 @findex gnus-demon-add-disconnection
18238 Some ready-made functions to do this have been created:
18239 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
18240 @code{gnus-demon-add-nntp-close-connection},
18241 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
18242 @code{gnus-demon-add-scanmail}. Just put those functions in your
18243 @file{.gnus} if you want those abilities.
18245 @findex gnus-demon-init
18246 @findex gnus-demon-cancel
18247 @vindex gnus-demon-handlers
18248 If you add handlers to @code{gnus-demon-handlers} directly, you should
18249 run @code{gnus-demon-init} to make the changes take hold. To cancel all
18250 daemons, you can use the @code{gnus-demon-cancel} function.
18252 Note that adding daemons can be pretty naughty if you over do it. Adding
18253 functions that scan all news and mail from all servers every two seconds
18254 is a sure-fire way of getting booted off any respectable system. So
18263 @dfn{Spamming} is posting the same article lots and lots of times.
18264 Spamming is bad. Spamming is evil.
18266 Spamming is usually canceled within a day or so by various anti-spamming
18267 agencies. These agencies usually also send out @dfn{NoCeM} messages.
18268 NoCeM is pronounced ``no see-'em'', and means what the name
18269 implies---these are messages that make the offending articles, like, go
18272 What use are these NoCeM messages if the articles are canceled anyway?
18273 Some sites do not honor cancel messages and some sites just honor cancels
18274 from a select few people. Then you may wish to make use of the NoCeM
18275 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
18277 Gnus can read and parse the messages in this group automatically, and
18278 this will make spam disappear.
18280 There are some variables to customize, of course:
18283 @item gnus-use-nocem
18284 @vindex gnus-use-nocem
18285 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
18288 @item gnus-nocem-groups
18289 @vindex gnus-nocem-groups
18290 Gnus will look for NoCeM messages in the groups in this list. The
18291 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
18292 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
18294 @item gnus-nocem-issuers
18295 @vindex gnus-nocem-issuers
18296 There are many people issuing NoCeM messages. This list says what
18297 people you want to listen to. The default is @code{("Automoose-1"
18298 "clewis@@ferret.ocunix.on.ca" "cosmo.roadkill" "SpamHippo"
18299 "hweede@@snafu.de")}; fine, upstanding citizens all of them.
18301 Known despammers that you can put in this list are listed at
18302 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
18304 You do not have to heed NoCeM messages from all these people---just the
18305 ones you want to listen to. You also don't have to accept all NoCeM
18306 messages from the people you like. Each NoCeM message has a @dfn{type}
18307 header that gives the message a (more or less, usually less) rigorous
18308 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
18309 @samp{binary}, and @samp{troll}. To specify this, you have to use
18310 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
18311 Each condition is either a string (which is a regexp that matches types
18312 you want to use) or a list on the form @code{(not @var{string})}, where
18313 @var{string} is a regexp that matches types you don't want to use.
18315 For instance, if you want all NoCeM messages from Chris Lewis except his
18316 @samp{troll} messages, you'd say:
18319 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
18322 On the other hand, if you just want nothing but his @samp{spam} and
18323 @samp{spew} messages, you'd say:
18326 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
18329 The specs are applied left-to-right.
18332 @item gnus-nocem-verifyer
18333 @vindex gnus-nocem-verifyer
18335 This should be a function for verifying that the NoCeM issuer is who she
18336 says she is. The default is @code{mc-verify}, which is a Mailcrypt
18337 function. If this is too slow and you don't care for verification
18338 (which may be dangerous), you can set this variable to @code{nil}.
18340 If you want signed NoCeM messages to be verified and unsigned messages
18341 not to be verified (but used anyway), you could do something like:
18344 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
18346 (defun my-gnus-mc-verify ()
18354 This might be dangerous, though.
18356 @item gnus-nocem-directory
18357 @vindex gnus-nocem-directory
18358 This is where Gnus will store its NoCeM cache files. The default is
18359 @file{~/News/NoCeM/}.
18361 @item gnus-nocem-expiry-wait
18362 @vindex gnus-nocem-expiry-wait
18363 The number of days before removing old NoCeM entries from the cache.
18364 The default is 15. If you make it shorter Gnus will be faster, but you
18365 might then see old spam.
18367 @item gnus-nocem-check-from
18368 @vindex gnus-nocem-check-from
18369 Non-@code{nil} means check for valid issuers in message bodies.
18370 Otherwise don't bother fetching articles unless their author matches a
18371 valid issuer; that is much faster if you are selective about the
18374 @item gnus-nocem-check-article-limit
18375 @vindex gnus-nocem-check-article-limit
18376 If non-@code{nil}, the maximum number of articles to check in any NoCeM
18377 group. NoCeM groups can be huge and very slow to process.
18381 Using NoCeM could potentially be a memory hog. If you have many living
18382 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
18383 big. If this is a problem, you should kill off all (or most) of your
18384 unsubscribed groups (@pxref{Subscription Commands}).
18391 It is very useful to be able to undo actions one has done. In normal
18392 Emacs buffers, it's easy enough---you just push the @code{undo} button.
18393 In Gnus buffers, however, it isn't that simple.
18395 The things Gnus displays in its buffer is of no value whatsoever to
18396 Gnus---it's all just data designed to look nice to the user.
18397 Killing a group in the group buffer with @kbd{C-k} makes the line
18398 disappear, but that's just a side-effect of the real action---the
18399 removal of the group in question from the internal Gnus structures.
18400 Undoing something like that can't be done by the normal Emacs
18401 @code{undo} function.
18403 Gnus tries to remedy this somewhat by keeping track of what the user
18404 does and coming up with actions that would reverse the actions the user
18405 takes. When the user then presses the @code{undo} key, Gnus will run
18406 the code to reverse the previous action, or the previous actions.
18407 However, not all actions are easily reversible, so Gnus currently offers
18408 a few key functions to be undoable. These include killing groups,
18409 yanking groups, and changing the list of read articles of groups.
18410 That's it, really. More functions may be added in the future, but each
18411 added function means an increase in data to be stored, so Gnus will
18412 never be totally undoable.
18414 @findex gnus-undo-mode
18415 @vindex gnus-use-undo
18417 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
18418 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
18419 default. The @kbd{M-C-_} key performs the @code{gnus-undo}
18420 command, which should feel kinda like the normal Emacs @code{undo}
18425 @section Moderation
18428 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
18429 It is not included in the standard Gnus package. Write a mail to
18430 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
18433 The moderation package is implemented as a minor mode for summary
18437 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
18440 in your @file{.gnus.el} file.
18442 If you are the moderator of @samp{rec.zoofle}, this is how it's
18447 You split your incoming mail by matching on
18448 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
18449 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
18452 You enter that group once in a while and post articles using the @kbd{e}
18453 (edit-and-post) or @kbd{s} (just send unedited) commands.
18456 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
18457 articles that weren't approved by you, you can cancel them with the
18461 To use moderation mode in these two groups, say:
18464 (setq gnus-moderated-list
18465 "^nnml:rec.zoofle$\\|^rec.zoofle$")
18469 @node XEmacs Enhancements
18470 @section XEmacs Enhancements
18473 XEmacs is able to display pictures and stuff, so Gnus has taken
18477 * Picons:: How to display pictures of what your reading.
18478 * Smileys:: Show all those happy faces the way they were meant to be shown.
18479 * Toolbar:: Click'n'drool.
18480 * XVarious:: Other XEmacsy Gnusey variables.
18493 So@dots{} You want to slow down your news reader even more! This is a
18494 good way to do so. Its also a great way to impress people staring
18495 over your shoulder as you read news.
18498 * Picon Basics:: What are picons and How do I get them.
18499 * Picon Requirements:: Don't go further if you aren't using XEmacs.
18500 * Easy Picons:: Displaying Picons---the easy way.
18501 * Hard Picons:: The way you should do it. You'll learn something.
18502 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
18507 @subsubsection Picon Basics
18509 What are Picons? To quote directly from the Picons Web site:
18518 @dfn{Picons} is short for ``personal icons''. They're small,
18519 constrained images used to represent users and domains on the net,
18520 organized into databases so that the appropriate image for a given
18521 e-mail address can be found. Besides users and domains, there are picon
18522 databases for Usenet newsgroups and weather forecasts. The picons are
18523 in either monochrome @code{XBM} format or color @code{XPM} and
18524 @code{GIF} formats.
18527 @vindex gnus-picons-piconsearch-url
18528 If you have a permanent connection to the Internet you can use Steve
18529 Kinzler's Picons Search engine by setting
18530 @code{gnus-picons-piconsearch-url} to the string @*
18531 @uref{http://www.cs.indiana.edu/picons/search.html}.
18533 @vindex gnus-picons-database
18534 Otherwise you need a local copy of his database. For instructions on
18535 obtaining and installing the picons databases, point your Web browser at @*
18536 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}. Gnus expects
18537 picons to be installed into a location pointed to by
18538 @code{gnus-picons-database}.
18541 @node Picon Requirements
18542 @subsubsection Picon Requirements
18544 To have Gnus display Picons for you, you must be running XEmacs
18545 19.13 or greater since all other versions of Emacs aren't yet able to
18548 Additionally, you must have @code{x} support compiled into XEmacs. To
18549 display color picons which are much nicer than the black & white one,
18550 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
18552 @vindex gnus-picons-convert-x-face
18553 If you want to display faces from @code{X-Face} headers, you should have
18554 the @code{xface} support compiled into XEmacs. Otherwise you must have
18555 the @code{netpbm} utilities installed, or munge the
18556 @code{gnus-picons-convert-x-face} variable to use something else.
18560 @subsubsection Easy Picons
18562 To enable displaying picons, simply put the following line in your
18563 @file{~/.gnus} file and start Gnus.
18566 (setq gnus-use-picons t)
18567 (setq gnus-treat-display-picons t)
18570 and make sure @code{gnus-picons-database} points to the directory
18571 containing the Picons databases.
18573 Alternatively if you want to use the web piconsearch engine add this:
18576 (setq gnus-picons-piconsearch-url
18577 "http://www.cs.indiana.edu:800/piconsearch")
18582 @subsubsection Hard Picons
18590 Gnus can display picons for you as you enter and leave groups and
18591 articles. It knows how to interact with three sections of the picons
18592 database. Namely, it can display the picons newsgroup pictures,
18593 author's face picture(s), and the authors domain. To enable this
18594 feature, you need to select where to get the picons from, and where to
18599 @item gnus-picons-database
18600 @vindex gnus-picons-database
18601 The location of the picons database. Should point to a directory
18602 containing the @file{news}, @file{domains}, @file{users} (and so on)
18603 subdirectories. This is only useful if
18604 @code{gnus-picons-piconsearch-url} is @code{nil}. Defaults to
18605 @file{/usr/local/faces/}.
18607 @item gnus-picons-piconsearch-url
18608 @vindex gnus-picons-piconsearch-url
18609 The URL for the web picons search engine. The only currently known
18610 engine is @uref{http://www.cs.indiana.edu:800/piconsearch}. To
18611 workaround network delays, icons will be fetched in the background. If
18612 this is @code{nil} 'the default), then picons are fetched from local
18613 database indicated by @code{gnus-picons-database}.
18615 @item gnus-picons-display-where
18616 @vindex gnus-picons-display-where
18617 Where the picon images should be displayed. It is @code{picons} by
18618 default (which by default maps to the buffer @samp{*Picons*}). Other
18619 valid places could be @code{article}, @code{summary}, or
18620 @samp{*scratch*} for all I care. Just make sure that you've made the
18621 buffer visible using the standard Gnus window configuration
18622 routines---@pxref{Windows Configuration}.
18624 @item gnus-picons-group-excluded-groups
18625 @vindex gnus-picons-group-excluded-groups
18626 Groups that are matched by this regexp won't have their group icons
18631 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
18632 window configuration for you to include the @code{picons} buffer.
18634 Now that you've made those decision, you need to add the following
18635 functions to the appropriate hooks so these pictures will get displayed
18638 @vindex gnus-picons-display-where
18640 @item gnus-article-display-picons
18641 @findex gnus-article-display-picons
18642 Looks up and displays the picons for the author and the author's domain
18643 in the @code{gnus-picons-display-where} buffer.
18645 @item gnus-picons-article-display-x-face
18646 @findex gnus-article-display-picons
18647 Decodes and displays the X-Face header if present.
18653 @node Picon Useless Configuration
18654 @subsubsection Picon Useless Configuration
18662 The following variables offer further control over how things are
18663 done, where things are located, and other useless stuff you really
18664 don't need to worry about.
18668 @item gnus-picons-news-directories
18669 @vindex gnus-picons-news-directories
18670 List of subdirectories to search in @code{gnus-picons-database} for
18671 newsgroups faces. @code{("news")} is the default.
18673 @item gnus-picons-user-directories
18674 @vindex gnus-picons-user-directories
18675 List of subdirectories to search in @code{gnus-picons-database} for user
18676 faces. @code{("local" "users" "usenix" "misc")} is the default.
18678 @item gnus-picons-domain-directories
18679 @vindex gnus-picons-domain-directories
18680 List of subdirectories to search in @code{gnus-picons-database} for
18681 domain name faces. Defaults to @code{("domains")}. Some people may
18682 want to add @samp{"unknown"} to this list.
18684 @item gnus-picons-convert-x-face
18685 @vindex gnus-picons-convert-x-face
18686 If you don't have @code{xface} support builtin XEmacs, this is the
18687 command to use to convert the @code{X-Face} header to an X bitmap
18688 (@code{xbm}). Defaults to @code{(format "@{ echo '/* Width=48,
18689 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
18690 gnus-picons-x-face-file-name)}
18692 @item gnus-picons-x-face-file-name
18693 @vindex gnus-picons-x-face-file-name
18694 Names a temporary file to store the @code{X-Face} bitmap in. Defaults
18695 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
18697 @item gnus-picons-has-modeline-p
18698 @vindex gnus-picons-has-modeline-p
18699 If you have set @code{gnus-picons-display-where} to @code{picons}, your
18700 XEmacs frame will become really cluttered. To alleviate this a bit you
18701 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
18702 remove the mode line from the Picons buffer. This is only useful if
18703 @code{gnus-picons-display-where} is @code{picons}.
18705 @item gnus-picons-refresh-before-display
18706 @vindex gnus-picons-refresh-before-display
18707 If non-nil, display the article buffer before computing the picons.
18708 Defaults to @code{nil}.
18710 @item gnus-picons-display-as-address
18711 @vindex gnus-picons-display-as-address
18712 If @code{t} display textual email addresses along with pictures.
18713 Defaults to @code{t}.
18715 @item gnus-picons-file-suffixes
18716 @vindex gnus-picons-file-suffixes
18717 Ordered list of suffixes on picon file names to try. Defaults to
18718 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
18720 @item gnus-picons-setup-hook
18721 @vindex gnus-picons-setup-hook
18722 Hook run in the picon buffer, if that is displayed.
18724 @item gnus-picons-display-article-move-p
18725 @vindex gnus-picons-display-article-move-p
18726 Whether to move point to first empty line when displaying picons. This
18727 has only an effect if `gnus-picons-display-where' has value `article'.
18729 If @code{nil}, display the picons in the @code{From} and
18730 @code{Newsgroups} lines. This is the default.
18732 @item gnus-picons-clear-cache-on-shutdown
18733 @vindex gnus-picons-clear-cache-on-shutdown
18734 Whether to clear the picons cache when exiting gnus. Gnus caches every
18735 picons it finds while it is running. This saves some time in the search
18736 process but eats some memory. If this variable is set to @code{nil},
18737 Gnus will never clear the cache itself; you will have to manually call
18738 @code{gnus-picons-clear-cache} to clear it. Otherwise the cache will be
18739 cleared every time you exit Gnus. Defaults to @code{t}.
18750 @subsection Smileys
18755 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
18760 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
18761 currently the only package that uses Smiley, it is documented here.
18763 In short---to use Smiley in Gnus, put the following in your
18764 @file{.gnus.el} file:
18767 (setq gnus-treat-display-smileys t)
18770 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
18771 the like---to pictures and displays those instead of the text smiley
18772 faces. The conversion is controlled by a list of regexps that matches
18773 text and maps that to file names.
18775 @vindex smiley-nosey-regexp-alist
18776 @vindex smiley-deformed-regexp-alist
18777 Smiley supplies two example conversion alists by default:
18778 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
18779 and so on), and @code{smiley-nosey-regexp-alist} (which matches
18780 @samp{:-)}, @samp{:-(} and so on).
18782 The alist used is specified by the @code{smiley-regexp-alist} variable,
18783 which defaults to the value of @code{smiley-deformed-regexp-alist}.
18785 The first item in each element is the regexp to be matched; the second
18786 element is the regexp match group that is to be replaced by the picture;
18787 and the third element is the name of the file to be displayed.
18789 The following variables customize where Smiley will look for these
18790 files, as well as the color to be used and stuff:
18794 @item smiley-data-directory
18795 @vindex smiley-data-directory
18796 Where Smiley will look for smiley faces files.
18798 @item smiley-flesh-color
18799 @vindex smiley-flesh-color
18800 Skin color. The default is @samp{yellow}, which is really racist.
18802 @item smiley-features-color
18803 @vindex smiley-features-color
18804 Color of the features of the face. The default is @samp{black}.
18806 @item smiley-tongue-color
18807 @vindex smiley-tongue-color
18808 Color of the tongue. The default is @samp{red}.
18810 @item smiley-circle-color
18811 @vindex smiley-circle-color
18812 Color of the circle around the face. The default is @samp{black}.
18814 @item smiley-mouse-face
18815 @vindex smiley-mouse-face
18816 Face used for mouse highlighting over the smiley face.
18822 @subsection Toolbar
18832 @item gnus-use-toolbar
18833 @vindex gnus-use-toolbar
18834 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
18835 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
18836 @code{right-toolbar}, or @code{left-toolbar}.
18838 @item gnus-group-toolbar
18839 @vindex gnus-group-toolbar
18840 The toolbar in the group buffer.
18842 @item gnus-summary-toolbar
18843 @vindex gnus-summary-toolbar
18844 The toolbar in the summary buffer.
18846 @item gnus-summary-mail-toolbar
18847 @vindex gnus-summary-mail-toolbar
18848 The toolbar in the summary buffer of mail groups.
18854 @subsection Various XEmacs Variables
18857 @item gnus-xmas-glyph-directory
18858 @vindex gnus-xmas-glyph-directory
18859 This is where Gnus will look for pictures. Gnus will normally
18860 auto-detect this directory, but you may set it manually if you have an
18861 unusual directory structure.
18863 @item gnus-xmas-logo-color-alist
18864 @vindex gnus-xmas-logo-color-alist
18865 This is an alist where the key is a type symbol and the values are the
18866 foreground and background color of the splash page glyph.
18868 @item gnus-xmas-logo-color-style
18869 @vindex gnus-xmas-logo-color-style
18870 This is the key used to look up the color in the alist described above.
18871 Valid values include @code{flame}, @code{pine}, @code{moss},
18872 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
18873 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
18875 @item gnus-xmas-modeline-glyph
18876 @vindex gnus-xmas-modeline-glyph
18877 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
18891 @node Fuzzy Matching
18892 @section Fuzzy Matching
18893 @cindex fuzzy matching
18895 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
18896 things like scoring, thread gathering and thread comparison.
18898 As opposed to regular expression matching, fuzzy matching is very fuzzy.
18899 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
18900 means, and the implementation has changed over time.
18902 Basically, it tries to remove all noise from lines before comparing.
18903 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
18904 out of the strings before comparing the results. This often leads to
18905 adequate results---even when faced with strings generated by text
18906 manglers masquerading as newsreaders.
18909 @node Thwarting Email Spam
18910 @section Thwarting Email Spam
18914 @cindex unsolicited commercial email
18916 In these last days of the Usenet, commercial vultures are hanging about
18917 and grepping through news like crazy to find email addresses they can
18918 foist off their scams and products to. As a reaction to this, many
18919 people have started putting nonsense addresses into their @code{From}
18920 lines. I think this is counterproductive---it makes it difficult for
18921 people to send you legitimate mail in response to things you write, as
18922 well as making it difficult to see who wrote what. This rewriting may
18923 perhaps be a bigger menace than the unsolicited commercial email itself
18926 The biggest problem I have with email spam is that it comes in under
18927 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
18928 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
18929 mail group, only to find two pyramid schemes, seven advertisements
18930 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
18931 and one mail asking me to repent and find some god.
18935 The way to deal with this is having Gnus split out all spam into a
18936 @samp{spam} mail group (@pxref{Splitting Mail}).
18938 First, pick one (1) valid mail address that you can be reached at, and
18939 put it in your @code{From} header of all your news articles. (I've
18940 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
18941 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
18942 sysadmin whether your sendmail installation accepts keywords in the local
18943 part of the mail address.)
18946 (setq message-default-news-headers
18947 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
18950 Then put the following split rule in @code{nnmail-split-fancy}
18951 (@pxref{Fancy Mail Splitting}):
18956 (to "larsi@@trym.ifi.uio.no"
18957 (| ("subject" "re:.*" "misc")
18958 ("references" ".*@@.*" "misc")
18964 This says that all mail to this address is suspect, but if it has a
18965 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
18966 header, it's probably ok. All the rest goes to the @samp{spam} group.
18967 (This idea probably comes from Tim Pierce.)
18969 In addition, many mail spammers talk directly to your @code{smtp} server
18970 and do not include your email address explicitly in the @code{To}
18971 header. Why they do this is unknown---perhaps it's to thwart this
18972 thwarting scheme? In any case, this is trivial to deal with---you just
18973 put anything not addressed to you in the @samp{spam} group by ending
18974 your fancy split rule in this way:
18979 (to "larsi" "misc")
18983 In my experience, this will sort virtually everything into the right
18984 group. You still have to check the @samp{spam} group from time to time to
18985 check for legitimate mail, though. If you feel like being a good net
18986 citizen, you can even send off complaints to the proper authorities on
18987 each unsolicited commercial email---at your leisure.
18989 If you are also a lazy net citizen, you will probably prefer complaining
18990 automatically with the @file{gnus-junk.el} package, available FOR FREE
18991 at @* @uref{http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html}.
18992 Since most e-mail spam is sent automatically, this may reconcile the
18993 cosmic balance somewhat.
18995 This works for me. It allows people an easy way to contact me (they can
18996 just press @kbd{r} in the usual way), and I'm not bothered at all with
18997 spam. It's a win-win situation. Forging @code{From} headers to point
18998 to non-existent domains is yucky, in my opinion.
19001 @node Various Various
19002 @section Various Various
19008 @item gnus-home-directory
19009 All Gnus path variables will be initialized from this variable, which
19010 defaults to @file{~/}.
19012 @item gnus-directory
19013 @vindex gnus-directory
19014 Most Gnus storage path variables will be initialized from this variable,
19015 which defaults to the @samp{SAVEDIR} environment variable, or
19016 @file{~/News/} if that variable isn't set.
19018 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
19019 This means that other directory variables that are initialized from this
19020 variable won't be set properly if you set this variable in
19021 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
19023 @item gnus-default-directory
19024 @vindex gnus-default-directory
19025 Not related to the above variable at all---this variable says what the
19026 default directory of all Gnus buffers should be. If you issue commands
19027 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
19028 default directory. If this variable is @code{nil} (which is the
19029 default), the default directory will be the default directory of the
19030 buffer you were in when you started Gnus.
19033 @vindex gnus-verbose
19034 This variable is an integer between zero and ten. The higher the value,
19035 the more messages will be displayed. If this variable is zero, Gnus
19036 will never flash any messages, if it is seven (which is the default),
19037 most important messages will be shown, and if it is ten, Gnus won't ever
19038 shut up, but will flash so many messages it will make your head swim.
19040 @item gnus-verbose-backends
19041 @vindex gnus-verbose-backends
19042 This variable works the same way as @code{gnus-verbose}, but it applies
19043 to the Gnus backends instead of Gnus proper.
19045 @item nnheader-max-head-length
19046 @vindex nnheader-max-head-length
19047 When the backends read straight heads of articles, they all try to read
19048 as little as possible. This variable (default 4096) specifies
19049 the absolute max length the backends will try to read before giving up
19050 on finding a separator line between the head and the body. If this
19051 variable is @code{nil}, there is no upper read bound. If it is
19052 @code{t}, the backends won't try to read the articles piece by piece,
19053 but read the entire articles. This makes sense with some versions of
19054 @code{ange-ftp} or @code{efs}.
19056 @item nnheader-head-chop-length
19057 @vindex nnheader-head-chop-length
19058 This variable (default 2048) says how big a piece of each article to
19059 read when doing the operation described above.
19061 @item nnheader-file-name-translation-alist
19062 @vindex nnheader-file-name-translation-alist
19064 @cindex invalid characters in file names
19065 @cindex characters in file names
19066 This is an alist that says how to translate characters in file names.
19067 For instance, if @samp{:} is invalid as a file character in file names
19068 on your system (you OS/2 user you), you could say something like:
19071 (setq nnheader-file-name-translation-alist
19075 In fact, this is the default value for this variable on OS/2 and MS
19076 Windows (phooey) systems.
19078 @item gnus-hidden-properties
19079 @vindex gnus-hidden-properties
19080 This is a list of properties to use to hide ``invisible'' text. It is
19081 @code{(invisible t intangible t)} by default on most systems, which
19082 makes invisible text invisible and intangible.
19084 @item gnus-parse-headers-hook
19085 @vindex gnus-parse-headers-hook
19086 A hook called before parsing headers. It can be used, for instance, to
19087 gather statistics on the headers fetched, or perhaps you'd like to prune
19088 some headers. I don't see why you'd want that, though.
19090 @item gnus-shell-command-separator
19091 @vindex gnus-shell-command-separator
19092 String used to separate two shell commands. The default is @samp{;}.
19094 @item gnus-invalid-group-regexp
19095 @vindex gnus-invalid-group-regexp
19097 Regexp to match ``invalid'' group names when querying user for a group
19098 name. The default value catches some @strong{really} invalid group
19099 names who could possibly mess up Gnus internally (like allowing
19100 @samp{:} in a group name, which is normally used to delimit method and
19103 @sc{imap} users might want to allow @samp{/} in group names though.
19112 Well, that's the manual---you can get on with your life now. Keep in
19113 touch. Say hello to your cats from me.
19115 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
19117 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
19123 Not because of victories @*
19126 but for the common sunshine,@*
19128 the largess of the spring.
19132 but for the day's work done@*
19133 as well as I was able;@*
19134 not for a seat upon the dais@*
19135 but at the common table.@*
19140 @chapter Appendices
19143 * History:: How Gnus got where it is today.
19144 * On Writing Manuals:: Why this is not a beginner's guide.
19145 * Terminology:: We use really difficult, like, words here.
19146 * Customization:: Tailoring Gnus to your needs.
19147 * Troubleshooting:: What you might try if things do not work.
19148 * Gnus Reference Guide:: Rilly, rilly technical stuff.
19149 * Emacs for Heathens:: A short introduction to Emacsian terms.
19150 * Frequently Asked Questions:: A question-and-answer session.
19158 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
19159 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
19161 If you want to investigate the person responsible for this outrage,
19162 you can point your (feh!) web browser to
19163 @uref{http://quimby.gnus.org/}. This is also the primary
19164 distribution point for the new and spiffy versions of Gnus, and is
19165 known as The Site That Destroys Newsrcs And Drives People Mad.
19167 During the first extended alpha period of development, the new Gnus was
19168 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
19169 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
19170 (Besides, the ``Gnus'' in this abbreviation should probably be
19171 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
19172 appropriate name, don't you think?)
19174 In any case, after spending all that energy on coming up with a new and
19175 spunky name, we decided that the name was @emph{too} spunky, so we
19176 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
19177 ``@sc{gnus}''. New vs. old.
19180 * Gnus Versions:: What Gnus versions have been released.
19181 * Other Gnus Versions:: Other Gnus versions that also have been released.
19182 * Why?:: What's the point of Gnus?
19183 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
19184 * Conformity:: Gnus tries to conform to all standards.
19185 * Emacsen:: Gnus can be run on a few modern Emacsen.
19186 * Gnus Development:: How Gnus is developed.
19187 * Contributors:: Oodles of people.
19188 * New Features:: Pointers to some of the new stuff in Gnus.
19192 @node Gnus Versions
19193 @subsection Gnus Versions
19194 @cindex Pterodactyl Gnus
19196 @cindex September Gnus
19197 @cindex Quassia Gnus
19199 The first ``proper'' release of Gnus 5 was done in November 1995 when it
19200 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
19201 plus 15 Gnus 5.0 releases).
19203 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
19204 releases)) was released under the name ``Gnus 5.2'' (40 releases).
19206 On July 28th 1996 work on Red Gnus was begun, and it was released on
19207 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
19209 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
19210 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
19212 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
19213 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
19216 On the 26th of October 2000, Oort Gnus was begun.
19218 If you happen upon a version of Gnus that has a prefixed name --
19219 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
19220 ``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic. Don't let it know
19221 that you're frightened. Back away. Slowly. Whatever you do, don't
19222 run. Walk away, calmly, until you're out of its reach. Find a proper
19223 released version of Gnus and snuggle up to that instead.
19226 @node Other Gnus Versions
19227 @subsection Other Gnus Versions
19230 In addition to the versions of Gnus which have had their releases
19231 coordinated by Lars, one major development has been Semi-gnus from
19232 Japan. It's based on a library called @sc{semi}, which provides
19233 @sc{mime} capabilities.
19235 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
19236 Collectively, they are called ``Semi-gnus'', and different strains are
19237 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
19238 @sc{mime} and multilingualization things, especially important for
19245 What's the point of Gnus?
19247 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
19248 newsreader, that lets you do anything you can think of. That was my
19249 original motivation, but while working on Gnus, it has become clear to
19250 me that this generation of newsreaders really belong in the stone age.
19251 Newsreaders haven't developed much since the infancy of the net. If the
19252 volume continues to rise with the current rate of increase, all current
19253 newsreaders will be pretty much useless. How do you deal with
19254 newsgroups that have thousands of new articles each day? How do you
19255 keep track of millions of people who post?
19257 Gnus offers no real solutions to these questions, but I would very much
19258 like to see Gnus being used as a testing ground for new methods of
19259 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
19260 to separate the newsreader from the backends, Gnus now offers a simple
19261 interface for anybody who wants to write new backends for fetching mail
19262 and news from different sources. I have added hooks for customizations
19263 everywhere I could imagine it being useful. By doing so, I'm inviting
19264 every one of you to explore and invent.
19266 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
19267 @kbd{C-u 100 M-x all-hail-xemacs}.
19270 @node Compatibility
19271 @subsection Compatibility
19273 @cindex compatibility
19274 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
19275 bindings have been kept. More key bindings have been added, of course,
19276 but only in one or two obscure cases have old bindings been changed.
19281 @center In a cloud bones of steel.
19285 All commands have kept their names. Some internal functions have changed
19288 The @code{gnus-uu} package has changed drastically. @xref{Decoding
19291 One major compatibility question is the presence of several summary
19292 buffers. All variables relevant while reading a group are
19293 buffer-local to the summary buffer they belong in. Although many
19294 important variables have their values copied into their global
19295 counterparts whenever a command is executed in the summary buffer, this
19296 change might lead to incorrect values being used unless you are careful.
19298 All code that relies on knowledge of @sc{gnus} internals will probably
19299 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
19300 changing it in any way, as a matter of fact) is strictly verboten. Gnus
19301 maintains a hash table that points to the entries in this alist (which
19302 speeds up many functions), and changing the alist directly will lead to
19306 @cindex highlighting
19307 Old hilit19 code does not work at all. In fact, you should probably
19308 remove all hilit code from all Gnus hooks
19309 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
19310 Gnus provides various integrated functions for highlighting. These are
19311 faster and more accurate. To make life easier for everybody, Gnus will
19312 by default remove all hilit calls from all hilit hooks. Uncleanliness!
19315 Packages like @code{expire-kill} will no longer work. As a matter of
19316 fact, you should probably remove all old @sc{gnus} packages (and other
19317 code) when you start using Gnus. More likely than not, Gnus already
19318 does what you have written code to make @sc{gnus} do. (Snicker.)
19320 Even though old methods of doing things are still supported, only the
19321 new methods are documented in this manual. If you detect a new method of
19322 doing something while reading this manual, that does not mean you have
19323 to stop doing it the old way.
19325 Gnus understands all @sc{gnus} startup files.
19327 @kindex M-x gnus-bug
19329 @cindex reporting bugs
19331 Overall, a casual user who hasn't written much code that depends on
19332 @sc{gnus} internals should suffer no problems. If problems occur,
19333 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
19335 @vindex gnus-bug-create-help-buffer
19336 If you are in the habit of sending bug reports @emph{very} often, you
19337 may find the helpful help buffer annoying after a while. If so, set
19338 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
19343 @subsection Conformity
19345 No rebels without a clue here, ma'am. We conform to all standards known
19346 to (wo)man. Except for those standards and/or conventions we disagree
19353 There are no known breaches of this standard.
19357 There are no known breaches of this standard, either.
19359 @item Son-of-RFC 1036
19360 @cindex Son-of-RFC 1036
19361 We do have some breaches to this one.
19367 These are considered to be ``vanity headers'', while I consider them
19368 to be consumer information. After seeing so many badly formatted
19369 articles coming from @code{tin} and @code{Netscape} I know not to use
19370 either of those for posting articles. I would not have known that if
19371 it wasn't for the @code{X-Newsreader} header.
19376 USEFOR is an IETF working group writing a successor to RFC 1036, based
19377 on Son-of-RFC 1036. They have produced a number of drafts proposing
19378 various changes to the format of news articles. The Gnus towers will
19379 look into implementing the changes when the draft is accepted as an RFC.
19383 If you ever notice Gnus acting non-compliant with regards to the texts
19384 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
19389 @subsection Emacsen
19395 Gnus should work on :
19403 XEmacs 21.1.1 and up.
19407 This Gnus version will absolutely not work on any Emacsen older than
19408 that. Not reliably, at least. Older versions of Gnus may work on older
19409 Emacs versions. However, T-gnus does support ``Mule 2.3 based on Emacs
19410 19.34'' and possibly the versions of XEmacs prior to 21.1.1, e.g. 20.4.
19411 See the file ``README'' in the T-gnus distribution for more details.
19413 There are some vague differences between Gnus on the various
19414 platforms---XEmacs features more graphics (a logo and a toolbar)---but
19415 other than that, things should look pretty much the same under all
19419 @node Gnus Development
19420 @subsection Gnus Development
19422 Gnus is developed in a two-phased cycle. The first phase involves much
19423 discussion on the @samp{ding@@gnus.org} mailing list, where people
19424 propose changes and new features, post patches and new backends. This
19425 phase is called the @dfn{alpha} phase, since the Gnusae released in this
19426 phase are @dfn{alpha releases}, or (perhaps more commonly in other
19427 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
19428 unstable and should not be used by casual users. Gnus alpha releases
19429 have names like ``Red Gnus'' and ``Quassia Gnus''.
19431 After futzing around for 50-100 alpha releases, Gnus is declared
19432 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
19433 and is called things like ``Gnus 5.6.32'' instead. Normal people are
19434 supposed to be able to use these, and these are mostly discussed on the
19435 @samp{gnu.emacs.gnus} newsgroup.
19438 @vindex mail-source-delete-incoming
19439 Some variable defaults differ between alpha Gnusae and released Gnusae.
19440 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
19441 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
19442 lossage of mail if an alpha release hiccups while handling the mail.
19444 The division of discussion between the ding mailing list and the Gnus
19445 newsgroup is not purely based on publicity concerns. It's true that
19446 having people write about the horrible things that an alpha Gnus release
19447 can do (sometimes) in a public forum may scare people off, but more
19448 importantly, talking about new experimental features that have been
19449 introduced may confuse casual users. New features are frequently
19450 introduced, fiddled with, and judged to be found wanting, and then
19451 either discarded or totally rewritten. People reading the mailing list
19452 usually keep up with these rapid changes, while people on the newsgroup
19453 can't be assumed to do so.
19458 @subsection Contributors
19459 @cindex contributors
19461 The new Gnus version couldn't have been done without the help of all the
19462 people on the (ding) mailing list. Every day for over a year I have
19463 gotten billions of nice bug reports from them, filling me with joy,
19464 every single one of them. Smooches. The people on the list have been
19465 tried beyond endurance, what with my ``oh, that's a neat idea <type
19466 type>, yup, I'll release it right away <ship off> no wait, that doesn't
19467 work at all <type type>, yup, I'll ship that one off right away <ship
19468 off> no, wait, that absolutely does not work'' policy for releases.
19469 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
19470 ``worser''? ``much worser''? ``worsest''?)
19472 I would like to take this opportunity to thank the Academy for... oops,
19478 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
19481 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
19482 nnwarchive and many, many other things connected with @sc{mime} and
19483 other types of en/decoding, as well as general bug fixing, new
19484 functionality and stuff.
19487 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
19488 well as numerous other things).
19491 Luis Fernandes---design and graphics.
19494 Justin Sheehy--the FAQ maintainer.
19497 Erik Naggum---help, ideas, support, code and stuff.
19500 Wes Hardaker---@file{gnus-picon.el} and the manual section on
19501 @dfn{picons} (@pxref{Picons}).
19504 Kim-Minh Kaplan---further work on the picon code.
19507 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
19508 (@pxref{GroupLens}).
19511 Sudish Joseph---innumerable bug fixes.
19514 Ilja Weis---@file{gnus-topic.el}.
19517 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
19520 Vladimir Alexiev---the refcard and reference booklets.
19523 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
19524 distribution by Felix Lee and JWZ.
19527 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
19530 Peter Mutsaers---orphan article scoring code.
19533 Ken Raeburn---POP mail support.
19536 Hallvard B Furuseth---various bits and pieces, especially dealing with
19540 Brian Edmonds---@file{gnus-bbdb.el}.
19543 David Moore---rewrite of @file{nnvirtual.el} and many other things.
19546 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
19549 François Pinard---many, many interesting and thorough bug reports, as
19550 well as autoconf support.
19554 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
19555 Borges, and Jost Krieger proof-reading parts of the manual.
19557 The following people have contributed many patches and suggestions:
19566 Jason L. Tibbitts, III,
19570 Also thanks to the following for patches and stuff:
19580 Alexei V. Barantsev,
19595 Massimo Campostrini,
19600 Jae-you Chung, @c ?
19601 James H. Cloos, Jr.,
19605 Andrew J. Cosgriff,
19608 Geoffrey T. Dairiki,
19614 Michael Welsh Duggan,
19619 Enami Tsugutomo, @c Enami
19623 Nelson Jose dos Santos Ferreira,
19631 Arne Georg Gleditsch,
19633 Michelangelo Grigni,
19637 Kenichi Handa, @c Handa
19639 Yoshiki Hayashi, @c ?
19641 Hisashige Kenji, @c Hisashige
19648 François Felix Ingrand,
19649 Tatsuya Ichikawa, @c ?
19650 Ishikawa Ichiro, @c Ishikawa
19652 Iwamuro Motonori, @c Iwamuro
19663 Peter Skov Knudsen,
19664 Shuhei Kobayashi, @c Kobayashi
19666 Koseki Yoshinori, @c Koseki
19667 Thor Kristoffersen,
19670 Seokchan Lee, @c Lee
19688 Morioka Tomohiko, @c Morioka
19689 Erik Toubro Nielsen,
19696 Masaharu Onishi, @c Onishi
19701 Jens-Ulrik Holger Petersen,
19705 John McClary Prevost,
19711 Lars Balker Rasmussen,
19716 Christian von Roques,
19719 Wolfgang Rupprecht,
19726 Philippe Schnoebelen,
19728 Randal L. Schwartz,
19742 Kiyokazu Suto, @c Suto
19747 Tozawa Akihiko, @c Tozawa
19763 Katsumi Yamaoka @c Yamaoka
19768 For a full overview of what each person has done, the ChangeLogs
19769 included in the Gnus alpha distributions should give ample reading
19770 (550kB and counting).
19772 Apologies to everybody that I've forgotten, of which there are many, I'm
19775 Gee, that's quite a list of people. I guess that must mean that there
19776 actually are people who are using Gnus. Who'd'a thunk it!
19780 @subsection New Features
19781 @cindex new features
19784 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
19785 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
19786 * Red Gnus:: Third time best---Gnus 5.4/5.5.
19787 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
19788 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
19791 These lists are, of course, just @emph{short} overviews of the
19792 @emph{most} important new features. No, really. There are tons more.
19793 Yes, we have feeping creaturism in full effect.
19796 @subsubsection (ding) Gnus
19798 New features in Gnus 5.0/5.1:
19803 The look of all buffers can be changed by setting format-like variables
19804 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
19807 Local spool and several @sc{nntp} servers can be used at once
19808 (@pxref{Select Methods}).
19811 You can combine groups into virtual groups (@pxref{Virtual Groups}).
19814 You can read a number of different mail formats (@pxref{Getting Mail}).
19815 All the mail backends implement a convenient mail expiry scheme
19816 (@pxref{Expiring Mail}).
19819 Gnus can use various strategies for gathering threads that have lost
19820 their roots (thereby gathering loose sub-threads into one thread) or it
19821 can go back and retrieve enough headers to build a complete thread
19822 (@pxref{Customizing Threading}).
19825 Killed groups can be displayed in the group buffer, and you can read
19826 them as well (@pxref{Listing Groups}).
19829 Gnus can do partial group updates---you do not have to retrieve the
19830 entire active file just to check for new articles in a few groups
19831 (@pxref{The Active File}).
19834 Gnus implements a sliding scale of subscribedness to groups
19835 (@pxref{Group Levels}).
19838 You can score articles according to any number of criteria
19839 (@pxref{Scoring}). You can even get Gnus to find out how to score
19840 articles for you (@pxref{Adaptive Scoring}).
19843 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
19844 manner, so it should be difficult to lose much data on what you have
19845 read if your machine should go down (@pxref{Auto Save}).
19848 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
19849 the @file{.emacs} file.
19852 You can set the process mark on both groups and articles and perform
19853 operations on all the marked items (@pxref{Process/Prefix}).
19856 You can grep through a subset of groups and create a group from the
19857 results (@pxref{Kibozed Groups}).
19860 You can list subsets of groups according to, well, anything
19861 (@pxref{Listing Groups}).
19864 You can browse foreign servers and subscribe to groups from those
19865 servers (@pxref{Browse Foreign Server}).
19868 Gnus can fetch articles, asynchronously, on a second connection to the
19869 server (@pxref{Asynchronous Fetching}).
19872 You can cache articles locally (@pxref{Article Caching}).
19875 The uudecode functions have been expanded and generalized
19876 (@pxref{Decoding Articles}).
19879 You can still post uuencoded articles, which was a little-known feature
19880 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
19883 Fetching parents (and other articles) now actually works without
19884 glitches (@pxref{Finding the Parent}).
19887 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
19890 Digests (and other files) can be used as the basis for groups
19891 (@pxref{Document Groups}).
19894 Articles can be highlighted and customized (@pxref{Customizing
19898 URLs and other external references can be buttonized (@pxref{Article
19902 You can do lots of strange stuff with the Gnus window & frame
19903 configuration (@pxref{Windows Configuration}).
19906 You can click on buttons instead of using the keyboard
19912 @node September Gnus
19913 @subsubsection September Gnus
19917 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
19921 New features in Gnus 5.2/5.3:
19926 A new message composition mode is used. All old customization variables
19927 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
19931 Gnus is now able to generate @dfn{sparse} threads---threads where
19932 missing articles are represented by empty nodes (@pxref{Customizing
19936 (setq gnus-build-sparse-threads 'some)
19940 Outgoing articles are stored on a special archive server
19941 (@pxref{Archived Messages}).
19944 Partial thread regeneration now happens when articles are
19948 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
19951 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
19954 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
19957 (setq gnus-use-trees t)
19961 An @code{nn}-like pick-and-read minor mode is available for the summary
19962 buffers (@pxref{Pick and Read}).
19965 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
19969 In binary groups you can use a special binary minor mode (@pxref{Binary
19973 Groups can be grouped in a folding topic hierarchy (@pxref{Group
19977 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
19981 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
19984 Groups can now have a score, and bubbling based on entry frequency
19985 is possible (@pxref{Group Score}).
19988 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
19992 Groups can be process-marked, and commands can be performed on
19993 groups of groups (@pxref{Marking Groups}).
19996 Caching is possible in virtual groups.
19999 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
20000 news batches, ClariNet briefs collections, and just about everything
20001 else (@pxref{Document Groups}).
20004 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
20008 The Gnus cache is much faster.
20011 Groups can be sorted according to many criteria (@pxref{Sorting
20015 New group parameters have been introduced to set list-addresses and
20016 expiry times (@pxref{Group Parameters}).
20019 All formatting specs allow specifying faces to be used
20020 (@pxref{Formatting Fonts}).
20023 There are several more commands for setting/removing/acting on process
20024 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
20027 The summary buffer can be limited to show parts of the available
20028 articles based on a wide range of criteria. These commands have been
20029 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
20032 Articles can be made persistent with the @kbd{*} command
20033 (@pxref{Persistent Articles}).
20036 All functions for hiding article elements are now toggles.
20039 Article headers can be buttonized (@pxref{Article Washing}).
20042 All mail backends support fetching articles by @code{Message-ID}.
20045 Duplicate mail can now be treated properly (@pxref{Duplicates}).
20048 All summary mode commands are available directly from the article
20049 buffer (@pxref{Article Keymap}).
20052 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
20056 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
20059 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
20064 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
20067 (setq gnus-use-nocem t)
20071 Groups can be made permanently visible (@pxref{Listing Groups}).
20074 (setq gnus-permanently-visible-groups "^nnml:")
20078 Many new hooks have been introduced to make customizing easier.
20081 Gnus respects the @code{Mail-Copies-To} header.
20084 Threads can be gathered by looking at the @code{References} header
20085 (@pxref{Customizing Threading}).
20088 (setq gnus-summary-thread-gathering-function
20089 'gnus-gather-threads-by-references)
20093 Read articles can be stored in a special backlog buffer to avoid
20094 refetching (@pxref{Article Backlog}).
20097 (setq gnus-keep-backlog 50)
20101 A clean copy of the current article is always stored in a separate
20102 buffer to allow easier treatment.
20105 Gnus can suggest where to save articles (@pxref{Saving Articles}).
20108 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
20112 (setq gnus-prompt-before-saving t)
20116 @code{gnus-uu} can view decoded files asynchronously while fetching
20117 articles (@pxref{Other Decode Variables}).
20120 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
20124 Filling in the article buffer now works properly on cited text
20125 (@pxref{Article Washing}).
20128 Hiding cited text adds buttons to toggle hiding, and how much
20129 cited text to hide is now customizable (@pxref{Article Hiding}).
20132 (setq gnus-cited-lines-visible 2)
20136 Boring headers can be hidden (@pxref{Article Hiding}).
20139 Default scoring values can now be set from the menu bar.
20142 Further syntax checking of outgoing articles have been added.
20148 @subsubsection Red Gnus
20150 New features in Gnus 5.4/5.5:
20154 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
20161 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
20164 Article prefetching functionality has been moved up into
20165 Gnus (@pxref{Asynchronous Fetching}).
20168 Scoring can now be performed with logical operators like @code{and},
20169 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
20173 Article washing status can be displayed in the
20174 article mode line (@pxref{Misc Article}).
20177 @file{gnus.el} has been split into many smaller files.
20180 Suppression of duplicate articles based on Message-ID can be done
20181 (@pxref{Duplicate Suppression}).
20184 (setq gnus-suppress-duplicates t)
20188 New variables for specifying what score and adapt files are to be
20189 considered home score and adapt files (@pxref{Home Score File}) have
20193 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
20194 Server Internals}).
20197 Groups can inherit group parameters from parent topics (@pxref{Topic
20201 Article editing has been revamped and is now actually usable.
20204 Signatures can be recognized in more intelligent fashions
20205 (@pxref{Article Signature}).
20208 Summary pick mode has been made to look more @code{nn}-like. Line
20209 numbers are displayed and the @kbd{.} command can be used to pick
20210 articles (@code{Pick and Read}).
20213 Commands for moving the @file{.newsrc.eld} from one server to
20214 another have been added (@pxref{Changing Servers}).
20217 There's a way now to specify that ``uninteresting'' fields be suppressed
20218 when generating lines in buffers (@pxref{Advanced Formatting}).
20221 Several commands in the group buffer can be undone with @kbd{M-C-_}
20225 Scoring can be done on words using the new score type @code{w}
20226 (@pxref{Score File Format}).
20229 Adaptive scoring can be done on a Subject word-by-word basis
20230 (@pxref{Adaptive Scoring}).
20233 (setq gnus-use-adaptive-scoring '(word))
20237 Scores can be decayed (@pxref{Score Decays}).
20240 (setq gnus-decay-scores t)
20244 Scoring can be performed using a regexp on the Date header. The Date is
20245 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
20248 A new command has been added to remove all data on articles from
20249 the native server (@pxref{Changing Servers}).
20252 A new command for reading collections of documents
20253 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
20254 (@pxref{Really Various Summary Commands}).
20257 Process mark sets can be pushed and popped (@pxref{Setting Process
20261 A new mail-to-news backend makes it possible to post even when the @sc{nntp}
20262 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
20265 A new backend for reading searches from Web search engines
20266 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
20267 (@pxref{Web Searches}).
20270 Groups inside topics can now be sorted using the standard sorting
20271 functions, and each topic can be sorted independently (@pxref{Topic
20275 Subsets of the groups can be sorted independently (@code{Sorting
20279 Cached articles can be pulled into the groups (@pxref{Summary Generation
20283 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
20288 Score files are now applied in a more reliable order (@pxref{Score
20292 Reports on where mail messages end up can be generated (@pxref{Splitting
20296 More hooks and functions have been added to remove junk from incoming
20297 mail before saving the mail (@pxref{Washing Mail}).
20300 Emphasized text can be properly fontisized:
20306 @subsubsection Quassia Gnus
20308 New features in Gnus 5.6:
20313 New functionality for using Gnus as an offline newsreader has been
20314 added. A plethora of new commands and modes have been added. See
20315 @pxref{Gnus Unplugged} for the full story.
20318 The @code{nndraft} backend has returned, but works differently than
20319 before. All Message buffers are now also articles in the @code{nndraft}
20320 group, which is created automatically.
20323 @code{gnus-alter-header-function} can now be used to alter header
20327 @code{gnus-summary-goto-article} now accept Message-ID's.
20330 A new Message command for deleting text in the body of a message
20331 outside the region: @kbd{C-c C-v}.
20334 You can now post to component group in @code{nnvirtual} groups with
20338 @code{nntp-rlogin-program}---new variable to ease customization.
20341 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
20342 re-highlighting of the article buffer.
20345 New element in @code{gnus-boring-article-headers}---@code{long-to}.
20348 @kbd{M-i} symbolic prefix command. See the section "Symbolic
20349 Prefixes" in the Gnus manual for details.
20352 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
20353 @kbd{a} to add the score rule to the "all.SCORE" file.
20356 @code{gnus-simplify-subject-functions} variable to allow greater
20357 control over simplification.
20360 @kbd{A T}---new command for fetching the current thread.
20363 @kbd{/ T}---new command for including the current thread in the
20367 @kbd{M-RET} is a new Message command for breaking cited text.
20370 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
20373 The @code{custom-face-lookup} function has been removed.
20374 If you used this function in your initialization files, you must
20375 rewrite them to use @code{face-spec-set} instead.
20378 Canceling now uses the current select method. Symbolic prefix
20379 @kbd{a} forces normal posting method.
20382 New command to translate M******** sm*rtq**t*s into proper
20386 For easier debugging of @code{nntp}, you can set
20387 @code{nntp-record-commands} to a non-@code{nil} value.
20390 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
20391 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
20394 A command for editing group parameters from the summary buffer
20398 A history of where mails have been split is available.
20401 A new article date command has been added---@code{article-date-iso8601}.
20404 Subjects can be simplified when threading by setting
20405 @code{gnus-score-thread-simplify}.
20408 A new function for citing in Message has been
20409 added---@code{message-cite-original-without-signature}.
20412 @code{article-strip-all-blank-lines}---new article command.
20415 A new Message command to kill to the end of the article has
20419 A minimum adaptive score can be specified by using the
20420 @code{gnus-adaptive-word-minimum} variable.
20423 The "lapsed date" article header can be kept continually
20424 updated by the @code{gnus-start-date-timer} command.
20427 Web listserv archives can be read with the @code{nnlistserv} backend.
20430 Old dejanews archives can now be read by @code{nnweb}.
20434 @node Pterodactyl Gnus
20435 @subsubsection Pterodactyl Gnus
20437 New features in Gnus 5.8:
20441 @item The mail-fetching functions have changed. See the manual for the
20442 many details. In particular, all procmail fetching variables are gone.
20444 If you used procmail like in
20447 (setq nnmail-use-procmail t)
20448 (setq nnmail-spool-file 'procmail)
20449 (setq nnmail-procmail-directory "~/mail/incoming/")
20450 (setq nnmail-procmail-suffix "\\.in")
20453 this now has changed to
20457 '((directory :path "~/mail/incoming/"
20461 More information is available in the info doc at Select Methods ->
20462 Getting Mail -> Mail Sources
20464 @item Gnus is now a MIME-capable reader. This affects many parts of
20465 Gnus, and adds a slew of new commands. See the manual for details.
20467 @item Gnus has also been multilingualized. This also affects too
20468 many parts of Gnus to summarize here, and adds many new variables.
20470 @item @code{gnus-auto-select-first} can now be a function to be
20471 called to position point.
20473 @item The user can now decide which extra headers should be included in
20474 summary buffers and NOV files.
20476 @item @code{gnus-article-display-hook} has been removed. Instead, a number
20477 of variables starting with @code{gnus-treat-} have been added.
20479 @item The Gnus posting styles have been redone again and now works in a
20480 subtly different manner.
20482 @item New web-based backends have been added: @code{nnslashdot},
20483 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
20484 again, to keep up with ever-changing layouts.
20486 @item Gnus can now read IMAP mail via @code{nnimap}.
20494 @section The Manual
20498 This manual was generated from a TeXinfo file and then run through
20499 either @code{texi2dvi}
20501 or my own home-brewed TeXinfo to \LaTeX\ transformer,
20502 and then run through @code{latex} and @code{dvips}
20504 to get what you hold in your hands now.
20506 The following conventions have been used:
20511 This is a @samp{string}
20514 This is a @kbd{keystroke}
20517 This is a @file{file}
20520 This is a @code{symbol}
20524 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
20528 (setq flargnoze "yes")
20531 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
20534 (setq flumphel 'yes)
20537 @samp{yes} and @code{yes} are two @emph{very} different things---don't
20538 ever get them confused.
20542 Of course, everything in this manual is of vital interest, so you should
20543 read it all. Several times. However, if you feel like skimming the
20544 manual, look for that gnu head you should see in the margin over
20545 there---it means that what's being discussed is of more importance than
20546 the rest of the stuff. (On the other hand, if everything is infinitely
20547 important, how can anything be more important than that? Just one more
20548 of the mysteries of this world, I guess.)
20554 @node On Writing Manuals
20555 @section On Writing Manuals
20557 I guess most manuals are written after-the-fact; documenting a program
20558 that's already there. This is not how this manual is written. When
20559 implementing something, I write the manual entry for that something
20560 straight away. I then see that it's difficult to explain the
20561 functionality, so I write how it's supposed to be, and then I change the
20562 implementation. Writing the documentation and writing the code goes
20565 This, of course, means that this manual has no, or little, flow. It
20566 documents absolutely everything in Gnus, but often not where you're
20567 looking for it. It is a reference manual, and not a guide to how to get
20570 That would be a totally different book, that should be written using the
20571 reference manual as source material. It would look quite differently.
20576 @section Terminology
20578 @cindex terminology
20583 This is what you are supposed to use this thing for---reading news.
20584 News is generally fetched from a nearby @sc{nntp} server, and is
20585 generally publicly available to everybody. If you post news, the entire
20586 world is likely to read just what you have written, and they'll all
20587 snigger mischievously. Behind your back.
20591 Everything that's delivered to you personally is mail. Some news/mail
20592 readers (like Gnus) blur the distinction between mail and news, but
20593 there is a difference. Mail is private. News is public. Mailing is
20594 not posting, and replying is not following up.
20598 Send a mail to the person who has written what you are reading.
20602 Post an article to the current newsgroup responding to the article you
20607 Gnus gets fed articles from a number of backends, both news and mail
20608 backends. Gnus does not handle the underlying media, so to speak---this
20609 is all done by the backends.
20613 Gnus will always use one method (and backend) as the @dfn{native}, or
20614 default, way of getting news.
20618 You can also have any number of foreign groups active at the same time.
20619 These are groups that use non-native non-secondary backends for getting
20624 Secondary backends are somewhere half-way between being native and being
20625 foreign, but they mostly act like they are native.
20629 A message that has been posted as news.
20632 @cindex mail message
20633 A message that has been mailed.
20637 A mail message or news article
20641 The top part of a message, where administrative information (etc.) is
20646 The rest of an article. Everything not in the head is in the
20651 A line from the head of an article.
20655 A collection of such lines, or a collection of heads. Or even a
20656 collection of @sc{nov} lines.
20660 When Gnus enters a group, it asks the backend for the headers of all
20661 unread articles in the group. Most servers support the News OverView
20662 format, which is more compact and much faster to read and parse than the
20663 normal @sc{head} format.
20667 Each group is subscribed at some @dfn{level} or other (1-9). The ones
20668 that have a lower level are ``more'' subscribed than the groups with a
20669 higher level. In fact, groups on levels 1-5 are considered
20670 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
20671 are @dfn{killed}. Commands for listing groups and scanning for new
20672 articles will all use the numeric prefix as @dfn{working level}.
20674 @item killed groups
20675 @cindex killed groups
20676 No information on killed groups is stored or updated, which makes killed
20677 groups much easier to handle than subscribed groups.
20679 @item zombie groups
20680 @cindex zombie groups
20681 Just like killed groups, only slightly less dead.
20684 @cindex active file
20685 The news server has to keep track of what articles it carries, and what
20686 groups exist. All this information in stored in the active file, which
20687 is rather large, as you might surmise.
20690 @cindex bogus groups
20691 A group that exists in the @file{.newsrc} file, but isn't known to the
20692 server (i.e., it isn't in the active file), is a @emph{bogus group}.
20693 This means that the group probably doesn't exist (any more).
20696 @cindex activating groups
20697 The act of asking the server for info on a group and computing the
20698 number of unread articles is called @dfn{activating the group}.
20699 Un-activated groups are listed with @samp{*} in the group buffer.
20703 A machine one can connect to and get news (or mail) from.
20705 @item select method
20706 @cindex select method
20707 A structure that specifies the backend, the server and the virtual
20710 @item virtual server
20711 @cindex virtual server
20712 A named select method. Since a select method defines all there is to
20713 know about connecting to a (physical) server, taking the thing as a
20714 whole is a virtual server.
20718 Taking a buffer and running it through a filter of some sort. The
20719 result will (more often than not) be cleaner and more pleasing than the
20722 @item ephemeral groups
20723 @cindex ephemeral groups
20724 Most groups store data on what articles you have read. @dfn{Ephemeral}
20725 groups are groups that will have no data stored---when you exit the
20726 group, it'll disappear into the aether.
20729 @cindex solid groups
20730 This is the opposite of ephemeral groups. All groups listed in the
20731 group buffer are solid groups.
20733 @item sparse articles
20734 @cindex sparse articles
20735 These are article placeholders shown in the summary buffer when
20736 @code{gnus-build-sparse-threads} has been switched on.
20740 To put responses to articles directly after the articles they respond
20741 to---in a hierarchical fashion.
20745 @cindex thread root
20746 The first article in a thread is the root. It is the ancestor of all
20747 articles in the thread.
20751 An article that has responses.
20755 An article that responds to a different article---its parent.
20759 A collection of messages in one file. The most common digest format is
20760 specified by RFC 1153.
20766 @node Customization
20767 @section Customization
20768 @cindex general customization
20770 All variables are properly documented elsewhere in this manual. This
20771 section is designed to give general pointers on how to customize Gnus
20772 for some quite common situations.
20775 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
20776 * Slow Terminal Connection:: You run a remote Emacs.
20777 * Little Disk Space:: You feel that having large setup files is icky.
20778 * Slow Machine:: You feel like buying a faster machine.
20782 @node Slow/Expensive Connection
20783 @subsection Slow/Expensive @sc{nntp} Connection
20785 If you run Emacs on a machine locally, and get your news from a machine
20786 over some very thin strings, you want to cut down on the amount of data
20787 Gnus has to get from the @sc{nntp} server.
20791 @item gnus-read-active-file
20792 Set this to @code{nil}, which will inhibit Gnus from requesting the
20793 entire active file from the server. This file is often v. large. You
20794 also have to set @code{gnus-check-new-newsgroups} and
20795 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
20796 doesn't suddenly decide to fetch the active file anyway.
20798 @item gnus-nov-is-evil
20799 This one has to be @code{nil}. If not, grabbing article headers from
20800 the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers
20801 support @sc{xover}; Gnus will detect this by itself.
20805 @node Slow Terminal Connection
20806 @subsection Slow Terminal Connection
20808 Let's say you use your home computer for dialing up the system that runs
20809 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
20810 possible) the amount of data sent over the wires.
20814 @item gnus-auto-center-summary
20815 Set this to @code{nil} to inhibit Gnus from re-centering the summary
20816 buffer all the time. If it is @code{vertical}, do only vertical
20817 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
20818 horizontal and vertical recentering.
20820 @item gnus-visible-headers
20821 Cut down on the headers included in the articles to the
20822 minimum. You can, in fact, make do without them altogether---most of the
20823 useful data is in the summary buffer, anyway. Set this variable to
20824 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
20826 Set this hook to all the available hiding commands:
20828 (setq gnus-treat-hide-headers 'head
20829 gnus-treat-hide-signature t
20830 gnus-treat-hide-citation t)
20833 @item gnus-use-full-window
20834 By setting this to @code{nil}, you can make all the windows smaller.
20835 While this doesn't really cut down much generally, it means that you
20836 have to see smaller portions of articles before deciding that you didn't
20837 want to read them anyway.
20839 @item gnus-thread-hide-subtree
20840 If this is non-@code{nil}, all threads in the summary buffer will be
20843 @item gnus-updated-mode-lines
20844 If this is @code{nil}, Gnus will not put information in the buffer mode
20845 lines, which might save some time.
20849 @node Little Disk Space
20850 @subsection Little Disk Space
20853 The startup files can get rather large, so you may want to cut their
20854 sizes a bit if you are running out of space.
20858 @item gnus-save-newsrc-file
20859 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
20860 only save @file{.newsrc.eld}. This means that you will not be able to
20861 use any other newsreaders than Gnus. This variable is @code{t} by
20864 @item gnus-read-newsrc-file
20865 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
20866 only read @file{.newsrc.eld}. This means that you will not be able to
20867 use any other newsreaders than Gnus. This variable is @code{t} by
20870 @item gnus-save-killed-list
20871 If this is @code{nil}, Gnus will not save the list of dead groups. You
20872 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
20873 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
20874 variable to @code{nil}. This variable is @code{t} by default.
20880 @subsection Slow Machine
20881 @cindex slow machine
20883 If you have a slow machine, or are just really impatient, there are a
20884 few things you can do to make Gnus run faster.
20886 Set @code{gnus-check-new-newsgroups} and
20887 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
20889 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
20890 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
20891 summary buffer faster.
20895 @node Troubleshooting
20896 @section Troubleshooting
20897 @cindex troubleshooting
20899 Gnus works @emph{so} well straight out of the box---I can't imagine any
20907 Make sure your computer is switched on.
20910 Make sure that you really load the current Gnus version. If you have
20911 been running @sc{gnus}, you need to exit Emacs and start it up again before
20915 Try doing an @kbd{M-x gnus-version}. If you get something that looks
20916 like @samp{T-gnus 6.15.* (based on Oort Gnus v0.*; for SEMI 1.1*, FLIM
20917 1.1*)} you have the right files loaded. If, on the other hand, you get
20918 something like @samp{NNTP 3.x} or @samp{nntp flee}, you have some old
20919 @file{.el} files lying around. Delete these.
20922 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
20926 @vindex max-lisp-eval-depth
20927 Gnus works on many recursive structures, and in some extreme (and very
20928 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
20929 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
20930 something like that.
20933 If all else fails, report the problem as a bug.
20936 @cindex reporting bugs
20938 @kindex M-x gnus-bug
20940 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
20941 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
20942 me the backtrace. I will fix bugs, but I can only fix them if you send
20943 me a precise description as to how to reproduce the bug.
20945 You really can never be too detailed in a bug report. Always use the
20946 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
20947 a 10Kb mail each time you use it, and even if you have sent me your
20948 environment 500 times before. I don't care. I want the full info each
20951 It is also important to remember that I have no memory whatsoever. If
20952 you send a bug report, and I send you a reply, and then you just send
20953 back ``No, it's not! Moron!'', I will have no idea what you are
20954 insulting me about. Always over-explain everything. It's much easier
20955 for all of us---if I don't have all the information I need, I will just
20956 mail you and ask for more info, and everything takes more time.
20958 If the problem you're seeing is very visual, and you can't quite explain
20959 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
20960 it somewhere it can be reached, and include the URL of the picture in
20963 If you just need help, you are better off asking on
20964 @samp{gnu.emacs.gnus}. I'm not very helpful.
20966 @cindex gnu.emacs.gnus
20967 @cindex ding mailing list
20968 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
20969 Write to @samp{ding-request@@gnus.org} to subscribe.
20973 @node Gnus Reference Guide
20974 @section Gnus Reference Guide
20976 It is my hope that other people will figure out smart stuff that Gnus
20977 can do, and that other people will write those smart things as well. To
20978 facilitate that I thought it would be a good idea to describe the inner
20979 workings of Gnus. And some of the not-so-inner workings, while I'm at
20982 You can never expect the internals of a program not to change, but I
20983 will be defining (in some details) the interface between Gnus and its
20984 backends (this is written in stone), the format of the score files
20985 (ditto), data structures (some are less likely to change than others)
20986 and general methods of operation.
20989 * Gnus Utility Functions:: Common functions and variable to use.
20990 * Backend Interface:: How Gnus communicates with the servers.
20991 * Score File Syntax:: A BNF definition of the score file standard.
20992 * Headers:: How Gnus stores headers internally.
20993 * Ranges:: A handy format for storing mucho numbers.
20994 * Group Info:: The group info format.
20995 * Extended Interactive:: Symbolic prefixes and stuff.
20996 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
20997 * Various File Formats:: Formats of files that Gnus use.
21001 @node Gnus Utility Functions
21002 @subsection Gnus Utility Functions
21003 @cindex Gnus utility functions
21004 @cindex utility functions
21006 @cindex internal variables
21008 When writing small functions to be run from hooks (and stuff), it's
21009 vital to have access to the Gnus internal functions and variables.
21010 Below is a list of the most common ones.
21014 @item gnus-newsgroup-name
21015 @vindex gnus-newsgroup-name
21016 This variable holds the name of the current newsgroup.
21018 @item gnus-find-method-for-group
21019 @findex gnus-find-method-for-group
21020 A function that returns the select method for @var{group}.
21022 @item gnus-group-real-name
21023 @findex gnus-group-real-name
21024 Takes a full (prefixed) Gnus group name, and returns the unprefixed
21027 @item gnus-group-prefixed-name
21028 @findex gnus-group-prefixed-name
21029 Takes an unprefixed group name and a select method, and returns the full
21030 (prefixed) Gnus group name.
21032 @item gnus-get-info
21033 @findex gnus-get-info
21034 Returns the group info list for @var{group}.
21036 @item gnus-group-unread
21037 @findex gnus-group-unread
21038 The number of unread articles in @var{group}, or @code{t} if that is
21042 @findex gnus-active
21043 The active entry for @var{group}.
21045 @item gnus-set-active
21046 @findex gnus-set-active
21047 Set the active entry for @var{group}.
21049 @item gnus-add-current-to-buffer-list
21050 @findex gnus-add-current-to-buffer-list
21051 Adds the current buffer to the list of buffers to be killed on Gnus
21054 @item gnus-continuum-version
21055 @findex gnus-continuum-version
21056 Takes a Gnus version string as a parameter and returns a floating point
21057 number. Earlier versions will always get a lower number than later
21060 @item gnus-group-read-only-p
21061 @findex gnus-group-read-only-p
21062 Says whether @var{group} is read-only or not.
21064 @item gnus-news-group-p
21065 @findex gnus-news-group-p
21066 Says whether @var{group} came from a news backend.
21068 @item gnus-ephemeral-group-p
21069 @findex gnus-ephemeral-group-p
21070 Says whether @var{group} is ephemeral or not.
21072 @item gnus-server-to-method
21073 @findex gnus-server-to-method
21074 Returns the select method corresponding to @var{server}.
21076 @item gnus-server-equal
21077 @findex gnus-server-equal
21078 Says whether two virtual servers are equal.
21080 @item gnus-group-native-p
21081 @findex gnus-group-native-p
21082 Says whether @var{group} is native or not.
21084 @item gnus-group-secondary-p
21085 @findex gnus-group-secondary-p
21086 Says whether @var{group} is secondary or not.
21088 @item gnus-group-foreign-p
21089 @findex gnus-group-foreign-p
21090 Says whether @var{group} is foreign or not.
21092 @item group-group-find-parameter
21093 @findex group-group-find-parameter
21094 Returns the parameter list of @var{group}. If given a second parameter,
21095 returns the value of that parameter for @var{group}.
21097 @item gnus-group-set-parameter
21098 @findex gnus-group-set-parameter
21099 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
21101 @item gnus-narrow-to-body
21102 @findex gnus-narrow-to-body
21103 Narrows the current buffer to the body of the article.
21105 @item gnus-check-backend-function
21106 @findex gnus-check-backend-function
21107 Takes two parameters, @var{function} and @var{group}. If the backend
21108 @var{group} comes from supports @var{function}, return non-@code{nil}.
21111 (gnus-check-backend-function "request-scan" "nnml:misc")
21115 @item gnus-read-method
21116 @findex gnus-read-method
21117 Prompts the user for a select method.
21122 @node Backend Interface
21123 @subsection Backend Interface
21125 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
21126 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
21127 server is a @dfn{backend} and some @dfn{backend variables}. As examples
21128 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
21129 examples of the latter we have @code{nntp-port-number} and
21130 @code{nnmbox-directory}.
21132 When Gnus asks for information from a backend---say @code{nntp}---on
21133 something, it will normally include a virtual server name in the
21134 function parameters. (If not, the backend should use the ``current''
21135 virtual server.) For instance, @code{nntp-request-list} takes a virtual
21136 server as its only (optional) parameter. If this virtual server hasn't
21137 been opened, the function should fail.
21139 Note that a virtual server name has no relation to some physical server
21140 name. Take this example:
21144 (nntp-address "ifi.uio.no")
21145 (nntp-port-number 4324))
21148 Here the virtual server name is @samp{odd-one} while the name of
21149 the physical server is @samp{ifi.uio.no}.
21151 The backends should be able to switch between several virtual servers.
21152 The standard backends implement this by keeping an alist of virtual
21153 server environments that they pull down/push up when needed.
21155 There are two groups of interface functions: @dfn{required functions},
21156 which must be present, and @dfn{optional functions}, which Gnus will
21157 always check for presence before attempting to call 'em.
21159 All these functions are expected to return data in the buffer
21160 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
21161 unfortunately named, but we'll have to live with it. When I talk about
21162 @dfn{resulting data}, I always refer to the data in that buffer. When I
21163 talk about @dfn{return value}, I talk about the function value returned by
21164 the function call. Functions that fail should return @code{nil} as the
21167 Some backends could be said to be @dfn{server-forming} backends, and
21168 some might be said not to be. The latter are backends that generally
21169 only operate on one group at a time, and have no concept of ``server''
21170 -- they have a group, and they deliver info on that group and nothing
21173 In the examples and definitions I will refer to the imaginary backend
21176 @cindex @code{nnchoke}
21179 * Required Backend Functions:: Functions that must be implemented.
21180 * Optional Backend Functions:: Functions that need not be implemented.
21181 * Error Messaging:: How to get messages and report errors.
21182 * Writing New Backends:: Extending old backends.
21183 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
21184 * Mail-like Backends:: Some tips on mail backends.
21188 @node Required Backend Functions
21189 @subsubsection Required Backend Functions
21193 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
21195 @var{articles} is either a range of article numbers or a list of
21196 @code{Message-ID}s. Current backends do not fully support either---only
21197 sequences (lists) of article numbers, and most backends do not support
21198 retrieval of @code{Message-ID}s. But they should try for both.
21200 The result data should either be HEADs or NOV lines, and the result
21201 value should either be @code{headers} or @code{nov} to reflect this.
21202 This might later be expanded to @code{various}, which will be a mixture
21203 of HEADs and NOV lines, but this is currently not supported by Gnus.
21205 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
21206 headers", in some meaning of the word. This is generally done by
21207 fetching (at most) @var{fetch-old} extra headers less than the smallest
21208 article number in @code{articles}, and filling the gaps as well. The
21209 presence of this parameter can be ignored if the backend finds it
21210 cumbersome to follow the request. If this is non-@code{nil} and not a
21211 number, do maximum fetches.
21213 Here's an example HEAD:
21216 221 1056 Article retrieved.
21217 Path: ifi.uio.no!sturles
21218 From: sturles@@ifi.uio.no (Sturle Sunde)
21219 Newsgroups: ifi.discussion
21220 Subject: Re: Something very droll
21221 Date: 27 Oct 1994 14:02:57 +0100
21222 Organization: Dept. of Informatics, University of Oslo, Norway
21224 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
21225 References: <38jdmq$4qu@@visbur.ifi.uio.no>
21226 NNTP-Posting-Host: holmenkollen.ifi.uio.no
21230 So a @code{headers} return value would imply that there's a number of
21231 these in the data buffer.
21233 Here's a BNF definition of such a buffer:
21237 head = error / valid-head
21238 error-message = [ "4" / "5" ] 2number " " <error message> eol
21239 valid-head = valid-message *header "." eol
21240 valid-message = "221 " <number> " Article retrieved." eol
21241 header = <text> eol
21244 If the return value is @code{nov}, the data buffer should contain
21245 @dfn{network overview database} lines. These are basically fields
21249 nov-buffer = *nov-line
21250 nov-line = 8*9 [ field <TAB> ] eol
21251 field = <text except TAB>
21254 For a closer look at what should be in those fields,
21258 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
21260 @var{server} is here the virtual server name. @var{definitions} is a
21261 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
21263 If the server can't be opened, no error should be signaled. The backend
21264 may then choose to refuse further attempts at connecting to this
21265 server. In fact, it should do so.
21267 If the server is opened already, this function should return a
21268 non-@code{nil} value. There should be no data returned.
21271 @item (nnchoke-close-server &optional SERVER)
21273 Close connection to @var{server} and free all resources connected
21274 to it. Return @code{nil} if the server couldn't be closed for some
21277 There should be no data returned.
21280 @item (nnchoke-request-close)
21282 Close connection to all servers and free all resources that the backend
21283 have reserved. All buffers that have been created by that backend
21284 should be killed. (Not the @code{nntp-server-buffer}, though.) This
21285 function is generally only called when Gnus is shutting down.
21287 There should be no data returned.
21290 @item (nnchoke-server-opened &optional SERVER)
21292 If @var{server} is the current virtual server, and the connection to the
21293 physical server is alive, then this function should return a
21294 non-@code{nil} vlue. This function should under no circumstances
21295 attempt to reconnect to a server we have lost connection to.
21297 There should be no data returned.
21300 @item (nnchoke-status-message &optional SERVER)
21302 This function should return the last error message from @var{server}.
21304 There should be no data returned.
21307 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
21309 The result data from this function should be the article specified by
21310 @var{article}. This might either be a @code{Message-ID} or a number.
21311 It is optional whether to implement retrieval by @code{Message-ID}, but
21312 it would be nice if that were possible.
21314 If @var{to-buffer} is non-@code{nil}, the result data should be returned
21315 in this buffer instead of the normal data buffer. This is to make it
21316 possible to avoid copying large amounts of data from one buffer to
21317 another, while Gnus mainly requests articles to be inserted directly
21318 into its article buffer.
21320 If it is at all possible, this function should return a cons cell where
21321 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
21322 the article number. This will enable Gnus to find out what the real
21323 group and article numbers are when fetching articles by
21324 @code{Message-ID}. If this isn't possible, @code{t} should be returned
21325 on successful article retrieval.
21328 @item (nnchoke-request-group GROUP &optional SERVER FAST)
21330 Get data on @var{group}. This function also has the side effect of
21331 making @var{group} the current group.
21333 If @var{fast}, don't bother to return useful data, just make @var{group}
21336 Here's an example of some result data and a definition of the same:
21339 211 56 1000 1059 ifi.discussion
21342 The first number is the status, which should be 211. Next is the
21343 total number of articles in the group, the lowest article number, the
21344 highest article number, and finally the group name. Note that the total
21345 number of articles may be less than one might think while just
21346 considering the highest and lowest article numbers, but some articles
21347 may have been canceled. Gnus just discards the total-number, so
21348 whether one should take the bother to generate it properly (if that is a
21349 problem) is left as an exercise to the reader.
21352 group-status = [ error / info ] eol
21353 error = [ "4" / "5" ] 2<number> " " <Error message>
21354 info = "211 " 3* [ <number> " " ] <string>
21358 @item (nnchoke-close-group GROUP &optional SERVER)
21360 Close @var{group} and free any resources connected to it. This will be
21361 a no-op on most backends.
21363 There should be no data returned.
21366 @item (nnchoke-request-list &optional SERVER)
21368 Return a list of all groups available on @var{server}. And that means
21371 Here's an example from a server that only carries two groups:
21374 ifi.test 0000002200 0000002000 y
21375 ifi.discussion 3324 3300 n
21378 On each line we have a group name, then the highest article number in
21379 that group, the lowest article number, and finally a flag.
21382 active-file = *active-line
21383 active-line = name " " <number> " " <number> " " flags eol
21385 flags = "n" / "y" / "m" / "x" / "j" / "=" name
21388 The flag says whether the group is read-only (@samp{n}), is moderated
21389 (@samp{m}), is dead (@samp{x}), is aliased to some other group
21390 (@samp{=other-group}) or none of the above (@samp{y}).
21393 @item (nnchoke-request-post &optional SERVER)
21395 This function should post the current buffer. It might return whether
21396 the posting was successful or not, but that's not required. If, for
21397 instance, the posting is done asynchronously, it has generally not been
21398 completed by the time this function concludes. In that case, this
21399 function should set up some kind of sentinel to beep the user loud and
21400 clear if the posting could not be completed.
21402 There should be no result data from this function.
21407 @node Optional Backend Functions
21408 @subsubsection Optional Backend Functions
21412 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
21414 @var{groups} is a list of groups, and this function should request data
21415 on all those groups. How it does it is of no concern to Gnus, but it
21416 should attempt to do this in a speedy fashion.
21418 The return value of this function can be either @code{active} or
21419 @code{group}, which says what the format of the result data is. The
21420 former is in the same format as the data from
21421 @code{nnchoke-request-list}, while the latter is a buffer full of lines
21422 in the same format as @code{nnchoke-request-group} gives.
21425 group-buffer = *active-line / *group-status
21429 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
21431 A Gnus group info (@pxref{Group Info}) is handed to the backend for
21432 alterations. This comes in handy if the backend really carries all the
21433 information (as is the case with virtual and imap groups). This
21434 function should destructively alter the info to suit its needs, and
21435 should return the (altered) group info.
21437 There should be no result data from this function.
21440 @item (nnchoke-request-type GROUP &optional ARTICLE)
21442 When the user issues commands for ``sending news'' (@kbd{F} in the
21443 summary buffer, for instance), Gnus has to know whether the article the
21444 user is following up on is news or mail. This function should return
21445 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
21446 is mail and @code{unknown} if the type can't be decided. (The
21447 @var{article} parameter is necessary in @code{nnvirtual} groups which
21448 might very well combine mail groups and news groups.) Both @var{group}
21449 and @var{article} may be @code{nil}.
21451 There should be no result data from this function.
21454 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
21456 Set/remove/add marks on articles. Normally Gnus handles the article
21457 marks (such as read, ticked, expired etc) internally, and store them in
21458 @code{~/.newsrc.eld}. Some backends (such as @sc{imap}) however carry
21459 all information about the articles on the server, so Gnus need to
21460 propagate the mark information to the server.
21462 ACTION is a list of mark setting requests, having this format:
21465 (RANGE ACTION MARK)
21468 RANGE is a range of articles you wish to update marks on. ACTION is
21469 @code{set}, @code{add} or @code{del}, respectively used for removing all
21470 existing marks and setting them as specified, adding (preserving the
21471 marks not mentioned) mark and removing (preserving the marks not
21472 mentioned) marks. MARK is a list of marks; where each mark is a symbol.
21473 Currently used marks are @code{read}, @code{tick}, @code{reply},
21474 @code{expire}, @code{killed}, @code{dormant}, @code{save},
21475 @code{download} and @code{unsend}, but your backend should, if possible,
21476 not limit itself to these.
21478 Given contradictory actions, the last action in the list should be the
21479 effective one. That is, if your action contains a request to add the
21480 @code{tick} mark on article 1 and, later in the list, a request to
21481 remove the mark on the same article, the mark should in fact be removed.
21483 An example action list:
21486 (((5 12 30) 'del '(tick))
21487 ((10 . 90) 'add '(read expire))
21488 ((92 94) 'del '(read)))
21491 The function should return a range of articles it wasn't able to set the
21492 mark on (currently not used for anything).
21494 There should be no result data from this function.
21496 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
21498 If the user tries to set a mark that the backend doesn't like, this
21499 function may change the mark. Gnus will use whatever this function
21500 returns as the mark for @var{article} instead of the original
21501 @var{mark}. If the backend doesn't care, it must return the original
21502 @var{mark}, and not @code{nil} or any other type of garbage.
21504 The only use for this I can see is what @code{nnvirtual} does with
21505 it---if a component group is auto-expirable, marking an article as read
21506 in the virtual group should result in the article being marked as
21509 There should be no result data from this function.
21512 @item (nnchoke-request-scan &optional GROUP SERVER)
21514 This function may be called at any time (by Gnus or anything else) to
21515 request that the backend check for incoming articles, in one way or
21516 another. A mail backend will typically read the spool file or query the
21517 POP server when this function is invoked. The @var{group} doesn't have
21518 to be heeded---if the backend decides that it is too much work just
21519 scanning for a single group, it may do a total scan of all groups. It
21520 would be nice, however, to keep things local if that's practical.
21522 There should be no result data from this function.
21525 @item (nnchoke-request-group-description GROUP &optional SERVER)
21527 The result data from this function should be a description of
21531 description-line = name <TAB> description eol
21533 description = <text>
21536 @item (nnchoke-request-list-newsgroups &optional SERVER)
21538 The result data from this function should be the description of all
21539 groups available on the server.
21542 description-buffer = *description-line
21546 @item (nnchoke-request-newgroups DATE &optional SERVER)
21548 The result data from this function should be all groups that were
21549 created after @samp{date}, which is in normal human-readable date
21550 format. The data should be in the active buffer format.
21553 @item (nnchoke-request-create-group GROUP &optional SERVER)
21555 This function should create an empty group with name @var{group}.
21557 There should be no return data.
21560 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
21562 This function should run the expiry process on all articles in the
21563 @var{articles} range (which is currently a simple list of article
21564 numbers.) It is left up to the backend to decide how old articles
21565 should be before they are removed by this function. If @var{force} is
21566 non-@code{nil}, all @var{articles} should be deleted, no matter how new
21569 This function should return a list of articles that it did not/was not
21572 There should be no result data returned.
21575 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
21578 This function should move @var{article} (which is a number) from
21579 @var{group} by calling @var{accept-form}.
21581 This function should ready the article in question for moving by
21582 removing any header lines it has added to the article, and generally
21583 should ``tidy up'' the article. Then it should @code{eval}
21584 @var{accept-form} in the buffer where the ``tidy'' article is. This
21585 will do the actual copying. If this @code{eval} returns a
21586 non-@code{nil} value, the article should be removed.
21588 If @var{last} is @code{nil}, that means that there is a high likelihood
21589 that there will be more requests issued shortly, so that allows some
21592 The function should return a cons where the @code{car} is the group name and
21593 the @code{cdr} is the article number that the article was entered as.
21595 There should be no data returned.
21598 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
21600 This function takes the current buffer and inserts it into @var{group}.
21601 If @var{last} in @code{nil}, that means that there will be more calls to
21602 this function in short order.
21604 The function should return a cons where the @code{car} is the group name and
21605 the @code{cdr} is the article number that the article was entered as.
21607 There should be no data returned.
21610 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
21612 This function should remove @var{article} (which is a number) from
21613 @var{group} and insert @var{buffer} there instead.
21615 There should be no data returned.
21618 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
21620 This function should delete @var{group}. If @var{force}, it should
21621 really delete all the articles in the group, and then delete the group
21622 itself. (If there is such a thing as ``the group itself''.)
21624 There should be no data returned.
21627 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
21629 This function should rename @var{group} into @var{new-name}. All
21630 articles in @var{group} should move to @var{new-name}.
21632 There should be no data returned.
21637 @node Error Messaging
21638 @subsubsection Error Messaging
21640 @findex nnheader-report
21641 @findex nnheader-get-report
21642 The backends should use the function @code{nnheader-report} to report
21643 error conditions---they should not raise errors when they aren't able to
21644 perform a request. The first argument to this function is the backend
21645 symbol, and the rest are interpreted as arguments to @code{format} if
21646 there are multiple of them, or just a string if there is one of them.
21647 This function must always returns @code{nil}.
21650 (nnheader-report 'nnchoke "You did something totally bogus")
21652 (nnheader-report 'nnchoke "Could not request group %s" group)
21655 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
21656 @code{nil} back from a server, and this function returns the most
21657 recently reported message for the backend in question. This function
21658 takes one argument---the server symbol.
21660 Internally, these functions access @var{backend}@code{-status-string},
21661 so the @code{nnchoke} backend will have its error message stored in
21662 @code{nnchoke-status-string}.
21665 @node Writing New Backends
21666 @subsubsection Writing New Backends
21668 Many backends are quite similar. @code{nnml} is just like
21669 @code{nnspool}, but it allows you to edit the articles on the server.
21670 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
21671 and it doesn't maintain overview databases. @code{nndir} is just like
21672 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
21675 It would make sense if it were possible to ``inherit'' functions from
21676 backends when writing new backends. And, indeed, you can do that if you
21677 want to. (You don't have to if you don't want to, of course.)
21679 All the backends declare their public variables and functions by using a
21680 package called @code{nnoo}.
21682 To inherit functions from other backends (and allow other backends to
21683 inherit functions from the current backend), you should use the
21689 This macro declares the first parameter to be a child of the subsequent
21690 parameters. For instance:
21693 (nnoo-declare nndir
21697 @code{nndir} has declared here that it intends to inherit functions from
21698 both @code{nnml} and @code{nnmh}.
21701 This macro is equivalent to @code{defvar}, but registers the variable as
21702 a public server variable. Most state-oriented variables should be
21703 declared with @code{defvoo} instead of @code{defvar}.
21705 In addition to the normal @code{defvar} parameters, it takes a list of
21706 variables in the parent backends to map the variable to when executing
21707 a function in those backends.
21710 (defvoo nndir-directory nil
21711 "Where nndir will look for groups."
21712 nnml-current-directory nnmh-current-directory)
21715 This means that @code{nnml-current-directory} will be set to
21716 @code{nndir-directory} when an @code{nnml} function is called on behalf
21717 of @code{nndir}. (The same with @code{nnmh}.)
21719 @item nnoo-define-basics
21720 This macro defines some common functions that almost all backends should
21724 (nnoo-define-basics nndir)
21728 This macro is just like @code{defun} and takes the same parameters. In
21729 addition to doing the normal @code{defun} things, it registers the
21730 function as being public so that other backends can inherit it.
21732 @item nnoo-map-functions
21733 This macro allows mapping of functions from the current backend to
21734 functions from the parent backends.
21737 (nnoo-map-functions nndir
21738 (nnml-retrieve-headers 0 nndir-current-group 0 0)
21739 (nnmh-request-article 0 nndir-current-group 0 0))
21742 This means that when @code{nndir-retrieve-headers} is called, the first,
21743 third, and fourth parameters will be passed on to
21744 @code{nnml-retrieve-headers}, while the second parameter is set to the
21745 value of @code{nndir-current-group}.
21748 This macro allows importing functions from backends. It should be the
21749 last thing in the source file, since it will only define functions that
21750 haven't already been defined.
21756 nnmh-request-newgroups)
21760 This means that calls to @code{nndir-request-list} should just be passed
21761 on to @code{nnmh-request-list}, while all public functions from
21762 @code{nnml} that haven't been defined in @code{nndir} yet should be
21767 Below is a slightly shortened version of the @code{nndir} backend.
21770 ;;; nndir.el --- single directory newsgroup access for Gnus
21771 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
21775 (require 'nnheader)
21779 (eval-when-compile (require 'cl))
21781 (nnoo-declare nndir
21784 (defvoo nndir-directory nil
21785 "Where nndir will look for groups."
21786 nnml-current-directory nnmh-current-directory)
21788 (defvoo nndir-nov-is-evil nil
21789 "*Non-nil means that nndir will never retrieve NOV headers."
21792 (defvoo nndir-current-group ""
21794 nnml-current-group nnmh-current-group)
21795 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
21796 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
21798 (defvoo nndir-status-string "" nil nnmh-status-string)
21799 (defconst nndir-version "nndir 1.0")
21801 ;;; Interface functions.
21803 (nnoo-define-basics nndir)
21805 (deffoo nndir-open-server (server &optional defs)
21806 (setq nndir-directory
21807 (or (cadr (assq 'nndir-directory defs))
21809 (unless (assq 'nndir-directory defs)
21810 (push `(nndir-directory ,server) defs))
21811 (push `(nndir-current-group
21812 ,(file-name-nondirectory
21813 (directory-file-name nndir-directory)))
21815 (push `(nndir-top-directory
21816 ,(file-name-directory (directory-file-name nndir-directory)))
21818 (nnoo-change-server 'nndir server defs))
21820 (nnoo-map-functions nndir
21821 (nnml-retrieve-headers 0 nndir-current-group 0 0)
21822 (nnmh-request-article 0 nndir-current-group 0 0)
21823 (nnmh-request-group nndir-current-group 0 0)
21824 (nnmh-close-group nndir-current-group 0))
21828 nnmh-status-message
21830 nnmh-request-newgroups))
21836 @node Hooking New Backends Into Gnus
21837 @subsubsection Hooking New Backends Into Gnus
21839 @vindex gnus-valid-select-methods
21840 Having Gnus start using your new backend is rather easy---you just
21841 declare it with the @code{gnus-declare-backend} functions. This will
21842 enter the backend into the @code{gnus-valid-select-methods} variable.
21844 @code{gnus-declare-backend} takes two parameters---the backend name and
21845 an arbitrary number of @dfn{abilities}.
21850 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
21853 The abilities can be:
21857 This is a mailish backend---followups should (probably) go via mail.
21859 This is a newsish backend---followups should (probably) go via news.
21861 This backend supports both mail and news.
21863 This is neither a post nor mail backend---it's something completely
21866 It supports respooling---or rather, it is able to modify its source
21867 articles and groups.
21869 The name of the server should be in the virtual server name. This is
21870 true for almost all backends.
21871 @item prompt-address
21872 The user should be prompted for an address when doing commands like
21873 @kbd{B} in the group buffer. This is true for backends like
21874 @code{nntp}, but not @code{nnmbox}, for instance.
21878 @node Mail-like Backends
21879 @subsubsection Mail-like Backends
21881 One of the things that separate the mail backends from the rest of the
21882 backends is the heavy dependence by the mail backends on common
21883 functions in @file{nnmail.el}. For instance, here's the definition of
21884 @code{nnml-request-scan}:
21887 (deffoo nnml-request-scan (&optional group server)
21888 (setq nnml-article-file-alist nil)
21889 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
21892 It simply calls @code{nnmail-get-new-mail} with a few parameters,
21893 and @code{nnmail} takes care of all the moving and splitting of the
21896 This function takes four parameters.
21900 This should be a symbol to designate which backend is responsible for
21903 @item exit-function
21904 This function should be called after the splitting has been performed.
21906 @item temp-directory
21907 Where the temporary files should be stored.
21910 This optional argument should be a group name if the splitting is to be
21911 performed for one group only.
21914 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
21915 save each article. @var{backend}@code{-active-number} will be called to
21916 find the article number assigned to this article.
21918 The function also uses the following variables:
21919 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
21920 this backend); and @var{backend}@code{-group-alist} and
21921 @var{backend}@code{-active-file} to generate the new active file.
21922 @var{backend}@code{-group-alist} should be a group-active alist, like
21926 (("a-group" (1 . 10))
21927 ("some-group" (34 . 39)))
21931 @node Score File Syntax
21932 @subsection Score File Syntax
21934 Score files are meant to be easily parseable, but yet extremely
21935 mallable. It was decided that something that had the same read syntax
21936 as an Emacs Lisp list would fit that spec.
21938 Here's a typical score file:
21942 ("win95" -10000 nil s)
21949 BNF definition of a score file:
21952 score-file = "" / "(" *element ")"
21953 element = rule / atom
21954 rule = string-rule / number-rule / date-rule
21955 string-rule = "(" quote string-header quote space *string-match ")"
21956 number-rule = "(" quote number-header quote space *number-match ")"
21957 date-rule = "(" quote date-header quote space *date-match ")"
21959 string-header = "subject" / "from" / "references" / "message-id" /
21960 "xref" / "body" / "head" / "all" / "followup"
21961 number-header = "lines" / "chars"
21962 date-header = "date"
21963 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
21964 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
21965 score = "nil" / <integer>
21966 date = "nil" / <natural number>
21967 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
21968 "r" / "regex" / "R" / "Regex" /
21969 "e" / "exact" / "E" / "Exact" /
21970 "f" / "fuzzy" / "F" / "Fuzzy"
21971 number-match = "(" <integer> [ "" / [ space score [ "" /
21972 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
21973 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
21974 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
21975 space date [ "" / [ space date-match-t ] ] ] ] ")"
21976 date-match-t = "nil" / "at" / "before" / "after"
21977 atom = "(" [ required-atom / optional-atom ] ")"
21978 required-atom = mark / expunge / mark-and-expunge / files /
21979 exclude-files / read-only / touched
21980 optional-atom = adapt / local / eval
21981 mark = "mark" space nil-or-number
21982 nil-or-number = "nil" / <integer>
21983 expunge = "expunge" space nil-or-number
21984 mark-and-expunge = "mark-and-expunge" space nil-or-number
21985 files = "files" *[ space <string> ]
21986 exclude-files = "exclude-files" *[ space <string> ]
21987 read-only = "read-only" [ space "nil" / space "t" ]
21988 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
21989 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
21990 local = "local" *[ space "(" <string> space <form> ")" ]
21991 eval = "eval" space <form>
21992 space = *[ " " / <TAB> / <NEWLINE> ]
21995 Any unrecognized elements in a score file should be ignored, but not
21998 As you can see, white space is needed, but the type and amount of white
21999 space is irrelevant. This means that formatting of the score file is
22000 left up to the programmer---if it's simpler to just spew it all out on
22001 one looong line, then that's ok.
22003 The meaning of the various atoms are explained elsewhere in this
22004 manual (@pxref{Score File Format}).
22008 @subsection Headers
22010 Internally Gnus uses a format for storing article headers that
22011 corresponds to the @sc{nov} format in a mysterious fashion. One could
22012 almost suspect that the author looked at the @sc{nov} specification and
22013 just shamelessly @emph{stole} the entire thing, and one would be right.
22015 @dfn{Header} is a severely overloaded term. ``Header'' is used in
22016 RFC 1036 to talk about lines in the head of an article (e.g.,
22017 @code{From}). It is used by many people as a synonym for
22018 ``head''---``the header and the body''. (That should be avoided, in my
22019 opinion.) And Gnus uses a format internally that it calls ``header'',
22020 which is what I'm talking about here. This is a 9-element vector,
22021 basically, with each header (ouch) having one slot.
22023 These slots are, in order: @code{number}, @code{subject}, @code{from},
22024 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
22025 @code{xref}, and @code{extra}. There are macros for accessing and
22026 setting these slots---they all have predictable names beginning with
22027 @code{mail-header-} and @code{mail-header-set-}, respectively.
22029 All these slots contain strings, except the @code{extra} slot, which
22030 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
22036 @sc{gnus} introduced a concept that I found so useful that I've started
22037 using it a lot and have elaborated on it greatly.
22039 The question is simple: If you have a large amount of objects that are
22040 identified by numbers (say, articles, to take a @emph{wild} example)
22041 that you want to qualify as being ``included'', a normal sequence isn't
22042 very useful. (A 200,000 length sequence is a bit long-winded.)
22044 The solution is as simple as the question: You just collapse the
22048 (1 2 3 4 5 6 10 11 12)
22051 is transformed into
22054 ((1 . 6) (10 . 12))
22057 To avoid having those nasty @samp{(13 . 13)} elements to denote a
22058 lonesome object, a @samp{13} is a valid element:
22061 ((1 . 6) 7 (10 . 12))
22064 This means that comparing two ranges to find out whether they are equal
22065 is slightly tricky:
22068 ((1 . 5) 7 8 (10 . 12))
22074 ((1 . 5) (7 . 8) (10 . 12))
22077 are equal. In fact, any non-descending list is a range:
22083 is a perfectly valid range, although a pretty long-winded one. This is
22090 and is equal to the previous range.
22092 Here's a BNF definition of ranges. Of course, one must remember the
22093 semantic requirement that the numbers are non-descending. (Any number
22094 of repetition of the same number is allowed, but apt to disappear in
22098 range = simple-range / normal-range
22099 simple-range = "(" number " . " number ")"
22100 normal-range = "(" start-contents ")"
22101 contents = "" / simple-range *[ " " contents ] /
22102 number *[ " " contents ]
22105 Gnus currently uses ranges to keep track of read articles and article
22106 marks. I plan on implementing a number of range operators in C if The
22107 Powers That Be are willing to let me. (I haven't asked yet, because I
22108 need to do some more thinking on what operators I need to make life
22109 totally range-based without ever having to convert back to normal
22114 @subsection Group Info
22116 Gnus stores all permanent info on groups in a @dfn{group info} list.
22117 This list is from three to six elements (or more) long and exhaustively
22118 describes the group.
22120 Here are two example group infos; one is a very simple group while the
22121 second is a more complex one:
22124 ("no.group" 5 ((1 . 54324)))
22126 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
22127 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
22129 ((auto-expire . t) (to-address . "ding@@gnus.org")))
22132 The first element is the @dfn{group name}---as Gnus knows the group,
22133 anyway. The second element is the @dfn{subscription level}, which
22134 normally is a small integer. (It can also be the @dfn{rank}, which is a
22135 cons cell where the @code{car} is the level and the @code{cdr} is the
22136 score.) The third element is a list of ranges of read articles. The
22137 fourth element is a list of lists of article marks of various kinds.
22138 The fifth element is the select method (or virtual server, if you like).
22139 The sixth element is a list of @dfn{group parameters}, which is what
22140 this section is about.
22142 Any of the last three elements may be missing if they are not required.
22143 In fact, the vast majority of groups will normally only have the first
22144 three elements, which saves quite a lot of cons cells.
22146 Here's a BNF definition of the group info format:
22149 info = "(" group space ralevel space read
22150 [ "" / [ space marks-list [ "" / [ space method [ "" /
22151 space parameters ] ] ] ] ] ")"
22152 group = quote <string> quote
22153 ralevel = rank / level
22154 level = <integer in the range of 1 to inf>
22155 rank = "(" level "." score ")"
22156 score = <integer in the range of 1 to inf>
22158 marks-lists = nil / "(" *marks ")"
22159 marks = "(" <string> range ")"
22160 method = "(" <string> *elisp-forms ")"
22161 parameters = "(" *elisp-forms ")"
22164 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
22165 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
22168 If you have a Gnus info and want to access the elements, Gnus offers a
22169 series of macros for getting/setting these elements.
22172 @item gnus-info-group
22173 @itemx gnus-info-set-group
22174 @findex gnus-info-group
22175 @findex gnus-info-set-group
22176 Get/set the group name.
22178 @item gnus-info-rank
22179 @itemx gnus-info-set-rank
22180 @findex gnus-info-rank
22181 @findex gnus-info-set-rank
22182 Get/set the group rank (@pxref{Group Score}).
22184 @item gnus-info-level
22185 @itemx gnus-info-set-level
22186 @findex gnus-info-level
22187 @findex gnus-info-set-level
22188 Get/set the group level.
22190 @item gnus-info-score
22191 @itemx gnus-info-set-score
22192 @findex gnus-info-score
22193 @findex gnus-info-set-score
22194 Get/set the group score (@pxref{Group Score}).
22196 @item gnus-info-read
22197 @itemx gnus-info-set-read
22198 @findex gnus-info-read
22199 @findex gnus-info-set-read
22200 Get/set the ranges of read articles.
22202 @item gnus-info-marks
22203 @itemx gnus-info-set-marks
22204 @findex gnus-info-marks
22205 @findex gnus-info-set-marks
22206 Get/set the lists of ranges of marked articles.
22208 @item gnus-info-method
22209 @itemx gnus-info-set-method
22210 @findex gnus-info-method
22211 @findex gnus-info-set-method
22212 Get/set the group select method.
22214 @item gnus-info-params
22215 @itemx gnus-info-set-params
22216 @findex gnus-info-params
22217 @findex gnus-info-set-params
22218 Get/set the group parameters.
22221 All the getter functions take one parameter---the info list. The setter
22222 functions take two parameters---the info list and the new value.
22224 The last three elements in the group info aren't mandatory, so it may be
22225 necessary to extend the group info before setting the element. If this
22226 is necessary, you can just pass on a non-@code{nil} third parameter to
22227 the three final setter functions to have this happen automatically.
22230 @node Extended Interactive
22231 @subsection Extended Interactive
22232 @cindex interactive
22233 @findex gnus-interactive
22235 Gnus extends the standard Emacs @code{interactive} specification
22236 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
22237 Prefixes}). Here's an example of how this is used:
22240 (defun gnus-summary-increase-score (&optional score symp)
22241 (interactive (gnus-interactive "P\ny"))
22246 The best thing to do would have been to implement
22247 @code{gnus-interactive} as a macro which would have returned an
22248 @code{interactive} form, but this isn't possible since Emacs checks
22249 whether a function is interactive or not by simply doing an @code{assq}
22250 on the lambda form. So, instead we have @code{gnus-interactive}
22251 function that takes a string and returns values that are usable to
22252 @code{interactive}.
22254 This function accepts (almost) all normal @code{interactive} specs, but
22259 @vindex gnus-current-prefix-symbol
22260 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
22264 @vindex gnus-current-prefix-symbols
22265 A list of the current symbolic prefixes---the
22266 @code{gnus-current-prefix-symbol} variable.
22269 The current article number---the @code{gnus-summary-article-number}
22273 The current article header---the @code{gnus-summary-article-header}
22277 The current group name---the @code{gnus-group-group-name}
22283 @node Emacs/XEmacs Code
22284 @subsection Emacs/XEmacs Code
22288 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
22289 platforms must be the primary one. I chose Emacs. Not because I don't
22290 like XEmacs or Mule, but because it comes first alphabetically.
22292 This means that Gnus will byte-compile under Emacs with nary a warning,
22293 while XEmacs will pump out gigabytes of warnings while byte-compiling.
22294 As I use byte-compilation warnings to help me root out trivial errors in
22295 Gnus, that's very useful.
22297 I've also consistently used Emacs function interfaces, but have used
22298 Gnusey aliases for the functions. To take an example: Emacs defines a
22299 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
22300 function. I then define a function called @code{gnus-run-at-time} that
22301 takes the same parameters as the Emacs @code{run-at-time}. When running
22302 Gnus under Emacs, the former function is just an alias for the latter.
22303 However, when running under XEmacs, the former is an alias for the
22304 following function:
22307 (defun gnus-xmas-run-at-time (time repeat function &rest args)
22311 (,function ,@@args))
22315 This sort of thing has been done for bunches of functions. Gnus does
22316 not redefine any native Emacs functions while running under XEmacs---it
22317 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
22320 In the cases where the XEmacs function interface was obviously cleaner,
22321 I used it instead. For example @code{gnus-region-active-p} is an alias
22322 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
22324 Of course, I could have chosen XEmacs as my native platform and done
22325 mapping functions the other way around. But I didn't. The performance
22326 hit these indirections impose on Gnus under XEmacs should be slight.
22329 @node Various File Formats
22330 @subsection Various File Formats
22333 * Active File Format:: Information on articles and groups available.
22334 * Newsgroups File Format:: Group descriptions.
22338 @node Active File Format
22339 @subsubsection Active File Format
22341 The active file lists all groups available on the server in
22342 question. It also lists the highest and lowest current article numbers
22345 Here's an excerpt from a typical active file:
22348 soc.motss 296030 293865 y
22349 alt.binaries.pictures.fractals 3922 3913 n
22350 comp.sources.unix 1605 1593 m
22351 comp.binaries.ibm.pc 5097 5089 y
22352 no.general 1000 900 y
22355 Here's a pseudo-BNF definition of this file:
22358 active = *group-line
22359 group-line = group spc high-number spc low-number spc flag <NEWLINE>
22360 group = <non-white-space string>
22362 high-number = <non-negative integer>
22363 low-number = <positive integer>
22364 flag = "y" / "n" / "m" / "j" / "x" / "=" group
22367 For a full description of this file, see the manual pages for
22368 @samp{innd}, in particular @samp{active(5)}.
22371 @node Newsgroups File Format
22372 @subsubsection Newsgroups File Format
22374 The newsgroups file lists groups along with their descriptions. Not all
22375 groups on the server have to be listed, and not all groups in the file
22376 have to exist on the server. The file is meant purely as information to
22379 The format is quite simple; a group name, a tab, and the description.
22380 Here's the definition:
22384 line = group tab description <NEWLINE>
22385 group = <non-white-space string>
22387 description = <string>
22392 @node Emacs for Heathens
22393 @section Emacs for Heathens
22395 Believe it or not, but some people who use Gnus haven't really used
22396 Emacs much before they embarked on their journey on the Gnus Love Boat.
22397 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
22398 region'', and ``set @code{gnus-flargblossen} to an alist where the key
22399 is a regexp that is used for matching on the group name'' are magical
22400 phrases with little or no meaning, then this appendix is for you. If
22401 you are already familiar with Emacs, just ignore this and go fondle your
22405 * Keystrokes:: Entering text and executing commands.
22406 * Emacs Lisp:: The built-in Emacs programming language.
22411 @subsection Keystrokes
22415 Q: What is an experienced Emacs user?
22418 A: A person who wishes that the terminal had pedals.
22421 Yes, when you use Emacs, you are apt to use the control key, the shift
22422 key and the meta key a lot. This is very annoying to some people
22423 (notably @code{vi}le users), and the rest of us just love the hell out
22424 of it. Just give up and submit. Emacs really does stand for
22425 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
22426 may have heard from other disreputable sources (like the Emacs author).
22428 The shift keys are normally located near your pinky fingers, and are
22429 normally used to get capital letters and stuff. You probably use it all
22430 the time. The control key is normally marked ``CTRL'' or something like
22431 that. The meta key is, funnily enough, never marked as such on any
22432 keyboard. The one I'm currently at has a key that's marked ``Alt'',
22433 which is the meta key on this keyboard. It's usually located somewhere
22434 to the left hand side of the keyboard, usually on the bottom row.
22436 Now, us Emacs people don't say ``press the meta-control-m key'',
22437 because that's just too inconvenient. We say ``press the @kbd{M-C-m}
22438 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
22439 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
22440 down the control key, and hold it down while you press @kbd{k}''.
22441 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
22442 the control key and then press @kbd{k}''. Simple, ay?
22444 This is somewhat complicated by the fact that not all keyboards have a
22445 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
22446 means ``press escape, release escape, press @kbd{k}''. That's much more
22447 work than if you have a meta key, so if that's the case, I respectfully
22448 suggest you get a real keyboard with a meta key. You can't live without
22454 @subsection Emacs Lisp
22456 Emacs is the King of Editors because it's really a Lisp interpreter.
22457 Each and every key you tap runs some Emacs Lisp code snippet, and since
22458 Emacs Lisp is an interpreted language, that means that you can configure
22459 any key to run any arbitrary code. You just, like, do it.
22461 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
22462 functions. (These are byte-compiled for speed, but it's still
22463 interpreted.) If you decide that you don't like the way Gnus does
22464 certain things, it's trivial to have it do something a different way.
22465 (Well, at least if you know how to write Lisp code.) However, that's
22466 beyond the scope of this manual, so we are simply going to talk about
22467 some common constructs that you normally use in your @file{.emacs} file
22470 If you want to set the variable @code{gnus-florgbnize} to four (4), you
22471 write the following:
22474 (setq gnus-florgbnize 4)
22477 This function (really ``special form'') @code{setq} is the one that can
22478 set a variable to some value. This is really all you need to know. Now
22479 you can go and fill your @code{.emacs} file with lots of these to change
22482 If you have put that thing in your @code{.emacs} file, it will be read
22483 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
22484 start Emacs. If you want to change the variable right away, simply say
22485 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
22486 previous ``form'', which is a simple @code{setq} statement here.
22488 Go ahead---just try it, if you're located at your Emacs. After you
22489 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
22490 is the return value of the form you @code{eval}ed.
22494 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
22498 (setq gnus-read-active-file 'some)
22501 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
22502 @samp{nntp.ifi.uio.no}'', that means:
22505 (setq gnus-nntp-server "nntp.ifi.uio.no")
22508 So be careful not to mix up strings (the latter) with symbols (the
22509 former). The manual is unambiguous, but it can be confusing.
22512 @include gnus-faq.texi
22533 % LocalWords: Backend BNF mucho Backends backends detailmenu cindex kindex kbd
22534 % LocalWords: findex Gnusae vindex dfn dfn samp nntp setq nnspool nntpserver
22535 % LocalWords: nnmbox backend newusers Blllrph NEWGROUPS dingnusdingnusdingnus
22536 % LocalWords: pre fab rec comp nnslashdot regex ga ga sci nnml nnbabyl nnmh
22537 % LocalWords: nnfolder emph looong eld newsreaders defun init elc pxref