1 \input texinfo @c -*-texinfo-*- -*- coding: iso-latin-1 -*-
10 * Gnus: (gnus). The newsreader Gnus.
15 @setchapternewpage odd
19 \documentclass[twoside,a4paper,openright,11pt]{book}
20 \usepackage[latin1]{inputenc}
21 \usepackage{pagestyle}
29 \newcommand{\gnuschaptername}{}
30 \newcommand{\gnussectionname}{}
32 \newcommand{\gnusbackslash}{/}
34 \newcommand{\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.
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 This manual corresponds to Oort Gnus v.
381 Gnus is the advanced, self-documenting, customizable, extensible
382 unreal-time newsreader for GNU Emacs.
384 Oops. That sounds oddly familiar, so let's start over again to avoid
385 being accused of plagiarism:
387 Gnus is a message-reading laboratory. It will let you look at just
388 about anything as if it were a newsgroup. You can read mail with it,
389 you can browse directories with it, you can @code{ftp} with it---you
390 can even read news with it!
392 Gnus tries to empower people who read news the same way Emacs empowers
393 people who edit text. Gnus sets no limits to what the user should be
394 allowed to do. Users are encouraged to extend Gnus to make it behave
395 like they want it to behave. A program should not control people;
396 people should be empowered to do what they want by using (or abusing)
402 * Starting Up:: Finding news can be a pain.
403 * Group Buffer:: Selecting, subscribing and killing groups.
404 * Summary Buffer:: Reading, saving and posting articles.
405 * Article Buffer:: Displaying and handling articles.
406 * Composing Messages:: Information on sending mail and news.
407 * Select Methods:: Gnus reads all messages from various select methods.
408 * Scoring:: Assigning values to articles.
409 * Various:: General purpose settings.
410 * The End:: Farewell and goodbye.
411 * Appendices:: Terminology, Emacs intro, FAQ, History, Internals.
412 * Index:: Variable, function and concept index.
413 * Key Index:: Key Index.
416 --- The Detailed Node Listing ---
420 * Finding the News:: Choosing a method for getting news.
421 * The First Time:: What does Gnus do the first time you start it?
422 * The Server is Down:: How can I read my mail then?
423 * Slave Gnusae:: You can have more than one Gnus active at a time.
424 * Fetching a Group:: Starting Gnus just to read a group.
425 * New Groups:: What is Gnus supposed to do with new groups?
426 * Changing Servers:: You may want to move from one server to another.
427 * Startup Files:: Those pesky startup files---@file{.newsrc}.
428 * Auto Save:: Recovering from a crash.
429 * The Active File:: Reading the active file over a slow line Takes Time.
430 * Startup Variables:: Other variables you might change.
434 * Checking New Groups:: Determining what groups are new.
435 * Subscription Methods:: What Gnus should do with new groups.
436 * Filtering New Groups:: Making Gnus ignore certain new groups.
440 * Group Buffer Format:: Information listed and how you can change it.
441 * Group Maneuvering:: Commands for moving in the group buffer.
442 * Selecting a Group:: Actually reading news.
443 * Subscription Commands:: Unsubscribing, killing, subscribing.
444 * Group Data:: Changing the info for a group.
445 * Group Levels:: Levels? What are those, then?
446 * Group Score:: A mechanism for finding out what groups you like.
447 * Marking Groups:: You can mark groups for later processing.
448 * Foreign Groups:: Creating and editing groups.
449 * Group Parameters:: Each group may have different parameters set.
450 * Listing Groups:: Gnus can list various subsets of the groups.
451 * Sorting Groups:: Re-arrange the group order.
452 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
453 * Browse Foreign Server:: You can browse a server. See what it has to offer.
454 * Exiting Gnus:: Stop reading news and get some work done.
455 * Group Topics:: A folding group mode divided into topics.
456 * Misc Group Stuff:: Other stuff that you can to do.
460 * Group Line Specification:: Deciding how the group buffer is to look.
461 * Group Modeline Specification:: The group buffer modeline.
462 * Group Highlighting:: Having nice colors in the group buffer.
466 * Topic Variables:: How to customize the topics the Lisp Way.
467 * Topic Commands:: Interactive E-Z commands.
468 * Topic Sorting:: Sorting each topic individually.
469 * Topic Topology:: A map of the world.
470 * Topic Parameters:: Parameters that apply to all groups in a topic.
474 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
475 * Group Information:: Information and help on groups and Gnus.
476 * Group Timestamp:: Making Gnus keep track of when you last read a group.
477 * File Commands:: Reading and writing the Gnus files.
481 * Summary Buffer Format:: Deciding how the summary buffer is to look.
482 * Summary Maneuvering:: Moving around the summary buffer.
483 * Choosing Articles:: Reading articles.
484 * Paging the Article:: Scrolling the current article.
485 * Reply Followup and Post:: Posting articles.
487 * Marking Articles:: Marking articles as read, expirable, etc.
488 * Limiting:: You can limit the summary buffer.
489 * Threading:: How threads are made.
490 * Sorting the Summary Buffer:: How articles and threads are sorted.
491 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
492 * Article Caching:: You may store articles in a cache.
493 * Persistent Articles:: Making articles expiry-resistant.
494 * Article Backlog:: Having already read articles hang around.
495 * Saving Articles:: Ways of customizing article saving.
496 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
497 * Article Treatment:: The article buffer can be mangled at will.
498 * MIME Commands:: Doing MIMEy things with the articles.
499 * Charsets:: Character set issues.
500 * Article Commands:: Doing various things with the article buffer.
501 * Summary Sorting:: Sorting the summary buffer in various ways.
502 * Finding the Parent:: No child support? Get the parent.
503 * Alternative Approaches:: Reading using non-default summaries.
504 * Tree Display:: A more visual display of threads.
505 * Mail Group Commands:: Some commands can only be used in mail groups.
506 * Various Summary Stuff:: What didn't fit anywhere else.
507 * Exiting the Summary Buffer:: Returning to the Group buffer,
508 or reselecting the current group.
509 * Crosspost Handling:: How crossposted articles are dealt with.
510 * Duplicate Suppression:: An alternative when crosspost handling fails.
511 * Security:: Decrypt and Verify.
512 * Mailing List:: Mailing list minor mode.
514 Summary Buffer Format
516 * Summary Buffer Lines:: You can specify how summary lines should look.
517 * To From Newsgroups:: How to not display your own name.
518 * Summary Buffer Mode Line:: You can say how the mode line should look.
519 * Summary Highlighting:: Making the summary buffer all pretty and nice.
523 * Choosing Commands:: Commands for choosing articles.
524 * Choosing Variables:: Variables that influence these commands.
526 Reply, Followup and Post
528 * Summary Mail Commands:: Sending mail.
529 * Summary Post Commands:: Sending news.
530 * Summary Message Commands:: Other Message-related commands.
531 * Canceling and Superseding::
535 * Unread Articles:: Marks for unread articles.
536 * Read Articles:: Marks for read articles.
537 * Other Marks:: Marks that do not affect readedness.
539 * Generic Marking Commands::
540 * Setting Process Marks::
544 * Setting Marks:: How to set and remove marks.
545 * Generic Marking Commands:: How to customize the marking.
546 * Setting Process Marks:: How to mark articles for later processing.
550 * Customizing Threading:: Variables you can change to affect the threading.
551 * Thread Commands:: Thread based commands in the summary buffer.
553 Customizing Threading
555 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
556 * Filling In Threads:: Making the threads displayed look fuller.
557 * More Threading:: Even more variables for fiddling with threads.
558 * Low-Level Threading:: You thought it was over... but you were wrong!
562 * Uuencoded Articles:: Uudecode articles.
563 * Shell Archives:: Unshar articles.
564 * PostScript Files:: Split PostScript.
565 * Other Files:: Plain save and binhex.
566 * Decoding Variables:: Variables for a happy decoding.
567 * Viewing Files:: You want to look at the result of the decoding?
571 * Rule Variables:: Variables that say how a file is to be viewed.
572 * Other Decode Variables:: Other decode variables.
573 * Uuencoding and Posting:: Variables for customizing uuencoding.
577 * Article Highlighting:: You want to make the article look like fruit salad.
578 * Article Fontisizing:: Making emphasized text look nice.
579 * Article Hiding:: You also want to make certain info go away.
580 * Article Washing:: Lots of way-neat functions to make life better.
581 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
582 * Article Date:: Grumble, UT!
583 * Article Signature:: What is a signature?
584 * Article Miscellania:: Various other stuff.
586 Alternative Approaches
588 * Pick and Read:: First mark articles and then read them.
589 * Binary Groups:: Auto-decode all articles.
591 Various Summary Stuff
593 * Summary Group Information:: Information oriented commands.
594 * Searching for Articles:: Multiple article commands.
595 * Summary Generation Commands::
596 * Really Various Summary Commands:: Those pesky non-conformant commands.
600 * Hiding Headers:: Deciding what headers should be displayed.
601 * Using MIME:: Pushing articles through @sc{mime} before reading them.
602 * Customizing Articles:: Tailoring the look of the articles.
603 * Article Keymap:: Keystrokes available in the article buffer.
604 * Misc Article:: Other stuff.
608 * Mail:: Mailing and replying.
609 * Posting Server:: What server should you post via?
610 * Mail and Post:: Mailing and posting at the same time.
611 * Archived Messages:: Where Gnus stores the messages you've sent.
612 * Posting Styles:: An easier way to specify who you are.
613 * Drafts:: Postponing messages and rejected messages.
614 * Rejected Articles:: What happens if the server doesn't like your article?
615 * Using GPG:: How to use GPG and MML to sign and encrypt messages
619 * Server Buffer:: Making and editing virtual servers.
620 * Getting News:: Reading USENET news with Gnus.
621 * Getting Mail:: Reading your personal mail with Gnus.
622 * Browsing the Web:: Getting messages from a plethora of Web sources.
623 * Other Sources:: Reading directories, files, SOUP packets.
624 * Combined Groups:: Combining groups into one group.
625 * Gnus Unplugged:: Reading news and mail offline.
629 * Server Buffer Format:: You can customize the look of this buffer.
630 * Server Commands:: Commands to manipulate servers.
631 * Example Methods:: Examples server specifications.
632 * Creating a Virtual Server:: An example session.
633 * Server Variables:: Which variables to set.
634 * Servers and Methods:: You can use server names as select methods.
635 * Unavailable Servers:: Some servers you try to contact may be down.
639 * NNTP:: Reading news from an @sc{nntp} server.
640 * News Spool:: Reading news from the local spool.
644 * Direct Functions:: Connecting directly to the server.
645 * Indirect Functions:: Connecting indirectly to the server.
646 * Common Variables:: Understood by several connection functions.
650 * Mail in a Newsreader:: Important introductory notes.
651 * Getting Started Reading Mail:: A simple cookbook example.
652 * Splitting Mail:: How to create mail groups.
653 * Mail Sources:: How to tell Gnus where to get mail from.
654 * Mail Backend Variables:: Variables for customizing mail handling.
655 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
656 * Group Mail Splitting:: Use group customize to drive mail splitting.
657 * Incorporating Old Mail:: What about the old mail you have?
658 * Expiring Mail:: Getting rid of unwanted mail.
659 * Washing Mail:: Removing gruft from the mail you get.
660 * Duplicates:: Dealing with duplicated mail.
661 * Not Reading Mail:: Using mail backends for reading other files.
662 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
666 * Mail Source Specifiers:: How to specify what a mail source is.
667 * Mail Source Customization:: Some variables that influence things.
668 * Fetching Mail:: Using the mail source specifiers.
670 Choosing a Mail Backend
672 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
673 * Rmail Babyl:: Emacs programs use the rmail babyl format.
674 * Mail Spool:: Store your mail in a private spool?
675 * MH Spool:: An mhspool-like backend.
676 * Mail Folders:: Having one file for each group.
677 * Comparing Mail Backends:: An in-depth looks at pros and cons.
681 * Web Searches:: Creating groups from articles that match a string.
682 * Slashdot:: Reading the Slashdot comments.
683 * Ultimate:: The Ultimate Bulletin Board systems.
684 * Web Archive:: Reading mailing list archived on web.
685 * RSS:: Reading RDF site summary.
686 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
690 * Directory Groups:: You can read a directory as if it was a newsgroup.
691 * Anything Groups:: Dired? Who needs dired?
692 * Document Groups:: Single files can be the basis of a group.
693 * SOUP:: Reading @sc{soup} packets ``offline''.
694 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
695 * IMAP:: Using Gnus as a @sc{imap} client.
699 * Document Server Internals:: How to add your own document types.
703 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
704 * SOUP Groups:: A backend for reading @sc{soup} packets.
705 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
709 * Splitting in IMAP:: Splitting mail with nnimap.
710 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
711 * Expunging mailboxes:: Equivalent of a "compress mailbox" button.
715 * Virtual Groups:: Combining articles from many groups.
716 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
720 * Agent Basics:: How it all is supposed to work.
721 * Agent Categories:: How to tell the Gnus Agent what to download.
722 * Agent Commands:: New commands for all the buffers.
723 * Agent Expiry:: How to make old articles go away.
724 * Agent and IMAP:: How to use the Agent with IMAP.
725 * Outgoing Messages:: What happens when you post/mail something?
726 * Agent Variables:: Customizing is fun.
727 * Example Setup:: An example @file{.gnus.el} file for offline people.
728 * Batching Agents:: How to fetch news from a @code{cron} job.
729 * Agent Caveats:: What you think it'll do and what it does.
733 * Category Syntax:: What a category looks like.
734 * Category Buffer:: A buffer for maintaining categories.
735 * Category Variables:: Customize'r'Us.
739 * Group Agent Commands::
740 * Summary Agent Commands::
741 * Server Agent Commands::
745 * Summary Score Commands:: Adding score entries for the current group.
746 * Group Score Commands:: General score commands.
747 * Score Variables:: Customize your scoring. (My, what terminology).
748 * Score File Format:: What a score file may contain.
749 * Score File Editing:: You can edit score files by hand as well.
750 * Adaptive Scoring:: Big Sister Gnus knows what you read.
751 * Home Score File:: How to say where new score entries are to go.
752 * Followups To Yourself:: Having Gnus notice when people answer you.
753 * Scoring On Other Headers:: Scoring on non-standard headers.
754 * Scoring Tips:: How to score effectively.
755 * Reverse Scoring:: That problem child of old is not problem.
756 * Global Score Files:: Earth-spanning, ear-splitting score files.
757 * Kill Files:: They are still here, but they can be ignored.
758 * Converting Kill Files:: Translating kill files to score files.
759 * GroupLens:: Getting predictions on what you like to read.
760 * Advanced Scoring:: Using logical expressions to build score rules.
761 * Score Decays:: It can be useful to let scores wither away.
765 * Using GroupLens:: How to make Gnus use GroupLens.
766 * Rating Articles:: Letting GroupLens know how you rate articles.
767 * Displaying Predictions:: Displaying predictions given by GroupLens.
768 * GroupLens Variables:: Customizing GroupLens.
772 * Advanced Scoring Syntax:: A definition.
773 * Advanced Scoring Examples:: What they look like.
774 * Advanced Scoring Tips:: Getting the most out of it.
778 * Process/Prefix:: A convention used by many treatment commands.
779 * Interactive:: Making Gnus ask you many questions.
780 * Symbolic Prefixes:: How to supply some Gnus functions with options.
781 * Formatting Variables:: You can specify what buffers should look like.
782 * Window Layout:: Configuring the Gnus buffer windows.
783 * Faces and Fonts:: How to change how faces look.
784 * Compilation:: How to speed Gnus up.
785 * Mode Lines:: Displaying information in the mode lines.
786 * Highlighting and Menus:: Making buffers look all nice and cozy.
787 * Buttons:: Get tendinitis in ten easy steps!
788 * Daemons:: Gnus can do things behind your back.
789 * NoCeM:: How to avoid spam and other fatty foods.
790 * Undo:: Some actions can be undone.
791 * Moderation:: What to do if you're a moderator.
792 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
793 * Fuzzy Matching:: What's the big fuzz?
794 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
795 * Various Various:: Things that are really various.
799 * Formatting Basics:: A formatting variable is basically a format string.
800 * Mode Line Formatting:: Some rules about mode line formatting variables.
801 * Advanced Formatting:: Modifying output in various ways.
802 * User-Defined Specs:: Having Gnus call your own functions.
803 * Formatting Fonts:: Making the formatting look colorful and nice.
804 * Positioning Point:: Moving point to a position after an operation.
805 * Tabulation:: Tabulating your output.
806 * Wide Characters:: Dealing with wide characters.
810 * Picons:: How to display pictures of what your reading.
811 * Smileys:: Show all those happy faces the way they were meant to be shown.
812 * Toolbar:: Click'n'drool.
813 * XVarious:: Other XEmacsy Gnusey variables.
817 * Picon Basics:: What are picons and How do I get them.
818 * Picon Requirements:: Don't go further if you aren't using XEmacs.
819 * Easy Picons:: Displaying Picons---the easy way.
820 * Hard Picons:: The way you should do it. You'll learn something.
821 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
825 * History:: How Gnus got where it is today.
826 * On Writing Manuals:: Why this is not a beginner's guide.
827 * Terminology:: We use really difficult, like, words here.
828 * Customization:: Tailoring Gnus to your needs.
829 * Troubleshooting:: What you might try if things do not work.
830 * Gnus Reference Guide:: Rilly, rilly technical stuff.
831 * Emacs for Heathens:: A short introduction to Emacsian terms.
835 * Gnus Versions:: What Gnus versions have been released.
836 * Other Gnus Versions:: Other Gnus versions that also have been released.
837 * Why?:: What's the point of Gnus?
838 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
839 * Conformity:: Gnus tries to conform to all standards.
840 * Emacsen:: Gnus can be run on a few modern Emacsen.
841 * Gnus Development:: How Gnus is developed.
842 * Contributors:: Oodles of people.
843 * New Features:: Pointers to some of the new stuff in Gnus.
847 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
848 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
849 * Red Gnus:: Third time best---Gnus 5.4/5.5.
850 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
851 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
855 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
856 * Slow Terminal Connection:: You run a remote Emacs.
857 * Little Disk Space:: You feel that having large setup files is icky.
858 * Slow Machine:: You feel like buying a faster machine.
862 * Gnus Utility Functions:: Common functions and variable to use.
863 * Backend Interface:: How Gnus communicates with the servers.
864 * Score File Syntax:: A BNF definition of the score file standard.
865 * Headers:: How Gnus stores headers internally.
866 * Ranges:: A handy format for storing mucho numbers.
867 * Group Info:: The group info format.
868 * Extended Interactive:: Symbolic prefixes and stuff.
869 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
870 * Various File Formats:: Formats of files that Gnus use.
874 * Required Backend Functions:: Functions that must be implemented.
875 * Optional Backend Functions:: Functions that need not be implemented.
876 * Error Messaging:: How to get messages and report errors.
877 * Writing New Backends:: Extending old backends.
878 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
879 * Mail-like Backends:: Some tips on mail backends.
883 * Active File Format:: Information on articles and groups available.
884 * Newsgroups File Format:: Group descriptions.
888 * Keystrokes:: Entering text and executing commands.
889 * Emacs Lisp:: The built-in Emacs programming language.
895 @chapter Starting Gnus
900 If your system administrator has set things up properly, starting Gnus
901 and reading news is extremely easy---you just type @kbd{M-x gnus} in
904 @findex gnus-other-frame
905 @kindex M-x gnus-other-frame
906 If you want to start Gnus in a different frame, you can use the command
907 @kbd{M-x gnus-other-frame} instead.
909 If things do not go smoothly at startup, you have to twiddle some
910 variables in your @file{~/.gnus} file. This file is similar to
911 @file{~/.emacs}, but is read when gnus starts.
913 If you puzzle at any terms used in this manual, please refer to the
914 terminology section (@pxref{Terminology}).
917 * Finding the News:: Choosing a method for getting news.
918 * The First Time:: What does Gnus do the first time you start it?
919 * The Server is Down:: How can I read my mail then?
920 * Slave Gnusae:: You can have more than one Gnus active at a time.
921 * Fetching a Group:: Starting Gnus just to read a group.
922 * New Groups:: What is Gnus supposed to do with new groups?
923 * Changing Servers:: You may want to move from one server to another.
924 * Startup Files:: Those pesky startup files---@file{.newsrc}.
925 * Auto Save:: Recovering from a crash.
926 * The Active File:: Reading the active file over a slow line Takes Time.
927 * Startup Variables:: Other variables you might change.
931 @node Finding the News
932 @section Finding the News
935 @vindex gnus-select-method
937 The @code{gnus-select-method} variable says where Gnus should look for
938 news. This variable should be a list where the first element says
939 @dfn{how} and the second element says @dfn{where}. This method is your
940 native method. All groups not fetched with this method are
943 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
944 you want to get your daily dosage of news from, you'd say:
947 (setq gnus-select-method '(nntp "news.somewhere.edu"))
950 If you want to read directly from the local spool, say:
953 (setq gnus-select-method '(nnspool ""))
956 If you can use a local spool, you probably should, as it will almost
957 certainly be much faster.
959 @vindex gnus-nntpserver-file
961 @cindex @sc{nntp} server
962 If this variable is not set, Gnus will take a look at the
963 @code{NNTPSERVER} environment variable. If that variable isn't set,
964 Gnus will see whether @code{gnus-nntpserver-file}
965 (@file{/etc/nntpserver} by default) has any opinions on the matter. If
966 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server. That's a long shot, though.
968 @vindex gnus-nntp-server
969 If @code{gnus-nntp-server} is set, this variable will override
970 @code{gnus-select-method}. You should therefore set
971 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
973 @vindex gnus-secondary-servers
974 @vindex gnus-nntp-server
975 You can also make Gnus prompt you interactively for the name of an
976 @sc{nntp} server. If you give a non-numerical prefix to @code{gnus}
977 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
978 in the @code{gnus-secondary-servers} list (if any). You can also just
979 type in the name of any server you feel like visiting. (Note that this
980 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
981 gnus} later in the same Emacs session, Gnus will contact the same
984 @findex gnus-group-browse-foreign-server
986 However, if you use one @sc{nntp} server regularly and are just
987 interested in a couple of groups from a different server, you would be
988 better served by using the @kbd{B} command in the group buffer. It will
989 let you have a look at what groups are available, and you can subscribe
990 to any of the groups you want to. This also makes @file{.newsrc}
991 maintenance much tidier. @xref{Foreign Groups}.
993 @vindex gnus-secondary-select-methods
995 A slightly different approach to foreign groups is to set the
996 @code{gnus-secondary-select-methods} variable. The select methods
997 listed in this variable are in many ways just as native as the
998 @code{gnus-select-method} server. They will also be queried for active
999 files during startup (if that's required), and new newsgroups that
1000 appear on these servers will be subscribed (or not) just as native
1003 For instance, if you use the @code{nnmbox} backend to read your mail, you
1004 would typically set this variable to
1007 (setq gnus-secondary-select-methods '((nnmbox "")))
1011 @node The First Time
1012 @section The First Time
1013 @cindex first time usage
1015 If no startup files exist, Gnus will try to determine what groups should
1016 be subscribed by default.
1018 @vindex gnus-default-subscribed-newsgroups
1019 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
1020 will subscribe you to just those groups in that list, leaving the rest
1021 killed. Your system administrator should have set this variable to
1024 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
1025 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1026 here as @dfn{whatever Lars thinks you should read}.)
1028 You'll also be subscribed to the Gnus documentation group, which should
1029 help you with most common problems.
1031 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
1032 use the normal functions for handling new groups, and not do anything
1036 @node The Server is Down
1037 @section The Server is Down
1038 @cindex server errors
1040 If the default server is down, Gnus will understandably have some
1041 problems starting. However, if you have some mail groups in addition to
1042 the news groups, you may want to start Gnus anyway.
1044 Gnus, being the trusting sort of program, will ask whether to proceed
1045 without a native select method if that server can't be contacted. This
1046 will happen whether the server doesn't actually exist (i.e., you have
1047 given the wrong address) or the server has just momentarily taken ill
1048 for some reason or other. If you decide to continue and have no foreign
1049 groups, you'll find it difficult to actually do anything in the group
1050 buffer. But, hey, that's your problem. Blllrph!
1052 @findex gnus-no-server
1053 @kindex M-x gnus-no-server
1055 If you know that the server is definitely down, or you just want to read
1056 your mail without bothering with the server at all, you can use the
1057 @code{gnus-no-server} command to start Gnus. That might come in handy
1058 if you're in a hurry as well. This command will not attempt to contact
1059 your primary server---instead, it will just activate all groups on level
1060 1 and 2. (You should preferably keep no native groups on those two
1061 levels.) Also @pxref{Group Levels}.
1065 @section Slave Gnusae
1068 You might want to run more than one Emacs with more than one Gnus at the
1069 same time. If you are using different @file{.newsrc} files (e.g., if you
1070 are using the two different Gnusae to read from two different servers),
1071 that is no problem whatsoever. You just do it.
1073 The problem appears when you want to run two Gnusae that use the same
1074 @code{.newsrc} file.
1076 To work around that problem some, we here at the Think-Tank at the Gnus
1077 Towers have come up with a new concept: @dfn{Masters} and
1078 @dfn{slaves}. (We have applied for a patent on this concept, and have
1079 taken out a copyright on those words. If you wish to use those words in
1080 conjunction with each other, you have to send $1 per usage instance to
1081 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1082 Applications}) will be much more expensive, of course.)
1084 Anyway, you start one Gnus up the normal way with @kbd{M-x gnus} (or
1085 however you do it). Each subsequent slave Gnusae should be started with
1086 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1087 files, but instead save @dfn{slave files} that contain information only
1088 on what groups have been read in the slave session. When a master Gnus
1089 starts, it will read (and delete) these slave files, incorporating all
1090 information from them. (The slave files will be read in the sequence
1091 they were created, so the latest changes will have precedence.)
1093 Information from the slave files has, of course, precedence over the
1094 information in the normal (i.e., master) @code{.newsrc} file.
1097 @node Fetching a Group
1098 @section Fetching a Group
1099 @cindex fetching a group
1101 @findex gnus-fetch-group
1102 It is sometimes convenient to be able to just say ``I want to read this
1103 group and I don't care whether Gnus has been started or not''. This is
1104 perhaps more useful for people who write code than for users, but the
1105 command @code{gnus-fetch-group} provides this functionality in any case.
1106 It takes the group name as a parameter.
1112 @cindex subscription
1114 @vindex gnus-check-new-newsgroups
1115 If you are satisfied that you really never want to see any new groups,
1116 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1117 also save you some time at startup. Even if this variable is
1118 @code{nil}, you can always subscribe to the new groups just by pressing
1119 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1120 is @code{ask-server} by default. If you set this variable to
1121 @code{always}, then Gnus will query the backends for new groups even
1122 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1125 * Checking New Groups:: Determining what groups are new.
1126 * Subscription Methods:: What Gnus should do with new groups.
1127 * Filtering New Groups:: Making Gnus ignore certain new groups.
1131 @node Checking New Groups
1132 @subsection Checking New Groups
1134 Gnus normally determines whether a group is new or not by comparing the
1135 list of groups from the active file(s) with the lists of subscribed and
1136 dead groups. This isn't a particularly fast method. If
1137 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
1138 server for new groups since the last time. This is both faster and
1139 cheaper. This also means that you can get rid of the list of killed
1140 groups altogether, so you may set @code{gnus-save-killed-list} to
1141 @code{nil}, which will save time both at startup, at exit, and all over.
1142 Saves disk space, too. Why isn't this the default, then?
1143 Unfortunately, not all servers support this command.
1145 I bet I know what you're thinking now: How do I find out whether my
1146 server supports @code{ask-server}? No? Good, because I don't have a
1147 fail-safe answer. I would suggest just setting this variable to
1148 @code{ask-server} and see whether any new groups appear within the next
1149 few days. If any do, then it works. If none do, then it doesn't
1150 work. I could write a function to make Gnus guess whether the server
1151 supports @code{ask-server}, but it would just be a guess. So I won't.
1152 You could @code{telnet} to the server and say @code{HELP} and see
1153 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1154 it does, then it might work. (But there are servers that lists
1155 @samp{NEWGROUPS} without supporting the function properly.)
1157 This variable can also be a list of select methods. If so, Gnus will
1158 issue an @code{ask-server} command to each of the select methods, and
1159 subscribe them (or not) using the normal methods. This might be handy
1160 if you are monitoring a few servers for new groups. A side effect is
1161 that startup will take much longer, so you can meditate while waiting.
1162 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1165 @node Subscription Methods
1166 @subsection Subscription Methods
1168 @vindex gnus-subscribe-newsgroup-method
1169 What Gnus does when it encounters a new group is determined by the
1170 @code{gnus-subscribe-newsgroup-method} variable.
1172 This variable should contain a function. This function will be called
1173 with the name of the new group as the only parameter.
1175 Some handy pre-fab functions are:
1179 @item gnus-subscribe-zombies
1180 @vindex gnus-subscribe-zombies
1181 Make all new groups zombies. This is the default. You can browse the
1182 zombies later (with @kbd{A z}) and either kill them all off properly
1183 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1185 @item gnus-subscribe-randomly
1186 @vindex gnus-subscribe-randomly
1187 Subscribe all new groups in arbitrary order. This really means that all
1188 new groups will be added at ``the top'' of the group buffer.
1190 @item gnus-subscribe-alphabetically
1191 @vindex gnus-subscribe-alphabetically
1192 Subscribe all new groups in alphabetical order.
1194 @item gnus-subscribe-hierarchically
1195 @vindex gnus-subscribe-hierarchically
1196 Subscribe all new groups hierarchically. The difference between this
1197 function and @code{gnus-subscribe-alphabetically} is slight.
1198 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1199 alphabetical fashion, while this function will enter groups into its
1200 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1201 @samp{comp} hierarchy, this function will not mess that configuration
1202 up. Or something like that.
1204 @item gnus-subscribe-interactively
1205 @vindex gnus-subscribe-interactively
1206 Subscribe new groups interactively. This means that Gnus will ask
1207 you about @strong{all} new groups. The groups you choose to subscribe
1208 to will be subscribed hierarchically.
1210 @item gnus-subscribe-killed
1211 @vindex gnus-subscribe-killed
1212 Kill all new groups.
1214 @item gnus-subscribe-topics
1215 @vindex gnus-subscribe-topics
1216 Put the groups into the topic that has a matching @code{subscribe} topic
1217 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1218 topic parameter that looks like
1224 will mean that all groups that match that regex will be subscribed under
1227 If no topics match the groups, the groups will be subscribed in the
1232 @vindex gnus-subscribe-hierarchical-interactive
1233 A closely related variable is
1234 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1235 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
1236 hierarchical fashion whether to subscribe to new groups or not. Gnus
1237 will ask you for each sub-hierarchy whether you want to descend the
1240 One common mistake is to set the variable a few paragraphs above
1241 (@code{gnus-subscribe-newsgroup-method}) to
1242 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1243 will not work. This is ga-ga. So don't do it.
1246 @node Filtering New Groups
1247 @subsection Filtering New Groups
1249 A nice and portable way to control which new newsgroups should be
1250 subscribed (or ignored) is to put an @dfn{options} line at the start of
1251 the @file{.newsrc} file. Here's an example:
1254 options -n !alt.all !rec.all sci.all
1257 @vindex gnus-subscribe-options-newsgroup-method
1258 This line obviously belongs to a serious-minded intellectual scientific
1259 person (or she may just be plain old boring), because it says that all
1260 groups that have names beginning with @samp{alt} and @samp{rec} should
1261 be ignored, and all groups with names beginning with @samp{sci} should
1262 be subscribed. Gnus will not use the normal subscription method for
1263 subscribing these groups.
1264 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1265 variable defaults to @code{gnus-subscribe-alphabetically}.
1267 @vindex gnus-options-not-subscribe
1268 @vindex gnus-options-subscribe
1269 If you don't want to mess with your @file{.newsrc} file, you can just
1270 set the two variables @code{gnus-options-subscribe} and
1271 @code{gnus-options-not-subscribe}. These two variables do exactly the
1272 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1273 and if the new group matches the former, it will be unconditionally
1274 subscribed, and if it matches the latter, it will be ignored.
1276 @vindex gnus-auto-subscribed-groups
1277 Yet another variable that meddles here is
1278 @code{gnus-auto-subscribed-groups}. It works exactly like
1279 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
1280 thought it would be nice to have two of these. This variable is more
1281 meant for setting some ground rules, while the other variable is used
1282 more for user fiddling. By default this variable makes all new groups
1283 that come from mail backends (@code{nnml}, @code{nnbabyl},
1284 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed. If you
1285 don't like that, just set this variable to @code{nil}.
1287 New groups that match this regexp are subscribed using
1288 @code{gnus-subscribe-options-newsgroup-method}.
1291 @node Changing Servers
1292 @section Changing Servers
1293 @cindex changing servers
1295 Sometimes it is necessary to move from one @sc{nntp} server to another.
1296 This happens very rarely, but perhaps you change jobs, or one server is
1297 very flaky and you want to use another.
1299 Changing the server is pretty easy, right? You just change
1300 @code{gnus-select-method} to point to the new server?
1304 Article numbers are not (in any way) kept synchronized between different
1305 @sc{nntp} servers, and the only way Gnus keeps track of what articles
1306 you have read is by keeping track of article numbers. So when you
1307 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1310 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1311 file from one server to another. They all have one thing in
1312 common---they take a looong time to run. You don't want to use these
1313 functions more than absolutely necessary.
1315 @kindex M-x gnus-change-server
1316 @findex gnus-change-server
1317 If you have access to both servers, Gnus can request the headers for all
1318 the articles you have read and compare @code{Message-ID}s and map the
1319 article numbers of the read articles and article marks. The @kbd{M-x
1320 gnus-change-server} command will do this for all your native groups. It
1321 will prompt for the method you want to move to.
1323 @kindex M-x gnus-group-move-group-to-server
1324 @findex gnus-group-move-group-to-server
1325 You can also move individual groups with the @kbd{M-x
1326 gnus-group-move-group-to-server} command. This is useful if you want to
1327 move a (foreign) group from one server to another.
1329 @kindex M-x gnus-group-clear-data-on-native-groups
1330 @findex gnus-group-clear-data-on-native-groups
1331 If you don't have access to both the old and new server, all your marks
1332 and read ranges have become worthless. You can use the @kbd{M-x
1333 gnus-group-clear-data-on-native-groups} command to clear out all data
1334 that you have on your native groups. Use with caution.
1336 After changing servers, you @strong{must} move the cache hierarchy away,
1337 since the cached articles will have wrong article numbers, which will
1338 affect which articles Gnus thinks are read.
1342 @section Startup Files
1343 @cindex startup files
1348 Now, you all know about the @file{.newsrc} file. All subscription
1349 information is traditionally stored in this file.
1351 Things got a bit more complicated with @sc{gnus}. In addition to
1352 keeping the @file{.newsrc} file updated, it also used a file called
1353 @file{.newsrc.el} for storing all the information that didn't fit into
1354 the @file{.newsrc} file. (Actually, it also duplicated everything in
1355 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1356 files was the most recently saved, which enabled people to swap between
1357 @sc{gnus} and other newsreaders.
1359 That was kinda silly, so Gnus went one better: In addition to the
1360 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1361 @file{.newsrc.eld}. It will read whichever of these files that are most
1362 recent, but it will never write a @file{.newsrc.el} file. You should
1363 never delete the @file{.newsrc.eld} file---it contains much information
1364 not stored in the @file{.newsrc} file.
1366 @vindex gnus-save-newsrc-file
1367 @vindex gnus-read-newsrc-file
1368 You can turn off writing the @file{.newsrc} file by setting
1369 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1370 the file and save some space, as well as exiting from Gnus faster.
1371 However, this will make it impossible to use other newsreaders than
1372 Gnus. But hey, who would want to, right? Similarly, setting
1373 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
1374 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1375 convenient if you have a tendency to use Netscape once in a while.
1377 @vindex gnus-save-killed-list
1378 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1379 will not save the list of killed groups to the startup file. This will
1380 save both time (when starting and quitting) and space (on disk). It
1381 will also mean that Gnus has no record of what groups are new or old,
1382 so the automatic new groups subscription methods become meaningless.
1383 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1384 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1385 Groups}). This variable can also be a regular expression. If that's
1386 the case, remove all groups that do not match this regexp before
1387 saving. This can be useful in certain obscure situations that involve
1388 several servers where not all servers support @code{ask-server}.
1390 @vindex gnus-startup-file
1391 The @code{gnus-startup-file} variable says where the startup files are.
1392 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1393 file being whatever that one is, with a @samp{.eld} appended.
1395 @vindex gnus-save-newsrc-hook
1396 @vindex gnus-save-quick-newsrc-hook
1397 @vindex gnus-save-standard-newsrc-hook
1398 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1399 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1400 saving the @file{.newsrc.eld} file, and
1401 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1402 @file{.newsrc} file. The latter two are commonly used to turn version
1403 control on or off. Version control is on by default when saving the
1404 startup files. If you want to turn backup creation off, say something like:
1407 (defun turn-off-backup ()
1408 (set (make-local-variable 'backup-inhibited) t))
1410 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1411 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1414 @vindex gnus-init-file
1415 When Gnus starts, it will read the @code{gnus-site-init-file}
1416 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1417 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1418 and can be used to avoid cluttering your @file{~/.emacs} and
1419 @file{site-init} files with Gnus stuff. Gnus will also check for files
1420 with the same names as these, but with @file{.elc} and @file{.el}
1421 suffixes. In other words, if you have set @code{gnus-init-file} to
1422 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1423 and finally @file{~/.gnus} (in this order).
1429 @cindex dribble file
1432 Whenever you do something that changes the Gnus data (reading articles,
1433 catching up, killing/subscribing groups), the change is added to a
1434 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1435 Emacs way. If your Emacs should crash before you have saved the
1436 @file{.newsrc} files, all changes you have made can be recovered from
1439 If Gnus detects this file at startup, it will ask the user whether to
1440 read it. The auto save file is deleted whenever the real startup file is
1443 @vindex gnus-use-dribble-file
1444 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
1445 maintain a dribble buffer. The default is @code{t}.
1447 @vindex gnus-dribble-directory
1448 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1449 this variable is @code{nil}, which it is by default, Gnus will dribble
1450 into the directory where the @file{.newsrc} file is located. (This is
1451 normally the user's home directory.) The dribble file will get the same
1452 file permissions as the @code{.newsrc} file.
1454 @vindex gnus-always-read-dribble-file
1455 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1456 read the dribble file on startup without querying the user.
1459 @node The Active File
1460 @section The Active File
1462 @cindex ignored groups
1464 When Gnus starts, or indeed whenever it tries to determine whether new
1465 articles have arrived, it reads the active file. This is a very large
1466 file that lists all the active groups and articles on the server.
1468 @vindex gnus-ignored-newsgroups
1469 Before examining the active file, Gnus deletes all lines that match the
1470 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1471 any groups with bogus names, but you can use this variable to make Gnus
1472 ignore hierarchies you aren't ever interested in. However, this is not
1473 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1474 Groups} for an overview of other variables that can be used instead.
1477 @c @code{nil} by default, and will slow down active file handling somewhat
1478 @c if you set it to anything else.
1480 @vindex gnus-read-active-file
1482 The active file can be rather Huge, so if you have a slow network, you
1483 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
1484 reading the active file. This variable is @code{some} by default.
1486 Gnus will try to make do by getting information just on the groups that
1487 you actually subscribe to.
1489 Note that if you subscribe to lots and lots of groups, setting this
1490 variable to @code{nil} will probably make Gnus slower, not faster. At
1491 present, having this variable @code{nil} will slow Gnus down
1492 considerably, unless you read news over a 2400 baud modem.
1494 This variable can also have the value @code{some}. Gnus will then
1495 attempt to read active info only on the subscribed groups. On some
1496 servers this is quite fast (on sparkling, brand new INN servers that
1497 support the @code{LIST ACTIVE group} command), on others this isn't fast
1498 at all. In any case, @code{some} should be faster than @code{nil}, and
1499 is certainly faster than @code{t} over slow lines.
1501 Some news servers (old versions of Leafnode and old versions of INN, for
1502 instance) do not support the @code{LIST ACTIVE group}. For these
1503 servers, @code{nil} is probably the most efficient value for this
1506 If this variable is @code{nil}, Gnus will ask for group info in total
1507 lock-step, which isn't very fast. If it is @code{some} and you use an
1508 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
1509 read all the replies in one swoop. This will normally result in better
1510 performance, but if the server does not support the aforementioned
1511 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1513 If you think that starting up Gnus takes too long, try all the three
1514 different values for this variable and see what works best for you.
1516 In any case, if you use @code{some} or @code{nil}, you should definitely
1517 kill all groups that you aren't interested in to speed things up.
1519 Note that this variable also affects active file retrieval from
1520 secondary select methods.
1523 @node Startup Variables
1524 @section Startup Variables
1528 @item gnus-load-hook
1529 @vindex gnus-load-hook
1530 A hook run while Gnus is being loaded. Note that this hook will
1531 normally be run just once in each Emacs session, no matter how many
1532 times you start Gnus.
1534 @item gnus-before-startup-hook
1535 @vindex gnus-before-startup-hook
1536 A hook run after starting up Gnus successfully.
1538 @item gnus-startup-hook
1539 @vindex gnus-startup-hook
1540 A hook run as the very last thing after starting up Gnus
1542 @item gnus-started-hook
1543 @vindex gnus-started-hook
1544 A hook that is run as the very last thing after starting up Gnus
1547 @item gnus-setup-news-hook
1548 @vindex gnus-setup-news-hook
1549 A hook that is run after reading the @file{.newsrc} file(s), but before
1550 generating the group buffer.
1552 @item gnus-check-bogus-newsgroups
1553 @vindex gnus-check-bogus-newsgroups
1554 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1555 startup. A @dfn{bogus group} is a group that you have in your
1556 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1557 bogus groups can take quite a while, so to save time and resources it's
1558 best to leave this option off, and do the checking for bogus groups once
1559 in a while from the group buffer instead (@pxref{Group Maintenance}).
1561 @item gnus-inhibit-startup-message
1562 @vindex gnus-inhibit-startup-message
1563 If non-@code{nil}, the startup message won't be displayed. That way,
1564 your boss might not notice as easily that you are reading news instead
1565 of doing your job. Note that this variable is used before
1566 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1568 @item gnus-no-groups-message
1569 @vindex gnus-no-groups-message
1570 Message displayed by Gnus when no groups are available.
1572 @item gnus-play-startup-jingle
1573 @vindex gnus-play-startup-jingle
1574 If non-@code{nil}, play the Gnus jingle at startup.
1576 @item gnus-startup-jingle
1577 @vindex gnus-startup-jingle
1578 Jingle to be played if the above variable is non-@code{nil}. The
1579 default is @samp{Tuxedomoon.Jingle4.au}.
1585 @chapter Group Buffer
1586 @cindex group buffer
1588 The @dfn{group buffer} lists all (or parts) of the available groups. It
1589 is the first buffer shown when Gnus starts, and will never be killed as
1590 long as Gnus is active.
1594 \gnusfigure{The Group Buffer}{320}{
1595 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1596 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1597 \put(120,38){\vector(1,2){10}}
1598 \put(40,60){\makebox(0,0)[r]{Mode line}}
1599 \put(40,58){\vector(1,0){30}}
1600 \put(200,28){\makebox(0,0)[t]{Native select method}}
1601 \put(200,26){\vector(-1,2){15}}
1607 * Group Buffer Format:: Information listed and how you can change it.
1608 * Group Maneuvering:: Commands for moving in the group buffer.
1609 * Selecting a Group:: Actually reading news.
1610 * Subscription Commands:: Unsubscribing, killing, subscribing.
1611 * Group Data:: Changing the info for a group.
1612 * Group Levels:: Levels? What are those, then?
1613 * Group Score:: A mechanism for finding out what groups you like.
1614 * Marking Groups:: You can mark groups for later processing.
1615 * Foreign Groups:: Creating and editing groups.
1616 * Group Parameters:: Each group may have different parameters set.
1617 * Listing Groups:: Gnus can list various subsets of the groups.
1618 * Sorting Groups:: Re-arrange the group order.
1619 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1620 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1621 * Exiting Gnus:: Stop reading news and get some work done.
1622 * Group Topics:: A folding group mode divided into topics.
1623 * Misc Group Stuff:: Other stuff that you can to do.
1627 @node Group Buffer Format
1628 @section Group Buffer Format
1631 * Group Line Specification:: Deciding how the group buffer is to look.
1632 * Group Modeline Specification:: The group buffer modeline.
1633 * Group Highlighting:: Having nice colors in the group buffer.
1637 @node Group Line Specification
1638 @subsection Group Line Specification
1639 @cindex group buffer format
1641 The default format of the group buffer is nice and dull, but you can
1642 make it as exciting and ugly as you feel like.
1644 Here's a couple of example group lines:
1647 25: news.announce.newusers
1648 * 0: alt.fan.andrea-dworkin
1653 You can see that there are 25 unread articles in
1654 @samp{news.announce.newusers}. There are no unread articles, but some
1655 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1656 asterisk at the beginning of the line?).
1658 @vindex gnus-group-line-format
1659 You can change that format to whatever you want by fiddling with the
1660 @code{gnus-group-line-format} variable. This variable works along the
1661 lines of a @code{format} specification, which is pretty much the same as
1662 a @code{printf} specifications, for those of you who use (feh!) C.
1663 @xref{Formatting Variables}.
1665 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1667 There should always be a colon on the line; the cursor always moves to
1668 the colon after performing an operation. Nothing else is required---not
1669 even the group name. All displayed text is just window dressing, and is
1670 never examined by Gnus. Gnus stores all real information it needs using
1673 (Note that if you make a really strange, wonderful, spreadsheet-like
1674 layout, everybody will believe you are hard at work with the accounting
1675 instead of wasting time reading news.)
1677 Here's a list of all available format characters:
1682 An asterisk if the group only has marked articles.
1685 Whether the group is subscribed.
1688 Level of subscribedness.
1691 Number of unread articles.
1694 Number of dormant articles.
1697 Number of ticked articles.
1700 Number of read articles.
1703 Estimated total number of articles. (This is really @var{max-number}
1704 minus @var{min-number} plus 1.)
1706 Gnus uses this estimation because the NNTP protocol provides efficient
1707 access to @var{max-number} and @var{min-number} but getting the true
1708 unread message count is not possible efficiently. For hysterical
1709 raisins, even the mail backends, where the true number of unread
1710 messages might be available efficiently, use the same limited
1711 interface. To remove this restriction from Gnus means that the
1712 backend interface has to be changed, which is not an easy job. If you
1713 want to work on this, please contact the Gnus mailing list.
1716 Number of unread, unticked, non-dormant articles.
1719 Number of ticked and dormant articles.
1728 Newsgroup description.
1731 @samp{m} if moderated.
1734 @samp{(m)} if moderated.
1743 A string that looks like @samp{<%s:%n>} if a foreign select method is
1747 Indentation based on the level of the topic (@pxref{Group Topics}).
1750 @vindex gnus-group-uncollapsed-levels
1751 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1752 variable says how many levels to leave at the end of the group name.
1753 The default is 1---this will mean that group names like
1754 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1757 @vindex gnus-new-mail-mark
1759 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1763 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1766 A string that says when you last read the group (@pxref{Group
1770 User defined specifier. The next character in the format string should
1771 be a letter. Gnus will call the function
1772 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1773 following @samp{%u}. The function will be passed a single dummy
1774 parameter as argument. The function should return a string, which will
1775 be inserted into the buffer just like information from any other
1780 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1781 if no info is available---for instance, if it is a non-activated foreign
1782 group, or a bogus native group.
1785 @node Group Modeline Specification
1786 @subsection Group Modeline Specification
1787 @cindex group modeline
1789 @vindex gnus-group-mode-line-format
1790 The mode line can be changed by setting
1791 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1792 doesn't understand that many format specifiers:
1796 The native news server.
1798 The native select method.
1802 @node Group Highlighting
1803 @subsection Group Highlighting
1804 @cindex highlighting
1805 @cindex group highlighting
1807 @vindex gnus-group-highlight
1808 Highlighting in the group buffer is controlled by the
1809 @code{gnus-group-highlight} variable. This is an alist with elements
1810 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1811 something non-@code{nil}, the @var{face} will be used on the line.
1813 Here's an example value for this variable that might look nice if the
1817 (cond (window-system
1818 (setq custom-background-mode 'light)
1819 (defface my-group-face-1
1820 '((t (:foreground "Red" :bold t))) "First group face")
1821 (defface my-group-face-2
1822 '((t (:foreground "DarkSeaGreen4" :bold t))) "Second group face")
1823 (defface my-group-face-3
1824 '((t (:foreground "Green4" :bold t))) "Third group face")
1825 (defface my-group-face-4
1826 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1827 (defface my-group-face-5
1828 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1830 (setq gnus-group-highlight
1831 '(((> unread 200) . my-group-face-1)
1832 ((and (< level 3) (zerop unread)) . my-group-face-2)
1833 ((< level 3) . my-group-face-3)
1834 ((zerop unread) . my-group-face-4)
1835 (t . my-group-face-5)))
1838 Also @pxref{Faces and Fonts}.
1840 Variables that are dynamically bound when the forms are evaluated
1847 The number of unread articles in the group.
1851 Whether the group is a mail group.
1853 The level of the group.
1855 The score of the group.
1857 The number of ticked articles in the group.
1859 The total number of articles in the group. Or rather, MAX-NUMBER minus
1860 MIN-NUMBER plus one.
1862 When using the topic minor mode, this variable is bound to the current
1863 topic being inserted.
1866 When the forms are @code{eval}ed, point is at the beginning of the line
1867 of the group in question, so you can use many of the normal Gnus
1868 functions for snarfing info on the group.
1870 @vindex gnus-group-update-hook
1871 @findex gnus-group-highlight-line
1872 @code{gnus-group-update-hook} is called when a group line is changed.
1873 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1874 calls @code{gnus-group-highlight-line} by default.
1877 @node Group Maneuvering
1878 @section Group Maneuvering
1879 @cindex group movement
1881 All movement commands understand the numeric prefix and will behave as
1882 expected, hopefully.
1888 @findex gnus-group-next-unread-group
1889 Go to the next group that has unread articles
1890 (@code{gnus-group-next-unread-group}).
1896 @findex gnus-group-prev-unread-group
1897 Go to the previous group that has unread articles
1898 (@code{gnus-group-prev-unread-group}).
1902 @findex gnus-group-next-group
1903 Go to the next group (@code{gnus-group-next-group}).
1907 @findex gnus-group-prev-group
1908 Go to the previous group (@code{gnus-group-prev-group}).
1912 @findex gnus-group-next-unread-group-same-level
1913 Go to the next unread group on the same (or lower) level
1914 (@code{gnus-group-next-unread-group-same-level}).
1918 @findex gnus-group-prev-unread-group-same-level
1919 Go to the previous unread group on the same (or lower) level
1920 (@code{gnus-group-prev-unread-group-same-level}).
1923 Three commands for jumping to groups:
1929 @findex gnus-group-jump-to-group
1930 Jump to a group (and make it visible if it isn't already)
1931 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
1936 @findex gnus-group-best-unread-group
1937 Jump to the unread group with the lowest level
1938 (@code{gnus-group-best-unread-group}).
1942 @findex gnus-group-first-unread-group
1943 Jump to the first group with unread articles
1944 (@code{gnus-group-first-unread-group}).
1947 @vindex gnus-group-goto-unread
1948 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1949 commands will move to the next group, not the next unread group. Even
1950 the commands that say they move to the next unread group. The default
1954 @node Selecting a Group
1955 @section Selecting a Group
1956 @cindex group selection
1961 @kindex SPACE (Group)
1962 @findex gnus-group-read-group
1963 Select the current group, switch to the summary buffer and display the
1964 first unread article (@code{gnus-group-read-group}). If there are no
1965 unread articles in the group, or if you give a non-numerical prefix to
1966 this command, Gnus will offer to fetch all the old articles in this
1967 group from the server. If you give a numerical prefix @var{N}, @var{N}
1968 determines the number of articles Gnus will fetch. If @var{N} is
1969 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1970 negative, Gnus fetches the @code{abs(@var{N})} oldest articles.
1972 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
1973 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
1974 - 4 2 SPC} fetches the 42 oldest ones.
1976 When you are in the group (in the Summary buffer), you can type
1977 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
1982 @findex gnus-group-select-group
1983 Select the current group and switch to the summary buffer
1984 (@code{gnus-group-select-group}). Takes the same arguments as
1985 @code{gnus-group-read-group}---the only difference is that this command
1986 does not display the first unread article automatically upon group
1990 @kindex M-RET (Group)
1991 @findex gnus-group-quick-select-group
1992 This does the same as the command above, but tries to do it with the
1993 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
1994 scoring/killing will be performed, there will be no highlights and no
1995 expunging. This might be useful if you're in a real hurry and have to
1996 enter some humongous group. If you give a 0 prefix to this command
1997 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
1998 which is useful if you want to toggle threading before generating the
1999 summary buffer (@pxref{Summary Generation Commands}).
2002 @kindex M-SPACE (Group)
2003 @findex gnus-group-visible-select-group
2004 This is yet one more command that does the same as the @kbd{RET}
2005 command, but this one does it without expunging and hiding dormants
2006 (@code{gnus-group-visible-select-group}).
2009 @kindex M-C-RET (Group)
2010 @findex gnus-group-select-group-ephemerally
2011 Finally, this command selects the current group ephemerally without
2012 doing any processing of its contents
2013 (@code{gnus-group-select-group-ephemerally}). Even threading has been
2014 turned off. Everything you do in the group after selecting it in this
2015 manner will have no permanent effects.
2019 @vindex gnus-large-newsgroup
2020 The @code{gnus-large-newsgroup} variable says what Gnus should consider
2021 to be a big group. This is 200 by default. If the group has more
2022 (unread and/or ticked) articles than this, Gnus will query the user
2023 before entering the group. The user can then specify how many articles
2024 should be fetched from the server. If the user specifies a negative
2025 number (@code{-n}), the @code{n} oldest articles will be fetched. If it
2026 is positive, the @code{n} articles that have arrived most recently will
2029 @vindex gnus-select-group-hook
2030 @vindex gnus-auto-select-first
2031 @code{gnus-auto-select-first} control whether any articles are selected
2032 automatically when entering a group with the @kbd{SPACE} command.
2037 Don't select any articles when entering the group. Just display the
2038 full summary buffer.
2041 Select the first unread article when entering the group.
2044 Select the highest scored article in the group when entering the
2049 This variable can also be a function. In that case, that function will
2050 be called to place point on a subject line, and/or select some article.
2051 Useful functions include:
2054 @item gnus-summary-first-unread-subject
2055 Place point on the subject line of the first unread article, but
2056 don't select the article.
2058 @item gnus-summary-first-unread-article
2059 Select the first unread article.
2061 @item gnus-summary-best-unread-article
2062 Select the highest-scored unread article.
2066 If you want to prevent automatic selection in some group (say, in a
2067 binary group with Huge articles) you can set this variable to @code{nil}
2068 in @code{gnus-select-group-hook}, which is called when a group is
2072 @node Subscription Commands
2073 @section Subscription Commands
2074 @cindex subscription
2082 @findex gnus-group-unsubscribe-current-group
2083 @c @icon{gnus-group-unsubscribe}
2084 Toggle subscription to the current group
2085 (@code{gnus-group-unsubscribe-current-group}).
2091 @findex gnus-group-unsubscribe-group
2092 Prompt for a group to subscribe, and then subscribe it. If it was
2093 subscribed already, unsubscribe it instead
2094 (@code{gnus-group-unsubscribe-group}).
2100 @findex gnus-group-kill-group
2101 @c @icon{gnus-group-kill-group}
2102 Kill the current group (@code{gnus-group-kill-group}).
2108 @findex gnus-group-yank-group
2109 Yank the last killed group (@code{gnus-group-yank-group}).
2112 @kindex C-x C-t (Group)
2113 @findex gnus-group-transpose-groups
2114 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2115 really a subscription command, but you can use it instead of a
2116 kill-and-yank sequence sometimes.
2122 @findex gnus-group-kill-region
2123 Kill all groups in the region (@code{gnus-group-kill-region}).
2127 @findex gnus-group-kill-all-zombies
2128 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2131 @kindex S C-k (Group)
2132 @findex gnus-group-kill-level
2133 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2134 These groups can't be yanked back after killing, so this command should
2135 be used with some caution. The only time where this command comes in
2136 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2137 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2138 kill off all unsubscribed groups that do not have message numbers in the
2139 @file{.newsrc} file.
2143 Also @pxref{Group Levels}.
2153 @findex gnus-group-catchup-current
2154 @vindex gnus-group-catchup-group-hook
2155 @c @icon{gnus-group-catchup-current}
2156 Mark all unticked articles in this group as read
2157 (@code{gnus-group-catchup-current}).
2158 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2163 @findex gnus-group-catchup-current-all
2164 Mark all articles in this group, even the ticked ones, as read
2165 (@code{gnus-group-catchup-current-all}).
2169 @findex gnus-group-clear-data
2170 Clear the data from the current group---nix out marks and the list of
2171 read articles (@code{gnus-group-clear-data}).
2173 @item M-x gnus-group-clear-data-on-native-groups
2174 @kindex M-x gnus-group-clear-data-on-native-groups
2175 @findex gnus-group-clear-data-on-native-groups
2176 If you have switched from one @sc{nntp} server to another, all your marks
2177 and read ranges have become worthless. You can use this command to
2178 clear out all data that you have on your native groups. Use with
2185 @section Group Levels
2189 All groups have a level of @dfn{subscribedness}. For instance, if a
2190 group is on level 2, it is more subscribed than a group on level 5. You
2191 can ask Gnus to just list groups on a given level or lower
2192 (@pxref{Listing Groups}), or to just check for new articles in groups on
2193 a given level or lower (@pxref{Scanning New Messages}).
2195 Remember: The higher the level of the group, the less important it is.
2201 @findex gnus-group-set-current-level
2202 Set the level of the current group. If a numeric prefix is given, the
2203 next @var{n} groups will have their levels set. The user will be
2204 prompted for a level.
2207 @vindex gnus-level-killed
2208 @vindex gnus-level-zombie
2209 @vindex gnus-level-unsubscribed
2210 @vindex gnus-level-subscribed
2211 Gnus considers groups from levels 1 to
2212 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2213 @code{gnus-level-subscribed} (exclusive) and
2214 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2215 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2216 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2217 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2218 same, but zombie and killed groups have no information on what articles
2219 you have read, etc, stored. This distinction between dead and living
2220 groups isn't done because it is nice or clever, it is done purely for
2221 reasons of efficiency.
2223 It is recommended that you keep all your mail groups (if any) on quite
2224 low levels (e.g. 1 or 2).
2226 Maybe the following description of the default behavior of Gnus helps to
2227 understand what these levels are all about. By default, Gnus shows you
2228 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2229 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2230 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2231 groups are hidden, in a way.
2233 Zombie and killed groups are similar to unsubscribed groups in that they
2234 are hidden by default. But they are different from subscribed and
2235 unsubscribed groups in that Gnus doesn't ask the news server for
2236 information (number of messages, number of unread messages) on zombie
2237 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2238 aren't interested in. If most groups are killed, Gnus is faster.
2240 Why does Gnus distinguish between zombie and killed groups? Well, when
2241 a new group arrives on the server, Gnus by default makes it a zombie
2242 group. This means that you are normally not bothered with new groups,
2243 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2244 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2245 list of killed groups.)
2247 If you want to play with the level variables, you should show some care.
2248 Set them once, and don't touch them ever again. Better yet, don't touch
2249 them at all unless you know exactly what you're doing.
2251 @vindex gnus-level-default-unsubscribed
2252 @vindex gnus-level-default-subscribed
2253 Two closely related variables are @code{gnus-level-default-subscribed}
2254 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2255 which are the levels that new groups will be put on if they are
2256 (un)subscribed. These two variables should, of course, be inside the
2257 relevant valid ranges.
2259 @vindex gnus-keep-same-level
2260 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2261 will only move to groups of the same level (or lower). In
2262 particular, going from the last article in one group to the next group
2263 will go to the next group of the same level (or lower). This might be
2264 handy if you want to read the most important groups before you read the
2267 If this variable is @code{best}, Gnus will make the next newsgroup the
2268 one with the best level.
2270 @vindex gnus-group-default-list-level
2271 All groups with a level less than or equal to
2272 @code{gnus-group-default-list-level} will be listed in the group buffer
2275 @vindex gnus-group-list-inactive-groups
2276 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2277 groups will be listed along with the unread groups. This variable is
2278 @code{t} by default. If it is @code{nil}, inactive groups won't be
2281 @vindex gnus-group-use-permanent-levels
2282 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2283 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2284 use this level as the ``work'' level.
2286 @vindex gnus-activate-level
2287 Gnus will normally just activate (i. e., query the server about) groups
2288 on level @code{gnus-activate-level} or less. If you don't want to
2289 activate unsubscribed groups, for instance, you might set this variable
2290 to 5. The default is 6.
2294 @section Group Score
2299 You would normally keep important groups on high levels, but that scheme
2300 is somewhat restrictive. Don't you wish you could have Gnus sort the
2301 group buffer according to how often you read groups, perhaps? Within
2304 This is what @dfn{group score} is for. You can have Gnus assign a score
2305 to each group through the mechanism described below. You can then sort
2306 the group buffer based on this score. Alternatively, you can sort on
2307 score and then level. (Taken together, the level and the score is
2308 called the @dfn{rank} of the group. A group that is on level 4 and has
2309 a score of 1 has a higher rank than a group on level 5 that has a score
2310 of 300. (The level is the most significant part and the score is the
2311 least significant part.))
2313 @findex gnus-summary-bubble-group
2314 If you want groups you read often to get higher scores than groups you
2315 read seldom you can add the @code{gnus-summary-bubble-group} function to
2316 the @code{gnus-summary-exit-hook} hook. This will result (after
2317 sorting) in a bubbling sort of action. If you want to see that in
2318 action after each summary exit, you can add
2319 @code{gnus-group-sort-groups-by-rank} or
2320 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2321 slow things down somewhat.
2324 @node Marking Groups
2325 @section Marking Groups
2326 @cindex marking groups
2328 If you want to perform some command on several groups, and they appear
2329 subsequently in the group buffer, you would normally just give a
2330 numerical prefix to the command. Most group commands will then do your
2331 bidding on those groups.
2333 However, if the groups are not in sequential order, you can still
2334 perform a command on several groups. You simply mark the groups first
2335 with the process mark and then execute the command.
2343 @findex gnus-group-mark-group
2344 Set the mark on the current group (@code{gnus-group-mark-group}).
2350 @findex gnus-group-unmark-group
2351 Remove the mark from the current group
2352 (@code{gnus-group-unmark-group}).
2356 @findex gnus-group-unmark-all-groups
2357 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2361 @findex gnus-group-mark-region
2362 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2366 @findex gnus-group-mark-buffer
2367 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2371 @findex gnus-group-mark-regexp
2372 Mark all groups that match some regular expression
2373 (@code{gnus-group-mark-regexp}).
2376 Also @pxref{Process/Prefix}.
2378 @findex gnus-group-universal-argument
2379 If you want to execute some command on all groups that have been marked
2380 with the process mark, you can use the @kbd{M-&}
2381 (@code{gnus-group-universal-argument}) command. It will prompt you for
2382 the command to be executed.
2385 @node Foreign Groups
2386 @section Foreign Groups
2387 @cindex foreign groups
2389 Below are some group mode commands for making and editing general foreign
2390 groups, as well as commands to ease the creation of a few
2391 special-purpose groups. All these commands insert the newly created
2392 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2399 @findex gnus-group-make-group
2400 @cindex making groups
2401 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2402 for a name, a method and possibly an @dfn{address}. For an easier way
2403 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
2407 @findex gnus-group-rename-group
2408 @cindex renaming groups
2409 Rename the current group to something else
2410 (@code{gnus-group-rename-group}). This is valid only on some
2411 groups---mail groups mostly. This command might very well be quite slow
2417 @findex gnus-group-customize
2418 Customize the group parameters (@code{gnus-group-customize}).
2422 @findex gnus-group-edit-group-method
2423 @cindex renaming groups
2424 Enter a buffer where you can edit the select method of the current
2425 group (@code{gnus-group-edit-group-method}).
2429 @findex gnus-group-edit-group-parameters
2430 Enter a buffer where you can edit the group parameters
2431 (@code{gnus-group-edit-group-parameters}).
2435 @findex gnus-group-edit-group
2436 Enter a buffer where you can edit the group info
2437 (@code{gnus-group-edit-group}).
2441 @findex gnus-group-make-directory-group
2443 Make a directory group (@pxref{Directory Groups}). You will be prompted
2444 for a directory name (@code{gnus-group-make-directory-group}).
2449 @findex gnus-group-make-help-group
2450 Make the Gnus help group (@code{gnus-group-make-help-group}).
2454 @cindex (ding) archive
2455 @cindex archive group
2456 @findex gnus-group-make-archive-group
2457 @vindex gnus-group-archive-directory
2458 @vindex gnus-group-recent-archive-directory
2459 Make a Gnus archive group (@code{gnus-group-make-archive-group}). By
2460 default a group pointing to the most recent articles will be created
2461 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2462 group will be created from @code{gnus-group-archive-directory}.
2466 @findex gnus-group-make-kiboze-group
2468 Make a kiboze group. You will be prompted for a name, for a regexp to
2469 match groups to be ``included'' in the kiboze group, and a series of
2470 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2471 @xref{Kibozed Groups}.
2475 @findex gnus-group-enter-directory
2477 Read an arbitrary directory as if it were a newsgroup with the
2478 @code{nneething} backend (@code{gnus-group-enter-directory}).
2479 @xref{Anything Groups}.
2483 @findex gnus-group-make-doc-group
2484 @cindex ClariNet Briefs
2486 Make a group based on some file or other
2487 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2488 command, you will be prompted for a file name and a file type.
2489 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
2490 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
2491 @code{rfc934}, @code{rfc822-forward}, @code{nsmail} and @code{forward}.
2492 If you run this command without a prefix, Gnus will guess at the file
2493 type. @xref{Document Groups}.
2497 @vindex gnus-useful-groups
2498 @findex gnus-group-make-useful-group
2499 Create one of the groups mentioned in @code{gnus-useful-groups}
2500 (@code{gnus-group-make-useful-group}).
2504 @findex gnus-group-make-web-group
2509 Make an ephemeral group based on a web search
2510 (@code{gnus-group-make-web-group}). If you give a prefix to this
2511 command, make a solid group instead. You will be prompted for the
2512 search engine type and the search string. Valid search engine types
2513 include @code{dejanews}, @code{altavista} and @code{reference}.
2514 @xref{Web Searches}.
2516 If you use the @code{dejanews} search engine, you can limit the search
2517 to a particular group by using a match string like
2518 @samp{~g alt.sysadmin.recovery shaving}.
2521 @kindex G DEL (Group)
2522 @findex gnus-group-delete-group
2523 This function will delete the current group
2524 (@code{gnus-group-delete-group}). If given a prefix, this function will
2525 actually delete all the articles in the group, and forcibly remove the
2526 group itself from the face of the Earth. Use a prefix only if you are
2527 absolutely sure of what you are doing. This command can't be used on
2528 read-only groups (like @code{nntp} group), though.
2532 @findex gnus-group-make-empty-virtual
2533 Make a new, fresh, empty @code{nnvirtual} group
2534 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2538 @findex gnus-group-add-to-virtual
2539 Add the current group to an @code{nnvirtual} group
2540 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2543 @xref{Select Methods}, for more information on the various select
2546 @vindex gnus-activate-foreign-newsgroups
2547 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2548 Gnus will check all foreign groups with this level or lower at startup.
2549 This might take quite a while, especially if you subscribe to lots of
2550 groups from different @sc{nntp} servers. Also @pxref{Group Levels};
2551 @code{gnus-activate-level} also affects activation of foreign
2555 @node Group Parameters
2556 @section Group Parameters
2557 @cindex group parameters
2559 The group parameters store information local to a particular group.
2560 Here's an example group parameter list:
2563 ((to-address . "ding@@gnus.org")
2567 We see that each element consists of a "dotted pair"---the thing before
2568 the dot is the key, while the thing after the dot is the value. All the
2569 parameters have this form @emph{except} local variable specs, which are
2570 not dotted pairs, but proper lists.
2572 Some parameters have correspondant customizable variables, each of which
2573 is an alist of regexps and values.
2575 The following group parameters can be used:
2580 Address used by when doing followups and new posts.
2583 (to-address . "some@@where.com")
2586 This is primarily useful in mail groups that represent closed mailing
2587 lists---mailing lists where it's expected that everybody that writes to
2588 the mailing list is subscribed to it. Since using this parameter
2589 ensures that the mail only goes to the mailing list itself, it means
2590 that members won't receive two copies of your followups.
2592 Using @code{to-address} will actually work whether the group is foreign
2593 or not. Let's say there's a group on the server that is called
2594 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2595 the articles from a mail-to-news gateway. Posting directly to this
2596 group is therefore impossible---you have to send mail to the mailing
2597 list address instead.
2599 See also @code{gnus-parameter-to-address-alist}.
2603 Address used when doing @kbd{a} in that group.
2606 (to-list . "some@@where.com")
2609 It is totally ignored
2610 when doing a followup---except that if it is present in a news group,
2611 you'll get mail group semantics when doing @kbd{f}.
2613 If you do an @kbd{a} command in a mail group and you have neither a
2614 @code{to-list} group parameter nor a @code{to-address} group parameter,
2615 then a @code{to-list} group parameter will be added automatically upon
2616 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2617 @vindex gnus-add-to-list
2619 If you do an @kbd{a} command in a mail group and you don't have a
2620 @code{to-list} group parameter, one will be added automatically upon
2621 sending the message.
2623 @findex gnus-mailing-list-mode
2624 @cindex Mail List Groups
2625 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2626 entering summary buffer.
2628 See also @code{gnus-parameter-to-list-alist}.
2632 If the group parameter list has the element @code{(visible . t)},
2633 that group will always be visible in the Group buffer, regardless
2634 of whether it has any unread articles.
2636 @item broken-reply-to
2637 @cindex broken-reply-to
2638 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2639 headers in this group are to be ignored. This can be useful if you're
2640 reading a mailing list group where the listserv has inserted
2641 @code{Reply-To} headers that point back to the listserv itself. This is
2642 broken behavior. So there!
2646 Elements like @code{(to-group . "some.group.name")} means that all
2647 posts in that group will be sent to @code{some.group.name}.
2651 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2652 will treat all responses as if they were responses to news articles.
2653 This can be useful if you have a mail group that's really a mirror of a
2658 If @code{(gcc-self . t)} is present in the group parameter list, newly
2659 composed messages will be @code{Gcc}'d to the current group. If
2660 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2661 generated, if @code{(gcc-self . "string")} is present, this string will
2662 be inserted literally as a @code{gcc} header. This parameter takes
2663 precedence over any default @code{Gcc} rules as described later
2664 (@pxref{Archived Messages}).
2668 If the group parameter has an element that looks like @code{(auto-expire
2669 . t)}, all articles read will be marked as expirable. For an
2670 alternative approach, @pxref{Expiring Mail}.
2672 See also @code{gnus-auto-expirable-newsgroups}.
2675 @cindex total-expire
2676 If the group parameter has an element that looks like
2677 @code{(total-expire . t)}, all read articles will be put through the
2678 expiry process, even if they are not marked as expirable. Use with
2679 caution. Unread, ticked and dormant articles are not eligible for
2682 See also @code{gnus-total-expirable-newsgroups}.
2686 @vindex nnmail-expiry-wait-function
2687 If the group parameter has an element that looks like @code{(expiry-wait
2688 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2689 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2690 The value can either be a number of days (not necessarily an integer) or
2691 the symbols @code{never} or @code{immediate}.
2694 @cindex score file group parameter
2695 Elements that look like @code{(score-file . "file")} will make
2696 @file{file} into the current score file for the group in question. All
2697 interactive score entries will be put into this file.
2700 @cindex adapt file group parameter
2701 Elements that look like @code{(adapt-file . "file")} will make
2702 @file{file} into the current adaptive file for the group in question.
2703 All adaptive score entries will be put into this file.
2706 @cindex admin-address
2707 When unsubscribing from a mailing list you should never send the
2708 unsubscription notice to the mailing list itself. Instead, you'd send
2709 messages to the administrative address. This parameter allows you to
2710 put the admin address somewhere convenient.
2714 Elements that look like @code{(display . MODE)} say which articles to
2715 display on entering the group. Valid values are:
2719 Display all articles, both read and unread.
2722 Display the default visible articles, which normally includes unread and
2726 Display articles that satisfy a predicate.
2728 Here are some examples:
2732 Display only read articles.
2735 Display everything except expirable articles.
2737 @item [and (not reply) (not expire)]
2738 Display everything except expirable and articles you've already
2742 The available operators are @code{not}, @code{and} and @code{or}.
2743 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2744 @code{read}, @code{dormant}, @code{expire}, @code{reply},
2745 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2746 @code{cache}, @code{forward}, @code{seen} and @code{recent}.
2750 The @code{display} parameter works by limiting the summary buffer to
2751 the subset specified. You can pop the limit by using the @kbd{/ w}
2752 command (@pxref{Limiting}).
2756 Elements that look like @code{(comment . "This is a comment")}
2757 are arbitrary comments on the group. They are currently ignored by
2758 Gnus, but provide a place for you to store information on particular
2763 Elements that look like @code{(charset . iso-8859-1)} will make
2764 @code{iso-8859-1} the default charset; that is, the charset that will be
2765 used for all articles that do not specify a charset.
2767 See also @code{gnus-group-charset-alist}.
2769 @item ignored-charsets
2770 @cindex ignored-charset
2771 Elements that look like @code{(ignored-charsets x-known iso-8859-1)}
2772 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2773 default charset will be used for decoding articles.
2775 See also @code{gnus-group-ignored-charsets-alist}.
2778 @cindex posting-style
2779 You can store additional posting style information for this group only
2780 here (@pxref{Posting Styles}). The format is that of an entry in the
2781 @code{gnus-posting-styles} alist, except that there's no regexp matching
2782 the group name (of course). Style elements in this group parameter will
2783 take precedence over the ones found in @code{gnus-posting-styles}.
2785 For instance, if you want a funky name and signature in this group only,
2786 instead of hacking @code{gnus-posting-styles}, you could put something
2787 like this in the group parameters:
2792 (signature "Funky Signature"))
2797 If it is set, the value is used as the method for posting message
2798 instead of @code{gnus-post-method}.
2802 An item like @code{(banner . "regex")} causes any part of an article
2803 that matches the regular expression "regex" to be stripped. Instead of
2804 "regex", you can also use the symbol @code{signature} which strips the
2805 last signature or any of the elements of the alist
2806 @code{gnus-article-banner-alist}.
2808 @item (@var{variable} @var{form})
2809 You can use the group parameters to set variables local to the group you
2810 are entering. If you want to turn threading off in @samp{news.answers},
2811 you could put @code{(gnus-show-threads nil)} in the group parameters of
2812 that group. @code{gnus-show-threads} will be made into a local variable
2813 in the summary buffer you enter, and the form @code{nil} will be
2814 @code{eval}ed there.
2816 This can also be used as a group-specific hook function, if you'd like.
2817 If you want to hear a beep when you enter a group, you could put
2818 something like @code{(dummy-variable (ding))} in the parameters of that
2819 group. @code{dummy-variable} will be set to the result of the
2820 @code{(ding)} form, but who cares?
2824 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
2825 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
2826 presents you with a Customize-like interface. The latter helps avoid
2827 silly Lisp errors.) You might also be interested in reading about topic
2828 parameters (@pxref{Topic Parameters}).
2830 Group parameters can be set via the @code{gnus-parameters} variable too.
2831 But some variables, such as @code{visible}, have no effect. For
2835 (setq gnus-parameters
2837 (gnus-show-threads nil)
2838 (gnus-use-scoring nil)
2839 (gnus-summary-line-format
2840 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
2844 ("^nnimap:\\(foo.bar\\)$"
2848 (gnus-use-scoring t))
2852 (broken-reply-to . t))))
2855 String value of parameters will be subjected to regexp substitution, as
2856 the @code{to-group} example shows.
2859 @node Listing Groups
2860 @section Listing Groups
2861 @cindex group listing
2863 These commands all list various slices of the groups available.
2871 @findex gnus-group-list-groups
2872 List all groups that have unread articles
2873 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
2874 command will list only groups of level ARG and lower. By default, it
2875 only lists groups of level five (i. e.,
2876 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2883 @findex gnus-group-list-all-groups
2884 List all groups, whether they have unread articles or not
2885 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
2886 this command will list only groups of level ARG and lower. By default,
2887 it lists groups of level seven or lower (i.e., just subscribed and
2888 unsubscribed groups).
2892 @findex gnus-group-list-level
2893 List all unread groups on a specific level
2894 (@code{gnus-group-list-level}). If given a prefix, also list the groups
2895 with no unread articles.
2899 @findex gnus-group-list-killed
2900 List all killed groups (@code{gnus-group-list-killed}). If given a
2901 prefix argument, really list all groups that are available, but aren't
2902 currently (un)subscribed. This could entail reading the active file
2907 @findex gnus-group-list-zombies
2908 List all zombie groups (@code{gnus-group-list-zombies}).
2912 @findex gnus-group-list-matching
2913 List all unread, subscribed groups with names that match a regexp
2914 (@code{gnus-group-list-matching}).
2918 @findex gnus-group-list-all-matching
2919 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2923 @findex gnus-group-list-active
2924 List absolutely all groups in the active file(s) of the
2925 server(s) you are connected to (@code{gnus-group-list-active}). This
2926 might very well take quite a while. It might actually be a better idea
2927 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2928 thing to match on. Also note that this command may list groups that
2929 don't exist (yet)---these will be listed as if they were killed groups.
2930 Take the output with some grains of salt.
2934 @findex gnus-group-apropos
2935 List all groups that have names that match a regexp
2936 (@code{gnus-group-apropos}).
2940 @findex gnus-group-description-apropos
2941 List all groups that have names or descriptions that match a regexp
2942 (@code{gnus-group-description-apropos}).
2946 @findex gnus-group-list-cached
2947 List all groups with cached articles (@code{gnus-group-list-cached}).
2951 @findex gnus-group-list-dormant
2952 List all groups with dormant articles (@code{gnus-group-list-dormant}).
2956 @findex gnus-group-list-limit
2957 List groups limited within the current selection
2958 (@code{gnus-group-list-limit}).
2962 @findex gnus-group-list-flush
2963 Flush groups from the current selection (@code{gnus-group-list-flush}).
2967 @findex gnus-group-list-plus
2968 List groups plus the current selection (@code{gnus-group-list-plus}).
2972 @vindex gnus-permanently-visible-groups
2973 @cindex visible group parameter
2974 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2975 always be shown, whether they have unread articles or not. You can also
2976 add the @code{visible} element to the group parameters in question to
2977 get the same effect.
2979 @vindex gnus-list-groups-with-ticked-articles
2980 Groups that have just ticked articles in it are normally listed in the
2981 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
2982 @code{nil}, these groups will be treated just like totally empty
2983 groups. It is @code{t} by default.
2986 @node Sorting Groups
2987 @section Sorting Groups
2988 @cindex sorting groups
2990 @kindex C-c C-s (Group)
2991 @findex gnus-group-sort-groups
2992 @vindex gnus-group-sort-function
2993 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2994 group buffer according to the function(s) given by the
2995 @code{gnus-group-sort-function} variable. Available sorting functions
3000 @item gnus-group-sort-by-alphabet
3001 @findex gnus-group-sort-by-alphabet
3002 Sort the group names alphabetically. This is the default.
3004 @item gnus-group-sort-by-real-name
3005 @findex gnus-group-sort-by-real-name
3006 Sort the group alphabetically on the real (unprefixed) group names.
3008 @item gnus-group-sort-by-level
3009 @findex gnus-group-sort-by-level
3010 Sort by group level.
3012 @item gnus-group-sort-by-score
3013 @findex gnus-group-sort-by-score
3014 Sort by group score. @xref{Group Score}.
3016 @item gnus-group-sort-by-rank
3017 @findex gnus-group-sort-by-rank
3018 Sort by group score and then the group level. The level and the score
3019 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3021 @item gnus-group-sort-by-unread
3022 @findex gnus-group-sort-by-unread
3023 Sort by number of unread articles.
3025 @item gnus-group-sort-by-method
3026 @findex gnus-group-sort-by-method
3027 Sort alphabetically on the select method.
3029 @item gnus-group-sort-by-server
3030 @findex gnus-group-sort-by-server
3031 Sort alphabetically on the Gnus server name.
3036 @code{gnus-group-sort-function} can also be a list of sorting
3037 functions. In that case, the most significant sort key function must be
3041 There are also a number of commands for sorting directly according to
3042 some sorting criteria:
3046 @kindex G S a (Group)
3047 @findex gnus-group-sort-groups-by-alphabet
3048 Sort the group buffer alphabetically by group name
3049 (@code{gnus-group-sort-groups-by-alphabet}).
3052 @kindex G S u (Group)
3053 @findex gnus-group-sort-groups-by-unread
3054 Sort the group buffer by the number of unread articles
3055 (@code{gnus-group-sort-groups-by-unread}).
3058 @kindex G S l (Group)
3059 @findex gnus-group-sort-groups-by-level
3060 Sort the group buffer by group level
3061 (@code{gnus-group-sort-groups-by-level}).
3064 @kindex G S v (Group)
3065 @findex gnus-group-sort-groups-by-score
3066 Sort the group buffer by group score
3067 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3070 @kindex G S r (Group)
3071 @findex gnus-group-sort-groups-by-rank
3072 Sort the group buffer by group rank
3073 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3076 @kindex G S m (Group)
3077 @findex gnus-group-sort-groups-by-method
3078 Sort the group buffer alphabetically by backend name
3079 (@code{gnus-group-sort-groups-by-method}).
3083 All the commands below obey the process/prefix convention
3084 (@pxref{Process/Prefix}).
3086 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3087 commands will sort in reverse order.
3089 You can also sort a subset of the groups:
3093 @kindex G P a (Group)
3094 @findex gnus-group-sort-selected-groups-by-alphabet
3095 Sort the groups alphabetically by group name
3096 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3099 @kindex G P u (Group)
3100 @findex gnus-group-sort-selected-groups-by-unread
3101 Sort the groups by the number of unread articles
3102 (@code{gnus-group-sort-selected-groups-by-unread}).
3105 @kindex G P l (Group)
3106 @findex gnus-group-sort-selected-groups-by-level
3107 Sort the groups by group level
3108 (@code{gnus-group-sort-selected-groups-by-level}).
3111 @kindex G P v (Group)
3112 @findex gnus-group-sort-selected-groups-by-score
3113 Sort the groups by group score
3114 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3117 @kindex G P r (Group)
3118 @findex gnus-group-sort-selected-groups-by-rank
3119 Sort the groups by group rank
3120 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3123 @kindex G P m (Group)
3124 @findex gnus-group-sort-selected-groups-by-method
3125 Sort the groups alphabetically by backend name
3126 (@code{gnus-group-sort-selected-groups-by-method}).
3130 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3134 @node Group Maintenance
3135 @section Group Maintenance
3136 @cindex bogus groups
3141 @findex gnus-group-check-bogus-groups
3142 Find bogus groups and delete them
3143 (@code{gnus-group-check-bogus-groups}).
3147 @findex gnus-group-find-new-groups
3148 Find new groups and process them (@code{gnus-group-find-new-groups}).
3149 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3150 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3151 to query the server for new groups, and subscribe the new groups as
3155 @kindex C-c C-x (Group)
3156 @findex gnus-group-expire-articles
3157 Run all expirable articles in the current group through the expiry
3158 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3159 all expirable articles in the group that have been around for a while.
3160 (@pxref{Expiring Mail}).
3163 @kindex C-c M-C-x (Group)
3164 @findex gnus-group-expire-all-groups
3165 Run all expirable articles in all groups through the expiry process
3166 (@code{gnus-group-expire-all-groups}).
3171 @node Browse Foreign Server
3172 @section Browse Foreign Server
3173 @cindex foreign servers
3174 @cindex browsing servers
3179 @findex gnus-group-browse-foreign-server
3180 You will be queried for a select method and a server name. Gnus will
3181 then attempt to contact this server and let you browse the groups there
3182 (@code{gnus-group-browse-foreign-server}).
3185 @findex gnus-browse-mode
3186 A new buffer with a list of available groups will appear. This buffer
3187 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3188 a lot) like a normal group buffer.
3190 Here's a list of keystrokes available in the browse mode:
3195 @findex gnus-group-next-group
3196 Go to the next group (@code{gnus-group-next-group}).
3200 @findex gnus-group-prev-group
3201 Go to the previous group (@code{gnus-group-prev-group}).
3204 @kindex SPACE (Browse)
3205 @findex gnus-browse-read-group
3206 Enter the current group and display the first article
3207 (@code{gnus-browse-read-group}).
3210 @kindex RET (Browse)
3211 @findex gnus-browse-select-group
3212 Enter the current group (@code{gnus-browse-select-group}).
3216 @findex gnus-browse-unsubscribe-current-group
3217 Unsubscribe to the current group, or, as will be the case here,
3218 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3224 @findex gnus-browse-exit
3225 Exit browse mode (@code{gnus-browse-exit}).
3229 @findex gnus-browse-describe-briefly
3230 Describe browse mode briefly (well, there's not much to describe, is
3231 there) (@code{gnus-browse-describe-briefly}).
3236 @section Exiting Gnus
3237 @cindex exiting Gnus
3239 Yes, Gnus is ex(c)iting.
3244 @findex gnus-group-suspend
3245 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
3246 but it kills all buffers except the Group buffer. I'm not sure why this
3247 is a gain, but then who am I to judge?
3251 @findex gnus-group-exit
3252 @c @icon{gnus-group-exit}
3253 Quit Gnus (@code{gnus-group-exit}).
3257 @findex gnus-group-quit
3258 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3259 The dribble file will be saved, though (@pxref{Auto Save}).
3262 @vindex gnus-exit-gnus-hook
3263 @vindex gnus-suspend-gnus-hook
3264 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
3265 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
3266 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3271 If you wish to completely unload Gnus and all its adherents, you can use
3272 the @code{gnus-unload} command. This command is also very handy when
3273 trying to customize meta-variables.
3278 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3279 numbly heavy and herself fall into a hazy trance as the boy sitting
3280 behind her drew repeated lines with his pencil across the back of her
3286 @section Group Topics
3289 If you read lots and lots of groups, it might be convenient to group
3290 them hierarchically according to topics. You put your Emacs groups over
3291 here, your sex groups over there, and the rest (what, two groups or so?)
3292 you put in some misc section that you never bother with anyway. You can
3293 even group the Emacs sex groups as a sub-topic to either the Emacs
3294 groups or the sex groups---or both! Go wild!
3298 \gnusfigure{Group Topics}{400}{
3299 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
3310 2: alt.religion.emacs
3313 0: comp.talk.emacs.recovery
3315 8: comp.binaries.fractals
3316 13: comp.sources.unix
3319 @findex gnus-topic-mode
3321 To get this @emph{fab} functionality you simply turn on (ooh!) the
3322 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3323 is a toggling command.)
3325 Go ahead, just try it. I'll still be here when you get back. La de
3326 dum... Nice tune, that... la la la... What, you're back? Yes, and now
3327 press @kbd{l}. There. All your groups are now listed under
3328 @samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and
3331 If you want this permanently enabled, you should add that minor mode to
3332 the hook for the group mode:
3335 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3339 * Topic Variables:: How to customize the topics the Lisp Way.
3340 * Topic Commands:: Interactive E-Z commands.
3341 * Topic Sorting:: Sorting each topic individually.
3342 * Topic Topology:: A map of the world.
3343 * Topic Parameters:: Parameters that apply to all groups in a topic.
3347 @node Topic Variables
3348 @subsection Topic Variables
3349 @cindex topic variables
3351 Now, if you select a topic, it will fold/unfold that topic, which is
3352 really neat, I think.
3354 @vindex gnus-topic-line-format
3355 The topic lines themselves are created according to the
3356 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3369 Number of groups in the topic.
3371 Number of unread articles in the topic.
3373 Number of unread articles in the topic and all its subtopics.
3376 @vindex gnus-topic-indent-level
3377 Each sub-topic (and the groups in the sub-topics) will be indented with
3378 @code{gnus-topic-indent-level} times the topic level number of spaces.
3381 @vindex gnus-topic-mode-hook
3382 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3384 @vindex gnus-topic-display-empty-topics
3385 The @code{gnus-topic-display-empty-topics} says whether to display even
3386 topics that have no unread articles in them. The default is @code{t}.
3389 @node Topic Commands
3390 @subsection Topic Commands
3391 @cindex topic commands
3393 When the topic minor mode is turned on, a new @kbd{T} submap will be
3394 available. In addition, a few of the standard keys change their
3395 definitions slightly.
3401 @findex gnus-topic-create-topic
3402 Prompt for a new topic name and create it
3403 (@code{gnus-topic-create-topic}).
3407 @findex gnus-topic-move-group
3408 Move the current group to some other topic
3409 (@code{gnus-topic-move-group}). This command uses the process/prefix
3410 convention (@pxref{Process/Prefix}).
3414 @findex gnus-topic-jump-to-topic
3415 Go to a topic (@code{gnus-topic-jump-to-topic}).
3419 @findex gnus-topic-copy-group
3420 Copy the current group to some other topic
3421 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3422 convention (@pxref{Process/Prefix}).
3426 @findex gnus-topic-hide-topic
3427 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3428 a prefix, hide the topic permanently.
3432 @findex gnus-topic-show-topic
3433 Show the current topic (@code{gnus-topic-show-topic}). If given
3434 a prefix, show the topic permanently.
3438 @findex gnus-topic-remove-group
3439 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3440 This command is mainly useful if you have the same group in several
3441 topics and wish to remove it from one of the topics. You may also
3442 remove a group from all topics, but in that case, Gnus will add it to
3443 the root topic the next time you start Gnus. In fact, all new groups
3444 (which, naturally, don't belong to any topic) will show up in the root
3447 This command uses the process/prefix convention
3448 (@pxref{Process/Prefix}).
3452 @findex gnus-topic-move-matching
3453 Move all groups that match some regular expression to a topic
3454 (@code{gnus-topic-move-matching}).
3458 @findex gnus-topic-copy-matching
3459 Copy all groups that match some regular expression to a topic
3460 (@code{gnus-topic-copy-matching}).
3464 @findex gnus-topic-toggle-display-empty-topics
3465 Toggle hiding empty topics
3466 (@code{gnus-topic-toggle-display-empty-topics}).
3470 @findex gnus-topic-mark-topic
3471 Mark all groups in the current topic with the process mark
3472 (@code{gnus-topic-mark-topic}).
3475 @kindex T M-# (Topic)
3476 @findex gnus-topic-unmark-topic
3477 Remove the process mark from all groups in the current topic
3478 (@code{gnus-topic-unmark-topic}).
3482 @kindex T TAB (Topic)
3484 @findex gnus-topic-indent
3485 ``Indent'' the current topic so that it becomes a sub-topic of the
3486 previous topic (@code{gnus-topic-indent}). If given a prefix,
3487 ``un-indent'' the topic instead.
3490 @kindex M-TAB (Topic)
3491 @findex gnus-topic-unindent
3492 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3493 parent of its current parent (@code{gnus-topic-unindent}).
3497 @findex gnus-topic-select-group
3499 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3500 When you perform this command on a group, you'll enter the group, as
3501 usual. When done on a topic line, the topic will be folded (if it was
3502 visible) or unfolded (if it was folded already). So it's basically a
3503 toggling command on topics. In addition, if you give a numerical
3504 prefix, group on that level (and lower) will be displayed.
3507 @kindex C-c C-x (Topic)
3508 @findex gnus-topic-expire-articles
3509 Run all expirable articles in the current group or topic through the
3510 expiry process (if any)
3511 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3515 @findex gnus-topic-kill-group
3516 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3517 topic will be removed along with the topic.
3521 @findex gnus-topic-yank-group
3522 Yank the previously killed group or topic
3523 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3528 @findex gnus-topic-rename
3529 Rename a topic (@code{gnus-topic-rename}).
3532 @kindex T DEL (Topic)
3533 @findex gnus-topic-delete
3534 Delete an empty topic (@code{gnus-topic-delete}).
3538 @findex gnus-topic-list-active
3539 List all groups that Gnus knows about in a topics-ified way
3540 (@code{gnus-topic-list-active}).
3544 @findex gnus-topic-edit-parameters
3545 @cindex group parameters
3546 @cindex topic parameters
3548 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3549 @xref{Topic Parameters}.
3555 @subsection Topic Sorting
3556 @cindex topic sorting
3558 You can sort the groups in each topic individually with the following
3564 @kindex T S a (Topic)
3565 @findex gnus-topic-sort-groups-by-alphabet
3566 Sort the current topic alphabetically by group name
3567 (@code{gnus-topic-sort-groups-by-alphabet}).
3570 @kindex T S u (Topic)
3571 @findex gnus-topic-sort-groups-by-unread
3572 Sort the current topic by the number of unread articles
3573 (@code{gnus-topic-sort-groups-by-unread}).
3576 @kindex T S l (Topic)
3577 @findex gnus-topic-sort-groups-by-level
3578 Sort the current topic by group level
3579 (@code{gnus-topic-sort-groups-by-level}).
3582 @kindex T S v (Topic)
3583 @findex gnus-topic-sort-groups-by-score
3584 Sort the current topic by group score
3585 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
3588 @kindex T S r (Topic)
3589 @findex gnus-topic-sort-groups-by-rank
3590 Sort the current topic by group rank
3591 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
3594 @kindex T S m (Topic)
3595 @findex gnus-topic-sort-groups-by-method
3596 Sort the current topic alphabetically by backend name
3597 (@code{gnus-topic-sort-groups-by-method}).
3601 @xref{Sorting Groups}, for more information about group sorting.
3604 @node Topic Topology
3605 @subsection Topic Topology
3606 @cindex topic topology
3609 So, let's have a look at an example group buffer:
3615 2: alt.religion.emacs
3618 0: comp.talk.emacs.recovery
3620 8: comp.binaries.fractals
3621 13: comp.sources.unix
3624 So, here we have one top-level topic (@samp{Gnus}), two topics under
3625 that, and one sub-topic under one of the sub-topics. (There is always
3626 just one (1) top-level topic). This topology can be expressed as
3631 (("Emacs -- I wuw it!" visible)
3632 (("Naughty Emacs" visible)))
3636 @vindex gnus-topic-topology
3637 This is in fact how the variable @code{gnus-topic-topology} would look
3638 for the display above. That variable is saved in the @file{.newsrc.eld}
3639 file, and shouldn't be messed with manually---unless you really want
3640 to. Since this variable is read from the @file{.newsrc.eld} file,
3641 setting it in any other startup files will have no effect.
3643 This topology shows what topics are sub-topics of what topics (right),
3644 and which topics are visible. Two settings are currently
3645 allowed---@code{visible} and @code{invisible}.
3648 @node Topic Parameters
3649 @subsection Topic Parameters
3650 @cindex topic parameters
3652 All groups in a topic will inherit group parameters from the parent (and
3653 ancestor) topic parameters. All valid group parameters are valid topic
3654 parameters (@pxref{Group Parameters}).
3656 In addition, the following parameters are only valid as topic
3661 When subscribing new groups by topic (@pxref{Subscription Methods}), the
3662 @code{subscribe} topic parameter says what groups go in what topic. Its
3663 value should be a regexp to match the groups that should go in that
3668 Group parameters (of course) override topic parameters, and topic
3669 parameters in sub-topics override topic parameters in super-topics. You
3670 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
3671 verb, although you may feel free to disagree with me here.)
3677 2: alt.religion.emacs
3681 0: comp.talk.emacs.recovery
3683 8: comp.binaries.fractals
3684 13: comp.sources.unix
3688 The @samp{Emacs} topic has the topic parameter @code{(score-file
3689 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
3690 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
3691 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
3692 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
3693 . "religion.SCORE")}.
3695 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
3696 will get the @file{relief.SCORE} home score file. If you enter the same
3697 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
3698 score file. If you enter the group @samp{alt.religion.emacs}, you'll
3699 get the @file{religion.SCORE} home score file.
3701 This seems rather simple and self-evident, doesn't it? Well, yes. But
3702 there are some problems, especially with the @code{total-expiry}
3703 parameter. Say you have a mail group in two topics; one with
3704 @code{total-expiry} and one without. What happens when you do @kbd{M-x
3705 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
3706 of these topics you mean to expire articles from, so anything may
3707 happen. In fact, I hereby declare that it is @dfn{undefined} what
3708 happens. You just have to be careful if you do stuff like that.
3711 @node Misc Group Stuff
3712 @section Misc Group Stuff
3715 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
3716 * Group Information:: Information and help on groups and Gnus.
3717 * Group Timestamp:: Making Gnus keep track of when you last read a group.
3718 * File Commands:: Reading and writing the Gnus files.
3725 @findex gnus-group-enter-server-mode
3726 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3727 @xref{Server Buffer}.
3731 @findex gnus-group-post-news
3732 Post an article to a group (@code{gnus-group-post-news}). If given a
3733 prefix, the current group name will be used as the default.
3737 @findex gnus-group-mail
3738 Mail a message somewhere (@code{gnus-group-mail}).
3742 Variables for the group buffer:
3746 @item gnus-group-mode-hook
3747 @vindex gnus-group-mode-hook
3748 is called after the group buffer has been
3751 @item gnus-group-prepare-hook
3752 @vindex gnus-group-prepare-hook
3753 is called after the group buffer is
3754 generated. It may be used to modify the buffer in some strange,
3757 @item gnus-group-prepared-hook
3758 @vindex gnus-group-prepare-hook
3759 is called as the very last thing after the group buffer has been
3760 generated. It may be used to move point around, for instance.
3762 @item gnus-permanently-visible-groups
3763 @vindex gnus-permanently-visible-groups
3764 Groups matching this regexp will always be listed in the group buffer,
3765 whether they are empty or not.
3767 @item gnus-group-name-charset-method-alist
3768 @vindex gnus-group-name-charset-method-alist
3769 An alist of method and the charset for group names. It is used to show
3770 non-ASCII group names.
3774 (setq gnus-group-name-charset-method-alist
3775 '(((nntp "news.com.cn") . cn-gb-2312)))
3778 @item gnus-group-name-charset-group-alist
3779 @vindex gnus-group-name-charset-group-alist
3780 An alist of regexp of group name and the charset for group names.
3781 It is used to show non-ASCII group names.
3785 (setq gnus-group-name-charset-group-alist
3786 '(("\\.com\\.cn:" . cn-gb-2312)))
3791 @node Scanning New Messages
3792 @subsection Scanning New Messages
3793 @cindex new messages
3794 @cindex scanning new news
3800 @findex gnus-group-get-new-news
3801 @c @icon{gnus-group-get-new-news}
3802 Check the server(s) for new articles. If the numerical prefix is used,
3803 this command will check only groups of level @var{arg} and lower
3804 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
3805 command will force a total re-reading of the active file(s) from the
3810 @findex gnus-group-get-new-news-this-group
3811 @vindex gnus-goto-next-group-when-activating
3812 @c @icon{gnus-group-get-new-news-this-group}
3813 Check whether new articles have arrived in the current group
3814 (@code{gnus-group-get-new-news-this-group}).
3815 @code{gnus-goto-next-group-when-activating} says whether this command is
3816 to move point to the next group or not. It is @code{t} by default.
3818 @findex gnus-activate-all-groups
3819 @cindex activating groups
3821 @kindex C-c M-g (Group)
3822 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3827 @findex gnus-group-restart
3828 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
3829 file(s), closes the connection to all servers, clears up all run-time
3830 Gnus variables, and then starts Gnus all over again.
3834 @vindex gnus-get-new-news-hook
3835 @code{gnus-get-new-news-hook} is run just before checking for new news.
3837 @vindex gnus-after-getting-new-news-hook
3838 @code{gnus-after-getting-new-news-hook} is run after checking for new
3842 @node Group Information
3843 @subsection Group Information
3844 @cindex group information
3845 @cindex information on groups
3852 @findex gnus-group-fetch-faq
3853 @vindex gnus-group-faq-directory
3856 Try to fetch the FAQ for the current group
3857 (@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from
3858 @code{gnus-group-faq-directory}, which is usually a directory on a
3859 remote machine. This variable can also be a list of directories. In
3860 that case, giving a prefix to this command will allow you to choose
3861 between the various sites. @code{ange-ftp} (or @code{efs}) will be used
3862 for fetching the file.
3864 If fetching from the first site is unsuccessful, Gnus will attempt to go
3865 through @code{gnus-group-faq-directory} and try to open them one by one.
3869 @c @icon{gnus-group-describe-group}
3871 @kindex C-c C-d (Group)
3872 @cindex describing groups
3873 @cindex group description
3874 @findex gnus-group-describe-group
3875 Describe the current group (@code{gnus-group-describe-group}). If given
3876 a prefix, force Gnus to re-read the description from the server.
3880 @findex gnus-group-describe-all-groups
3881 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
3882 prefix, force Gnus to re-read the description file from the server.
3889 @findex gnus-version
3890 Display current Gnus version numbers (@code{gnus-version}).
3894 @findex gnus-group-describe-briefly
3895 Give a very short help message (@code{gnus-group-describe-briefly}).
3898 @kindex C-c C-i (Group)
3901 @findex gnus-info-find-node
3902 Go to the Gnus info node (@code{gnus-info-find-node}).
3906 @node Group Timestamp
3907 @subsection Group Timestamp
3909 @cindex group timestamps
3911 It can be convenient to let Gnus keep track of when you last read a
3912 group. To set the ball rolling, you should add
3913 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3916 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3919 After doing this, each time you enter a group, it'll be recorded.
3921 This information can be displayed in various ways---the easiest is to
3922 use the @samp{%d} spec in the group line format:
3925 (setq gnus-group-line-format
3926 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3929 This will result in lines looking like:
3932 * 0: mail.ding 19961002T012943
3933 0: custom 19961002T012713
3936 As you can see, the date is displayed in compact ISO 8601 format. This
3937 may be a bit too much, so to just display the date, you could say
3941 (setq gnus-group-line-format
3942 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3947 @subsection File Commands
3948 @cindex file commands
3954 @findex gnus-group-read-init-file
3955 @vindex gnus-init-file
3956 @cindex reading init file
3957 Re-read the init file (@code{gnus-init-file}, which defaults to
3958 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3962 @findex gnus-group-save-newsrc
3963 @cindex saving .newsrc
3964 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3965 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
3966 file(s) whether Gnus thinks it is necessary or not.
3969 @c @kindex Z (Group)
3970 @c @findex gnus-group-clear-dribble
3971 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3976 @node Summary Buffer
3977 @chapter Summary Buffer
3978 @cindex summary buffer
3980 A line for each article is displayed in the summary buffer. You can
3981 move around, read articles, post articles and reply to articles.
3983 The most common way to a summary buffer is to select a group from the
3984 group buffer (@pxref{Selecting a Group}).
3986 You can have as many summary buffers open as you wish.
3989 * Summary Buffer Format:: Deciding how the summary buffer is to look.
3990 * Summary Maneuvering:: Moving around the summary buffer.
3991 * Choosing Articles:: Reading articles.
3992 * Paging the Article:: Scrolling the current article.
3993 * Reply Followup and Post:: Posting articles.
3994 * Delayed Articles::
3995 * Marking Articles:: Marking articles as read, expirable, etc.
3996 * Limiting:: You can limit the summary buffer.
3997 * Threading:: How threads are made.
3998 * Sorting the Summary Buffer:: How articles and threads are sorted.
3999 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
4000 * Article Caching:: You may store articles in a cache.
4001 * Persistent Articles:: Making articles expiry-resistant.
4002 * Article Backlog:: Having already read articles hang around.
4003 * Saving Articles:: Ways of customizing article saving.
4004 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
4005 * Article Treatment:: The article buffer can be mangled at will.
4006 * MIME Commands:: Doing MIMEy things with the articles.
4007 * Charsets:: Character set issues.
4008 * Article Commands:: Doing various things with the article buffer.
4009 * Summary Sorting:: Sorting the summary buffer in various ways.
4010 * Finding the Parent:: No child support? Get the parent.
4011 * Alternative Approaches:: Reading using non-default summaries.
4012 * Tree Display:: A more visual display of threads.
4013 * Mail Group Commands:: Some commands can only be used in mail groups.
4014 * Various Summary Stuff:: What didn't fit anywhere else.
4015 * Exiting the Summary Buffer:: Returning to the Group buffer,
4016 or reselecting the current group.
4017 * Crosspost Handling:: How crossposted articles are dealt with.
4018 * Duplicate Suppression:: An alternative when crosspost handling fails.
4019 * Security:: Decrypt and Verify.
4020 * Mailing List:: Mailing list minor mode.
4024 @node Summary Buffer Format
4025 @section Summary Buffer Format
4026 @cindex summary buffer format
4030 \gnusfigure{The Summary Buffer}{180}{
4031 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
4032 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
4038 * Summary Buffer Lines:: You can specify how summary lines should look.
4039 * To From Newsgroups:: How to not display your own name.
4040 * Summary Buffer Mode Line:: You can say how the mode line should look.
4041 * Summary Highlighting:: Making the summary buffer all pretty and nice.
4044 @findex mail-extract-address-components
4045 @findex gnus-extract-address-components
4046 @vindex gnus-extract-address-components
4047 Gnus will use the value of the @code{gnus-extract-address-components}
4048 variable as a function for getting the name and address parts of a
4049 @code{From} header. Two pre-defined functions exist:
4050 @code{gnus-extract-address-components}, which is the default, quite
4051 fast, and too simplistic solution; and
4052 @code{mail-extract-address-components}, which works very nicely, but is
4053 slower. The default function will return the wrong answer in 5% of the
4054 cases. If this is unacceptable to you, use the other function instead:
4057 (setq gnus-extract-address-components
4058 'mail-extract-address-components)
4061 @vindex gnus-summary-same-subject
4062 @code{gnus-summary-same-subject} is a string indicating that the current
4063 article has the same subject as the previous. This string will be used
4064 with those specs that require it. The default is @code{""}.
4067 @node Summary Buffer Lines
4068 @subsection Summary Buffer Lines
4070 @vindex gnus-summary-line-format
4071 You can change the format of the lines in the summary buffer by changing
4072 the @code{gnus-summary-line-format} variable. It works along the same
4073 lines as a normal @code{format} string, with some extensions
4074 (@pxref{Formatting Variables}).
4076 There should always be a colon or a point position marker on the line;
4077 the cursor always moves to the point position marker or the colon after
4078 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
4079 possible to change this. Just write a new function
4080 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4082 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23n%]%) %s\n}.
4084 The following format specification characters are understood:
4090 Subject string. List identifiers stripped,
4091 @code{gnus-list-identifies}. @xref{Article Hiding}.
4093 Subject if the article is the root of the thread or the previous article
4094 had a different subject, @code{gnus-summary-same-subject} otherwise.
4095 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4097 Full @code{From} header.
4099 The name (from the @code{From} header).
4101 The name, code @code{To} header or the @code{Newsgroups} header
4102 (@pxref{To From Newsgroups}).
4104 The name (from the @code{From} header). This differs from the @code{n}
4105 spec in that it uses the function designated by the
4106 @code{gnus-extract-address-components} variable, which is slower, but
4107 may be more thorough.
4109 The address (from the @code{From} header). This works the same way as
4112 Number of lines in the article.
4114 Number of characters in the article. This specifier is not supported
4115 in some methods (like nnfolder).
4117 Indentation based on thread level (@pxref{Customizing Threading}).
4119 A complex trn-style thread tree, showing response-connecting trace
4122 Nothing if the article is a root and lots of spaces if it isn't (it
4123 pushes everything after it off the screen).
4125 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4126 for adopted articles (@pxref{Customizing Threading}).
4128 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4129 for adopted articles.
4131 One space for each thread level.
4133 Twenty minus thread level spaces.
4138 This misleadingly named specifier is the @dfn{secondary mark}. This
4139 mark will say whether the article has been replied to, has been cached,
4143 Score as a number (@pxref{Scoring}).
4145 @vindex gnus-summary-zcore-fuzz
4146 Zcore, @samp{+} if above the default level and @samp{-} if below the
4147 default level. If the difference between
4148 @code{gnus-summary-default-score} and the score is less than
4149 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4157 The @code{Date} in @code{DD-MMM} format.
4159 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4165 Number of articles in the current sub-thread. Using this spec will slow
4166 down summary buffer generation somewhat.
4168 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4169 article has any children.
4175 User defined specifier. The next character in the format string should
4176 be a letter. Gnus will call the function
4177 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
4178 following @samp{%u}. The function will be passed the current header as
4179 argument. The function should return a string, which will be inserted
4180 into the summary just like information from any other summary specifier.
4183 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4184 have to be handled with care. For reasons of efficiency, Gnus will
4185 compute what column these characters will end up in, and ``hard-code''
4186 that. This means that it is invalid to have these specs after a
4187 variable-length spec. Well, you might not be arrested, but your summary
4188 buffer will look strange, which is bad enough.
4190 The smart choice is to have these specs as far to the left as possible.
4191 (Isn't that the case with everything, though? But I digress.)
4193 This restriction may disappear in later versions of Gnus.
4196 @node To From Newsgroups
4197 @subsection To From Newsgroups
4201 In some groups (particularly in archive groups), the @code{From} header
4202 isn't very interesting, since all the articles there are written by
4203 you. To display the information in the @code{To} or @code{Newsgroups}
4204 headers instead, you need to decide three things: What information to
4205 gather; where to display it; and when to display it.
4209 @vindex gnus-extra-headers
4210 The reading of extra header information is controlled by the
4211 @code{gnus-extra-headers}. This is a list of header symbols. For
4215 (setq gnus-extra-headers
4216 '(To Newsgroups X-Newsreader))
4219 This will result in Gnus trying to obtain these three headers, and
4220 storing it in header structures for later easy retrieval.
4223 @findex gnus-extra-header
4224 The value of these extra headers can be accessed via the
4225 @code{gnus-extra-header} function. Here's a format line spec that will
4226 access the @code{X-Newsreader} header:
4229 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4233 @vindex gnus-ignored-from-addresses
4234 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4235 summary line spec returns the @code{To}, @code{Newsreader} or
4236 @code{From} header. If this regexp matches the contents of the
4237 @code{From} header, the value of the @code{To} or @code{Newsreader}
4238 headers are used instead.
4242 @vindex nnmail-extra-headers
4243 A related variable is @code{nnmail-extra-headers}, which controls when
4244 to include extra headers when generating overview (@sc{nov}) files. If
4245 you have old overview files, you should regenerate them after changing
4248 @vindex gnus-summary-line-format
4249 You also have to instruct Gnus to display the data by changing the
4250 @code{%n} spec to the @code{%f} spec in the
4251 @code{gnus-summary-line-format} variable.
4253 In summary, you'd typically put something like the following in
4257 (setq gnus-extra-headers
4259 (setq nnmail-extra-headers gnus-extra-headers)
4260 (setq gnus-summary-line-format
4261 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
4262 (setq gnus-ignored-from-addresses
4266 Now, this is mostly useful for mail groups, where you have control over
4267 the @sc{nov} files that are created. However, if you can persuade your
4274 to the end of her @file{overview.fmt} file, then you can use that just
4275 as you would the extra headers from the mail groups.
4278 @node Summary Buffer Mode Line
4279 @subsection Summary Buffer Mode Line
4281 @vindex gnus-summary-mode-line-format
4282 You can also change the format of the summary mode bar (@pxref{Mode Line
4283 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
4284 like. The default is @samp{Gnus: %%b [%A] %Z}.
4286 Here are the elements you can play with:
4292 Unprefixed group name.
4294 Current article number.
4296 Current article score.
4300 Number of unread articles in this group.
4302 Number of unread articles in this group that aren't displayed in the
4305 A string with the number of unread and unselected articles represented
4306 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4307 articles, and just as @samp{<%U more>} if there are just unread articles
4308 and no unselected ones.
4310 Shortish group name. For instance, @samp{rec.arts.anime} will be
4311 shortened to @samp{r.a.anime}.
4313 Subject of the current article.
4315 User-defined spec (@pxref{User-Defined Specs}).
4317 Name of the current score file (@pxref{Scoring}).
4319 Number of dormant articles (@pxref{Unread Articles}).
4321 Number of ticked articles (@pxref{Unread Articles}).
4323 Number of articles that have been marked as read in this session.
4325 Number of articles expunged by the score files.
4329 @node Summary Highlighting
4330 @subsection Summary Highlighting
4334 @item gnus-visual-mark-article-hook
4335 @vindex gnus-visual-mark-article-hook
4336 This hook is run after selecting an article. It is meant to be used for
4337 highlighting the article in some way. It is not run if
4338 @code{gnus-visual} is @code{nil}.
4340 @item gnus-summary-update-hook
4341 @vindex gnus-summary-update-hook
4342 This hook is called when a summary line is changed. It is not run if
4343 @code{gnus-visual} is @code{nil}.
4345 @item gnus-summary-selected-face
4346 @vindex gnus-summary-selected-face
4347 This is the face (or @dfn{font} as some people call it) used to
4348 highlight the current article in the summary buffer.
4350 @item gnus-summary-highlight
4351 @vindex gnus-summary-highlight
4352 Summary lines are highlighted according to this variable, which is a
4353 list where the elements are of the format @code{(@var{form}
4354 . @var{face})}. If you would, for instance, like ticked articles to be
4355 italic and high-scored articles to be bold, you could set this variable
4358 (((eq mark gnus-ticked-mark) . italic)
4359 ((> score default) . bold))
4361 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4362 @var{face} will be applied to the line.
4366 @node Summary Maneuvering
4367 @section Summary Maneuvering
4368 @cindex summary movement
4370 All the straight movement commands understand the numeric prefix and
4371 behave pretty much as you'd expect.
4373 None of these commands select articles.
4378 @kindex M-n (Summary)
4379 @kindex G M-n (Summary)
4380 @findex gnus-summary-next-unread-subject
4381 Go to the next summary line of an unread article
4382 (@code{gnus-summary-next-unread-subject}).
4386 @kindex M-p (Summary)
4387 @kindex G M-p (Summary)
4388 @findex gnus-summary-prev-unread-subject
4389 Go to the previous summary line of an unread article
4390 (@code{gnus-summary-prev-unread-subject}).
4393 @kindex G g (Summary)
4394 @findex gnus-summary-goto-subject
4395 Ask for an article number and then go to the summary line of that article
4396 without displaying the article (@code{gnus-summary-goto-subject}).
4399 If Gnus asks you to press a key to confirm going to the next group, you
4400 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4401 buffer, searching for the next group to read without actually returning
4402 to the group buffer.
4404 Variables related to summary movement:
4408 @vindex gnus-auto-select-next
4409 @item gnus-auto-select-next
4410 If you issue one of the movement commands (like @kbd{n}) and there are
4411 no more unread articles after the current one, Gnus will offer to go to
4412 the next group. If this variable is @code{t} and the next group is
4413 empty, Gnus will exit summary mode and return to the group buffer. If
4414 this variable is neither @code{t} nor @code{nil}, Gnus will select the
4415 next group, no matter whether it has any unread articles or not. As a
4416 special case, if this variable is @code{quietly}, Gnus will select the
4417 next group without asking for confirmation. If this variable is
4418 @code{almost-quietly}, the same will happen only if you are located on
4419 the last article in the group. Finally, if this variable is
4420 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
4421 without confirmation. Also @pxref{Group Levels}.
4423 @item gnus-auto-select-same
4424 @vindex gnus-auto-select-same
4425 If non-@code{nil}, all the movement commands will try to go to the next
4426 article with the same subject as the current. (@dfn{Same} here might
4427 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
4428 for details (@pxref{Customizing Threading}).) If there are no more
4429 articles with the same subject, go to the first unread article.
4431 This variable is not particularly useful if you use a threaded display.
4433 @item gnus-summary-check-current
4434 @vindex gnus-summary-check-current
4435 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4436 to the next (or previous) article if the current article is unread.
4437 Instead, they will choose the current article.
4439 @item gnus-auto-center-summary
4440 @vindex gnus-auto-center-summary
4441 If non-@code{nil}, Gnus will keep the point in the summary buffer
4442 centered at all times. This makes things quite tidy, but if you have a
4443 slow network connection, or simply do not like this un-Emacsism, you can
4444 set this variable to @code{nil} to get the normal Emacs scrolling
4445 action. This will also inhibit horizontal re-centering of the summary
4446 buffer, which might make it more inconvenient to read extremely long
4449 This variable can also be a number. In that case, center the window at
4450 the given number of lines from the top.
4455 @node Choosing Articles
4456 @section Choosing Articles
4457 @cindex selecting articles
4460 * Choosing Commands:: Commands for choosing articles.
4461 * Choosing Variables:: Variables that influence these commands.
4465 @node Choosing Commands
4466 @subsection Choosing Commands
4468 None of the following movement commands understand the numeric prefix,
4469 and they all select and display an article.
4471 If you want to fetch new articles or redisplay the group, see
4472 @ref{Exiting the Summary Buffer}.
4476 @kindex SPACE (Summary)
4477 @findex gnus-summary-next-page
4478 Select the current article, or, if that one's read already, the next
4479 unread article (@code{gnus-summary-next-page}).
4484 @kindex G n (Summary)
4485 @findex gnus-summary-next-unread-article
4486 @c @icon{gnus-summary-next-unread}
4487 Go to next unread article (@code{gnus-summary-next-unread-article}).
4492 @findex gnus-summary-prev-unread-article
4493 @c @icon{gnus-summary-prev-unread}
4494 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
4499 @kindex G N (Summary)
4500 @findex gnus-summary-next-article
4501 Go to the next article (@code{gnus-summary-next-article}).
4506 @kindex G P (Summary)
4507 @findex gnus-summary-prev-article
4508 Go to the previous article (@code{gnus-summary-prev-article}).
4511 @kindex G C-n (Summary)
4512 @findex gnus-summary-next-same-subject
4513 Go to the next article with the same subject
4514 (@code{gnus-summary-next-same-subject}).
4517 @kindex G C-p (Summary)
4518 @findex gnus-summary-prev-same-subject
4519 Go to the previous article with the same subject
4520 (@code{gnus-summary-prev-same-subject}).
4524 @kindex G f (Summary)
4526 @findex gnus-summary-first-unread-article
4527 Go to the first unread article
4528 (@code{gnus-summary-first-unread-article}).
4532 @kindex G b (Summary)
4534 @findex gnus-summary-best-unread-article
4535 Go to the article with the highest score
4536 (@code{gnus-summary-best-unread-article}).
4541 @kindex G l (Summary)
4542 @findex gnus-summary-goto-last-article
4543 Go to the previous article read (@code{gnus-summary-goto-last-article}).
4546 @kindex G o (Summary)
4547 @findex gnus-summary-pop-article
4549 @cindex article history
4550 Pop an article off the summary history and go to this article
4551 (@code{gnus-summary-pop-article}). This command differs from the
4552 command above in that you can pop as many previous articles off the
4553 history as you like, while @kbd{l} toggles the two last read articles.
4554 For a somewhat related issue (if you use these commands a lot),
4555 @pxref{Article Backlog}.
4560 @kindex G j (Summary)
4561 @findex gnus-summary-goto-article
4562 Ask for an article number or @code{Message-ID}, and then go to that
4563 article (@code{gnus-summary-goto-article}).
4568 @node Choosing Variables
4569 @subsection Choosing Variables
4571 Some variables relevant for moving and selecting articles:
4574 @item gnus-auto-extend-newsgroup
4575 @vindex gnus-auto-extend-newsgroup
4576 All the movement commands will try to go to the previous (or next)
4577 article, even if that article isn't displayed in the Summary buffer if
4578 this variable is non-@code{nil}. Gnus will then fetch the article from
4579 the server and display it in the article buffer.
4581 @item gnus-select-article-hook
4582 @vindex gnus-select-article-hook
4583 This hook is called whenever an article is selected. By default it
4584 exposes any threads hidden under the selected article.
4586 @item gnus-mark-article-hook
4587 @vindex gnus-mark-article-hook
4588 @findex gnus-summary-mark-unread-as-read
4589 @findex gnus-summary-mark-read-and-unread-as-read
4590 @findex gnus-unread-mark
4591 This hook is called whenever an article is selected. It is intended to
4592 be used for marking articles as read. The default value is
4593 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
4594 mark of almost any article you read to @code{gnus-unread-mark}. The
4595 only articles not affected by this function are ticked, dormant, and
4596 expirable articles. If you'd instead like to just have unread articles
4597 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
4598 instead. It will leave marks like @code{gnus-low-score-mark},
4599 @code{gnus-del-mark} (and so on) alone.
4604 @node Paging the Article
4605 @section Scrolling the Article
4606 @cindex article scrolling
4611 @kindex SPACE (Summary)
4612 @findex gnus-summary-next-page
4613 Pressing @kbd{SPACE} will scroll the current article forward one page,
4614 or, if you have come to the end of the current article, will choose the
4615 next article (@code{gnus-summary-next-page}).
4618 @kindex DEL (Summary)
4619 @findex gnus-summary-prev-page
4620 Scroll the current article back one page (@code{gnus-summary-prev-page}).
4623 @kindex RET (Summary)
4624 @findex gnus-summary-scroll-up
4625 Scroll the current article one line forward
4626 (@code{gnus-summary-scroll-up}).
4629 @kindex M-RET (Summary)
4630 @findex gnus-summary-scroll-down
4631 Scroll the current article one line backward
4632 (@code{gnus-summary-scroll-down}).
4636 @kindex A g (Summary)
4638 @findex gnus-summary-show-article
4639 @vindex gnus-summary-show-article-charset-alist
4640 (Re)fetch the current article (@code{gnus-summary-show-article}). If
4641 given a prefix, fetch the current article, but don't run any of the
4642 article treatment functions. This will give you a ``raw'' article, just
4643 the way it came from the server.
4645 If given a numerical prefix, you can do semi-manual charset stuff.
4646 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
4647 encoded in the @code{cn-gb-2312} charset. If you have
4650 (setq gnus-summary-show-article-charset-alist
4655 then you can say @kbd{C-u 1 g} to get the same effect.
4660 @kindex A < (Summary)
4661 @findex gnus-summary-beginning-of-article
4662 Scroll to the beginning of the article
4663 (@code{gnus-summary-beginning-of-article}).
4668 @kindex A > (Summary)
4669 @findex gnus-summary-end-of-article
4670 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
4674 @kindex A s (Summary)
4676 @findex gnus-summary-isearch-article
4677 Perform an isearch in the article buffer
4678 (@code{gnus-summary-isearch-article}).
4682 @findex gnus-summary-select-article-buffer
4683 Select the article buffer (@code{gnus-summary-select-article-buffer}).
4688 @node Reply Followup and Post
4689 @section Reply, Followup and Post
4692 * Summary Mail Commands:: Sending mail.
4693 * Summary Post Commands:: Sending news.
4694 * Summary Message Commands:: Other Message-related commands.
4695 * Canceling and Superseding::
4699 @node Summary Mail Commands
4700 @subsection Summary Mail Commands
4702 @cindex composing mail
4704 Commands for composing a mail message:
4710 @kindex S r (Summary)
4712 @findex gnus-summary-reply
4713 @c @icon{gnus-summary-mail-reply}
4714 @c @icon{gnus-summary-reply}
4715 Mail a reply to the author of the current article
4716 (@code{gnus-summary-reply}).
4721 @kindex S R (Summary)
4722 @findex gnus-summary-reply-with-original
4723 @c @icon{gnus-summary-reply-with-original}
4724 Mail a reply to the author of the current article and include the
4725 original message (@code{gnus-summary-reply-with-original}). This
4726 command uses the process/prefix convention.
4729 @kindex S w (Summary)
4730 @findex gnus-summary-wide-reply
4731 Mail a wide reply to the author of the current article
4732 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
4733 goes out to all people listed in the @code{To}, @code{From} (or
4734 @code{Reply-to}) and @code{Cc} headers.
4737 @kindex S W (Summary)
4738 @findex gnus-summary-wide-reply-with-original
4739 Mail a wide reply to the current article and include the original
4740 message (@code{gnus-summary-wide-reply-with-original}). This command uses
4741 the process/prefix convention.
4744 @kindex S v (Summary)
4745 @findex gnus-summary-very-wide-reply
4746 Mail a very wide reply to the author of the current article
4747 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
4748 that goes out to all people listed in the @code{To}, @code{From} (or
4749 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
4750 articles. This command uses the process/prefix convention.
4754 @kindex S o m (Summary)
4755 @kindex C-c C-f (Summary)
4756 @findex gnus-summary-mail-forward
4757 @c @icon{gnus-summary-mail-forward}
4758 Forward the current article to some other person
4759 (@code{gnus-summary-mail-forward}). If no prefix is given, the message
4760 is forwarded according to the value of (@code{message-forward-as-mime})
4761 and (@code{message-forward-show-mml}); if the prefix is 1, decode the
4762 message and forward directly inline; if the prefix is 2, forward message
4763 as an rfc822 MIME section; if the prefix is 3, decode message and
4764 forward as an rfc822 MIME section; if the prefix is 4, forward message
4765 directly inline; otherwise, the message is forwarded as no prefix given
4766 but use the flipped value of (@code{message-forward-as-mime}). By
4767 default, the message is decoded and forwarded as an rfc822 MIME section.
4772 @kindex S m (Summary)
4773 @findex gnus-summary-mail-other-window
4774 @c @icon{gnus-summary-mail-originate}
4775 Send a mail to some other person
4776 (@code{gnus-summary-mail-other-window}).
4779 @kindex S D b (Summary)
4780 @findex gnus-summary-resend-bounced-mail
4781 @cindex bouncing mail
4782 If you have sent a mail, but the mail was bounced back to you for some
4783 reason (wrong address, transient failure), you can use this command to
4784 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
4785 will be popped into a mail buffer where you can edit the headers before
4786 sending the mail off again. If you give a prefix to this command, and
4787 the bounced mail is a reply to some other mail, Gnus will try to fetch
4788 that mail and display it for easy perusal of its headers. This might
4789 very well fail, though.
4792 @kindex S D r (Summary)
4793 @findex gnus-summary-resend-message
4794 Not to be confused with the previous command,
4795 @code{gnus-summary-resend-message} will prompt you for an address to
4796 send the current message off to, and then send it to that place. The
4797 headers of the message won't be altered---but lots of headers that say
4798 @code{Resent-To}, @code{Resent-From} and so on will be added. This
4799 means that you actually send a mail to someone that has a @code{To}
4800 header that (probably) points to yourself. This will confuse people.
4801 So, natcherly you'll only do that if you're really eVIl.
4803 This command is mainly used if you have several accounts and want to
4804 ship a mail to a different account of yours. (If you're both
4805 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4806 to the @code{root} account, you may want to resend it to
4807 @code{postmaster}. Ordnung muß sein!
4809 This command understands the process/prefix convention
4810 (@pxref{Process/Prefix}).
4813 @kindex S O m (Summary)
4814 @findex gnus-uu-digest-mail-forward
4815 Digest the current series (@pxref{Decoding Articles}) and forward the
4816 result using mail (@code{gnus-uu-digest-mail-forward}). This command
4817 uses the process/prefix convention (@pxref{Process/Prefix}).
4820 @kindex S M-c (Summary)
4821 @findex gnus-summary-mail-crosspost-complaint
4822 @cindex crossposting
4823 @cindex excessive crossposting
4824 Send a complaint about excessive crossposting to the author of the
4825 current article (@code{gnus-summary-mail-crosspost-complaint}).
4827 @findex gnus-crosspost-complaint
4828 This command is provided as a way to fight back against the current
4829 crossposting pandemic that's sweeping Usenet. It will compose a reply
4830 using the @code{gnus-crosspost-complaint} variable as a preamble. This
4831 command understands the process/prefix convention
4832 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
4836 Also @pxref{(message)Header Commands} for more information.
4839 @node Summary Post Commands
4840 @subsection Summary Post Commands
4842 @cindex composing news
4844 Commands for posting a news article:
4850 @kindex S p (Summary)
4851 @findex gnus-summary-post-news
4852 @c @icon{gnus-summary-post-news}
4853 Post an article to the current group
4854 (@code{gnus-summary-post-news}).
4859 @kindex S f (Summary)
4860 @findex gnus-summary-followup
4861 @c @icon{gnus-summary-followup}
4862 Post a followup to the current article (@code{gnus-summary-followup}).
4866 @kindex S F (Summary)
4868 @c @icon{gnus-summary-followup-with-original}
4869 @findex gnus-summary-followup-with-original
4870 Post a followup to the current article and include the original message
4871 (@code{gnus-summary-followup-with-original}). This command uses the
4872 process/prefix convention.
4875 @kindex S n (Summary)
4876 @findex gnus-summary-followup-to-mail
4877 Post a followup to the current article via news, even if you got the
4878 message through mail (@code{gnus-summary-followup-to-mail}).
4881 @kindex S N (Summary)
4882 @findex gnus-summary-followup-to-mail-with-original
4883 Post a followup to the current article via news, even if you got the
4884 message through mail and include the original message
4885 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
4886 the process/prefix convention.
4889 @kindex S o p (Summary)
4890 @findex gnus-summary-post-forward
4891 Forward the current article to a newsgroup
4892 (@code{gnus-summary-post-forward}).
4893 If no prefix is given, the message is forwarded according to the value
4894 of (@code{message-forward-as-mime}) and
4895 (@code{message-forward-show-mml}); if the prefix is 1, decode the
4896 message and forward directly inline; if the prefix is 2, forward message
4897 as an rfc822 MIME section; if the prefix is 3, decode message and
4898 forward as an rfc822 MIME section; if the prefix is 4, forward message
4899 directly inline; otherwise, the message is forwarded as no prefix given
4900 but use the flipped value of (@code{message-forward-as-mime}). By
4901 default, the message is decoded and forwarded as an rfc822 MIME section.
4904 @kindex S O p (Summary)
4905 @findex gnus-uu-digest-post-forward
4907 @cindex making digests
4908 Digest the current series and forward the result to a newsgroup
4909 (@code{gnus-uu-digest-mail-forward}). This command uses the
4910 process/prefix convention.
4913 @kindex S u (Summary)
4914 @findex gnus-uu-post-news
4915 @c @icon{gnus-uu-post-news}
4916 Uuencode a file, split it into parts, and post it as a series
4917 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
4920 Also @pxref{(message)Header Commands} for more information.
4923 @node Summary Message Commands
4924 @subsection Summary Message Commands
4928 @kindex S y (Summary)
4929 @findex gnus-summary-yank-message
4930 Yank the current article into an already existing Message composition
4931 buffer (@code{gnus-summary-yank-message}). This command prompts for
4932 what message buffer you want to yank into, and understands the
4933 process/prefix convention (@pxref{Process/Prefix}).
4938 @node Canceling and Superseding
4939 @subsection Canceling Articles
4940 @cindex canceling articles
4941 @cindex superseding articles
4943 Have you ever written something, and then decided that you really,
4944 really, really wish you hadn't posted that?
4946 Well, you can't cancel mail, but you can cancel posts.
4948 @findex gnus-summary-cancel-article
4950 @c @icon{gnus-summary-cancel-article}
4951 Find the article you wish to cancel (you can only cancel your own
4952 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
4953 c} (@code{gnus-summary-cancel-article}). Your article will be
4954 canceled---machines all over the world will be deleting your article.
4955 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4957 Be aware, however, that not all sites honor cancels, so your article may
4958 live on here and there, while most sites will delete the article in
4961 Gnus will use the ``current'' select method when canceling. If you
4962 want to use the standard posting method, use the @samp{a} symbolic
4963 prefix (@pxref{Symbolic Prefixes}).
4965 If you discover that you have made some mistakes and want to do some
4966 corrections, you can post a @dfn{superseding} article that will replace
4967 your original article.
4969 @findex gnus-summary-supersede-article
4971 Go to the original article and press @kbd{S s}
4972 (@code{gnus-summary-supersede-article}). You will be put in a buffer
4973 where you can edit the article all you want before sending it off the
4976 The same goes for superseding as for canceling, only more so: Some
4977 sites do not honor superseding. On those sites, it will appear that you
4978 have posted almost the same article twice.
4980 If you have just posted the article, and change your mind right away,
4981 there is a trick you can use to cancel/supersede the article without
4982 waiting for the article to appear on your site first. You simply return
4983 to the post buffer (which is called @code{*sent ...*}). There you will
4984 find the article you just posted, with all the headers intact. Change
4985 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4986 header by substituting one of those words for the word
4987 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
4988 you would do normally. The previous article will be
4989 canceled/superseded.
4991 Just remember, kids: There is no 'c' in 'supersede'.
4993 @node Delayed Articles
4994 @section Delayed Articles
4995 @cindex delayed sending
4996 @cindex send delayed
4998 Sometimes, you might wish to delay the sending of a message. For
4999 example, you might wish to arrange for a message to turn up just in time
5000 to remind your about the birthday of your Significant Other. For this,
5001 there is the @code{gnus-delay} package. Setup is simple:
5004 (gnus-delay-initialize)
5007 @findex gnus-delay-article
5008 Normally, to send a message you use the @kbd{C-c C-c} command from
5009 Message mode. To delay a message, use @kbd{C-c C-j}
5010 (@code{gnus-delay-article}) instead. This will ask you for how long the
5011 message should be delayed. Possible answers are:
5015 A time span. Consists of an integer and a letter. For example,
5016 @code{42d} means to delay for 42 days. Available letters are @code{m}
5017 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5018 (months) and @code{Y} (years).
5021 A specific date. Looks like @code{YYYYY-MM-DD}. The message will be
5022 delayed until that day, at a specific time (eight o'clock by default).
5023 See also @code{gnus-delay-default-hour}.
5026 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
5027 stuff. The deadline will be at that time today, except if that time has
5028 already passed, then it's at the given time tomorrow. So if it's ten
5029 o'clock in the morning and you specify @code{11:15}, then the deadline
5030 is one hour and fifteen minutes hence. But if you specify @code{9:20},
5031 that means a time tomorrow.
5034 The action of the @code{gnus-delay-article} command is influenced by a
5035 couple of variables:
5038 @item gnus-delay-default-hour
5039 @vindex gnus-delay-default-hour
5040 When you specify a specific date, the message will be due on that hour
5041 on the given date. Possible values are integers 0 through 23.
5043 @item gnus-delay-default-delay
5044 @vindex gnus-delay-default-delay
5045 This is a string and gives the default delay. It can be of any of the
5046 formats described above.
5048 @item gnus-delay-group
5049 @vindex gnus-delay-group
5050 Delayed articles will be kept in this group on the drafts server until
5051 they are due. You probably don't need to change this. The default
5052 value is @code{"delayed"}.
5054 @item gnus-delay-header
5055 @vindex gnus-delay-header
5056 The deadline for each article will be stored in a header. This variable
5057 is a string and gives the header name. You probably don't need to
5058 change this. The default value is @code{"X-Gnus-Delayed"}.
5061 The way delaying works is like this: when you use the
5062 @code{gnus-delay-article} command, you give a certain delay. Gnus
5063 calculates the deadline of the message and stores it in the
5064 @code{X-Gnus-Delayed} header and puts the message in the
5065 @code{nndraft:delayed} group.
5067 And whenever you get new news, Gnus looks through the group for articles
5068 which are due and sends them. It uses the @code{gnus-delay-send-drafts}
5069 function for this. By default, this function is added to the hook
5070 @code{gnus-get-new-news-hook}. But of course, you can change this.
5071 Maybe you want to use the demon to send drafts? Just tell the demon to
5072 execute the @code{gnus-delay-send-drafts} function.
5075 @item gnus-delay-initialize
5076 @findex gnus-delay-initialize
5077 By default, this function installs the @kbd{C-c C-j} key binding in
5078 Message mode and @code{gnus-delay-send-drafts} in
5079 @code{gnus-get-new-news-hook}. But it accepts two optional arguments,
5080 @code{no-keymap} and @code{no-check}. If @code{no-keymap} is non-nil,
5081 the @kbd{C-c C-j} binding is not intalled. If @code{no-check} is
5082 non-nil, @code{gnus-get-new-news-hook} is not changed.
5084 For example, @code{(gnus-delay-initialize nil t)} means to change the
5085 keymap but not to change @code{gnus-get-new-news-hook}. Presumably, you
5086 want to use the demon for sending due delayed articles. Just don't
5087 forget to set that up :-)
5091 @node Marking Articles
5092 @section Marking Articles
5093 @cindex article marking
5094 @cindex article ticking
5097 There are several marks you can set on an article.
5099 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5100 neologism ohoy!) of the article. Alphabetic marks generally mean
5101 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5103 In addition, you also have marks that do not affect readedness.
5106 * Unread Articles:: Marks for unread articles.
5107 * Read Articles:: Marks for read articles.
5108 * Other Marks:: Marks that do not affect readedness.
5112 There's a plethora of commands for manipulating these marks:
5116 * Setting Marks:: How to set and remove marks.
5117 * Generic Marking Commands:: How to customize the marking.
5118 * Setting Process Marks:: How to mark articles for later processing.
5122 @node Unread Articles
5123 @subsection Unread Articles
5125 The following marks mark articles as (kinda) unread, in one form or
5130 @vindex gnus-ticked-mark
5131 Marked as ticked (@code{gnus-ticked-mark}).
5133 @dfn{Ticked articles} are articles that will remain visible always. If
5134 you see an article that you find interesting, or you want to put off
5135 reading it, or replying to it, until sometime later, you'd typically
5136 tick it. However, articles can be expired (from news servers by the
5137 news server software, Gnus itself never expires ticked messages), so if
5138 you want to keep an article forever, you'll have to make it persistent
5139 (@pxref{Persistent Articles}).
5142 @vindex gnus-dormant-mark
5143 Marked as dormant (@code{gnus-dormant-mark}).
5145 @dfn{Dormant articles} will only appear in the summary buffer if there
5146 are followups to it. If you want to see them even if they don't have
5147 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
5148 Otherwise (except for the visibility issue), they are just like ticked
5152 @vindex gnus-unread-mark
5153 Marked as unread (@code{gnus-unread-mark}).
5155 @dfn{Unread articles} are articles that haven't been read at all yet.
5160 @subsection Read Articles
5161 @cindex expirable mark
5163 All the following marks mark articles as read.
5168 @vindex gnus-del-mark
5169 These are articles that the user has marked as read with the @kbd{d}
5170 command manually, more or less (@code{gnus-del-mark}).
5173 @vindex gnus-read-mark
5174 Articles that have actually been read (@code{gnus-read-mark}).
5177 @vindex gnus-ancient-mark
5178 Articles that were marked as read in previous sessions and are now
5179 @dfn{old} (@code{gnus-ancient-mark}).
5182 @vindex gnus-killed-mark
5183 Marked as killed (@code{gnus-killed-mark}).
5186 @vindex gnus-kill-file-mark
5187 Marked as killed by kill files (@code{gnus-kill-file-mark}).
5190 @vindex gnus-low-score-mark
5191 Marked as read by having too low a score (@code{gnus-low-score-mark}).
5194 @vindex gnus-catchup-mark
5195 Marked as read by a catchup (@code{gnus-catchup-mark}).
5198 @vindex gnus-canceled-mark
5199 Canceled article (@code{gnus-canceled-mark})
5202 @vindex gnus-souped-mark
5203 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
5206 @vindex gnus-sparse-mark
5207 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
5211 @vindex gnus-duplicate-mark
5212 Article marked as read by duplicate suppression
5213 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
5217 All these marks just mean that the article is marked as read, really.
5218 They are interpreted differently when doing adaptive scoring, though.
5220 One more special mark, though:
5224 @vindex gnus-expirable-mark
5225 Marked as expirable (@code{gnus-expirable-mark}).
5227 Marking articles as @dfn{expirable} (or have them marked as such
5228 automatically) doesn't make much sense in normal groups---a user doesn't
5229 control expiring of news articles, but in mail groups, for instance,
5230 articles marked as @dfn{expirable} can be deleted by Gnus at
5236 @subsection Other Marks
5237 @cindex process mark
5240 There are some marks that have nothing to do with whether the article is
5246 You can set a bookmark in the current article. Say you are reading a
5247 long thesis on cats' urinary tracts, and have to go home for dinner
5248 before you've finished reading the thesis. You can then set a bookmark
5249 in the article, and Gnus will jump to this bookmark the next time it
5250 encounters the article. @xref{Setting Marks}.
5253 @vindex gnus-replied-mark
5254 All articles that you have replied to or made a followup to (i.e., have
5255 answered) will be marked with an @samp{A} in the second column
5256 (@code{gnus-replied-mark}).
5258 @vindex gnus-forwarded-mark
5259 All articles that you have forwarded will be marked with an @samp{F} in
5260 the second column (@code{gnus-forwarded-mark}).
5262 @vindex gnus-recent-mark
5263 Articles that are ``recently'' arrived in the group will be marked
5264 with an @samp{N} in the second column (@code{gnus-recent-mark}). Most
5265 backend doesn't support the mark, in which case it's not shown.
5268 @vindex gnus-cached-mark
5269 Articles stored in the article cache will be marked with an @samp{*} in
5270 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
5273 @vindex gnus-saved-mark
5274 Articles ``saved'' (in some manner or other; not necessarily
5275 religiously) are marked with an @samp{S} in the second column
5276 (@code{gnus-saved-mark}).
5279 @vindex gnus-unseen-mark
5280 Articles that haven't been seen by the user before are marked with a
5281 @samp{.} in the second column (@code{gnus-unseen-mark}).
5284 @vindex gnus-not-empty-thread-mark
5285 @vindex gnus-empty-thread-mark
5286 If the @samp{%e} spec is used, the presence of threads or not will be
5287 marked with @code{gnus-not-empty-thread-mark} and
5288 @code{gnus-empty-thread-mark} in the third column, respectively.
5291 @vindex gnus-process-mark
5292 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
5293 variety of commands react to the presence of the process mark. For
5294 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5295 all articles that have been marked with the process mark. Articles
5296 marked with the process mark have a @samp{#} in the second column.
5300 You might have noticed that most of these ``non-readedness'' marks
5301 appear in the second column by default. So if you have a cached, saved,
5302 replied article that you have process-marked, what will that look like?
5304 Nothing much. The precedence rules go as follows: process -> cache ->
5305 replied -> saved. So if the article is in the cache and is replied,
5306 you'll only see the cache mark and not the replied mark.
5310 @subsection Setting Marks
5311 @cindex setting marks
5313 All the marking commands understand the numeric prefix.
5318 @kindex M c (Summary)
5319 @kindex M-u (Summary)
5320 @findex gnus-summary-clear-mark-forward
5321 @cindex mark as unread
5322 Clear all readedness-marks from the current article
5323 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
5329 @kindex M t (Summary)
5330 @findex gnus-summary-tick-article-forward
5331 Tick the current article (@code{gnus-summary-tick-article-forward}).
5332 @xref{Article Caching}.
5337 @kindex M ? (Summary)
5338 @findex gnus-summary-mark-as-dormant
5339 Mark the current article as dormant
5340 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
5344 @kindex M d (Summary)
5346 @findex gnus-summary-mark-as-read-forward
5347 Mark the current article as read
5348 (@code{gnus-summary-mark-as-read-forward}).
5352 @findex gnus-summary-mark-as-read-backward
5353 Mark the current article as read and move point to the previous line
5354 (@code{gnus-summary-mark-as-read-backward}).
5359 @kindex M k (Summary)
5360 @findex gnus-summary-kill-same-subject-and-select
5361 Mark all articles that have the same subject as the current one as read,
5362 and then select the next unread article
5363 (@code{gnus-summary-kill-same-subject-and-select}).
5367 @kindex M K (Summary)
5368 @kindex C-k (Summary)
5369 @findex gnus-summary-kill-same-subject
5370 Mark all articles that have the same subject as the current one as read
5371 (@code{gnus-summary-kill-same-subject}).
5374 @kindex M C (Summary)
5375 @findex gnus-summary-catchup
5376 @c @icon{gnus-summary-catchup}
5377 Mark all unread articles as read (@code{gnus-summary-catchup}).
5380 @kindex M C-c (Summary)
5381 @findex gnus-summary-catchup-all
5382 Mark all articles in the group as read---even the ticked and dormant
5383 articles (@code{gnus-summary-catchup-all}).
5386 @kindex M H (Summary)
5387 @findex gnus-summary-catchup-to-here
5388 Catchup the current group to point (before the point)
5389 (@code{gnus-summary-catchup-to-here}).
5392 @kindex M h (Summary)
5393 @findex gnus-summary-catchup-from-here
5394 Catchup the current group from point (after the point)
5395 (@code{gnus-summary-catchup-from-here}).
5398 @kindex C-w (Summary)
5399 @findex gnus-summary-mark-region-as-read
5400 Mark all articles between point and mark as read
5401 (@code{gnus-summary-mark-region-as-read}).
5404 @kindex M V k (Summary)
5405 @findex gnus-summary-kill-below
5406 Kill all articles with scores below the default score (or below the
5407 numeric prefix) (@code{gnus-summary-kill-below}).
5411 @kindex M e (Summary)
5413 @findex gnus-summary-mark-as-expirable
5414 Mark the current article as expirable
5415 (@code{gnus-summary-mark-as-expirable}).
5418 @kindex M b (Summary)
5419 @findex gnus-summary-set-bookmark
5420 Set a bookmark in the current article
5421 (@code{gnus-summary-set-bookmark}).
5424 @kindex M B (Summary)
5425 @findex gnus-summary-remove-bookmark
5426 Remove the bookmark from the current article
5427 (@code{gnus-summary-remove-bookmark}).
5430 @kindex M V c (Summary)
5431 @findex gnus-summary-clear-above
5432 Clear all marks from articles with scores over the default score (or
5433 over the numeric prefix) (@code{gnus-summary-clear-above}).
5436 @kindex M V u (Summary)
5437 @findex gnus-summary-tick-above
5438 Tick all articles with scores over the default score (or over the
5439 numeric prefix) (@code{gnus-summary-tick-above}).
5442 @kindex M V m (Summary)
5443 @findex gnus-summary-mark-above
5444 Prompt for a mark, and mark all articles with scores over the default
5445 score (or over the numeric prefix) with this mark
5446 (@code{gnus-summary-clear-above}).
5449 @vindex gnus-summary-goto-unread
5450 The @code{gnus-summary-goto-unread} variable controls what action should
5451 be taken after setting a mark. If non-@code{nil}, point will move to
5452 the next/previous unread article. If @code{nil}, point will just move
5453 one line up or down. As a special case, if this variable is
5454 @code{never}, all the marking commands as well as other commands (like
5455 @kbd{SPACE}) will move to the next article, whether it is unread or not.
5456 The default is @code{t}.
5459 @node Generic Marking Commands
5460 @subsection Generic Marking Commands
5462 Some people would like the command that ticks an article (@kbd{!}) go to
5463 the next article. Others would like it to go to the next unread
5464 article. Yet others would like it to stay on the current article. And
5465 even though I haven't heard of anybody wanting it to go to the
5466 previous (unread) article, I'm sure there are people that want that as
5469 Multiply these five behaviors with five different marking commands, and
5470 you get a potentially complex set of variable to control what each
5473 To sidestep that mess, Gnus provides commands that do all these
5474 different things. They can be found on the @kbd{M M} map in the summary
5475 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
5476 to list in this manual.
5478 While you can use these commands directly, most users would prefer
5479 altering the summary mode keymap. For instance, if you would like the
5480 @kbd{!} command to go to the next article instead of the next unread
5481 article, you could say something like:
5484 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
5485 (defun my-alter-summary-map ()
5486 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
5492 (defun my-alter-summary-map ()
5493 (local-set-key "!" "MM!n"))
5497 @node Setting Process Marks
5498 @subsection Setting Process Marks
5499 @cindex setting process marks
5506 @kindex M P p (Summary)
5507 @findex gnus-summary-mark-as-processable
5508 Mark the current article with the process mark
5509 (@code{gnus-summary-mark-as-processable}).
5510 @findex gnus-summary-unmark-as-processable
5514 @kindex M P u (Summary)
5515 @kindex M-# (Summary)
5516 Remove the process mark, if any, from the current article
5517 (@code{gnus-summary-unmark-as-processable}).
5520 @kindex M P U (Summary)
5521 @findex gnus-summary-unmark-all-processable
5522 Remove the process mark from all articles
5523 (@code{gnus-summary-unmark-all-processable}).
5526 @kindex M P i (Summary)
5527 @findex gnus-uu-invert-processable
5528 Invert the list of process marked articles
5529 (@code{gnus-uu-invert-processable}).
5532 @kindex M P R (Summary)
5533 @findex gnus-uu-mark-by-regexp
5534 Mark articles that have a @code{Subject} header that matches a regular
5535 expression (@code{gnus-uu-mark-by-regexp}).
5538 @kindex M P G (Summary)
5539 @findex gnus-uu-unmark-by-regexp
5540 Unmark articles that have a @code{Subject} header that matches a regular
5541 expression (@code{gnus-uu-unmark-by-regexp}).
5544 @kindex M P r (Summary)
5545 @findex gnus-uu-mark-region
5546 Mark articles in region (@code{gnus-uu-mark-region}).
5549 @kindex M P t (Summary)
5550 @findex gnus-uu-mark-thread
5551 Mark all articles in the current (sub)thread
5552 (@code{gnus-uu-mark-thread}).
5555 @kindex M P T (Summary)
5556 @findex gnus-uu-unmark-thread
5557 Unmark all articles in the current (sub)thread
5558 (@code{gnus-uu-unmark-thread}).
5561 @kindex M P v (Summary)
5562 @findex gnus-uu-mark-over
5563 Mark all articles that have a score above the prefix argument
5564 (@code{gnus-uu-mark-over}).
5567 @kindex M P s (Summary)
5568 @findex gnus-uu-mark-series
5569 Mark all articles in the current series (@code{gnus-uu-mark-series}).
5572 @kindex M P S (Summary)
5573 @findex gnus-uu-mark-sparse
5574 Mark all series that have already had some articles marked
5575 (@code{gnus-uu-mark-sparse}).
5578 @kindex M P a (Summary)
5579 @findex gnus-uu-mark-all
5580 Mark all articles in series order (@code{gnus-uu-mark-series}).
5583 @kindex M P b (Summary)
5584 @findex gnus-uu-mark-buffer
5585 Mark all articles in the buffer in the order they appear
5586 (@code{gnus-uu-mark-buffer}).
5589 @kindex M P k (Summary)
5590 @findex gnus-summary-kill-process-mark
5591 Push the current process mark set onto the stack and unmark all articles
5592 (@code{gnus-summary-kill-process-mark}).
5595 @kindex M P y (Summary)
5596 @findex gnus-summary-yank-process-mark
5597 Pop the previous process mark set from the stack and restore it
5598 (@code{gnus-summary-yank-process-mark}).
5601 @kindex M P w (Summary)
5602 @findex gnus-summary-save-process-mark
5603 Push the current process mark set onto the stack
5604 (@code{gnus-summary-save-process-mark}).
5608 Also see the @kbd{&} command in @pxref{Searching for Articles} for how to
5609 set process marks based on article body contents.
5616 It can be convenient to limit the summary buffer to just show some
5617 subset of the articles currently in the group. The effect most limit
5618 commands have is to remove a few (or many) articles from the summary
5621 All limiting commands work on subsets of the articles already fetched
5622 from the servers. None of these commands query the server for
5623 additional articles.
5629 @kindex / / (Summary)
5630 @findex gnus-summary-limit-to-subject
5631 Limit the summary buffer to articles that match some subject
5632 (@code{gnus-summary-limit-to-subject}).
5635 @kindex / a (Summary)
5636 @findex gnus-summary-limit-to-author
5637 Limit the summary buffer to articles that match some author
5638 (@code{gnus-summary-limit-to-author}).
5641 @kindex / x (Summary)
5642 @findex gnus-summary-limit-to-extra
5643 Limit the summary buffer to articles that match one of the ``extra''
5644 headers (@pxref{To From Newsgroups})
5645 (@code{gnus-summary-limit-to-extra}).
5649 @kindex / u (Summary)
5651 @findex gnus-summary-limit-to-unread
5652 Limit the summary buffer to articles not marked as read
5653 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
5654 buffer to articles strictly unread. This means that ticked and
5655 dormant articles will also be excluded.
5658 @kindex / m (Summary)
5659 @findex gnus-summary-limit-to-marks
5660 Ask for a mark and then limit to all articles that have been marked
5661 with that mark (@code{gnus-summary-limit-to-marks}).
5664 @kindex / t (Summary)
5665 @findex gnus-summary-limit-to-age
5666 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
5667 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
5668 articles younger than that number of days.
5671 @kindex / n (Summary)
5672 @findex gnus-summary-limit-to-articles
5673 Limit the summary buffer to the current article
5674 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
5675 convention (@pxref{Process/Prefix}).
5678 @kindex / w (Summary)
5679 @findex gnus-summary-pop-limit
5680 Pop the previous limit off the stack and restore it
5681 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
5685 @kindex / v (Summary)
5686 @findex gnus-summary-limit-to-score
5687 Limit the summary buffer to articles that have a score at or above some
5688 score (@code{gnus-summary-limit-to-score}).
5691 @kindex / p (Summary)
5692 @findex gnus-summary-limit-to-display-parameter
5693 Limit the summary buffer to articles that satisfy the @code{display}
5694 group parameter predicate
5695 (@code{gnus-summary-limit-to-display-parameter}). See @pxref{Group
5696 Parameters} for more on this predicate.
5700 @kindex M S (Summary)
5701 @kindex / E (Summary)
5702 @findex gnus-summary-limit-include-expunged
5703 Include all expunged articles in the limit
5704 (@code{gnus-summary-limit-include-expunged}).
5707 @kindex / D (Summary)
5708 @findex gnus-summary-limit-include-dormant
5709 Include all dormant articles in the limit
5710 (@code{gnus-summary-limit-include-dormant}).
5713 @kindex / * (Summary)
5714 @findex gnus-summary-limit-include-cached
5715 Include all cached articles in the limit
5716 (@code{gnus-summary-limit-include-cached}).
5719 @kindex / d (Summary)
5720 @findex gnus-summary-limit-exclude-dormant
5721 Exclude all dormant articles from the limit
5722 (@code{gnus-summary-limit-exclude-dormant}).
5725 @kindex / M (Summary)
5726 @findex gnus-summary-limit-exclude-marks
5727 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
5730 @kindex / T (Summary)
5731 @findex gnus-summary-limit-include-thread
5732 Include all the articles in the current thread in the limit.
5735 @kindex / c (Summary)
5736 @findex gnus-summary-limit-exclude-childless-dormant
5737 Exclude all dormant articles that have no children from the limit
5738 (@code{gnus-summary-limit-exclude-childless-dormant}).
5741 @kindex / C (Summary)
5742 @findex gnus-summary-limit-mark-excluded-as-read
5743 Mark all excluded unread articles as read
5744 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
5745 also mark excluded ticked and dormant articles as read.
5753 @cindex article threading
5755 Gnus threads articles by default. @dfn{To thread} is to put responses
5756 to articles directly after the articles they respond to---in a
5757 hierarchical fashion.
5759 Threading is done by looking at the @code{References} headers of the
5760 articles. In a perfect world, this would be enough to build pretty
5761 trees, but unfortunately, the @code{References} header is often broken
5762 or simply missing. Weird news propagation exacerbates the problem,
5763 so one has to employ other heuristics to get pleasing results. A
5764 plethora of approaches exists, as detailed in horrible detail in
5765 @pxref{Customizing Threading}.
5767 First, a quick overview of the concepts:
5771 The top-most article in a thread; the first article in the thread.
5774 A tree-like article structure.
5777 A small(er) section of this tree-like structure.
5780 Threads often lose their roots due to article expiry, or due to the root
5781 already having been read in a previous session, and not displayed in the
5782 summary buffer. We then typically have many sub-threads that really
5783 belong to one thread, but are without connecting roots. These are
5784 called loose threads.
5786 @item thread gathering
5787 An attempt to gather loose threads into bigger threads.
5789 @item sparse threads
5790 A thread where the missing articles have been ``guessed'' at, and are
5791 displayed as empty lines in the summary buffer.
5797 * Customizing Threading:: Variables you can change to affect the threading.
5798 * Thread Commands:: Thread based commands in the summary buffer.
5802 @node Customizing Threading
5803 @subsection Customizing Threading
5804 @cindex customizing threading
5807 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
5808 * Filling In Threads:: Making the threads displayed look fuller.
5809 * More Threading:: Even more variables for fiddling with threads.
5810 * Low-Level Threading:: You thought it was over... but you were wrong!
5815 @subsubsection Loose Threads
5818 @cindex loose threads
5821 @item gnus-summary-make-false-root
5822 @vindex gnus-summary-make-false-root
5823 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
5824 and create a dummy root at the top. (Wait a minute. Root at the top?
5825 Yup.) Loose subtrees occur when the real root has expired, or you've
5826 read or killed the root in a previous session.
5828 When there is no real root of a thread, Gnus will have to fudge
5829 something. This variable says what fudging method Gnus should use.
5830 There are four possible values:
5834 \gnusfigure{The Summary Buffer}{390}{
5835 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
5836 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
5837 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
5838 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
5843 @cindex adopting articles
5848 Gnus will make the first of the orphaned articles the parent. This
5849 parent will adopt all the other articles. The adopted articles will be
5850 marked as such by pointy brackets (@samp{<>}) instead of the standard
5851 square brackets (@samp{[]}). This is the default method.
5854 @vindex gnus-summary-dummy-line-format
5855 Gnus will create a dummy summary line that will pretend to be the
5856 parent. This dummy line does not correspond to any real article, so
5857 selecting it will just select the first real article after the dummy
5858 article. @code{gnus-summary-dummy-line-format} is used to specify the
5859 format of the dummy roots. It accepts only one format spec: @samp{S},
5860 which is the subject of the article. @xref{Formatting Variables}.
5863 Gnus won't actually make any article the parent, but simply leave the
5864 subject field of all orphans except the first empty. (Actually, it will
5865 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
5869 Don't make any article parent at all. Just gather the threads and
5870 display them after one another.
5873 Don't gather loose threads.
5876 @item gnus-summary-gather-subject-limit
5877 @vindex gnus-summary-gather-subject-limit
5878 Loose threads are gathered by comparing subjects of articles. If this
5879 variable is @code{nil}, Gnus requires an exact match between the
5880 subjects of the loose threads before gathering them into one big
5881 super-thread. This might be too strict a requirement, what with the
5882 presence of stupid newsreaders that chop off long subject lines. If
5883 you think so, set this variable to, say, 20 to require that only the
5884 first 20 characters of the subjects have to match. If you set this
5885 variable to a really low number, you'll find that Gnus will gather
5886 everything in sight into one thread, which isn't very helpful.
5888 @cindex fuzzy article gathering
5889 If you set this variable to the special value @code{fuzzy}, Gnus will
5890 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
5893 @item gnus-simplify-subject-fuzzy-regexp
5894 @vindex gnus-simplify-subject-fuzzy-regexp
5895 This can either be a regular expression or list of regular expressions
5896 that match strings that will be removed from subjects if fuzzy subject
5897 simplification is used.
5899 @item gnus-simplify-ignored-prefixes
5900 @vindex gnus-simplify-ignored-prefixes
5901 If you set @code{gnus-summary-gather-subject-limit} to something as low
5902 as 10, you might consider setting this variable to something sensible:
5904 @c Written by Michael Ernst <mernst@cs.rice.edu>
5906 (setq gnus-simplify-ignored-prefixes
5912 "wanted" "followup" "summary\\( of\\)?"
5913 "help" "query" "problem" "question"
5914 "answer" "reference" "announce"
5915 "How can I" "How to" "Comparison of"
5920 (mapconcat 'identity
5921 '("for" "for reference" "with" "about")
5923 "\\)?\\]?:?[ \t]*"))
5926 All words that match this regexp will be removed before comparing two
5929 @item gnus-simplify-subject-functions
5930 @vindex gnus-simplify-subject-functions
5931 If non-@code{nil}, this variable overrides
5932 @code{gnus-summary-gather-subject-limit}. This variable should be a
5933 list of functions to apply to the @code{Subject} string iteratively to
5934 arrive at the simplified version of the string.
5936 Useful functions to put in this list include:
5939 @item gnus-simplify-subject-re
5940 @findex gnus-simplify-subject-re
5941 Strip the leading @samp{Re:}.
5943 @item gnus-simplify-subject-fuzzy
5944 @findex gnus-simplify-subject-fuzzy
5947 @item gnus-simplify-whitespace
5948 @findex gnus-simplify-whitespace
5949 Remove excessive whitespace.
5952 You may also write your own functions, of course.
5955 @item gnus-summary-gather-exclude-subject
5956 @vindex gnus-summary-gather-exclude-subject
5957 Since loose thread gathering is done on subjects only, that might lead
5958 to many false hits, especially with certain common subjects like
5959 @samp{} and @samp{(none)}. To make the situation slightly better,
5960 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
5961 what subjects should be excluded from the gathering process.@*
5962 The default is @samp{^ *$\\|^(none)$}.
5964 @item gnus-summary-thread-gathering-function
5965 @vindex gnus-summary-thread-gathering-function
5966 Gnus gathers threads by looking at @code{Subject} headers. This means
5967 that totally unrelated articles may end up in the same ``thread'', which
5968 is confusing. An alternate approach is to look at all the
5969 @code{Message-ID}s in all the @code{References} headers to find matches.
5970 This will ensure that no gathered threads ever include unrelated
5971 articles, but it also means that people who have posted with broken
5972 newsreaders won't be gathered properly. The choice is yours---plague or
5976 @item gnus-gather-threads-by-subject
5977 @findex gnus-gather-threads-by-subject
5978 This function is the default gathering function and looks at
5979 @code{Subject}s exclusively.
5981 @item gnus-gather-threads-by-references
5982 @findex gnus-gather-threads-by-references
5983 This function looks at @code{References} headers exclusively.
5986 If you want to test gathering by @code{References}, you could say
5990 (setq gnus-summary-thread-gathering-function
5991 'gnus-gather-threads-by-references)
5997 @node Filling In Threads
5998 @subsubsection Filling In Threads
6001 @item gnus-fetch-old-headers
6002 @vindex gnus-fetch-old-headers
6003 If non-@code{nil}, Gnus will attempt to build old threads by fetching
6004 more old headers---headers to articles marked as read. If you
6005 would like to display as few summary lines as possible, but still
6006 connect as many loose threads as possible, you should set this variable
6007 to @code{some} or a number. If you set it to a number, no more than
6008 that number of extra old headers will be fetched. In either case,
6009 fetching old headers only works if the backend you are using carries
6010 overview files---this would normally be @code{nntp}, @code{nnspool} and
6011 @code{nnml}. Also remember that if the root of the thread has been
6012 expired by the server, there's not much Gnus can do about that.
6014 This variable can also be set to @code{invisible}. This won't have any
6015 visible effects, but is useful if you use the @kbd{A T} command a lot
6016 (@pxref{Finding the Parent}).
6018 @item gnus-build-sparse-threads
6019 @vindex gnus-build-sparse-threads
6020 Fetching old headers can be slow. A low-rent similar effect can be
6021 gotten by setting this variable to @code{some}. Gnus will then look at
6022 the complete @code{References} headers of all articles and try to string
6023 together articles that belong in the same thread. This will leave
6024 @dfn{gaps} in the threading display where Gnus guesses that an article
6025 is missing from the thread. (These gaps appear like normal summary
6026 lines. If you select a gap, Gnus will try to fetch the article in
6027 question.) If this variable is @code{t}, Gnus will display all these
6028 ``gaps'' without regard for whether they are useful for completing the
6029 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
6030 off sparse leaf nodes that don't lead anywhere. This variable is
6031 @code{nil} by default.
6033 @item gnus-read-all-available-headers
6034 @vindex gnus-read-all-available-headers
6035 This is a rather obscure variable that few will find useful. It's
6036 intended for those non-news newsgroups where the backend has to fetch
6037 quite a lot to present the summary buffer, and where it's impossible to
6038 go back to parents of articles. This is mostly the case in the
6039 web-based groups, like the @code{nnultimate} groups.
6041 If you don't use those, then it's safe to leave this as the default
6042 @code{nil}. If you want to use this variable, it should be a regexp
6043 that matches the group name, or @code{t} for all groups.
6048 @node More Threading
6049 @subsubsection More Threading
6052 @item gnus-show-threads
6053 @vindex gnus-show-threads
6054 If this variable is @code{nil}, no threading will be done, and all of
6055 the rest of the variables here will have no effect. Turning threading
6056 off will speed group selection up a bit, but it is sure to make reading
6057 slower and more awkward.
6059 @item gnus-thread-hide-subtree
6060 @vindex gnus-thread-hide-subtree
6061 If non-@code{nil}, all threads will be hidden when the summary buffer is
6064 @item gnus-thread-expunge-below
6065 @vindex gnus-thread-expunge-below
6066 All threads that have a total score (as defined by
6067 @code{gnus-thread-score-function}) less than this number will be
6068 expunged. This variable is @code{nil} by default, which means that no
6069 threads are expunged.
6071 @item gnus-thread-hide-killed
6072 @vindex gnus-thread-hide-killed
6073 if you kill a thread and this variable is non-@code{nil}, the subtree
6076 @item gnus-thread-ignore-subject
6077 @vindex gnus-thread-ignore-subject
6078 Sometimes somebody changes the subject in the middle of a thread. If
6079 this variable is non-@code{nil}, which is the default, the subject
6080 change is ignored. If it is @code{nil}, a change in the subject will
6081 result in a new thread.
6083 @item gnus-thread-indent-level
6084 @vindex gnus-thread-indent-level
6085 This is a number that says how much each sub-thread should be indented.
6088 @item gnus-sort-gathered-threads-function
6089 @vindex gnus-sort-gathered-threads-function
6090 Sometimes, particularly with mailing lists, the order in which mails
6091 arrive locally is not necessarily the same as the order in which they
6092 arrived on the mailing list. Consequently, when sorting sub-threads
6093 using the default @code{gnus-thread-sort-by-number}, responses can end
6094 up appearing before the article to which they are responding to.
6095 Setting this variable to an alternate value
6096 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
6097 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
6098 more logical sub-thread ordering in such instances.
6103 @node Low-Level Threading
6104 @subsubsection Low-Level Threading
6108 @item gnus-parse-headers-hook
6109 @vindex gnus-parse-headers-hook
6110 Hook run before parsing any headers.
6112 @item gnus-alter-header-function
6113 @vindex gnus-alter-header-function
6114 If non-@code{nil}, this function will be called to allow alteration of
6115 article header structures. The function is called with one parameter,
6116 the article header vector, which it may alter in any way. For instance,
6117 if you have a mail-to-news gateway which alters the @code{Message-ID}s
6118 in systematic ways (by adding prefixes and such), you can use this
6119 variable to un-scramble the @code{Message-ID}s so that they are more
6120 meaningful. Here's one example:
6123 (setq gnus-alter-header-function 'my-alter-message-id)
6125 (defun my-alter-message-id (header)
6126 (let ((id (mail-header-id header)))
6128 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
6130 (concat (match-string 1 id) "@@" (match-string 2 id))
6137 @node Thread Commands
6138 @subsection Thread Commands
6139 @cindex thread commands
6145 @kindex T k (Summary)
6146 @kindex M-C-k (Summary)
6147 @findex gnus-summary-kill-thread
6148 Mark all articles in the current (sub-)thread as read
6149 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
6150 remove all marks instead. If the prefix argument is negative, tick
6155 @kindex T l (Summary)
6156 @kindex M-C-l (Summary)
6157 @findex gnus-summary-lower-thread
6158 Lower the score of the current (sub-)thread
6159 (@code{gnus-summary-lower-thread}).
6162 @kindex T i (Summary)
6163 @findex gnus-summary-raise-thread
6164 Increase the score of the current (sub-)thread
6165 (@code{gnus-summary-raise-thread}).
6168 @kindex T # (Summary)
6169 @findex gnus-uu-mark-thread
6170 Set the process mark on the current (sub-)thread
6171 (@code{gnus-uu-mark-thread}).
6174 @kindex T M-# (Summary)
6175 @findex gnus-uu-unmark-thread
6176 Remove the process mark from the current (sub-)thread
6177 (@code{gnus-uu-unmark-thread}).
6180 @kindex T T (Summary)
6181 @findex gnus-summary-toggle-threads
6182 Toggle threading (@code{gnus-summary-toggle-threads}).
6185 @kindex T s (Summary)
6186 @findex gnus-summary-show-thread
6187 Expose the (sub-)thread hidden under the current article, if any
6188 (@code{gnus-summary-show-thread}).
6191 @kindex T h (Summary)
6192 @findex gnus-summary-hide-thread
6193 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
6196 @kindex T S (Summary)
6197 @findex gnus-summary-show-all-threads
6198 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
6201 @kindex T H (Summary)
6202 @findex gnus-summary-hide-all-threads
6203 Hide all threads (@code{gnus-summary-hide-all-threads}).
6206 @kindex T t (Summary)
6207 @findex gnus-summary-rethread-current
6208 Re-thread the current article's thread
6209 (@code{gnus-summary-rethread-current}). This works even when the
6210 summary buffer is otherwise unthreaded.
6213 @kindex T ^ (Summary)
6214 @findex gnus-summary-reparent-thread
6215 Make the current article the child of the marked (or previous) article
6216 (@code{gnus-summary-reparent-thread}).
6220 The following commands are thread movement commands. They all
6221 understand the numeric prefix.
6226 @kindex T n (Summary)
6228 @kindex M-C-n (Summary)
6230 @kindex M-down (Summary)
6231 @findex gnus-summary-next-thread
6232 Go to the next thread (@code{gnus-summary-next-thread}).
6235 @kindex T p (Summary)
6237 @kindex M-C-p (Summary)
6239 @kindex M-up (Summary)
6240 @findex gnus-summary-prev-thread
6241 Go to the previous thread (@code{gnus-summary-prev-thread}).
6244 @kindex T d (Summary)
6245 @findex gnus-summary-down-thread
6246 Descend the thread (@code{gnus-summary-down-thread}).
6249 @kindex T u (Summary)
6250 @findex gnus-summary-up-thread
6251 Ascend the thread (@code{gnus-summary-up-thread}).
6254 @kindex T o (Summary)
6255 @findex gnus-summary-top-thread
6256 Go to the top of the thread (@code{gnus-summary-top-thread}).
6259 @vindex gnus-thread-operation-ignore-subject
6260 If you ignore subject while threading, you'll naturally end up with
6261 threads that have several different subjects in them. If you then issue
6262 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
6263 wish to kill the entire thread, but just those parts of the thread that
6264 have the same subject as the current article. If you like this idea,
6265 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
6266 is non-@code{nil} (which it is by default), subjects will be ignored
6267 when doing thread commands. If this variable is @code{nil}, articles in
6268 the same thread with different subjects will not be included in the
6269 operation in question. If this variable is @code{fuzzy}, only articles
6270 that have subjects fuzzily equal will be included (@pxref{Fuzzy
6274 @node Sorting the Summary Buffer
6275 @section Sorting the Summary Buffer
6277 @findex gnus-thread-sort-by-total-score
6278 @findex gnus-thread-sort-by-date
6279 @findex gnus-thread-sort-by-score
6280 @findex gnus-thread-sort-by-subject
6281 @findex gnus-thread-sort-by-author
6282 @findex gnus-thread-sort-by-number
6283 @vindex gnus-thread-sort-functions
6284 If you are using a threaded summary display, you can sort the threads by
6285 setting @code{gnus-thread-sort-functions}, which can be either a single
6286 function, a list of functions, or a list containing functions and
6287 @code{(not some-function)} elements.
6289 By default, sorting is done on article numbers. Ready-made sorting
6290 predicate functions include @code{gnus-thread-sort-by-number},
6291 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
6292 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
6293 @code{gnus-thread-sort-by-total-score}.
6295 Each function takes two threads and returns non-@code{nil} if the first
6296 thread should be sorted before the other. Note that sorting really is
6297 normally done by looking only at the roots of each thread.
6299 If you use more than one function, the primary sort key should be the
6300 last function in the list. You should probably always include
6301 @code{gnus-thread-sort-by-number} in the list of sorting
6302 functions---preferably first. This will ensure that threads that are
6303 equal with respect to the other sort criteria will be displayed in
6304 ascending article order.
6306 If you would like to sort by reverse score, then by subject, and finally
6307 by number, you could do something like:
6310 (setq gnus-thread-sort-functions
6311 '(gnus-thread-sort-by-number
6312 gnus-thread-sort-by-subject
6313 (not gnus-thread-sort-by-total-score)))
6316 The threads that have highest score will be displayed first in the
6317 summary buffer. When threads have the same score, they will be sorted
6318 alphabetically. The threads that have the same score and the same
6319 subject will be sorted by number, which is (normally) the sequence in
6320 which the articles arrived.
6322 If you want to sort by score and then reverse arrival order, you could
6326 (setq gnus-thread-sort-functions
6328 (not (gnus-thread-sort-by-number t1 t2)))
6329 gnus-thread-sort-by-score))
6332 @vindex gnus-thread-score-function
6333 The function in the @code{gnus-thread-score-function} variable (default
6334 @code{+}) is used for calculating the total score of a thread. Useful
6335 functions might be @code{max}, @code{min}, or squared means, or whatever
6338 @findex gnus-article-sort-functions
6339 @findex gnus-article-sort-by-date
6340 @findex gnus-article-sort-by-score
6341 @findex gnus-article-sort-by-subject
6342 @findex gnus-article-sort-by-author
6343 @findex gnus-article-sort-by-number
6344 If you are using an unthreaded display for some strange reason or other,
6345 you have to fiddle with the @code{gnus-article-sort-functions} variable.
6346 It is very similar to the @code{gnus-thread-sort-functions}, except that
6347 it uses slightly different functions for article comparison. Available
6348 sorting predicate functions are @code{gnus-article-sort-by-number},
6349 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
6350 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
6352 If you want to sort an unthreaded summary display by subject, you could
6356 (setq gnus-article-sort-functions
6357 '(gnus-article-sort-by-number
6358 gnus-article-sort-by-subject))
6363 @node Asynchronous Fetching
6364 @section Asynchronous Article Fetching
6365 @cindex asynchronous article fetching
6366 @cindex article pre-fetch
6369 If you read your news from an @sc{nntp} server that's far away, the
6370 network latencies may make reading articles a chore. You have to wait
6371 for a while after pressing @kbd{n} to go to the next article before the
6372 article appears. Why can't Gnus just go ahead and fetch the article
6373 while you are reading the previous one? Why not, indeed.
6375 First, some caveats. There are some pitfalls to using asynchronous
6376 article fetching, especially the way Gnus does it.
6378 Let's say you are reading article 1, which is short, and article 2 is
6379 quite long, and you are not interested in reading that. Gnus does not
6380 know this, so it goes ahead and fetches article 2. You decide to read
6381 article 3, but since Gnus is in the process of fetching article 2, the
6382 connection is blocked.
6384 To avoid these situations, Gnus will open two (count 'em two)
6385 connections to the server. Some people may think this isn't a very nice
6386 thing to do, but I don't see any real alternatives. Setting up that
6387 extra connection takes some time, so Gnus startup will be slower.
6389 Gnus will fetch more articles than you will read. This will mean that
6390 the link between your machine and the @sc{nntp} server will become more
6391 loaded than if you didn't use article pre-fetch. The server itself will
6392 also become more loaded---both with the extra article requests, and the
6395 Ok, so now you know that you shouldn't really use this thing... unless
6398 @vindex gnus-asynchronous
6399 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
6400 happen automatically.
6402 @vindex gnus-use-article-prefetch
6403 You can control how many articles are to be pre-fetched by setting
6404 @code{gnus-use-article-prefetch}. This is 30 by default, which means
6405 that when you read an article in the group, the backend will pre-fetch
6406 the next 30 articles. If this variable is @code{t}, the backend will
6407 pre-fetch all the articles it can without bound. If it is
6408 @code{nil}, no pre-fetching will be done.
6410 @vindex gnus-async-prefetch-article-p
6411 @findex gnus-async-read-p
6412 There are probably some articles that you don't want to pre-fetch---read
6413 articles, for instance. The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched. This function should
6414 return non-@code{nil} when the article in question is to be
6415 pre-fetched. The default is @code{gnus-async-read-p}, which returns
6416 @code{nil} on read articles. The function is called with an article
6417 data structure as the only parameter.
6419 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
6422 (defun my-async-short-unread-p (data)
6423 "Return non-nil for short, unread articles."
6424 (and (gnus-data-unread-p data)
6425 (< (mail-header-lines (gnus-data-header data))
6428 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
6431 These functions will be called many, many times, so they should
6432 preferably be short and sweet to avoid slowing down Gnus too much.
6433 It's probably a good idea to byte-compile things like this.
6435 @vindex gnus-prefetched-article-deletion-strategy
6436 Articles have to be removed from the asynch buffer sooner or later. The
6437 @code{gnus-prefetched-article-deletion-strategy} says when to remove
6438 articles. This is a list that may contain the following elements:
6442 Remove articles when they are read.
6445 Remove articles when exiting the group.
6448 The default value is @code{(read exit)}.
6450 @c @vindex gnus-use-header-prefetch
6451 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
6452 @c from the next group.
6455 @node Article Caching
6456 @section Article Caching
6457 @cindex article caching
6460 If you have an @emph{extremely} slow @sc{nntp} connection, you may
6461 consider turning article caching on. Each article will then be stored
6462 locally under your home directory. As you may surmise, this could
6463 potentially use @emph{huge} amounts of disk space, as well as eat up all
6464 your inodes so fast it will make your head swim. In vodka.
6466 Used carefully, though, it could be just an easier way to save articles.
6468 @vindex gnus-use-long-file-name
6469 @vindex gnus-cache-directory
6470 @vindex gnus-use-cache
6471 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
6472 all articles ticked or marked as dormant will then be copied
6473 over to your local cache (@code{gnus-cache-directory}). Whether this
6474 cache is flat or hierarchical is controlled by the
6475 @code{gnus-use-long-file-name} variable, as usual.
6477 When re-selecting a ticked or dormant article, it will be fetched from the
6478 cache instead of from the server. As articles in your cache will never
6479 expire, this might serve as a method of saving articles while still
6480 keeping them where they belong. Just mark all articles you want to save
6481 as dormant, and don't worry.
6483 When an article is marked as read, is it removed from the cache.
6485 @vindex gnus-cache-remove-articles
6486 @vindex gnus-cache-enter-articles
6487 The entering/removal of articles from the cache is controlled by the
6488 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
6489 variables. Both are lists of symbols. The first is @code{(ticked
6490 dormant)} by default, meaning that ticked and dormant articles will be
6491 put in the cache. The latter is @code{(read)} by default, meaning that
6492 articles marked as read are removed from the cache. Possibly
6493 symbols in these two lists are @code{ticked}, @code{dormant},
6494 @code{unread} and @code{read}.
6496 @findex gnus-jog-cache
6497 So where does the massive article-fetching and storing come into the
6498 picture? The @code{gnus-jog-cache} command will go through all
6499 subscribed newsgroups, request all unread articles, score them, and
6500 store them in the cache. You should only ever, ever ever ever, use this
6501 command if 1) your connection to the @sc{nntp} server is really, really,
6502 really slow and 2) you have a really, really, really huge disk.
6503 Seriously. One way to cut down on the number of articles downloaded is
6504 to score unwanted articles down and have them marked as read. They will
6505 not then be downloaded by this command.
6507 @vindex gnus-uncacheable-groups
6508 @vindex gnus-cacheable-groups
6509 It is likely that you do not want caching on all groups. For instance,
6510 if your @code{nnml} mail is located under your home directory, it makes no
6511 sense to cache it somewhere else under your home directory. Unless you
6512 feel that it's neat to use twice as much space.
6514 To limit the caching, you could set @code{gnus-cacheable-groups} to a
6515 regexp of groups to cache, @samp{^nntp} for instance, or set the
6516 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
6517 Both variables are @code{nil} by default. If a group matches both
6518 variables, the group is not cached.
6520 @findex gnus-cache-generate-nov-databases
6521 @findex gnus-cache-generate-active
6522 @vindex gnus-cache-active-file
6523 The cache stores information on what articles it contains in its active
6524 file (@code{gnus-cache-active-file}). If this file (or any other parts
6525 of the cache) becomes all messed up for some reason or other, Gnus
6526 offers two functions that will try to set things right. @kbd{M-x
6527 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
6528 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
6532 @node Persistent Articles
6533 @section Persistent Articles
6534 @cindex persistent articles
6536 Closely related to article caching, we have @dfn{persistent articles}.
6537 In fact, it's just a different way of looking at caching, and much more
6538 useful in my opinion.
6540 Say you're reading a newsgroup, and you happen on to some valuable gem
6541 that you want to keep and treasure forever. You'd normally just save it
6542 (using one of the many saving commands) in some file. The problem with
6543 that is that it's just, well, yucky. Ideally you'd prefer just having
6544 the article remain in the group where you found it forever; untouched by
6545 the expiry going on at the news server.
6547 This is what a @dfn{persistent article} is---an article that just won't
6548 be deleted. It's implemented using the normal cache functions, but
6549 you use two explicit commands for managing persistent articles:
6555 @findex gnus-cache-enter-article
6556 Make the current article persistent (@code{gnus-cache-enter-article}).
6559 @kindex M-* (Summary)
6560 @findex gnus-cache-remove-article
6561 Remove the current article from the persistent articles
6562 (@code{gnus-cache-remove-article}). This will normally delete the
6566 Both these commands understand the process/prefix convention.
6568 To avoid having all ticked articles (and stuff) entered into the cache,
6569 you should set @code{gnus-use-cache} to @code{passive} if you're just
6570 interested in persistent articles:
6573 (setq gnus-use-cache 'passive)
6577 @node Article Backlog
6578 @section Article Backlog
6580 @cindex article backlog
6582 If you have a slow connection, but the idea of using caching seems
6583 unappealing to you (and it is, really), you can help the situation some
6584 by switching on the @dfn{backlog}. This is where Gnus will buffer
6585 already read articles so that it doesn't have to re-fetch articles
6586 you've already read. This only helps if you are in the habit of
6587 re-selecting articles you've recently read, of course. If you never do
6588 that, turning the backlog on will slow Gnus down a little bit, and
6589 increase memory usage some.
6591 @vindex gnus-keep-backlog
6592 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
6593 at most @var{n} old articles in a buffer for later re-fetching. If this
6594 variable is non-@code{nil} and is not a number, Gnus will store
6595 @emph{all} read articles, which means that your Emacs will grow without
6596 bound before exploding and taking your machine down with you. I put
6597 that in there just to keep y'all on your toes.
6599 This variable is @code{nil} by default.
6602 @node Saving Articles
6603 @section Saving Articles
6604 @cindex saving articles
6606 Gnus can save articles in a number of ways. Below is the documentation
6607 for saving articles in a fairly straight-forward fashion (i.e., little
6608 processing of the article is done before it is saved). For a different
6609 approach (uudecoding, unsharing) you should use @code{gnus-uu}
6610 (@pxref{Decoding Articles}).
6612 @vindex gnus-save-all-headers
6613 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
6614 unwanted headers before saving the article.
6616 @vindex gnus-saved-headers
6617 If the preceding variable is @code{nil}, all headers that match the
6618 @code{gnus-saved-headers} regexp will be kept, while the rest will be
6619 deleted before saving.
6625 @kindex O o (Summary)
6627 @findex gnus-summary-save-article
6628 @c @icon{gnus-summary-save-article}
6629 Save the current article using the default article saver
6630 (@code{gnus-summary-save-article}).
6633 @kindex O m (Summary)
6634 @findex gnus-summary-save-article-mail
6635 Save the current article in mail format
6636 (@code{gnus-summary-save-article-mail}).
6639 @kindex O r (Summary)
6640 @findex gnus-summary-save-article-rmail
6641 Save the current article in rmail format
6642 (@code{gnus-summary-save-article-rmail}).
6645 @kindex O f (Summary)
6646 @findex gnus-summary-save-article-file
6647 @c @icon{gnus-summary-save-article-file}
6648 Save the current article in plain file format
6649 (@code{gnus-summary-save-article-file}).
6652 @kindex O F (Summary)
6653 @findex gnus-summary-write-article-file
6654 Write the current article in plain file format, overwriting any previous
6655 file contents (@code{gnus-summary-write-article-file}).
6658 @kindex O b (Summary)
6659 @findex gnus-summary-save-article-body-file
6660 Save the current article body in plain file format
6661 (@code{gnus-summary-save-article-body-file}).
6664 @kindex O h (Summary)
6665 @findex gnus-summary-save-article-folder
6666 Save the current article in mh folder format
6667 (@code{gnus-summary-save-article-folder}).
6670 @kindex O v (Summary)
6671 @findex gnus-summary-save-article-vm
6672 Save the current article in a VM folder
6673 (@code{gnus-summary-save-article-vm}).
6677 @kindex O p (Summary)
6679 @findex gnus-summary-pipe-output
6680 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
6681 the current article to a process (@code{gnus-summary-pipe-output}).
6684 @vindex gnus-prompt-before-saving
6685 All these commands use the process/prefix convention
6686 (@pxref{Process/Prefix}). If you save bunches of articles using these
6687 functions, you might get tired of being prompted for files to save each
6688 and every article in. The prompting action is controlled by
6689 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
6690 default, giving you that excessive prompting action you know and
6691 loathe. If you set this variable to @code{t} instead, you'll be prompted
6692 just once for each series of articles you save. If you like to really
6693 have Gnus do all your thinking for you, you can even set this variable
6694 to @code{nil}, which means that you will never be prompted for files to
6695 save articles in. Gnus will simply save all the articles in the default
6699 @vindex gnus-default-article-saver
6700 You can customize the @code{gnus-default-article-saver} variable to make
6701 Gnus do what you want it to. You can use any of the six ready-made
6702 functions below, or you can create your own.
6706 @item gnus-summary-save-in-rmail
6707 @findex gnus-summary-save-in-rmail
6708 @vindex gnus-rmail-save-name
6709 @findex gnus-plain-save-name
6710 This is the default format, @dfn{babyl}. Uses the function in the
6711 @code{gnus-rmail-save-name} variable to get a file name to save the
6712 article in. The default is @code{gnus-plain-save-name}.
6714 @item gnus-summary-save-in-mail
6715 @findex gnus-summary-save-in-mail
6716 @vindex gnus-mail-save-name
6717 Save in a Unix mail (mbox) file. Uses the function in the
6718 @code{gnus-mail-save-name} variable to get a file name to save the
6719 article in. The default is @code{gnus-plain-save-name}.
6721 @item gnus-summary-save-in-file
6722 @findex gnus-summary-save-in-file
6723 @vindex gnus-file-save-name
6724 @findex gnus-numeric-save-name
6725 Append the article straight to an ordinary file. Uses the function in
6726 the @code{gnus-file-save-name} variable to get a file name to save the
6727 article in. The default is @code{gnus-numeric-save-name}.
6729 @item gnus-summary-save-body-in-file
6730 @findex gnus-summary-save-body-in-file
6731 Append the article body to an ordinary file. Uses the function in the
6732 @code{gnus-file-save-name} variable to get a file name to save the
6733 article in. The default is @code{gnus-numeric-save-name}.
6735 @item gnus-summary-save-in-folder
6736 @findex gnus-summary-save-in-folder
6737 @findex gnus-folder-save-name
6738 @findex gnus-Folder-save-name
6739 @vindex gnus-folder-save-name
6742 Save the article to an MH folder using @code{rcvstore} from the MH
6743 library. Uses the function in the @code{gnus-folder-save-name} variable
6744 to get a file name to save the article in. The default is
6745 @code{gnus-folder-save-name}, but you can also use
6746 @code{gnus-Folder-save-name}, which creates capitalized names.
6748 @item gnus-summary-save-in-vm
6749 @findex gnus-summary-save-in-vm
6750 Save the article in a VM folder. You have to have the VM mail
6751 reader to use this setting.
6754 @vindex gnus-article-save-directory
6755 All of these functions, except for the last one, will save the article
6756 in the @code{gnus-article-save-directory}, which is initialized from the
6757 @code{SAVEDIR} environment variable. This is @file{~/News/} by
6760 As you can see above, the functions use different functions to find a
6761 suitable name of a file to save the article in. Below is a list of
6762 available functions that generate names:
6766 @item gnus-Numeric-save-name
6767 @findex gnus-Numeric-save-name
6768 File names like @file{~/News/Alt.andrea-dworkin/45}.
6770 @item gnus-numeric-save-name
6771 @findex gnus-numeric-save-name
6772 File names like @file{~/News/alt.andrea-dworkin/45}.
6774 @item gnus-Plain-save-name
6775 @findex gnus-Plain-save-name
6776 File names like @file{~/News/Alt.andrea-dworkin}.
6778 @item gnus-plain-save-name
6779 @findex gnus-plain-save-name
6780 File names like @file{~/News/alt.andrea-dworkin}.
6782 @item gnus-sender-save-name
6783 @findex gnus-sender-save-name
6784 File names like @file{~/News/larsi}.
6787 @vindex gnus-split-methods
6788 You can have Gnus suggest where to save articles by plonking a regexp into
6789 the @code{gnus-split-methods} alist. For instance, if you would like to
6790 save articles related to Gnus in the file @file{gnus-stuff}, and articles
6791 related to VM in @code{vm-stuff}, you could set this variable to something
6795 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
6796 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
6797 (my-choosing-function "../other-dir/my-stuff")
6798 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
6801 We see that this is a list where each element is a list that has two
6802 elements---the @dfn{match} and the @dfn{file}. The match can either be
6803 a string (in which case it is used as a regexp to match on the article
6804 head); it can be a symbol (which will be called as a function with the
6805 group name as a parameter); or it can be a list (which will be
6806 @code{eval}ed). If any of these actions have a non-@code{nil} result,
6807 the @dfn{file} will be used as a default prompt. In addition, the
6808 result of the operation itself will be used if the function or form
6809 called returns a string or a list of strings.
6811 You basically end up with a list of file names that might be used when
6812 saving the current article. (All ``matches'' will be used.) You will
6813 then be prompted for what you really want to use as a name, with file
6814 name completion over the results from applying this variable.
6816 This variable is @code{((gnus-article-archive-name))} by default, which
6817 means that Gnus will look at the articles it saves for an
6818 @code{Archive-name} line and use that as a suggestion for the file
6821 Here's an example function to clean up file names somewhat. If you have
6822 lots of mail groups called things like
6823 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
6824 these group names before creating the file name to save to. The
6825 following will do just that:
6828 (defun my-save-name (group)
6829 (when (string-match "^nnml:mail." group)
6830 (substring group (match-end 0))))
6832 (setq gnus-split-methods
6833 '((gnus-article-archive-name)
6838 @vindex gnus-use-long-file-name
6839 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
6840 @code{nil}, all the preceding functions will replace all periods
6841 (@samp{.}) in the group names with slashes (@samp{/})---which means that
6842 the functions will generate hierarchies of directories instead of having
6843 all the files in the top level directory
6844 (@file{~/News/alt/andrea-dworkin} instead of
6845 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
6846 on most systems. However, for historical reasons, this is @code{nil} on
6847 Xenix and usg-unix-v machines by default.
6849 This function also affects kill and score file names. If this variable
6850 is a list, and the list contains the element @code{not-score}, long file
6851 names will not be used for score files, if it contains the element
6852 @code{not-save}, long file names will not be used for saving, and if it
6853 contains the element @code{not-kill}, long file names will not be used
6856 If you'd like to save articles in a hierarchy that looks something like
6860 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
6861 (setq gnus-default-article-saver
6862 'gnus-summary-save-in-file) ; no encoding
6865 Then just save with @kbd{o}. You'd then read this hierarchy with
6866 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
6867 the top level directory as the argument (@file{~/News/}). Then just walk
6868 around to the groups/directories with @code{nneething}.
6871 @node Decoding Articles
6872 @section Decoding Articles
6873 @cindex decoding articles
6875 Sometime users post articles (or series of articles) that have been
6876 encoded in some way or other. Gnus can decode them for you.
6879 * Uuencoded Articles:: Uudecode articles.
6880 * Shell Archives:: Unshar articles.
6881 * PostScript Files:: Split PostScript.
6882 * Other Files:: Plain save and binhex.
6883 * Decoding Variables:: Variables for a happy decoding.
6884 * Viewing Files:: You want to look at the result of the decoding?
6888 @cindex article series
6889 All these functions use the process/prefix convention
6890 (@pxref{Process/Prefix}) for finding out what articles to work on, with
6891 the extension that a ``single article'' means ``a single series''. Gnus
6892 can find out by itself what articles belong to a series, decode all the
6893 articles and unpack/view/save the resulting file(s).
6895 Gnus guesses what articles are in the series according to the following
6896 simplish rule: The subjects must be (nearly) identical, except for the
6897 last two numbers of the line. (Spaces are largely ignored, however.)
6899 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
6900 will find all the articles that match the regexp @samp{^cat.gif
6901 ([0-9]+/[0-9]+).*$}.
6903 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
6904 series}, will not be properly recognized by any of the automatic viewing
6905 commands, and you have to mark the articles manually with @kbd{#}.
6908 @node Uuencoded Articles
6909 @subsection Uuencoded Articles
6911 @cindex uuencoded articles
6916 @kindex X u (Summary)
6917 @findex gnus-uu-decode-uu
6918 @c @icon{gnus-uu-decode-uu}
6919 Uudecodes the current series (@code{gnus-uu-decode-uu}).
6922 @kindex X U (Summary)
6923 @findex gnus-uu-decode-uu-and-save
6924 Uudecodes and saves the current series
6925 (@code{gnus-uu-decode-uu-and-save}).
6928 @kindex X v u (Summary)
6929 @findex gnus-uu-decode-uu-view
6930 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
6933 @kindex X v U (Summary)
6934 @findex gnus-uu-decode-uu-and-save-view
6935 Uudecodes, views and saves the current series
6936 (@code{gnus-uu-decode-uu-and-save-view}).
6940 Remember that these all react to the presence of articles marked with
6941 the process mark. If, for instance, you'd like to decode and save an
6942 entire newsgroup, you'd typically do @kbd{M P a}
6943 (@code{gnus-uu-mark-all}) and then @kbd{X U}
6944 (@code{gnus-uu-decode-uu-and-save}).
6946 All this is very much different from how @code{gnus-uu} worked with
6947 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
6948 the sun. This version of @code{gnus-uu} generally assumes that you mark
6949 articles in some way (@pxref{Setting Process Marks}) and then press
6952 @vindex gnus-uu-notify-files
6953 Note: When trying to decode articles that have names matching
6954 @code{gnus-uu-notify-files}, which is hard-coded to
6955 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
6956 automatically post an article on @samp{comp.unix.wizards} saying that
6957 you have just viewed the file in question. This feature can't be turned
6961 @node Shell Archives
6962 @subsection Shell Archives
6964 @cindex shell archives
6965 @cindex shared articles
6967 Shell archives (``shar files'') used to be a popular way to distribute
6968 sources, but it isn't used all that much today. In any case, we have
6969 some commands to deal with these:
6974 @kindex X s (Summary)
6975 @findex gnus-uu-decode-unshar
6976 Unshars the current series (@code{gnus-uu-decode-unshar}).
6979 @kindex X S (Summary)
6980 @findex gnus-uu-decode-unshar-and-save
6981 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
6984 @kindex X v s (Summary)
6985 @findex gnus-uu-decode-unshar-view
6986 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
6989 @kindex X v S (Summary)
6990 @findex gnus-uu-decode-unshar-and-save-view
6991 Unshars, views and saves the current series
6992 (@code{gnus-uu-decode-unshar-and-save-view}).
6996 @node PostScript Files
6997 @subsection PostScript Files
7003 @kindex X p (Summary)
7004 @findex gnus-uu-decode-postscript
7005 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
7008 @kindex X P (Summary)
7009 @findex gnus-uu-decode-postscript-and-save
7010 Unpack and save the current PostScript series
7011 (@code{gnus-uu-decode-postscript-and-save}).
7014 @kindex X v p (Summary)
7015 @findex gnus-uu-decode-postscript-view
7016 View the current PostScript series
7017 (@code{gnus-uu-decode-postscript-view}).
7020 @kindex X v P (Summary)
7021 @findex gnus-uu-decode-postscript-and-save-view
7022 View and save the current PostScript series
7023 (@code{gnus-uu-decode-postscript-and-save-view}).
7028 @subsection Other Files
7032 @kindex X o (Summary)
7033 @findex gnus-uu-decode-save
7034 Save the current series
7035 (@code{gnus-uu-decode-save}).
7038 @kindex X b (Summary)
7039 @findex gnus-uu-decode-binhex
7040 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
7041 doesn't really work yet.
7045 @node Decoding Variables
7046 @subsection Decoding Variables
7048 Adjective, not verb.
7051 * Rule Variables:: Variables that say how a file is to be viewed.
7052 * Other Decode Variables:: Other decode variables.
7053 * Uuencoding and Posting:: Variables for customizing uuencoding.
7057 @node Rule Variables
7058 @subsubsection Rule Variables
7059 @cindex rule variables
7061 Gnus uses @dfn{rule variables} to decide how to view a file. All these
7062 variables are of the form
7065 (list '(regexp1 command2)
7072 @item gnus-uu-user-view-rules
7073 @vindex gnus-uu-user-view-rules
7075 This variable is consulted first when viewing files. If you wish to use,
7076 for instance, @code{sox} to convert an @samp{.au} sound file, you could
7079 (setq gnus-uu-user-view-rules
7080 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
7083 @item gnus-uu-user-view-rules-end
7084 @vindex gnus-uu-user-view-rules-end
7085 This variable is consulted if Gnus couldn't make any matches from the
7086 user and default view rules.
7088 @item gnus-uu-user-archive-rules
7089 @vindex gnus-uu-user-archive-rules
7090 This variable can be used to say what commands should be used to unpack
7095 @node Other Decode Variables
7096 @subsubsection Other Decode Variables
7099 @vindex gnus-uu-grabbed-file-functions
7101 @item gnus-uu-grabbed-file-functions
7102 All functions in this list will be called right after each file has been
7103 successfully decoded---so that you can move or view files right away,
7104 and don't have to wait for all files to be decoded before you can do
7105 anything. Ready-made functions you can put in this list are:
7109 @item gnus-uu-grab-view
7110 @findex gnus-uu-grab-view
7113 @item gnus-uu-grab-move
7114 @findex gnus-uu-grab-move
7115 Move the file (if you're using a saving function.)
7118 @item gnus-uu-be-dangerous
7119 @vindex gnus-uu-be-dangerous
7120 Specifies what to do if unusual situations arise during decoding. If
7121 @code{nil}, be as conservative as possible. If @code{t}, ignore things
7122 that didn't work, and overwrite existing files. Otherwise, ask each
7125 @item gnus-uu-ignore-files-by-name
7126 @vindex gnus-uu-ignore-files-by-name
7127 Files with name matching this regular expression won't be viewed.
7129 @item gnus-uu-ignore-files-by-type
7130 @vindex gnus-uu-ignore-files-by-type
7131 Files with a @sc{mime} type matching this variable won't be viewed.
7132 Note that Gnus tries to guess what type the file is based on the name.
7133 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
7136 @item gnus-uu-tmp-dir
7137 @vindex gnus-uu-tmp-dir
7138 Where @code{gnus-uu} does its work.
7140 @item gnus-uu-do-not-unpack-archives
7141 @vindex gnus-uu-do-not-unpack-archives
7142 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
7143 looking for files to display.
7145 @item gnus-uu-view-and-save
7146 @vindex gnus-uu-view-and-save
7147 Non-@code{nil} means that the user will always be asked to save a file
7150 @item gnus-uu-ignore-default-view-rules
7151 @vindex gnus-uu-ignore-default-view-rules
7152 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
7155 @item gnus-uu-ignore-default-archive-rules
7156 @vindex gnus-uu-ignore-default-archive-rules
7157 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
7160 @item gnus-uu-kill-carriage-return
7161 @vindex gnus-uu-kill-carriage-return
7162 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
7165 @item gnus-uu-unmark-articles-not-decoded
7166 @vindex gnus-uu-unmark-articles-not-decoded
7167 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
7168 decoded articles as unread.
7170 @item gnus-uu-correct-stripped-uucode
7171 @vindex gnus-uu-correct-stripped-uucode
7172 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
7173 uuencoded files that have had trailing spaces deleted.
7175 @item gnus-uu-pre-uudecode-hook
7176 @vindex gnus-uu-pre-uudecode-hook
7177 Hook run before sending a message to @code{uudecode}.
7179 @item gnus-uu-view-with-metamail
7180 @vindex gnus-uu-view-with-metamail
7182 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
7183 commands defined by the rule variables and just fudge a @sc{mime}
7184 content type based on the file name. The result will be fed to
7185 @code{metamail} for viewing.
7187 @item gnus-uu-save-in-digest
7188 @vindex gnus-uu-save-in-digest
7189 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
7190 decoding, will save in digests. If this variable is @code{nil},
7191 @code{gnus-uu} will just save everything in a file without any
7192 embellishments. The digesting almost conforms to RFC 1153---no easy way
7193 to specify any meaningful volume and issue numbers were found, so I
7194 simply dropped them.
7199 @node Uuencoding and Posting
7200 @subsubsection Uuencoding and Posting
7204 @item gnus-uu-post-include-before-composing
7205 @vindex gnus-uu-post-include-before-composing
7206 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
7207 before you compose the article. If this variable is @code{t}, you can
7208 either include an encoded file with @kbd{C-c C-i} or have one included
7209 for you when you post the article.
7211 @item gnus-uu-post-length
7212 @vindex gnus-uu-post-length
7213 Maximum length of an article. The encoded file will be split into how
7214 many articles it takes to post the entire file.
7216 @item gnus-uu-post-threaded
7217 @vindex gnus-uu-post-threaded
7218 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
7219 thread. This may not be smart, as no other decoder I have seen is able
7220 to follow threads when collecting uuencoded articles. (Well, I have
7221 seen one package that does that---@code{gnus-uu}, but somehow, I don't
7222 think that counts...) Default is @code{nil}.
7224 @item gnus-uu-post-separate-description
7225 @vindex gnus-uu-post-separate-description
7226 Non-@code{nil} means that the description will be posted in a separate
7227 article. The first article will typically be numbered (0/x). If this
7228 variable is @code{nil}, the description the user enters will be included
7229 at the beginning of the first article, which will be numbered (1/x).
7230 Default is @code{t}.
7236 @subsection Viewing Files
7237 @cindex viewing files
7238 @cindex pseudo-articles
7240 After decoding, if the file is some sort of archive, Gnus will attempt
7241 to unpack the archive and see if any of the files in the archive can be
7242 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
7243 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
7244 uncompress and de-tar the main file, and then view the two pictures.
7245 This unpacking process is recursive, so if the archive contains archives
7246 of archives, it'll all be unpacked.
7248 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
7249 extracted file into the summary buffer. If you go to these
7250 ``articles'', you will be prompted for a command to run (usually Gnus
7251 will make a suggestion), and then the command will be run.
7253 @vindex gnus-view-pseudo-asynchronously
7254 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
7255 until the viewing is done before proceeding.
7257 @vindex gnus-view-pseudos
7258 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
7259 the pseudo-articles into the summary buffer, but view them
7260 immediately. If this variable is @code{not-confirm}, the user won't even
7261 be asked for a confirmation before viewing is done.
7263 @vindex gnus-view-pseudos-separately
7264 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
7265 pseudo-article will be created for each file to be viewed. If
7266 @code{nil}, all files that use the same viewing command will be given as
7267 a list of parameters to that command.
7269 @vindex gnus-insert-pseudo-articles
7270 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
7271 pseudo-articles when decoding. It is @code{t} by default.
7273 So; there you are, reading your @emph{pseudo-articles} in your
7274 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
7275 Why isn't anything real anymore? How did we get here?
7278 @node Article Treatment
7279 @section Article Treatment
7281 Reading through this huge manual, you may have quite forgotten that the
7282 object of newsreaders is to actually, like, read what people have
7283 written. Reading articles. Unfortunately, people are quite bad at
7284 writing, so there are tons of functions and variables to make reading
7285 these articles easier.
7288 * Article Highlighting:: You want to make the article look like fruit salad.
7289 * Article Fontisizing:: Making emphasized text look nice.
7290 * Article Hiding:: You also want to make certain info go away.
7291 * Article Washing:: Lots of way-neat functions to make life better.
7292 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
7293 * Article Date:: Grumble, UT!
7294 * Article Signature:: What is a signature?
7295 * Article Miscellania:: Various other stuff.
7299 @node Article Highlighting
7300 @subsection Article Highlighting
7301 @cindex highlighting
7303 Not only do you want your article buffer to look like fruit salad, but
7304 you want it to look like technicolor fruit salad.
7309 @kindex W H a (Summary)
7310 @findex gnus-article-highlight
7311 @findex gnus-article-maybe-highlight
7312 Do much highlighting of the current article
7313 (@code{gnus-article-highlight}). This function highlights header, cited
7314 text, the signature, and adds buttons to the body and the head.
7317 @kindex W H h (Summary)
7318 @findex gnus-article-highlight-headers
7319 @vindex gnus-header-face-alist
7320 Highlight the headers (@code{gnus-article-highlight-headers}). The
7321 highlighting will be done according to the @code{gnus-header-face-alist}
7322 variable, which is a list where each element has the form
7323 @code{(@var{regexp} @var{name} @var{content})}.
7324 @var{regexp} is a regular expression for matching the
7325 header, @var{name} is the face used for highlighting the header name
7326 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
7327 the header value. The first match made will be used. Note that
7328 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
7331 @kindex W H c (Summary)
7332 @findex gnus-article-highlight-citation
7333 Highlight cited text (@code{gnus-article-highlight-citation}).
7335 Some variables to customize the citation highlights:
7338 @vindex gnus-cite-parse-max-size
7340 @item gnus-cite-parse-max-size
7341 If the article size if bigger than this variable (which is 25000 by
7342 default), no citation highlighting will be performed.
7344 @item gnus-cite-max-prefix
7345 @vindex gnus-cite-max-prefix
7346 Maximum possible length for a citation prefix (default 20).
7348 @item gnus-cite-face-list
7349 @vindex gnus-cite-face-list
7350 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
7351 When there are citations from multiple articles in the same message,
7352 Gnus will try to give each citation from each article its own face.
7353 This should make it easier to see who wrote what.
7355 @item gnus-supercite-regexp
7356 @vindex gnus-supercite-regexp
7357 Regexp matching normal Supercite attribution lines.
7359 @item gnus-supercite-secondary-regexp
7360 @vindex gnus-supercite-secondary-regexp
7361 Regexp matching mangled Supercite attribution lines.
7363 @item gnus-cite-minimum-match-count
7364 @vindex gnus-cite-minimum-match-count
7365 Minimum number of identical prefixes we have to see before we believe
7366 that it's a citation.
7368 @item gnus-cite-attribution-prefix
7369 @vindex gnus-cite-attribution-prefix
7370 Regexp matching the beginning of an attribution line.
7372 @item gnus-cite-attribution-suffix
7373 @vindex gnus-cite-attribution-suffix
7374 Regexp matching the end of an attribution line.
7376 @item gnus-cite-attribution-face
7377 @vindex gnus-cite-attribution-face
7378 Face used for attribution lines. It is merged with the face for the
7379 cited text belonging to the attribution.
7385 @kindex W H s (Summary)
7386 @vindex gnus-signature-separator
7387 @vindex gnus-signature-face
7388 @findex gnus-article-highlight-signature
7389 Highlight the signature (@code{gnus-article-highlight-signature}).
7390 Everything after @code{gnus-signature-separator} (@pxref{Article
7391 Signature}) in an article will be considered a signature and will be
7392 highlighted with @code{gnus-signature-face}, which is @code{italic} by
7397 @xref{Customizing Articles}, for how to highlight articles automatically.
7400 @node Article Fontisizing
7401 @subsection Article Fontisizing
7403 @cindex article emphasis
7405 @findex gnus-article-emphasize
7406 @kindex W e (Summary)
7407 People commonly add emphasis to words in news articles by writing things
7408 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
7409 this look nicer by running the article through the @kbd{W e}
7410 (@code{gnus-article-emphasize}) command.
7412 @vindex gnus-emphasis-alist
7413 How the emphasis is computed is controlled by the
7414 @code{gnus-emphasis-alist} variable. This is an alist where the first
7415 element is a regular expression to be matched. The second is a number
7416 that says what regular expression grouping is used to find the entire
7417 emphasized word. The third is a number that says what regexp grouping
7418 should be displayed and highlighted. (The text between these two
7419 groupings will be hidden.) The fourth is the face used for
7423 (setq gnus-emphasis-alist
7424 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
7425 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
7434 @vindex gnus-emphasis-underline
7435 @vindex gnus-emphasis-bold
7436 @vindex gnus-emphasis-italic
7437 @vindex gnus-emphasis-underline-bold
7438 @vindex gnus-emphasis-underline-italic
7439 @vindex gnus-emphasis-bold-italic
7440 @vindex gnus-emphasis-underline-bold-italic
7441 By default, there are seven rules, and they use the following faces:
7442 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
7443 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
7444 @code{gnus-emphasis-underline-italic},
7445 @code{gnus-emphasis-underline-bold}, and
7446 @code{gnus-emphasis-underline-bold-italic}.
7448 If you want to change these faces, you can either use @kbd{M-x
7449 customize}, or you can use @code{copy-face}. For instance, if you want
7450 to make @code{gnus-emphasis-italic} use a red face instead, you could
7454 (copy-face 'red 'gnus-emphasis-italic)
7457 @vindex gnus-group-highlight-words-alist
7459 If you want to highlight arbitrary words, you can use the
7460 @code{gnus-group-highlight-words-alist} variable, which uses the same
7461 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
7462 parameter (@pxref{Group Parameters}) can also be used.
7464 @xref{Customizing Articles}, for how to fontize articles automatically.
7467 @node Article Hiding
7468 @subsection Article Hiding
7469 @cindex article hiding
7471 Or rather, hiding certain things in each article. There usually is much
7472 too much cruft in most articles.
7477 @kindex W W a (Summary)
7478 @findex gnus-article-hide
7479 Do quite a lot of hiding on the article buffer
7480 (@kbd{gnus-article-hide}). In particular, this function will hide
7481 headers, PGP, cited text and the signature.
7484 @kindex W W h (Summary)
7485 @findex gnus-article-hide-headers
7486 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
7490 @kindex W W b (Summary)
7491 @findex gnus-article-hide-boring-headers
7492 Hide headers that aren't particularly interesting
7493 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
7496 @kindex W W s (Summary)
7497 @findex gnus-article-hide-signature
7498 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
7502 @kindex W W l (Summary)
7503 @findex gnus-article-hide-list-identifiers
7504 @vindex gnus-list-identifiers
7505 Strip list identifiers specified in @code{gnus-list-identifiers}. These
7506 are strings some mailing list servers add to the beginning of all
7507 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
7508 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
7509 may not contain @code{\\(..\\)}.
7513 @item gnus-list-identifiers
7514 @vindex gnus-list-identifiers
7515 A regular expression that matches list identifiers to be removed from
7516 subject. This can also be a list of regular expressions.
7521 @kindex W W p (Summary)
7522 @findex gnus-article-hide-pgp
7523 @vindex gnus-article-hide-pgp-hook
7524 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). The
7525 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
7526 signature has been hidden. For example, to automatically verify
7527 articles that have signatures in them do:
7529 ;;; Hide pgp cruft if any.
7531 (setq gnus-treat-strip-pgp t)
7533 ;;; After hiding pgp, verify the message;
7534 ;;; only happens if pgp signature is found.
7536 (add-hook 'gnus-article-hide-pgp-hook
7539 (set-buffer gnus-original-article-buffer)
7544 @kindex W W P (Summary)
7545 @findex gnus-article-hide-pem
7546 Hide @sc{pem} (privacy enhanced messages) cruft
7547 (@code{gnus-article-hide-pem}).
7550 @kindex W W B (Summary)
7551 @findex gnus-article-strip-banner
7554 @cindex stripping advertisements
7555 @cindex advertisements
7556 Strip the banner specified by the @code{banner} group parameter
7557 (@code{gnus-article-strip-banner}). This is mainly used to hide those
7558 annoying banners and/or signatures that some mailing lists and moderated
7559 groups adds to all the messages. The way to use this function is to add
7560 the @code{banner} group parameter (@pxref{Group Parameters}) to the
7561 group you want banners stripped from. The parameter either be a string,
7562 which will be interpreted as a regular expression matching text to be
7563 removed, or the symbol @code{signature}, meaning that the (last)
7564 signature should be removed, or other symbol, meaning that the
7565 corresponding regular expression in @code{gnus-article-banner-alist} is
7569 @kindex W W c (Summary)
7570 @findex gnus-article-hide-citation
7571 Hide citation (@code{gnus-article-hide-citation}). Some variables for
7572 customizing the hiding:
7576 @item gnus-cited-opened-text-button-line-format
7577 @itemx gnus-cited-closed-text-button-line-format
7578 @vindex gnus-cited-closed-text-button-line-format
7579 @vindex gnus-cited-opened-text-button-line-format
7580 Gnus adds buttons to show where the cited text has been hidden, and to
7581 allow toggle hiding the text. The format of the variable is specified
7582 by these format-like variable (@pxref{Formatting Variables}). These
7587 Starting point of the hidden text.
7589 Ending point of the hidden text.
7591 Number of characters in the hidden region.
7593 Number of lines of hidden text.
7596 @item gnus-cited-lines-visible
7597 @vindex gnus-cited-lines-visible
7598 The number of lines at the beginning of the cited text to leave
7599 shown. This can also be a cons cell with the number of lines at the top
7600 and bottom of the text, respectively, to remain visible.
7605 @kindex W W C-c (Summary)
7606 @findex gnus-article-hide-citation-maybe
7608 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
7609 following two variables:
7612 @item gnus-cite-hide-percentage
7613 @vindex gnus-cite-hide-percentage
7614 If the cited text is of a bigger percentage than this variable (default
7615 50), hide the cited text.
7617 @item gnus-cite-hide-absolute
7618 @vindex gnus-cite-hide-absolute
7619 The cited text must have at least this length (default 10) before it
7624 @kindex W W C (Summary)
7625 @findex gnus-article-hide-citation-in-followups
7626 Hide cited text in articles that aren't roots
7627 (@code{gnus-article-hide-citation-in-followups}). This isn't very
7628 useful as an interactive command, but might be a handy function to stick
7629 have happen automatically (@pxref{Customizing Articles}).
7633 All these ``hiding'' commands are toggles, but if you give a negative
7634 prefix to these commands, they will show what they have previously
7635 hidden. If you give a positive prefix, they will always hide.
7637 Also @pxref{Article Highlighting} for further variables for
7638 citation customization.
7640 @xref{Customizing Articles}, for how to hide article elements
7644 @node Article Washing
7645 @subsection Article Washing
7647 @cindex article washing
7649 We call this ``article washing'' for a really good reason. Namely, the
7650 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
7652 @dfn{Washing} is defined by us as ``changing something from something to
7653 something else'', but normally results in something looking better.
7656 @xref{Customizing Articles}, if you want to change how Gnus displays
7657 articles by default.
7662 This is not really washing, it's sort of the opposite of washing. If
7663 you type this, you see the article exactly as it exists on disk or on
7667 @kindex W l (Summary)
7668 @findex gnus-summary-stop-page-breaking
7669 Remove page breaks from the current article
7670 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
7674 @kindex W r (Summary)
7675 @findex gnus-summary-caesar-message
7676 @c @icon{gnus-summary-caesar-message}
7677 Do a Caesar rotate (rot13) on the article buffer
7678 (@code{gnus-summary-caesar-message}).
7679 Unreadable articles that tell you to read them with Caesar rotate or rot13.
7680 (Typically offensive jokes and such.)
7682 It's commonly called ``rot13'' because each letter is rotated 13
7683 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
7684 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
7685 is rumored to have employed this form of, uh, somewhat weak encryption.
7689 @kindex W t (Summary)
7691 @findex gnus-summary-toggle-header
7692 Toggle whether to display all headers in the article buffer
7693 (@code{gnus-summary-toggle-header}).
7696 @kindex W v (Summary)
7697 @findex gnus-summary-verbose-header
7698 Toggle whether to display all headers in the article buffer permanently
7699 (@code{gnus-summary-verbose-header}).
7702 @kindex W o (Summary)
7703 @findex gnus-article-treat-overstrike
7704 Treat overstrike (@code{gnus-article-treat-overstrike}).
7707 @kindex W d (Summary)
7708 @findex gnus-article-treat-dumbquotes
7709 @vindex gnus-article-dumbquotes-map
7711 @cindex M****s*** sm*rtq**t*s
7713 Treat M****s*** sm*rtq**t*s according to
7714 @code{gnus-article-dumbquotes-map}
7715 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
7716 whether a character is a sm*rtq**t* or not, so it should only be used
7719 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
7720 an attempt to provide more quoting characters. If you see something
7721 like @code{\222} or @code{\264} where you're expecting some kind of
7722 apostrophe or quotation mark, then try this wash.
7725 @kindex W w (Summary)
7726 @findex gnus-article-fill-cited-article
7727 Do word wrap (@code{gnus-article-fill-cited-article}).
7729 You can give the command a numerical prefix to specify the width to use
7733 @kindex W Q (Summary)
7734 @findex gnus-article-fill-long-lines
7735 Fill long lines (@code{gnus-article-fill-long-lines}).
7738 @kindex W C (Summary)
7739 @findex gnus-article-capitalize-sentences
7740 Capitalize the first word in each sentence
7741 (@code{gnus-article-capitalize-sentences}).
7744 @kindex W c (Summary)
7745 @findex gnus-article-remove-cr
7746 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
7747 (this takes care of DOS line endings), and then translate any remaining
7748 CRs into LF (this takes care of Mac line endings)
7749 (@code{gnus-article-remove-cr}).
7752 @kindex W q (Summary)
7753 @findex gnus-article-de-quoted-unreadable
7754 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
7755 Quoted-Printable is one common @sc{mime} encoding employed when sending
7756 non-ASCII (i. e., 8-bit) articles. It typically makes strings like
7757 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
7758 readable to me. Note that the this is usually done automatically by
7759 Gnus if the message in question has a @code{Content-Transfer-Encoding}
7760 header that says that this encoding has been done.
7761 If a prefix is given, a charset will be asked for.
7764 @kindex W 6 (Summary)
7765 @findex gnus-article-de-base64-unreadable
7766 Treat base64 (@code{gnus-article-de-base64-unreadable}).
7767 Base64 is one common @sc{mime} encoding employed when sending non-ASCII
7768 (i. e., 8-bit) articles. Note that the this is usually done
7769 automatically by Gnus if the message in question has a
7770 @code{Content-Transfer-Encoding} header that says that this encoding has
7772 If a prefix is given, a charset will be asked for.
7775 @kindex W Z (Summary)
7776 @findex gnus-article-decode-HZ
7777 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
7778 common encoding employed when sending Chinese articles. It typically
7779 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
7782 @kindex W h (Summary)
7783 @findex gnus-article-wash-html
7784 Treat HTML (@code{gnus-article-wash-html}).
7785 Note that the this is usually done automatically by Gnus if the message
7786 in question has a @code{Content-Type} header that says that this type
7788 If a prefix is given, a charset will be asked for.
7791 @kindex W f (Summary)
7793 @findex gnus-article-display-x-face
7794 @findex gnus-article-x-face-command
7795 @vindex gnus-article-x-face-command
7796 @vindex gnus-article-x-face-too-ugly
7803 Look for and display any X-Face headers
7804 (@code{gnus-article-display-x-face}). The command executed by this
7805 function is given by the @code{gnus-article-x-face-command} variable.
7806 If this variable is a string, this string will be executed in a
7807 sub-shell. If it is a function, this function will be called with the
7808 face as the argument. If the @code{gnus-article-x-face-too-ugly} (which
7809 is a regexp) matches the @code{From} header, the face will not be shown.
7810 The default action under Emacs is to fork off the @code{display}
7811 program@footnote{@code{display} is from the ImageMagick package. For the
7812 @code{uncompface} and @code{icontopbm} programs look for a package
7813 like `compface' or `faces-xface' on a GNU/Linux system.}
7814 to view the face. Under XEmacs or Emacs 21+ with suitable image
7815 support, the default action is to display the face before the
7816 @code{From} header. (It's nicer if XEmacs has been compiled with X-Face
7817 support---that will make display somewhat faster. If there's no native
7818 X-Face support, Gnus will try to convert the @code{X-Face} header using
7819 external programs from the @code{pbmplus} package and
7820 friends.@footnote{On a GNU/Linux system look for packages with names
7821 like @code{netpbm} or @code{libgr-progs}.}) If you
7822 want to have this function in the display hook, it should probably come
7826 @kindex W b (Summary)
7827 @findex gnus-article-add-buttons
7828 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
7829 @xref{Article Buttons}.
7832 @kindex W B (Summary)
7833 @findex gnus-article-add-buttons-to-head
7834 Add clickable buttons to the article headers
7835 (@code{gnus-article-add-buttons-to-head}).
7838 @kindex W p (Summary)
7839 @findex gnus-article-verify-x-pgp-sig
7840 Verify a signed control message (@code{gnus-article-verify-x-pgp-sig}).
7841 Control messages such as @code{newgroup} and @code{checkgroups} are
7842 usually signed by the hierarchy maintainer. You need to add the PGP
7843 public key of the maintainer to your keyring to verify the
7844 message.@footnote{PGP keys for many hierarchies are available at
7845 @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
7848 @kindex W W H (Summary)
7849 @findex gnus-article-strip-headers-from-body
7850 Strip headers like the @code{X-No-Archive} header from the beginning of
7851 article bodies (@code{gnus-article-strip-headers-from-body}).
7854 @kindex W E l (Summary)
7855 @findex gnus-article-strip-leading-blank-lines
7856 Remove all blank lines from the beginning of the article
7857 (@code{gnus-article-strip-leading-blank-lines}).
7860 @kindex W E m (Summary)
7861 @findex gnus-article-strip-multiple-blank-lines
7862 Replace all blank lines with empty lines and then all multiple empty
7863 lines with a single empty line.
7864 (@code{gnus-article-strip-multiple-blank-lines}).
7867 @kindex W E t (Summary)
7868 @findex gnus-article-remove-trailing-blank-lines
7869 Remove all blank lines at the end of the article
7870 (@code{gnus-article-remove-trailing-blank-lines}).
7873 @kindex W E a (Summary)
7874 @findex gnus-article-strip-blank-lines
7875 Do all the three commands above
7876 (@code{gnus-article-strip-blank-lines}).
7879 @kindex W E A (Summary)
7880 @findex gnus-article-strip-all-blank-lines
7881 Remove all blank lines
7882 (@code{gnus-article-strip-all-blank-lines}).
7885 @kindex W E s (Summary)
7886 @findex gnus-article-strip-leading-space
7887 Remove all white space from the beginning of all lines of the article
7888 body (@code{gnus-article-strip-leading-space}).
7891 @kindex W E e (Summary)
7892 @findex gnus-article-strip-trailing-space
7893 Remove all white space from the end of all lines of the article
7894 body (@code{gnus-article-strip-trailing-space}).
7898 @xref{Customizing Articles}, for how to wash articles automatically.
7901 @node Article Buttons
7902 @subsection Article Buttons
7905 People often include references to other stuff in articles, and it would
7906 be nice if Gnus could just fetch whatever it is that people talk about
7907 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
7908 button on these references.
7910 Gnus adds @dfn{buttons} to certain standard references by default:
7911 Well-formed URLs, mail addresses and Message-IDs. This is controlled by
7912 two variables, one that handles article bodies and one that handles
7917 @item gnus-button-alist
7918 @vindex gnus-button-alist
7919 This is an alist where each entry has this form:
7922 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
7928 All text that match this regular expression will be considered an
7929 external reference. Here's a typical regexp that matches embedded URLs:
7930 @samp{<URL:\\([^\n\r>]*\\)>}.
7933 Gnus has to know which parts of the matches is to be highlighted. This
7934 is a number that says what sub-expression of the regexp is to be
7935 highlighted. If you want it all highlighted, you use 0 here.
7938 This form will be @code{eval}ed, and if the result is non-@code{nil},
7939 this is considered a match. This is useful if you want extra sifting to
7940 avoid false matches.
7943 This function will be called when you click on this button.
7946 As with @var{button-par}, this is a sub-expression number, but this one
7947 says which part of the match is to be sent as data to @var{function}.
7951 So the full entry for buttonizing URLs is then
7954 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
7957 @item gnus-header-button-alist
7958 @vindex gnus-header-button-alist
7959 This is just like the other alist, except that it is applied to the
7960 article head only, and that each entry has an additional element that is
7961 used to say what headers to apply the buttonize coding to:
7964 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
7967 @var{header} is a regular expression.
7969 @item gnus-button-url-regexp
7970 @vindex gnus-button-url-regexp
7971 A regular expression that matches embedded URLs. It is used in the
7972 default values of the variables above.
7974 @item gnus-article-button-face
7975 @vindex gnus-article-button-face
7976 Face used on buttons.
7978 @item gnus-article-mouse-face
7979 @vindex gnus-article-mouse-face
7980 Face used when the mouse cursor is over a button.
7984 @xref{Customizing Articles}, for how to buttonize articles automatically.
7988 @subsection Article Date
7990 The date is most likely generated in some obscure timezone you've never
7991 heard of, so it's quite nice to be able to find out what the time was
7992 when the article was sent.
7997 @kindex W T u (Summary)
7998 @findex gnus-article-date-ut
7999 Display the date in UT (aka. GMT, aka ZULU)
8000 (@code{gnus-article-date-ut}).
8003 @kindex W T i (Summary)
8004 @findex gnus-article-date-iso8601
8006 Display the date in international format, aka. ISO 8601
8007 (@code{gnus-article-date-iso8601}).
8010 @kindex W T l (Summary)
8011 @findex gnus-article-date-local
8012 Display the date in the local timezone (@code{gnus-article-date-local}).
8015 @kindex W T p (Summary)
8016 @findex gnus-article-date-english
8017 Display the date in a format that's easily pronounceable in English
8018 (@code{gnus-article-date-english}).
8021 @kindex W T s (Summary)
8022 @vindex gnus-article-time-format
8023 @findex gnus-article-date-user
8024 @findex format-time-string
8025 Display the date using a user-defined format
8026 (@code{gnus-article-date-user}). The format is specified by the
8027 @code{gnus-article-time-format} variable, and is a string that's passed
8028 to @code{format-time-string}. See the documentation of that variable
8029 for a list of possible format specs.
8032 @kindex W T e (Summary)
8033 @findex gnus-article-date-lapsed
8034 @findex gnus-start-date-timer
8035 @findex gnus-stop-date-timer
8036 Say how much time has elapsed between the article was posted and now
8037 (@code{gnus-article-date-lapsed}). It looks something like:
8040 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
8043 The value of @code{gnus-article-date-lapsed-new-header} determines
8044 whether this header will just be added below the old Date one, or will
8047 An advantage of using Gnus to read mail is that it converts simple bugs
8048 into wonderful absurdities.
8050 If you want to have this line updated continually, you can put
8053 (gnus-start-date-timer)
8056 in your @file{.gnus.el} file, or you can run it off of some hook. If
8057 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
8061 @kindex W T o (Summary)
8062 @findex gnus-article-date-original
8063 Display the original date (@code{gnus-article-date-original}). This can
8064 be useful if you normally use some other conversion function and are
8065 worried that it might be doing something totally wrong. Say, claiming
8066 that the article was posted in 1854. Although something like that is
8067 @emph{totally} impossible. Don't you trust me? *titter*
8071 @xref{Customizing Articles}, for how to display the date in your
8072 preferred format automatically.
8075 @node Article Signature
8076 @subsection Article Signature
8078 @cindex article signature
8080 @vindex gnus-signature-separator
8081 Each article is divided into two parts---the head and the body. The
8082 body can be divided into a signature part and a text part. The variable
8083 that says what is to be considered a signature is
8084 @code{gnus-signature-separator}. This is normally the standard
8085 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
8086 non-standard signature separators, so this variable can also be a list
8087 of regular expressions to be tested, one by one. (Searches are done
8088 from the end of the body towards the beginning.) One likely value is:
8091 (setq gnus-signature-separator
8092 '("^-- $" ; The standard
8093 "^-- *$" ; A common mangling
8094 "^-------*$" ; Many people just use a looong
8095 ; line of dashes. Shame!
8096 "^ *--------*$" ; Double-shame!
8097 "^________*$" ; Underscores are also popular
8098 "^========*$")) ; Pervert!
8101 The more permissive you are, the more likely it is that you'll get false
8104 @vindex gnus-signature-limit
8105 @code{gnus-signature-limit} provides a limit to what is considered a
8106 signature when displaying articles.
8110 If it is an integer, no signature may be longer (in characters) than
8113 If it is a floating point number, no signature may be longer (in lines)
8116 If it is a function, the function will be called without any parameters,
8117 and if it returns @code{nil}, there is no signature in the buffer.
8119 If it is a string, it will be used as a regexp. If it matches, the text
8120 in question is not a signature.
8123 This variable can also be a list where the elements may be of the types
8124 listed above. Here's an example:
8127 (setq gnus-signature-limit
8128 '(200.0 "^---*Forwarded article"))
8131 This means that if there are more than 200 lines after the signature
8132 separator, or the text after the signature separator is matched by
8133 the regular expression @samp{^---*Forwarded article}, then it isn't a
8134 signature after all.
8137 @node Article Miscellania
8138 @subsection Article Miscellania
8142 @kindex A t (Summary)
8143 @findex gnus-article-babel
8144 Translate the article from one language to another
8145 (@code{gnus-article-babel}).
8151 @section @sc{mime} Commands
8152 @cindex MIME decoding
8154 @cindex viewing attachments
8156 The following commands all understand the numerical prefix. For
8157 instance, @kbd{3 b} means ``view the third @sc{mime} part''.
8163 @kindex K v (Summary)
8164 View the @sc{mime} part.
8167 @kindex K o (Summary)
8168 Save the @sc{mime} part.
8171 @kindex K c (Summary)
8172 Copy the @sc{mime} part.
8175 @kindex K e (Summary)
8176 View the @sc{mime} part externally.
8179 @kindex K i (Summary)
8180 View the @sc{mime} part internally.
8183 @kindex K | (Summary)
8184 Pipe the @sc{mime} part to an external command.
8187 The rest of these @sc{mime} commands do not use the numerical prefix in
8192 @kindex K b (Summary)
8193 Make all the @sc{mime} parts have buttons in front of them. This is
8194 mostly useful if you wish to save (or perform other actions) on inlined
8198 @kindex K m (Summary)
8199 @findex gnus-summary-repair-multipart
8200 Some multipart messages are transmitted with missing or faulty headers.
8201 This command will attempt to ``repair'' these messages so that they can
8202 be viewed in a more pleasant manner
8203 (@code{gnus-summary-repair-multipart}).
8206 @kindex X m (Summary)
8207 @findex gnus-summary-save-parts
8208 Save all parts matching a @sc{mime} type to a directory
8209 (@code{gnus-summary-save-parts}). Understands the process/prefix
8210 convention (@pxref{Process/Prefix}).
8213 @kindex M-t (Summary)
8214 @findex gnus-summary-display-buttonized
8215 Toggle the buttonized display of the article buffer
8216 (@code{gnus-summary-toggle-display-buttonized}).
8219 @kindex W M w (Summary)
8220 Decode RFC 2047-encoded words in the article headers
8221 (@code{gnus-article-decode-mime-words}).
8224 @kindex W M c (Summary)
8225 Decode encoded article bodies as well as charsets
8226 (@code{gnus-article-decode-charset}).
8228 This command looks in the @code{Content-Type} header to determine the
8229 charset. If there is no such header in the article, you can give it a
8230 prefix, which will prompt for the charset to decode as. In regional
8231 groups where people post using some common encoding (but do not include
8232 MIME headers), you can set the @code{charset} group/topic parameter to
8233 the required charset (@pxref{Group Parameters}).
8236 @kindex W M v (Summary)
8237 View all the @sc{mime} parts in the current article
8238 (@code{gnus-mime-view-all-parts}).
8245 @item gnus-ignored-mime-types
8246 @vindex gnus-ignored-mime-types
8247 This is a list of regexps. @sc{mime} types that match a regexp from
8248 this list will be completely ignored by Gnus. The default value is
8251 To have all Vcards be ignored, you'd say something like this:
8254 (setq gnus-ignored-mime-types
8258 @item gnus-unbuttonized-mime-types
8259 @vindex gnus-unbuttonized-mime-types
8260 This is a list of regexps. @sc{mime} types that match a regexp from
8261 this list won't have @sc{mime} buttons inserted unless they aren't
8262 displayed. The default value is @code{(".*/.*")}.
8264 @item gnus-article-mime-part-function
8265 @vindex gnus-article-mime-part-function
8266 For each @sc{mime} part, this function will be called with the @sc{mime}
8267 handle as the parameter. The function is meant to be used to allow
8268 users to gather information from the article (e. g., add Vcard info to
8269 the bbdb database) or to do actions based on parts (e. g., automatically
8270 save all jpegs into some directory).
8272 Here's an example function the does the latter:
8275 (defun my-save-all-jpeg-parts (handle)
8276 (when (equal (car (mm-handle-type handle)) "image/jpeg")
8278 (insert (mm-get-part handle))
8279 (write-region (point-min) (point-max)
8280 (read-file-name "Save jpeg to: ")))))
8281 (setq gnus-article-mime-part-function
8282 'my-save-all-jpeg-parts)
8285 @vindex gnus-mime-multipart-functions
8286 @item gnus-mime-multipart-functions
8287 Alist of @sc{mime} multipart types and functions to handle them.
8289 @vindex mm-file-name-rewrite-functions
8290 @item mm-file-name-rewrite-functions
8291 List of functions used for rewriting file names of @sc{mime} parts.
8292 Each function takes a file name as input and returns a file name.
8294 Ready-made functions include@*
8295 @code{mm-file-name-delete-whitespace},
8296 @code{mm-file-name-trim-whitespace},
8297 @code{mm-file-name-collapse-whitespace}, and
8298 @code{mm-file-name-replace-whitespace}. The later uses the value of
8299 the variable @code{mm-file-name-replace-whitespace} to replace each
8300 whitespace character in a file name with that string; default value
8301 is @code{"_"} (a single underscore).
8302 @findex mm-file-name-delete-whitespace
8303 @findex mm-file-name-trim-whitespace
8304 @findex mm-file-name-collapse-whitespace
8305 @findex mm-file-name-replace-whitespace
8306 @vindex mm-file-name-replace-whitespace
8308 The standard functions @code{capitalize}, @code{downcase},
8309 @code{upcase}, and @code{upcase-initials} may be useful, too.
8311 Everybody knows that whitespace characters in file names are evil,
8312 except those who don't know. If you receive lots of attachments from
8313 such unenlightened users, you can make live easier by adding
8316 (setq mm-file-name-rewrite-functions
8317 '(mm-file-name-trim-whitespace
8318 mm-file-name-collapse-whitespace
8319 mm-file-name-replace-whitespace))
8323 to your @file{.gnus} file.
8332 People use different charsets, and we have @sc{mime} to let us know what
8333 charsets they use. Or rather, we wish we had. Many people use
8334 newsreaders and mailers that do not understand or use @sc{mime}, and
8335 just send out messages without saying what character sets they use. To
8336 help a bit with this, some local news hierarchies have policies that say
8337 what character set is the default. For instance, the @samp{fj}
8338 hierarchy uses @code{iso-2022-jp-2}.
8340 @vindex gnus-group-charset-alist
8341 This knowledge is encoded in the @code{gnus-group-charset-alist}
8342 variable, which is an alist of regexps (use the first item to match full
8343 group names) and default charsets to be used when reading these groups.
8345 In addition, some people do use soi-disant @sc{mime}-aware agents that
8346 aren't. These blithely mark messages as being in @code{iso-8859-1} even
8347 if they really are in @code{koi-8}. To help here, the
8348 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
8349 charsets that are listed here will be ignored. The variable can be set
8350 on a group-by-group basis using the group parameters (@pxref{Group
8351 Parameters}). The default value is @code{(unknown-8bit)}, which is
8352 something some agents insist on having in there.
8354 @vindex gnus-group-posting-charset-alist
8355 When posting, @code{gnus-group-posting-charset-alist} is used to
8356 determine which charsets should not be encoded using the @sc{mime}
8357 encodings. For instance, some hierarchies discourage using
8358 quoted-printable header encoding.
8360 This variable is an alist of regexps and permitted unencoded charsets
8361 for posting. Each element of the alist has the form @code{(}@var{test
8362 header body-list}@code{)}, where:
8366 is either a regular expression matching the newsgroup header or a
8369 is the charset which may be left unencoded in the header (@code{nil}
8370 means encode all charsets),
8372 is a list of charsets which may be encoded using 8bit content-transfer
8373 encoding in the body, or one of the special values @code{nil} (always
8374 encode using quoted-printable) or @code{t} (always use 8bit).
8381 @cindex coding system aliases
8382 @cindex preferred charset
8384 Other charset tricks that may be useful, although not Gnus-specific:
8386 If there are several @sc{mime} charsets that encode the same Emacs
8387 charset, you can choose what charset to use by saying the following:
8390 (put-charset-property 'cyrillic-iso8859-5
8391 'preferred-coding-system 'koi8-r)
8394 This means that Russian will be encoded using @code{koi8-r} instead of
8395 the default @code{iso-8859-5} @sc{mime} charset.
8397 If you want to read messages in @code{koi8-u}, you can cheat and say
8400 (define-coding-system-alias 'koi8-u 'koi8-r)
8403 This will almost do the right thing.
8405 And finally, to read charsets like @code{windows-1251}, you can say
8409 (codepage-setup 1251)
8410 (define-coding-system-alias 'windows-1251 'cp1251)
8414 @node Article Commands
8415 @section Article Commands
8422 @kindex A P (Summary)
8423 @vindex gnus-ps-print-hook
8424 @findex gnus-summary-print-article
8425 Generate and print a PostScript image of the article buffer
8426 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be
8427 run just before printing the buffer.
8432 @node Summary Sorting
8433 @section Summary Sorting
8434 @cindex summary sorting
8436 You can have the summary buffer sorted in various ways, even though I
8437 can't really see why you'd want that.
8442 @kindex C-c C-s C-n (Summary)
8443 @findex gnus-summary-sort-by-number
8444 Sort by article number (@code{gnus-summary-sort-by-number}).
8447 @kindex C-c C-s C-a (Summary)
8448 @findex gnus-summary-sort-by-author
8449 Sort by author (@code{gnus-summary-sort-by-author}).
8452 @kindex C-c C-s C-s (Summary)
8453 @findex gnus-summary-sort-by-subject
8454 Sort by subject (@code{gnus-summary-sort-by-subject}).
8457 @kindex C-c C-s C-d (Summary)
8458 @findex gnus-summary-sort-by-date
8459 Sort by date (@code{gnus-summary-sort-by-date}).
8462 @kindex C-c C-s C-l (Summary)
8463 @findex gnus-summary-sort-by-lines
8464 Sort by lines (@code{gnus-summary-sort-by-lines}).
8467 @kindex C-c C-s C-c (Summary)
8468 @findex gnus-summary-sort-by-chars
8469 Sort by article length (@code{gnus-summary-sort-by-chars}).
8472 @kindex C-c C-s C-i (Summary)
8473 @findex gnus-summary-sort-by-score
8474 Sort by score (@code{gnus-summary-sort-by-score}).
8477 @kindex C-c C-s C-o (Summary)
8478 @findex gnus-summary-sort-by-original
8479 Sort using the default sorting method
8480 (@code{gnus-summary-sort-by-original}).
8483 These functions will work both when you use threading and when you don't
8484 use threading. In the latter case, all summary lines will be sorted,
8485 line by line. In the former case, sorting will be done on a
8486 root-by-root basis, which might not be what you were looking for. To
8487 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
8491 @node Finding the Parent
8492 @section Finding the Parent
8493 @cindex parent articles
8494 @cindex referring articles
8499 @findex gnus-summary-refer-parent-article
8500 If you'd like to read the parent of the current article, and it is not
8501 displayed in the summary buffer, you might still be able to. That is,
8502 if the current group is fetched by @sc{nntp}, the parent hasn't expired
8503 and the @code{References} in the current article are not mangled, you
8504 can just press @kbd{^} or @kbd{A r}
8505 (@code{gnus-summary-refer-parent-article}). If everything goes well,
8506 you'll get the parent. If the parent is already displayed in the
8507 summary buffer, point will just move to this article.
8509 If given a positive numerical prefix, fetch that many articles back into
8510 the ancestry. If given a negative numerical prefix, fetch just that
8511 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
8512 grandparent and the grandgrandparent of the current article. If you say
8513 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
8517 @findex gnus-summary-refer-references
8518 @kindex A R (Summary)
8519 Fetch all articles mentioned in the @code{References} header of the
8520 article (@code{gnus-summary-refer-references}).
8523 @findex gnus-summary-refer-thread
8524 @kindex A T (Summary)
8525 Display the full thread where the current article appears
8526 (@code{gnus-summary-refer-thread}). This command has to fetch all the
8527 headers in the current group to work, so it usually takes a while. If
8528 you do it often, you may consider setting @code{gnus-fetch-old-headers}
8529 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
8530 visible effects normally, but it'll make this command work a whole lot
8531 faster. Of course, it'll make group entry somewhat slow.
8533 @vindex gnus-refer-thread-limit
8534 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
8535 articles before the first displayed in the current group) headers to
8536 fetch when doing this command. The default is 200. If @code{t}, all
8537 the available headers will be fetched. This variable can be overridden
8538 by giving the @kbd{A T} command a numerical prefix.
8541 @findex gnus-summary-refer-article
8542 @kindex M-^ (Summary)
8544 @cindex fetching by Message-ID
8545 You can also ask the @sc{nntp} server for an arbitrary article, no
8546 matter what group it belongs to. @kbd{M-^}
8547 (@code{gnus-summary-refer-article}) will ask you for a
8548 @code{Message-ID}, which is one of those long, hard-to-read thingies
8549 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
8550 have to get it all exactly right. No fuzzy searches, I'm afraid.
8553 The current select method will be used when fetching by
8554 @code{Message-ID} from non-news select method, but you can override this
8555 by giving this command a prefix.
8557 @vindex gnus-refer-article-method
8558 If the group you are reading is located on a backend that does not
8559 support fetching by @code{Message-ID} very well (like @code{nnspool}),
8560 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
8561 would, perhaps, be best if the @sc{nntp} server you consult is the one
8562 updating the spool you are reading from, but that's not really
8565 It can also be a list of select methods, as well as the special symbol
8566 @code{current}, which means to use the current select method. If it
8567 is a list, Gnus will try all the methods in the list until it finds a
8570 Here's an example setting that will first try the current method, and
8571 then ask Deja if that fails:
8574 (setq gnus-refer-article-method
8576 (nnweb "refer" (nnweb-type dejanews))))
8579 Most of the mail backends support fetching by @code{Message-ID}, but do
8580 not do a particularly excellent job at it. That is, @code{nnmbox} and
8581 @code{nnbabyl} are able to locate articles from any groups, while
8582 @code{nnml} and @code{nnfolder} are only able to locate articles that
8583 have been posted to the current group. (Anything else would be too time
8584 consuming.) @code{nnmh} does not support this at all.
8587 @node Alternative Approaches
8588 @section Alternative Approaches
8590 Different people like to read news using different methods. This being
8591 Gnus, we offer a small selection of minor modes for the summary buffers.
8594 * Pick and Read:: First mark articles and then read them.
8595 * Binary Groups:: Auto-decode all articles.
8600 @subsection Pick and Read
8601 @cindex pick and read
8603 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
8604 a two-phased reading interface. The user first marks in a summary
8605 buffer the articles she wants to read. Then she starts reading the
8606 articles with just an article buffer displayed.
8608 @findex gnus-pick-mode
8609 @kindex M-x gnus-pick-mode
8610 Gnus provides a summary buffer minor mode that allows
8611 this---@code{gnus-pick-mode}. This basically means that a few process
8612 mark commands become one-keystroke commands to allow easy marking, and
8613 it provides one additional command for switching to the summary buffer.
8615 Here are the available keystrokes when using pick mode:
8620 @findex gnus-pick-article-or-thread
8621 Pick the article or thread on the current line
8622 (@code{gnus-pick-article-or-thread}). If the variable
8623 @code{gnus-thread-hide-subtree} is true, then this key selects the
8624 entire thread when used at the first article of the thread. Otherwise,
8625 it selects just the article. If given a numerical prefix, go to that
8626 thread or article and pick it. (The line number is normally displayed
8627 at the beginning of the summary pick lines.)
8630 @kindex SPACE (Pick)
8631 @findex gnus-pick-next-page
8632 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
8633 at the end of the buffer, start reading the picked articles.
8637 @findex gnus-pick-unmark-article-or-thread.
8638 Unpick the thread or article
8639 (@code{gnus-pick-unmark-article-or-thread}). If the variable
8640 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
8641 thread if used at the first article of the thread. Otherwise it unpicks
8642 just the article. You can give this key a numerical prefix to unpick
8643 the thread or article at that line.
8647 @findex gnus-pick-start-reading
8648 @vindex gnus-pick-display-summary
8649 Start reading the picked articles (@code{gnus-pick-start-reading}). If
8650 given a prefix, mark all unpicked articles as read first. If
8651 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
8652 will still be visible when you are reading.
8656 All the normal summary mode commands are still available in the
8657 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
8658 which is mapped to the same function
8659 @code{gnus-summary-tick-article-forward}.
8661 If this sounds like a good idea to you, you could say:
8664 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
8667 @vindex gnus-pick-mode-hook
8668 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
8670 @vindex gnus-mark-unpicked-articles-as-read
8671 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
8672 all unpicked articles as read. The default is @code{nil}.
8674 @vindex gnus-summary-pick-line-format
8675 The summary line format in pick mode is slightly different from the
8676 standard format. At the beginning of each line the line number is
8677 displayed. The pick mode line format is controlled by the
8678 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
8679 Variables}). It accepts the same format specs that
8680 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
8684 @subsection Binary Groups
8685 @cindex binary groups
8687 @findex gnus-binary-mode
8688 @kindex M-x gnus-binary-mode
8689 If you spend much time in binary groups, you may grow tired of hitting
8690 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
8691 is a minor mode for summary buffers that makes all ordinary Gnus article
8692 selection functions uudecode series of articles and display the result
8693 instead of just displaying the articles the normal way.
8696 @findex gnus-binary-show-article
8697 The only way, in fact, to see the actual articles is the @kbd{g}
8698 command, when you have turned on this mode
8699 (@code{gnus-binary-show-article}).
8701 @vindex gnus-binary-mode-hook
8702 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
8706 @section Tree Display
8709 @vindex gnus-use-trees
8710 If you don't like the normal Gnus summary display, you might try setting
8711 @code{gnus-use-trees} to @code{t}. This will create (by default) an
8712 additional @dfn{tree buffer}. You can execute all summary mode commands
8715 There are a few variables to customize the tree display, of course:
8718 @item gnus-tree-mode-hook
8719 @vindex gnus-tree-mode-hook
8720 A hook called in all tree mode buffers.
8722 @item gnus-tree-mode-line-format
8723 @vindex gnus-tree-mode-line-format
8724 A format string for the mode bar in the tree mode buffers (@pxref{Mode
8725 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
8726 of valid specs, @pxref{Summary Buffer Mode Line}.
8728 @item gnus-selected-tree-face
8729 @vindex gnus-selected-tree-face
8730 Face used for highlighting the selected article in the tree buffer. The
8731 default is @code{modeline}.
8733 @item gnus-tree-line-format
8734 @vindex gnus-tree-line-format
8735 A format string for the tree nodes. The name is a bit of a misnomer,
8736 though---it doesn't define a line, but just the node. The default value
8737 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
8738 the name of the poster. It is vital that all nodes are of the same
8739 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
8745 The name of the poster.
8747 The @code{From} header.
8749 The number of the article.
8751 The opening bracket.
8753 The closing bracket.
8758 @xref{Formatting Variables}.
8760 Variables related to the display are:
8763 @item gnus-tree-brackets
8764 @vindex gnus-tree-brackets
8765 This is used for differentiating between ``real'' articles and
8766 ``sparse'' articles. The format is @code{((@var{real-open} . @var{real-close})
8767 (@var{sparse-open} . @var{sparse-close}) (@var{dummy-open} . @var{dummy-close}))}, and the
8768 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
8770 @item gnus-tree-parent-child-edges
8771 @vindex gnus-tree-parent-child-edges
8772 This is a list that contains the characters used for connecting parent
8773 nodes to their children. The default is @code{(?- ?\\ ?|)}.
8777 @item gnus-tree-minimize-window
8778 @vindex gnus-tree-minimize-window
8779 If this variable is non-@code{nil}, Gnus will try to keep the tree
8780 buffer as small as possible to allow more room for the other Gnus
8781 windows. If this variable is a number, the tree buffer will never be
8782 higher than that number. The default is @code{t}. Note that if you
8783 have several windows displayed side-by-side in a frame and the tree
8784 buffer is one of these, minimizing the tree window will also resize all
8785 other windows displayed next to it.
8787 @item gnus-generate-tree-function
8788 @vindex gnus-generate-tree-function
8789 @findex gnus-generate-horizontal-tree
8790 @findex gnus-generate-vertical-tree
8791 The function that actually generates the thread tree. Two predefined
8792 functions are available: @code{gnus-generate-horizontal-tree} and
8793 @code{gnus-generate-vertical-tree} (which is the default).
8797 Here's an example from a horizontal tree buffer:
8800 @{***@}-(***)-[odd]-[Gun]
8810 Here's the same thread displayed in a vertical tree buffer:
8814 |--------------------------\-----\-----\
8815 (***) [Bjo] [Gun] [Gun]
8817 [odd] [Jan] [odd] (***) [Jor]
8819 [Gun] [Eri] [Eri] [odd]
8824 If you're using horizontal trees, it might be nice to display the trees
8825 side-by-side with the summary buffer. You could add something like the
8826 following to your @file{.gnus.el} file:
8829 (setq gnus-use-trees t
8830 gnus-generate-tree-function 'gnus-generate-horizontal-tree
8831 gnus-tree-minimize-window nil)
8832 (gnus-add-configuration
8836 (summary 0.75 point)
8841 @xref{Window Layout}.
8844 @node Mail Group Commands
8845 @section Mail Group Commands
8846 @cindex mail group commands
8848 Some commands only make sense in mail groups. If these commands are
8849 invalid in the current group, they will raise a hell and let you know.
8851 All these commands (except the expiry and edit commands) use the
8852 process/prefix convention (@pxref{Process/Prefix}).
8857 @kindex B e (Summary)
8858 @findex gnus-summary-expire-articles
8859 Run all expirable articles in the current group through the expiry
8860 process (@code{gnus-summary-expire-articles}). That is, delete all
8861 expirable articles in the group that have been around for a while.
8862 (@pxref{Expiring Mail}).
8865 @kindex B M-C-e (Summary)
8866 @findex gnus-summary-expire-articles-now
8867 Delete all the expirable articles in the group
8868 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
8869 articles eligible for expiry in the current group will
8870 disappear forever into that big @file{/dev/null} in the sky.
8873 @kindex B DEL (Summary)
8874 @findex gnus-summary-delete-article
8875 @c @icon{gnus-summary-mail-delete}
8876 Delete the mail article. This is ``delete'' as in ``delete it from your
8877 disk forever and ever, never to return again.'' Use with caution.
8878 (@code{gnus-summary-delete-article}).
8881 @kindex B m (Summary)
8883 @findex gnus-summary-move-article
8884 @vindex gnus-preserve-marks
8885 Move the article from one mail group to another
8886 (@code{gnus-summary-move-article}). Marks will be preserved if
8887 @var{gnus-preserve-marks} is non-@code{nil} (which is the default).
8890 @kindex B c (Summary)
8892 @findex gnus-summary-copy-article
8893 @c @icon{gnus-summary-mail-copy}
8894 Copy the article from one group (mail group or not) to a mail group
8895 (@code{gnus-summary-copy-article}). Marks will be preserved if
8896 @var{gnus-preserve-marks} is non-@code{nil} (which is the default).
8899 @kindex B B (Summary)
8900 @cindex crosspost mail
8901 @findex gnus-summary-crosspost-article
8902 Crosspost the current article to some other group
8903 (@code{gnus-summary-crosspost-article}). This will create a new copy of
8904 the article in the other group, and the Xref headers of the article will
8905 be properly updated.
8908 @kindex B i (Summary)
8909 @findex gnus-summary-import-article
8910 Import an arbitrary file into the current mail newsgroup
8911 (@code{gnus-summary-import-article}). You will be prompted for a file
8912 name, a @code{From} header and a @code{Subject} header.
8915 @kindex B r (Summary)
8916 @findex gnus-summary-respool-article
8917 Respool the mail article (@code{gnus-summary-respool-article}).
8918 @code{gnus-summary-respool-default-method} will be used as the default
8919 select method when respooling. This variable is @code{nil} by default,
8920 which means that the current group select method will be used instead.
8921 Marks will be preserved if @var{gnus-preserve-marks} is non-@code{nil}
8922 (which is the default).
8926 @kindex B w (Summary)
8928 @findex gnus-summary-edit-article
8929 @kindex C-c C-c (Article)
8930 Edit the current article (@code{gnus-summary-edit-article}). To finish
8931 editing and make the changes permanent, type @kbd{C-c C-c}
8932 (@kbd{gnus-summary-edit-article-done}). If you give a prefix to the
8933 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
8936 @kindex B q (Summary)
8937 @findex gnus-summary-respool-query
8938 If you want to re-spool an article, you might be curious as to what group
8939 the article will end up in before you do the re-spooling. This command
8940 will tell you (@code{gnus-summary-respool-query}).
8943 @kindex B t (Summary)
8944 @findex gnus-summary-respool-trace
8945 Similarly, this command will display all fancy splitting patterns used
8946 when repooling, if any (@code{gnus-summary-respool-trace}).
8949 @kindex B p (Summary)
8950 @findex gnus-summary-article-posted-p
8951 Some people have a tendency to send you "courtesy" copies when they
8952 follow up to articles you have posted. These usually have a
8953 @code{Newsgroups} header in them, but not always. This command
8954 (@code{gnus-summary-article-posted-p}) will try to fetch the current
8955 article from your news server (or rather, from
8956 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
8957 report back whether it found the article or not. Even if it says that
8958 it didn't find the article, it may have been posted anyway---mail
8959 propagation is much faster than news propagation, and the news copy may
8960 just not have arrived yet.
8964 @vindex gnus-move-split-methods
8965 @cindex moving articles
8966 If you move (or copy) articles regularly, you might wish to have Gnus
8967 suggest where to put the articles. @code{gnus-move-split-methods} is a
8968 variable that uses the same syntax as @code{gnus-split-methods}
8969 (@pxref{Saving Articles}). You may customize that variable to create
8970 suggestions you find reasonable. (Note that
8971 @code{gnus-move-split-methods} uses group names where
8972 @code{gnus-split-methods} uses file names.)
8975 (setq gnus-move-split-methods
8976 '(("^From:.*Lars Magne" "nnml:junk")
8977 ("^Subject:.*gnus" "nnfolder:important")
8978 (".*" "nnml:misc")))
8982 @node Various Summary Stuff
8983 @section Various Summary Stuff
8986 * Summary Group Information:: Information oriented commands.
8987 * Searching for Articles:: Multiple article commands.
8988 * Summary Generation Commands::
8989 * Really Various Summary Commands:: Those pesky non-conformant commands.
8993 @vindex gnus-summary-mode-hook
8994 @item gnus-summary-mode-hook
8995 This hook is called when creating a summary mode buffer.
8997 @vindex gnus-summary-generate-hook
8998 @item gnus-summary-generate-hook
8999 This is called as the last thing before doing the threading and the
9000 generation of the summary buffer. It's quite convenient for customizing
9001 the threading variables based on what data the newsgroup has. This hook
9002 is called from the summary buffer after most summary buffer variables
9005 @vindex gnus-summary-prepare-hook
9006 @item gnus-summary-prepare-hook
9007 It is called after the summary buffer has been generated. You might use
9008 it to, for instance, highlight lines or modify the look of the buffer in
9009 some other ungodly manner. I don't care.
9011 @vindex gnus-summary-prepared-hook
9012 @item gnus-summary-prepared-hook
9013 A hook called as the very last thing after the summary buffer has been
9016 @vindex gnus-summary-ignore-duplicates
9017 @item gnus-summary-ignore-duplicates
9018 When Gnus discovers two articles that have the same @code{Message-ID},
9019 it has to do something drastic. No articles are allowed to have the
9020 same @code{Message-ID}, but this may happen when reading mail from some
9021 sources. Gnus allows you to customize what happens with this variable.
9022 If it is @code{nil} (which is the default), Gnus will rename the
9023 @code{Message-ID} (for display purposes only) and display the article as
9024 any other article. If this variable is @code{t}, it won't display the
9025 article---it'll be as if it never existed.
9027 @vindex gnus-alter-articles-to-read-function
9028 @item gnus-alter-articles-to-read-function
9029 This function, which takes two parameters (the group name and the list
9030 of articles to be selected), is called to allow the user to alter the
9031 list of articles to be selected.
9033 For instance, the following function adds the list of cached articles to
9034 the list in one particular group:
9037 (defun my-add-cached-articles (group articles)
9038 (if (string= group "some.group")
9039 (append gnus-newsgroup-cached articles)
9046 @node Summary Group Information
9047 @subsection Summary Group Information
9052 @kindex H f (Summary)
9053 @findex gnus-summary-fetch-faq
9054 @vindex gnus-group-faq-directory
9055 Try to fetch the FAQ (list of frequently asked questions) for the
9056 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
9057 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
9058 on a remote machine. This variable can also be a list of directories.
9059 In that case, giving a prefix to this command will allow you to choose
9060 between the various sites. @code{ange-ftp} or @code{efs} will probably
9061 be used for fetching the file.
9064 @kindex H d (Summary)
9065 @findex gnus-summary-describe-group
9066 Give a brief description of the current group
9067 (@code{gnus-summary-describe-group}). If given a prefix, force
9068 rereading the description from the server.
9071 @kindex H h (Summary)
9072 @findex gnus-summary-describe-briefly
9073 Give an extremely brief description of the most important summary
9074 keystrokes (@code{gnus-summary-describe-briefly}).
9077 @kindex H i (Summary)
9078 @findex gnus-info-find-node
9079 Go to the Gnus info node (@code{gnus-info-find-node}).
9083 @node Searching for Articles
9084 @subsection Searching for Articles
9089 @kindex M-s (Summary)
9090 @findex gnus-summary-search-article-forward
9091 Search through all subsequent (raw) articles for a regexp
9092 (@code{gnus-summary-search-article-forward}).
9095 @kindex M-r (Summary)
9096 @findex gnus-summary-search-article-backward
9097 Search through all previous (raw) articles for a regexp
9098 (@code{gnus-summary-search-article-backward}).
9102 @findex gnus-summary-execute-command
9103 This command will prompt you for a header, a regular expression to match
9104 on this field, and a command to be executed if the match is made
9105 (@code{gnus-summary-execute-command}). If the header is an empty
9106 string, the match is done on the entire article. If given a prefix,
9107 search backward instead.
9109 For instance, @kbd{& RET some.*string #} will put the process mark on
9110 all articles that have heads or bodies that match @samp{some.*string}.
9113 @kindex M-& (Summary)
9114 @findex gnus-summary-universal-argument
9115 Perform any operation on all articles that have been marked with
9116 the process mark (@code{gnus-summary-universal-argument}).
9119 @node Summary Generation Commands
9120 @subsection Summary Generation Commands
9125 @kindex Y g (Summary)
9126 @findex gnus-summary-prepare
9127 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
9130 @kindex Y c (Summary)
9131 @findex gnus-summary-insert-cached-articles
9132 Pull all cached articles (for the current group) into the summary buffer
9133 (@code{gnus-summary-insert-cached-articles}).
9138 @node Really Various Summary Commands
9139 @subsection Really Various Summary Commands
9145 @kindex C-d (Summary)
9146 @kindex A D (Summary)
9147 @findex gnus-summary-enter-digest-group
9148 If the current article is a collection of other articles (for instance,
9149 a digest), you might use this command to enter a group based on the that
9150 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
9151 guess what article type is currently displayed unless you give a prefix
9152 to this command, which forces a ``digest'' interpretation. Basically,
9153 whenever you see a message that is a collection of other messages of
9154 some format, you @kbd{C-d} and read these messages in a more convenient
9158 @kindex M-C-d (Summary)
9159 @findex gnus-summary-read-document
9160 This command is very similar to the one above, but lets you gather
9161 several documents into one biiig group
9162 (@code{gnus-summary-read-document}). It does this by opening several
9163 @code{nndoc} groups for each document, and then opening an
9164 @code{nnvirtual} group on top of these @code{nndoc} groups. This
9165 command understands the process/prefix convention
9166 (@pxref{Process/Prefix}).
9169 @kindex C-t (Summary)
9170 @findex gnus-summary-toggle-truncation
9171 Toggle truncation of summary lines
9172 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
9173 line centering function in the summary buffer, so it's not a good idea
9174 to have truncation switched off while reading articles.
9178 @findex gnus-summary-expand-window
9179 Expand the summary buffer window (@code{gnus-summary-expand-window}).
9180 If given a prefix, force an @code{article} window configuration.
9183 @kindex M-C-e (Summary)
9184 @findex gnus-summary-edit-parameters
9185 Edit the group parameters (@pxref{Group Parameters}) of the current
9186 group (@code{gnus-summary-edit-parameters}).
9189 @kindex M-C-a (Summary)
9190 @findex gnus-summary-customize-parameters
9191 Customize the group parameters (@pxref{Group Parameters}) of the current
9192 group (@code{gnus-summary-customize-parameters}).
9197 @node Exiting the Summary Buffer
9198 @section Exiting the Summary Buffer
9199 @cindex summary exit
9200 @cindex exiting groups
9202 Exiting from the summary buffer will normally update all info on the
9203 group and return you to the group buffer.
9209 @kindex Z Z (Summary)
9211 @findex gnus-summary-exit
9212 @vindex gnus-summary-exit-hook
9213 @vindex gnus-summary-prepare-exit-hook
9214 @c @icon{gnus-summary-exit}
9215 Exit the current group and update all information on the group
9216 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
9217 called before doing much of the exiting, which calls
9218 @code{gnus-summary-expire-articles} by default.
9219 @code{gnus-summary-exit-hook} is called after finishing the exit
9220 process. @code{gnus-group-no-more-groups-hook} is run when returning to
9221 group mode having no more (unread) groups.
9225 @kindex Z E (Summary)
9227 @findex gnus-summary-exit-no-update
9228 Exit the current group without updating any information on the group
9229 (@code{gnus-summary-exit-no-update}).
9233 @kindex Z c (Summary)
9235 @findex gnus-summary-catchup-and-exit
9236 @c @icon{gnus-summary-catchup-and-exit}
9237 Mark all unticked articles in the group as read and then exit
9238 (@code{gnus-summary-catchup-and-exit}).
9241 @kindex Z C (Summary)
9242 @findex gnus-summary-catchup-all-and-exit
9243 Mark all articles, even the ticked ones, as read and then exit
9244 (@code{gnus-summary-catchup-all-and-exit}).
9247 @kindex Z n (Summary)
9248 @findex gnus-summary-catchup-and-goto-next-group
9249 Mark all articles as read and go to the next group
9250 (@code{gnus-summary-catchup-and-goto-next-group}).
9253 @kindex Z R (Summary)
9254 @findex gnus-summary-reselect-current-group
9255 Exit this group, and then enter it again
9256 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
9257 all articles, both read and unread.
9261 @kindex Z G (Summary)
9262 @kindex M-g (Summary)
9263 @findex gnus-summary-rescan-group
9264 @c @icon{gnus-summary-mail-get}
9265 Exit the group, check for new articles in the group, and select the
9266 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
9267 articles, both read and unread.
9270 @kindex Z N (Summary)
9271 @findex gnus-summary-next-group
9272 Exit the group and go to the next group
9273 (@code{gnus-summary-next-group}).
9276 @kindex Z P (Summary)
9277 @findex gnus-summary-prev-group
9278 Exit the group and go to the previous group
9279 (@code{gnus-summary-prev-group}).
9282 @kindex Z s (Summary)
9283 @findex gnus-summary-save-newsrc
9284 Save the current number of read/marked articles in the dribble buffer
9285 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
9286 given a prefix, also save the @file{.newsrc} file(s). Using this
9287 command will make exit without updating (the @kbd{Q} command) worthless.
9290 @vindex gnus-exit-group-hook
9291 @code{gnus-exit-group-hook} is called when you exit the current group
9292 with an ``updating'' exit. For instance @kbd{Q}
9293 (@code{gnus-summary-exit-no-update}) does not call this hook.
9295 @findex gnus-summary-wake-up-the-dead
9296 @findex gnus-dead-summary-mode
9297 @vindex gnus-kill-summary-on-exit
9298 If you're in the habit of exiting groups, and then changing your mind
9299 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
9300 If you do that, Gnus won't kill the summary buffer when you exit it.
9301 (Quelle surprise!) Instead it will change the name of the buffer to
9302 something like @samp{*Dead Summary ... *} and install a minor mode
9303 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
9304 buffer, you'll find that all keys are mapped to a function called
9305 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
9306 summary buffer will result in a live, normal summary buffer.
9308 There will never be more than one dead summary buffer at any one time.
9310 @vindex gnus-use-cross-reference
9311 The data on the current group will be updated (which articles you have
9312 read, which articles you have replied to, etc.) when you exit the
9313 summary buffer. If the @code{gnus-use-cross-reference} variable is
9314 @code{t} (which is the default), articles that are cross-referenced to
9315 this group and are marked as read, will also be marked as read in the
9316 other subscribed groups they were cross-posted to. If this variable is
9317 neither @code{nil} nor @code{t}, the article will be marked as read in
9318 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
9321 @node Crosspost Handling
9322 @section Crosspost Handling
9326 Marking cross-posted articles as read ensures that you'll never have to
9327 read the same article more than once. Unless, of course, somebody has
9328 posted it to several groups separately. Posting the same article to
9329 several groups (not cross-posting) is called @dfn{spamming}, and you are
9330 by law required to send nasty-grams to anyone who perpetrates such a
9331 heinous crime. You may want to try NoCeM handling to filter out spam
9334 Remember: Cross-posting is kinda ok, but posting the same article
9335 separately to several groups is not. Massive cross-posting (aka.
9336 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
9337 @code{gnus-summary-mail-crosspost-complaint} command to complain about
9338 excessive crossposting (@pxref{Summary Mail Commands}).
9340 @cindex cross-posting
9343 One thing that may cause Gnus to not do the cross-posting thing
9344 correctly is if you use an @sc{nntp} server that supports @sc{xover}
9345 (which is very nice, because it speeds things up considerably) which
9346 does not include the @code{Xref} header in its @sc{nov} lines. This is
9347 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
9348 even with @sc{xover} by registering the @code{Xref} lines of all
9349 articles you actually read, but if you kill the articles, or just mark
9350 them as read without reading them, Gnus will not get a chance to snoop
9351 the @code{Xref} lines out of these articles, and will be unable to use
9352 the cross reference mechanism.
9354 @cindex LIST overview.fmt
9355 @cindex overview.fmt
9356 To check whether your @sc{nntp} server includes the @code{Xref} header
9357 in its overview files, try @samp{telnet your.nntp.server nntp},
9358 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
9359 overview.fmt}. This may not work, but if it does, and the last line you
9360 get does not read @samp{Xref:full}, then you should shout and whine at
9361 your news admin until she includes the @code{Xref} header in the
9364 @vindex gnus-nov-is-evil
9365 If you want Gnus to get the @code{Xref}s right all the time, you have to
9366 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
9371 For an alternative approach, @pxref{Duplicate Suppression}.
9374 @node Duplicate Suppression
9375 @section Duplicate Suppression
9377 By default, Gnus tries to make sure that you don't have to read the same
9378 article more than once by utilizing the crossposting mechanism
9379 (@pxref{Crosspost Handling}). However, that simple and efficient
9380 approach may not work satisfactory for some users for various
9385 The @sc{nntp} server may fail to generate the @code{Xref} header. This
9386 is evil and not very common.
9389 The @sc{nntp} server may fail to include the @code{Xref} header in the
9390 @file{.overview} data bases. This is evil and all too common, alas.
9393 You may be reading the same group (or several related groups) from
9394 different @sc{nntp} servers.
9397 You may be getting mail that duplicates articles posted to groups.
9400 I'm sure there are other situations where @code{Xref} handling fails as
9401 well, but these four are the most common situations.
9403 If, and only if, @code{Xref} handling fails for you, then you may
9404 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
9405 will remember the @code{Message-ID}s of all articles you have read or
9406 otherwise marked as read, and then, as if by magic, mark them as read
9407 all subsequent times you see them---in @emph{all} groups. Using this
9408 mechanism is quite likely to be somewhat inefficient, but not overly
9409 so. It's certainly preferable to reading the same articles more than
9412 Duplicate suppression is not a very subtle instrument. It's more like a
9413 sledge hammer than anything else. It works in a very simple
9414 fashion---if you have marked an article as read, it adds this Message-ID
9415 to a cache. The next time it sees this Message-ID, it will mark the
9416 article as read with the @samp{M} mark. It doesn't care what group it
9420 @item gnus-suppress-duplicates
9421 @vindex gnus-suppress-duplicates
9422 If non-@code{nil}, suppress duplicates.
9424 @item gnus-save-duplicate-list
9425 @vindex gnus-save-duplicate-list
9426 If non-@code{nil}, save the list of duplicates to a file. This will
9427 make startup and shutdown take longer, so the default is @code{nil}.
9428 However, this means that only duplicate articles read in a single Gnus
9429 session are suppressed.
9431 @item gnus-duplicate-list-length
9432 @vindex gnus-duplicate-list-length
9433 This variable says how many @code{Message-ID}s to keep in the duplicate
9434 suppression list. The default is 10000.
9436 @item gnus-duplicate-file
9437 @vindex gnus-duplicate-file
9438 The name of the file to store the duplicate suppression list in. The
9439 default is @file{~/News/suppression}.
9442 If you have a tendency to stop and start Gnus often, setting
9443 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
9444 you leave Gnus running for weeks on end, you may have it @code{nil}. On
9445 the other hand, saving the list makes startup and shutdown much slower,
9446 so that means that if you stop and start Gnus often, you should set
9447 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
9448 to you to figure out, I think.
9453 Gnus is able to verify PGP or S/MIME signed messages or decrypt PGP
9458 To verify or decrypt PGP messages, you have to install mailcrypt or
9464 @item mm-verify-option
9465 @vindex mm-verify-option
9466 Option of verifying signed parts. @code{never}, not verify;
9467 @code{always}, always verify; @code{known}, only verify known
9468 protocols. Otherwise, ask user.
9470 @item mm-decrypt-option
9471 @vindex mm-decrypt-option
9472 Option of decrypting encrypted parts. @code{never}, no decryption;
9473 @code{always}, always decrypt @code{known}, only decrypt known
9474 protocols. Otherwise, ask user.
9479 @section Mailing List
9481 Gnus understands some mailing list fields of RFC 2369.
9486 @kindex C-c C-n h (Summary)
9487 @findex gnus-mailing-list-help
9488 Send a message to fetch mailing list help, if List-Help field exists.
9491 @kindex C-c C-n s (Summary)
9492 @findex gnus-mailing-list-subscribe
9493 Send a message to subscribe the mailing list, if List-Subscribe field exists.
9496 @kindex C-c C-n u (Summary)
9497 @findex gnus-mailing-list-unsubscribe
9498 Send a message to unsubscribe the mailing list, if List-Unsubscribe
9502 @kindex C-c C-n p (Summary)
9503 @findex gnus-mailing-list-post
9504 Post to the mailing list, if List-Post field exists.
9507 @kindex C-c C-n o (Summary)
9508 @findex gnus-mailing-list-owner
9509 Send a message to the mailing list owner, if List-Owner field exists.
9512 @kindex C-c C-n a (Summary)
9513 @findex gnus-mailing-list-owner
9514 Browse the mailing list archive, if List-Archive field exists.
9518 @node Article Buffer
9519 @chapter Article Buffer
9520 @cindex article buffer
9522 The articles are displayed in the article buffer, of which there is only
9523 one. All the summary buffers share the same article buffer unless you
9524 tell Gnus otherwise.
9527 * Hiding Headers:: Deciding what headers should be displayed.
9528 * Using MIME:: Pushing articles through @sc{mime} before reading them.
9529 * Customizing Articles:: Tailoring the look of the articles.
9530 * Article Keymap:: Keystrokes available in the article buffer.
9531 * Misc Article:: Other stuff.
9535 @node Hiding Headers
9536 @section Hiding Headers
9537 @cindex hiding headers
9538 @cindex deleting headers
9540 The top section of each article is the @dfn{head}. (The rest is the
9541 @dfn{body}, but you may have guessed that already.)
9543 @vindex gnus-show-all-headers
9544 There is a lot of useful information in the head: the name of the person
9545 who wrote the article, the date it was written and the subject of the
9546 article. That's well and nice, but there's also lots of information
9547 most people do not want to see---what systems the article has passed
9548 through before reaching you, the @code{Message-ID}, the
9549 @code{References}, etc. ad nauseum---and you'll probably want to get rid
9550 of some of those lines. If you want to keep all those lines in the
9551 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
9553 Gnus provides you with two variables for sifting headers:
9557 @item gnus-visible-headers
9558 @vindex gnus-visible-headers
9559 If this variable is non-@code{nil}, it should be a regular expression
9560 that says what headers you wish to keep in the article buffer. All
9561 headers that do not match this variable will be hidden.
9563 For instance, if you only want to see the name of the person who wrote
9564 the article and the subject, you'd say:
9567 (setq gnus-visible-headers "^From:\\|^Subject:")
9570 This variable can also be a list of regexps to match headers to
9573 @item gnus-ignored-headers
9574 @vindex gnus-ignored-headers
9575 This variable is the reverse of @code{gnus-visible-headers}. If this
9576 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
9577 should be a regular expression that matches all lines that you want to
9578 hide. All lines that do not match this variable will remain visible.
9580 For instance, if you just want to get rid of the @code{References} line
9581 and the @code{Xref} line, you might say:
9584 (setq gnus-ignored-headers "^References:\\|^Xref:")
9587 This variable can also be a list of regexps to match headers to
9590 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
9591 variable will have no effect.
9595 @vindex gnus-sorted-header-list
9596 Gnus can also sort the headers for you. (It does this by default.) You
9597 can control the sorting by setting the @code{gnus-sorted-header-list}
9598 variable. It is a list of regular expressions that says in what order
9599 the headers are to be displayed.
9601 For instance, if you want the name of the author of the article first,
9602 and then the subject, you might say something like:
9605 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
9608 Any headers that are to remain visible, but are not listed in this
9609 variable, will be displayed in random order after all the headers listed in this variable.
9611 @findex gnus-article-hide-boring-headers
9612 @vindex gnus-boring-article-headers
9613 You can hide further boring headers by setting
9614 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
9615 does depends on the @code{gnus-boring-article-headers} variable. It's a
9616 list, but this list doesn't actually contain header names. Instead is
9617 lists various @dfn{boring conditions} that Gnus can check and remove
9620 These conditions are:
9623 Remove all empty headers.
9625 Remove the @code{Followup-To} header if it is identical to the
9626 @code{Newsgroups} header.
9628 Remove the @code{Reply-To} header if it lists the same address as the
9631 Remove the @code{Newsgroups} header if it only contains the current group
9634 Remove the @code{To} header if it only contains the address identical to
9635 the current groups's @code{to-address} parameter.
9637 Remove the @code{Date} header if the article is less than three days
9640 Remove the @code{To} header if it is very long.
9642 Remove all @code{To} headers if there are more than one.
9645 To include these three elements, you could say something like;
9648 (setq gnus-boring-article-headers
9649 '(empty followup-to reply-to))
9652 This is also the default value for this variable.
9656 @section Using @sc{mime}
9659 Mime is a standard for waving your hands through the air, aimlessly,
9660 while people stand around yawning.
9662 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
9663 while all newsreaders die of fear.
9665 @sc{mime} may specify what character set the article uses, the encoding
9666 of the characters, and it also makes it possible to embed pictures and
9667 other naughty stuff in innocent-looking articles.
9669 @vindex gnus-display-mime-function
9670 @findex gnus-display-mime
9671 Gnus pushes @sc{mime} articles through @code{gnus-display-mime-function}
9672 to display the @sc{mime} parts. This is @code{gnus-display-mime} by
9673 default, which creates a bundle of clickable buttons that can be used to
9674 display, save and manipulate the @sc{mime} objects.
9676 The following commands are available when you have placed point over a
9680 @findex gnus-article-press-button
9682 @itemx BUTTON-2 (Article)
9683 Toggle displaying of the @sc{mime} object
9684 (@code{gnus-article-press-button}).
9686 @findex gnus-mime-view-part
9687 @item M-RET (Article)
9689 Prompt for a method, and then view the @sc{mime} object using this
9690 method (@code{gnus-mime-view-part}).
9692 @findex gnus-mime-view-part-as-type
9694 View the @sc{mime} object as if it were a different @sc{mime} media type
9695 (@code{gnus-mime-view-part-as-type}).
9697 @findex gnus-mime-view-part-as-charset
9699 Prompt for a charset, and then view the @sc{mime} object using this
9700 charset (@code{gnus-mime-view-part-as-charset}).
9702 @findex gnus-mime-save-part
9704 Prompt for a file name, and then save the @sc{mime} object
9705 (@code{gnus-mime-save-part}).
9707 @findex gnus-mime-save-part-and-strip
9709 Prompt for a file name, then save the @sc{mime} object and strip it from
9710 the article. Then proceed to article editing, where a reasonable
9711 suggestion is being made on how the altered article should look
9712 like. The stripped @sc{mime} object will be referred via the
9713 message/external-body @sc{mime} type.
9714 (@code{gnus-mime-save-part-and-strip}).
9716 @findex gnus-mime-copy-part
9718 Copy the @sc{mime} object to a fresh buffer and display this buffer
9719 (@code{gnus-mime-copy-part}).
9721 @findex gnus-mime-inline-part
9723 Insert the contents of the @sc{mime} object into the buffer
9724 (@code{gnus-mime-inline-part}) as text/plain. If given a prefix, insert
9725 the raw contents without decoding. If given a numerical prefix, you can
9726 do semi-manual charset stuff (see
9727 @code{gnus-summary-show-article-charset-alist} in @pxref{Paging the
9730 @findex gnus-mime-internalize-part
9732 View the @sc{mime} object with an internal viewer. If no internal
9733 viewer is available, use an external viewer
9734 (@code{gnus-mime-internalize-part}).
9736 @findex gnus-mime-externalize-part
9738 View the @sc{mime} object with an external viewer.
9739 (@code{gnus-mime-externalize-part}).
9741 @findex gnus-mime-pipe-part
9743 Output the @sc{mime} object to a process (@code{gnus-mime-pipe-part}).
9745 @findex gnus-mime-action-on-part
9747 Interactively run an action on the @sc{mime} object
9748 (@code{gnus-mime-action-on-part}).
9752 Gnus will display some @sc{mime} objects automatically. The way Gnus
9753 determines which parts to do this with is described in the Emacs MIME
9756 It might be best to just use the toggling functions from the article
9757 buffer to avoid getting nasty surprises. (For instance, you enter the
9758 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
9759 decoded the sound file in the article and some horrible sing-a-long song
9760 comes screaming out your speakers, and you can't find the volume button,
9761 because there isn't one, and people are starting to look at you, and you
9762 try to stop the program, but you can't, and you can't find the program
9763 to control the volume, and everybody else in the room suddenly decides
9764 to look at you disdainfully, and you'll feel rather stupid.)
9766 Any similarity to real events and people is purely coincidental. Ahem.
9768 Also see @pxref{MIME Commands}.
9771 @node Customizing Articles
9772 @section Customizing Articles
9773 @cindex article customization
9775 A slew of functions for customizing how the articles are to look like
9776 exist. You can call these functions interactively, or you can have them
9777 called automatically when you select the articles.
9779 To have them called automatically, you should set the corresponding
9780 ``treatment'' variable. For instance, to have headers hidden, you'd set
9781 @code{gnus-treat-hide-headers}. Below is a list of variables that can
9782 be set, but first we discuss the values these variables can have.
9784 Note: Some values, while valid, make little sense. Check the list below
9785 for sensible values.
9789 @code{nil}: Don't do this treatment.
9792 @code{t}: Do this treatment on all body parts.
9795 @code{head}: Do the treatment on the headers.
9798 @code{last}: Do this treatment on the last part.
9801 An integer: Do this treatment on all body parts that have a length less
9805 A list of strings: Do this treatment on all body parts that are in
9806 articles that are read in groups that have names that match one of the
9807 regexps in the list.
9810 A list where the first element is not a string:
9812 The list is evaluated recursively. The first element of the list is a
9813 predicate. The following predicates are recognized: @code{or},
9814 @code{and}, @code{not} and @code{typep}. Here's an example:
9818 (typep "text/x-vcard"))
9823 You may have noticed that the word @dfn{part} is used here. This refers
9824 to the fact that some messages are @sc{mime} multipart articles that may
9825 be divided into several parts. Articles that are not multiparts are
9826 considered to contain just a single part.
9828 @vindex gnus-article-treat-types
9829 Are the treatments applied to all sorts of multipart parts? Yes, if you
9830 want to, but by default, only @samp{text/plain} parts are given the
9831 treatment. This is controlled by the @code{gnus-article-treat-types}
9832 variable, which is a list of regular expressions that are matched to the
9833 type of the part. This variable is ignored if the value of the
9834 controlling variable is a predicate list, as described above.
9836 The following treatment options are available. The easiest way to
9837 customize this is to examine the @code{gnus-article-treat} customization
9838 group. Values in parenthesis are suggested sensible values. Others are
9839 possible but those listed are probably sufficient for most people.
9842 @item gnus-treat-highlight-signature (t, last)
9843 @item gnus-treat-buttonize (t, integer)
9844 @item gnus-treat-buttonize-head (head)
9845 @item gnus-treat-emphasize (t, head, integer)
9846 @item gnus-treat-fill-article (t, integer)
9847 @item gnus-treat-strip-cr (t, integer)
9848 @item gnus-treat-hide-headers (head)
9849 @item gnus-treat-hide-boring-headers (head)
9850 @item gnus-treat-hide-signature (t, last)
9851 @item gnus-treat-hide-citation (t, integer)
9852 @item gnus-treat-hide-citation-maybe (t, integer)
9853 @item gnus-treat-strip-pgp (t, last, integer)
9854 @item gnus-treat-x-pgp-sig (head)
9855 @item gnus-treat-strip-pem (t, last, integer)
9856 @item gnus-treat-highlight-headers (head)
9857 @item gnus-treat-highlight-citation (t, integer)
9858 @item gnus-treat-highlight-signature (t, last, integer)
9859 @item gnus-treat-date-ut (head)
9860 @item gnus-treat-date-local (head)
9861 @item gnus-treat-date-english (head)
9862 @item gnus-treat-date-lapsed (head)
9863 @item gnus-treat-date-original (head)
9864 @item gnus-treat-date-iso8601 (head)
9865 @item gnus-treat-date-user-defined (head)
9866 @item gnus-treat-strip-headers-in-body (t, integer)
9867 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
9868 @item gnus-treat-strip-leading-blank-lines (t, integer)
9869 @item gnus-treat-strip-multiple-blank-lines (t, integer)
9870 @item gnus-treat-overstrike (t, integer)
9871 @item gnus-treat-display-xface (head)
9872 @item gnus-treat-display-smileys (t, integer)
9873 @item gnus-treat-display-picons (head)
9874 @item gnus-treat-capitalize-sentences (t, integer)
9875 @item gnus-treat-fill-long-lines (t, integer)
9876 @item gnus-treat-play-sounds
9877 @item gnus-treat-translate
9880 @vindex gnus-part-display-hook
9881 You can, of course, write your own functions to be called from
9882 @code{gnus-part-display-hook}. The functions are called narrowed to the
9883 part, and you can do anything you like, pretty much. There is no
9884 information that you have to keep in the buffer---you can change
9888 @node Article Keymap
9889 @section Article Keymap
9891 Most of the keystrokes in the summary buffer can also be used in the
9892 article buffer. They should behave as if you typed them in the summary
9893 buffer, which means that you don't actually have to have a summary
9894 buffer displayed while reading. You can do it all from the article
9897 A few additional keystrokes are available:
9902 @kindex SPACE (Article)
9903 @findex gnus-article-next-page
9904 Scroll forwards one page (@code{gnus-article-next-page}).
9907 @kindex DEL (Article)
9908 @findex gnus-article-prev-page
9909 Scroll backwards one page (@code{gnus-article-prev-page}).
9912 @kindex C-c ^ (Article)
9913 @findex gnus-article-refer-article
9914 If point is in the neighborhood of a @code{Message-ID} and you press
9915 @kbd{C-c ^}, Gnus will try to get that article from the server
9916 (@code{gnus-article-refer-article}).
9919 @kindex C-c C-m (Article)
9920 @findex gnus-article-mail
9921 Send a reply to the address near point (@code{gnus-article-mail}). If
9922 given a prefix, include the mail.
9926 @findex gnus-article-show-summary
9927 Reconfigure the buffers so that the summary buffer becomes visible
9928 (@code{gnus-article-show-summary}).
9932 @findex gnus-article-describe-briefly
9933 Give a very brief description of the available keystrokes
9934 (@code{gnus-article-describe-briefly}).
9937 @kindex TAB (Article)
9938 @findex gnus-article-next-button
9939 Go to the next button, if any (@code{gnus-article-next-button}). This
9940 only makes sense if you have buttonizing turned on.
9943 @kindex M-TAB (Article)
9944 @findex gnus-article-prev-button
9945 Go to the previous button, if any (@code{gnus-article-prev-button}).
9951 @section Misc Article
9955 @item gnus-single-article-buffer
9956 @vindex gnus-single-article-buffer
9957 If non-@code{nil}, use the same article buffer for all the groups.
9958 (This is the default.) If @code{nil}, each group will have its own
9961 @vindex gnus-article-decode-hook
9962 @item gnus-article-decode-hook
9964 Hook used to decode @sc{mime} articles. The default value is
9965 @code{(article-decode-charset article-decode-encoded-words)}
9967 @vindex gnus-article-prepare-hook
9968 @item gnus-article-prepare-hook
9969 This hook is called right after the article has been inserted into the
9970 article buffer. It is mainly intended for functions that do something
9971 depending on the contents; it should probably not be used for changing
9972 the contents of the article buffer.
9974 @item gnus-article-mode-hook
9975 @vindex gnus-article-mode-hook
9976 Hook called in article mode buffers.
9978 @item gnus-article-mode-syntax-table
9979 @vindex gnus-article-mode-syntax-table
9980 Syntax table used in article buffers. It is initialized from
9981 @code{text-mode-syntax-table}.
9983 @vindex gnus-article-mode-line-format
9984 @item gnus-article-mode-line-format
9985 This variable is a format string along the same lines as
9986 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}). It
9987 accepts the same format specifications as that variable, with two
9992 The @dfn{wash status} of the article. This is a short string with one
9993 character for each possible article wash operation that may have been
9996 The number of @sc{mime} parts in the article.
9999 @vindex gnus-break-pages
10001 @item gnus-break-pages
10002 Controls whether @dfn{page breaking} is to take place. If this variable
10003 is non-@code{nil}, the articles will be divided into pages whenever a
10004 page delimiter appears in the article. If this variable is @code{nil},
10005 paging will not be done.
10007 @item gnus-page-delimiter
10008 @vindex gnus-page-delimiter
10009 This is the delimiter mentioned above. By default, it is @samp{^L}
10014 @node Composing Messages
10015 @chapter Composing Messages
10016 @cindex composing messages
10019 @cindex sending mail
10025 @kindex C-c C-c (Post)
10026 All commands for posting and mailing will put you in a message buffer
10027 where you can edit the article all you like, before you send the
10028 article by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The
10029 Message Manual}. Where the message will be posted/mailed to depends
10030 on your setup (@pxref{Posting Server}).
10033 * Mail:: Mailing and replying.
10034 * Posting Server:: What server should you post via?
10035 * Mail and Post:: Mailing and posting at the same time.
10036 * Archived Messages:: Where Gnus stores the messages you've sent.
10037 * Posting Styles:: An easier way to specify who you are.
10038 * Drafts:: Postponing messages and rejected messages.
10039 * Rejected Articles:: What happens if the server doesn't like your article?
10040 * Using GPG:: How to use GPG and MML to sign and encrypt messages
10043 Also see @pxref{Canceling and Superseding} for information on how to
10044 remove articles you shouldn't have posted.
10050 Variables for customizing outgoing mail:
10053 @item gnus-uu-digest-headers
10054 @vindex gnus-uu-digest-headers
10055 List of regexps to match headers included in digested messages. The
10056 headers will be included in the sequence they are matched.
10058 @item gnus-add-to-list
10059 @vindex gnus-add-to-list
10060 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
10061 that have none when you do a @kbd{a}.
10066 @node Posting Server
10067 @section Posting Server
10069 When you press those magical @kbd{C-c C-c} keys to ship off your latest
10070 (extremely intelligent, of course) article, where does it go?
10072 Thank you for asking. I hate you.
10074 @vindex gnus-post-method
10076 It can be quite complicated. Normally, Gnus will post using the same
10077 select method as you're reading from (which might be convenient if
10078 you're reading lots of groups from different private servers).
10079 However. If the server you're reading from doesn't allow posting,
10080 just reading, you probably want to use some other server to post your
10081 (extremely intelligent and fabulously interesting) articles. You can
10082 then set the @code{gnus-post-method} to some other method:
10085 (setq gnus-post-method '(nnspool ""))
10088 Now, if you've done this, and then this server rejects your article, or
10089 this server is down, what do you do then? To override this variable you
10090 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
10091 the ``current'' server, to get back the default behavior, for posting.
10093 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
10094 Gnus will prompt you for what method to use for posting.
10096 You can also set @code{gnus-post-method} to a list of select methods.
10097 If that's the case, Gnus will always prompt you for what method to use
10100 Finally, if you want to always post using the native select method,
10101 you can set this variable to @code{nil}.
10104 @node Mail and Post
10105 @section Mail and Post
10107 Here's a list of variables relevant to both mailing and
10111 @item gnus-mailing-list-groups
10112 @findex gnus-mailing-list-groups
10113 @cindex mailing lists
10115 If your news server offers groups that are really mailing lists
10116 gatewayed to the @sc{nntp} server, you can read those groups without
10117 problems, but you can't post/followup to them without some difficulty.
10118 One solution is to add a @code{to-address} to the group parameters
10119 (@pxref{Group Parameters}). An easier thing to do is set the
10120 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
10121 really are mailing lists. Then, at least, followups to the mailing
10122 lists will work most of the time. Posting to these groups (@kbd{a}) is
10123 still a pain, though.
10127 You may want to do spell-checking on messages that you send out. Or, if
10128 you don't want to spell-check by hand, you could add automatic
10129 spell-checking via the @code{ispell} package:
10132 @findex ispell-message
10134 (add-hook 'message-send-hook 'ispell-message)
10137 If you want to change the @code{ispell} dictionary based on what group
10138 you're in, you could say something like the following:
10141 (add-hook 'gnus-select-group-hook
10145 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
10146 (ispell-change-dictionary "deutsch"))
10148 (ispell-change-dictionary "english")))))
10151 Modify to suit your needs.
10154 @node Archived Messages
10155 @section Archived Messages
10156 @cindex archived messages
10157 @cindex sent messages
10159 Gnus provides a few different methods for storing the mail and news you
10160 send. The default method is to use the @dfn{archive virtual server} to
10161 store the messages. If you want to disable this completely, the
10162 @code{gnus-message-archive-group} variable should be @code{nil}, which
10165 @vindex gnus-message-archive-method
10166 @code{gnus-message-archive-method} says what virtual server Gnus is to
10167 use to store sent messages. The default is:
10170 (nnfolder "archive"
10171 (nnfolder-directory "~/Mail/archive")
10172 (nnfolder-active-file "~/Mail/archive/active")
10173 (nnfolder-get-new-mail nil)
10174 (nnfolder-inhibit-expiry t))
10177 You can, however, use any mail select method (@code{nnml},
10178 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
10179 for doing this sort of thing, though. If you don't like the default
10180 directory chosen, you could say something like:
10183 (setq gnus-message-archive-method
10184 '(nnfolder "archive"
10185 (nnfolder-inhibit-expiry t)
10186 (nnfolder-active-file "~/News/sent-mail/active")
10187 (nnfolder-directory "~/News/sent-mail/")))
10190 @vindex gnus-message-archive-group
10192 Gnus will insert @code{Gcc} headers in all outgoing messages that point
10193 to one or more group(s) on that server. Which group to use is
10194 determined by the @code{gnus-message-archive-group} variable.
10196 This variable can be used to do the following:
10200 Messages will be saved in that group.
10202 Note that you can include a select method in the group name, then the
10203 message will not be stored in the select method given by
10204 @code{gnus-message-archive-method}, but in the select method specified
10205 by the group name, instead. Suppose @code{gnus-message-archive-method}
10206 has the default value shown above. Then setting
10207 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
10208 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
10209 value @code{"nnml:foo"}, then outgoing messages will be stored in
10211 @item a list of strings
10212 Messages will be saved in all those groups.
10213 @item an alist of regexps, functions and forms
10214 When a key ``matches'', the result is used.
10216 No message archiving will take place. This is the default.
10221 Just saving to a single group called @samp{MisK}:
10223 (setq gnus-message-archive-group "MisK")
10226 Saving to two groups, @samp{MisK} and @samp{safe}:
10228 (setq gnus-message-archive-group '("MisK" "safe"))
10231 Save to different groups based on what group you are in:
10233 (setq gnus-message-archive-group
10234 '(("^alt" "sent-to-alt")
10235 ("mail" "sent-to-mail")
10236 (".*" "sent-to-misc")))
10239 More complex stuff:
10241 (setq gnus-message-archive-group
10242 '((if (message-news-p)
10247 How about storing all news messages in one file, but storing all mail
10248 messages in one file per month:
10251 (setq gnus-message-archive-group
10252 '((if (message-news-p)
10254 (concat "mail." (format-time-string "%Y-%m")))))
10257 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
10258 use a different value for @code{gnus-message-archive-group} there.)
10260 Now, when you send a message off, it will be stored in the appropriate
10261 group. (If you want to disable storing for just one particular message,
10262 you can just remove the @code{Gcc} header that has been inserted.) The
10263 archive group will appear in the group buffer the next time you start
10264 Gnus, or the next time you press @kbd{F} in the group buffer. You can
10265 enter it and read the articles in it just like you'd read any other
10266 group. If the group gets really big and annoying, you can simply rename
10267 if (using @kbd{G r} in the group buffer) to something
10268 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
10269 continue to be stored in the old (now empty) group.
10271 That's the default method of archiving sent messages. Gnus offers a
10272 different way for the people who don't like the default method. In that
10273 case you should set @code{gnus-message-archive-group} to @code{nil};
10274 this will disable archiving.
10277 @item gnus-outgoing-message-group
10278 @vindex gnus-outgoing-message-group
10279 All outgoing messages will be put in this group. If you want to store
10280 all your outgoing mail and articles in the group @samp{nnml:archive},
10281 you set this variable to that value. This variable can also be a list of
10284 If you want to have greater control over what group to put each
10285 message in, you can set this variable to a function that checks the
10286 current newsgroup name and then returns a suitable group name (or list
10289 This variable can be used instead of @code{gnus-message-archive-group},
10290 but the latter is the preferred method.
10292 @item gnus-inews-mark-gcc-as-read
10293 @vindex gnus-inews-mark-gcc-as-read
10294 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
10299 @node Posting Styles
10300 @section Posting Styles
10301 @cindex posting styles
10304 All them variables, they make my head swim.
10306 So what if you want a different @code{Organization} and signature based
10307 on what groups you post to? And you post both from your home machine
10308 and your work machine, and you want different @code{From} lines, and so
10311 @vindex gnus-posting-styles
10312 One way to do stuff like that is to write clever hooks that change the
10313 variables you need to have changed. That's a bit boring, so somebody
10314 came up with the bright idea of letting the user specify these things in
10315 a handy alist. Here's an example of a @code{gnus-posting-styles}
10320 (signature "Peace and happiness")
10321 (organization "What me?"))
10323 (signature "Death to everybody"))
10324 ("comp.emacs.i-love-it"
10325 (organization "Emacs is it")))
10328 As you might surmise from this example, this alist consists of several
10329 @dfn{styles}. Each style will be applicable if the first element
10330 ``matches'', in some form or other. The entire alist will be iterated
10331 over, from the beginning towards the end, and each match will be
10332 applied, which means that attributes in later styles that match override
10333 the same attributes in earlier matching styles. So
10334 @samp{comp.programming.literate} will have the @samp{Death to everybody}
10335 signature and the @samp{What me?} @code{Organization} header.
10337 The first element in each style is called the @code{match}. If it's a
10338 string, then Gnus will try to regexp match it against the group name.
10339 If it is the symbol @code{header}, then Gnus will look for header (the
10340 next element in the match) in the original article , and compare that to
10341 the last regexp in the match. If it's a function symbol, that function
10342 will be called with no arguments. If it's a variable symbol, then the
10343 variable will be referenced. If it's a list, then that list will be
10344 @code{eval}ed. In any case, if this returns a non-@code{nil} value,
10345 then the style is said to @dfn{match}.
10347 Each style may contain a arbitrary amount of @dfn{attributes}. Each
10348 attribute consists of a @code{(@var{name} @var{value})} pair. The
10349 attribute name can be one of @code{signature}, @code{signature-file},
10350 @code{organization}, @code{address}, @code{name} or @code{body}. The
10351 attribute name can also be a string. In that case, this will be used as
10352 a header name, and the value will be inserted in the headers of the
10353 article; if the value is @code{nil}, the header name will be removed.
10354 If the attribute name is @code{eval}, the form is evaluated, and the
10355 result is thrown away.
10357 The attribute value can be a string (used verbatim), a function with
10358 zero arguments (the return value will be used), a variable (its value
10359 will be used) or a list (it will be @code{eval}ed and the return value
10360 will be used). The functions and sexps are called/@code{eval}ed in the
10361 message buffer that is being set up. The headers of the current article
10362 are available through the @code{message-reply-headers} variable.
10364 If you wish to check whether the message you are about to compose is
10365 meant to be a news article or a mail message, you can check the values
10366 of the @code{message-news-p} and @code{message-mail-p} functions.
10368 @findex message-mail-p
10369 @findex message-news-p
10371 So here's a new example:
10374 (setq gnus-posting-styles
10376 (signature-file "~/.signature")
10378 ("X-Home-Page" (getenv "WWW_HOME"))
10379 (organization "People's Front Against MWM"))
10381 (signature my-funny-signature-randomizer))
10382 ((equal (system-name) "gnarly")
10383 (signature my-quote-randomizer))
10385 (signature my-news-signature))
10386 (header "to" "larsi.*org"
10387 (Organization "Somewhere, Inc."))
10388 ((posting-from-work-p)
10389 (signature-file "~/.work-signature")
10390 (address "user@@bar.foo")
10391 (body "You are fired.\n\nSincerely, your boss.")
10392 (organization "Important Work, Inc"))
10394 (From (save-excursion
10395 (set-buffer gnus-article-buffer)
10396 (message-fetch-field "to"))))
10398 (signature-file "~/.mail-signature"))))
10401 The @samp{nnml:.*} rule means that you use the @code{To} address as the
10402 @code{From} address in all your outgoing replies, which might be handy
10403 if you fill many roles.
10410 If you are writing a message (mail or news) and suddenly remember that
10411 you have a steak in the oven (or some pesto in the food processor, you
10412 craaazy vegetarians), you'll probably wish there was a method to save
10413 the message you are writing so that you can continue editing it some
10414 other day, and send it when you feel its finished.
10416 Well, don't worry about it. Whenever you start composing a message of
10417 some sort using the Gnus mail and post commands, the buffer you get will
10418 automatically associate to an article in a special @dfn{draft} group.
10419 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
10420 article will be saved there. (Auto-save files also go to the draft
10424 @vindex nndraft-directory
10425 The draft group is a special group (which is implemented as an
10426 @code{nndraft} group, if you absolutely have to know) called
10427 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
10428 @code{nndraft} is to store its files. What makes this group special is
10429 that you can't tick any articles in it or mark any articles as
10430 read---all articles in the group are permanently unread.
10432 If the group doesn't exist, it will be created and you'll be subscribed
10433 to it. The only way to make it disappear from the Group buffer is to
10436 @c @findex gnus-dissociate-buffer-from-draft
10437 @c @kindex C-c M-d (Mail)
10438 @c @kindex C-c M-d (Post)
10439 @c @findex gnus-associate-buffer-with-draft
10440 @c @kindex C-c C-d (Mail)
10441 @c @kindex C-c C-d (Post)
10442 @c If you're writing some super-secret message that you later want to
10443 @c encode with PGP before sending, you may wish to turn the auto-saving
10444 @c (and association with the draft group) off. You never know who might be
10445 @c interested in reading all your extremely valuable and terribly horrible
10446 @c and interesting secrets. The @kbd{C-c M-d}
10447 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
10448 @c If you change your mind and want to turn the auto-saving back on again,
10449 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
10451 @c @vindex gnus-use-draft
10452 @c To leave association with the draft group off by default, set
10453 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
10455 @findex gnus-draft-edit-message
10456 @kindex D e (Draft)
10457 When you want to continue editing the article, you simply enter the
10458 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
10459 that. You will be placed in a buffer where you left off.
10461 Rejected articles will also be put in this draft group (@pxref{Rejected
10464 @findex gnus-draft-send-all-messages
10465 @findex gnus-draft-send-message
10466 If you have lots of rejected messages you want to post (or mail) without
10467 doing further editing, you can use the @kbd{D s} command
10468 (@code{gnus-draft-send-message}). This command understands the
10469 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
10470 command (@code{gnus-draft-send-all-messages}) will ship off all messages
10473 If you have some messages that you wish not to send, you can use the
10474 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
10475 as unsendable. This is a toggling command.
10478 @node Rejected Articles
10479 @section Rejected Articles
10480 @cindex rejected articles
10482 Sometimes a news server will reject an article. Perhaps the server
10483 doesn't like your face. Perhaps it just feels miserable. Perhaps
10484 @emph{there be demons}. Perhaps you have included too much cited text.
10485 Perhaps the disk is full. Perhaps the server is down.
10487 These situations are, of course, totally beyond the control of Gnus.
10488 (Gnus, of course, loves the way you look, always feels great, has angels
10489 fluttering around inside of it, doesn't care about how much cited text
10490 you include, never runs full and never goes down.) So Gnus saves these
10491 articles until some later time when the server feels better.
10493 The rejected articles will automatically be put in a special draft group
10494 (@pxref{Drafts}). When the server comes back up again, you'd then
10495 typically enter that group and send all the articles off.
10501 Gnus has an ALPHA support to GPG that's provided by @file{gpg.el}. See
10502 @code{mm-verify-option} and @code{mm-decrypt-option} to enable Gnus to
10503 verify or decrypt messages accordingly.
10505 To use this correctly with GPG, you'll need the following lisp code in your
10506 @file{~/.emacs} or @file{~/.gnus}:
10510 (setq mml2015-use 'gpg)
10511 (setq gpg-temp-directory (expand-file-name "~/.gnupg/tmp"))
10514 The @code{gpg-temp-directory} need to point to a directory with permissions set
10515 to 700, for your own safety.
10517 If you want to benefit of PGP2.6 compatibility, you might create a script named
10518 @file{gpg-2comp} with these instructions:
10522 exec gpg --rfc1991 "$@@"
10525 If you don't want to use such compatibility, you can add the following line to
10526 your @file{~/.emacs} or @file{~/.gnus}:
10529 (setq gpg-command-default-alist (quote ((gpg . "gpg") (gpg-2comp . "gpg"))))
10532 To sign or encrypt your message you may choose to use the MML Security
10533 menu or @kbd{C-c C-m s p} to sign your message using PGP/MIME, @kbd{C-c
10534 C-m s s} to sign your message using S/MIME. There's also @kbd{C-c C-m c
10535 p} to encrypt your message with PGP/MIME and @kbd{C-c C-m c s} to
10536 encrypt using S/MIME.
10538 Gnus will ask for your passphrase and then it will send your message, if
10539 you've typed it correctly.
10541 @node Select Methods
10542 @chapter Select Methods
10543 @cindex foreign groups
10544 @cindex select methods
10546 A @dfn{foreign group} is a group not read by the usual (or
10547 default) means. It could be, for instance, a group from a different
10548 @sc{nntp} server, it could be a virtual group, or it could be your own
10549 personal mail group.
10551 A foreign group (or any group, really) is specified by a @dfn{name} and
10552 a @dfn{select method}. To take the latter first, a select method is a
10553 list where the first element says what backend to use (e.g. @code{nntp},
10554 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
10555 name}. There may be additional elements in the select method, where the
10556 value may have special meaning for the backend in question.
10558 One could say that a select method defines a @dfn{virtual server}---so
10559 we do just that (@pxref{Server Buffer}).
10561 The @dfn{name} of the group is the name the backend will recognize the
10564 For instance, the group @samp{soc.motss} on the @sc{nntp} server
10565 @samp{some.where.edu} will have the name @samp{soc.motss} and select
10566 method @code{(nntp "some.where.edu")}. Gnus will call this group
10567 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
10568 backend just knows this group as @samp{soc.motss}.
10570 The different methods all have their peculiarities, of course.
10573 * Server Buffer:: Making and editing virtual servers.
10574 * Getting News:: Reading USENET news with Gnus.
10575 * Getting Mail:: Reading your personal mail with Gnus.
10576 * Browsing the Web:: Getting messages from a plethora of Web sources.
10577 * Other Sources:: Reading directories, files, SOUP packets.
10578 * Combined Groups:: Combining groups into one group.
10579 * Gnus Unplugged:: Reading news and mail offline.
10583 @node Server Buffer
10584 @section Server Buffer
10586 Traditionally, a @dfn{server} is a machine or a piece of software that
10587 one connects to, and then requests information from. Gnus does not
10588 connect directly to any real servers, but does all transactions through
10589 one backend or other. But that's just putting one layer more between
10590 the actual media and Gnus, so we might just as well say that each
10591 backend represents a virtual server.
10593 For instance, the @code{nntp} backend may be used to connect to several
10594 different actual @sc{nntp} servers, or, perhaps, to many different ports
10595 on the same actual @sc{nntp} server. You tell Gnus which backend to
10596 use, and what parameters to set by specifying a @dfn{select method}.
10598 These select method specifications can sometimes become quite
10599 complicated---say, for instance, that you want to read from the
10600 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
10601 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
10602 Anyway, if you had to specify that for each group that used this
10603 server, that would be too much work, so Gnus offers a way of naming
10604 select methods, which is what you do in the server buffer.
10606 To enter the server buffer, use the @kbd{^}
10607 (@code{gnus-group-enter-server-mode}) command in the group buffer.
10610 * Server Buffer Format:: You can customize the look of this buffer.
10611 * Server Commands:: Commands to manipulate servers.
10612 * Example Methods:: Examples server specifications.
10613 * Creating a Virtual Server:: An example session.
10614 * Server Variables:: Which variables to set.
10615 * Servers and Methods:: You can use server names as select methods.
10616 * Unavailable Servers:: Some servers you try to contact may be down.
10619 @vindex gnus-server-mode-hook
10620 @code{gnus-server-mode-hook} is run when creating the server buffer.
10623 @node Server Buffer Format
10624 @subsection Server Buffer Format
10625 @cindex server buffer format
10627 @vindex gnus-server-line-format
10628 You can change the look of the server buffer lines by changing the
10629 @code{gnus-server-line-format} variable. This is a @code{format}-like
10630 variable, with some simple extensions:
10635 How the news is fetched---the backend name.
10638 The name of this server.
10641 Where the news is to be fetched from---the address.
10644 The opened/closed/denied status of the server.
10647 @vindex gnus-server-mode-line-format
10648 The mode line can also be customized by using the
10649 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
10650 Formatting}). The following specs are understood:
10660 Also @pxref{Formatting Variables}.
10663 @node Server Commands
10664 @subsection Server Commands
10665 @cindex server commands
10671 @findex gnus-server-add-server
10672 Add a new server (@code{gnus-server-add-server}).
10676 @findex gnus-server-edit-server
10677 Edit a server (@code{gnus-server-edit-server}).
10680 @kindex SPACE (Server)
10681 @findex gnus-server-read-server
10682 Browse the current server (@code{gnus-server-read-server}).
10686 @findex gnus-server-exit
10687 Return to the group buffer (@code{gnus-server-exit}).
10691 @findex gnus-server-kill-server
10692 Kill the current server (@code{gnus-server-kill-server}).
10696 @findex gnus-server-yank-server
10697 Yank the previously killed server (@code{gnus-server-yank-server}).
10701 @findex gnus-server-copy-server
10702 Copy the current server (@code{gnus-server-copy-server}).
10706 @findex gnus-server-list-servers
10707 List all servers (@code{gnus-server-list-servers}).
10711 @findex gnus-server-scan-server
10712 Request that the server scan its sources for new articles
10713 (@code{gnus-server-scan-server}). This is mainly sensible with mail
10718 @findex gnus-server-regenerate-server
10719 Request that the server regenerate all its data structures
10720 (@code{gnus-server-regenerate-server}). This can be useful if you have
10721 a mail backend that has gotten out of sync.
10726 @node Example Methods
10727 @subsection Example Methods
10729 Most select methods are pretty simple and self-explanatory:
10732 (nntp "news.funet.fi")
10735 Reading directly from the spool is even simpler:
10741 As you can see, the first element in a select method is the name of the
10742 backend, and the second is the @dfn{address}, or @dfn{name}, if you
10745 After these two elements, there may be an arbitrary number of
10746 @code{(@var{variable} @var{form})} pairs.
10748 To go back to the first example---imagine that you want to read from
10749 port 15 on that machine. This is what the select method should
10753 (nntp "news.funet.fi" (nntp-port-number 15))
10756 You should read the documentation to each backend to find out what
10757 variables are relevant, but here's an @code{nnmh} example:
10759 @code{nnmh} is a mail backend that reads a spool-like structure. Say
10760 you have two structures that you wish to access: One is your private
10761 mail spool, and the other is a public one. Here's the possible spec for
10765 (nnmh "private" (nnmh-directory "~/private/mail/"))
10768 (This server is then called @samp{private}, but you may have guessed
10771 Here's the method for a public spool:
10775 (nnmh-directory "/usr/information/spool/")
10776 (nnmh-get-new-mail nil))
10782 If you are behind a firewall and only have access to the @sc{nntp}
10783 server from the firewall machine, you can instruct Gnus to @code{rlogin}
10784 on the firewall machine and telnet from there to the @sc{nntp} server.
10785 Doing this can be rather fiddly, but your virtual server definition
10786 should probably look something like this:
10790 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
10791 (nntp-via-address "the.firewall.machine")
10792 (nntp-address "the.real.nntp.host")
10793 (nntp-end-of-line "\n"))
10796 If you want to use the wonderful @code{ssh} program to provide a
10797 compressed connection over the modem line, you could add the following
10798 configuration to the example above:
10801 (nntp-via-rlogin-command "ssh")
10804 If you're behind a firewall, but have direct access to the outside world
10805 through a wrapper command like "runsocks", you could open a socksified
10806 telnet connection to the news server as follows:
10810 (nntp-pre-command "runsocks")
10811 (nntp-open-connection-function nntp-open-via-telnet)
10812 (nntp-address "the.news.server")
10813 (nntp-end-of-line "\n"))
10816 This means that you have to have set up @code{ssh-agent} correctly to
10817 provide automatic authorization, of course. And to get a compressed
10818 connection, you have to have the @samp{Compression} option in the
10819 @code{ssh} @file{config} file.
10822 @node Creating a Virtual Server
10823 @subsection Creating a Virtual Server
10825 If you're saving lots of articles in the cache by using persistent
10826 articles, you may want to create a virtual server to read the cache.
10828 First you need to add a new server. The @kbd{a} command does that. It
10829 would probably be best to use @code{nnspool} to read the cache. You
10830 could also use @code{nnml} or @code{nnmh}, though.
10832 Type @kbd{a nnspool RET cache RET}.
10834 You should now have a brand new @code{nnspool} virtual server called
10835 @samp{cache}. You now need to edit it to have the right definitions.
10836 Type @kbd{e} to edit the server. You'll be entered into a buffer that
10837 will contain the following:
10847 (nnspool-spool-directory "~/News/cache/")
10848 (nnspool-nov-directory "~/News/cache/")
10849 (nnspool-active-file "~/News/cache/active"))
10852 Type @kbd{C-c C-c} to return to the server buffer. If you now press
10853 @kbd{RET} over this virtual server, you should be entered into a browse
10854 buffer, and you should be able to enter any of the groups displayed.
10857 @node Server Variables
10858 @subsection Server Variables
10860 One sticky point when defining variables (both on backends and in Emacs
10861 in general) is that some variables are typically initialized from other
10862 variables when the definition of the variables is being loaded. If you
10863 change the "base" variable after the variables have been loaded, you
10864 won't change the "derived" variables.
10866 This typically affects directory and file variables. For instance,
10867 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
10868 directory variables are initialized from that variable, so
10869 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
10870 new virtual @code{nnml} server, it will @emph{not} suffice to set just
10871 @code{nnml-directory}---you have to explicitly set all the file
10872 variables to be what you want them to be. For a complete list of
10873 variables for each backend, see each backend's section later in this
10874 manual, but here's an example @code{nnml} definition:
10878 (nnml-directory "~/my-mail/")
10879 (nnml-active-file "~/my-mail/active")
10880 (nnml-newsgroups-file "~/my-mail/newsgroups"))
10884 @node Servers and Methods
10885 @subsection Servers and Methods
10887 Wherever you would normally use a select method
10888 (e.g. @code{gnus-secondary-select-method}, in the group select method,
10889 when browsing a foreign server) you can use a virtual server name
10890 instead. This could potentially save lots of typing. And it's nice all
10894 @node Unavailable Servers
10895 @subsection Unavailable Servers
10897 If a server seems to be unreachable, Gnus will mark that server as
10898 @code{denied}. That means that any subsequent attempt to make contact
10899 with that server will just be ignored. ``It can't be opened,'' Gnus
10900 will tell you, without making the least effort to see whether that is
10901 actually the case or not.
10903 That might seem quite naughty, but it does make sense most of the time.
10904 Let's say you have 10 groups subscribed to on server
10905 @samp{nephelococcygia.com}. This server is located somewhere quite far
10906 away from you and the machine is quite slow, so it takes 1 minute just
10907 to find out that it refuses connection to you today. If Gnus were to
10908 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
10909 attempt to do that. Once it has gotten a single ``connection refused'',
10910 it will regard that server as ``down''.
10912 So, what happens if the machine was only feeling unwell temporarily?
10913 How do you test to see whether the machine has come up again?
10915 You jump to the server buffer (@pxref{Server Buffer}) and poke it
10916 with the following commands:
10922 @findex gnus-server-open-server
10923 Try to establish connection to the server on the current line
10924 (@code{gnus-server-open-server}).
10928 @findex gnus-server-close-server
10929 Close the connection (if any) to the server
10930 (@code{gnus-server-close-server}).
10934 @findex gnus-server-deny-server
10935 Mark the current server as unreachable
10936 (@code{gnus-server-deny-server}).
10939 @kindex M-o (Server)
10940 @findex gnus-server-open-all-servers
10941 Open the connections to all servers in the buffer
10942 (@code{gnus-server-open-all-servers}).
10945 @kindex M-c (Server)
10946 @findex gnus-server-close-all-servers
10947 Close the connections to all servers in the buffer
10948 (@code{gnus-server-close-all-servers}).
10952 @findex gnus-server-remove-denials
10953 Remove all marks to whether Gnus was denied connection from any servers
10954 (@code{gnus-server-remove-denials}).
10960 @section Getting News
10961 @cindex reading news
10962 @cindex news backends
10964 A newsreader is normally used for reading news. Gnus currently provides
10965 only two methods of getting news---it can read from an @sc{nntp} server,
10966 or it can read from a local spool.
10969 * NNTP:: Reading news from an @sc{nntp} server.
10970 * News Spool:: Reading news from the local spool.
10975 @subsection @sc{nntp}
10978 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
10979 You just specify @code{nntp} as method and the address of the @sc{nntp}
10980 server as the, uhm, address.
10982 If the @sc{nntp} server is located at a non-standard port, setting the
10983 third element of the select method to this port number should allow you
10984 to connect to the right port. You'll have to edit the group info for
10985 that (@pxref{Foreign Groups}).
10987 The name of the foreign group can be the same as a native group. In
10988 fact, you can subscribe to the same group from as many different servers
10989 you feel like. There will be no name collisions.
10991 The following variables can be used to create a virtual @code{nntp}
10996 @item nntp-server-opened-hook
10997 @vindex nntp-server-opened-hook
10998 @cindex @sc{mode reader}
11000 @cindex authentification
11001 @cindex nntp authentification
11002 @findex nntp-send-authinfo
11003 @findex nntp-send-mode-reader
11004 is run after a connection has been made. It can be used to send
11005 commands to the @sc{nntp} server after it has been contacted. By
11006 default it sends the command @code{MODE READER} to the server with the
11007 @code{nntp-send-mode-reader} function. This function should always be
11008 present in this hook.
11010 @item nntp-authinfo-function
11011 @vindex nntp-authinfo-function
11012 @findex nntp-send-authinfo
11013 @vindex nntp-authinfo-file
11014 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
11015 server. The default function is @code{nntp-send-authinfo}, which looks
11016 through your @file{~/.authinfo} (or whatever you've set the
11017 @code{nntp-authinfo-file} variable to) for applicable entries. If none
11018 are found, it will prompt you for a login name and a password. The
11019 format of the @file{~/.authinfo} file is (almost) the same as the
11020 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
11021 manual page, but here are the salient facts:
11025 The file contains one or more line, each of which define one server.
11028 Each line may contain an arbitrary number of token/value pairs.
11030 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
11031 @samp{default}. In addition Gnus introduces two new tokens, not present
11032 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
11033 @samp{force}. (This is the only way the @file{.authinfo} file format
11034 deviates from the @file{.netrc} file format.) @samp{port} is used to
11035 indicate what port on the server the credentials apply to and
11036 @samp{force} is explained below.
11040 Here's an example file:
11043 machine news.uio.no login larsi password geheimnis
11044 machine nntp.ifi.uio.no login larsi force yes
11047 The token/value pairs may appear in any order; @samp{machine} doesn't
11048 have to be first, for instance.
11050 In this example, both login name and password have been supplied for the
11051 former server, while the latter has only the login name listed, and the
11052 user will be prompted for the password. The latter also has the
11053 @samp{force} tag, which means that the authinfo will be sent to the
11054 @var{nntp} server upon connection; the default (i.e., when there is not
11055 @samp{force} tag) is to not send authinfo to the @var{nntp} server
11056 until the @var{nntp} server asks for it.
11058 You can also add @samp{default} lines that will apply to all servers
11059 that don't have matching @samp{machine} lines.
11065 This will force sending @samp{AUTHINFO} commands to all servers not
11066 previously mentioned.
11068 Remember to not leave the @file{~/.authinfo} file world-readable.
11070 @item nntp-server-action-alist
11071 @vindex nntp-server-action-alist
11072 This is a list of regexps to match on server types and actions to be
11073 taken when matches are made. For instance, if you want Gnus to beep
11074 every time you connect to innd, you could say something like:
11077 (setq nntp-server-action-alist
11078 '(("innd" (ding))))
11081 You probably don't want to do that, though.
11083 The default value is
11086 '(("nntpd 1\\.5\\.11t"
11087 (remove-hook 'nntp-server-opened-hook
11088 'nntp-send-mode-reader)))
11091 This ensures that Gnus doesn't send the @code{MODE READER} command to
11092 nntpd 1.5.11t, since that command chokes that server, I've been told.
11094 @item nntp-maximum-request
11095 @vindex nntp-maximum-request
11096 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
11097 will collect headers by sending a series of @code{head} commands. To
11098 speed things up, the backend sends lots of these commands without
11099 waiting for reply, and then reads all the replies. This is controlled
11100 by the @code{nntp-maximum-request} variable, and is 400 by default. If
11101 your network is buggy, you should set this to 1.
11103 @item nntp-connection-timeout
11104 @vindex nntp-connection-timeout
11105 If you have lots of foreign @code{nntp} groups that you connect to
11106 regularly, you're sure to have problems with @sc{nntp} servers not
11107 responding properly, or being too loaded to reply within reasonable
11108 time. This is can lead to awkward problems, which can be helped
11109 somewhat by setting @code{nntp-connection-timeout}. This is an integer
11110 that says how many seconds the @code{nntp} backend should wait for a
11111 connection before giving up. If it is @code{nil}, which is the default,
11112 no timeouts are done.
11114 @c @item nntp-command-timeout
11115 @c @vindex nntp-command-timeout
11116 @c @cindex PPP connections
11117 @c @cindex dynamic IP addresses
11118 @c If you're running Gnus on a machine that has a dynamically assigned
11119 @c address, Gnus may become confused. If the address of your machine
11120 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
11121 @c waiting forever for replies from the server. To help with this
11122 @c unfortunate problem, you can set this command to a number. Gnus will
11123 @c then, if it sits waiting for a reply from the server longer than that
11124 @c number of seconds, shut down the connection, start a new one, and resend
11125 @c the command. This should hopefully be transparent to the user. A
11126 @c likely number is 30 seconds.
11128 @c @item nntp-retry-on-break
11129 @c @vindex nntp-retry-on-break
11130 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
11131 @c hangs. This will have much the same effect as the command timeout
11132 @c described above.
11134 @item nntp-server-hook
11135 @vindex nntp-server-hook
11136 This hook is run as the last step when connecting to an @sc{nntp}
11139 @item nntp-buggy-select
11140 @vindex nntp-buggy-select
11141 Set this to non-@code{nil} if your select routine is buggy.
11143 @item nntp-nov-is-evil
11144 @vindex nntp-nov-is-evil
11145 If the @sc{nntp} server does not support @sc{nov}, you could set this
11146 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
11149 @item nntp-xover-commands
11150 @vindex nntp-xover-commands
11153 List of strings used as commands to fetch @sc{nov} lines from a
11154 server. The default value of this variable is @code{("XOVER"
11158 @vindex nntp-nov-gap
11159 @code{nntp} normally sends just one big request for @sc{nov} lines to
11160 the server. The server responds with one huge list of lines. However,
11161 if you have read articles 2-5000 in the group, and only want to read
11162 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
11163 lines that you will not need. This variable says how
11164 big a gap between two consecutive articles is allowed to be before the
11165 @code{XOVER} request is split into several request. Note that if your
11166 network is fast, setting this variable to a really small number means
11167 that fetching will probably be slower. If this variable is @code{nil},
11168 @code{nntp} will never split requests. The default is 5.
11170 @item nntp-prepare-server-hook
11171 @vindex nntp-prepare-server-hook
11172 A hook run before attempting to connect to an @sc{nntp} server.
11174 @item nntp-warn-about-losing-connection
11175 @vindex nntp-warn-about-losing-connection
11176 If this variable is non-@code{nil}, some noise will be made when a
11177 server closes connection.
11179 @item nntp-record-commands
11180 @vindex nntp-record-commands
11181 If non-@code{nil}, @code{nntp} will log all commands it sends to the
11182 @sc{nntp} server (along with a timestamp) in the @samp{*nntp-log*}
11183 buffer. This is useful if you are debugging a Gnus/@sc{nntp} connection
11184 that doesn't seem to work.
11186 @item nntp-open-connection-function
11187 @vindex nntp-open-connection-function
11188 It is possible to customize how the connection to the nntp server will
11189 be opened. If you specify an @code{nntp-open-connection-function}
11190 parameter, Gnus will use that function to establish the connection.
11191 Five pre-made functions are supplied. These functions can be grouped in
11192 two categories: direct connection functions (three pre-made), and
11193 indirect ones (two pre-made).
11197 * Direct Functions:: Connecting directly to the server.
11198 * Indirect Functions:: Connecting indirectly to the server.
11199 * Common Variables:: Understood by several connection functions.
11203 @node Direct Functions
11204 @subsubsection Direct Functions
11205 @cindex direct connection functions
11207 These functions are called direct because they open a direct connection
11208 between your machine and the @sc{nntp} server. The behavior of these
11209 functions is also affected by commonly understood variables
11210 (@pxref{Common Variables}).
11213 @findex nntp-open-network-stream
11214 @item nntp-open-network-stream
11215 This is the default, and simply connects to some port or other on the
11218 @findex nntp-open-ssl-stream
11219 @item nntp-open-ssl-stream
11220 Opens a connection to a server over a @dfn{secure} channel. To use this
11221 you must have SSLay installed
11222 (@uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
11223 @file{ssl.el} (from the W3 distribution, for instance). You then
11224 define a server as follows:
11227 ;; Type `C-c C-c' after you've finished editing.
11229 ;; "snews" is port 563 and is predefined in our /etc/services
11231 (nntp "snews.bar.com"
11232 (nntp-open-connection-function nntp-open-ssl-stream)
11233 (nntp-port-number "snews")
11234 (nntp-address "snews.bar.com"))
11237 @findex nntp-open-telnet-stream
11238 @item nntp-open-telnet-stream
11239 Opens a connection to an @sc{nntp} server by simply @samp{telnet}'ing
11240 it. You might wonder why this function exists, since we have the
11241 default @code{nntp-open-network-stream} which would do the job. (One
11242 of) the reason(s) is that if you are behind a firewall but have direct
11243 connections to the outside world thanks to a command wrapper like
11244 @code{runsocks}, you can use it like this:
11248 (nntp-pre-command "runsocks")
11249 (nntp-open-connection-function nntp-open-telnet-stream)
11250 (nntp-address "the.news.server"))
11253 With the default method, you would need to wrap your whole Emacs
11254 session, which is not a good idea.
11258 @node Indirect Functions
11259 @subsubsection Indirect Functions
11260 @cindex indirect connection functions
11262 These functions are called indirect because they connect to an
11263 intermediate host before actually connecting to the @sc{nntp} server.
11264 All of these functions and related variables are also said to belong to
11265 the "via" family of connection: they're all prefixed with "via" to make
11266 things cleaner. The behavior of these functions is also affected by
11267 commonly understood variables (@pxref{Common Variables}).
11270 @item nntp-open-via-rlogin-and-telnet
11271 @findex nntp-open-via-rlogin-and-telnet
11272 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
11273 to the real @sc{nntp} server from there. This is useful for instance if
11274 you need to connect to a firewall machine first.
11276 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
11279 @item nntp-via-rlogin-command
11280 @vindex nntp-via-rlogin-command
11281 Command used to log in on the intermediate host. The default is
11282 @samp{rsh}, but @samp{ssh} is a popular alternative.
11285 @item nntp-open-via-telnet-and-telnet
11286 @findex nntp-open-via-telnet-and-telnet
11287 Does essentially the same, but uses @samp{telnet} instead of
11288 @samp{rlogin} to connect to the intermediate host.
11290 @code{nntp-open-via-telnet-and-telnet}-specific variables:
11293 @item nntp-via-telnet-command
11294 @vindex nntp-via-telnet-command
11295 Command used to @code{telnet} the intermediate host. The default is
11298 @item nntp-via-telnet-switches
11299 @vindex nntp-via-telnet-switches
11300 List of strings to be used as the switches to the
11301 @code{nntp-via-telnet-command} command. The default is @samp{("-8")}.
11303 @item nntp-via-user-password
11304 @vindex nntp-via-user-password
11305 Password to use when logging in on the intermediate host.
11307 @item nntp-via-envuser
11308 @vindex nntp-via-envuser
11309 If non-@code{nil}, the intermediate @code{telnet} session (client and
11310 server both) will support the @code{ENVIRON} option and not prompt for
11311 login name. This works for Solaris @code{telnet}, for instance.
11313 @item nntp-via-shell-prompt
11314 @vindex nntp-via-shell-prompt
11315 Regexp matching the shell prompt on the intermediate host. The default
11316 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
11323 Here are some additional variables that are understood by all the above
11328 @item nntp-via-user-name
11329 @vindex nntp-via-user-name
11330 User name to use when connecting to the intermediate host.
11332 @item nntp-via-address
11333 @vindex nntp-via-address
11334 Address of the intermediate host to connect to.
11339 @node Common Variables
11340 @subsubsection Common Variables
11342 The following variables affect the behavior of all, or several of the
11343 pre-made connection functions. When not specified, all functions are
11348 @item nntp-pre-command
11349 @vindex nntp-pre-command
11350 A command wrapper to use when connecting through a non native connection
11351 function (all except @code{nntp-open-network-stream} and
11352 @code{nntp-open-ssl-stream}. This is where you would put a @samp{SOCKS}
11353 wrapper for instance.
11356 @vindex nntp-address
11357 The address of the @sc{nntp} server.
11359 @item nntp-port-number
11360 @vindex nntp-port-number
11361 Port number to connect to the @sc{nntp} server. The default is @samp{nntp}.
11363 @item nntp-end-of-line
11364 @vindex nntp-end-of-line
11365 String to use as end-of-line marker when talking to the @sc{nntp}
11366 server. This is @samp{\r\n} by default, but should be @samp{\n} when
11367 using a non native connection function.
11369 @item nntp-telnet-command
11370 @vindex nntp-telnet-command
11371 Command to use when connecting to the @sc{nntp} server through
11372 @samp{telnet}. This is NOT for an intermediate host. This is just for
11373 the real @sc{nntp} server. The default is @samp{telnet}.
11375 @item nntp-telnet-switches
11376 @vindex nntp-telnet-switches
11377 A list of switches to pass to @code{nntp-telnet-command}. The default
11384 @subsection News Spool
11388 Subscribing to a foreign group from the local spool is extremely easy,
11389 and might be useful, for instance, to speed up reading groups that
11390 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
11393 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
11394 anything else) as the address.
11396 If you have access to a local spool, you should probably use that as the
11397 native select method (@pxref{Finding the News}). It is normally faster
11398 than using an @code{nntp} select method, but might not be. It depends.
11399 You just have to try to find out what's best at your site.
11403 @item nnspool-inews-program
11404 @vindex nnspool-inews-program
11405 Program used to post an article.
11407 @item nnspool-inews-switches
11408 @vindex nnspool-inews-switches
11409 Parameters given to the inews program when posting an article.
11411 @item nnspool-spool-directory
11412 @vindex nnspool-spool-directory
11413 Where @code{nnspool} looks for the articles. This is normally
11414 @file{/usr/spool/news/}.
11416 @item nnspool-nov-directory
11417 @vindex nnspool-nov-directory
11418 Where @code{nnspool} will look for @sc{nov} files. This is normally
11419 @file{/usr/spool/news/over.view/}.
11421 @item nnspool-lib-dir
11422 @vindex nnspool-lib-dir
11423 Where the news lib dir is (@file{/usr/lib/news/} by default).
11425 @item nnspool-active-file
11426 @vindex nnspool-active-file
11427 The path to the active file.
11429 @item nnspool-newsgroups-file
11430 @vindex nnspool-newsgroups-file
11431 The path to the group descriptions file.
11433 @item nnspool-history-file
11434 @vindex nnspool-history-file
11435 The path to the news history file.
11437 @item nnspool-active-times-file
11438 @vindex nnspool-active-times-file
11439 The path to the active date file.
11441 @item nnspool-nov-is-evil
11442 @vindex nnspool-nov-is-evil
11443 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
11446 @item nnspool-sift-nov-with-sed
11447 @vindex nnspool-sift-nov-with-sed
11449 If non-@code{nil}, which is the default, use @code{sed} to get the
11450 relevant portion from the overview file. If nil, @code{nnspool} will
11451 load the entire file into a buffer and process it there.
11457 @section Getting Mail
11458 @cindex reading mail
11461 Reading mail with a newsreader---isn't that just plain WeIrD? But of
11465 * Mail in a Newsreader:: Important introductory notes.
11466 * Getting Started Reading Mail:: A simple cookbook example.
11467 * Splitting Mail:: How to create mail groups.
11468 * Mail Sources:: How to tell Gnus where to get mail from.
11469 * Mail Backend Variables:: Variables for customizing mail handling.
11470 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
11471 * Group Mail Splitting:: Use group customize to drive mail splitting.
11472 * Incorporating Old Mail:: What about the old mail you have?
11473 * Expiring Mail:: Getting rid of unwanted mail.
11474 * Washing Mail:: Removing gruft from the mail you get.
11475 * Duplicates:: Dealing with duplicated mail.
11476 * Not Reading Mail:: Using mail backends for reading other files.
11477 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
11481 @node Mail in a Newsreader
11482 @subsection Mail in a Newsreader
11484 If you are used to traditional mail readers, but have decided to switch
11485 to reading mail with Gnus, you may find yourself experiencing something
11486 of a culture shock.
11488 Gnus does not behave like traditional mail readers. If you want to make
11489 it behave that way, you can, but it's an uphill battle.
11491 Gnus, by default, handles all its groups using the same approach. This
11492 approach is very newsreaderly---you enter a group, see the new/unread
11493 messages, and when you read the messages, they get marked as read, and
11494 you don't see them any more. (Unless you explicitly ask for them.)
11496 In particular, you do not do anything explicitly to delete messages.
11498 Does this mean that all the messages that have been marked as read are
11499 deleted? How awful!
11501 But, no, it means that old messages are @dfn{expired} according to some
11502 scheme or other. For news messages, the expire process is controlled by
11503 the news administrator; for mail, the expire process is controlled by
11504 you. The expire process for mail is covered in depth in @pxref{Expiring
11507 What many Gnus users find, after using it a while for both news and
11508 mail, is that the transport mechanism has very little to do with how
11509 they want to treat a message.
11511 Many people subscribe to several mailing lists. These are transported
11512 via SMTP, and are therefore mail. But we might go for weeks without
11513 answering, or even reading these messages very carefully. We may not
11514 need to save them because if we should need to read one again, they are
11515 archived somewhere else.
11517 Some people have local news groups which have only a handful of readers.
11518 These are transported via @sc{nntp}, and are therefore news. But we may need
11519 to read and answer a large fraction of the messages very carefully in
11520 order to do our work. And there may not be an archive, so we may need
11521 to save the interesting messages the same way we would personal mail.
11523 The important distinction turns out to be not the transport mechanism,
11524 but other factors such as how interested we are in the subject matter,
11525 or how easy it is to retrieve the message if we need to read it again.
11527 Gnus provides many options for sorting mail into ``groups'' which behave
11528 like newsgroups, and for treating each group (whether mail or news)
11531 Some users never get comfortable using the Gnus (ahem) paradigm and wish
11532 that Gnus should grow up and be a male, er, mail reader. It is possible
11533 to whip Gnus into a more mailreaderly being, but, as said before, it's
11534 not easy. People who prefer proper mail readers should try @sc{vm}
11535 instead, which is an excellent, and proper, mail reader.
11537 I don't mean to scare anybody off, but I want to make it clear that you
11538 may be required to learn a new way of thinking about messages. After
11539 you've been subjected to The Gnus Way, you will come to love it. I can
11540 guarantee it. (At least the guy who sold me the Emacs Subliminal
11541 Brain-Washing Functions that I've put into Gnus did guarantee it. You
11542 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
11546 @node Getting Started Reading Mail
11547 @subsection Getting Started Reading Mail
11549 It's quite easy to use Gnus to read your new mail. You just plonk the
11550 mail backend of your choice into @code{gnus-secondary-select-methods},
11551 and things will happen automatically.
11553 For instance, if you want to use @code{nnml} (which is a "one file per
11554 mail" backend), you could put the following in your @file{.gnus} file:
11557 (setq gnus-secondary-select-methods '((nnml "")))
11560 Now, the next time you start Gnus, this backend will be queried for new
11561 articles, and it will move all the messages in your spool file to its
11562 directory, which is @code{~/Mail/} by default. The new group that will
11563 be created (@samp{mail.misc}) will be subscribed, and you can read it
11564 like any other group.
11566 You will probably want to split the mail into several groups, though:
11569 (setq nnmail-split-methods
11570 '(("junk" "^From:.*Lars Ingebrigtsen")
11571 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
11575 This will result in three new @code{nnml} mail groups being created:
11576 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
11577 mail that doesn't fit into the first two groups will be placed in the
11580 This should be sufficient for reading mail with Gnus. You might want to
11581 give the other sections in this part of the manual a perusal, though.
11582 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
11585 @node Splitting Mail
11586 @subsection Splitting Mail
11587 @cindex splitting mail
11588 @cindex mail splitting
11590 @vindex nnmail-split-methods
11591 The @code{nnmail-split-methods} variable says how the incoming mail is
11592 to be split into groups.
11595 (setq nnmail-split-methods
11596 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
11597 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
11598 ("mail.other" "")))
11601 This variable is a list of lists, where the first element of each of
11602 these lists is the name of the mail group (they do not have to be called
11603 something beginning with @samp{mail}, by the way), and the second
11604 element is a regular expression used on the header of each mail to
11605 determine if it belongs in this mail group. The first string may
11606 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
11607 insert sub-expressions from the matched text. For instance:
11610 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
11613 The second element can also be a function. In that case, it will be
11614 called narrowed to the headers with the first element of the rule as the
11615 argument. It should return a non-@code{nil} value if it thinks that the
11616 mail belongs in that group.
11618 The last of these groups should always be a general one, and the regular
11619 expression should @emph{always} be @samp{} so that it matches any mails
11620 that haven't been matched by any of the other regexps. (These rules are
11621 processed from the beginning of the alist toward the end. The first
11622 rule to make a match will "win", unless you have crossposting enabled.
11623 In that case, all matching rules will "win".)
11625 If you like to tinker with this yourself, you can set this variable to a
11626 function of your choice. This function will be called without any
11627 arguments in a buffer narrowed to the headers of an incoming mail
11628 message. The function should return a list of group names that it
11629 thinks should carry this mail message.
11631 Note that the mail backends are free to maul the poor, innocent,
11632 incoming headers all they want to. They all add @code{Lines} headers;
11633 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
11634 @code{From<SPACE>} line to something else.
11636 @vindex nnmail-crosspost
11637 The mail backends all support cross-posting. If several regexps match,
11638 the mail will be ``cross-posted'' to all those groups.
11639 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
11640 that no articles are crossposted to the general (@samp{}) group.
11642 @vindex nnmail-crosspost-link-function
11645 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
11646 the crossposted articles. However, not all file systems support hard
11647 links. If that's the case for you, set
11648 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
11649 variable is @code{add-name-to-file} by default.)
11651 @kindex M-x nnmail-split-history
11652 @kindex nnmail-split-history
11653 If you wish to see where the previous mail split put the messages, you
11654 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
11655 where re-spooling messages would put the messages, you can use
11656 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
11659 Gnus gives you all the opportunity you could possibly want for shooting
11660 yourself in the foot. Let's say you create a group that will contain
11661 all the mail you get from your boss. And then you accidentally
11662 unsubscribe from the group. Gnus will still put all the mail from your
11663 boss in the unsubscribed group, and so, when your boss mails you ``Have
11664 that report ready by Monday or you're fired!'', you'll never see it and,
11665 come Tuesday, you'll still believe that you're gainfully employed while
11666 you really should be out collecting empty bottles to save up for next
11667 month's rent money.
11671 @subsection Mail Sources
11673 Mail can be gotten from many different sources---the mail spool, from a
11674 POP mail server, from a procmail directory, or from a maildir, for
11678 * Mail Source Specifiers:: How to specify what a mail source is.
11679 * Mail Source Customization:: Some variables that influence things.
11680 * Fetching Mail:: Using the mail source specifiers.
11684 @node Mail Source Specifiers
11685 @subsubsection Mail Source Specifiers
11687 @cindex mail server
11690 @cindex mail source
11692 You tell Gnus how to fetch mail by setting @code{mail-sources}
11693 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
11698 (pop :server "pop3.mailserver.com" :user "myname")
11701 As can be observed, a mail source specifier is a list where the first
11702 element is a @dfn{mail source type}, followed by an arbitrary number of
11703 @dfn{keywords}. Keywords that are not explicitly specified are given
11706 The following mail source types are available:
11710 Get mail from a single file; typically from the mail spool.
11716 The path of the file. Defaults to the value of the @code{MAIL}
11717 environment variable or @file{/usr/mail/spool/user-name}.
11720 An example file mail source:
11723 (file :path "/usr/spool/mail/user-name")
11726 Or using the default path:
11732 If the mail spool file is not located on the local machine, it's best to
11733 use POP or @sc{imap} or the like to fetch the mail. You can not use ange-ftp
11734 file names here---it has no way to lock the mail spool while moving the
11737 If it's impossible to set up a proper server, you can use ssh instead.
11741 '((file :prescript "ssh host bin/getmail >%t")))
11744 The @samp{getmail} script would look something like the following:
11748 # getmail - move mail from spool to stdout
11751 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
11753 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
11756 Alter this script to fit find the @samp{movemail} you want to use.
11760 Get mail from several files in a directory. This is typically used when
11761 you have procmail split the incoming mail into several files. Setting
11762 @code{nnmail-scan-directory-mail-source-once} to non-nil forces Gnus to
11763 scan the mail source only once. This is particularly useful if you want
11764 to scan mail groups at a specified level.
11770 The path of the directory where the files are. There is no default
11774 Only files ending with this suffix are used. The default is
11778 Only files that have this predicate return non-@code{nil} are returned.
11779 The default is @code{identity}. This is used as an additional
11780 filter---only files that have the right suffix @emph{and} satisfy this
11781 predicate are considered.
11785 Script run before/after fetching mail.
11789 An example directory mail source:
11792 (directory :path "/home/user-name/procmail-dir/"
11797 Get mail from a POP server.
11803 The name of the POP server. The default is taken from the
11804 @code{MAILHOST} environment variable.
11807 The port number of the POP server. This can be a number (eg,
11808 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
11809 string, it should be a service name as listed in @file{/etc/services} on
11810 Unix systems. The default is @samp{"pop3"}. On some systems you might
11811 need to specify it as @samp{"pop-3"} instead.
11814 The user name to give to the POP server. The default is the login
11818 The password to give to the POP server. If not specified, the user is
11822 The program to use to fetch mail from the POP server. This should be
11823 a @code{format}-like string. Here's an example:
11826 fetchmail %u@@%s -P %p %t
11829 The valid format specifier characters are:
11833 The name of the file the mail is to be moved to. This must always be
11834 included in this string.
11837 The name of the server.
11840 The port number of the server.
11843 The user name to use.
11846 The password to use.
11849 The values used for these specs are taken from the values you give the
11850 corresponding keywords.
11853 A script to be run before fetching the mail. The syntax is the same as
11854 the @code{:program} keyword. This can also be a function to be run.
11857 A script to be run after fetching the mail. The syntax is the same as
11858 the @code{:program} keyword. This can also be a function to be run.
11861 The function to use to fetch mail from the POP server. The function is
11862 called with one parameter---the name of the file where the mail should
11865 @item :authentication
11866 This can be either the symbol @code{password} or the symbol @code{apop}
11867 and says what authentication scheme to use. The default is
11872 If the @code{:program} and @code{:function} keywords aren't specified,
11873 @code{pop3-movemail} will be used.
11875 Here are some examples. Fetch from the default POP server, using the
11876 default user name, and default fetcher:
11882 Fetch from a named server with a named user and password:
11885 (pop :server "my.pop.server"
11886 :user "user-name" :password "secret")
11889 Use @samp{movemail} to move the mail:
11892 (pop :program "movemail po:%u %t %p")
11896 Get mail from a maildir. This is a type of mailbox that is supported by
11897 at least qmail and postfix, where each file in a special directory
11898 contains exactly one mail.
11904 The path of the directory where the mails are stored. The default is
11905 taken from the @code{MAILDIR} environment variable or
11908 The subdirectories of the Maildir. The default is
11909 @samp{("new" "cur")}.
11911 @c If you sometimes look at your mail through a pop3 daemon before fetching
11912 @c them with Gnus, you may also have to fetch your mails from the
11913 @c @code{cur} directory inside the maildir, like in the first example
11916 You can also get mails from remote hosts (because maildirs don't suffer
11917 from locking problems).
11921 Two example maildir mail sources:
11924 (maildir :path "/home/user-name/Maildir/"
11925 :subdirs ("cur" "new"))
11929 (maildir :path "/user@@remotehost.org:~/Maildir/"
11934 Get mail from a @sc{imap} server. If you don't want to use @sc{imap}
11935 as intended, as a network mail reading protocol (ie with nnimap), for
11936 some reason or other, Gnus let you treat it similar to a POP server
11937 and fetches articles from a given @sc{imap} mailbox. @xref{IMAP}, for
11944 The name of the @sc{imap} server. The default is taken from the
11945 @code{MAILHOST} environment variable.
11948 The port number of the @sc{imap} server. The default is @samp{143}, or
11949 @samp{993} for SSL connections.
11952 The user name to give to the @sc{imap} server. The default is the login
11956 The password to give to the @sc{imap} server. If not specified, the user is
11960 What stream to use for connecting to the server, this is one of the
11961 symbols in @code{imap-stream-alist}. Right now, this means
11962 @samp{kerberos4}, @samp{ssl} or the default @samp{network}.
11964 @item :authentication
11965 Which authenticator to use for authenticating to the server, this is one
11966 of the symbols in @code{imap-authenticator-alist}. Right now, this
11967 means @samp{kerberos4}, @samp{cram-md5}, @samp{anonymous} or the default
11971 When using the `shell' :stream, the contents of this variable is
11972 mapped into the `imap-shell-program' variable. This should be a
11973 @code{format}-like string (or list of strings). Here's an example:
11979 The valid format specifier characters are:
11983 The name of the server.
11986 User name from `imap-default-user'.
11989 The port number of the server.
11992 The values used for these specs are taken from the values you give the
11993 corresponding keywords.
11996 The name of the mailbox to get mail from. The default is @samp{INBOX}
11997 which normally is the mailbox which receive incoming mail.
12000 The predicate used to find articles to fetch. The default, @samp{UNSEEN
12001 UNDELETED}, is probably the best choice for most people, but if you
12002 sometimes peek in your mailbox with a @sc{imap} client and mark some
12003 articles as read (or; SEEN) you might want to set this to @samp{nil}.
12004 Then all articles in the mailbox is fetched, no matter what. For a
12005 complete list of predicates, see RFC 2060 §6.4.4.
12008 How to flag fetched articles on the server, the default @samp{\Deleted}
12009 will mark them as deleted, an alternative would be @samp{\Seen} which
12010 would simply mark them as read. These are the two most likely choices,
12011 but more flags are defined in RFC 2060 §2.3.2.
12014 If non-nil, don't remove all articles marked as deleted in the mailbox
12015 after finishing the fetch.
12019 An example @sc{imap} mail source:
12022 (imap :server "mail.mycorp.com"
12024 :fetchflag "\\Seen")
12028 Get mail from a webmail server, such as www.hotmail.com,
12029 webmail.netscape.com, www.netaddress.com, www.my-deja.com.
12031 NOTE: Now mail.yahoo.com provides POP3 service, so @sc{pop} mail source
12034 NOTE: Webmail largely depends cookies. A "one-line-cookie" patch is
12035 required for url "4.0pre.46".
12037 WARNING: Mails may lost. NO WARRANTY.
12043 The type of the webmail server. The default is @code{hotmail}. The
12044 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
12047 The user name to give to the webmail server. The default is the login
12051 The password to give to the webmail server. If not specified, the user is
12055 If non-nil, only fetch unread articles and don't move them to trash
12056 folder after finishing the fetch.
12060 An example webmail source:
12063 (webmail :subtype 'hotmail
12065 :password "secret")
12070 @item Common Keywords
12071 Common keywords can be used in any type of mail source.
12077 If non-nil, fetch the mail even when Gnus is unplugged. If you use
12078 directory source to get mail, you can specify it as in this example:
12082 '((directory :path "/home/pavel/.Spool/"
12087 Gnus will then fetch your mail even when you are unplugged. This is
12088 useful when you use local mail and news.
12093 @subsubsection Function Interface
12095 Some of the above keywords specify a Lisp function to be executed.
12096 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
12097 the value of the keyword while the function is executing. For example,
12098 consider the following mail-source setting:
12101 (setq mail-sources '((pop :user "jrl"
12102 :server "pophost" :function fetchfunc)))
12105 While the function @code{fetchfunc} is executing, the symbol @code{user}
12106 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
12107 @code{"pophost"}. The symbols @code{port}, @code{password},
12108 @code{program}, @code{prescript}, @code{postscript}, @code{function},
12109 and @code{authentication} are also bound (to their default values).
12111 See above for a list of keywords for each type of mail source.
12114 @node Mail Source Customization
12115 @subsubsection Mail Source Customization
12117 The following is a list of variables that influence how the mail is
12118 fetched. You would normally not need to set or change any of these
12122 @item mail-source-crash-box
12123 @vindex mail-source-crash-box
12124 File where mail will be stored while processing it. The default is
12125 @file{~/.emacs-mail-crash-box}.
12127 @item mail-source-delete-incoming
12128 @vindex mail-source-delete-incoming
12129 If non-@code{nil}, delete incoming files after handling them.
12131 @item mail-source-directory
12132 @vindex mail-source-directory
12133 Directory where files (if any) will be stored. The default is
12134 @file{~/Mail/}. At present, the only thing this is used for is to say
12135 where the incoming files will be stored if the previous variable is
12138 @item mail-source-incoming-file-prefix
12139 @vindex mail-source-incoming-file-prefix
12140 Prefix for file name for storing incoming mail. The default is
12141 @file{Incoming}, in which case files will end up with names like
12142 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
12143 relevant if @code{mail-source-delete-incoming} is @code{nil}.
12145 @item mail-source-default-file-modes
12146 @vindex mail-source-default-file-modes
12147 All new mail files will get this file mode. The default is 384.
12152 @node Fetching Mail
12153 @subsubsection Fetching Mail
12155 @vindex mail-sources
12156 @vindex nnmail-spool-file
12157 The way to actually tell Gnus where to get new mail from is to set
12158 @code{mail-sources} to a list of mail source specifiers
12159 (@pxref{Mail Source Specifiers}).
12161 If this variable (and the obsolescent @code{nnmail-spool-file}) is
12162 @code{nil}, the mail backends will never attempt to fetch mail by
12165 If you want to fetch mail both from your local spool as well as a POP
12166 mail server, you'd say something like:
12171 (pop :server "pop3.mail.server"
12172 :password "secret")))
12175 Or, if you don't want to use any of the keyword defaults:
12179 '((file :path "/var/spool/mail/user-name")
12180 (pop :server "pop3.mail.server"
12183 :password "secret")))
12187 When you use a mail backend, Gnus will slurp all your mail from your
12188 inbox and plonk it down in your home directory. Gnus doesn't move any
12189 mail if you're not using a mail backend---you have to do a lot of magic
12190 invocations first. At the time when you have finished drawing the
12191 pentagram, lightened the candles, and sacrificed the goat, you really
12192 shouldn't be too surprised when Gnus moves your mail.
12196 @node Mail Backend Variables
12197 @subsection Mail Backend Variables
12199 These variables are (for the most part) pertinent to all the various
12203 @vindex nnmail-read-incoming-hook
12204 @item nnmail-read-incoming-hook
12205 The mail backends all call this hook after reading new mail. You can
12206 use this hook to notify any mail watch programs, if you want to.
12208 @vindex nnmail-split-hook
12209 @item nnmail-split-hook
12210 @findex article-decode-encoded-words
12211 @findex RFC 1522 decoding
12212 @findex RFC 2047 decoding
12213 Hook run in the buffer where the mail headers of each message is kept
12214 just before the splitting based on these headers is done. The hook is
12215 free to modify the buffer contents in any way it sees fit---the buffer
12216 is discarded after the splitting has been done, and no changes performed
12217 in the buffer will show up in any files.
12218 @code{gnus-article-decode-encoded-words} is one likely function to add
12221 @vindex nnmail-pre-get-new-mail-hook
12222 @vindex nnmail-post-get-new-mail-hook
12223 @item nnmail-pre-get-new-mail-hook
12224 @itemx nnmail-post-get-new-mail-hook
12225 These are two useful hooks executed when treating new incoming
12226 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
12227 starting to handle the new mail) and
12228 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
12229 is done). Here's and example of using these two hooks to change the
12230 default file modes the new mail files get:
12233 (add-hook 'nnmail-pre-get-new-mail-hook
12234 (lambda () (set-default-file-modes 511)))
12236 (add-hook 'nnmail-post-get-new-mail-hook
12237 (lambda () (set-default-file-modes 551)))
12240 @item nnmail-use-long-file-names
12241 @vindex nnmail-use-long-file-names
12242 If non-@code{nil}, the mail backends will use long file and directory
12243 names. Groups like @samp{mail.misc} will end up in directories
12244 (assuming use of @code{nnml} backend) or files (assuming use of
12245 @code{nnfolder} backend) like @file{mail.misc}. If it is @code{nil},
12246 the same group will end up in @file{mail/misc}.
12248 @item nnmail-delete-file-function
12249 @vindex nnmail-delete-file-function
12250 @findex delete-file
12251 Function called to delete files. It is @code{delete-file} by default.
12253 @item nnmail-cache-accepted-message-ids
12254 @vindex nnmail-cache-accepted-message-ids
12255 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
12256 the backend (via @code{Gcc}, for instance) into the mail duplication
12257 discovery cache. The default is @code{nil}.
12262 @node Fancy Mail Splitting
12263 @subsection Fancy Mail Splitting
12264 @cindex mail splitting
12265 @cindex fancy mail splitting
12267 @vindex nnmail-split-fancy
12268 @findex nnmail-split-fancy
12269 If the rather simple, standard method for specifying how to split mail
12270 doesn't allow you to do what you want, you can set
12271 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
12272 play with the @code{nnmail-split-fancy} variable.
12274 Let's look at an example value of this variable first:
12277 ;; Messages from the mailer daemon are not crossposted to any of
12278 ;; the ordinary groups. Warnings are put in a separate group
12279 ;; from real errors.
12280 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
12282 ;; Non-error messages are crossposted to all relevant
12283 ;; groups, but we don't crosspost between the group for the
12284 ;; (ding) list and the group for other (ding) related mail.
12285 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
12286 ("subject" "ding" "ding.misc"))
12287 ;; Other mailing lists...
12288 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
12289 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
12290 ;; Both lists below have the same suffix, so prevent
12291 ;; cross-posting to mkpkg.list of messages posted only to
12292 ;; the bugs- list, but allow cross-posting when the
12293 ;; message was really cross-posted.
12294 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
12295 (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
12297 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
12298 ;; Unmatched mail goes to the catch all group.
12302 This variable has the format of a @dfn{split}. A split is a (possibly)
12303 recursive structure where each split may contain other splits. Here are
12304 the five possible split syntaxes:
12309 @samp{group}: If the split is a string, that will be taken as a group
12310 name. Normal regexp match expansion will be done. See below for
12314 @code{(@var{field} @var{value} @code{[-} @var{restrict}
12315 @code{[@dots{}]}@code{]} @var{split})}: If the split is a list, the
12316 first element of which is a string, then store the message as
12317 specified by @var{split}, if header @var{field} (a regexp) contains
12318 @var{value} (also a regexp). If @var{restrict} (yet another regexp)
12319 matches some string after @var{field} and before the end of the
12320 matched @var{value}, the @var{split} is ignored. If none of the
12321 @var{restrict} clauses match, @var{split} is processed.
12324 @code{(| @var{split}@dots{})}: If the split is a list, and the first
12325 element is @code{|} (vertical bar), then process each @var{split} until
12326 one of them matches. A @var{split} is said to match if it will cause
12327 the mail message to be stored in one or more groups.
12330 @code{(& @var{split}@dots{})}: If the split is a list, and the first
12331 element is @code{&}, then process all @var{split}s in the list.
12334 @code{junk}: If the split is the symbol @code{junk}, then don't save
12335 this message. Use with extreme caution.
12338 @code{(: @var{function} @var{arg1} @var{arg2} @dots{})}: If the split is
12339 a list, and the first element is @code{:}, then the second element will
12340 be called as a function with @var{args} given as arguments. The
12341 function should return a @var{split}.
12344 For instance, the following function could be used to split based on the
12345 body of the messages:
12348 (defun split-on-body ()
12350 (set-buffer " *nnmail incoming*")
12351 (goto-char (point-min))
12352 (when (re-search-forward "Some.*string" nil t)
12356 The @samp{" *nnmail incoming*"} is narrowed to the message in question
12357 when the @code{:} function is run.
12360 @code{(! @var{func} @var{split})}: If the split is a list, and the first
12361 element is @code{!}, then SPLIT will be processed, and FUNC will be
12362 called as a function with the result of SPLIT as argument. FUNC should
12366 @code{nil}: If the split is @code{nil}, it is ignored.
12370 In these splits, @var{field} must match a complete field name.
12371 @var{value} must match a complete word according to the fundamental mode
12372 syntax table. You can use @code{.*} in the regexps to match partial
12373 field names or words. In other words, all @var{value}'s are wrapped in
12374 @samp{\<} and @samp{\>} pairs.
12376 @vindex nnmail-split-abbrev-alist
12377 @var{field} and @var{value} can also be lisp symbols, in that case they
12378 are expanded as specified by the variable
12379 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
12380 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
12383 @vindex nnmail-split-fancy-syntax-table
12384 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
12385 when all this splitting is performed.
12387 If you want to have Gnus create groups dynamically based on some
12388 information in the headers (i.e., do @code{replace-match}-like
12389 substitutions in the group names), you can say things like:
12392 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
12395 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
12396 will be filed in @samp{mail.debian.foo}.
12398 If the string contains the element @samp{\&}, then the previously
12399 matched string will be substituted. Similarly, the elements @samp{\\1}
12400 up to @samp{\\9} will be substituted with the text matched by the
12401 groupings 1 through 9.
12403 @findex nnmail-split-fancy-with-parent
12404 @code{nnmail-split-fancy-with-parent} is a function which allows you to
12405 split followups into the same groups their parents are in. Sometimes
12406 you can't make splitting rules for all your mail. For example, your
12407 boss might send you personal mail regarding different projects you are
12408 working on, and as you can't tell your boss to put a distinguishing
12409 string into the subject line, you have to resort to manually moving the
12410 messages into the right group. With this function, you only have to do
12411 it once per thread.
12413 To use this feature, you have to set @code{nnmail-treat-duplicates} and
12414 @code{nnmail-cache-accepted-message-ids} to a non-nil value. And then
12415 you can include @code{nnmail-split-fancy-with-parent} using the colon
12418 (setq nnmail-split-fancy
12419 '(| (: nnmail-split-fancy-with-parent)
12420 ;; other splits go here
12424 This feature works as follows: when @code{nnmail-treat-duplicates} is
12425 non-nil, Gnus records the message id of every message it sees in the
12426 file specified by the variable @code{nnmail-message-id-cache-file},
12427 together with the group it is in (the group is omitted for non-mail
12428 messages). When mail splitting is invoked, the function
12429 @code{nnmail-split-fancy-with-parent} then looks at the References (and
12430 In-Reply-To) header of each message to split and searches the file
12431 specified by @code{nnmail-message-id-cache-file} for the message ids.
12432 When it has found a parent, it returns the corresponding group name
12433 unless the group name matches the regexp
12434 @code{nnmail-split-fancy-with-parent-ignore-groups}. It is recommended
12435 that you set @code{nnmail-message-id-cache-length} to a somewhat higher
12436 number than the default so that the message ids are still in the cache.
12437 (A value of 5000 appears to create a file some 300 kBytes in size.)
12438 @vindex nnmail-cache-accepted-message-ids
12439 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
12440 also records the message ids of moved articles, so that the followup
12441 messages goes into the new group.
12444 @node Group Mail Splitting
12445 @subsection Group Mail Splitting
12446 @cindex mail splitting
12447 @cindex group mail splitting
12449 @findex gnus-group-split
12450 If you subscribe to dozens of mailing lists but you don't want to
12451 maintain mail splitting rules manually, group mail splitting is for you.
12452 You just have to set @var{to-list} and/or @var{to-address} in group
12453 parameters or group customization and set @code{nnmail-split-methods} to
12454 @code{gnus-group-split}. This splitting function will scan all groups
12455 for those parameters and split mail accordingly, i.e., messages posted
12456 from or to the addresses specified in the parameters @var{to-list} or
12457 @var{to-address} of a mail group will be stored in that group.
12459 Sometimes, mailing lists have multiple addresses, and you may want mail
12460 splitting to recognize them all: just set the @var{extra-aliases} group
12461 parameter to the list of additional addresses and it's done. If you'd
12462 rather use a regular expression, set @var{split-regexp}.
12464 All these parameters in a group will be used to create an
12465 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
12466 the @var{value} is a single regular expression that matches
12467 @var{to-list}, @var{to-address}, all of @var{extra-aliases} and all
12468 matches of @var{split-regexp}, and the @var{split} is the name of the
12469 group. @var{restrict}s are also supported: just set the
12470 @var{split-exclude} parameter to a list of regular expressions.
12472 If you can't get the right split to be generated using all these
12473 parameters, or you just need something fancier, you can set the
12474 parameter @var{split-spec} to an @code{nnmail-split-fancy} split. In
12475 this case, all other aforementioned parameters will be ignored by
12476 @code{gnus-group-split}. In particular, @var{split-spec} may be set to
12477 @code{nil}, in which case the group will be ignored by
12478 @code{gnus-group-split}.
12480 @vindex gnus-group-split-default-catch-all-group
12481 @code{gnus-group-split} will do cross-posting on all groups that match,
12482 by defining a single @code{&} fancy split containing one split for each
12483 group. If a message doesn't match any split, it will be stored in the
12484 group named in @code{gnus-group-split-default-catch-all-group}, unless
12485 some group has @var{split-spec} set to @code{catch-all}, in which case
12486 that group is used as the catch-all group. Even though this variable is
12487 often used just to name a group, it may also be set to an arbitrarily
12488 complex fancy split (after all, a group name is a fancy split), and this
12489 may be useful to split mail that doesn't go to any mailing list to
12490 personal mail folders. Note that this fancy split is added as the last
12491 element of a @code{|} split list that also contains a @code{&} split
12492 with the rules extracted from group parameters.
12494 It's time for an example. Assume the following group parameters have
12499 ((to-address . "bar@@femail.com")
12500 (split-regexp . ".*@@femail\\.com"))
12502 ((to-list . "foo@@nowhere.gov")
12503 (extra-aliases "foo@@localhost" "foo-redist@@home")
12504 (split-exclude "bugs-foo" "rambling-foo")
12505 (admin-address . "foo-request@@nowhere.gov"))
12507 ((split-spec . catch-all))
12510 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
12511 behave as if @code{nnmail-split-fancy} had been selected and variable
12512 @code{nnmail-split-fancy} had been set as follows:
12515 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
12516 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
12517 - "bugs-foo" - "rambling-foo" "mail.foo"))
12521 @findex gnus-group-split-fancy
12522 If you'd rather not use group splitting for all your mail groups, you
12523 may use it for only some of them, by using @code{nnmail-split-fancy}
12527 (: gnus-mlsplt-fancy GROUPS NO-CROSSPOST CATCH-ALL)
12530 @var{groups} may be a regular expression or a list of group names whose
12531 parameters will be scanned to generate the output split.
12532 @var{no-crosspost} can be used to disable cross-posting; in this case, a
12533 single @code{|} split will be output. @var{catch-all} is the fallback
12534 fancy split, used like @var{gnus-group-split-default-catch-all-group}.
12535 If @var{catch-all} is @code{nil}, or if @var{split-regexp} matches the
12536 empty string in any selected group, no catch-all split will be issued.
12537 Otherwise, if some group has @var{split-spec} set to @code{catch-all},
12538 this group will override the value of the @var{catch-all} argument.
12540 @findex gnus-group-split-setup
12541 Unfortunately, scanning all groups and their parameters can be quite
12542 slow, especially considering that it has to be done for every message.
12543 But don't despair! The function @code{gnus-group-split-setup} can be
12544 used to enable @code{gnus-group-split} in a much more efficient way. It
12545 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
12546 @code{nnmail-split-fancy} to the split produced by
12547 @code{gnus-group-split-fancy}. Thus, the group parameters are only
12548 scanned once, no matter how many messages are split.
12550 @findex gnus-group-split-update
12551 However, if you change group parameters, you'd have to update
12552 @code{nnmail-split-fancy} manually. You can do it by running
12553 @code{gnus-group-split-update}. If you'd rather have it updated
12554 automatically, just tell @code{gnus-group-split-setup} to do it for
12555 you. For example, add to your @file{.gnus}:
12558 (gnus-group-split-setup AUTO-UPDATE CATCH-ALL)
12561 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
12562 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
12563 have to worry about updating @code{nnmail-split-fancy} again. If you
12564 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
12565 @code{gnus-group-split-default-catch-all-group} will be set to its
12568 @vindex gnus-group-split-updated-hook
12569 Because you may want to change @code{nnmail-split-fancy} after it is set
12570 by @code{gnus-group-split-update}, this function will run
12571 @code{gnus-group-split-updated-hook} just before finishing.
12573 @node Incorporating Old Mail
12574 @subsection Incorporating Old Mail
12575 @cindex incorporating old mail
12576 @cindex import old mail
12578 Most people have lots of old mail stored in various file formats. If
12579 you have set up Gnus to read mail using one of the spiffy Gnus mail
12580 backends, you'll probably wish to have that old mail incorporated into
12583 Doing so can be quite easy.
12585 To take an example: You're reading mail using @code{nnml}
12586 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
12587 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
12588 file filled with important, but old, mail. You want to move it into
12589 your @code{nnml} groups.
12595 Go to the group buffer.
12598 Type `G f' and give the path to the mbox file when prompted to create an
12599 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
12602 Type `SPACE' to enter the newly created group.
12605 Type `M P b' to process-mark all articles in this group's buffer
12606 (@pxref{Setting Process Marks}).
12609 Type `B r' to respool all the process-marked articles, and answer
12610 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
12613 All the mail messages in the mbox file will now also be spread out over
12614 all your @code{nnml} groups. Try entering them and check whether things
12615 have gone without a glitch. If things look ok, you may consider
12616 deleting the mbox file, but I wouldn't do that unless I was absolutely
12617 sure that all the mail has ended up where it should be.
12619 Respooling is also a handy thing to do if you're switching from one mail
12620 backend to another. Just respool all the mail in the old mail groups
12621 using the new mail backend.
12624 @node Expiring Mail
12625 @subsection Expiring Mail
12626 @cindex article expiry
12628 Traditional mail readers have a tendency to remove mail articles when
12629 you mark them as read, in some way. Gnus takes a fundamentally
12630 different approach to mail reading.
12632 Gnus basically considers mail just to be news that has been received in
12633 a rather peculiar manner. It does not think that it has the power to
12634 actually change the mail, or delete any mail messages. If you enter a
12635 mail group, and mark articles as ``read'', or kill them in some other
12636 fashion, the mail articles will still exist on the system. I repeat:
12637 Gnus will not delete your old, read mail. Unless you ask it to, of
12640 To make Gnus get rid of your unwanted mail, you have to mark the
12641 articles as @dfn{expirable}. This does not mean that the articles will
12642 disappear right away, however. In general, a mail article will be
12643 deleted from your system if, 1) it is marked as expirable, AND 2) it is
12644 more than one week old. If you do not mark an article as expirable, it
12645 will remain on your system until hell freezes over. This bears
12646 repeating one more time, with some spurious capitalizations: IF you do
12647 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
12649 @vindex gnus-auto-expirable-newsgroups
12650 You do not have to mark articles as expirable by hand. Groups that
12651 match the regular expression @code{gnus-auto-expirable-newsgroups} will
12652 have all articles that you read marked as expirable automatically. All
12653 articles marked as expirable have an @samp{E} in the first
12654 column in the summary buffer.
12656 By default, if you have auto expiry switched on, Gnus will mark all the
12657 articles you read as expirable, no matter if they were read or unread
12658 before. To avoid having articles marked as read marked as expirable
12659 automatically, you can put something like the following in your
12662 @vindex gnus-mark-article-hook
12664 (remove-hook 'gnus-mark-article-hook
12665 'gnus-summary-mark-read-and-unread-as-read)
12666 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
12669 Note that making a group auto-expirable doesn't mean that all read
12670 articles are expired---only the articles marked as expirable
12671 will be expired. Also note that using the @kbd{d} command won't make
12672 articles expirable---only semi-automatic marking of articles as read will
12673 mark the articles as expirable in auto-expirable groups.
12675 Let's say you subscribe to a couple of mailing lists, and you want the
12676 articles you have read to disappear after a while:
12679 (setq gnus-auto-expirable-newsgroups
12680 "mail.nonsense-list\\|mail.nice-list")
12683 Another way to have auto-expiry happen is to have the element
12684 @code{auto-expire} in the group parameters of the group.
12686 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
12687 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
12688 don't really mix very well.
12690 @vindex nnmail-expiry-wait
12691 The @code{nnmail-expiry-wait} variable supplies the default time an
12692 expirable article has to live. Gnus starts counting days from when the
12693 message @emph{arrived}, not from when it was sent. The default is seven
12696 Gnus also supplies a function that lets you fine-tune how long articles
12697 are to live, based on what group they are in. Let's say you want to
12698 have one month expiry period in the @samp{mail.private} group, a one day
12699 expiry period in the @samp{mail.junk} group, and a six day expiry period
12702 @vindex nnmail-expiry-wait-function
12704 (setq nnmail-expiry-wait-function
12706 (cond ((string= group "mail.private")
12708 ((string= group "mail.junk")
12710 ((string= group "important")
12716 The group names this function is fed are ``unadorned'' group
12717 names---no @samp{nnml:} prefixes and the like.
12719 The @code{nnmail-expiry-wait} variable and
12720 @code{nnmail-expiry-wait-function} function can either be a number (not
12721 necessarily an integer) or one of the symbols @code{immediate} or
12724 You can also use the @code{expiry-wait} group parameter to selectively
12725 change the expiry period (@pxref{Group Parameters}).
12727 @vindex nnmail-expiry-target
12728 The normal action taken when expiring articles is to delete them.
12729 However, in some circumstances it might make more sense to move them to
12730 other groups instead of deleting them. The variable @code{nnmail-expiry-target}
12731 (and the @code{expiry-target} group parameter) controls this. The
12732 variable supplies a default value for all groups, which can be
12733 overridden for specific groups by the group parameter.
12734 default value is @code{delete}, but this can also be a string (which
12735 should be the name of the group the message should be moved to), or a
12736 function (which will be called in a buffer narrowed to the message in
12737 question, and with the name of the group being moved from as its
12738 parameter) which should return a target -- either a group name or
12741 Here's an example for specifying a group name:
12743 (setq nnmail-expiry-target "nnml:expired")
12747 @vindex nnmail-keep-last-article
12748 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
12749 expire the final article in a mail newsgroup. This is to make life
12750 easier for procmail users.
12752 @vindex gnus-total-expirable-newsgroups
12753 By the way: That line up there, about Gnus never expiring non-expirable
12754 articles, is a lie. If you put @code{total-expire} in the group
12755 parameters, articles will not be marked as expirable, but all read
12756 articles will be put through the expiry process. Use with extreme
12757 caution. Even more dangerous is the
12758 @code{gnus-total-expirable-newsgroups} variable. All groups that match
12759 this regexp will have all read articles put through the expiry process,
12760 which means that @emph{all} old mail articles in the groups in question
12761 will be deleted after a while. Use with extreme caution, and don't come
12762 crying to me when you discover that the regexp you used matched the
12763 wrong group and all your important mail has disappeared. Be a
12764 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
12767 Most people make most of their mail groups total-expirable, though.
12769 @vindex gnus-inhibit-user-auto-expire
12770 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
12771 commands will not mark an article as expirable, even if the group has
12772 auto-expire turned on.
12776 @subsection Washing Mail
12777 @cindex mail washing
12778 @cindex list server brain damage
12779 @cindex incoming mail treatment
12781 Mailers and list servers are notorious for doing all sorts of really,
12782 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
12783 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
12784 end of all lines passing through our server, so let's do that!!!!1!''
12785 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
12786 considered to be self-evident were not discussed. So. Here we are.
12788 Case in point: The German version of Microsoft Exchange adds @samp{AW:
12789 } to the subjects of replies instead of @samp{Re: }. I could pretend to
12790 be shocked and dismayed by this, but I haven't got the energy. It is to
12793 Gnus provides a plethora of functions for washing articles while
12794 displaying them, but it might be nicer to do the filtering before
12795 storing the mail to disc. For that purpose, we have three hooks and
12796 various functions that can be put in these hooks.
12799 @item nnmail-prepare-incoming-hook
12800 @vindex nnmail-prepare-incoming-hook
12801 This hook is called before doing anything with the mail and is meant for
12802 grand, sweeping gestures. It is called in a buffer that contains all
12803 the new, incoming mail. Functions to be used include:
12806 @item nnheader-ms-strip-cr
12807 @findex nnheader-ms-strip-cr
12808 Remove trailing carriage returns from each line. This is default on
12809 Emacs running on MS machines.
12813 @item nnmail-prepare-incoming-header-hook
12814 @vindex nnmail-prepare-incoming-header-hook
12815 This hook is called narrowed to each header. It can be used when
12816 cleaning up the headers. Functions that can be used include:
12819 @item nnmail-remove-leading-whitespace
12820 @findex nnmail-remove-leading-whitespace
12821 Clear leading white space that ``helpful'' listservs have added to the
12822 headers to make them look nice. Aaah.
12824 @item nnmail-remove-list-identifiers
12825 @findex nnmail-remove-list-identifiers
12826 Some list servers add an identifier---for example, @samp{(idm)}---to the
12827 beginning of all @code{Subject} headers. I'm sure that's nice for
12828 people who use stone age mail readers. This function will remove
12829 strings that match the @code{nnmail-list-identifiers} regexp, which can
12830 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
12833 For instance, if you want to remove the @samp{(idm)} and the
12834 @samp{nagnagnag} identifiers:
12837 (setq nnmail-list-identifiers
12838 '("(idm)" "nagnagnag"))
12841 This can also be done non-destructively with
12842 @code{gnus-list-identifiers}, @xref{Article Hiding}.
12844 @item nnmail-remove-tabs
12845 @findex nnmail-remove-tabs
12846 Translate all @samp{TAB} characters into @samp{SPACE} characters.
12848 @item nnmail-fix-eudora-headers
12849 @findex nnmail-fix-eudora-headers
12851 Eudora produces broken @code{References} headers, but OK
12852 @code{In-Reply-To} headers. This function will get rid of the
12853 @code{References} headers.
12857 @item nnmail-prepare-incoming-message-hook
12858 @vindex nnmail-prepare-incoming-message-hook
12859 This hook is called narrowed to each message. Functions to be used
12863 @item article-de-quoted-unreadable
12864 @findex article-de-quoted-unreadable
12865 Decode Quoted Readable encoding.
12872 @subsection Duplicates
12874 @vindex nnmail-treat-duplicates
12875 @vindex nnmail-message-id-cache-length
12876 @vindex nnmail-message-id-cache-file
12877 @cindex duplicate mails
12878 If you are a member of a couple of mailing lists, you will sometimes
12879 receive two copies of the same mail. This can be quite annoying, so
12880 @code{nnmail} checks for and treats any duplicates it might find. To do
12881 this, it keeps a cache of old @code{Message-ID}s---
12882 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
12883 default. The approximate maximum number of @code{Message-ID}s stored
12884 there is controlled by the @code{nnmail-message-id-cache-length}
12885 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
12886 stored.) If all this sounds scary to you, you can set
12887 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
12888 default), and @code{nnmail} won't delete duplicate mails. Instead it
12889 will insert a warning into the head of the mail saying that it thinks
12890 that this is a duplicate of a different message.
12892 This variable can also be a function. If that's the case, the function
12893 will be called from a buffer narrowed to the message in question with
12894 the @code{Message-ID} as a parameter. The function must return either
12895 @code{nil}, @code{warn}, or @code{delete}.
12897 You can turn this feature off completely by setting the variable to
12900 If you want all the duplicate mails to be put into a special
12901 @dfn{duplicates} group, you could do that using the normal mail split
12905 (setq nnmail-split-fancy
12906 '(| ;; Messages duplicates go to a separate group.
12907 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
12908 ;; Message from daemons, postmaster, and the like to another.
12909 (any mail "mail.misc")
12916 (setq nnmail-split-methods
12917 '(("duplicates" "^Gnus-Warning:.*duplicate")
12922 Here's a neat feature: If you know that the recipient reads her mail
12923 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
12924 @code{delete}, you can send her as many insults as you like, just by
12925 using a @code{Message-ID} of a mail that you know that she's already
12926 received. Think of all the fun! She'll never see any of it! Whee!
12929 @node Not Reading Mail
12930 @subsection Not Reading Mail
12932 If you start using any of the mail backends, they have the annoying
12933 habit of assuming that you want to read mail with them. This might not
12934 be unreasonable, but it might not be what you want.
12936 If you set @code{mail-sources} and @code{nnmail-spool-file} to
12937 @code{nil}, none of the backends will ever attempt to read incoming
12938 mail, which should help.
12940 @vindex nnbabyl-get-new-mail
12941 @vindex nnmbox-get-new-mail
12942 @vindex nnml-get-new-mail
12943 @vindex nnmh-get-new-mail
12944 @vindex nnfolder-get-new-mail
12945 This might be too much, if, for instance, you are reading mail quite
12946 happily with @code{nnml} and just want to peek at some old @sc{rmail}
12947 file you have stashed away with @code{nnbabyl}. All backends have
12948 variables called backend-@code{get-new-mail}. If you want to disable
12949 the @code{nnbabyl} mail reading, you edit the virtual server for the
12950 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
12952 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
12953 narrowed to the article to be saved before saving it when reading
12957 @node Choosing a Mail Backend
12958 @subsection Choosing a Mail Backend
12960 Gnus will read the mail spool when you activate a mail group. The mail
12961 file is first copied to your home directory. What happens after that
12962 depends on what format you want to store your mail in.
12964 There are five different mail backends in the standard Gnus, and more
12965 backends are available separately. The mail backend most people use
12966 (because it is the fastest and most flexible) is @code{nnml}
12967 (@pxref{Mail Spool}).
12970 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
12971 * Rmail Babyl:: Emacs programs use the rmail babyl format.
12972 * Mail Spool:: Store your mail in a private spool?
12973 * MH Spool:: An mhspool-like backend.
12974 * Mail Folders:: Having one file for each group.
12975 * Comparing Mail Backends:: An in-depth looks at pros and cons.
12979 @node Unix Mail Box
12980 @subsubsection Unix Mail Box
12982 @cindex unix mail box
12984 @vindex nnmbox-active-file
12985 @vindex nnmbox-mbox-file
12986 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
12987 mail. @code{nnmbox} will add extra headers to each mail article to say
12988 which group it belongs in.
12990 Virtual server settings:
12993 @item nnmbox-mbox-file
12994 @vindex nnmbox-mbox-file
12995 The name of the mail box in the user's home directory. Default is
12998 @item nnmbox-active-file
12999 @vindex nnmbox-active-file
13000 The name of the active file for the mail box. Default is
13001 @file{~/.mbox-active}.
13003 @item nnmbox-get-new-mail
13004 @vindex nnmbox-get-new-mail
13005 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
13006 into groups. Default is @code{t}.
13011 @subsubsection Rmail Babyl
13015 @vindex nnbabyl-active-file
13016 @vindex nnbabyl-mbox-file
13017 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
13018 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
13019 mail article to say which group it belongs in.
13021 Virtual server settings:
13024 @item nnbabyl-mbox-file
13025 @vindex nnbabyl-mbox-file
13026 The name of the rmail mbox file. The default is @file{~/RMAIL}
13028 @item nnbabyl-active-file
13029 @vindex nnbabyl-active-file
13030 The name of the active file for the rmail box. The default is
13031 @file{~/.rmail-active}
13033 @item nnbabyl-get-new-mail
13034 @vindex nnbabyl-get-new-mail
13035 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
13041 @subsubsection Mail Spool
13043 @cindex mail @sc{nov} spool
13045 The @dfn{nnml} spool mail format isn't compatible with any other known
13046 format. It should be used with some caution.
13048 @vindex nnml-directory
13049 If you use this backend, Gnus will split all incoming mail into files,
13050 one file for each mail, and put the articles into the corresponding
13051 directories under the directory specified by the @code{nnml-directory}
13052 variable. The default value is @file{~/Mail/}.
13054 You do not have to create any directories beforehand; Gnus will take
13057 If you have a strict limit as to how many files you are allowed to store
13058 in your account, you should not use this backend. As each mail gets its
13059 own file, you might very well occupy thousands of inodes within a few
13060 weeks. If this is no problem for you, and it isn't a problem for you
13061 having your friendly systems administrator walking around, madly,
13062 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
13063 know that this is probably the fastest format to use. You do not have
13064 to trudge through a big mbox file just to read your new mail.
13066 @code{nnml} is probably the slowest backend when it comes to article
13067 splitting. It has to create lots of files, and it also generates
13068 @sc{nov} databases for the incoming mails. This makes it the fastest
13069 backend when it comes to reading mail.
13071 @cindex self contained nnml servers
13072 When the marks file is used (which it is by default), @code{nnml}
13073 servers have the property that you may backup them using @code{tar} or
13074 similar, and later be able to restore them into Gnus (by adding the
13075 proper @code{nnml} server) and have all your marks be preserved. Marks
13076 for a group is usually stored in the @code{.marks} file (but see
13077 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
13078 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
13079 to restore the group (after restoring the backup into the nnml
13082 Virtual server settings:
13085 @item nnml-directory
13086 @vindex nnml-directory
13087 All @code{nnml} directories will be placed under this directory.
13088 The default is the value of `message-directory' (whose default value is
13091 @item nnml-active-file
13092 @vindex nnml-active-file
13093 The active file for the @code{nnml} server. The default is
13094 @file{~/Mail/active"}.
13096 @item nnml-newsgroups-file
13097 @vindex nnml-newsgroups-file
13098 The @code{nnml} group descriptions file. @xref{Newsgroups File
13099 Format}. The default is @file{~/Mail/newsgroups"}.
13101 @item nnml-get-new-mail
13102 @vindex nnml-get-new-mail
13103 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
13106 @item nnml-nov-is-evil
13107 @vindex nnml-nov-is-evil
13108 If non-@code{nil}, this backend will ignore any @sc{nov} files. The
13109 default is @code{nil}.
13111 @item nnml-nov-file-name
13112 @vindex nnml-nov-file-name
13113 The name of the @sc{nov} files. The default is @file{.overview}.
13115 @item nnml-prepare-save-mail-hook
13116 @vindex nnml-prepare-save-mail-hook
13117 Hook run narrowed to an article before saving.
13119 @item nnml-marks-is-evil
13120 @vindex nnml-marks-is-evil
13121 If non-@code{nil}, this backend will ignore any @sc{marks} files. The
13122 default is @code{nil}.
13124 @item nnml-marks-file-name
13125 @vindex nnml-marks-file-name
13126 The name of the @sc{marks} files. The default is @file{.marks}.
13130 @findex nnml-generate-nov-databases
13131 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
13132 you can do a complete update by typing @kbd{M-x
13133 nnml-generate-nov-databases}. This command will trawl through the
13134 entire @code{nnml} hierarchy, looking at each and every article, so it
13135 might take a while to complete. A better interface to this
13136 functionality can be found in the server buffer (@pxref{Server
13141 @subsubsection MH Spool
13143 @cindex mh-e mail spool
13145 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
13146 @sc{nov} databases and it doesn't keep an active file or marks file.
13147 This makes @code{nnmh} a @emph{much} slower backend than @code{nnml},
13148 but it also makes it easier to write procmail scripts for.
13150 Virtual server settings:
13153 @item nnmh-directory
13154 @vindex nnmh-directory
13155 All @code{nnmh} directories will be located under this directory. The
13156 default is the value of @code{message-directory} (whose default is
13159 @item nnmh-get-new-mail
13160 @vindex nnmh-get-new-mail
13161 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
13165 @vindex nnmh-be-safe
13166 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
13167 sure that the articles in the folder are actually what Gnus thinks they
13168 are. It will check date stamps and stat everything in sight, so
13169 setting this to @code{t} will mean a serious slow-down. If you never
13170 use anything but Gnus to read the @code{nnmh} articles, you do not have
13171 to set this variable to @code{t}. The default is @code{nil}.
13176 @subsubsection Mail Folders
13178 @cindex mbox folders
13179 @cindex mail folders
13181 @code{nnfolder} is a backend for storing each mail group in a separate
13182 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
13183 will add extra headers to keep track of article numbers and arrival
13186 @cindex self contained nnfolder servers
13187 When the marks file is used (which it is by default), @code{nnfolder}
13188 servers have the property that you may backup them using @code{tar} or
13189 similar, and later be able to restore them into Gnus (by adding the
13190 proper @code{nnfolder} server) and have all your marks be preserved.
13191 Marks for a group is usually stored in a file named as the mbox file
13192 with @code{.mrk} concatenated to it (but see
13193 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder} directory.
13194 Individual @code{nnfolder} groups are also possible to backup, use
13195 @kbd{G m} to restore the group (after restoring the backup into the
13196 @code{nnfolder} directory).
13198 Virtual server settings:
13201 @item nnfolder-directory
13202 @vindex nnfolder-directory
13203 All the @code{nnfolder} mail boxes will be stored under this directory.
13204 The default is the value of @code{message-directory} (whose default is
13207 @item nnfolder-active-file
13208 @vindex nnfolder-active-file
13209 The name of the active file. The default is @file{~/Mail/active}.
13211 @item nnfolder-newsgroups-file
13212 @vindex nnfolder-newsgroups-file
13213 The name of the group descriptions file. @xref{Newsgroups File
13214 Format}. The default is @file{~/Mail/newsgroups"}
13216 @item nnfolder-get-new-mail
13217 @vindex nnfolder-get-new-mail
13218 If non-@code{nil}, @code{nnfolder} will read incoming mail. The default
13221 @item nnfolder-save-buffer-hook
13222 @vindex nnfolder-save-buffer-hook
13223 @cindex backup files
13224 Hook run before saving the folders. Note that Emacs does the normal
13225 backup renaming of files even with the @code{nnfolder} buffers. If you
13226 wish to switch this off, you could say something like the following in
13227 your @file{.emacs} file:
13230 (defun turn-off-backup ()
13231 (set (make-local-variable 'backup-inhibited) t))
13233 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
13236 @item nnfolder-delete-mail-hook
13237 @vindex nnfolder-delete-mail-hook
13238 Hook run in a buffer narrowed to the message that is to be deleted.
13239 This function can be used to copy the message to somewhere else, or to
13240 extract some information from it before removing it.
13242 @item nnfolder-nov-is-evil
13243 @vindex nnfolder-nov-is-evil
13244 If non-@code{nil}, this backend will ignore any @sc{nov} files. The
13245 default is @code{nil}.
13247 @item nnfolder-nov-file-suffix
13248 @vindex nnfolder-nov-file-suffix
13249 The extension for @sc{nov} files. The default is @file{.nov}.
13251 @item nnfolder-marks-is-evil
13252 @vindex nnfolder-marks-is-evil
13253 If non-@code{nil}, this backend will ignore any @sc{marks} files. The
13254 default is @code{nil}.
13256 @item nnfolder-marks-file-suffix
13257 @vindex nnfolder-marks-file-suffix
13258 The extension for @sc{marks} files. The default is @file{.mrk}.
13263 @findex nnfolder-generate-active-file
13264 @kindex M-x nnfolder-generate-active-file
13265 If you have lots of @code{nnfolder}-like files you'd like to read with
13266 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
13267 command to make @code{nnfolder} aware of all likely files in
13268 @code{nnfolder-directory}. This only works if you use long file names,
13271 @node Comparing Mail Backends
13272 @subsubsection Comparing Mail Backends
13274 First, just for terminology, the @dfn{backend} is the common word for a
13275 low-level access method---a transport, if you will, by which something
13276 is acquired. The sense is that one's mail has to come from somewhere,
13277 and so selection of a suitable backend is required in order to get that
13278 mail within spitting distance of Gnus.
13280 The same concept exists for Usenet itself: Though access to articles is
13281 typically done by @sc{nntp} these days, once upon a midnight dreary, everyone
13282 in the world got at Usenet by running a reader on the machine where the
13283 articles lay (the machine which today we call an @sc{nntp} server), and
13284 access was by the reader stepping into the articles' directory spool
13285 area directly. One can still select between either the @code{nntp} or
13286 @code{nnspool} backends, to select between these methods, if one happens
13287 actually to live on the server (or can see its spool directly, anyway,
13290 The goal in selecting a mail backend is to pick one which
13291 simultaneously represents a suitable way of dealing with the original
13292 format plus leaving mail in a form that is convenient to use in the
13293 future. Here are some high and low points on each:
13298 UNIX systems have historically had a single, very common, and well-
13299 defined format. All messages arrive in a single @dfn{spool file}, and
13300 they are delineated by a line whose regular expression matches
13301 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
13302 to make it clear in this instance that this is not the RFC-specified
13303 @samp{From:} header.) Because Emacs and therefore Gnus emanate
13304 historically from the Unix environment, it is simplest if one does not
13305 mess a great deal with the original mailbox format, so if one chooses
13306 this backend, Gnus' primary activity in getting mail from the real spool
13307 area to Gnus' preferred directory is simply to copy it, with no
13308 (appreciable) format change in the process. It is the ``dumbest'' way
13309 to move mail into availability in the Gnus environment. This makes it
13310 fast to move into place, but slow to parse, when Gnus has to look at
13315 Once upon a time, there was the DEC-10 and DEC-20, running operating
13316 systems called TOPS and related things, and the usual (only?) mail
13317 reading environment was a thing called Babyl. I don't know what format
13318 was used for mail landing on the system, but Babyl had its own internal
13319 format to which mail was converted, primarily involving creating a
13320 spool-file-like entity with a scheme for inserting Babyl-specific
13321 headers and status bits above the top of each message in the file.
13322 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
13323 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
13324 to understand the mail files folks already had in existence. Gnus (and
13325 VM, for that matter) continue to support this format because it's
13326 perceived as having some good qualities in those mailer-specific
13327 headers/status bits stuff. RMAIL itself still exists as well, of
13328 course, and is still maintained by Stallman.
13330 Both of the above forms leave your mail in a single file on your
13331 filesystem, and they must parse that entire file each time you take a
13336 @code{nnml} is the backend which smells the most as though you were
13337 actually operating with an @code{nnspool}-accessed Usenet system. (In
13338 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
13339 lo these years ago.) One's mail is taken from the original spool file,
13340 and is then cut up into individual message files, 1:1. It maintains a
13341 Usenet-style active file (analogous to what one finds in an INN- or
13342 CNews-based news system in (for instance) @file{/var/lib/news/active},
13343 or what is returned via the @samp{NNTP LIST} verb) and also creates
13344 @dfn{overview} files for efficient group entry, as has been defined for
13345 @sc{nntp} servers for some years now. It is slower in mail-splitting,
13346 due to the creation of lots of files, updates to the @code{nnml} active
13347 file, and additions to overview files on a per-message basis, but it is
13348 extremely fast on access because of what amounts to the indexing support
13349 provided by the active file and overviews.
13351 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
13352 resource which defines available places in the filesystem to put new
13353 files. Sysadmins take a dim view of heavy inode occupation within
13354 tight, shared filesystems. But if you live on a personal machine where
13355 the filesystem is your own and space is not at a premium, @code{nnml}
13358 It is also problematic using this backend if you are living in a
13359 FAT16-based Windows world, since much space will be wasted on all these
13364 The Rand MH mail-reading system has been around UNIX systems for a very
13365 long time; it operates by splitting one's spool file of messages into
13366 individual files, but with little or no indexing support -- @code{nnmh}
13367 is considered to be semantically equivalent to ``@code{nnml} without
13368 active file or overviews''. This is arguably the worst choice, because
13369 one gets the slowness of individual file creation married to the
13370 slowness of access parsing when learning what's new in one's groups.
13374 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
13375 method described above) on a per-group basis. That is, @code{nnmbox}
13376 itself puts *all* one's mail in one file; @code{nnfolder} provides a
13377 little bit of optimization to this so that each of one's mail groups has
13378 a Unix mail box file. It's faster than @code{nnmbox} because each group
13379 can be parsed separately, and still provides the simple Unix mail box
13380 format requiring minimal effort in moving the mail around. In addition,
13381 it maintains an ``active'' file making it much faster for Gnus to figure
13382 out how many messages there are in each separate group.
13384 If you have groups that are expected to have a massive amount of
13385 messages, @code{nnfolder} is not the best choice, but if you receive
13386 only a moderate amount of mail, @code{nnfolder} is probably the most
13387 friendly mail backend all over.
13392 @node Browsing the Web
13393 @section Browsing the Web
13395 @cindex browsing the web
13399 Web-based discussion forums are getting more and more popular. On many
13400 subjects, the web-based forums have become the most important forums,
13401 eclipsing the importance of mailing lists and news groups. The reason
13402 is easy to understand---they are friendly to new users; you just point
13403 and click, and there's the discussion. With mailing lists, you have to
13404 go through a cumbersome subscription procedure, and most people don't
13405 even know what a news group is.
13407 The problem with this scenario is that web browsers are not very good at
13408 being newsreaders. They do not keep track of what articles you've read;
13409 they do not allow you to score on subjects you're interested in; they do
13410 not allow off-line browsing; they require you to click around and drive
13411 you mad in the end.
13413 So---if web browsers suck at reading discussion forums, why not use Gnus
13416 Gnus has been getting a bit of a collection of backends for providing
13417 interfaces to these sources.
13420 * Web Searches:: Creating groups from articles that match a string.
13421 * Slashdot:: Reading the Slashdot comments.
13422 * Ultimate:: The Ultimate Bulletin Board systems.
13423 * Web Archive:: Reading mailing list archived on web.
13424 * RSS:: Reading RDF site summary.
13425 * Customizing w3:: Doing stuff to Emacs/w3 from Gnus.
13428 All the web sources require Emacs/w3 and the url library to work.
13430 The main caveat with all these web sources is that they probably won't
13431 work for a very long time. Gleaning information from the @sc{html} data
13432 is guesswork at best, and when the layout is altered, the Gnus backend
13433 will fail. If you have reasonably new versions of these backends,
13434 though, you should be ok.
13436 One thing all these Web methods have in common is that the Web sources
13437 are often down, unavailable or just plain too slow to be fun. In those
13438 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
13439 Unplugged}) handle downloading articles, and then you can read them at
13440 leisure from your local disk. No more World Wide Wait for you.
13444 @subsection Web Searches
13448 @cindex InReference
13449 @cindex Usenet searches
13450 @cindex searching the Usenet
13452 It's, like, too neat to search the Usenet for articles that match a
13453 string, but it, like, totally @emph{sucks}, like, totally, to use one of
13454 those, like, Web browsers, and you, like, have to, rilly, like, look at
13455 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
13456 searches without having to use a browser.
13458 The @code{nnweb} backend allows an easy interface to the mighty search
13459 engine. You create an @code{nnweb} group, enter a search pattern, and
13460 then enter the group and read the articles like you would any normal
13461 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
13462 Groups}) will do this in an easy-to-use fashion.
13464 @code{nnweb} groups don't really lend themselves to being solid
13465 groups---they have a very fleeting idea of article numbers. In fact,
13466 each time you enter an @code{nnweb} group (not even changing the search
13467 pattern), you are likely to get the articles ordered in a different
13468 manner. Not even using duplicate suppression (@pxref{Duplicate
13469 Suppression}) will help, since @code{nnweb} doesn't even know the
13470 @code{Message-ID} of the articles before reading them using some search
13471 engines (DejaNews, for instance). The only possible way to keep track
13472 of which articles you've read is by scoring on the @code{Date}
13473 header---mark all articles posted before the last date you read the
13476 If the search engine changes its output substantially, @code{nnweb}
13477 won't be able to parse it and will fail. One could hardly fault the Web
13478 providers if they were to do this---their @emph{raison d'être} is to
13479 make money off of advertisements, not to provide services to the
13480 community. Since @code{nnweb} washes the ads off all the articles, one
13481 might think that the providers might be somewhat miffed. We'll see.
13483 You must have the @code{url} and @code{w3} package installed to be able
13484 to use @code{nnweb}.
13486 Virtual server variables:
13491 What search engine type is being used. The currently supported types
13492 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
13496 @vindex nnweb-search
13497 The search string to feed to the search engine.
13499 @item nnweb-max-hits
13500 @vindex nnweb-max-hits
13501 Advisory maximum number of hits per search to display. The default is
13504 @item nnweb-type-definition
13505 @vindex nnweb-type-definition
13506 Type-to-definition alist. This alist says what @code{nnweb} should do
13507 with the various search engine types. The following elements must be
13512 Function to decode the article and provide something that Gnus
13516 Function to create an article number to message header and URL alist.
13519 Function to send the search string to the search engine.
13522 The address the aforementioned function should send the search string
13526 Format string URL to fetch an article by @code{Message-ID}.
13533 @subsection Slashdot
13537 Slashdot (@uref{http://slashdot.org/}) is a popular news site, with
13538 lively discussion following the news articles. @code{nnslashdot} will
13539 let you read this forum in a convenient manner.
13541 The easiest way to read this source is to put something like the
13542 following in your @file{.gnus.el} file:
13545 (setq gnus-secondary-select-methods
13546 '((nnslashdot "")))
13549 This will make Gnus query the @code{nnslashdot} backend for new comments
13550 and groups. The @kbd{F} command will subscribe each new news article as
13551 a new Gnus group, and you can read the comments by entering these
13552 groups. (Note that the default subscription method is to subscribe new
13553 groups as zombies. Other methods are available (@pxref{Subscription
13556 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
13557 command is the most handy tool (@pxref{Foreign Groups}).
13559 When following up to @code{nnslashdot} comments (or posting new
13560 comments), some light @sc{html}izations will be performed. In
13561 particular, text quoted with @samp{> } will be quoted with
13562 @code{blockquote} instead, and signatures will have @code{br} added to
13563 the end of each line. Other than that, you can just write @sc{html}
13564 directly into the message buffer. Note that Slashdot filters out some
13567 The following variables can be altered to change its behavior:
13570 @item nnslashdot-threaded
13571 Whether @code{nnslashdot} should display threaded groups or not. The
13572 default is @code{t}. To be able to display threads, @code{nnslashdot}
13573 has to retrieve absolutely all comments in a group upon entry. If a
13574 threaded display is not required, @code{nnslashdot} will only retrieve
13575 the comments that are actually wanted by the user. Threading is nicer,
13576 but much, much slower than untreaded.
13578 @item nnslashdot-login-name
13579 @vindex nnslashdot-login-name
13580 The login name to use when posting.
13582 @item nnslashdot-password
13583 @vindex nnslashdot-password
13584 The password to use when posting.
13586 @item nnslashdot-directory
13587 @vindex nnslashdot-directory
13588 Where @code{nnslashdot} will store its files. The default is
13589 @samp{~/News/slashdot/}.
13591 @item nnslashdot-active-url
13592 @vindex nnslashdot-active-url
13593 The @sc{url} format string that will be used to fetch the information on
13594 news articles and comments. The default is
13595 @samp{http://slashdot.org/search.pl?section=&min=%d}.
13597 @item nnslashdot-comments-url
13598 @vindex nnslashdot-comments-url
13599 The @sc{url} format string that will be used to fetch comments. The
13601 @samp{http://slashdot.org/comments.pl?sid=%s&threshold=%d&commentsort=%d&mode=flat&startat=%d}.
13603 @item nnslashdot-article-url
13604 @vindex nnslashdot-article-url
13605 The @sc{url} format string that will be used to fetch the news article. The
13607 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
13609 @item nnslashdot-threshold
13610 @vindex nnslashdot-threshold
13611 The score threshold. The default is -1.
13613 @item nnslashdot-group-number
13614 @vindex nnslashdot-group-number
13615 The number of old groups, in addition to the ten latest, to keep
13616 updated. The default is 0.
13623 @subsection Ultimate
13625 @cindex Ultimate Bulletin Board
13627 The Ultimate Bulletin Board (@uref{http://www.ultimatebb.com/}) is
13628 probably the most popular Web bulletin board system used. It has a
13629 quite regular and nice interface, and it's possible to get the
13630 information Gnus needs to keep groups updated.
13632 The easiest way to get started with @code{nnultimate} is to say
13633 something like the following in the group buffer: @kbd{B nnultimate RET
13634 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @sc{url}
13635 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
13636 you're interested in; there's quite a list of them on the Ultimate web
13637 site.) Then subscribe to the groups you're interested in from the
13638 server buffer, and read them from the group buffer.
13640 The following @code{nnultimate} variables can be altered:
13643 @item nnultimate-directory
13644 @vindex nnultimate-directory
13645 The directory where @code{nnultimate} stores its files. The default is
13646 @samp{~/News/ultimate/}.
13651 @subsection Web Archive
13653 @cindex Web Archive
13655 Some mailing lists only have archives on Web servers, such as
13656 @uref{http://www.egroups.com/} and
13657 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
13658 interface, and it's possible to get the information Gnus needs to keep
13661 The easiest way to get started with @code{nnwarchive} is to say
13662 something like the following in the group buffer: @kbd{M-x
13663 gnus-group-make-warchive-group RET an_egroup RET egroups RET
13664 www.egroups.com RET your@@email.address RET}. (Substitute the
13665 @sc{an_egroup} with the mailing list you subscribed, the
13666 @sc{your@@email.address} with your email address.), or to browse the
13667 backend by @kbd{B nnwarchive RET mail-archive RET}.
13669 The following @code{nnwarchive} variables can be altered:
13672 @item nnwarchive-directory
13673 @vindex nnwarchive-directory
13674 The directory where @code{nnwarchive} stores its files. The default is
13675 @samp{~/News/warchive/}.
13677 @item nnwarchive-login
13678 @vindex nnwarchive-login
13679 The account name on the web server.
13681 @item nnwarchive-passwd
13682 @vindex nnwarchive-passwd
13683 The password for your account on the web server.
13691 Some sites have RDF site summary (RSS)
13692 @uref{http://purl.org/rss/1.0/spec}. It has a quite regular and nice
13693 interface, and it's possible to get the information Gnus needs to keep
13696 The easiest way to get started with @code{nnrss} is to say something
13697 like the following in the group buffer: @kbd{B nnrss RET RET}, then
13700 The following @code{nnrss} variables can be altered:
13703 @item nnrss-directory
13704 @vindex nnrss-directory
13705 The directory where @code{nnrss} stores its files. The default is
13706 @samp{~/News/rss/}.
13710 The following code may be helpful, if you want to show the description in
13711 the summary buffer.
13714 (add-to-list 'nnmail-extra-headers nnrss-description-field)
13715 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
13717 (defun gnus-user-format-function-X (header)
13719 (assq nnrss-description-field (mail-header-extra header))))
13720 (if descr (concat "\n\t" (cdr descr)) "")))
13723 The following code may be useful to open an nnrss url directly from the
13726 (require 'browse-url)
13728 (defun browse-nnrss-url( arg )
13730 (let ((url (assq nnrss-url-field
13733 (assq (gnus-summary-article-number)
13734 gnus-newsgroup-data))))))
13736 (browse-url (cdr url))
13737 (gnus-summary-scroll-up arg))))
13739 (eval-after-load "gnus"
13740 #'(define-key gnus-summary-mode-map
13741 (kbd "<RET>") 'browse-nnrss-url))
13742 (add-to-list 'nnmail-extra-headers nnrss-url-field)
13745 @node Customizing w3
13746 @subsection Customizing w3
13752 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
13753 pages. Emacs/w3 is documented in its own manual, but there are some
13754 things that may be more relevant for Gnus users.
13756 For instance, a common question is how to make Emacs/w3 follow links
13757 using the @code{browse-url} functions (which will call some external web
13758 browser like Netscape). Here's one way:
13761 (eval-after-load "w3"
13763 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
13764 (defun w3-fetch (&optional url target)
13765 (interactive (list (w3-read-url-with-default)))
13766 (if (eq major-mode 'gnus-article-mode)
13768 (w3-fetch-orig url target)))))
13771 Put that in your @file{.emacs} file, and hitting links in w3-rendered
13772 @sc{html} in the Gnus article buffers will use @code{browse-url} to
13776 @node Other Sources
13777 @section Other Sources
13779 Gnus can do more than just read news or mail. The methods described
13780 below allow Gnus to view directories and files as if they were
13784 * Directory Groups:: You can read a directory as if it was a newsgroup.
13785 * Anything Groups:: Dired? Who needs dired?
13786 * Document Groups:: Single files can be the basis of a group.
13787 * SOUP:: Reading @sc{soup} packets ``offline''.
13788 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
13789 * IMAP:: Using Gnus as a @sc{imap} client.
13793 @node Directory Groups
13794 @subsection Directory Groups
13796 @cindex directory groups
13798 If you have a directory that has lots of articles in separate files in
13799 it, you might treat it as a newsgroup. The files have to have numerical
13802 This might be an opportune moment to mention @code{ange-ftp} (and its
13803 successor @code{efs}), that most wonderful of all wonderful Emacs
13804 packages. When I wrote @code{nndir}, I didn't think much about it---a
13805 backend to read directories. Big deal.
13807 @code{ange-ftp} changes that picture dramatically. For instance, if you
13808 enter the @code{ange-ftp} file name
13809 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
13810 @code{ange-ftp} or @code{efs} will actually allow you to read this
13811 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
13813 @code{nndir} will use @sc{nov} files if they are present.
13815 @code{nndir} is a ``read-only'' backend---you can't delete or expire
13816 articles with this method. You can use @code{nnmh} or @code{nnml} for
13817 whatever you use @code{nndir} for, so you could switch to any of those
13818 methods if you feel the need to have a non-read-only @code{nndir}.
13821 @node Anything Groups
13822 @subsection Anything Groups
13825 From the @code{nndir} backend (which reads a single spool-like
13826 directory), it's just a hop and a skip to @code{nneething}, which
13827 pretends that any arbitrary directory is a newsgroup. Strange, but
13830 When @code{nneething} is presented with a directory, it will scan this
13831 directory and assign article numbers to each file. When you enter such
13832 a group, @code{nneething} must create ``headers'' that Gnus can use.
13833 After all, Gnus is a newsreader, in case you're forgetting.
13834 @code{nneething} does this in a two-step process. First, it snoops each
13835 file in question. If the file looks like an article (i.e., the first
13836 few lines look like headers), it will use this as the head. If this is
13837 just some arbitrary file without a head (e.g. a C source file),
13838 @code{nneething} will cobble up a header out of thin air. It will use
13839 file ownership, name and date and do whatever it can with these
13842 All this should happen automatically for you, and you will be presented
13843 with something that looks very much like a newsgroup. Totally like a
13844 newsgroup, to be precise. If you select an article, it will be displayed
13845 in the article buffer, just as usual.
13847 If you select a line that represents a directory, Gnus will pop you into
13848 a new summary buffer for this @code{nneething} group. And so on. You can
13849 traverse the entire disk this way, if you feel like, but remember that
13850 Gnus is not dired, really, and does not intend to be, either.
13852 There are two overall modes to this action---ephemeral or solid. When
13853 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
13854 will not store information on what files you have read, and what files
13855 are new, and so on. If you create a solid @code{nneething} group the
13856 normal way with @kbd{G m}, Gnus will store a mapping table between
13857 article numbers and file names, and you can treat this group like any
13858 other groups. When you activate a solid @code{nneething} group, you will
13859 be told how many unread articles it contains, etc., etc.
13864 @item nneething-map-file-directory
13865 @vindex nneething-map-file-directory
13866 All the mapping files for solid @code{nneething} groups will be stored
13867 in this directory, which defaults to @file{~/.nneething/}.
13869 @item nneething-exclude-files
13870 @vindex nneething-exclude-files
13871 All files that match this regexp will be ignored. Nice to use to exclude
13872 auto-save files and the like, which is what it does by default.
13874 @item nneething-include-files
13875 @vindex nneething-include-files
13876 Regexp saying what files to include in the group. If this variable is
13877 non-@code{nil}, only files matching this regexp will be included.
13879 @item nneething-map-file
13880 @vindex nneething-map-file
13881 Name of the map files.
13885 @node Document Groups
13886 @subsection Document Groups
13888 @cindex documentation group
13891 @code{nndoc} is a cute little thing that will let you read a single file
13892 as a newsgroup. Several files types are supported:
13899 The babyl (rmail) mail box.
13904 The standard Unix mbox file.
13906 @cindex MMDF mail box
13908 The MMDF mail box format.
13911 Several news articles appended into a file.
13914 @cindex rnews batch files
13915 The rnews batch transport format.
13916 @cindex forwarded messages
13919 Forwarded articles.
13922 Netscape mail boxes.
13925 MIME multipart messages.
13927 @item standard-digest
13928 The standard (RFC 1153) digest format.
13931 Non-standard digest format---matches most things, but does it badly.
13934 You can also use the special ``file type'' @code{guess}, which means
13935 that @code{nndoc} will try to guess what file type it is looking at.
13936 @code{digest} means that @code{nndoc} should guess what digest type the
13939 @code{nndoc} will not try to change the file or insert any extra headers into
13940 it---it will simply, like, let you use the file as the basis for a
13941 group. And that's it.
13943 If you have some old archived articles that you want to insert into your
13944 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
13945 that. Say you have an old @file{RMAIL} file with mail that you now want
13946 to split into your new @code{nnml} groups. You look at that file using
13947 @code{nndoc} (using the @kbd{G f} command in the group buffer
13948 (@pxref{Foreign Groups})), set the process mark on all the articles in
13949 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
13950 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
13951 file is now also stored in lots of @code{nnml} directories, and you can
13952 delete that pesky @file{RMAIL} file. If you have the guts!
13954 Virtual server variables:
13957 @item nndoc-article-type
13958 @vindex nndoc-article-type
13959 This should be one of @code{mbox}, @code{babyl}, @code{digest},
13960 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
13961 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
13962 @code{slack-digest}, @code{clari-briefs}, @code{nsmail} or @code{guess}.
13964 @item nndoc-post-type
13965 @vindex nndoc-post-type
13966 This variable says whether Gnus is to consider the group a news group or
13967 a mail group. There are two valid values: @code{mail} (the default)
13972 * Document Server Internals:: How to add your own document types.
13976 @node Document Server Internals
13977 @subsubsection Document Server Internals
13979 Adding new document types to be recognized by @code{nndoc} isn't
13980 difficult. You just have to whip up a definition of what the document
13981 looks like, write a predicate function to recognize that document type,
13982 and then hook into @code{nndoc}.
13984 First, here's an example document type definition:
13988 (article-begin . "^\^A\^A\^A\^A\n")
13989 (body-end . "^\^A\^A\^A\^A\n"))
13992 The definition is simply a unique @dfn{name} followed by a series of
13993 regexp pseudo-variable settings. Below are the possible
13994 variables---don't be daunted by the number of variables; most document
13995 types can be defined with very few settings:
13998 @item first-article
13999 If present, @code{nndoc} will skip past all text until it finds
14000 something that match this regexp. All text before this will be
14003 @item article-begin
14004 This setting has to be present in all document type definitions. It
14005 says what the beginning of each article looks like.
14007 @item head-begin-function
14008 If present, this should be a function that moves point to the head of
14011 @item nndoc-head-begin
14012 If present, this should be a regexp that matches the head of the
14015 @item nndoc-head-end
14016 This should match the end of the head of the article. It defaults to
14017 @samp{^$}---the empty line.
14019 @item body-begin-function
14020 If present, this function should move point to the beginning of the body
14024 This should match the beginning of the body of the article. It defaults
14027 @item body-end-function
14028 If present, this function should move point to the end of the body of
14032 If present, this should match the end of the body of the article.
14035 If present, this should match the end of the file. All text after this
14036 regexp will be totally ignored.
14040 So, using these variables @code{nndoc} is able to dissect a document
14041 file into a series of articles, each with a head and a body. However, a
14042 few more variables are needed since not all document types are all that
14043 news-like---variables needed to transform the head or the body into
14044 something that's palatable for Gnus:
14047 @item prepare-body-function
14048 If present, this function will be called when requesting an article. It
14049 will be called with point at the start of the body, and is useful if the
14050 document has encoded some parts of its contents.
14052 @item article-transform-function
14053 If present, this function is called when requesting an article. It's
14054 meant to be used for more wide-ranging transformation of both head and
14055 body of the article.
14057 @item generate-head-function
14058 If present, this function is called to generate a head that Gnus can
14059 understand. It is called with the article number as a parameter, and is
14060 expected to generate a nice head for the article in question. It is
14061 called when requesting the headers of all articles.
14065 Let's look at the most complicated example I can come up with---standard
14070 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
14071 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
14072 (prepare-body-function . nndoc-unquote-dashes)
14073 (body-end-function . nndoc-digest-body-end)
14074 (head-end . "^ ?$")
14075 (body-begin . "^ ?\n")
14076 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
14077 (subtype digest guess))
14080 We see that all text before a 70-width line of dashes is ignored; all
14081 text after a line that starts with that @samp{^End of} is also ignored;
14082 each article begins with a 30-width line of dashes; the line separating
14083 the head from the body may contain a single space; and that the body is
14084 run through @code{nndoc-unquote-dashes} before being delivered.
14086 To hook your own document definition into @code{nndoc}, use the
14087 @code{nndoc-add-type} function. It takes two parameters---the first is
14088 the definition itself and the second (optional) parameter says where in
14089 the document type definition alist to put this definition. The alist is
14090 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
14091 is of @code{mmdf} type, and so on. These type predicates should return
14092 @code{nil} if the document is not of the correct type; @code{t} if it is
14093 of the correct type; and a number if the document might be of the
14094 correct type. A high number means high probability; a low number means
14095 low probability with @samp{0} being the lowest valid number.
14103 In the PC world people often talk about ``offline'' newsreaders. These
14104 are thingies that are combined reader/news transport monstrosities.
14105 With built-in modem programs. Yecchh!
14107 Of course, us Unix Weenie types of human beans use things like
14108 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
14109 transport things like Ghod intended. And then we just use normal
14112 However, it can sometimes be convenient to do something that's a bit
14113 easier on the brain if you have a very slow modem, and you're not really
14114 that interested in doing things properly.
14116 A file format called @sc{soup} has been developed for transporting news
14117 and mail from servers to home machines and back again. It can be a bit
14120 First some terminology:
14125 This is the machine that is connected to the outside world and where you
14126 get news and/or mail from.
14129 This is the machine that you want to do the actual reading and responding
14130 on. It is typically not connected to the rest of the world in any way.
14133 Something that contains messages and/or commands. There are two kinds
14137 @item message packets
14138 These are packets made at the server, and typically contain lots of
14139 messages for you to read. These are called @file{SoupoutX.tgz} by
14140 default, where @var{x} is a number.
14142 @item response packets
14143 These are packets made at the home machine, and typically contains
14144 replies that you've written. These are called @file{SoupinX.tgz} by
14145 default, where @var{x} is a number.
14155 You log in on the server and create a @sc{soup} packet. You can either
14156 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
14157 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
14158 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
14161 You transfer the packet home. Rail, boat, car or modem will do fine.
14164 You put the packet in your home directory.
14167 You fire up Gnus on your home machine using the @code{nnsoup} backend as
14168 the native or secondary server.
14171 You read articles and mail and answer and followup to the things you
14172 want (@pxref{SOUP Replies}).
14175 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
14179 You transfer this packet to the server.
14182 You use Gnus to mail this packet out with the @kbd{G s s} command.
14185 You then repeat until you die.
14189 So you basically have a bipartite system---you use @code{nnsoup} for
14190 reading and Gnus for packing/sending these @sc{soup} packets.
14193 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
14194 * SOUP Groups:: A backend for reading @sc{soup} packets.
14195 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
14199 @node SOUP Commands
14200 @subsubsection SOUP Commands
14202 These are commands for creating and manipulating @sc{soup} packets.
14206 @kindex G s b (Group)
14207 @findex gnus-group-brew-soup
14208 Pack all unread articles in the current group
14209 (@code{gnus-group-brew-soup}). This command understands the
14210 process/prefix convention.
14213 @kindex G s w (Group)
14214 @findex gnus-soup-save-areas
14215 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
14218 @kindex G s s (Group)
14219 @findex gnus-soup-send-replies
14220 Send all replies from the replies packet
14221 (@code{gnus-soup-send-replies}).
14224 @kindex G s p (Group)
14225 @findex gnus-soup-pack-packet
14226 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
14229 @kindex G s r (Group)
14230 @findex nnsoup-pack-replies
14231 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
14234 @kindex O s (Summary)
14235 @findex gnus-soup-add-article
14236 This summary-mode command adds the current article to a @sc{soup} packet
14237 (@code{gnus-soup-add-article}). It understands the process/prefix
14238 convention (@pxref{Process/Prefix}).
14243 There are a few variables to customize where Gnus will put all these
14248 @item gnus-soup-directory
14249 @vindex gnus-soup-directory
14250 Directory where Gnus will save intermediate files while composing
14251 @sc{soup} packets. The default is @file{~/SoupBrew/}.
14253 @item gnus-soup-replies-directory
14254 @vindex gnus-soup-replies-directory
14255 This is what Gnus will use as a temporary directory while sending our
14256 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
14258 @item gnus-soup-prefix-file
14259 @vindex gnus-soup-prefix-file
14260 Name of the file where Gnus stores the last used prefix. The default is
14261 @samp{gnus-prefix}.
14263 @item gnus-soup-packer
14264 @vindex gnus-soup-packer
14265 A format string command for packing a @sc{soup} packet. The default is
14266 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
14268 @item gnus-soup-unpacker
14269 @vindex gnus-soup-unpacker
14270 Format string command for unpacking a @sc{soup} packet. The default is
14271 @samp{gunzip -c %s | tar xvf -}.
14273 @item gnus-soup-packet-directory
14274 @vindex gnus-soup-packet-directory
14275 Where Gnus will look for reply packets. The default is @file{~/}.
14277 @item gnus-soup-packet-regexp
14278 @vindex gnus-soup-packet-regexp
14279 Regular expression matching @sc{soup} reply packets in
14280 @code{gnus-soup-packet-directory}.
14286 @subsubsection @sc{soup} Groups
14289 @code{nnsoup} is the backend for reading @sc{soup} packets. It will
14290 read incoming packets, unpack them, and put them in a directory where
14291 you can read them at leisure.
14293 These are the variables you can use to customize its behavior:
14297 @item nnsoup-tmp-directory
14298 @vindex nnsoup-tmp-directory
14299 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
14300 directory. (@file{/tmp/} by default.)
14302 @item nnsoup-directory
14303 @vindex nnsoup-directory
14304 @code{nnsoup} then moves each message and index file to this directory.
14305 The default is @file{~/SOUP/}.
14307 @item nnsoup-replies-directory
14308 @vindex nnsoup-replies-directory
14309 All replies will be stored in this directory before being packed into a
14310 reply packet. The default is @file{~/SOUP/replies/"}.
14312 @item nnsoup-replies-format-type
14313 @vindex nnsoup-replies-format-type
14314 The @sc{soup} format of the replies packets. The default is @samp{?n}
14315 (rnews), and I don't think you should touch that variable. I probably
14316 shouldn't even have documented it. Drats! Too late!
14318 @item nnsoup-replies-index-type
14319 @vindex nnsoup-replies-index-type
14320 The index type of the replies packet. The default is @samp{?n}, which
14321 means ``none''. Don't fiddle with this one either!
14323 @item nnsoup-active-file
14324 @vindex nnsoup-active-file
14325 Where @code{nnsoup} stores lots of information. This is not an ``active
14326 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
14327 this file or mess it up in any way, you're dead. The default is
14328 @file{~/SOUP/active}.
14330 @item nnsoup-packer
14331 @vindex nnsoup-packer
14332 Format string command for packing a reply @sc{soup} packet. The default
14333 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
14335 @item nnsoup-unpacker
14336 @vindex nnsoup-unpacker
14337 Format string command for unpacking incoming @sc{soup} packets. The
14338 default is @samp{gunzip -c %s | tar xvf -}.
14340 @item nnsoup-packet-directory
14341 @vindex nnsoup-packet-directory
14342 Where @code{nnsoup} will look for incoming packets. The default is
14345 @item nnsoup-packet-regexp
14346 @vindex nnsoup-packet-regexp
14347 Regular expression matching incoming @sc{soup} packets. The default is
14350 @item nnsoup-always-save
14351 @vindex nnsoup-always-save
14352 If non-@code{nil}, save the replies buffer after each posted message.
14358 @subsubsection SOUP Replies
14360 Just using @code{nnsoup} won't mean that your postings and mailings end
14361 up in @sc{soup} reply packets automagically. You have to work a bit
14362 more for that to happen.
14364 @findex nnsoup-set-variables
14365 The @code{nnsoup-set-variables} command will set the appropriate
14366 variables to ensure that all your followups and replies end up in the
14369 In specific, this is what it does:
14372 (setq message-send-news-function 'nnsoup-request-post)
14373 (setq message-send-mail-function 'nnsoup-request-mail)
14376 And that's it, really. If you only want news to go into the @sc{soup}
14377 system you just use the first line. If you only want mail to be
14378 @sc{soup}ed you use the second.
14381 @node Mail-To-News Gateways
14382 @subsection Mail-To-News Gateways
14383 @cindex mail-to-news gateways
14386 If your local @code{nntp} server doesn't allow posting, for some reason
14387 or other, you can post using one of the numerous mail-to-news gateways.
14388 The @code{nngateway} backend provides the interface.
14390 Note that you can't read anything from this backend---it can only be
14396 @item nngateway-address
14397 @vindex nngateway-address
14398 This is the address of the mail-to-news gateway.
14400 @item nngateway-header-transformation
14401 @vindex nngateway-header-transformation
14402 News headers often have to be transformed in some odd way or other
14403 for the mail-to-news gateway to accept it. This variable says what
14404 transformation should be called, and defaults to
14405 @code{nngateway-simple-header-transformation}. The function is called
14406 narrowed to the headers to be transformed and with one parameter---the
14409 This default function just inserts a new @code{To} header based on the
14410 @code{Newsgroups} header and the gateway address.
14411 For instance, an article with this @code{Newsgroups} header:
14414 Newsgroups: alt.religion.emacs
14417 will get this @code{From} header inserted:
14420 To: alt-religion-emacs@@GATEWAY
14423 The following pre-defined functions exist:
14425 @findex nngateway-simple-header-transformation
14428 @item nngateway-simple-header-transformation
14429 Creates a @code{To} header that looks like
14430 @var{newsgroup}@@@code{nngateway-address}.
14432 @findex nngateway-mail2news-header-transformation
14434 @item nngateway-mail2news-header-transformation
14435 Creates a @code{To} header that looks like
14436 @code{nngateway-address}.
14441 (setq gnus-post-method
14443 "mail2news@@replay.com"
14444 (nngateway-header-transformation
14445 nngateway-mail2news-header-transformation)))
14453 So, to use this, simply say something like:
14456 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
14462 @subsection @sc{imap}
14466 @sc{imap} is a network protocol for reading mail (or news, or ...),
14467 think of it as a modernized @sc{nntp}. Connecting to a @sc{imap}
14468 server is much similar to connecting to a news server, you just
14469 specify the network address of the server.
14471 @sc{imap} has two properties. First, @sc{imap} can do everything that
14472 POP can, it can hence be viewed as POP++. Secondly, @sc{imap} is a
14473 mail storage protocol, similar to @sc{nntp} being a news storage
14474 protocol. (@sc{imap} offers more features than @sc{nntp} because news
14475 is more or less read-only whereas mail is read-write.)
14477 If you want to use @sc{imap} as POP++, use an imap entry in
14478 mail-sources. With this, Gnus will fetch mails from the @sc{imap}
14479 server and store them on the local disk. This is not the usage
14480 described in this section. @xref{Mail Sources}.
14482 If you want to use @sc{imap} as a mail storage protocol, use an nnimap
14483 entry in gnus-secondary-select-methods. With this, Gnus will
14484 manipulate mails stored on the @sc{imap} server. This is the kind of
14485 usage explained in this section.
14487 A server configuration in @code{~/.gnus} with a few @sc{imap} servers
14488 might look something like this:
14491 (setq gnus-secondary-select-methods
14492 '((nnimap "simpleserver") ; no special configuration
14493 ; perhaps a ssh port forwarded server:
14495 (nnimap-address "localhost")
14496 (nnimap-server-port 1430))
14497 ; a UW server running on localhost
14499 (nnimap-server-port 143)
14500 (nnimap-address "localhost")
14501 (nnimap-list-pattern ("INBOX" "mail/*")))
14502 ; anonymous public cyrus server:
14503 (nnimap "cyrus.andrew.cmu.edu"
14504 (nnimap-authenticator anonymous)
14505 (nnimap-list-pattern "archive.*")
14506 (nnimap-stream network))
14507 ; a ssl server on a non-standard port:
14509 (nnimap-address "vic20.somewhere.com")
14510 (nnimap-server-port 9930)
14511 (nnimap-stream ssl))))
14514 The following variables can be used to create a virtual @code{nnimap}
14519 @item nnimap-address
14520 @vindex nnimap-address
14522 The address of the remote @sc{imap} server. Defaults to the virtual
14523 server name if not specified.
14525 @item nnimap-server-port
14526 @vindex nnimap-server-port
14527 Port on server to contact. Defaults to port 143, or 993 for SSL.
14529 Note that this should be a integer, example server specification:
14532 (nnimap "mail.server.com"
14533 (nnimap-server-port 4711))
14536 @item nnimap-list-pattern
14537 @vindex nnimap-list-pattern
14538 String or list of strings of mailboxes to limit available groups to.
14539 This is used when the server has very many mailboxes and you're only
14540 interested in a few -- some servers export your home directory via
14541 @sc{imap}, you'll probably want to limit the mailboxes to those in
14542 @file{~/Mail/*} then.
14544 The string can also be a cons of REFERENCE and the string as above, what
14545 REFERENCE is used for is server specific, but on the University of
14546 Washington server it's a directory that will be concatenated with the
14549 Example server specification:
14552 (nnimap "mail.server.com"
14553 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
14554 ("~friend/Mail/" . "list/*"))))
14557 @item nnimap-stream
14558 @vindex nnimap-stream
14559 The type of stream used to connect to your server. By default, nnimap
14560 will detect and automatically use all of the below, with the exception
14561 of SSL. (SSL is being replaced by STARTTLS, which can be automatically
14562 detected, but it's not widely deployed yet).
14564 Example server specification:
14567 (nnimap "mail.server.com"
14568 (nnimap-stream ssl))
14571 Please note that the value of @code{nnimap-stream} is a symbol!
14575 @dfn{gssapi:} Connect with GSSAPI (usually kerberos 5). Requires the
14576 @samp{imtest} program.
14578 @dfn{kerberos4:} Connect with kerberos 4. Requires the @samp{imtest} program.
14580 @dfn{starttls:} Connect via the STARTTLS extension (similar to
14581 SSL). Requires the external library @samp{starttls.el} and program
14584 @dfn{ssl:} Connect through SSL. Requires OpenSSL (the
14585 program @samp{openssl}) or SSLeay (@samp{s_client}).
14587 @dfn{shell:} Use a shell command to start @sc{imap} connection.
14589 @dfn{network:} Plain, TCP/IP network connection.
14592 @vindex imap-kerberos4-program
14593 The @samp{imtest} program is shipped with Cyrus IMAPD. If you're
14594 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
14595 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
14596 to make @code{imap.el} use a pty instead of a pipe when communicating
14597 with @samp{imtest}. You will then suffer from a line length
14598 restrictions on IMAP commands, which might make Gnus seem to hang
14599 indefinitely if you have many articles in a mailbox. The variable
14600 @code{imap-kerberos4-program} contain parameters to pass to the imtest
14603 @vindex imap-ssl-program
14604 For SSL connections, the OpenSSL program is available from
14605 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
14606 and nnimap support it too - altough the most recent versions of
14607 SSLeay, 0.9.x, are known to have serious bugs making it
14608 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
14609 work. The variable @code{imap-ssl-program} contain parameters to pass
14612 @vindex imap-shell-program
14613 @vindex imap-shell-host
14614 For @sc{imap} connections using the @code{shell} stream, the variable
14615 @code{imap-shell-program} specify what program to call.
14617 @item nnimap-authenticator
14618 @vindex nnimap-authenticator
14620 The authenticator used to connect to the server. By default, nnimap
14621 will use the most secure authenticator your server is capable of.
14623 Example server specification:
14626 (nnimap "mail.server.com"
14627 (nnimap-authenticator anonymous))
14630 Please note that the value of @code{nnimap-authenticator} is a symbol!
14634 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Require
14635 external program @code{imtest}.
14637 @dfn{kerberos4:} Kerberos authentication. Require external program
14640 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Require
14641 external library @code{digest-md5.el}.
14643 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
14645 @dfn{login:} Plain-text username/password via LOGIN.
14647 @dfn{anonymous:} Login as `anonymous', supplying your emailadress as password.
14650 @item nnimap-expunge-on-close
14652 @vindex nnimap-expunge-on-close
14653 Unlike Parmenides the @sc{imap} designers has decided that things that
14654 doesn't exist actually does exist. More specifically, @sc{imap} has
14655 this concept of marking articles @code{Deleted} which doesn't actually
14656 delete them, and this (marking them @code{Deleted}, that is) is what
14657 nnimap does when you delete a article in Gnus (with @kbd{G DEL} or
14660 Since the articles aren't really removed when we mark them with the
14661 @code{Deleted} flag we'll need a way to actually delete them. Feel like
14662 running in circles yet?
14664 Traditionally, nnimap has removed all articles marked as @code{Deleted}
14665 when closing a mailbox but this is now configurable by this server
14668 The possible options are:
14673 The default behavior, delete all articles marked as "Deleted" when
14676 Never actually delete articles. Currently there is no way of showing
14677 the articles marked for deletion in nnimap, but other @sc{imap} clients
14678 may allow you to do this. If you ever want to run the EXPUNGE command
14679 manually, @xref{Expunging mailboxes}.
14681 When closing mailboxes, nnimap will ask if you wish to expunge deleted
14686 @item nnimap-importantize-dormant
14687 @vindex nnimap-importantize-dormant
14689 If non-nil, marks dormant articles as ticked (as well), for other IMAP
14690 clients. Within Gnus, dormant articles will naturally still (only) be
14691 marked as ticked. This is to make dormant articles stand out, just
14692 like ticked articles, in other IMAP clients. (In other words, Gnus has
14693 two ``Tick'' marks and IMAP has only one.)
14695 Probably the only reason for frobing this would be if you're trying
14696 enable per-user persistant dormant flags, using something like:
14699 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
14700 (format "gnus-dormant-%s" (user-login-name)))
14701 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
14702 (format "KEYWORD gnus-dormant-%s" (user-login-name)))
14705 In this case, you would not want the per-user dormant flag showing up
14706 as ticked for other users.
14708 @item nnimap-expunge-search-string
14710 @vindex nnimap-expunge-search-string
14712 This variable contain the IMAP search command sent to server when
14713 searching for articles eligible for expiring. The default is
14714 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
14715 UID set and the second @code{%s} is replaced by a date.
14717 Probably the only useful value to change this to is
14718 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
14719 messages instead of the internal article date. See section 6.4.4 of
14720 RFC 2060 for more information on valid strings.
14722 @item nnimap-authinfo-file
14723 @vindex nnimap-authinfo-file
14725 A file containing credentials used to log in on servers. The format is
14726 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
14727 variable @code{nntp-authinfo-file} for exact syntax; also see
14733 * Splitting in IMAP:: Splitting mail with nnimap.
14734 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
14735 * Expunging mailboxes:: Equivalent of a "compress mailbox" button.
14740 @node Splitting in IMAP
14741 @subsubsection Splitting in @sc{imap}
14742 @cindex splitting imap mail
14744 Splitting is something Gnus users has loved and used for years, and now
14745 the rest of the world is catching up. Yeah, dream on, not many
14746 @sc{imap} server has server side splitting and those that have splitting
14747 seem to use some non-standard protocol. This means that @sc{imap}
14748 support for Gnus has to do it's own splitting.
14752 Here are the variables of interest:
14756 @item nnimap-split-crosspost
14757 @cindex splitting, crosspost
14759 @vindex nnimap-split-crosspost
14761 If non-nil, do crossposting if several split methods match the mail. If
14762 nil, the first match in @code{nnimap-split-rule} found will be used.
14764 Nnmail equivalent: @code{nnmail-crosspost}.
14766 @item nnimap-split-inbox
14767 @cindex splitting, inbox
14769 @vindex nnimap-split-inbox
14771 A string or a list of strings that gives the name(s) of @sc{imap}
14772 mailboxes to split from. Defaults to nil, which means that splitting is
14776 (setq nnimap-split-inbox
14777 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
14780 No nnmail equivalent.
14782 @item nnimap-split-rule
14783 @cindex Splitting, rules
14784 @vindex nnimap-split-rule
14786 New mail found in @code{nnimap-split-inbox} will be split according to
14789 This variable contains a list of lists, where the first element in the
14790 sublist gives the name of the @sc{imap} mailbox to move articles
14791 matching the regexp in the second element in the sublist. Got that?
14792 Neither did I, we need examples.
14795 (setq nnimap-split-rule
14797 "^Sender: owner-nnimap@@vic20.globalcom.se")
14798 ("INBOX.junk" "^Subject:.*MAKE MONEY")
14799 ("INBOX.private" "")))
14802 This will put all articles from the nnimap mailing list into mailbox
14803 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
14804 into INBOX.junk and everything else in INBOX.private.
14806 The first string may contain `\\1' forms, like the ones used by
14807 replace-match to insert sub-expressions from the matched text. For
14811 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
14814 The second element can also be a function. In that case, it will be
14815 called with the first element of the rule as the argument, in a buffer
14816 containing the headers of the article. It should return a non-nil value
14817 if it thinks that the mail belongs in that group.
14819 Nnmail users might recollect that the last regexp had to be empty to
14820 match all articles (like in the example above). This is not required in
14821 nnimap. Articles not matching any of the regexps will not be moved out
14822 of your inbox. (This might affect performance if you keep lots of
14823 unread articles in your inbox, since the splitting code would go over
14824 them every time you fetch new mail.)
14826 These rules are processed from the beginning of the alist toward the
14827 end. The first rule to make a match will "win", unless you have
14828 crossposting enabled. In that case, all matching rules will "win".
14830 This variable can also have a function as its value, the function will
14831 be called with the headers narrowed and should return a group where it
14832 thinks the article should be split to. See @code{nnimap-split-fancy}.
14834 The splitting code tries to create mailboxes if it need too.
14836 To allow for different split rules on different virtual servers, and
14837 even different split rules in different inboxes on the same server,
14838 the syntax of this variable have been extended along the lines of:
14841 (setq nnimap-split-rule
14842 '(("my1server" (".*" (("ding" "ding@@gnus.org")
14843 ("junk" "From:.*Simon")))
14844 ("my2server" ("INBOX" nnimap-split-fancy))
14845 ("my[34]server" (".*" (("private" "To:.*Simon")
14846 ("junk" my-junk-func)))))
14849 The virtual server name is in fact a regexp, so that the same rules
14850 may apply to several servers. In the example, the servers
14851 @code{my3server} and @code{my4server} both use the same rules.
14852 Similarly, the inbox string is also a regexp. The actual splitting
14853 rules are as before, either a function, or a list with group/regexp or
14854 group/function elements.
14856 Nnmail equivalent: @code{nnmail-split-methods}.
14858 @item nnimap-split-predicate
14860 @vindex nnimap-split-predicate
14862 Mail matching this predicate in @code{nnimap-split-inbox} will be
14863 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
14865 This might be useful if you use another @sc{imap} client to read mail in
14866 your inbox but would like Gnus to split all articles in the inbox
14867 regardless of readedness. Then you might change this to
14870 @item nnimap-split-fancy
14871 @cindex splitting, fancy
14872 @findex nnimap-split-fancy
14873 @vindex nnimap-split-fancy
14875 It's possible to set @code{nnimap-split-rule} to
14876 @code{nnmail-split-fancy} if you want to use fancy
14877 splitting. @xref{Fancy Mail Splitting}.
14879 However, to be able to have different fancy split rules for nnmail and
14880 nnimap backends you can set @code{nnimap-split-rule} to
14881 @code{nnimap-split-fancy} and define the nnimap specific fancy split
14882 rule in @code{nnimap-split-fancy}.
14887 (setq nnimap-split-rule 'nnimap-split-fancy
14888 nnimap-split-fancy ...)
14891 Nnmail equivalent: @code{nnmail-split-fancy}.
14895 @node Editing IMAP ACLs
14896 @subsubsection Editing @sc{imap} ACLs
14897 @cindex editing imap acls
14898 @cindex Access Control Lists
14899 @cindex Editing @sc{imap} ACLs
14901 @findex gnus-group-nnimap-edit-acl
14903 ACL stands for Access Control List. ACLs are used in @sc{imap} for
14904 limiting (or enabling) other users access to your mail boxes. Not all
14905 @sc{imap} servers support this, this function will give an error if it
14908 To edit a ACL for a mailbox, type @kbd{G l}
14909 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with a ACL
14910 editing window with detailed instructions.
14912 Some possible uses:
14916 Giving "anyone" the "lrs" rights (lookup, read, keep seen/unseen flags)
14917 on your mailing list mailboxes enables other users on the same server to
14918 follow the list without subscribing to it.
14920 At least with the Cyrus server, you are required to give the user
14921 "anyone" posting ("p") capabilities to have "plussing" work (that is,
14922 mail sent to user+mailbox@@domain ending up in the @sc{imap} mailbox
14926 @node Expunging mailboxes
14927 @subsubsection Expunging mailboxes
14931 @cindex Manual expunging
14933 @findex gnus-group-nnimap-expunge
14935 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
14936 you may want the option of expunging all deleted articles in a mailbox
14937 manually. This is exactly what @kbd{G x} does.
14939 Currently there is no way of showing deleted articles, you can just
14944 @node Combined Groups
14945 @section Combined Groups
14947 Gnus allows combining a mixture of all the other group types into bigger
14951 * Virtual Groups:: Combining articles from many groups.
14952 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
14956 @node Virtual Groups
14957 @subsection Virtual Groups
14959 @cindex virtual groups
14960 @cindex merging groups
14962 An @dfn{nnvirtual group} is really nothing more than a collection of
14965 For instance, if you are tired of reading many small groups, you can
14966 put them all in one big group, and then grow tired of reading one
14967 big, unwieldy group. The joys of computing!
14969 You specify @code{nnvirtual} as the method. The address should be a
14970 regexp to match component groups.
14972 All marks in the virtual group will stick to the articles in the
14973 component groups. So if you tick an article in a virtual group, the
14974 article will also be ticked in the component group from whence it came.
14975 (And vice versa---marks from the component groups will also be shown in
14976 the virtual group.)
14978 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
14979 newsgroups into one, big, happy newsgroup:
14982 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
14985 The component groups can be native or foreign; everything should work
14986 smoothly, but if your computer explodes, it was probably my fault.
14988 Collecting the same group from several servers might actually be a good
14989 idea if users have set the Distribution header to limit distribution.
14990 If you would like to read @samp{soc.motss} both from a server in Japan
14991 and a server in Norway, you could use the following as the group regexp:
14994 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
14997 (Remember, though, that if you're creating the group with @kbd{G m}, you
14998 shouldn't double the backslashes, and you should leave off the quote
14999 characters at the beginning and the end of the string.)
15001 This should work kinda smoothly---all articles from both groups should
15002 end up in this one, and there should be no duplicates. Threading (and
15003 the rest) will still work as usual, but there might be problems with the
15004 sequence of articles. Sorting on date might be an option here
15005 (@pxref{Selecting a Group}).
15007 One limitation, however---all groups included in a virtual
15008 group have to be alive (i.e., subscribed or unsubscribed). Killed or
15009 zombie groups can't be component groups for @code{nnvirtual} groups.
15011 @vindex nnvirtual-always-rescan
15012 If the @code{nnvirtual-always-rescan} is non-@code{nil},
15013 @code{nnvirtual} will always scan groups for unread articles when
15014 entering a virtual group. If this variable is @code{nil} (which is the
15015 default) and you read articles in a component group after the virtual
15016 group has been activated, the read articles from the component group
15017 will show up when you enter the virtual group. You'll also see this
15018 effect if you have two virtual groups that have a component group in
15019 common. If that's the case, you should set this variable to @code{t}.
15020 Or you can just tap @code{M-g} on the virtual group every time before
15021 you enter it---it'll have much the same effect.
15023 @code{nnvirtual} can have both mail and news groups as component groups.
15024 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
15025 has to ask the backend of the component group the article comes from
15026 whether it is a news or mail backend. However, when you do a @kbd{^},
15027 there is typically no sure way for the component backend to know this,
15028 and in that case @code{nnvirtual} tells Gnus that the article came from a
15029 not-news backend. (Just to be on the safe side.)
15031 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
15032 line from the article you respond to in these cases.
15036 @node Kibozed Groups
15037 @subsection Kibozed Groups
15041 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
15042 the news feed''. @code{nnkiboze} is a backend that will do this for
15043 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
15044 with useless requests! Oh happiness!
15046 @kindex G k (Group)
15047 To create a kibozed group, use the @kbd{G k} command in the group
15050 The address field of the @code{nnkiboze} method is, as with
15051 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
15052 @code{nnkiboze} group. That's where most similarities between @code{nnkiboze}
15053 and @code{nnvirtual} end.
15055 In addition to this regexp detailing component groups, an @code{nnkiboze} group
15056 must have a score file to say what articles are to be included in
15057 the group (@pxref{Scoring}).
15059 @kindex M-x nnkiboze-generate-groups
15060 @findex nnkiboze-generate-groups
15061 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
15062 @code{nnkiboze} groups you want to have. This command will take time. Lots of
15063 time. Oodles and oodles of time. Gnus has to fetch the headers from
15064 all the articles in all the component groups and run them through the
15065 scoring process to determine if there are any articles in the groups
15066 that are to be part of the @code{nnkiboze} groups.
15068 Please limit the number of component groups by using restrictive
15069 regexps. Otherwise your sysadmin may become annoyed with you, and the
15070 @sc{nntp} site may throw you off and never let you back in again.
15071 Stranger things have happened.
15073 @code{nnkiboze} component groups do not have to be alive---they can be dead,
15074 and they can be foreign. No restrictions.
15076 @vindex nnkiboze-directory
15077 The generation of an @code{nnkiboze} group means writing two files in
15078 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
15079 contains the @sc{nov} header lines for all the articles in the group,
15080 and the other is an additional @file{.newsrc} file to store information
15081 on what groups have been searched through to find component articles.
15083 Articles marked as read in the @code{nnkiboze} group will have
15084 their @sc{nov} lines removed from the @sc{nov} file.
15087 @node Gnus Unplugged
15088 @section Gnus Unplugged
15093 @cindex Gnus Unplugged
15095 In olden times (ca. February '88), people used to run their newsreaders
15096 on big machines with permanent connections to the net. News transport
15097 was dealt with by news servers, and all the newsreaders had to do was to
15098 read news. Believe it or not.
15100 Nowadays most people read news and mail at home, and use some sort of
15101 modem to connect to the net. To avoid running up huge phone bills, it
15102 would be nice to have a way to slurp down all the news and mail, hang up
15103 the phone, read for several hours, and then upload any responses you
15104 have to make. And then you repeat the procedure.
15106 Of course, you can use news servers for doing this as well. I've used
15107 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
15108 for some years, but doing that's a bore. Moving the news server
15109 functionality up to the newsreader makes sense if you're the only person
15110 reading news on a machine.
15112 Using Gnus as an ``offline'' newsreader is quite simple.
15116 First, set up Gnus as you would do if you were running it on a machine
15117 that has full connection to the net. Go ahead. I'll still be waiting
15121 Then, put the following magical incantation at the end of your
15122 @file{.gnus.el} file:
15129 That's it. Gnus is now an ``offline'' newsreader.
15131 Of course, to use it as such, you have to learn a few new commands.
15134 * Agent Basics:: How it all is supposed to work.
15135 * Agent Categories:: How to tell the Gnus Agent what to download.
15136 * Agent Commands:: New commands for all the buffers.
15137 * Agent Expiry:: How to make old articles go away.
15138 * Agent and IMAP:: How to use the Agent with IMAP.
15139 * Outgoing Messages:: What happens when you post/mail something?
15140 * Agent Variables:: Customizing is fun.
15141 * Example Setup:: An example @file{.gnus.el} file for offline people.
15142 * Batching Agents:: How to fetch news from a @code{cron} job.
15143 * Agent Caveats:: What you think it'll do and what it does.
15148 @subsection Agent Basics
15150 First, let's get some terminology out of the way.
15152 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
15153 connection to the net (and notified the Agent that this is the case).
15154 When the connection to the net is up again (and Gnus knows this), the
15155 Agent is @dfn{plugged}.
15157 The @dfn{local} machine is the one you're running on, and which isn't
15158 connected to the net continuously.
15160 @dfn{Downloading} means fetching things from the net to your local
15161 machine. @dfn{Uploading} is doing the opposite.
15163 Let's take a typical Gnus session using the Agent.
15168 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
15169 Agent in a disconnected state. You can read all the news that you have
15170 already fetched while in this mode.
15173 You then decide to see whether any new news has arrived. You connect
15174 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
15175 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
15176 as usual. To check for new mail in unplugged mode, see (@pxref{Mail
15177 Source Specifiers}).
15180 You can then read the new news immediately, or you can download the news
15181 onto your local machine. If you want to do the latter, you press @kbd{g}
15182 to check if there are any new news and then @kbd{J
15183 s} to fetch all the eligible articles in all the groups. (To let Gnus
15184 know which articles you want to download, @pxref{Agent Categories}.)
15187 After fetching the articles, you press @kbd{J j} to make Gnus become
15188 unplugged again, and you shut down the PPP thing (or whatever). And
15189 then you read the news offline.
15192 And then you go to step 2.
15195 Here are some things you should do the first time (or so) that you use
15201 Decide which servers should be covered by the Agent. If you have a mail
15202 backend, it would probably be nonsensical to have it covered by the
15203 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
15204 @kbd{J a} the server (or servers) that you wish to have covered by the
15205 Agent (@pxref{Server Agent Commands}). This will typically be only the
15206 primary select method, which is listed on the bottom in the buffer.
15209 Decide on download policy. @xref{Agent Categories}.
15216 @node Agent Categories
15217 @subsection Agent Categories
15219 One of the main reasons to integrate the news transport layer into the
15220 newsreader is to allow greater control over what articles to download.
15221 There's not much point in downloading huge amounts of articles, just to
15222 find out that you're not interested in reading any of them. It's better
15223 to be somewhat more conservative in choosing what to download, and then
15224 mark the articles for downloading manually if it should turn out that
15225 you're interested in the articles anyway.
15227 The main way to control what is to be downloaded is to create a
15228 @dfn{category} and then assign some (or all) groups to this category.
15229 Groups that do not belong in any other category belong to the
15230 @code{default} category. Gnus has its own buffer for creating and
15231 managing categories.
15234 * Category Syntax:: What a category looks like.
15235 * Category Buffer:: A buffer for maintaining categories.
15236 * Category Variables:: Customize'r'Us.
15240 @node Category Syntax
15241 @subsubsection Category Syntax
15243 A category consists of two things.
15247 A predicate which (generally) gives a rough outline of which articles
15248 are eligible for downloading; and
15251 a score rule which (generally) gives you a finer granularity when
15252 deciding what articles to download. (Note that this @dfn{download
15253 score} is not necessarily related to normal scores.)
15256 A predicate in its simplest form can be a single predicate such as
15257 @code{true} or @code{false}. These two will download every available
15258 article or nothing respectively. In the case of these two special
15259 predicates an additional score rule is superfluous.
15261 Predicates of @code{high} or @code{low} download articles in respect of
15262 their scores in relationship to @code{gnus-agent-high-score} and
15263 @code{gnus-agent-low-score} as described below.
15265 To gain even finer control of what is to be regarded eligible for
15266 download a predicate can consist of a number of predicates with logical
15267 operators sprinkled in between.
15269 Perhaps some examples are in order.
15271 Here's a simple predicate. (It's the default predicate, in fact, used
15272 for all groups that don't belong to any other category.)
15278 Quite simple, eh? This predicate is true if and only if the article is
15279 short (for some value of ``short'').
15281 Here's a more complex predicate:
15290 This means that an article should be downloaded if it has a high score,
15291 or if the score is not low and the article is not long. You get the
15294 The available logical operators are @code{or}, @code{and} and
15295 @code{not}. (If you prefer, you can use the more ``C''-ish operators
15296 @samp{|}, @code{&} and @code{!} instead.)
15298 The following predicates are pre-defined, but if none of these fit what
15299 you want to do, you can write your own.
15303 True iff the article is shorter than @code{gnus-agent-short-article}
15304 lines; default 100.
15307 True iff the article is longer than @code{gnus-agent-long-article}
15308 lines; default 200.
15311 True iff the article has a download score less than
15312 @code{gnus-agent-low-score}; default 0.
15315 True iff the article has a download score greater than
15316 @code{gnus-agent-high-score}; default 0.
15319 True iff the Gnus Agent guesses that the article is spam. The
15320 heuristics may change over time, but at present it just computes a
15321 checksum and sees whether articles match.
15330 If you want to create your own predicate function, here's what you have
15331 to know: The functions are called with no parameters, but the
15332 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
15335 For example, you could decide that you don't want to download articles
15336 that were posted more than a certain number of days ago (e.g. posted
15337 more than @code{gnus-agent-expire-days} ago) you might write a function
15338 something along the lines of the following:
15341 (defun my-article-old-p ()
15342 "Say whether an article is old."
15343 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
15344 (- (time-to-days (current-time)) gnus-agent-expire-days)))
15347 with the predicate then defined as:
15350 (not my-article-old-p)
15353 or you could append your predicate to the predefined
15354 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
15355 wherever. (Note: this would have to be at a point *after*
15356 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
15359 (setq gnus-category-predicate-alist
15360 (append gnus-category-predicate-alist
15361 '((old . my-article-old-p))))
15364 and simply specify your predicate as:
15370 If/when using something like the above, be aware that there are many
15371 misconfigured systems/mailers out there and so an article's date is not
15372 always a reliable indication of when it was posted. Hell, some people
15373 just don't give a damn.
15375 The above predicates apply to *all* the groups which belong to the
15376 category. However, if you wish to have a specific predicate for an
15377 individual group within a category, or you're just too lazy to set up a
15378 new category, you can enter a group's individual predicate in it's group
15379 parameters like so:
15382 (agent-predicate . short)
15385 This is the group parameter equivalent of the agent category default.
15386 Note that when specifying a single word predicate like this, the
15387 @code{agent-predicate} specification must be in dotted pair notation.
15389 The equivalent of the longer example from above would be:
15392 (agent-predicate or high (and (not low) (not long)))
15395 The outer parenthesis required in the category specification are not
15396 entered here as, not being in dotted pair notation, the value of the
15397 predicate is assumed to be a list.
15400 Now, the syntax of the download score is the same as the syntax of
15401 normal score files, except that all elements that require actually
15402 seeing the article itself are verboten. This means that only the
15403 following headers can be scored on: @code{Subject}, @code{From},
15404 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
15405 @code{Lines}, and @code{Xref}.
15407 As with predicates, the specification of the @code{download score rule}
15408 to use in respect of a group can be in either the category definition if
15409 it's to be applicable to all groups in therein, or a group's parameters
15410 if it's to be specific to that group.
15412 In both of these places the @code{download score rule} can take one of
15419 This has the same syntax as a normal gnus score file except only a
15420 subset of scoring keywords are available as mentioned above.
15426 Category specification
15430 ("Lars Ingebrigtsen" 1000000 nil s))
15436 Group Parameter specification
15439 (agent-score ("from"
15440 ("Lars Ingebrigtsen" 1000000 nil s))
15445 Again, note the omission of the outermost parenthesis here.
15451 These score files must *only* contain the permitted scoring keywords
15458 Category specification
15461 ("~/News/agent.SCORE")
15467 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
15471 Group Parameter specification
15474 (agent-score "~/News/agent.SCORE")
15477 Additional score files can be specified as above. Need I say anything
15482 Use @code{normal} score files
15484 If you don't want to maintain two sets of scoring rules for a group, and
15485 your desired @code{downloading} criteria for a group are the same as your
15486 @code{reading} criteria then you can tell the agent to refer to your
15487 @code{normal} score files when deciding what to download.
15489 These directives in either the category definition or a group's
15490 parameters will cause the agent to read in all the applicable score
15491 files for a group, *filtering out* those sections that do not
15492 relate to one of the permitted subset of scoring keywords.
15496 Category Specification
15503 Group Parameter specification
15506 (agent-score . file)
15511 @node Category Buffer
15512 @subsubsection Category Buffer
15514 You'd normally do all category maintenance from the category buffer.
15515 When you enter it for the first time (with the @kbd{J c} command from
15516 the group buffer), you'll only see the @code{default} category.
15518 The following commands are available in this buffer:
15522 @kindex q (Category)
15523 @findex gnus-category-exit
15524 Return to the group buffer (@code{gnus-category-exit}).
15527 @kindex k (Category)
15528 @findex gnus-category-kill
15529 Kill the current category (@code{gnus-category-kill}).
15532 @kindex c (Category)
15533 @findex gnus-category-copy
15534 Copy the current category (@code{gnus-category-copy}).
15537 @kindex a (Category)
15538 @findex gnus-category-add
15539 Add a new category (@code{gnus-category-add}).
15542 @kindex p (Category)
15543 @findex gnus-category-edit-predicate
15544 Edit the predicate of the current category
15545 (@code{gnus-category-edit-predicate}).
15548 @kindex g (Category)
15549 @findex gnus-category-edit-groups
15550 Edit the list of groups belonging to the current category
15551 (@code{gnus-category-edit-groups}).
15554 @kindex s (Category)
15555 @findex gnus-category-edit-score
15556 Edit the download score rule of the current category
15557 (@code{gnus-category-edit-score}).
15560 @kindex l (Category)
15561 @findex gnus-category-list
15562 List all the categories (@code{gnus-category-list}).
15566 @node Category Variables
15567 @subsubsection Category Variables
15570 @item gnus-category-mode-hook
15571 @vindex gnus-category-mode-hook
15572 Hook run in category buffers.
15574 @item gnus-category-line-format
15575 @vindex gnus-category-line-format
15576 Format of the lines in the category buffer (@pxref{Formatting
15577 Variables}). Valid elements are:
15581 The name of the category.
15584 The number of groups in the category.
15587 @item gnus-category-mode-line-format
15588 @vindex gnus-category-mode-line-format
15589 Format of the category mode line (@pxref{Mode Line Formatting}).
15591 @item gnus-agent-short-article
15592 @vindex gnus-agent-short-article
15593 Articles that have fewer lines than this are short. Default 100.
15595 @item gnus-agent-long-article
15596 @vindex gnus-agent-long-article
15597 Articles that have more lines than this are long. Default 200.
15599 @item gnus-agent-low-score
15600 @vindex gnus-agent-low-score
15601 Articles that have a score lower than this have a low score. Default
15604 @item gnus-agent-high-score
15605 @vindex gnus-agent-high-score
15606 Articles that have a score higher than this have a high score. Default
15612 @node Agent Commands
15613 @subsection Agent Commands
15615 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
15616 (@code{gnus-agent-toggle-plugged} command works in all modes, and
15617 toggles the plugged/unplugged state of the Gnus Agent.
15621 * Group Agent Commands::
15622 * Summary Agent Commands::
15623 * Server Agent Commands::
15626 You can run a complete batch fetch from the command line with the
15627 following incantation:
15629 @cindex gnus-agent-batch-fetch
15631 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
15636 @node Group Agent Commands
15637 @subsubsection Group Agent Commands
15641 @kindex J u (Agent Group)
15642 @findex gnus-agent-fetch-groups
15643 Fetch all eligible articles in the current group
15644 (@code{gnus-agent-fetch-groups}).
15647 @kindex J c (Agent Group)
15648 @findex gnus-enter-category-buffer
15649 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
15652 @kindex J s (Agent Group)
15653 @findex gnus-agent-fetch-session
15654 Fetch all eligible articles in all groups
15655 (@code{gnus-agent-fetch-session}).
15658 @kindex J S (Agent Group)
15659 @findex gnus-group-send-drafts
15660 Send all sendable messages in the draft group
15661 (@code{gnus-group-send-drafts}). @xref{Drafts}.
15664 @kindex J a (Agent Group)
15665 @findex gnus-agent-add-group
15666 Add the current group to an Agent category
15667 (@code{gnus-agent-add-group}). This command understands the
15668 process/prefix convention (@pxref{Process/Prefix}).
15671 @kindex J r (Agent Group)
15672 @findex gnus-agent-remove-group
15673 Remove the current group from its category, if any
15674 (@code{gnus-agent-remove-group}). This command understands the
15675 process/prefix convention (@pxref{Process/Prefix}).
15678 @kindex J Y (Agent Group)
15679 @findex gnus-agent-synchronize-flags
15680 Synchronize flags changed while unplugged with remote server, if any.
15686 @node Summary Agent Commands
15687 @subsubsection Summary Agent Commands
15691 @kindex J # (Agent Summary)
15692 @findex gnus-agent-mark-article
15693 Mark the article for downloading (@code{gnus-agent-mark-article}).
15696 @kindex J M-# (Agent Summary)
15697 @findex gnus-agent-unmark-article
15698 Remove the downloading mark from the article
15699 (@code{gnus-agent-unmark-article}).
15702 @kindex @@ (Agent Summary)
15703 @findex gnus-agent-toggle-mark
15704 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
15707 @kindex J c (Agent Summary)
15708 @findex gnus-agent-catchup
15709 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
15712 @kindex J u (Agent Summary)
15713 @findex gnus-agent-summary-fetch-group
15714 Download all downloadable articles in the current group
15715 (@code{gnus-agent-summary-fetch-group}).
15720 @node Server Agent Commands
15721 @subsubsection Server Agent Commands
15725 @kindex J a (Agent Server)
15726 @findex gnus-agent-add-server
15727 Add the current server to the list of servers covered by the Gnus Agent
15728 (@code{gnus-agent-add-server}).
15731 @kindex J r (Agent Server)
15732 @findex gnus-agent-remove-server
15733 Remove the current server from the list of servers covered by the Gnus
15734 Agent (@code{gnus-agent-remove-server}).
15740 @subsection Agent Expiry
15742 @vindex gnus-agent-expire-days
15743 @findex gnus-agent-expire
15744 @kindex M-x gnus-agent-expire
15745 @cindex Agent expiry
15746 @cindex Gnus Agent expiry
15749 @code{nnagent} doesn't handle expiry. Instead, there's a special
15750 @code{gnus-agent-expire} command that will expire all read articles that
15751 are older than @code{gnus-agent-expire-days} days. It can be run
15752 whenever you feel that you're running out of space. It's not
15753 particularly fast or efficient, and it's not a particularly good idea to
15754 interrupt it (with @kbd{C-g} or anything else) once you've started it.
15756 @vindex gnus-agent-expire-all
15757 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
15758 expire all articles---unread, read, ticked and dormant. If @code{nil}
15759 (which is the default), only read articles are eligible for expiry, and
15760 unread, ticked and dormant articles will be kept indefinitely.
15763 @node Agent and IMAP
15764 @subsection Agent and IMAP
15766 The Agent work with any Gnus backend, including nnimap. However,
15767 since there are some conceptual differences between @sc{nntp} and
15768 @sc{imap}, this section (should) provide you with some information to
15769 make Gnus Agent work smoother as a @sc{imap} Disconnected Mode client.
15771 The first thing to keep in mind is that all flags (read, ticked, etc)
15772 are kept on the @sc{imap} server, rather than in @code{.newsrc} as is the
15773 case for nntp. Thus Gnus need to remember flag changes when
15774 disconnected, and synchronize these flags when you plug back in.
15776 Gnus keep track of flag changes when reading nnimap groups under the
15777 Agent by default. When you plug back in, by default Gnus will check if
15778 you have any changed any flags and ask if you wish to synchronize these
15779 with the server. This behavior is customizable with
15780 @code{gnus-agent-synchronize-flags}.
15782 @vindex gnus-agent-synchronize-flags
15783 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
15784 never automatically synchronize flags. If it is @code{ask}, the
15785 default, the Agent will check if you made any changes and if so ask if
15786 you wish to synchronize these when you re-connect. If it has any other
15787 value, all flags will be synchronized automatically.
15789 If you do not wish to automatically synchronize flags when you
15790 re-connect, this can be done manually with the
15791 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
15792 in the group buffer by default.
15794 Some things are currently not implemented in the Agent that you'd might
15795 expect from a disconnected @sc{imap} client, including:
15800 Copying/moving articles into nnimap groups when unplugged.
15803 Creating/deleting nnimap groups when unplugged.
15807 Technical note: the synchronization algorithm does not work by "pushing"
15808 all local flags to the server, but rather incrementally update the
15809 server view of flags by changing only those flags that were changed by
15810 the user. Thus, if you set one flag on a article, quit the group and
15811 re-select the group and remove the flag; the flag will be set and
15812 removed from the server when you "synchronize". The queued flag
15813 operations can be found in the per-server @code{flags} file in the Agent
15814 directory. It's emptied when you synchronize flags.
15817 @node Outgoing Messages
15818 @subsection Outgoing Messages
15820 When Gnus is unplugged, all outgoing messages (both mail and news) are
15821 stored in the draft groups (@pxref{Drafts}). You can view them there
15822 after posting, and edit them at will.
15824 When Gnus is plugged again, you can send the messages either from the
15825 draft group with the special commands available there, or you can use
15826 the @kbd{J S} command in the group buffer to send all the sendable
15827 messages in the draft group.
15831 @node Agent Variables
15832 @subsection Agent Variables
15835 @item gnus-agent-directory
15836 @vindex gnus-agent-directory
15837 Where the Gnus Agent will store its files. The default is
15838 @file{~/News/agent/}.
15840 @item gnus-agent-handle-level
15841 @vindex gnus-agent-handle-level
15842 Groups on levels (@pxref{Group Levels}) higher than this variable will
15843 be ignored by the Agent. The default is @code{gnus-level-subscribed},
15844 which means that only subscribed group will be considered by the Agent
15847 @item gnus-agent-plugged-hook
15848 @vindex gnus-agent-plugged-hook
15849 Hook run when connecting to the network.
15851 @item gnus-agent-unplugged-hook
15852 @vindex gnus-agent-unplugged-hook
15853 Hook run when disconnecting from the network.
15858 @node Example Setup
15859 @subsection Example Setup
15861 If you don't want to read this manual, and you have a fairly standard
15862 setup, you may be able to use something like the following as your
15863 @file{.gnus.el} file to get started.
15866 ;;; Define how Gnus is to fetch news. We do this over @sc{nntp}
15867 ;;; from your ISP's server.
15868 (setq gnus-select-method '(nntp "news.your-isp.com"))
15870 ;;; Define how Gnus is to read your mail. We read mail from
15871 ;;; your ISP's POP server.
15872 (setq mail-sources '((pop :server "pop.your-isp.com")))
15874 ;;; Say how Gnus is to store the mail. We use nnml groups.
15875 (setq gnus-secondary-select-methods '((nnml "")))
15877 ;;; Make Gnus into an offline newsreader.
15881 That should be it, basically. Put that in your @file{~/.gnus.el} file,
15882 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
15885 If this is the first time you've run Gnus, you will be subscribed
15886 automatically to a few default newsgroups. You'll probably want to
15887 subscribe to more groups, and to do that, you have to query the
15888 @sc{nntp} server for a complete list of groups with the @kbd{A A}
15889 command. This usually takes quite a while, but you only have to do it
15892 After reading and parsing a while, you'll be presented with a list of
15893 groups. Subscribe to the ones you want to read with the @kbd{u}
15894 command. @kbd{l} to make all the killed groups disappear after you've
15895 subscribe to all the groups you want to read. (@kbd{A k} will bring
15896 back all the killed groups.)
15898 You can now read the groups at once, or you can download the articles
15899 with the @kbd{J s} command. And then read the rest of this manual to
15900 find out which of the other gazillion things you want to customize.
15903 @node Batching Agents
15904 @subsection Batching Agents
15906 Having the Gnus Agent fetch articles (and post whatever messages you've
15907 written) is quite easy once you've gotten things set up properly. The
15908 following shell script will do everything that is necessary:
15912 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
15916 @node Agent Caveats
15917 @subsection Agent Caveats
15919 The Gnus Agent doesn't seem to work like most other offline
15920 newsreaders. Here are some common questions that some imaginary people
15924 @item If I read an article while plugged, do they get entered into the
15929 @item If I read an article while plugged, and the article already exists
15930 in the Agent, will it get downloaded once more?
15936 In short, when Gnus is unplugged, it only looks into the locally stored
15937 articles; when it's plugged, it only talks to your ISP.
15944 Other people use @dfn{kill files}, but we here at Gnus Towers like
15945 scoring better than killing, so we'd rather switch than fight. They do
15946 something completely different as well, so sit up straight and pay
15949 @vindex gnus-summary-mark-below
15950 All articles have a default score (@code{gnus-summary-default-score}),
15951 which is 0 by default. This score may be raised or lowered either
15952 interactively or by score files. Articles that have a score lower than
15953 @code{gnus-summary-mark-below} are marked as read.
15955 Gnus will read any @dfn{score files} that apply to the current group
15956 before generating the summary buffer.
15958 There are several commands in the summary buffer that insert score
15959 entries based on the current article. You can, for instance, ask Gnus to
15960 lower or increase the score of all articles with a certain subject.
15962 There are two sorts of scoring entries: Permanent and temporary.
15963 Temporary score entries are self-expiring entries. Any entries that are
15964 temporary and have not been used for, say, a week, will be removed
15965 silently to help keep the sizes of the score files down.
15968 * Summary Score Commands:: Adding score entries for the current group.
15969 * Group Score Commands:: General score commands.
15970 * Score Variables:: Customize your scoring. (My, what terminology).
15971 * Score File Format:: What a score file may contain.
15972 * Score File Editing:: You can edit score files by hand as well.
15973 * Adaptive Scoring:: Big Sister Gnus knows what you read.
15974 * Home Score File:: How to say where new score entries are to go.
15975 * Followups To Yourself:: Having Gnus notice when people answer you.
15976 * Scoring On Other Headers:: Scoring on non-standard headers.
15977 * Scoring Tips:: How to score effectively.
15978 * Reverse Scoring:: That problem child of old is not problem.
15979 * Global Score Files:: Earth-spanning, ear-splitting score files.
15980 * Kill Files:: They are still here, but they can be ignored.
15981 * Converting Kill Files:: Translating kill files to score files.
15982 * GroupLens:: Getting predictions on what you like to read.
15983 * Advanced Scoring:: Using logical expressions to build score rules.
15984 * Score Decays:: It can be useful to let scores wither away.
15988 @node Summary Score Commands
15989 @section Summary Score Commands
15990 @cindex score commands
15992 The score commands that alter score entries do not actually modify real
15993 score files. That would be too inefficient. Gnus maintains a cache of
15994 previously loaded score files, one of which is considered the
15995 @dfn{current score file alist}. The score commands simply insert
15996 entries into this list, and upon group exit, this list is saved.
15998 The current score file is by default the group's local score file, even
15999 if no such score file actually exists. To insert score commands into
16000 some other score file (e.g. @file{all.SCORE}), you must first make this
16001 score file the current one.
16003 General score commands that don't actually change the score file:
16008 @kindex V s (Summary)
16009 @findex gnus-summary-set-score
16010 Set the score of the current article (@code{gnus-summary-set-score}).
16013 @kindex V S (Summary)
16014 @findex gnus-summary-current-score
16015 Display the score of the current article
16016 (@code{gnus-summary-current-score}).
16019 @kindex V t (Summary)
16020 @findex gnus-score-find-trace
16021 Display all score rules that have been used on the current article
16022 (@code{gnus-score-find-trace}).
16025 @kindex V R (Summary)
16026 @findex gnus-summary-rescore
16027 Run the current summary through the scoring process
16028 (@code{gnus-summary-rescore}). This might be useful if you're playing
16029 around with your score files behind Gnus' back and want to see the
16030 effect you're having.
16033 @kindex V c (Summary)
16034 @findex gnus-score-change-score-file
16035 Make a different score file the current
16036 (@code{gnus-score-change-score-file}).
16039 @kindex V e (Summary)
16040 @findex gnus-score-edit-current-scores
16041 Edit the current score file (@code{gnus-score-edit-current-scores}).
16042 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
16046 @kindex V f (Summary)
16047 @findex gnus-score-edit-file
16048 Edit a score file and make this score file the current one
16049 (@code{gnus-score-edit-file}).
16052 @kindex V F (Summary)
16053 @findex gnus-score-flush-cache
16054 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
16055 after editing score files.
16058 @kindex V C (Summary)
16059 @findex gnus-score-customize
16060 Customize a score file in a visually pleasing manner
16061 (@code{gnus-score-customize}).
16065 The rest of these commands modify the local score file.
16070 @kindex V m (Summary)
16071 @findex gnus-score-set-mark-below
16072 Prompt for a score, and mark all articles with a score below this as
16073 read (@code{gnus-score-set-mark-below}).
16076 @kindex V x (Summary)
16077 @findex gnus-score-set-expunge-below
16078 Prompt for a score, and add a score rule to the current score file to
16079 expunge all articles below this score
16080 (@code{gnus-score-set-expunge-below}).
16083 The keystrokes for actually making score entries follow a very regular
16084 pattern, so there's no need to list all the commands. (Hundreds of
16087 @findex gnus-summary-increase-score
16088 @findex gnus-summary-lower-score
16092 The first key is either @kbd{I} (upper case i) for increasing the score
16093 or @kbd{L} for lowering the score.
16095 The second key says what header you want to score on. The following
16096 keys are available:
16100 Score on the author name.
16103 Score on the subject line.
16106 Score on the @code{Xref} line---i.e., the cross-posting line.
16109 Score on the @code{References} line.
16115 Score on the number of lines.
16118 Score on the @code{Message-ID} header.
16121 Score on followups---this matches the author name, and adds scores to
16122 the followups to this author. (Using this key leads to the creation of
16123 @file{ADAPT} files.)
16132 Score on thread. (Using this key leads to the creation of @file{ADAPT}
16138 The third key is the match type. Which match types are valid depends on
16139 what headers you are scoring on.
16151 Substring matching.
16154 Fuzzy matching (@pxref{Fuzzy Matching}).
16183 Greater than number.
16188 The fourth and final key says whether this is a temporary (i.e., expiring)
16189 score entry, or a permanent (i.e., non-expiring) score entry, or whether
16190 it is to be done immediately, without adding to the score file.
16194 Temporary score entry.
16197 Permanent score entry.
16200 Immediately scoring.
16205 So, let's say you want to increase the score on the current author with
16206 exact matching permanently: @kbd{I a e p}. If you want to lower the
16207 score based on the subject line, using substring matching, and make a
16208 temporary score entry: @kbd{L s s t}. Pretty easy.
16210 To make things a bit more complicated, there are shortcuts. If you use
16211 a capital letter on either the second or third keys, Gnus will use
16212 defaults for the remaining one or two keystrokes. The defaults are
16213 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
16214 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
16216 These functions take both the numerical prefix and the symbolic prefix
16217 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
16218 (or increase) the score of the article. A symbolic prefix of @code{a}
16219 says to use the @file{all.SCORE} file for the command instead of the
16220 current score file.
16222 @vindex gnus-score-mimic-keymap
16223 The @code{gnus-score-mimic-keymap} says whether these commands will
16224 pretend they are keymaps or not.
16227 @node Group Score Commands
16228 @section Group Score Commands
16229 @cindex group score commands
16231 There aren't many of these as yet, I'm afraid.
16236 @kindex W f (Group)
16237 @findex gnus-score-flush-cache
16238 Gnus maintains a cache of score alists to avoid having to reload them
16239 all the time. This command will flush the cache
16240 (@code{gnus-score-flush-cache}).
16244 You can do scoring from the command line by saying something like:
16246 @findex gnus-batch-score
16247 @cindex batch scoring
16249 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
16253 @node Score Variables
16254 @section Score Variables
16255 @cindex score variables
16259 @item gnus-use-scoring
16260 @vindex gnus-use-scoring
16261 If @code{nil}, Gnus will not check for score files, and will not, in
16262 general, do any score-related work. This is @code{t} by default.
16264 @item gnus-kill-killed
16265 @vindex gnus-kill-killed
16266 If this variable is @code{nil}, Gnus will never apply score files to
16267 articles that have already been through the kill process. While this
16268 may save you lots of time, it also means that if you apply a kill file
16269 to a group, and then change the kill file and want to run it over you
16270 group again to kill more articles, it won't work. You have to set this
16271 variable to @code{t} to do that. (It is @code{t} by default.)
16273 @item gnus-kill-files-directory
16274 @vindex gnus-kill-files-directory
16275 All kill and score files will be stored in this directory, which is
16276 initialized from the @code{SAVEDIR} environment variable by default.
16277 This is @file{~/News/} by default.
16279 @item gnus-score-file-suffix
16280 @vindex gnus-score-file-suffix
16281 Suffix to add to the group name to arrive at the score file name
16282 (@samp{SCORE} by default.)
16284 @item gnus-score-uncacheable-files
16285 @vindex gnus-score-uncacheable-files
16286 @cindex score cache
16287 All score files are normally cached to avoid excessive re-loading of
16288 score files. However, if this might make your Emacs grow big and
16289 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
16290 @file{all.SCORE}, while it might be a good idea to not cache
16291 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
16292 variable is @samp{ADAPT$} by default, so no adaptive score files will
16295 @item gnus-save-score
16296 @vindex gnus-save-score
16297 If you have really complicated score files, and do lots of batch
16298 scoring, then you might set this variable to @code{t}. This will make
16299 Gnus save the scores into the @file{.newsrc.eld} file.
16301 If you do not set this to @code{t}, then manual scores (like those set
16302 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
16303 across group visits.
16305 @item gnus-score-interactive-default-score
16306 @vindex gnus-score-interactive-default-score
16307 Score used by all the interactive raise/lower commands to raise/lower
16308 score with. Default is 1000, which may seem excessive, but this is to
16309 ensure that the adaptive scoring scheme gets enough room to play with.
16310 We don't want the small changes from the adaptive scoring to overwrite
16311 manually entered data.
16313 @item gnus-summary-default-score
16314 @vindex gnus-summary-default-score
16315 Default score of an article, which is 0 by default.
16317 @item gnus-summary-expunge-below
16318 @vindex gnus-summary-expunge-below
16319 Don't display the summary lines of articles that have scores lower than
16320 this variable. This is @code{nil} by default, which means that no
16321 articles will be hidden. This variable is local to the summary buffers,
16322 and has to be set from @code{gnus-summary-mode-hook}.
16324 @item gnus-score-over-mark
16325 @vindex gnus-score-over-mark
16326 Mark (in the third column) used for articles with a score over the
16327 default. Default is @samp{+}.
16329 @item gnus-score-below-mark
16330 @vindex gnus-score-below-mark
16331 Mark (in the third column) used for articles with a score below the
16332 default. Default is @samp{-}.
16334 @item gnus-score-find-score-files-function
16335 @vindex gnus-score-find-score-files-function
16336 Function used to find score files for the current group. This function
16337 is called with the name of the group as the argument.
16339 Predefined functions available are:
16342 @item gnus-score-find-single
16343 @findex gnus-score-find-single
16344 Only apply the group's own score file.
16346 @item gnus-score-find-bnews
16347 @findex gnus-score-find-bnews
16348 Apply all score files that match, using bnews syntax. This is the
16349 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
16350 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
16351 @file{gnu.all.SCORE} would all apply. In short, the instances of
16352 @samp{all} in the score file names are translated into @samp{.*}, and
16353 then a regexp match is done.
16355 This means that if you have some score entries that you want to apply to
16356 all groups, then you put those entries in the @file{all.SCORE} file.
16358 The score files are applied in a semi-random order, although Gnus will
16359 try to apply the more general score files before the more specific score
16360 files. It does this by looking at the number of elements in the score
16361 file names---discarding the @samp{all} elements.
16363 @item gnus-score-find-hierarchical
16364 @findex gnus-score-find-hierarchical
16365 Apply all score files from all the parent groups. This means that you
16366 can't have score files like @file{all.SCORE}, but you can have
16367 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
16371 This variable can also be a list of functions. In that case, all
16372 these functions will be called with the group name as argument, and
16373 all the returned lists of score files will be applied. These
16374 functions can also return lists of lists of score alists directly. In
16375 that case, the functions that return these non-file score alists
16376 should probably be placed before the ``real'' score file functions, to
16377 ensure that the last score file returned is the local score file.
16380 For example, to do hierarchical scoring but use a non-server-specific
16381 overall score file, you could use the value
16383 (list (lambda (group) ("all.SCORE"))
16384 'gnus-score-find-hierarchical)
16387 @item gnus-score-expiry-days
16388 @vindex gnus-score-expiry-days
16389 This variable says how many days should pass before an unused score file
16390 entry is expired. If this variable is @code{nil}, no score file entries
16391 are expired. It's 7 by default.
16393 @item gnus-update-score-entry-dates
16394 @vindex gnus-update-score-entry-dates
16395 If this variable is non-@code{nil}, matching score entries will have
16396 their dates updated. (This is how Gnus controls expiry---all
16397 non-matching entries will become too old while matching entries will
16398 stay fresh and young.) However, if you set this variable to @code{nil},
16399 even matching entries will grow old and will have to face that oh-so
16402 @item gnus-score-after-write-file-function
16403 @vindex gnus-score-after-write-file-function
16404 Function called with the name of the score file just written.
16406 @item gnus-score-thread-simplify
16407 @vindex gnus-score-thread-simplify
16408 If this variable is non-@code{nil}, article subjects will be simplified
16409 for subject scoring purposes in the same manner as with
16410 threading---according to the current value of
16411 gnus-simplify-subject-functions. If the scoring entry uses
16412 @code{substring} or @code{exact} matching, the match will also be
16413 simplified in this manner.
16418 @node Score File Format
16419 @section Score File Format
16420 @cindex score file format
16422 A score file is an @code{emacs-lisp} file that normally contains just a
16423 single form. Casual users are not expected to edit these files;
16424 everything can be changed from the summary buffer.
16426 Anyway, if you'd like to dig into it yourself, here's an example:
16430 ("Lars Ingebrigtsen" -10000)
16432 ("larsi\\|lmi" -50000 nil R))
16434 ("Ding is Badd" nil 728373))
16436 ("alt.politics" -1000 728372 s))
16441 (mark-and-expunge -10)
16445 (files "/hom/larsi/News/gnu.SCORE")
16446 (exclude-files "all.SCORE")
16447 (local (gnus-newsgroup-auto-expire t)
16448 (gnus-summary-make-false-root empty))
16452 This example demonstrates most score file elements. For a different
16453 approach, see @pxref{Advanced Scoring}.
16455 Even though this looks much like lisp code, nothing here is actually
16456 @code{eval}ed. The lisp reader is used to read this form, though, so it
16457 has to be valid syntactically, if not semantically.
16459 Six keys are supported by this alist:
16464 If the key is a string, it is the name of the header to perform the
16465 match on. Scoring can only be performed on these eight headers:
16466 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
16467 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
16468 these headers, there are three strings to tell Gnus to fetch the entire
16469 article and do the match on larger parts of the article: @code{Body}
16470 will perform the match on the body of the article, @code{Head} will
16471 perform the match on the head of the article, and @code{All} will
16472 perform the match on the entire article. Note that using any of these
16473 last three keys will slow down group entry @emph{considerably}. The
16474 final ``header'' you can score on is @code{Followup}. These score
16475 entries will result in new score entries being added for all follow-ups
16476 to articles that matches these score entries.
16478 Following this key is a arbitrary number of score entries, where each
16479 score entry has one to four elements.
16483 The first element is the @dfn{match element}. On most headers this will
16484 be a string, but on the Lines and Chars headers, this must be an
16488 If the second element is present, it should be a number---the @dfn{score
16489 element}. This number should be an integer in the neginf to posinf
16490 interval. This number is added to the score of the article if the match
16491 is successful. If this element is not present, the
16492 @code{gnus-score-interactive-default-score} number will be used
16493 instead. This is 1000 by default.
16496 If the third element is present, it should be a number---the @dfn{date
16497 element}. This date says when the last time this score entry matched,
16498 which provides a mechanism for expiring the score entries. It this
16499 element is not present, the score entry is permanent. The date is
16500 represented by the number of days since December 31, 1 BCE.
16503 If the fourth element is present, it should be a symbol---the @dfn{type
16504 element}. This element specifies what function should be used to see
16505 whether this score entry matches the article. What match types that can
16506 be used depends on what header you wish to perform the match on.
16509 @item From, Subject, References, Xref, Message-ID
16510 For most header types, there are the @code{r} and @code{R} (regexp), as
16511 well as @code{s} and @code{S} (substring) types, and @code{e} and
16512 @code{E} (exact match), and @code{w} (word match) types. If this
16513 element is not present, Gnus will assume that substring matching should
16514 be used. @code{R}, @code{S}, and @code{E} differ from the others in
16515 that the matches will be done in a case-sensitive manner. All these
16516 one-letter types are really just abbreviations for the @code{regexp},
16517 @code{string}, @code{exact}, and @code{word} types, which you can use
16518 instead, if you feel like.
16521 These two headers use different match types: @code{<}, @code{>},
16522 @code{=}, @code{>=} and @code{<=}.
16524 These predicates are true if
16527 (PREDICATE HEADER MATCH)
16530 evaluates to non-@code{nil}. For instance, the advanced match
16531 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
16538 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
16539 the match, we get the score added if the article has less than 4 lines.
16540 (It's easy to get confused and think it's the other way around. But
16541 it's not. I think.)
16543 When matching on @code{Lines}, be careful because some backends (like
16544 @code{nndir}) do not generate @code{Lines} header, so every article ends
16545 up being marked as having 0 lines. This can lead to strange results if
16546 you happen to lower score of the articles with few lines.
16549 For the Date header we have three kinda silly match types:
16550 @code{before}, @code{at} and @code{after}. I can't really imagine this
16551 ever being useful, but, like, it would feel kinda silly not to provide
16552 this function. Just in case. You never know. Better safe than sorry.
16553 Once burnt, twice shy. Don't judge a book by its cover. Never not have
16554 sex on a first date. (I have been told that at least one person, and I
16555 quote, ``found this function indispensable'', however.)
16559 A more useful match type is @code{regexp}. With it, you can match the
16560 date string using a regular expression. The date is normalized to
16561 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
16562 you want to match all articles that have been posted on April 1st in
16563 every year, you could use @samp{....0401.........} as a match string,
16564 for instance. (Note that the date is kept in its original time zone, so
16565 this will match articles that were posted when it was April 1st where
16566 the article was posted from. Time zones are such wholesome fun for the
16569 @item Head, Body, All
16570 These three match keys use the same match types as the @code{From} (etc)
16574 This match key is somewhat special, in that it will match the
16575 @code{From} header, and affect the score of not only the matching
16576 articles, but also all followups to the matching articles. This allows
16577 you e.g. increase the score of followups to your own articles, or
16578 decrease the score of followups to the articles of some known
16579 trouble-maker. Uses the same match types as the @code{From} header
16580 uses. (Using this match key will lead to creation of @file{ADAPT}
16584 This match key works along the same lines as the @code{Followup} match
16585 key. If you say that you want to score on a (sub-)thread started by an
16586 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
16587 match. This will add a new @samp{thread} match for each article that
16588 has @var{x} in its @code{References} header. (These new @samp{thread}
16589 matches will use the @code{Message-ID}s of these matching articles.)
16590 This will ensure that you can raise/lower the score of an entire thread,
16591 even though some articles in the thread may not have complete
16592 @code{References} headers. Note that using this may lead to
16593 undeterministic scores of the articles in the thread. (Using this match
16594 key will lead to creation of @file{ADAPT} files.)
16598 @cindex Score File Atoms
16600 The value of this entry should be a number. Any articles with a score
16601 lower than this number will be marked as read.
16604 The value of this entry should be a number. Any articles with a score
16605 lower than this number will be removed from the summary buffer.
16607 @item mark-and-expunge
16608 The value of this entry should be a number. Any articles with a score
16609 lower than this number will be marked as read and removed from the
16612 @item thread-mark-and-expunge
16613 The value of this entry should be a number. All articles that belong to
16614 a thread that has a total score below this number will be marked as read
16615 and removed from the summary buffer. @code{gnus-thread-score-function}
16616 says how to compute the total score for a thread.
16619 The value of this entry should be any number of file names. These files
16620 are assumed to be score files as well, and will be loaded the same way
16623 @item exclude-files
16624 The clue of this entry should be any number of files. These files will
16625 not be loaded, even though they would normally be so, for some reason or
16629 The value of this entry will be @code{eval}el. This element will be
16630 ignored when handling global score files.
16633 Read-only score files will not be updated or saved. Global score files
16634 should feature this atom (@pxref{Global Score Files}). (Note:
16635 @dfn{Global} here really means @dfn{global}; not your personal
16636 apply-to-all-groups score files.)
16639 The value of this entry should be a number. Articles that do not have
16640 parents will get this number added to their scores. Imagine you follow
16641 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
16642 will only follow a few of the threads, also want to see any new threads.
16644 You can do this with the following two score file entries:
16648 (mark-and-expunge -100)
16651 When you enter the group the first time, you will only see the new
16652 threads. You then raise the score of the threads that you find
16653 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
16654 rest. Next time you enter the group, you will see new articles in the
16655 interesting threads, plus any new threads.
16657 I.e.---the orphan score atom is for high-volume groups where a few
16658 interesting threads which can't be found automatically by ordinary
16659 scoring rules exist.
16662 This entry controls the adaptive scoring. If it is @code{t}, the
16663 default adaptive scoring rules will be used. If it is @code{ignore}, no
16664 adaptive scoring will be performed on this group. If it is a list, this
16665 list will be used as the adaptive scoring rules. If it isn't present,
16666 or is something other than @code{t} or @code{ignore}, the default
16667 adaptive scoring rules will be used. If you want to use adaptive
16668 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
16669 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
16670 not want adaptive scoring. If you only want adaptive scoring in a few
16671 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
16672 insert @code{(adapt t)} in the score files of the groups where you want
16676 All adaptive score entries will go to the file named by this entry. It
16677 will also be applied when entering the group. This atom might be handy
16678 if you want to adapt on several groups at once, using the same adaptive
16679 file for a number of groups.
16682 @cindex local variables
16683 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
16684 Each @var{var} will be made buffer-local to the current summary buffer,
16685 and set to the value specified. This is a convenient, if somewhat
16686 strange, way of setting variables in some groups if you don't like hooks
16687 much. Note that the @var{value} won't be evaluated.
16691 @node Score File Editing
16692 @section Score File Editing
16694 You normally enter all scoring commands from the summary buffer, but you
16695 might feel the urge to edit them by hand as well, so we've supplied you
16696 with a mode for that.
16698 It's simply a slightly customized @code{emacs-lisp} mode, with these
16699 additional commands:
16704 @kindex C-c C-c (Score)
16705 @findex gnus-score-edit-done
16706 Save the changes you have made and return to the summary buffer
16707 (@code{gnus-score-edit-done}).
16710 @kindex C-c C-d (Score)
16711 @findex gnus-score-edit-insert-date
16712 Insert the current date in numerical format
16713 (@code{gnus-score-edit-insert-date}). This is really the day number, if
16714 you were wondering.
16717 @kindex C-c C-p (Score)
16718 @findex gnus-score-pretty-print
16719 The adaptive score files are saved in an unformatted fashion. If you
16720 intend to read one of these files, you want to @dfn{pretty print} it
16721 first. This command (@code{gnus-score-pretty-print}) does that for
16726 Type @kbd{M-x gnus-score-mode} to use this mode.
16728 @vindex gnus-score-mode-hook
16729 @code{gnus-score-menu-hook} is run in score mode buffers.
16731 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
16732 e} to begin editing score files.
16735 @node Adaptive Scoring
16736 @section Adaptive Scoring
16737 @cindex adaptive scoring
16739 If all this scoring is getting you down, Gnus has a way of making it all
16740 happen automatically---as if by magic. Or rather, as if by artificial
16741 stupidity, to be precise.
16743 @vindex gnus-use-adaptive-scoring
16744 When you read an article, or mark an article as read, or kill an
16745 article, you leave marks behind. On exit from the group, Gnus can sniff
16746 these marks and add score elements depending on what marks it finds.
16747 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
16748 @code{t} or @code{(line)}. If you want score adaptively on separate
16749 words appearing in the subjects, you should set this variable to
16750 @code{(word)}. If you want to use both adaptive methods, set this
16751 variable to @code{(word line)}.
16753 @vindex gnus-default-adaptive-score-alist
16754 To give you complete control over the scoring process, you can customize
16755 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
16756 might look something like this:
16759 (setq gnus-default-adaptive-score-alist
16760 '((gnus-unread-mark)
16761 (gnus-ticked-mark (from 4))
16762 (gnus-dormant-mark (from 5))
16763 (gnus-del-mark (from -4) (subject -1))
16764 (gnus-read-mark (from 4) (subject 2))
16765 (gnus-expirable-mark (from -1) (subject -1))
16766 (gnus-killed-mark (from -1) (subject -3))
16767 (gnus-kill-file-mark)
16768 (gnus-ancient-mark)
16769 (gnus-low-score-mark)
16770 (gnus-catchup-mark (from -1) (subject -1))))
16773 As you see, each element in this alist has a mark as a key (either a
16774 variable name or a ``real'' mark---a character). Following this key is
16775 a arbitrary number of header/score pairs. If there are no header/score
16776 pairs following the key, no adaptive scoring will be done on articles
16777 that have that key as the article mark. For instance, articles with
16778 @code{gnus-unread-mark} in the example above will not get adaptive score
16781 Each article can have only one mark, so just a single of these rules
16782 will be applied to each article.
16784 To take @code{gnus-del-mark} as an example---this alist says that all
16785 articles that have that mark (i.e., are marked with @samp{D}) will have a
16786 score entry added to lower based on the @code{From} header by -4, and
16787 lowered by @code{Subject} by -1. Change this to fit your prejudices.
16789 If you have marked 10 articles with the same subject with
16790 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
16791 That means that that subject will get a score of ten times -1, which
16792 should be, unless I'm much mistaken, -10.
16794 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
16795 the read articles will be marked with the @samp{E} mark. This'll
16796 probably make adaptive scoring slightly impossible, so auto-expiring and
16797 adaptive scoring doesn't really mix very well.
16799 The headers you can score on are @code{from}, @code{subject},
16800 @code{message-id}, @code{references}, @code{xref}, @code{lines},
16801 @code{chars} and @code{date}. In addition, you can score on
16802 @code{followup}, which will create an adaptive score entry that matches
16803 on the @code{References} header using the @code{Message-ID} of the
16804 current article, thereby matching the following thread.
16806 You can also score on @code{thread}, which will try to score all
16807 articles that appear in a thread. @code{thread} matches uses a
16808 @code{Message-ID} to match on the @code{References} header of the
16809 article. If the match is made, the @code{Message-ID} of the article is
16810 added to the @code{thread} rule. (Think about it. I'd recommend two
16811 aspirins afterwards.)
16813 If you use this scheme, you should set the score file atom @code{mark}
16814 to something small---like -300, perhaps, to avoid having small random
16815 changes result in articles getting marked as read.
16817 After using adaptive scoring for a week or so, Gnus should start to
16818 become properly trained and enhance the authors you like best, and kill
16819 the authors you like least, without you having to say so explicitly.
16821 You can control what groups the adaptive scoring is to be performed on
16822 by using the score files (@pxref{Score File Format}). This will also
16823 let you use different rules in different groups.
16825 @vindex gnus-adaptive-file-suffix
16826 The adaptive score entries will be put into a file where the name is the
16827 group name with @code{gnus-adaptive-file-suffix} appended. The default
16830 @vindex gnus-score-exact-adapt-limit
16831 When doing adaptive scoring, substring or fuzzy matching would probably
16832 give you the best results in most cases. However, if the header one
16833 matches is short, the possibility for false positives is great, so if
16834 the length of the match is less than
16835 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
16836 this variable is @code{nil}, exact matching will always be used to avoid
16839 @vindex gnus-default-adaptive-word-score-alist
16840 As mentioned above, you can adapt either on individual words or entire
16841 headers. If you adapt on words, the
16842 @code{gnus-default-adaptive-word-score-alist} variable says what score
16843 each instance of a word should add given a mark.
16846 (setq gnus-default-adaptive-word-score-alist
16847 `((,gnus-read-mark . 30)
16848 (,gnus-catchup-mark . -10)
16849 (,gnus-killed-mark . -20)
16850 (,gnus-del-mark . -15)))
16853 This is the default value. If you have adaption on words enabled, every
16854 word that appears in subjects of articles marked with
16855 @code{gnus-read-mark} will result in a score rule that increase the
16856 score with 30 points.
16858 @vindex gnus-default-ignored-adaptive-words
16859 @vindex gnus-ignored-adaptive-words
16860 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
16861 will be ignored. If you wish to add more words to be ignored, use the
16862 @code{gnus-ignored-adaptive-words} list instead.
16864 @vindex gnus-adaptive-word-length-limit
16865 Some may feel that short words shouldn't count when doing adaptive
16866 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
16867 an integer. Words shorter than this number will be ignored. This
16868 variable defaults til @code{nil}.
16870 @vindex gnus-adaptive-word-syntax-table
16871 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
16872 syntax table in effect. It is similar to the standard syntax table, but
16873 it considers numbers to be non-word-constituent characters.
16875 @vindex gnus-adaptive-word-minimum
16876 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
16877 word scoring process will never bring down the score of an article to
16878 below this number. The default is @code{nil}.
16880 @vindex gnus-adaptive-word-no-group-words
16881 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
16882 won't adaptively word score any of the words in the group name. Useful
16883 for groups like @samp{comp.editors.emacs}, where most of the subject
16884 lines contain the word @samp{emacs}.
16886 After using this scheme for a while, it might be nice to write a
16887 @code{gnus-psychoanalyze-user} command to go through the rules and see
16888 what words you like and what words you don't like. Or perhaps not.
16890 Note that the adaptive word scoring thing is highly experimental and is
16891 likely to change in the future. Initial impressions seem to indicate
16892 that it's totally useless as it stands. Some more work (involving more
16893 rigorous statistical methods) will have to be done to make this useful.
16896 @node Home Score File
16897 @section Home Score File
16899 The score file where new score file entries will go is called the
16900 @dfn{home score file}. This is normally (and by default) the score file
16901 for the group itself. For instance, the home score file for
16902 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
16904 However, this may not be what you want. It is often convenient to share
16905 a common home score file among many groups---all @samp{emacs} groups
16906 could perhaps use the same home score file.
16908 @vindex gnus-home-score-file
16909 The variable that controls this is @code{gnus-home-score-file}. It can
16914 A string. Then this file will be used as the home score file for all
16918 A function. The result of this function will be used as the home score
16919 file. The function will be called with the name of the group as the
16923 A list. The elements in this list can be:
16927 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
16928 group name, the @var{file-name} will be used as the home score file.
16931 A function. If the function returns non-nil, the result will be used as
16932 the home score file.
16935 A string. Use the string as the home score file.
16938 The list will be traversed from the beginning towards the end looking
16943 So, if you want to use just a single score file, you could say:
16946 (setq gnus-home-score-file
16947 "my-total-score-file.SCORE")
16950 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
16951 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
16953 @findex gnus-hierarchial-home-score-file
16955 (setq gnus-home-score-file
16956 'gnus-hierarchial-home-score-file)
16959 This is a ready-made function provided for your convenience.
16960 Other functions include
16963 @item gnus-current-home-score-file
16964 @findex gnus-current-home-score-file
16965 Return the ``current'' regular score file. This will make scoring
16966 commands add entry to the ``innermost'' matching score file.
16970 If you want to have one score file for the @samp{emacs} groups and
16971 another for the @samp{comp} groups, while letting all other groups use
16972 their own home score files:
16975 (setq gnus-home-score-file
16976 ;; All groups that match the regexp "\\.emacs"
16977 '(("\\.emacs" "emacs.SCORE")
16978 ;; All the comp groups in one score file
16979 ("^comp" "comp.SCORE")))
16982 @vindex gnus-home-adapt-file
16983 @code{gnus-home-adapt-file} works exactly the same way as
16984 @code{gnus-home-score-file}, but says what the home adaptive score file
16985 is instead. All new adaptive file entries will go into the file
16986 specified by this variable, and the same syntax is allowed.
16988 In addition to using @code{gnus-home-score-file} and
16989 @code{gnus-home-adapt-file}, you can also use group parameters
16990 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
16991 Parameters}) to achieve much the same. Group and topic parameters take
16992 precedence over this variable.
16995 @node Followups To Yourself
16996 @section Followups To Yourself
16998 Gnus offers two commands for picking out the @code{Message-ID} header in
16999 the current buffer. Gnus will then add a score rule that scores using
17000 this @code{Message-ID} on the @code{References} header of other
17001 articles. This will, in effect, increase the score of all articles that
17002 respond to the article in the current buffer. Quite useful if you want
17003 to easily note when people answer what you've said.
17007 @item gnus-score-followup-article
17008 @findex gnus-score-followup-article
17009 This will add a score to articles that directly follow up your own
17012 @item gnus-score-followup-thread
17013 @findex gnus-score-followup-thread
17014 This will add a score to all articles that appear in a thread ``below''
17018 @vindex message-sent-hook
17019 These two functions are both primarily meant to be used in hooks like
17020 @code{message-sent-hook}, like this:
17022 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
17026 If you look closely at your own @code{Message-ID}, you'll notice that
17027 the first two or three characters are always the same. Here's two of
17031 <x6u3u47icf.fsf@@eyesore.no>
17032 <x6sp9o7ibw.fsf@@eyesore.no>
17035 So ``my'' ident on this machine is @samp{x6}. This can be
17036 exploited---the following rule will raise the score on all followups to
17041 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
17045 Whether it's the first two or first three characters that are ``yours''
17046 is system-dependent.
17049 @node Scoring On Other Headers
17050 @section Scoring On Other Headers
17051 @cindex scoring on other headers
17053 Gnus is quite fast when scoring the ``traditional''
17054 headers---@samp{From}, @samp{Subject} and so on. However, scoring
17055 other headers requires writing a @code{head} scoring rule, which means
17056 that Gnus has to request every single article from the backend to find
17057 matches. This takes a long time in big groups.
17059 Now, there's not much you can do about this for news groups, but for
17060 mail groups, you have greater control. In the @pxref{To From
17061 Newsgroups} section of the manual, it's explained in greater detail what
17062 this mechanism does, but here's a cookbook example for @code{nnml} on
17063 how to allow scoring on the @samp{To} and @samp{Cc} headers.
17065 Put the following in your @file{.gnus.el} file.
17068 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
17069 nnmail-extra-headers gnus-extra-headers)
17072 Restart Gnus and rebuild your @code{nnml} overview files with the
17073 @kbd{M-x nnml-generate-nov-databases} command. This will take a long
17074 time if you have much mail.
17076 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
17077 so: @kbd{I e s p To RET <your name> RET}.
17083 @section Scoring Tips
17084 @cindex scoring tips
17090 @cindex scoring crossposts
17091 If you want to lower the score of crossposts, the line to match on is
17092 the @code{Xref} header.
17094 ("xref" (" talk.politics.misc:" -1000))
17097 @item Multiple crossposts
17098 If you want to lower the score of articles that have been crossposted to
17099 more than, say, 3 groups:
17102 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
17106 @item Matching on the body
17107 This is generally not a very good idea---it takes a very long time.
17108 Gnus actually has to fetch each individual article from the server. But
17109 you might want to anyway, I guess. Even though there are three match
17110 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
17111 and stick with it in each score file. If you use any two, each article
17112 will be fetched @emph{twice}. If you want to match a bit on the
17113 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
17116 @item Marking as read
17117 You will probably want to mark articles that have scores below a certain
17118 number as read. This is most easily achieved by putting the following
17119 in your @file{all.SCORE} file:
17123 You may also consider doing something similar with @code{expunge}.
17125 @item Negated character classes
17126 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
17127 That will match newlines, which might lead to, well, The Unknown. Say
17128 @code{[^abcd\n]*} instead.
17132 @node Reverse Scoring
17133 @section Reverse Scoring
17134 @cindex reverse scoring
17136 If you want to keep just articles that have @samp{Sex with Emacs} in the
17137 subject header, and expunge all other articles, you could put something
17138 like this in your score file:
17142 ("Sex with Emacs" 2))
17147 So, you raise all articles that match @samp{Sex with Emacs} and mark the
17148 rest as read, and expunge them to boot.
17151 @node Global Score Files
17152 @section Global Score Files
17153 @cindex global score files
17155 Sure, other newsreaders have ``global kill files''. These are usually
17156 nothing more than a single kill file that applies to all groups, stored
17157 in the user's home directory. Bah! Puny, weak newsreaders!
17159 What I'm talking about here are Global Score Files. Score files from
17160 all over the world, from users everywhere, uniting all nations in one
17161 big, happy score file union! Ange-score! New and untested!
17163 @vindex gnus-global-score-files
17164 All you have to do to use other people's score files is to set the
17165 @code{gnus-global-score-files} variable. One entry for each score file,
17166 or each score file directory. Gnus will decide by itself what score
17167 files are applicable to which group.
17169 To use the score file
17170 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
17171 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
17175 (setq gnus-global-score-files
17176 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
17177 "/ftp@@ftp.some-where:/pub/score/"))
17180 @findex gnus-score-search-global-directories
17182 Simple, eh? Directory names must end with a @samp{/}. These
17183 directories are typically scanned only once during each Gnus session.
17184 If you feel the need to manually re-scan the remote directories, you can
17185 use the @code{gnus-score-search-global-directories} command.
17187 Note that, at present, using this option will slow down group entry
17188 somewhat. (That is---a lot.)
17190 If you want to start maintaining score files for other people to use,
17191 just put your score file up for anonymous ftp and announce it to the
17192 world. Become a retro-moderator! Participate in the retro-moderator
17193 wars sure to ensue, where retro-moderators battle it out for the
17194 sympathy of the people, luring them to use their score files on false
17195 premises! Yay! The net is saved!
17197 Here are some tips for the would-be retro-moderator, off the top of my
17203 Articles heavily crossposted are probably junk.
17205 To lower a single inappropriate article, lower by @code{Message-ID}.
17207 Particularly brilliant authors can be raised on a permanent basis.
17209 Authors that repeatedly post off-charter for the group can safely be
17210 lowered out of existence.
17212 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
17213 articles completely.
17216 Use expiring score entries to keep the size of the file down. You
17217 should probably have a long expiry period, though, as some sites keep
17218 old articles for a long time.
17221 ... I wonder whether other newsreaders will support global score files
17222 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
17223 Wave, xrn and 1stReader are bound to implement scoring. Should we start
17224 holding our breath yet?
17228 @section Kill Files
17231 Gnus still supports those pesky old kill files. In fact, the kill file
17232 entries can now be expiring, which is something I wrote before Daniel
17233 Quinlan thought of doing score files, so I've left the code in there.
17235 In short, kill processing is a lot slower (and I do mean @emph{a lot})
17236 than score processing, so it might be a good idea to rewrite your kill
17237 files into score files.
17239 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
17240 forms into this file, which means that you can use kill files as some
17241 sort of primitive hook function to be run on group entry, even though
17242 that isn't a very good idea.
17244 Normal kill files look like this:
17247 (gnus-kill "From" "Lars Ingebrigtsen")
17248 (gnus-kill "Subject" "ding")
17252 This will mark every article written by me as read, and remove the
17253 marked articles from the summary buffer. Very useful, you'll agree.
17255 Other programs use a totally different kill file syntax. If Gnus
17256 encounters what looks like a @code{rn} kill file, it will take a stab at
17259 Two summary functions for editing a GNUS kill file:
17264 @kindex M-k (Summary)
17265 @findex gnus-summary-edit-local-kill
17266 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
17269 @kindex M-K (Summary)
17270 @findex gnus-summary-edit-global-kill
17271 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
17274 Two group mode functions for editing the kill files:
17279 @kindex M-k (Group)
17280 @findex gnus-group-edit-local-kill
17281 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
17284 @kindex M-K (Group)
17285 @findex gnus-group-edit-global-kill
17286 Edit the general kill file (@code{gnus-group-edit-global-kill}).
17289 Kill file variables:
17292 @item gnus-kill-file-name
17293 @vindex gnus-kill-file-name
17294 A kill file for the group @samp{soc.motss} is normally called
17295 @file{soc.motss.KILL}. The suffix appended to the group name to get
17296 this file name is detailed by the @code{gnus-kill-file-name} variable.
17297 The ``global'' kill file (not in the score file sense of ``global'', of
17298 course) is just called @file{KILL}.
17300 @vindex gnus-kill-save-kill-file
17301 @item gnus-kill-save-kill-file
17302 If this variable is non-@code{nil}, Gnus will save the
17303 kill file after processing, which is necessary if you use expiring
17306 @item gnus-apply-kill-hook
17307 @vindex gnus-apply-kill-hook
17308 @findex gnus-apply-kill-file-unless-scored
17309 @findex gnus-apply-kill-file
17310 A hook called to apply kill files to a group. It is
17311 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
17312 kill file if you have a score file for the same group, you can set this
17313 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
17314 kill files to be processed, you should set this variable to @code{nil}.
17316 @item gnus-kill-file-mode-hook
17317 @vindex gnus-kill-file-mode-hook
17318 A hook called in kill-file mode buffers.
17323 @node Converting Kill Files
17324 @section Converting Kill Files
17326 @cindex converting kill files
17328 If you have loads of old kill files, you may want to convert them into
17329 score files. If they are ``regular'', you can use
17330 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
17333 The kill to score conversion package isn't included in Gnus by default.
17334 You can fetch it from
17335 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
17337 If your old kill files are very complex---if they contain more
17338 non-@code{gnus-kill} forms than not, you'll have to convert them by
17339 hand. Or just let them be as they are. Gnus will still use them as
17347 GroupLens is a collaborative filtering system that helps you work
17348 together with other people to find the quality news articles out of the
17349 huge volume of news articles generated every day.
17351 To accomplish this the GroupLens system combines your opinions about
17352 articles you have already read with the opinions of others who have done
17353 likewise and gives you a personalized prediction for each unread news
17354 article. Think of GroupLens as a matchmaker. GroupLens watches how you
17355 rate articles, and finds other people that rate articles the same way.
17356 Once it has found some people you agree with it tells you, in the form
17357 of a prediction, what they thought of the article. You can use this
17358 prediction to help you decide whether or not you want to read the
17362 * Using GroupLens:: How to make Gnus use GroupLens.
17363 * Rating Articles:: Letting GroupLens know how you rate articles.
17364 * Displaying Predictions:: Displaying predictions given by GroupLens.
17365 * GroupLens Variables:: Customizing GroupLens.
17369 @node Using GroupLens
17370 @subsection Using GroupLens
17372 To use GroupLens you must register a pseudonym with your local Better
17374 @uref{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
17375 better bit in town at the moment.
17377 Once you have registered you'll need to set a couple of variables.
17381 @item gnus-use-grouplens
17382 @vindex gnus-use-grouplens
17383 Setting this variable to a non-@code{nil} value will make Gnus hook into
17384 all the relevant GroupLens functions.
17386 @item grouplens-pseudonym
17387 @vindex grouplens-pseudonym
17388 This variable should be set to the pseudonym you got when registering
17389 with the Better Bit Bureau.
17391 @item grouplens-newsgroups
17392 @vindex grouplens-newsgroups
17393 A list of groups that you want to get GroupLens predictions for.
17397 That's the minimum of what you need to get up and running with GroupLens.
17398 Once you've registered, GroupLens will start giving you scores for
17399 articles based on the average of what other people think. But, to get
17400 the real benefit of GroupLens you need to start rating articles
17401 yourself. Then the scores GroupLens gives you will be personalized for
17402 you, based on how the people you usually agree with have already rated.
17405 @node Rating Articles
17406 @subsection Rating Articles
17408 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
17409 Where 1 means something like this article is a waste of bandwidth and 5
17410 means that the article was really good. The basic question to ask
17411 yourself is, "on a scale from 1 to 5 would I like to see more articles
17414 There are four ways to enter a rating for an article in GroupLens.
17419 @kindex r (GroupLens)
17420 @findex bbb-summary-rate-article
17421 This function will prompt you for a rating on a scale of one to five.
17424 @kindex k (GroupLens)
17425 @findex grouplens-score-thread
17426 This function will prompt you for a rating, and rate all the articles in
17427 the thread. This is really useful for some of those long running giant
17428 threads in rec.humor.
17432 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
17433 the score of the article you're reading.
17438 @kindex n (GroupLens)
17439 @findex grouplens-next-unread-article
17440 Rate the article and go to the next unread article.
17443 @kindex , (GroupLens)
17444 @findex grouplens-best-unread-article
17445 Rate the article and go to the next unread article with the highest score.
17449 If you want to give the current article a score of 4 and then go to the
17450 next article, just type @kbd{4 n}.
17453 @node Displaying Predictions
17454 @subsection Displaying Predictions
17456 GroupLens makes a prediction for you about how much you will like a
17457 news article. The predictions from GroupLens are on a scale from 1 to
17458 5, where 1 is the worst and 5 is the best. You can use the predictions
17459 from GroupLens in one of three ways controlled by the variable
17460 @code{gnus-grouplens-override-scoring}.
17462 @vindex gnus-grouplens-override-scoring
17463 There are three ways to display predictions in grouplens. You may
17464 choose to have the GroupLens scores contribute to, or override the
17465 regular gnus scoring mechanism. override is the default; however, some
17466 people prefer to see the Gnus scores plus the grouplens scores. To get
17467 the separate scoring behavior you need to set
17468 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
17469 GroupLens predictions combined with the grouplens scores set it to
17470 @code{'override} and to combine the scores set
17471 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
17472 the combine option you will also want to set the values for
17473 @code{grouplens-prediction-offset} and
17474 @code{grouplens-score-scale-factor}.
17476 @vindex grouplens-prediction-display
17477 In either case, GroupLens gives you a few choices for how you would like
17478 to see your predictions displayed. The display of predictions is
17479 controlled by the @code{grouplens-prediction-display} variable.
17481 The following are valid values for that variable.
17484 @item prediction-spot
17485 The higher the prediction, the further to the right an @samp{*} is
17488 @item confidence-interval
17489 A numeric confidence interval.
17491 @item prediction-bar
17492 The higher the prediction, the longer the bar.
17494 @item confidence-bar
17495 Numerical confidence.
17497 @item confidence-spot
17498 The spot gets bigger with more confidence.
17500 @item prediction-num
17501 Plain-old numeric value.
17503 @item confidence-plus-minus
17504 Prediction +/- confidence.
17509 @node GroupLens Variables
17510 @subsection GroupLens Variables
17514 @item gnus-summary-grouplens-line-format
17515 The summary line format used in GroupLens-enhanced summary buffers. It
17516 accepts the same specs as the normal summary line format (@pxref{Summary
17517 Buffer Lines}). The default is @samp{%U%R%z%l%I%(%[%4L: %-23,23n%]%)
17520 @item grouplens-bbb-host
17521 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
17524 @item grouplens-bbb-port
17525 Port of the host running the bbbd server. The default is 9000.
17527 @item grouplens-score-offset
17528 Offset the prediction by this value. In other words, subtract the
17529 prediction value by this number to arrive at the effective score. The
17532 @item grouplens-score-scale-factor
17533 This variable allows the user to magnify the effect of GroupLens scores.
17534 The scale factor is applied after the offset. The default is 1.
17539 @node Advanced Scoring
17540 @section Advanced Scoring
17542 Scoring on Subjects and From headers is nice enough, but what if you're
17543 really interested in what a person has to say only when she's talking
17544 about a particular subject? Or what if you really don't want to
17545 read what person A has to say when she's following up to person B, but
17546 want to read what she says when she's following up to person C?
17548 By using advanced scoring rules you may create arbitrarily complex
17552 * Advanced Scoring Syntax:: A definition.
17553 * Advanced Scoring Examples:: What they look like.
17554 * Advanced Scoring Tips:: Getting the most out of it.
17558 @node Advanced Scoring Syntax
17559 @subsection Advanced Scoring Syntax
17561 Ordinary scoring rules have a string as the first element in the rule.
17562 Advanced scoring rules have a list as the first element. The second
17563 element is the score to be applied if the first element evaluated to a
17564 non-@code{nil} value.
17566 These lists may consist of three logical operators, one redirection
17567 operator, and various match operators.
17574 This logical operator will evaluate each of its arguments until it finds
17575 one that evaluates to @code{false}, and then it'll stop. If all arguments
17576 evaluate to @code{true} values, then this operator will return
17581 This logical operator will evaluate each of its arguments until it finds
17582 one that evaluates to @code{true}. If no arguments are @code{true},
17583 then this operator will return @code{false}.
17588 This logical operator only takes a single argument. It returns the
17589 logical negation of the value of its argument.
17593 There is an @dfn{indirection operator} that will make its arguments
17594 apply to the ancestors of the current article being scored. For
17595 instance, @code{1-} will make score rules apply to the parent of the
17596 current article. @code{2-} will make score rules apply to the
17597 grandparent of the current article. Alternatively, you can write
17598 @code{^^}, where the number of @code{^}s (carets) says how far back into
17599 the ancestry you want to go.
17601 Finally, we have the match operators. These are the ones that do the
17602 real work. Match operators are header name strings followed by a match
17603 and a match type. A typical match operator looks like @samp{("from"
17604 "Lars Ingebrigtsen" s)}. The header names are the same as when using
17605 simple scoring, and the match types are also the same.
17608 @node Advanced Scoring Examples
17609 @subsection Advanced Scoring Examples
17611 Let's say you want to increase the score of articles written by Lars
17612 when he's talking about Gnus:
17616 ("from" "Lars Ingebrigtsen")
17617 ("subject" "Gnus"))
17623 When he writes long articles, he sometimes has something nice to say:
17627 ("from" "Lars Ingebrigtsen")
17634 However, when he responds to things written by Reig Eigil Logge, you
17635 really don't want to read what he's written:
17639 ("from" "Lars Ingebrigtsen")
17640 (1- ("from" "Reig Eigir Logge")))
17644 Everybody that follows up Redmondo when he writes about disappearing
17645 socks should have their scores raised, but only when they talk about
17646 white socks. However, when Lars talks about socks, it's usually not
17653 ("from" "redmondo@@.*no" r)
17654 ("body" "disappearing.*socks" t)))
17655 (! ("from" "Lars Ingebrigtsen"))
17656 ("body" "white.*socks"))
17660 The possibilities are endless.
17663 @node Advanced Scoring Tips
17664 @subsection Advanced Scoring Tips
17666 The @code{&} and @code{|} logical operators do short-circuit logic.
17667 That is, they stop processing their arguments when it's clear what the
17668 result of the operation will be. For instance, if one of the arguments
17669 of an @code{&} evaluates to @code{false}, there's no point in evaluating
17670 the rest of the arguments. This means that you should put slow matches
17671 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
17672 @samp{subject}) first.
17674 The indirection arguments (@code{1-} and so on) will make their
17675 arguments work on previous generations of the thread. If you say
17686 Then that means "score on the from header of the grandparent of the
17687 current article". An indirection is quite fast, but it's better to say:
17693 ("subject" "Gnus")))
17700 (1- ("from" "Lars"))
17701 (1- ("subject" "Gnus")))
17706 @section Score Decays
17707 @cindex score decays
17710 You may find that your scores have a tendency to grow without
17711 bounds, especially if you're using adaptive scoring. If scores get too
17712 big, they lose all meaning---they simply max out and it's difficult to
17713 use them in any sensible way.
17715 @vindex gnus-decay-scores
17716 @findex gnus-decay-score
17717 @vindex gnus-decay-score-function
17718 Gnus provides a mechanism for decaying scores to help with this problem.
17719 When score files are loaded and @code{gnus-decay-scores} is
17720 non-@code{nil}, Gnus will run the score files through the decaying
17721 mechanism thereby lowering the scores of all non-permanent score rules.
17722 The decay itself if performed by the @code{gnus-decay-score-function}
17723 function, which is @code{gnus-decay-score} by default. Here's the
17724 definition of that function:
17727 (defun gnus-decay-score (score)
17729 This is done according to `gnus-score-decay-constant'
17730 and `gnus-score-decay-scale'."
17733 (* (if (< score 0) 1 -1)
17735 (max gnus-score-decay-constant
17737 gnus-score-decay-scale)))))))
17740 @vindex gnus-score-decay-scale
17741 @vindex gnus-score-decay-constant
17742 @code{gnus-score-decay-constant} is 3 by default and
17743 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
17747 Scores between -3 and 3 will be set to 0 when this function is called.
17750 Scores with magnitudes between 3 and 60 will be shrunk by 3.
17753 Scores with magnitudes greater than 60 will be shrunk by 5% of the
17757 If you don't like this decay function, write your own. It is called
17758 with the score to be decayed as its only parameter, and it should return
17759 the new score, which should be an integer.
17761 Gnus will try to decay scores once a day. If you haven't run Gnus for
17762 four days, Gnus will decay the scores four times, for instance.
17769 * Process/Prefix:: A convention used by many treatment commands.
17770 * Interactive:: Making Gnus ask you many questions.
17771 * Symbolic Prefixes:: How to supply some Gnus functions with options.
17772 * Formatting Variables:: You can specify what buffers should look like.
17773 * Window Layout:: Configuring the Gnus buffer windows.
17774 * Faces and Fonts:: How to change how faces look.
17775 * Compilation:: How to speed Gnus up.
17776 * Mode Lines:: Displaying information in the mode lines.
17777 * Highlighting and Menus:: Making buffers look all nice and cozy.
17778 * Buttons:: Get tendinitis in ten easy steps!
17779 * Daemons:: Gnus can do things behind your back.
17780 * NoCeM:: How to avoid spam and other fatty foods.
17781 * Undo:: Some actions can be undone.
17782 * Moderation:: What to do if you're a moderator.
17783 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
17784 * Fuzzy Matching:: What's the big fuzz?
17785 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
17786 * Various Various:: Things that are really various.
17790 @node Process/Prefix
17791 @section Process/Prefix
17792 @cindex process/prefix convention
17794 Many functions, among them functions for moving, decoding and saving
17795 articles, use what is known as the @dfn{Process/Prefix convention}.
17797 This is a method for figuring out what articles the user wants the
17798 command to be performed on.
17802 If the numeric prefix is N, perform the operation on the next N
17803 articles, starting with the current one. If the numeric prefix is
17804 negative, perform the operation on the previous N articles, starting
17805 with the current one.
17807 @vindex transient-mark-mode
17808 If @code{transient-mark-mode} in non-@code{nil} and the region is
17809 active, all articles in the region will be worked upon.
17811 If there is no numeric prefix, but some articles are marked with the
17812 process mark, perform the operation on the articles marked with
17815 If there is neither a numeric prefix nor any articles marked with the
17816 process mark, just perform the operation on the current article.
17818 Quite simple, really, but it needs to be made clear so that surprises
17821 Commands that react to the process mark will push the current list of
17822 process marked articles onto a stack and will then clear all process
17823 marked articles. You can restore the previous configuration with the
17824 @kbd{M P y} command (@pxref{Setting Process Marks}).
17826 @vindex gnus-summary-goto-unread
17827 One thing that seems to shock & horrify lots of people is that, for
17828 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
17829 Since each @kbd{d} (which marks the current article as read) by default
17830 goes to the next unread article after marking, this means that @kbd{3 d}
17831 will mark the next three unread articles as read, no matter what the
17832 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
17833 @code{nil} for a more straightforward action.
17835 Many commands do not use the process/prefix convention. All commands
17836 that do explicitly say so in this manual. To apply the process/prefix
17837 convention to commands that do not use it, you can use the @kbd{M-&}
17838 command. For instance, to mark all the articles in the group as
17839 expirable, you could say `M P b M-& E'.
17843 @section Interactive
17844 @cindex interaction
17848 @item gnus-novice-user
17849 @vindex gnus-novice-user
17850 If this variable is non-@code{nil}, you are either a newcomer to the
17851 World of Usenet, or you are very cautious, which is a nice thing to be,
17852 really. You will be given questions of the type ``Are you sure you want
17853 to do this?'' before doing anything dangerous. This is @code{t} by
17856 @item gnus-expert-user
17857 @vindex gnus-expert-user
17858 If this variable is non-@code{nil}, you will seldom be asked any
17859 questions by Gnus. It will simply assume you know what you're doing, no
17860 matter how strange.
17862 @item gnus-interactive-catchup
17863 @vindex gnus-interactive-catchup
17864 Require confirmation before catching up a group if non-@code{nil}. It
17865 is @code{t} by default.
17867 @item gnus-interactive-exit
17868 @vindex gnus-interactive-exit
17869 Require confirmation before exiting Gnus. This variable is @code{t} by
17874 @node Symbolic Prefixes
17875 @section Symbolic Prefixes
17876 @cindex symbolic prefixes
17878 Quite a lot of Emacs commands react to the (numeric) prefix. For
17879 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
17880 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
17881 rule of 900 to the current article.
17883 This is all nice and well, but what if you want to give a command some
17884 additional information? Well, what most commands do is interpret the
17885 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
17886 doesn't want a backup file to be created when saving the current buffer,
17887 for instance. But what if you want to save without making a backup
17888 file, and you want Emacs to flash lights and play a nice tune at the
17889 same time? You can't, and you're probably perfectly happy that way.
17891 @kindex M-i (Summary)
17892 @findex gnus-symbolic-argument
17893 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
17894 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
17895 character typed in is the value. You can stack as many @kbd{M-i}
17896 prefixes as you want. @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
17897 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b M-C-u} means
17898 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
17899 @code{b}''. You get the drift.
17901 Typing in symbolic prefixes to commands that don't accept them doesn't
17902 hurt, but it doesn't do any good either. Currently not many Gnus
17903 functions make use of the symbolic prefix.
17905 If you're interested in how Gnus implements this, @pxref{Extended
17909 @node Formatting Variables
17910 @section Formatting Variables
17911 @cindex formatting variables
17913 Throughout this manual you've probably noticed lots of variables called
17914 things like @code{gnus-group-line-format} and
17915 @code{gnus-summary-mode-line-format}. These control how Gnus is to
17916 output lines in the various buffers. There's quite a lot of them.
17917 Fortunately, they all use the same syntax, so there's not that much to
17920 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
17921 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
17922 lots of percentages everywhere.
17925 * Formatting Basics:: A formatting variable is basically a format string.
17926 * Mode Line Formatting:: Some rules about mode line formatting variables.
17927 * Advanced Formatting:: Modifying output in various ways.
17928 * User-Defined Specs:: Having Gnus call your own functions.
17929 * Formatting Fonts:: Making the formatting look colorful and nice.
17930 * Positioning Point:: Moving point to a position after an operation.
17931 * Tabulation:: Tabulating your output.
17932 * Wide Characters:: Dealing with wide characters.
17935 Currently Gnus uses the following formatting variables:
17936 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
17937 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
17938 @code{gnus-group-mode-line-format},
17939 @code{gnus-summary-mode-line-format},
17940 @code{gnus-article-mode-line-format},
17941 @code{gnus-server-mode-line-format}, and
17942 @code{gnus-summary-pick-line-format}.
17944 All these format variables can also be arbitrary elisp forms. In that
17945 case, they will be @code{eval}ed to insert the required lines.
17947 @kindex M-x gnus-update-format
17948 @findex gnus-update-format
17949 Gnus includes a command to help you while creating your own format
17950 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
17951 update the spec in question and pop you to a buffer where you can
17952 examine the resulting lisp code to be run to generate the line.
17956 @node Formatting Basics
17957 @subsection Formatting Basics
17959 Each @samp{%} element will be replaced by some string or other when the
17960 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
17961 spec, and pad with spaces to get a 5-character field''.
17963 As with normal C and Emacs Lisp formatting strings, the numerical
17964 modifier between the @samp{%} and the formatting type character will
17965 @dfn{pad} the output so that it is always at least that long.
17966 @samp{%5y} will make the field always (at least) five characters wide by
17967 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
17970 You may also wish to limit the length of the field to protect against
17971 particularly wide values. For that you can say @samp{%4,6y}, which
17972 means that the field will never be more than 6 characters wide and never
17973 less than 4 characters wide.
17976 @node Mode Line Formatting
17977 @subsection Mode Line Formatting
17979 Mode line formatting variables (e.g.,
17980 @code{gnus-summary-mode-line-format}) follow the same rules as other,
17981 buffer line oriented formatting variables (@pxref{Formatting Basics})
17982 with the following two differences:
17987 There must be no newline (@samp{\n}) at the end.
17990 The special @samp{%%b} spec can be used to display the buffer name.
17991 Well, it's no spec at all, really---@samp{%%} is just a way to quote
17992 @samp{%} to allow it to pass through the formatting machinery unmangled,
17993 so that Emacs receives @samp{%b}, which is something the Emacs mode line
17994 display interprets to mean ``show the buffer name''. For a full list of
17995 mode line specs Emacs understands, see the documentation of the
17996 @code{mode-line-format} variable.
18001 @node Advanced Formatting
18002 @subsection Advanced Formatting
18004 It is frequently useful to post-process the fields in some way.
18005 Padding, limiting, cutting off parts and suppressing certain values can
18006 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
18007 look like @samp{%~(cut 3)~(ignore "0")y}.
18009 These are the valid modifiers:
18014 Pad the field to the left with spaces until it reaches the required
18018 Pad the field to the right with spaces until it reaches the required
18023 Cut off characters from the left until it reaches the specified length.
18026 Cut off characters from the right until it reaches the specified
18031 Cut off the specified number of characters from the left.
18034 Cut off the specified number of characters from the right.
18037 Return an empty string if the field is equal to the specified value.
18040 Use the specified form as the field value when the @samp{@@} spec is
18044 Let's take an example. The @samp{%o} spec in the summary mode lines
18045 will return a date in compact ISO8601 format---@samp{19960809T230410}.
18046 This is quite a mouthful, so we want to shave off the century number and
18047 the time, leaving us with a six-character date. That would be
18048 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
18049 maxing, and we need the padding to ensure that the date is never less
18050 than 6 characters to make it look nice in columns.)
18052 Ignoring is done first; then cutting; then maxing; and then as the very
18053 last operation, padding.
18055 If you use lots of these advanced thingies, you'll find that Gnus gets
18056 quite slow. This can be helped enormously by running @kbd{M-x
18057 gnus-compile} when you are satisfied with the look of your lines.
18058 @xref{Compilation}.
18061 @node User-Defined Specs
18062 @subsection User-Defined Specs
18064 All the specs allow for inserting user defined specifiers---@samp{u}.
18065 The next character in the format string should be a letter. Gnus
18066 will call the function @code{gnus-user-format-function-}@samp{X}, where
18067 @samp{X} is the letter following @samp{%u}. The function will be passed
18068 a single parameter---what the parameter means depends on what buffer
18069 it's being called from. The function should return a string, which will
18070 be inserted into the buffer just like information from any other
18071 specifier. This function may also be called with dummy values, so it
18072 should protect against that.
18074 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
18075 much the same without defining new functions. Here's an example:
18076 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
18077 given here will be evaluated to yield the current line number, and then
18081 @node Formatting Fonts
18082 @subsection Formatting Fonts
18084 There are specs for highlighting, and these are shared by all the format
18085 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
18086 the special @code{mouse-face} property set, which means that it will be
18087 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
18090 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
18091 normal faces set using @code{gnus-face-0}, which is @code{bold} by
18092 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
18093 and so on. Create as many faces as you wish. The same goes for the
18094 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
18095 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
18097 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
18098 @code{balloon-help} property set to @code{gnus-balloon-face-0}. If you
18099 say @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The
18100 @code{gnus-balloon-face-*} variables should be either strings or symbols
18101 naming functions that return a string. Under @code{balloon-help-mode},
18102 when the mouse passes over text with this property set, a balloon window
18103 will appear and display the string. Please refer to the doc string of
18104 @code{balloon-help-mode} for more information on this.
18106 Here's an alternative recipe for the group buffer:
18109 ;; Create three face types.
18110 (setq gnus-face-1 'bold)
18111 (setq gnus-face-3 'italic)
18113 ;; We want the article count to be in
18114 ;; a bold and green face. So we create
18115 ;; a new face called `my-green-bold'.
18116 (copy-face 'bold 'my-green-bold)
18118 (set-face-foreground 'my-green-bold "ForestGreen")
18119 (setq gnus-face-2 'my-green-bold)
18121 ;; Set the new & fancy format.
18122 (setq gnus-group-line-format
18123 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
18126 I'm sure you'll be able to use this scheme to create totally unreadable
18127 and extremely vulgar displays. Have fun!
18129 Note that the @samp{%(} specs (and friends) do not make any sense on the
18130 mode-line variables.
18132 @node Positioning Point
18133 @subsection Positioning Point
18135 Gnus usually moves point to a pre-defined place on each line in most
18136 buffers. By default, point move to the first colon character on the
18137 line. You can customize this behaviour in three different ways.
18139 You can move the colon character to somewhere else on the line.
18141 @findex gnus-goto-colon
18142 You can redefine the function that moves the point to the colon. The
18143 function is called @code{gnus-goto-colon}.
18145 But perhaps the most convenient way to deal with this, if you don't want
18146 to have a colon in your line, is to use the @samp{%C} specifier. If you
18147 put a @samp{%C} somewhere in your format line definition, Gnus will
18152 @subsection Tabulation
18154 You can usually line up your displays by padding and cutting your
18155 strings. However, when combining various strings of different size, it
18156 can often be more convenient to just output the strings, and then worry
18157 about lining up the following text afterwards.
18159 To do that, Gnus supplies tabulator specs--@samp{%=}. There are two
18160 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
18162 @samp{%50=} will insert space characters to pad the line up to column
18163 50. If the text is already past column 50, nothing will be inserted.
18164 This is the soft tabulator.
18166 @samp{%-50=} will insert space characters to pad the line up to column
18167 50. If the text is already past column 50, the excess text past column
18168 50 will be removed. This is the hard tabulator.
18171 @node Wide Characters
18172 @subsection Wide Characters
18174 Proportional fonts in most countries have characters of the same width.
18175 Some countries, however, use Latin characters mixed with wider
18176 characters---most notable East Asian countries.
18178 The problem is that when formatting, Gnus assumes that if a string is 10
18179 characters wide, it'll be 10 Latin characters wide on the screen. In
18180 these coutries, that's not true.
18182 @vindex gnus-use-correct-string-widths
18183 To help fix this, you can set @code{gnus-use-correct-string-widths} to
18184 @code{t}. This makes buffer generation slower, but the results will be
18185 prettieer. The default value is @code{nil}.
18189 @node Window Layout
18190 @section Window Layout
18191 @cindex window layout
18193 No, there's nothing here about X, so be quiet.
18195 @vindex gnus-use-full-window
18196 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
18197 other windows and occupy the entire Emacs screen by itself. It is
18198 @code{t} by default.
18200 Setting this variable to @code{nil} kinda works, but there are
18201 glitches. Use at your own peril.
18203 @vindex gnus-buffer-configuration
18204 @code{gnus-buffer-configuration} describes how much space each Gnus
18205 buffer should be given. Here's an excerpt of this variable:
18208 ((group (vertical 1.0 (group 1.0 point)
18209 (if gnus-carpal (group-carpal 4))))
18210 (article (vertical 1.0 (summary 0.25 point)
18214 This is an alist. The @dfn{key} is a symbol that names some action or
18215 other. For instance, when displaying the group buffer, the window
18216 configuration function will use @code{group} as the key. A full list of
18217 possible names is listed below.
18219 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
18220 should occupy. To take the @code{article} split as an example -
18223 (article (vertical 1.0 (summary 0.25 point)
18227 This @dfn{split} says that the summary buffer should occupy 25% of upper
18228 half of the screen, and that it is placed over the article buffer. As
18229 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
18230 reaching for that calculator there). However, the special number
18231 @code{1.0} is used to signal that this buffer should soak up all the
18232 rest of the space available after the rest of the buffers have taken
18233 whatever they need. There should be only one buffer with the @code{1.0}
18234 size spec per split.
18236 Point will be put in the buffer that has the optional third element
18237 @code{point}. In a @code{frame} split, the last subsplit having a leaf
18238 split where the tag @code{frame-focus} is a member (i.e. is the third or
18239 fourth element in the list, depending on whether the @code{point} tag is
18240 present) gets focus.
18242 Here's a more complicated example:
18245 (article (vertical 1.0 (group 4)
18246 (summary 0.25 point)
18247 (if gnus-carpal (summary-carpal 4))
18251 If the size spec is an integer instead of a floating point number,
18252 then that number will be used to say how many lines a buffer should
18253 occupy, not a percentage.
18255 If the @dfn{split} looks like something that can be @code{eval}ed (to be
18256 precise---if the @code{car} of the split is a function or a subr), this
18257 split will be @code{eval}ed. If the result is non-@code{nil}, it will
18258 be used as a split. This means that there will be three buffers if
18259 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
18262 Not complicated enough for you? Well, try this on for size:
18265 (article (horizontal 1.0
18270 (summary 0.25 point)
18275 Whoops. Two buffers with the mystery 100% tag. And what's that
18276 @code{horizontal} thingie?
18278 If the first element in one of the split is @code{horizontal}, Gnus will
18279 split the window horizontally, giving you two windows side-by-side.
18280 Inside each of these strips you may carry on all you like in the normal
18281 fashion. The number following @code{horizontal} says what percentage of
18282 the screen is to be given to this strip.
18284 For each split, there @emph{must} be one element that has the 100% tag.
18285 The splitting is never accurate, and this buffer will eat any leftover
18286 lines from the splits.
18288 To be slightly more formal, here's a definition of what a valid split
18292 split = frame | horizontal | vertical | buffer | form
18293 frame = "(frame " size *split ")"
18294 horizontal = "(horizontal " size *split ")"
18295 vertical = "(vertical " size *split ")"
18296 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
18297 size = number | frame-params
18298 buf-name = group | article | summary ...
18301 The limitations are that the @code{frame} split can only appear as the
18302 top-level split. @var{form} should be an Emacs Lisp form that should
18303 return a valid split. We see that each split is fully recursive, and
18304 may contain any number of @code{vertical} and @code{horizontal} splits.
18306 @vindex gnus-window-min-width
18307 @vindex gnus-window-min-height
18308 @cindex window height
18309 @cindex window width
18310 Finding the right sizes can be a bit complicated. No window may be less
18311 than @code{gnus-window-min-height} (default 1) characters high, and all
18312 windows must be at least @code{gnus-window-min-width} (default 1)
18313 characters wide. Gnus will try to enforce this before applying the
18314 splits. If you want to use the normal Emacs window width/height limit,
18315 you can just set these two variables to @code{nil}.
18317 If you're not familiar with Emacs terminology, @code{horizontal} and
18318 @code{vertical} splits may work the opposite way of what you'd expect.
18319 Windows inside a @code{horizontal} split are shown side-by-side, and
18320 windows within a @code{vertical} split are shown above each other.
18322 @findex gnus-configure-frame
18323 If you want to experiment with window placement, a good tip is to call
18324 @code{gnus-configure-frame} directly with a split. This is the function
18325 that does all the real work when splitting buffers. Below is a pretty
18326 nonsensical configuration with 5 windows; two for the group buffer and
18327 three for the article buffer. (I said it was nonsensical.) If you
18328 @code{eval} the statement below, you can get an idea of how that would
18329 look straight away, without going through the normal Gnus channels.
18330 Play with it until you're satisfied, and then use
18331 @code{gnus-add-configuration} to add your new creation to the buffer
18332 configuration list.
18335 (gnus-configure-frame
18339 (article 0.3 point))
18347 You might want to have several frames as well. No prob---just use the
18348 @code{frame} split:
18351 (gnus-configure-frame
18354 (summary 0.25 point frame-focus)
18356 (vertical ((height . 5) (width . 15)
18357 (user-position . t)
18358 (left . -1) (top . 1))
18363 This split will result in the familiar summary/article window
18364 configuration in the first (or ``main'') frame, while a small additional
18365 frame will be created where picons will be shown. As you can see,
18366 instead of the normal @code{1.0} top-level spec, each additional split
18367 should have a frame parameter alist as the size spec.
18368 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
18369 Reference Manual}. Under XEmacs, a frame property list will be
18370 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
18372 The list of all possible keys for @code{gnus-buffer-configuration} can
18373 be found in its default value.
18375 Note that the @code{message} key is used for both
18376 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
18377 it is desirable to distinguish between the two, something like this
18381 (message (horizontal 1.0
18382 (vertical 1.0 (message 1.0 point))
18384 (if (buffer-live-p gnus-summary-buffer)
18389 One common desire for a multiple frame split is to have a separate frame
18390 for composing mail and news while leaving the original frame intact. To
18391 accomplish that, something like the following can be done:
18396 (if (not (buffer-live-p gnus-summary-buffer))
18397 (car (cdr (assoc 'group gnus-buffer-configuration)))
18398 (car (cdr (assoc 'summary gnus-buffer-configuration))))
18399 (vertical ((user-position . t) (top . 1) (left . 1)
18400 (name . "Message"))
18401 (message 1.0 point))))
18404 @findex gnus-add-configuration
18405 Since the @code{gnus-buffer-configuration} variable is so long and
18406 complicated, there's a function you can use to ease changing the config
18407 of a single setting: @code{gnus-add-configuration}. If, for instance,
18408 you want to change the @code{article} setting, you could say:
18411 (gnus-add-configuration
18412 '(article (vertical 1.0
18414 (summary .25 point)
18418 You'd typically stick these @code{gnus-add-configuration} calls in your
18419 @file{.gnus.el} file or in some startup hook---they should be run after
18420 Gnus has been loaded.
18422 @vindex gnus-always-force-window-configuration
18423 If all windows mentioned in the configuration are already visible, Gnus
18424 won't change the window configuration. If you always want to force the
18425 ``right'' window configuration, you can set
18426 @code{gnus-always-force-window-configuration} to non-@code{nil}.
18428 If you're using tree displays (@pxref{Tree Display}), and the tree
18429 window is displayed vertically next to another window, you may also want
18430 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
18433 @subsection Example Window Configurations
18437 Narrow left hand side occupied by group buffer. Right hand side split
18438 between summary buffer (top one-sixth) and article buffer (bottom).
18453 (gnus-add-configuration
18456 (vertical 25 (group 1.0))
18458 (summary 0.16 point)
18461 (gnus-add-configuration
18464 (vertical 25 (group 1.0))
18465 (vertical 1.0 (summary 1.0 point)))))
18471 @node Faces and Fonts
18472 @section Faces and Fonts
18477 Fiddling with fonts and faces used to be very difficult, but these days
18478 it is very simple. You simply say @kbd{M-x customize-face}, pick out
18479 the face you want to alter, and alter it via the standard Customize
18484 @section Compilation
18485 @cindex compilation
18486 @cindex byte-compilation
18488 @findex gnus-compile
18490 Remember all those line format specification variables?
18491 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
18492 on. Now, Gnus will of course heed whatever these variables are, but,
18493 unfortunately, changing them will mean a quite significant slow-down.
18494 (The default values of these variables have byte-compiled functions
18495 associated with them, while the user-generated versions do not, of
18498 To help with this, you can run @kbd{M-x gnus-compile} after you've
18499 fiddled around with the variables and feel that you're (kind of)
18500 satisfied. This will result in the new specs being byte-compiled, and
18501 you'll get top speed again. Gnus will save these compiled specs in the
18502 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
18503 this function, though---you should compile them yourself by sticking
18504 them into the @code{.gnus.el} file and byte-compiling that file.)
18508 @section Mode Lines
18511 @vindex gnus-updated-mode-lines
18512 @code{gnus-updated-mode-lines} says what buffers should keep their mode
18513 lines updated. It is a list of symbols. Supported symbols include
18514 @code{group}, @code{article}, @code{summary}, @code{server},
18515 @code{browse}, and @code{tree}. If the corresponding symbol is present,
18516 Gnus will keep that mode line updated with information that may be
18517 pertinent. If this variable is @code{nil}, screen refresh may be
18520 @cindex display-time
18522 @vindex gnus-mode-non-string-length
18523 By default, Gnus displays information on the current article in the mode
18524 lines of the summary and article buffers. The information Gnus wishes
18525 to display (e.g. the subject of the article) is often longer than the
18526 mode lines, and therefore have to be cut off at some point. The
18527 @code{gnus-mode-non-string-length} variable says how long the other
18528 elements on the line is (i.e., the non-info part). If you put
18529 additional elements on the mode line (e.g. a clock), you should modify
18532 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
18534 (add-hook 'display-time-hook
18535 (lambda () (setq gnus-mode-non-string-length
18537 (if line-number-mode 5 0)
18538 (if column-number-mode 4 0)
18539 (length display-time-string)))))
18542 If this variable is @code{nil} (which is the default), the mode line
18543 strings won't be chopped off, and they won't be padded either. Note
18544 that the default is unlikely to be desirable, as even the percentage
18545 complete in the buffer may be crowded off the mode line; the user should
18546 configure this variable appropriately for her configuration.
18549 @node Highlighting and Menus
18550 @section Highlighting and Menus
18552 @cindex highlighting
18555 @vindex gnus-visual
18556 The @code{gnus-visual} variable controls most of the Gnus-prettifying
18557 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
18558 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
18561 This variable can be a list of visual properties that are enabled. The
18562 following elements are valid, and are all included by default:
18565 @item group-highlight
18566 Do highlights in the group buffer.
18567 @item summary-highlight
18568 Do highlights in the summary buffer.
18569 @item article-highlight
18570 Do highlights in the article buffer.
18572 Turn on highlighting in all buffers.
18574 Create menus in the group buffer.
18576 Create menus in the summary buffers.
18578 Create menus in the article buffer.
18580 Create menus in the browse buffer.
18582 Create menus in the server buffer.
18584 Create menus in the score buffers.
18586 Create menus in all buffers.
18589 So if you only want highlighting in the article buffer and menus in all
18590 buffers, you could say something like:
18593 (setq gnus-visual '(article-highlight menu))
18596 If you want highlighting only and no menus whatsoever, you'd say:
18599 (setq gnus-visual '(highlight))
18602 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
18603 in all Gnus buffers.
18605 Other general variables that influence the look of all buffers include:
18608 @item gnus-mouse-face
18609 @vindex gnus-mouse-face
18610 This is the face (i.e., font) used for mouse highlighting in Gnus. No
18611 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
18615 There are hooks associated with the creation of all the different menus:
18619 @item gnus-article-menu-hook
18620 @vindex gnus-article-menu-hook
18621 Hook called after creating the article mode menu.
18623 @item gnus-group-menu-hook
18624 @vindex gnus-group-menu-hook
18625 Hook called after creating the group mode menu.
18627 @item gnus-summary-menu-hook
18628 @vindex gnus-summary-menu-hook
18629 Hook called after creating the summary mode menu.
18631 @item gnus-server-menu-hook
18632 @vindex gnus-server-menu-hook
18633 Hook called after creating the server mode menu.
18635 @item gnus-browse-menu-hook
18636 @vindex gnus-browse-menu-hook
18637 Hook called after creating the browse mode menu.
18639 @item gnus-score-menu-hook
18640 @vindex gnus-score-menu-hook
18641 Hook called after creating the score mode menu.
18652 Those new-fangled @dfn{mouse} contraptions is very popular with the
18653 young, hep kids who don't want to learn the proper way to do things
18654 these days. Why, I remember way back in the summer of '89, when I was
18655 using Emacs on a Tops 20 system. Three hundred users on one single
18656 machine, and every user was running Simula compilers. Bah!
18660 @vindex gnus-carpal
18661 Well, you can make Gnus display bufferfuls of buttons you can click to
18662 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
18663 really. Tell the chiropractor I sent you.
18668 @item gnus-carpal-mode-hook
18669 @vindex gnus-carpal-mode-hook
18670 Hook run in all carpal mode buffers.
18672 @item gnus-carpal-button-face
18673 @vindex gnus-carpal-button-face
18674 Face used on buttons.
18676 @item gnus-carpal-header-face
18677 @vindex gnus-carpal-header-face
18678 Face used on carpal buffer headers.
18680 @item gnus-carpal-group-buffer-buttons
18681 @vindex gnus-carpal-group-buffer-buttons
18682 Buttons in the group buffer.
18684 @item gnus-carpal-summary-buffer-buttons
18685 @vindex gnus-carpal-summary-buffer-buttons
18686 Buttons in the summary buffer.
18688 @item gnus-carpal-server-buffer-buttons
18689 @vindex gnus-carpal-server-buffer-buttons
18690 Buttons in the server buffer.
18692 @item gnus-carpal-browse-buffer-buttons
18693 @vindex gnus-carpal-browse-buffer-buttons
18694 Buttons in the browse buffer.
18697 All the @code{buttons} variables are lists. The elements in these list
18698 are either cons cells where the @code{car} contains a text to be displayed and
18699 the @code{cdr} contains a function symbol, or a simple string.
18707 Gnus, being larger than any program ever written (allegedly), does lots
18708 of strange stuff that you may wish to have done while you're not
18709 present. For instance, you may want it to check for new mail once in a
18710 while. Or you may want it to close down all connections to all servers
18711 when you leave Emacs idle. And stuff like that.
18713 Gnus will let you do stuff like that by defining various
18714 @dfn{handlers}. Each handler consists of three elements: A
18715 @var{function}, a @var{time}, and an @var{idle} parameter.
18717 Here's an example of a handler that closes connections when Emacs has
18718 been idle for thirty minutes:
18721 (gnus-demon-close-connections nil 30)
18724 Here's a handler that scans for PGP headers every hour when Emacs is
18728 (gnus-demon-scan-pgp 60 t)
18731 This @var{time} parameter and than @var{idle} parameter work together
18732 in a strange, but wonderful fashion. Basically, if @var{idle} is
18733 @code{nil}, then the function will be called every @var{time} minutes.
18735 If @var{idle} is @code{t}, then the function will be called after
18736 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
18737 the function will never be called. But once Emacs goes idle, the
18738 function will be called every @var{time} minutes.
18740 If @var{idle} is a number and @var{time} is a number, the function will
18741 be called every @var{time} minutes only when Emacs has been idle for
18742 @var{idle} minutes.
18744 If @var{idle} is a number and @var{time} is @code{nil}, the function
18745 will be called once every time Emacs has been idle for @var{idle}
18748 And if @var{time} is a string, it should look like @samp{07:31}, and
18749 the function will then be called once every day somewhere near that
18750 time. Modified by the @var{idle} parameter, of course.
18752 @vindex gnus-demon-timestep
18753 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
18754 seconds. This is 60 by default. If you change that variable,
18755 all the timings in the handlers will be affected.)
18757 So, if you want to add a handler, you could put something like this in
18758 your @file{.gnus} file:
18760 @findex gnus-demon-add-handler
18762 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
18765 @findex gnus-demon-add-nocem
18766 @findex gnus-demon-add-scanmail
18767 @findex gnus-demon-add-rescan
18768 @findex gnus-demon-add-scan-timestamps
18769 @findex gnus-demon-add-disconnection
18770 Some ready-made functions to do this have been created:
18771 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
18772 @code{gnus-demon-add-nntp-close-connection},
18773 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
18774 @code{gnus-demon-add-scanmail}. Just put those functions in your
18775 @file{.gnus} if you want those abilities.
18777 @findex gnus-demon-init
18778 @findex gnus-demon-cancel
18779 @vindex gnus-demon-handlers
18780 If you add handlers to @code{gnus-demon-handlers} directly, you should
18781 run @code{gnus-demon-init} to make the changes take hold. To cancel all
18782 daemons, you can use the @code{gnus-demon-cancel} function.
18784 Note that adding daemons can be pretty naughty if you over do it. Adding
18785 functions that scan all news and mail from all servers every two seconds
18786 is a sure-fire way of getting booted off any respectable system. So
18795 @dfn{Spamming} is posting the same article lots and lots of times.
18796 Spamming is bad. Spamming is evil.
18798 Spamming is usually canceled within a day or so by various anti-spamming
18799 agencies. These agencies usually also send out @dfn{NoCeM} messages.
18800 NoCeM is pronounced ``no see-'em'', and means what the name
18801 implies---these are messages that make the offending articles, like, go
18804 What use are these NoCeM messages if the articles are canceled anyway?
18805 Some sites do not honor cancel messages and some sites just honor cancels
18806 from a select few people. Then you may wish to make use of the NoCeM
18807 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
18809 Gnus can read and parse the messages in this group automatically, and
18810 this will make spam disappear.
18812 There are some variables to customize, of course:
18815 @item gnus-use-nocem
18816 @vindex gnus-use-nocem
18817 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
18820 @item gnus-nocem-groups
18821 @vindex gnus-nocem-groups
18822 Gnus will look for NoCeM messages in the groups in this list. The
18823 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
18824 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
18826 @item gnus-nocem-issuers
18827 @vindex gnus-nocem-issuers
18828 There are many people issuing NoCeM messages. This list says what
18829 people you want to listen to. The default is @code{("Automoose-1"
18830 "clewis@@ferret.ocunix.on.ca" "cosmo.roadkill" "SpamHippo"
18831 "hweede@@snafu.de")}; fine, upstanding citizens all of them.
18833 Known despammers that you can put in this list are listed at
18834 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
18836 You do not have to heed NoCeM messages from all these people---just the
18837 ones you want to listen to. You also don't have to accept all NoCeM
18838 messages from the people you like. Each NoCeM message has a @dfn{type}
18839 header that gives the message a (more or less, usually less) rigorous
18840 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
18841 @samp{binary}, and @samp{troll}. To specify this, you have to use
18842 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
18843 Each condition is either a string (which is a regexp that matches types
18844 you want to use) or a list on the form @code{(not @var{string})}, where
18845 @var{string} is a regexp that matches types you don't want to use.
18847 For instance, if you want all NoCeM messages from Chris Lewis except his
18848 @samp{troll} messages, you'd say:
18851 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
18854 On the other hand, if you just want nothing but his @samp{spam} and
18855 @samp{spew} messages, you'd say:
18858 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
18861 The specs are applied left-to-right.
18864 @item gnus-nocem-verifyer
18865 @vindex gnus-nocem-verifyer
18867 This should be a function for verifying that the NoCeM issuer is who she
18868 says she is. The default is @code{mc-verify}, which is a Mailcrypt
18869 function. If this is too slow and you don't care for verification
18870 (which may be dangerous), you can set this variable to @code{nil}.
18872 If you want signed NoCeM messages to be verified and unsigned messages
18873 not to be verified (but used anyway), you could do something like:
18876 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
18878 (defun my-gnus-mc-verify ()
18886 This might be dangerous, though.
18888 @item gnus-nocem-directory
18889 @vindex gnus-nocem-directory
18890 This is where Gnus will store its NoCeM cache files. The default is
18891 @file{~/News/NoCeM/}.
18893 @item gnus-nocem-expiry-wait
18894 @vindex gnus-nocem-expiry-wait
18895 The number of days before removing old NoCeM entries from the cache.
18896 The default is 15. If you make it shorter Gnus will be faster, but you
18897 might then see old spam.
18899 @item gnus-nocem-check-from
18900 @vindex gnus-nocem-check-from
18901 Non-@code{nil} means check for valid issuers in message bodies.
18902 Otherwise don't bother fetching articles unless their author matches a
18903 valid issuer; that is much faster if you are selective about the
18906 @item gnus-nocem-check-article-limit
18907 @vindex gnus-nocem-check-article-limit
18908 If non-@code{nil}, the maximum number of articles to check in any NoCeM
18909 group. NoCeM groups can be huge and very slow to process.
18913 Using NoCeM could potentially be a memory hog. If you have many living
18914 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
18915 big. If this is a problem, you should kill off all (or most) of your
18916 unsubscribed groups (@pxref{Subscription Commands}).
18923 It is very useful to be able to undo actions one has done. In normal
18924 Emacs buffers, it's easy enough---you just push the @code{undo} button.
18925 In Gnus buffers, however, it isn't that simple.
18927 The things Gnus displays in its buffer is of no value whatsoever to
18928 Gnus---it's all just data designed to look nice to the user.
18929 Killing a group in the group buffer with @kbd{C-k} makes the line
18930 disappear, but that's just a side-effect of the real action---the
18931 removal of the group in question from the internal Gnus structures.
18932 Undoing something like that can't be done by the normal Emacs
18933 @code{undo} function.
18935 Gnus tries to remedy this somewhat by keeping track of what the user
18936 does and coming up with actions that would reverse the actions the user
18937 takes. When the user then presses the @code{undo} key, Gnus will run
18938 the code to reverse the previous action, or the previous actions.
18939 However, not all actions are easily reversible, so Gnus currently offers
18940 a few key functions to be undoable. These include killing groups,
18941 yanking groups, and changing the list of read articles of groups.
18942 That's it, really. More functions may be added in the future, but each
18943 added function means an increase in data to be stored, so Gnus will
18944 never be totally undoable.
18946 @findex gnus-undo-mode
18947 @vindex gnus-use-undo
18949 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
18950 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
18951 default. The @kbd{M-C-_} key performs the @code{gnus-undo}
18952 command, which should feel kinda like the normal Emacs @code{undo}
18957 @section Moderation
18960 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
18961 It is not included in the standard Gnus package. Write a mail to
18962 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
18965 The moderation package is implemented as a minor mode for summary
18969 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
18972 in your @file{.gnus.el} file.
18974 If you are the moderator of @samp{rec.zoofle}, this is how it's
18979 You split your incoming mail by matching on
18980 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
18981 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
18984 You enter that group once in a while and post articles using the @kbd{e}
18985 (edit-and-post) or @kbd{s} (just send unedited) commands.
18988 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
18989 articles that weren't approved by you, you can cancel them with the
18993 To use moderation mode in these two groups, say:
18996 (setq gnus-moderated-list
18997 "^nnml:rec.zoofle$\\|^rec.zoofle$")
19001 @node XEmacs Enhancements
19002 @section XEmacs Enhancements
19005 XEmacs is able to display pictures and stuff, so Gnus has taken
19009 * Picons:: How to display pictures of what your reading.
19010 * Smileys:: Show all those happy faces the way they were meant to be shown.
19011 * Toolbar:: Click'n'drool.
19012 * XVarious:: Other XEmacsy Gnusey variables.
19025 So@dots{} You want to slow down your news reader even more! This is a
19026 good way to do so. Its also a great way to impress people staring
19027 over your shoulder as you read news.
19030 * Picon Basics:: What are picons and How do I get them.
19031 * Picon Requirements:: Don't go further if you aren't using XEmacs.
19032 * Easy Picons:: Displaying Picons---the easy way.
19033 * Hard Picons:: The way you should do it. You'll learn something.
19034 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
19039 @subsubsection Picon Basics
19041 What are Picons? To quote directly from the Picons Web site:
19050 @dfn{Picons} is short for ``personal icons''. They're small,
19051 constrained images used to represent users and domains on the net,
19052 organized into databases so that the appropriate image for a given
19053 e-mail address can be found. Besides users and domains, there are picon
19054 databases for Usenet newsgroups and weather forecasts. The picons are
19055 in either monochrome @code{XBM} format or color @code{XPM} and
19056 @code{GIF} formats.
19059 @vindex gnus-picons-piconsearch-url
19060 If you have a permanent connection to the Internet you can use Steve
19061 Kinzler's Picons Search engine by setting
19062 @code{gnus-picons-piconsearch-url} to the string @*
19063 @uref{http://www.cs.indiana.edu/picons/search.html}.
19065 @vindex gnus-picons-database
19066 Otherwise you need a local copy of his database. For instructions on
19067 obtaining and installing the picons databases, point your Web browser at @*
19068 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}. Gnus expects
19069 picons to be installed into a location pointed to by
19070 @code{gnus-picons-database}.
19073 @node Picon Requirements
19074 @subsubsection Picon Requirements
19076 To have Gnus display Picons for you, you must be running XEmacs
19077 19.13 or greater since all other versions of Emacs aren't yet able to
19080 Additionally, you must have @code{x} support compiled into XEmacs. To
19081 display color picons which are much nicer than the black & white one,
19082 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
19084 @vindex gnus-picons-convert-x-face
19085 If you want to display faces from @code{X-Face} headers, you should have
19086 the @code{xface} support compiled into XEmacs. Otherwise you must have
19087 the @code{netpbm} utilities installed, or munge the
19088 @code{gnus-picons-convert-x-face} variable to use something else.
19092 @subsubsection Easy Picons
19094 To enable displaying picons, simply put the following line in your
19095 @file{~/.gnus} file and start Gnus.
19098 (setq gnus-use-picons t)
19099 (setq gnus-treat-display-picons t)
19102 and make sure @code{gnus-picons-database} points to the directory
19103 containing the Picons databases.
19105 Alternatively if you want to use the web piconsearch engine add this:
19108 (setq gnus-picons-piconsearch-url
19109 "http://www.cs.indiana.edu:800/piconsearch")
19114 @subsubsection Hard Picons
19122 Gnus can display picons for you as you enter and leave groups and
19123 articles. It knows how to interact with three sections of the picons
19124 database. Namely, it can display the picons newsgroup pictures,
19125 author's face picture(s), and the authors domain. To enable this
19126 feature, you need to select where to get the picons from, and where to
19131 @item gnus-picons-database
19132 @vindex gnus-picons-database
19133 The location of the picons database. Should point to a directory
19134 containing the @file{news}, @file{domains}, @file{users} (and so on)
19135 subdirectories. This is only useful if
19136 @code{gnus-picons-piconsearch-url} is @code{nil}. Defaults to
19137 @file{/usr/local/faces/}.
19139 @item gnus-picons-piconsearch-url
19140 @vindex gnus-picons-piconsearch-url
19141 The URL for the web picons search engine. The only currently known
19142 engine is @uref{http://www.cs.indiana.edu:800/piconsearch}. To
19143 workaround network delays, icons will be fetched in the background. If
19144 this is @code{nil} 'the default), then picons are fetched from local
19145 database indicated by @code{gnus-picons-database}.
19147 @item gnus-picons-display-where
19148 @vindex gnus-picons-display-where
19149 Where the picon images should be displayed. It is @code{picons} by
19150 default (which by default maps to the buffer @samp{*Picons*}). Other
19151 valid places could be @code{article}, @code{summary}, or
19152 @samp{*scratch*} for all I care. Just make sure that you've made the
19153 buffer visible using the standard Gnus window configuration
19154 routines---@pxref{Window Layout}.
19156 @item gnus-picons-group-excluded-groups
19157 @vindex gnus-picons-group-excluded-groups
19158 Groups that are matched by this regexp won't have their group icons
19163 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
19164 window configuration for you to include the @code{picons} buffer.
19166 Now that you've made those decision, you need to add the following
19167 functions to the appropriate hooks so these pictures will get displayed
19170 @vindex gnus-picons-display-where
19172 @item gnus-article-display-picons
19173 @findex gnus-article-display-picons
19174 Looks up and displays the picons for the author and the author's domain
19175 in the @code{gnus-picons-display-where} buffer.
19177 @item gnus-picons-article-display-x-face
19178 @findex gnus-article-display-picons
19179 Decodes and displays the X-Face header if present.
19185 @node Picon Useless Configuration
19186 @subsubsection Picon Useless Configuration
19194 The following variables offer further control over how things are
19195 done, where things are located, and other useless stuff you really
19196 don't need to worry about.
19200 @item gnus-picons-news-directories
19201 @vindex gnus-picons-news-directories
19202 List of subdirectories to search in @code{gnus-picons-database} for
19203 newsgroups faces. @code{("news")} is the default.
19205 @item gnus-picons-user-directories
19206 @vindex gnus-picons-user-directories
19207 List of subdirectories to search in @code{gnus-picons-database} for user
19208 faces. @code{("local" "users" "usenix" "misc")} is the default.
19210 @item gnus-picons-domain-directories
19211 @vindex gnus-picons-domain-directories
19212 List of subdirectories to search in @code{gnus-picons-database} for
19213 domain name faces. Defaults to @code{("domains")}. Some people may
19214 want to add @samp{"unknown"} to this list.
19216 @item gnus-picons-convert-x-face
19217 @vindex gnus-picons-convert-x-face
19218 If you don't have @code{xface} support builtin XEmacs, this is the
19219 command to use to convert the @code{X-Face} header to an X bitmap
19220 (@code{xbm}). Defaults to @code{(format "@{ echo '/* Width=48,
19221 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
19222 gnus-picons-x-face-file-name)}
19224 @item gnus-picons-x-face-file-name
19225 @vindex gnus-picons-x-face-file-name
19226 Names a temporary file to store the @code{X-Face} bitmap in. Defaults
19227 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
19229 @item gnus-picons-has-modeline-p
19230 @vindex gnus-picons-has-modeline-p
19231 If you have set @code{gnus-picons-display-where} to @code{picons}, your
19232 XEmacs frame will become really cluttered. To alleviate this a bit you
19233 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
19234 remove the mode line from the Picons buffer. This is only useful if
19235 @code{gnus-picons-display-where} is @code{picons}.
19237 @item gnus-picons-refresh-before-display
19238 @vindex gnus-picons-refresh-before-display
19239 If non-nil, display the article buffer before computing the picons.
19240 Defaults to @code{nil}.
19242 @item gnus-picons-display-as-address
19243 @vindex gnus-picons-display-as-address
19244 If @code{t} display textual email addresses along with pictures.
19245 Defaults to @code{t}.
19247 @item gnus-picons-file-suffixes
19248 @vindex gnus-picons-file-suffixes
19249 Ordered list of suffixes on picon file names to try. Defaults to
19250 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
19252 @item gnus-picons-setup-hook
19253 @vindex gnus-picons-setup-hook
19254 Hook run in the picon buffer, if that is displayed.
19256 @item gnus-picons-display-article-move-p
19257 @vindex gnus-picons-display-article-move-p
19258 Whether to move point to first empty line when displaying picons. This
19259 has only an effect if `gnus-picons-display-where' has value `article'.
19261 If @code{nil}, display the picons in the @code{From} and
19262 @code{Newsgroups} lines. This is the default.
19264 @item gnus-picons-clear-cache-on-shutdown
19265 @vindex gnus-picons-clear-cache-on-shutdown
19266 Whether to clear the picons cache when exiting gnus. Gnus caches every
19267 picons it finds while it is running. This saves some time in the search
19268 process but eats some memory. If this variable is set to @code{nil},
19269 Gnus will never clear the cache itself; you will have to manually call
19270 @code{gnus-picons-clear-cache} to clear it. Otherwise the cache will be
19271 cleared every time you exit Gnus. Defaults to @code{t}.
19282 @subsection Smileys
19287 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
19292 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
19293 currently the only package that uses Smiley, it is documented here.
19295 In short---to use Smiley in Gnus, put the following in your
19296 @file{.gnus.el} file:
19299 (setq gnus-treat-display-smileys t)
19302 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
19303 the like---to pictures and displays those instead of the text smiley
19304 faces. The conversion is controlled by a list of regexps that matches
19305 text and maps that to file names.
19307 @vindex smiley-nosey-regexp-alist
19308 @vindex smiley-deformed-regexp-alist
19309 Smiley supplies two example conversion alists by default:
19310 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
19311 and so on), and @code{smiley-nosey-regexp-alist} (which matches
19312 @samp{:-)}, @samp{:-(} and so on).
19314 The alist used is specified by the @code{smiley-regexp-alist} variable,
19315 which defaults to the value of @code{smiley-deformed-regexp-alist}.
19317 The first item in each element is the regexp to be matched; the second
19318 element is the regexp match group that is to be replaced by the picture;
19319 and the third element is the name of the file to be displayed.
19321 The following variables customize where Smiley will look for these
19322 files, as well as the color to be used and stuff:
19326 @item smiley-data-directory
19327 @vindex smiley-data-directory
19328 Where Smiley will look for smiley faces files.
19330 @item smiley-flesh-color
19331 @vindex smiley-flesh-color
19332 Skin color. The default is @samp{yellow}, which is really racist.
19334 @item smiley-features-color
19335 @vindex smiley-features-color
19336 Color of the features of the face. The default is @samp{black}.
19338 @item smiley-tongue-color
19339 @vindex smiley-tongue-color
19340 Color of the tongue. The default is @samp{red}.
19342 @item smiley-circle-color
19343 @vindex smiley-circle-color
19344 Color of the circle around the face. The default is @samp{black}.
19346 @item smiley-mouse-face
19347 @vindex smiley-mouse-face
19348 Face used for mouse highlighting over the smiley face.
19354 @subsection Toolbar
19364 @item gnus-use-toolbar
19365 @vindex gnus-use-toolbar
19366 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
19367 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
19368 @code{right-toolbar}, or @code{left-toolbar}.
19370 @item gnus-group-toolbar
19371 @vindex gnus-group-toolbar
19372 The toolbar in the group buffer.
19374 @item gnus-summary-toolbar
19375 @vindex gnus-summary-toolbar
19376 The toolbar in the summary buffer.
19378 @item gnus-summary-mail-toolbar
19379 @vindex gnus-summary-mail-toolbar
19380 The toolbar in the summary buffer of mail groups.
19386 @subsection Various XEmacs Variables
19389 @item gnus-xmas-glyph-directory
19390 @vindex gnus-xmas-glyph-directory
19391 This is where Gnus will look for pictures. Gnus will normally
19392 auto-detect this directory, but you may set it manually if you have an
19393 unusual directory structure.
19395 @item gnus-xmas-logo-color-alist
19396 @vindex gnus-xmas-logo-color-alist
19397 This is an alist where the key is a type symbol and the values are the
19398 foreground and background color of the splash page glyph.
19400 @item gnus-xmas-logo-color-style
19401 @vindex gnus-xmas-logo-color-style
19402 This is the key used to look up the color in the alist described above.
19403 Valid values include @code{flame}, @code{pine}, @code{moss},
19404 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
19405 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
19407 @item gnus-xmas-modeline-glyph
19408 @vindex gnus-xmas-modeline-glyph
19409 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
19423 @node Fuzzy Matching
19424 @section Fuzzy Matching
19425 @cindex fuzzy matching
19427 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
19428 things like scoring, thread gathering and thread comparison.
19430 As opposed to regular expression matching, fuzzy matching is very fuzzy.
19431 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
19432 means, and the implementation has changed over time.
19434 Basically, it tries to remove all noise from lines before comparing.
19435 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
19436 out of the strings before comparing the results. This often leads to
19437 adequate results---even when faced with strings generated by text
19438 manglers masquerading as newsreaders.
19441 @node Thwarting Email Spam
19442 @section Thwarting Email Spam
19446 @cindex unsolicited commercial email
19448 In these last days of the Usenet, commercial vultures are hanging about
19449 and grepping through news like crazy to find email addresses they can
19450 foist off their scams and products to. As a reaction to this, many
19451 people have started putting nonsense addresses into their @code{From}
19452 lines. I think this is counterproductive---it makes it difficult for
19453 people to send you legitimate mail in response to things you write, as
19454 well as making it difficult to see who wrote what. This rewriting may
19455 perhaps be a bigger menace than the unsolicited commercial email itself
19458 The biggest problem I have with email spam is that it comes in under
19459 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
19460 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
19461 mail group, only to find two pyramid schemes, seven advertisements
19462 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
19463 and one mail asking me to repent and find some god.
19467 The way to deal with this is having Gnus split out all spam into a
19468 @samp{spam} mail group (@pxref{Splitting Mail}).
19470 First, pick one (1) valid mail address that you can be reached at, and
19471 put it in your @code{From} header of all your news articles. (I've
19472 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
19473 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
19474 sysadmin whether your sendmail installation accepts keywords in the local
19475 part of the mail address.)
19478 (setq message-default-news-headers
19479 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
19482 Then put the following split rule in @code{nnmail-split-fancy}
19483 (@pxref{Fancy Mail Splitting}):
19488 (to "larsi@@trym.ifi.uio.no"
19489 (| ("subject" "re:.*" "misc")
19490 ("references" ".*@@.*" "misc")
19496 This says that all mail to this address is suspect, but if it has a
19497 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
19498 header, it's probably ok. All the rest goes to the @samp{spam} group.
19499 (This idea probably comes from Tim Pierce.)
19501 In addition, many mail spammers talk directly to your @code{smtp} server
19502 and do not include your email address explicitly in the @code{To}
19503 header. Why they do this is unknown---perhaps it's to thwart this
19504 thwarting scheme? In any case, this is trivial to deal with---you just
19505 put anything not addressed to you in the @samp{spam} group by ending
19506 your fancy split rule in this way:
19511 (to "larsi" "misc")
19515 In my experience, this will sort virtually everything into the right
19516 group. You still have to check the @samp{spam} group from time to time to
19517 check for legitimate mail, though. If you feel like being a good net
19518 citizen, you can even send off complaints to the proper authorities on
19519 each unsolicited commercial email---at your leisure.
19521 If you are also a lazy net citizen, you will probably prefer complaining
19522 automatically with the @file{gnus-junk.el} package, available FOR FREE
19523 at @* @uref{http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html}.
19524 Since most e-mail spam is sent automatically, this may reconcile the
19525 cosmic balance somewhat.
19527 This works for me. It allows people an easy way to contact me (they can
19528 just press @kbd{r} in the usual way), and I'm not bothered at all with
19529 spam. It's a win-win situation. Forging @code{From} headers to point
19530 to non-existent domains is yucky, in my opinion.
19533 @node Various Various
19534 @section Various Various
19540 @item gnus-home-directory
19541 All Gnus path variables will be initialized from this variable, which
19542 defaults to @file{~/}.
19544 @item gnus-directory
19545 @vindex gnus-directory
19546 Most Gnus storage path variables will be initialized from this variable,
19547 which defaults to the @samp{SAVEDIR} environment variable, or
19548 @file{~/News/} if that variable isn't set.
19550 Note that Gnus is mostly loaded when the @file{.gnus.el} file is read.
19551 This means that other directory variables that are initialized from this
19552 variable won't be set properly if you set this variable in
19553 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
19555 @item gnus-default-directory
19556 @vindex gnus-default-directory
19557 Not related to the above variable at all---this variable says what the
19558 default directory of all Gnus buffers should be. If you issue commands
19559 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
19560 default directory. If this variable is @code{nil} (which is the
19561 default), the default directory will be the default directory of the
19562 buffer you were in when you started Gnus.
19565 @vindex gnus-verbose
19566 This variable is an integer between zero and ten. The higher the value,
19567 the more messages will be displayed. If this variable is zero, Gnus
19568 will never flash any messages, if it is seven (which is the default),
19569 most important messages will be shown, and if it is ten, Gnus won't ever
19570 shut up, but will flash so many messages it will make your head swim.
19572 @item gnus-verbose-backends
19573 @vindex gnus-verbose-backends
19574 This variable works the same way as @code{gnus-verbose}, but it applies
19575 to the Gnus backends instead of Gnus proper.
19577 @item nnheader-max-head-length
19578 @vindex nnheader-max-head-length
19579 When the backends read straight heads of articles, they all try to read
19580 as little as possible. This variable (default 4096) specifies
19581 the absolute max length the backends will try to read before giving up
19582 on finding a separator line between the head and the body. If this
19583 variable is @code{nil}, there is no upper read bound. If it is
19584 @code{t}, the backends won't try to read the articles piece by piece,
19585 but read the entire articles. This makes sense with some versions of
19586 @code{ange-ftp} or @code{efs}.
19588 @item nnheader-head-chop-length
19589 @vindex nnheader-head-chop-length
19590 This variable (default 2048) says how big a piece of each article to
19591 read when doing the operation described above.
19593 @item nnheader-file-name-translation-alist
19594 @vindex nnheader-file-name-translation-alist
19596 @cindex invalid characters in file names
19597 @cindex characters in file names
19598 This is an alist that says how to translate characters in file names.
19599 For instance, if @samp{:} is invalid as a file character in file names
19600 on your system (you OS/2 user you), you could say something like:
19603 (setq nnheader-file-name-translation-alist
19607 In fact, this is the default value for this variable on OS/2 and MS
19608 Windows (phooey) systems.
19610 @item gnus-hidden-properties
19611 @vindex gnus-hidden-properties
19612 This is a list of properties to use to hide ``invisible'' text. It is
19613 @code{(invisible t intangible t)} by default on most systems, which
19614 makes invisible text invisible and intangible.
19616 @item gnus-parse-headers-hook
19617 @vindex gnus-parse-headers-hook
19618 A hook called before parsing headers. It can be used, for instance, to
19619 gather statistics on the headers fetched, or perhaps you'd like to prune
19620 some headers. I don't see why you'd want that, though.
19622 @item gnus-shell-command-separator
19623 @vindex gnus-shell-command-separator
19624 String used to separate two shell commands. The default is @samp{;}.
19626 @item gnus-invalid-group-regexp
19627 @vindex gnus-invalid-group-regexp
19629 Regexp to match ``invalid'' group names when querying user for a group
19630 name. The default value catches some @strong{really} invalid group
19631 names who could possibly mess up Gnus internally (like allowing
19632 @samp{:} in a group name, which is normally used to delimit method and
19635 @sc{imap} users might want to allow @samp{/} in group names though.
19644 Well, that's the manual---you can get on with your life now. Keep in
19645 touch. Say hello to your cats from me.
19647 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
19649 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
19655 Not because of victories @*
19658 but for the common sunshine,@*
19660 the largess of the spring.
19664 but for the day's work done@*
19665 as well as I was able;@*
19666 not for a seat upon the dais@*
19667 but at the common table.@*
19672 @chapter Appendices
19675 * History:: How Gnus got where it is today.
19676 * On Writing Manuals:: Why this is not a beginner's guide.
19677 * Terminology:: We use really difficult, like, words here.
19678 * Customization:: Tailoring Gnus to your needs.
19679 * Troubleshooting:: What you might try if things do not work.
19680 * Gnus Reference Guide:: Rilly, rilly technical stuff.
19681 * Emacs for Heathens:: A short introduction to Emacsian terms.
19682 * Frequently Asked Questions::
19690 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
19691 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
19693 If you want to investigate the person responsible for this outrage,
19694 you can point your (feh!) web browser to
19695 @uref{http://quimby.gnus.org/}. This is also the primary
19696 distribution point for the new and spiffy versions of Gnus, and is
19697 known as The Site That Destroys Newsrcs And Drives People Mad.
19699 During the first extended alpha period of development, the new Gnus was
19700 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
19701 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
19702 (Besides, the ``Gnus'' in this abbreviation should probably be
19703 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
19704 appropriate name, don't you think?)
19706 In any case, after spending all that energy on coming up with a new and
19707 spunky name, we decided that the name was @emph{too} spunky, so we
19708 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
19709 ``@sc{gnus}''. New vs. old.
19712 * Gnus Versions:: What Gnus versions have been released.
19713 * Other Gnus Versions:: Other Gnus versions that also have been released.
19714 * Why?:: What's the point of Gnus?
19715 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
19716 * Conformity:: Gnus tries to conform to all standards.
19717 * Emacsen:: Gnus can be run on a few modern Emacsen.
19718 * Gnus Development:: How Gnus is developed.
19719 * Contributors:: Oodles of people.
19720 * New Features:: Pointers to some of the new stuff in Gnus.
19724 @node Gnus Versions
19725 @subsection Gnus Versions
19726 @cindex Pterodactyl Gnus
19728 @cindex September Gnus
19729 @cindex Quassia Gnus
19731 The first ``proper'' release of Gnus 5 was done in November 1995 when it
19732 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
19733 plus 15 Gnus 5.0 releases).
19735 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
19736 releases)) was released under the name ``Gnus 5.2'' (40 releases).
19738 On July 28th 1996 work on Red Gnus was begun, and it was released on
19739 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
19741 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
19742 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
19744 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
19745 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
19748 On the 26th of October 2000, Oort Gnus was begun.
19750 If you happen upon a version of Gnus that has a prefixed name --
19751 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
19752 ``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic. Don't let it know
19753 that you're frightened. Back away. Slowly. Whatever you do, don't
19754 run. Walk away, calmly, until you're out of its reach. Find a proper
19755 released version of Gnus and snuggle up to that instead.
19758 @node Other Gnus Versions
19759 @subsection Other Gnus Versions
19762 In addition to the versions of Gnus which have had their releases
19763 coordinated by Lars, one major development has been Semi-gnus from
19764 Japan. It's based on a library called @sc{semi}, which provides
19765 @sc{mime} capabilities.
19767 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
19768 Collectively, they are called ``Semi-gnus'', and different strains are
19769 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
19770 @sc{mime} and multilingualization things, especially important for
19777 What's the point of Gnus?
19779 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
19780 newsreader, that lets you do anything you can think of. That was my
19781 original motivation, but while working on Gnus, it has become clear to
19782 me that this generation of newsreaders really belong in the stone age.
19783 Newsreaders haven't developed much since the infancy of the net. If the
19784 volume continues to rise with the current rate of increase, all current
19785 newsreaders will be pretty much useless. How do you deal with
19786 newsgroups that have thousands of new articles each day? How do you
19787 keep track of millions of people who post?
19789 Gnus offers no real solutions to these questions, but I would very much
19790 like to see Gnus being used as a testing ground for new methods of
19791 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
19792 to separate the newsreader from the backends, Gnus now offers a simple
19793 interface for anybody who wants to write new backends for fetching mail
19794 and news from different sources. I have added hooks for customizations
19795 everywhere I could imagine it being useful. By doing so, I'm inviting
19796 every one of you to explore and invent.
19798 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
19799 @kbd{C-u 100 M-x all-hail-xemacs}.
19802 @node Compatibility
19803 @subsection Compatibility
19805 @cindex compatibility
19806 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
19807 bindings have been kept. More key bindings have been added, of course,
19808 but only in one or two obscure cases have old bindings been changed.
19813 @center In a cloud bones of steel.
19817 All commands have kept their names. Some internal functions have changed
19820 The @code{gnus-uu} package has changed drastically. @xref{Decoding
19823 One major compatibility question is the presence of several summary
19824 buffers. All variables relevant while reading a group are
19825 buffer-local to the summary buffer they belong in. Although many
19826 important variables have their values copied into their global
19827 counterparts whenever a command is executed in the summary buffer, this
19828 change might lead to incorrect values being used unless you are careful.
19830 All code that relies on knowledge of @sc{gnus} internals will probably
19831 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
19832 changing it in any way, as a matter of fact) is strictly verboten. Gnus
19833 maintains a hash table that points to the entries in this alist (which
19834 speeds up many functions), and changing the alist directly will lead to
19838 @cindex highlighting
19839 Old hilit19 code does not work at all. In fact, you should probably
19840 remove all hilit code from all Gnus hooks
19841 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
19842 Gnus provides various integrated functions for highlighting. These are
19843 faster and more accurate. To make life easier for everybody, Gnus will
19844 by default remove all hilit calls from all hilit hooks. Uncleanliness!
19847 Packages like @code{expire-kill} will no longer work. As a matter of
19848 fact, you should probably remove all old @sc{gnus} packages (and other
19849 code) when you start using Gnus. More likely than not, Gnus already
19850 does what you have written code to make @sc{gnus} do. (Snicker.)
19852 Even though old methods of doing things are still supported, only the
19853 new methods are documented in this manual. If you detect a new method of
19854 doing something while reading this manual, that does not mean you have
19855 to stop doing it the old way.
19857 Gnus understands all @sc{gnus} startup files.
19859 @kindex M-x gnus-bug
19861 @cindex reporting bugs
19863 Overall, a casual user who hasn't written much code that depends on
19864 @sc{gnus} internals should suffer no problems. If problems occur,
19865 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
19867 @vindex gnus-bug-create-help-buffer
19868 If you are in the habit of sending bug reports @emph{very} often, you
19869 may find the helpful help buffer annoying after a while. If so, set
19870 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
19875 @subsection Conformity
19877 No rebels without a clue here, ma'am. We conform to all standards known
19878 to (wo)man. Except for those standards and/or conventions we disagree
19885 There are no known breaches of this standard.
19889 There are no known breaches of this standard, either.
19891 @item Son-of-RFC 1036
19892 @cindex Son-of-RFC 1036
19893 We do have some breaches to this one.
19899 These are considered to be ``vanity headers'', while I consider them
19900 to be consumer information. After seeing so many badly formatted
19901 articles coming from @code{tin} and @code{Netscape} I know not to use
19902 either of those for posting articles. I would not have known that if
19903 it wasn't for the @code{X-Newsreader} header.
19908 USEFOR is an IETF working group writing a successor to RFC 1036, based
19909 on Son-of-RFC 1036. They have produced a number of drafts proposing
19910 various changes to the format of news articles. The Gnus towers will
19911 look into implementing the changes when the draft is accepted as an RFC.
19915 If you ever notice Gnus acting non-compliant with regards to the texts
19916 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
19921 @subsection Emacsen
19927 Gnus should work on :
19935 XEmacs 20.4 and up.
19939 This Gnus version will absolutely not work on any Emacsen older than
19940 that. Not reliably, at least. Older versions of Gnus may work on older
19943 There are some vague differences between Gnus on the various
19944 platforms---XEmacs features more graphics (a logo and a toolbar)---but
19945 other than that, things should look pretty much the same under all
19949 @node Gnus Development
19950 @subsection Gnus Development
19952 Gnus is developed in a two-phased cycle. The first phase involves much
19953 discussion on the @samp{ding@@gnus.org} mailing list, where people
19954 propose changes and new features, post patches and new backends. This
19955 phase is called the @dfn{alpha} phase, since the Gnusae released in this
19956 phase are @dfn{alpha releases}, or (perhaps more commonly in other
19957 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
19958 unstable and should not be used by casual users. Gnus alpha releases
19959 have names like ``Red Gnus'' and ``Quassia Gnus''.
19961 After futzing around for 50-100 alpha releases, Gnus is declared
19962 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
19963 and is called things like ``Gnus 5.6.32'' instead. Normal people are
19964 supposed to be able to use these, and these are mostly discussed on the
19965 @samp{gnu.emacs.gnus} newsgroup.
19968 @vindex mail-source-delete-incoming
19969 Some variable defaults differ between alpha Gnusae and released Gnusae.
19970 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
19971 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
19972 lossage of mail if an alpha release hiccups while handling the mail.
19974 The division of discussion between the ding mailing list and the Gnus
19975 newsgroup is not purely based on publicity concerns. It's true that
19976 having people write about the horrible things that an alpha Gnus release
19977 can do (sometimes) in a public forum may scare people off, but more
19978 importantly, talking about new experimental features that have been
19979 introduced may confuse casual users. New features are frequently
19980 introduced, fiddled with, and judged to be found wanting, and then
19981 either discarded or totally rewritten. People reading the mailing list
19982 usually keep up with these rapid changes, while people on the newsgroup
19983 can't be assumed to do so.
19988 @subsection Contributors
19989 @cindex contributors
19991 The new Gnus version couldn't have been done without the help of all the
19992 people on the (ding) mailing list. Every day for over a year I have
19993 gotten billions of nice bug reports from them, filling me with joy,
19994 every single one of them. Smooches. The people on the list have been
19995 tried beyond endurance, what with my ``oh, that's a neat idea <type
19996 type>, yup, I'll release it right away <ship off> no wait, that doesn't
19997 work at all <type type>, yup, I'll ship that one off right away <ship
19998 off> no, wait, that absolutely does not work'' policy for releases.
19999 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
20000 ``worser''? ``much worser''? ``worsest''?)
20002 I would like to take this opportunity to thank the Academy for... oops,
20008 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
20011 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
20012 nnwarchive and many, many other things connected with @sc{mime} and
20013 other types of en/decoding, as well as general bug fixing, new
20014 functionality and stuff.
20017 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
20018 well as numerous other things).
20021 Luis Fernandes---design and graphics.
20024 Justin Sheehy--the FAQ maintainer.
20027 Erik Naggum---help, ideas, support, code and stuff.
20030 Wes Hardaker---@file{gnus-picon.el} and the manual section on
20031 @dfn{picons} (@pxref{Picons}).
20034 Kim-Minh Kaplan---further work on the picon code.
20037 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
20038 (@pxref{GroupLens}).
20041 Sudish Joseph---innumerable bug fixes.
20044 Ilja Weis---@file{gnus-topic.el}.
20047 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
20050 Vladimir Alexiev---the refcard and reference booklets.
20053 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
20054 distribution by Felix Lee and JWZ.
20057 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
20060 Peter Mutsaers---orphan article scoring code.
20063 Ken Raeburn---POP mail support.
20066 Hallvard B Furuseth---various bits and pieces, especially dealing with
20070 Brian Edmonds---@file{gnus-bbdb.el}.
20073 David Moore---rewrite of @file{nnvirtual.el} and many other things.
20076 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
20079 François Pinard---many, many interesting and thorough bug reports, as
20080 well as autoconf support.
20084 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
20085 Borges, and Jost Krieger proof-reading parts of the manual.
20087 The following people have contributed many patches and suggestions:
20096 Jason L. Tibbitts, III,
20100 Also thanks to the following for patches and stuff:
20110 Alexei V. Barantsev,
20125 Massimo Campostrini,
20130 Jae-you Chung, @c ?
20131 James H. Cloos, Jr.,
20135 Andrew J. Cosgriff,
20138 Geoffrey T. Dairiki,
20144 Michael Welsh Duggan,
20149 Enami Tsugutomo, @c Enami
20153 Nelson Jose dos Santos Ferreira,
20161 Arne Georg Gleditsch,
20163 Michelangelo Grigni,
20167 Kenichi Handa, @c Handa
20169 Yoshiki Hayashi, @c ?
20171 Hisashige Kenji, @c Hisashige
20178 François Felix Ingrand,
20179 Tatsuya Ichikawa, @c ?
20180 Ishikawa Ichiro, @c Ishikawa
20182 Iwamuro Motonori, @c Iwamuro
20193 Peter Skov Knudsen,
20194 Shuhei Kobayashi, @c Kobayashi
20196 Koseki Yoshinori, @c Koseki
20197 Thor Kristoffersen,
20200 Seokchan Lee, @c Lee
20218 Morioka Tomohiko, @c Morioka
20219 Erik Toubro Nielsen,
20226 Masaharu Onishi, @c Onishi
20231 Jens-Ulrik Holger Petersen,
20235 John McClary Prevost,
20241 Lars Balker Rasmussen,
20246 Christian von Roques,
20249 Wolfgang Rupprecht,
20256 Philippe Schnoebelen,
20258 Randal L. Schwartz,
20272 Kiyokazu Suto, @c Suto
20277 Tozawa Akihiko, @c Tozawa
20293 Katsumi Yamaoka @c Yamaoka
20298 For a full overview of what each person has done, the ChangeLogs
20299 included in the Gnus alpha distributions should give ample reading
20300 (550kB and counting).
20302 Apologies to everybody that I've forgotten, of which there are many, I'm
20305 Gee, that's quite a list of people. I guess that must mean that there
20306 actually are people who are using Gnus. Who'd'a thunk it!
20310 @subsection New Features
20311 @cindex new features
20314 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
20315 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
20316 * Red Gnus:: Third time best---Gnus 5.4/5.5.
20317 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
20318 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
20321 These lists are, of course, just @emph{short} overviews of the
20322 @emph{most} important new features. No, really. There are tons more.
20323 Yes, we have feeping creaturism in full effect.
20326 @subsubsection (ding) Gnus
20328 New features in Gnus 5.0/5.1:
20333 The look of all buffers can be changed by setting format-like variables
20334 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
20337 Local spool and several @sc{nntp} servers can be used at once
20338 (@pxref{Select Methods}).
20341 You can combine groups into virtual groups (@pxref{Virtual Groups}).
20344 You can read a number of different mail formats (@pxref{Getting Mail}).
20345 All the mail backends implement a convenient mail expiry scheme
20346 (@pxref{Expiring Mail}).
20349 Gnus can use various strategies for gathering threads that have lost
20350 their roots (thereby gathering loose sub-threads into one thread) or it
20351 can go back and retrieve enough headers to build a complete thread
20352 (@pxref{Customizing Threading}).
20355 Killed groups can be displayed in the group buffer, and you can read
20356 them as well (@pxref{Listing Groups}).
20359 Gnus can do partial group updates---you do not have to retrieve the
20360 entire active file just to check for new articles in a few groups
20361 (@pxref{The Active File}).
20364 Gnus implements a sliding scale of subscribedness to groups
20365 (@pxref{Group Levels}).
20368 You can score articles according to any number of criteria
20369 (@pxref{Scoring}). You can even get Gnus to find out how to score
20370 articles for you (@pxref{Adaptive Scoring}).
20373 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
20374 manner, so it should be difficult to lose much data on what you have
20375 read if your machine should go down (@pxref{Auto Save}).
20378 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
20379 the @file{.emacs} file.
20382 You can set the process mark on both groups and articles and perform
20383 operations on all the marked items (@pxref{Process/Prefix}).
20386 You can grep through a subset of groups and create a group from the
20387 results (@pxref{Kibozed Groups}).
20390 You can list subsets of groups according to, well, anything
20391 (@pxref{Listing Groups}).
20394 You can browse foreign servers and subscribe to groups from those
20395 servers (@pxref{Browse Foreign Server}).
20398 Gnus can fetch articles, asynchronously, on a second connection to the
20399 server (@pxref{Asynchronous Fetching}).
20402 You can cache articles locally (@pxref{Article Caching}).
20405 The uudecode functions have been expanded and generalized
20406 (@pxref{Decoding Articles}).
20409 You can still post uuencoded articles, which was a little-known feature
20410 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
20413 Fetching parents (and other articles) now actually works without
20414 glitches (@pxref{Finding the Parent}).
20417 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
20420 Digests (and other files) can be used as the basis for groups
20421 (@pxref{Document Groups}).
20424 Articles can be highlighted and customized (@pxref{Customizing
20428 URLs and other external references can be buttonized (@pxref{Article
20432 You can do lots of strange stuff with the Gnus window & frame
20433 configuration (@pxref{Window Layout}).
20436 You can click on buttons instead of using the keyboard
20442 @node September Gnus
20443 @subsubsection September Gnus
20447 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
20451 New features in Gnus 5.2/5.3:
20456 A new message composition mode is used. All old customization variables
20457 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
20461 Gnus is now able to generate @dfn{sparse} threads---threads where
20462 missing articles are represented by empty nodes (@pxref{Customizing
20466 (setq gnus-build-sparse-threads 'some)
20470 Outgoing articles are stored on a special archive server
20471 (@pxref{Archived Messages}).
20474 Partial thread regeneration now happens when articles are
20478 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
20481 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
20484 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
20487 (setq gnus-use-trees t)
20491 An @code{nn}-like pick-and-read minor mode is available for the summary
20492 buffers (@pxref{Pick and Read}).
20495 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
20499 In binary groups you can use a special binary minor mode (@pxref{Binary
20503 Groups can be grouped in a folding topic hierarchy (@pxref{Group
20507 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
20511 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
20514 Groups can now have a score, and bubbling based on entry frequency
20515 is possible (@pxref{Group Score}).
20518 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
20522 Groups can be process-marked, and commands can be performed on
20523 groups of groups (@pxref{Marking Groups}).
20526 Caching is possible in virtual groups.
20529 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
20530 news batches, ClariNet briefs collections, and just about everything
20531 else (@pxref{Document Groups}).
20534 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
20538 The Gnus cache is much faster.
20541 Groups can be sorted according to many criteria (@pxref{Sorting
20545 New group parameters have been introduced to set list-addresses and
20546 expiry times (@pxref{Group Parameters}).
20549 All formatting specs allow specifying faces to be used
20550 (@pxref{Formatting Fonts}).
20553 There are several more commands for setting/removing/acting on process
20554 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
20557 The summary buffer can be limited to show parts of the available
20558 articles based on a wide range of criteria. These commands have been
20559 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
20562 Articles can be made persistent with the @kbd{*} command
20563 (@pxref{Persistent Articles}).
20566 All functions for hiding article elements are now toggles.
20569 Article headers can be buttonized (@pxref{Article Washing}).
20572 All mail backends support fetching articles by @code{Message-ID}.
20575 Duplicate mail can now be treated properly (@pxref{Duplicates}).
20578 All summary mode commands are available directly from the article
20579 buffer (@pxref{Article Keymap}).
20582 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
20586 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
20589 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
20594 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
20597 (setq gnus-use-nocem t)
20601 Groups can be made permanently visible (@pxref{Listing Groups}).
20604 (setq gnus-permanently-visible-groups "^nnml:")
20608 Many new hooks have been introduced to make customizing easier.
20611 Gnus respects the @code{Mail-Copies-To} header.
20614 Threads can be gathered by looking at the @code{References} header
20615 (@pxref{Customizing Threading}).
20618 (setq gnus-summary-thread-gathering-function
20619 'gnus-gather-threads-by-references)
20623 Read articles can be stored in a special backlog buffer to avoid
20624 refetching (@pxref{Article Backlog}).
20627 (setq gnus-keep-backlog 50)
20631 A clean copy of the current article is always stored in a separate
20632 buffer to allow easier treatment.
20635 Gnus can suggest where to save articles (@pxref{Saving Articles}).
20638 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
20642 (setq gnus-prompt-before-saving t)
20646 @code{gnus-uu} can view decoded files asynchronously while fetching
20647 articles (@pxref{Other Decode Variables}).
20650 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
20654 Filling in the article buffer now works properly on cited text
20655 (@pxref{Article Washing}).
20658 Hiding cited text adds buttons to toggle hiding, and how much
20659 cited text to hide is now customizable (@pxref{Article Hiding}).
20662 (setq gnus-cited-lines-visible 2)
20666 Boring headers can be hidden (@pxref{Article Hiding}).
20669 Default scoring values can now be set from the menu bar.
20672 Further syntax checking of outgoing articles have been added.
20678 @subsubsection Red Gnus
20680 New features in Gnus 5.4/5.5:
20684 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
20691 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
20694 Article prefetching functionality has been moved up into
20695 Gnus (@pxref{Asynchronous Fetching}).
20698 Scoring can now be performed with logical operators like @code{and},
20699 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
20703 Article washing status can be displayed in the
20704 article mode line (@pxref{Misc Article}).
20707 @file{gnus.el} has been split into many smaller files.
20710 Suppression of duplicate articles based on Message-ID can be done
20711 (@pxref{Duplicate Suppression}).
20714 (setq gnus-suppress-duplicates t)
20718 New variables for specifying what score and adapt files are to be
20719 considered home score and adapt files (@pxref{Home Score File}) have
20723 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
20724 Server Internals}).
20727 Groups can inherit group parameters from parent topics (@pxref{Topic
20731 Article editing has been revamped and is now actually usable.
20734 Signatures can be recognized in more intelligent fashions
20735 (@pxref{Article Signature}).
20738 Summary pick mode has been made to look more @code{nn}-like. Line
20739 numbers are displayed and the @kbd{.} command can be used to pick
20740 articles (@code{Pick and Read}).
20743 Commands for moving the @file{.newsrc.eld} from one server to
20744 another have been added (@pxref{Changing Servers}).
20747 There's a way now to specify that ``uninteresting'' fields be suppressed
20748 when generating lines in buffers (@pxref{Advanced Formatting}).
20751 Several commands in the group buffer can be undone with @kbd{M-C-_}
20755 Scoring can be done on words using the new score type @code{w}
20756 (@pxref{Score File Format}).
20759 Adaptive scoring can be done on a Subject word-by-word basis
20760 (@pxref{Adaptive Scoring}).
20763 (setq gnus-use-adaptive-scoring '(word))
20767 Scores can be decayed (@pxref{Score Decays}).
20770 (setq gnus-decay-scores t)
20774 Scoring can be performed using a regexp on the Date header. The Date is
20775 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
20778 A new command has been added to remove all data on articles from
20779 the native server (@pxref{Changing Servers}).
20782 A new command for reading collections of documents
20783 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
20784 (@pxref{Really Various Summary Commands}).
20787 Process mark sets can be pushed and popped (@pxref{Setting Process
20791 A new mail-to-news backend makes it possible to post even when the @sc{nntp}
20792 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
20795 A new backend for reading searches from Web search engines
20796 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
20797 (@pxref{Web Searches}).
20800 Groups inside topics can now be sorted using the standard sorting
20801 functions, and each topic can be sorted independently (@pxref{Topic
20805 Subsets of the groups can be sorted independently (@code{Sorting
20809 Cached articles can be pulled into the groups (@pxref{Summary Generation
20813 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
20818 Score files are now applied in a more reliable order (@pxref{Score
20822 Reports on where mail messages end up can be generated (@pxref{Splitting
20826 More hooks and functions have been added to remove junk from incoming
20827 mail before saving the mail (@pxref{Washing Mail}).
20830 Emphasized text can be properly fontisized:
20836 @subsubsection Quassia Gnus
20838 New features in Gnus 5.6:
20843 New functionality for using Gnus as an offline newsreader has been
20844 added. A plethora of new commands and modes have been added. See
20845 @pxref{Gnus Unplugged} for the full story.
20848 The @code{nndraft} backend has returned, but works differently than
20849 before. All Message buffers are now also articles in the @code{nndraft}
20850 group, which is created automatically.
20853 @code{gnus-alter-header-function} can now be used to alter header
20857 @code{gnus-summary-goto-article} now accept Message-ID's.
20860 A new Message command for deleting text in the body of a message
20861 outside the region: @kbd{C-c C-v}.
20864 You can now post to component group in @code{nnvirtual} groups with
20868 @code{nntp-rlogin-program}---new variable to ease customization.
20871 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
20872 re-highlighting of the article buffer.
20875 New element in @code{gnus-boring-article-headers}---@code{long-to}.
20878 @kbd{M-i} symbolic prefix command. See the section "Symbolic
20879 Prefixes" in the Gnus manual for details.
20882 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
20883 @kbd{a} to add the score rule to the "all.SCORE" file.
20886 @code{gnus-simplify-subject-functions} variable to allow greater
20887 control over simplification.
20890 @kbd{A T}---new command for fetching the current thread.
20893 @kbd{/ T}---new command for including the current thread in the
20897 @kbd{M-RET} is a new Message command for breaking cited text.
20900 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
20903 The @code{custom-face-lookup} function has been removed.
20904 If you used this function in your initialization files, you must
20905 rewrite them to use @code{face-spec-set} instead.
20908 Canceling now uses the current select method. Symbolic prefix
20909 @kbd{a} forces normal posting method.
20912 New command to translate M******** sm*rtq**t*s into proper
20916 For easier debugging of @code{nntp}, you can set
20917 @code{nntp-record-commands} to a non-@code{nil} value.
20920 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
20921 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
20924 A command for editing group parameters from the summary buffer
20928 A history of where mails have been split is available.
20931 A new article date command has been added---@code{article-date-iso8601}.
20934 Subjects can be simplified when threading by setting
20935 @code{gnus-score-thread-simplify}.
20938 A new function for citing in Message has been
20939 added---@code{message-cite-original-without-signature}.
20942 @code{article-strip-all-blank-lines}---new article command.
20945 A new Message command to kill to the end of the article has
20949 A minimum adaptive score can be specified by using the
20950 @code{gnus-adaptive-word-minimum} variable.
20953 The "lapsed date" article header can be kept continually
20954 updated by the @code{gnus-start-date-timer} command.
20957 Web listserv archives can be read with the @code{nnlistserv} backend.
20960 Old dejanews archives can now be read by @code{nnweb}.
20964 @node Pterodactyl Gnus
20965 @subsubsection Pterodactyl Gnus
20967 New features in Gnus 5.8:
20971 @item The mail-fetching functions have changed. See the manual for the
20972 many details. In particular, all procmail fetching variables are gone.
20974 If you used procmail like in
20977 (setq nnmail-use-procmail t)
20978 (setq nnmail-spool-file 'procmail)
20979 (setq nnmail-procmail-directory "~/mail/incoming/")
20980 (setq nnmail-procmail-suffix "\\.in")
20983 this now has changed to
20987 '((directory :path "~/mail/incoming/"
20991 More information is available in the info doc at Select Methods ->
20992 Getting Mail -> Mail Sources
20994 @item Gnus is now a MIME-capable reader. This affects many parts of
20995 Gnus, and adds a slew of new commands. See the manual for details.
20997 @item Gnus has also been multilingualized. This also affects too
20998 many parts of Gnus to summarize here, and adds many new variables.
21000 @item @code{gnus-auto-select-first} can now be a function to be
21001 called to position point.
21003 @item The user can now decide which extra headers should be included in
21004 summary buffers and NOV files.
21006 @item @code{gnus-article-display-hook} has been removed. Instead, a number
21007 of variables starting with @code{gnus-treat-} have been added.
21009 @item The Gnus posting styles have been redone again and now works in a
21010 subtly different manner.
21012 @item New web-based backends have been added: @code{nnslashdot},
21013 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
21014 again, to keep up with ever-changing layouts.
21016 @item Gnus can now read IMAP mail via @code{nnimap}.
21024 @section The Manual
21028 This manual was generated from a TeXinfo file and then run through
21029 either @code{texi2dvi}
21031 or my own home-brewed TeXinfo to \LaTeX\ transformer,
21032 and then run through @code{latex} and @code{dvips}
21034 to get what you hold in your hands now.
21036 The following conventions have been used:
21041 This is a @samp{string}
21044 This is a @kbd{keystroke}
21047 This is a @file{file}
21050 This is a @code{symbol}
21054 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
21058 (setq flargnoze "yes")
21061 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
21064 (setq flumphel 'yes)
21067 @samp{yes} and @code{yes} are two @emph{very} different things---don't
21068 ever get them confused.
21072 Of course, everything in this manual is of vital interest, so you should
21073 read it all. Several times. However, if you feel like skimming the
21074 manual, look for that gnu head you should see in the margin over
21075 there---it means that what's being discussed is of more importance than
21076 the rest of the stuff. (On the other hand, if everything is infinitely
21077 important, how can anything be more important than that? Just one more
21078 of the mysteries of this world, I guess.)
21084 @node On Writing Manuals
21085 @section On Writing Manuals
21087 I guess most manuals are written after-the-fact; documenting a program
21088 that's already there. This is not how this manual is written. When
21089 implementing something, I write the manual entry for that something
21090 straight away. I then see that it's difficult to explain the
21091 functionality, so I write how it's supposed to be, and then I change the
21092 implementation. Writing the documentation and writing the code goes
21095 This, of course, means that this manual has no, or little, flow. It
21096 documents absolutely everything in Gnus, but often not where you're
21097 looking for it. It is a reference manual, and not a guide to how to get
21100 That would be a totally different book, that should be written using the
21101 reference manual as source material. It would look quite differently.
21106 @section Terminology
21108 @cindex terminology
21113 This is what you are supposed to use this thing for---reading news.
21114 News is generally fetched from a nearby @sc{nntp} server, and is
21115 generally publicly available to everybody. If you post news, the entire
21116 world is likely to read just what you have written, and they'll all
21117 snigger mischievously. Behind your back.
21121 Everything that's delivered to you personally is mail. Some news/mail
21122 readers (like Gnus) blur the distinction between mail and news, but
21123 there is a difference. Mail is private. News is public. Mailing is
21124 not posting, and replying is not following up.
21128 Send a mail to the person who has written what you are reading.
21132 Post an article to the current newsgroup responding to the article you
21137 Gnus gets fed articles from a number of backends, both news and mail
21138 backends. Gnus does not handle the underlying media, so to speak---this
21139 is all done by the backends.
21143 Gnus will always use one method (and backend) as the @dfn{native}, or
21144 default, way of getting news.
21148 You can also have any number of foreign groups active at the same time.
21149 These are groups that use non-native non-secondary backends for getting
21154 Secondary backends are somewhere half-way between being native and being
21155 foreign, but they mostly act like they are native.
21159 A message that has been posted as news.
21162 @cindex mail message
21163 A message that has been mailed.
21167 A mail message or news article
21171 The top part of a message, where administrative information (etc.) is
21176 The rest of an article. Everything not in the head is in the
21181 A line from the head of an article.
21185 A collection of such lines, or a collection of heads. Or even a
21186 collection of @sc{nov} lines.
21190 When Gnus enters a group, it asks the backend for the headers of all
21191 unread articles in the group. Most servers support the News OverView
21192 format, which is more compact and much faster to read and parse than the
21193 normal @sc{head} format.
21197 Each group is subscribed at some @dfn{level} or other (1-9). The ones
21198 that have a lower level are ``more'' subscribed than the groups with a
21199 higher level. In fact, groups on levels 1-5 are considered
21200 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
21201 are @dfn{killed}. Commands for listing groups and scanning for new
21202 articles will all use the numeric prefix as @dfn{working level}.
21204 @item killed groups
21205 @cindex killed groups
21206 No information on killed groups is stored or updated, which makes killed
21207 groups much easier to handle than subscribed groups.
21209 @item zombie groups
21210 @cindex zombie groups
21211 Just like killed groups, only slightly less dead.
21214 @cindex active file
21215 The news server has to keep track of what articles it carries, and what
21216 groups exist. All this information in stored in the active file, which
21217 is rather large, as you might surmise.
21220 @cindex bogus groups
21221 A group that exists in the @file{.newsrc} file, but isn't known to the
21222 server (i.e., it isn't in the active file), is a @emph{bogus group}.
21223 This means that the group probably doesn't exist (any more).
21226 @cindex activating groups
21227 The act of asking the server for info on a group and computing the
21228 number of unread articles is called @dfn{activating the group}.
21229 Un-activated groups are listed with @samp{*} in the group buffer.
21233 A machine one can connect to and get news (or mail) from.
21235 @item select method
21236 @cindex select method
21237 A structure that specifies the backend, the server and the virtual
21240 @item virtual server
21241 @cindex virtual server
21242 A named select method. Since a select method defines all there is to
21243 know about connecting to a (physical) server, taking the thing as a
21244 whole is a virtual server.
21248 Taking a buffer and running it through a filter of some sort. The
21249 result will (more often than not) be cleaner and more pleasing than the
21252 @item ephemeral groups
21253 @cindex ephemeral groups
21254 Most groups store data on what articles you have read. @dfn{Ephemeral}
21255 groups are groups that will have no data stored---when you exit the
21256 group, it'll disappear into the aether.
21259 @cindex solid groups
21260 This is the opposite of ephemeral groups. All groups listed in the
21261 group buffer are solid groups.
21263 @item sparse articles
21264 @cindex sparse articles
21265 These are article placeholders shown in the summary buffer when
21266 @code{gnus-build-sparse-threads} has been switched on.
21270 To put responses to articles directly after the articles they respond
21271 to---in a hierarchical fashion.
21275 @cindex thread root
21276 The first article in a thread is the root. It is the ancestor of all
21277 articles in the thread.
21281 An article that has responses.
21285 An article that responds to a different article---its parent.
21289 A collection of messages in one file. The most common digest format is
21290 specified by RFC 1153.
21296 @node Customization
21297 @section Customization
21298 @cindex general customization
21300 All variables are properly documented elsewhere in this manual. This
21301 section is designed to give general pointers on how to customize Gnus
21302 for some quite common situations.
21305 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
21306 * Slow Terminal Connection:: You run a remote Emacs.
21307 * Little Disk Space:: You feel that having large setup files is icky.
21308 * Slow Machine:: You feel like buying a faster machine.
21312 @node Slow/Expensive Connection
21313 @subsection Slow/Expensive @sc{nntp} Connection
21315 If you run Emacs on a machine locally, and get your news from a machine
21316 over some very thin strings, you want to cut down on the amount of data
21317 Gnus has to get from the @sc{nntp} server.
21321 @item gnus-read-active-file
21322 Set this to @code{nil}, which will inhibit Gnus from requesting the
21323 entire active file from the server. This file is often v. large. You
21324 also have to set @code{gnus-check-new-newsgroups} and
21325 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
21326 doesn't suddenly decide to fetch the active file anyway.
21328 @item gnus-nov-is-evil
21329 This one has to be @code{nil}. If not, grabbing article headers from
21330 the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers
21331 support @sc{xover}; Gnus will detect this by itself.
21335 @node Slow Terminal Connection
21336 @subsection Slow Terminal Connection
21338 Let's say you use your home computer for dialing up the system that runs
21339 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
21340 possible) the amount of data sent over the wires.
21344 @item gnus-auto-center-summary
21345 Set this to @code{nil} to inhibit Gnus from re-centering the summary
21346 buffer all the time. If it is @code{vertical}, do only vertical
21347 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
21348 horizontal and vertical recentering.
21350 @item gnus-visible-headers
21351 Cut down on the headers included in the articles to the
21352 minimum. You can, in fact, make do without them altogether---most of the
21353 useful data is in the summary buffer, anyway. Set this variable to
21354 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
21356 Set this hook to all the available hiding commands:
21358 (setq gnus-treat-hide-headers 'head
21359 gnus-treat-hide-signature t
21360 gnus-treat-hide-citation t)
21363 @item gnus-use-full-window
21364 By setting this to @code{nil}, you can make all the windows smaller.
21365 While this doesn't really cut down much generally, it means that you
21366 have to see smaller portions of articles before deciding that you didn't
21367 want to read them anyway.
21369 @item gnus-thread-hide-subtree
21370 If this is non-@code{nil}, all threads in the summary buffer will be
21373 @item gnus-updated-mode-lines
21374 If this is @code{nil}, Gnus will not put information in the buffer mode
21375 lines, which might save some time.
21379 @node Little Disk Space
21380 @subsection Little Disk Space
21383 The startup files can get rather large, so you may want to cut their
21384 sizes a bit if you are running out of space.
21388 @item gnus-save-newsrc-file
21389 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
21390 only save @file{.newsrc.eld}. This means that you will not be able to
21391 use any other newsreaders than Gnus. This variable is @code{t} by
21394 @item gnus-read-newsrc-file
21395 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
21396 only read @file{.newsrc.eld}. This means that you will not be able to
21397 use any other newsreaders than Gnus. This variable is @code{t} by
21400 @item gnus-save-killed-list
21401 If this is @code{nil}, Gnus will not save the list of dead groups. You
21402 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
21403 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
21404 variable to @code{nil}. This variable is @code{t} by default.
21410 @subsection Slow Machine
21411 @cindex slow machine
21413 If you have a slow machine, or are just really impatient, there are a
21414 few things you can do to make Gnus run faster.
21416 Set @code{gnus-check-new-newsgroups} and
21417 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
21419 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
21420 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
21421 summary buffer faster.
21425 @node Troubleshooting
21426 @section Troubleshooting
21427 @cindex troubleshooting
21429 Gnus works @emph{so} well straight out of the box---I can't imagine any
21437 Make sure your computer is switched on.
21440 Make sure that you really load the current Gnus version. If you have
21441 been running @sc{gnus}, you need to exit Emacs and start it up again before
21445 Try doing an @kbd{M-x gnus-version}. If you get something that looks
21446 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded. If,
21447 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
21448 flee}, you have some old @file{.el} files lying around. Delete these.
21451 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
21455 @vindex max-lisp-eval-depth
21456 Gnus works on many recursive structures, and in some extreme (and very
21457 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
21458 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
21459 something like that.
21462 If all else fails, report the problem as a bug.
21465 @cindex reporting bugs
21467 @kindex M-x gnus-bug
21469 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
21470 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
21471 me the backtrace. I will fix bugs, but I can only fix them if you send
21472 me a precise description as to how to reproduce the bug.
21474 You really can never be too detailed in a bug report. Always use the
21475 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
21476 a 10Kb mail each time you use it, and even if you have sent me your
21477 environment 500 times before. I don't care. I want the full info each
21480 It is also important to remember that I have no memory whatsoever. If
21481 you send a bug report, and I send you a reply, and then you just send
21482 back ``No, it's not! Moron!'', I will have no idea what you are
21483 insulting me about. Always over-explain everything. It's much easier
21484 for all of us---if I don't have all the information I need, I will just
21485 mail you and ask for more info, and everything takes more time.
21487 If the problem you're seeing is very visual, and you can't quite explain
21488 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
21489 it somewhere it can be reached, and include the URL of the picture in
21493 If you would like to contribute a patch to fix bugs or make
21494 improvements, please produce the patch using @samp{diff -u}.
21496 If you just need help, you are better off asking on
21497 @samp{gnu.emacs.gnus}. I'm not very helpful.
21499 @cindex gnu.emacs.gnus
21500 @cindex ding mailing list
21501 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
21502 Write to @samp{ding-request@@gnus.org} to subscribe.
21506 @node Gnus Reference Guide
21507 @section Gnus Reference Guide
21509 It is my hope that other people will figure out smart stuff that Gnus
21510 can do, and that other people will write those smart things as well. To
21511 facilitate that I thought it would be a good idea to describe the inner
21512 workings of Gnus. And some of the not-so-inner workings, while I'm at
21515 You can never expect the internals of a program not to change, but I
21516 will be defining (in some details) the interface between Gnus and its
21517 backends (this is written in stone), the format of the score files
21518 (ditto), data structures (some are less likely to change than others)
21519 and general methods of operation.
21522 * Gnus Utility Functions:: Common functions and variable to use.
21523 * Backend Interface:: How Gnus communicates with the servers.
21524 * Score File Syntax:: A BNF definition of the score file standard.
21525 * Headers:: How Gnus stores headers internally.
21526 * Ranges:: A handy format for storing mucho numbers.
21527 * Group Info:: The group info format.
21528 * Extended Interactive:: Symbolic prefixes and stuff.
21529 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
21530 * Various File Formats:: Formats of files that Gnus use.
21534 @node Gnus Utility Functions
21535 @subsection Gnus Utility Functions
21536 @cindex Gnus utility functions
21537 @cindex utility functions
21539 @cindex internal variables
21541 When writing small functions to be run from hooks (and stuff), it's
21542 vital to have access to the Gnus internal functions and variables.
21543 Below is a list of the most common ones.
21547 @item gnus-newsgroup-name
21548 @vindex gnus-newsgroup-name
21549 This variable holds the name of the current newsgroup.
21551 @item gnus-find-method-for-group
21552 @findex gnus-find-method-for-group
21553 A function that returns the select method for @var{group}.
21555 @item gnus-group-real-name
21556 @findex gnus-group-real-name
21557 Takes a full (prefixed) Gnus group name, and returns the unprefixed
21560 @item gnus-group-prefixed-name
21561 @findex gnus-group-prefixed-name
21562 Takes an unprefixed group name and a select method, and returns the full
21563 (prefixed) Gnus group name.
21565 @item gnus-get-info
21566 @findex gnus-get-info
21567 Returns the group info list for @var{group}.
21569 @item gnus-group-unread
21570 @findex gnus-group-unread
21571 The number of unread articles in @var{group}, or @code{t} if that is
21575 @findex gnus-active
21576 The active entry for @var{group}.
21578 @item gnus-set-active
21579 @findex gnus-set-active
21580 Set the active entry for @var{group}.
21582 @item gnus-add-current-to-buffer-list
21583 @findex gnus-add-current-to-buffer-list
21584 Adds the current buffer to the list of buffers to be killed on Gnus
21587 @item gnus-continuum-version
21588 @findex gnus-continuum-version
21589 Takes a Gnus version string as a parameter and returns a floating point
21590 number. Earlier versions will always get a lower number than later
21593 @item gnus-group-read-only-p
21594 @findex gnus-group-read-only-p
21595 Says whether @var{group} is read-only or not.
21597 @item gnus-news-group-p
21598 @findex gnus-news-group-p
21599 Says whether @var{group} came from a news backend.
21601 @item gnus-ephemeral-group-p
21602 @findex gnus-ephemeral-group-p
21603 Says whether @var{group} is ephemeral or not.
21605 @item gnus-server-to-method
21606 @findex gnus-server-to-method
21607 Returns the select method corresponding to @var{server}.
21609 @item gnus-server-equal
21610 @findex gnus-server-equal
21611 Says whether two virtual servers are equal.
21613 @item gnus-group-native-p
21614 @findex gnus-group-native-p
21615 Says whether @var{group} is native or not.
21617 @item gnus-group-secondary-p
21618 @findex gnus-group-secondary-p
21619 Says whether @var{group} is secondary or not.
21621 @item gnus-group-foreign-p
21622 @findex gnus-group-foreign-p
21623 Says whether @var{group} is foreign or not.
21625 @item group-group-find-parameter
21626 @findex group-group-find-parameter
21627 Returns the parameter list of @var{group}. If given a second parameter,
21628 returns the value of that parameter for @var{group}.
21630 @item gnus-group-set-parameter
21631 @findex gnus-group-set-parameter
21632 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
21634 @item gnus-narrow-to-body
21635 @findex gnus-narrow-to-body
21636 Narrows the current buffer to the body of the article.
21638 @item gnus-check-backend-function
21639 @findex gnus-check-backend-function
21640 Takes two parameters, @var{function} and @var{group}. If the backend
21641 @var{group} comes from supports @var{function}, return non-@code{nil}.
21644 (gnus-check-backend-function "request-scan" "nnml:misc")
21648 @item gnus-read-method
21649 @findex gnus-read-method
21650 Prompts the user for a select method.
21655 @node Backend Interface
21656 @subsection Backend Interface
21658 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
21659 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
21660 server is a @dfn{backend} and some @dfn{backend variables}. As examples
21661 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
21662 examples of the latter we have @code{nntp-port-number} and
21663 @code{nnmbox-directory}.
21665 When Gnus asks for information from a backend---say @code{nntp}---on
21666 something, it will normally include a virtual server name in the
21667 function parameters. (If not, the backend should use the ``current''
21668 virtual server.) For instance, @code{nntp-request-list} takes a virtual
21669 server as its only (optional) parameter. If this virtual server hasn't
21670 been opened, the function should fail.
21672 Note that a virtual server name has no relation to some physical server
21673 name. Take this example:
21677 (nntp-address "ifi.uio.no")
21678 (nntp-port-number 4324))
21681 Here the virtual server name is @samp{odd-one} while the name of
21682 the physical server is @samp{ifi.uio.no}.
21684 The backends should be able to switch between several virtual servers.
21685 The standard backends implement this by keeping an alist of virtual
21686 server environments that they pull down/push up when needed.
21688 There are two groups of interface functions: @dfn{required functions},
21689 which must be present, and @dfn{optional functions}, which Gnus will
21690 always check for presence before attempting to call 'em.
21692 All these functions are expected to return data in the buffer
21693 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
21694 unfortunately named, but we'll have to live with it. When I talk about
21695 @dfn{resulting data}, I always refer to the data in that buffer. When I
21696 talk about @dfn{return value}, I talk about the function value returned by
21697 the function call. Functions that fail should return @code{nil} as the
21700 Some backends could be said to be @dfn{server-forming} backends, and
21701 some might be said not to be. The latter are backends that generally
21702 only operate on one group at a time, and have no concept of ``server''
21703 -- they have a group, and they deliver info on that group and nothing
21706 Gnus identifies each message by way of group name and article number. A
21707 few remarks about these article numbers might be useful. First of all,
21708 the numbers are positive integers. Secondly, it is normally not
21709 possible for later articles to `re-use' older article numbers without
21710 confusing Gnus. That is, if a group has ever contained a message
21711 numbered 42, then no other message may get that number, or Gnus will get
21712 mightily confused.@footnote{See the function
21713 @code{nnchoke-request-update-info}, @ref{Optional Backend Functions}.}
21714 Third, article numbers must be assigned in order of arrival in the
21715 group; this is not necessarily the same as the date of the message.
21717 The previous paragraph already mentions all the `hard' restrictions that
21718 article numbers must fulfill. But it seems that it might be useful to
21719 assign @emph{consecutive} article numbers, for Gnus gets quite confused
21720 if there are holes in the article numbering sequence. However, due to
21721 the `no-reuse' restriction, holes cannot be avoided altogether. It's
21722 also useful for the article numbers to start at 1 to avoid running out
21723 of numbers as long as possible.
21725 In the examples and definitions I will refer to the imaginary backend
21728 @cindex @code{nnchoke}
21731 * Required Backend Functions:: Functions that must be implemented.
21732 * Optional Backend Functions:: Functions that need not be implemented.
21733 * Error Messaging:: How to get messages and report errors.
21734 * Writing New Backends:: Extending old backends.
21735 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
21736 * Mail-like Backends:: Some tips on mail backends.
21740 @node Required Backend Functions
21741 @subsubsection Required Backend Functions
21745 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
21747 @var{articles} is either a range of article numbers or a list of
21748 @code{Message-ID}s. Current backends do not fully support either---only
21749 sequences (lists) of article numbers, and most backends do not support
21750 retrieval of @code{Message-ID}s. But they should try for both.
21752 The result data should either be HEADs or NOV lines, and the result
21753 value should either be @code{headers} or @code{nov} to reflect this.
21754 This might later be expanded to @code{various}, which will be a mixture
21755 of HEADs and NOV lines, but this is currently not supported by Gnus.
21757 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
21758 headers", in some meaning of the word. This is generally done by
21759 fetching (at most) @var{fetch-old} extra headers less than the smallest
21760 article number in @code{articles}, and filling the gaps as well. The
21761 presence of this parameter can be ignored if the backend finds it
21762 cumbersome to follow the request. If this is non-@code{nil} and not a
21763 number, do maximum fetches.
21765 Here's an example HEAD:
21768 221 1056 Article retrieved.
21769 Path: ifi.uio.no!sturles
21770 From: sturles@@ifi.uio.no (Sturle Sunde)
21771 Newsgroups: ifi.discussion
21772 Subject: Re: Something very droll
21773 Date: 27 Oct 1994 14:02:57 +0100
21774 Organization: Dept. of Informatics, University of Oslo, Norway
21776 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
21777 References: <38jdmq$4qu@@visbur.ifi.uio.no>
21778 NNTP-Posting-Host: holmenkollen.ifi.uio.no
21782 So a @code{headers} return value would imply that there's a number of
21783 these in the data buffer.
21785 Here's a BNF definition of such a buffer:
21789 head = error / valid-head
21790 error-message = [ "4" / "5" ] 2number " " <error message> eol
21791 valid-head = valid-message *header "." eol
21792 valid-message = "221 " <number> " Article retrieved." eol
21793 header = <text> eol
21796 If the return value is @code{nov}, the data buffer should contain
21797 @dfn{network overview database} lines. These are basically fields
21801 nov-buffer = *nov-line
21802 nov-line = 8*9 [ field <TAB> ] eol
21803 field = <text except TAB>
21806 For a closer look at what should be in those fields,
21810 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
21812 @var{server} is here the virtual server name. @var{definitions} is a
21813 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
21815 If the server can't be opened, no error should be signaled. The backend
21816 may then choose to refuse further attempts at connecting to this
21817 server. In fact, it should do so.
21819 If the server is opened already, this function should return a
21820 non-@code{nil} value. There should be no data returned.
21823 @item (nnchoke-close-server &optional SERVER)
21825 Close connection to @var{server} and free all resources connected
21826 to it. Return @code{nil} if the server couldn't be closed for some
21829 There should be no data returned.
21832 @item (nnchoke-request-close)
21834 Close connection to all servers and free all resources that the backend
21835 have reserved. All buffers that have been created by that backend
21836 should be killed. (Not the @code{nntp-server-buffer}, though.) This
21837 function is generally only called when Gnus is shutting down.
21839 There should be no data returned.
21842 @item (nnchoke-server-opened &optional SERVER)
21844 If @var{server} is the current virtual server, and the connection to the
21845 physical server is alive, then this function should return a
21846 non-@code{nil} vlue. This function should under no circumstances
21847 attempt to reconnect to a server we have lost connection to.
21849 There should be no data returned.
21852 @item (nnchoke-status-message &optional SERVER)
21854 This function should return the last error message from @var{server}.
21856 There should be no data returned.
21859 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
21861 The result data from this function should be the article specified by
21862 @var{article}. This might either be a @code{Message-ID} or a number.
21863 It is optional whether to implement retrieval by @code{Message-ID}, but
21864 it would be nice if that were possible.
21866 If @var{to-buffer} is non-@code{nil}, the result data should be returned
21867 in this buffer instead of the normal data buffer. This is to make it
21868 possible to avoid copying large amounts of data from one buffer to
21869 another, while Gnus mainly requests articles to be inserted directly
21870 into its article buffer.
21872 If it is at all possible, this function should return a cons cell where
21873 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
21874 the article number. This will enable Gnus to find out what the real
21875 group and article numbers are when fetching articles by
21876 @code{Message-ID}. If this isn't possible, @code{t} should be returned
21877 on successful article retrieval.
21880 @item (nnchoke-request-group GROUP &optional SERVER FAST)
21882 Get data on @var{group}. This function also has the side effect of
21883 making @var{group} the current group.
21885 If @var{fast}, don't bother to return useful data, just make @var{group}
21888 Here's an example of some result data and a definition of the same:
21891 211 56 1000 1059 ifi.discussion
21894 The first number is the status, which should be 211. Next is the
21895 total number of articles in the group, the lowest article number, the
21896 highest article number, and finally the group name. Note that the total
21897 number of articles may be less than one might think while just
21898 considering the highest and lowest article numbers, but some articles
21899 may have been canceled. Gnus just discards the total-number, so
21900 whether one should take the bother to generate it properly (if that is a
21901 problem) is left as an exercise to the reader.
21904 group-status = [ error / info ] eol
21905 error = [ "4" / "5" ] 2<number> " " <Error message>
21906 info = "211 " 3* [ <number> " " ] <string>
21910 @item (nnchoke-close-group GROUP &optional SERVER)
21912 Close @var{group} and free any resources connected to it. This will be
21913 a no-op on most backends.
21915 There should be no data returned.
21918 @item (nnchoke-request-list &optional SERVER)
21920 Return a list of all groups available on @var{server}. And that means
21923 Here's an example from a server that only carries two groups:
21926 ifi.test 0000002200 0000002000 y
21927 ifi.discussion 3324 3300 n
21930 On each line we have a group name, then the highest article number in
21931 that group, the lowest article number, and finally a flag.
21934 active-file = *active-line
21935 active-line = name " " <number> " " <number> " " flags eol
21937 flags = "n" / "y" / "m" / "x" / "j" / "=" name
21940 The flag says whether the group is read-only (@samp{n}), is moderated
21941 (@samp{m}), is dead (@samp{x}), is aliased to some other group
21942 (@samp{=other-group}) or none of the above (@samp{y}).
21945 @item (nnchoke-request-post &optional SERVER)
21947 This function should post the current buffer. It might return whether
21948 the posting was successful or not, but that's not required. If, for
21949 instance, the posting is done asynchronously, it has generally not been
21950 completed by the time this function concludes. In that case, this
21951 function should set up some kind of sentinel to beep the user loud and
21952 clear if the posting could not be completed.
21954 There should be no result data from this function.
21959 @node Optional Backend Functions
21960 @subsubsection Optional Backend Functions
21964 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
21966 @var{groups} is a list of groups, and this function should request data
21967 on all those groups. How it does it is of no concern to Gnus, but it
21968 should attempt to do this in a speedy fashion.
21970 The return value of this function can be either @code{active} or
21971 @code{group}, which says what the format of the result data is. The
21972 former is in the same format as the data from
21973 @code{nnchoke-request-list}, while the latter is a buffer full of lines
21974 in the same format as @code{nnchoke-request-group} gives.
21977 group-buffer = *active-line / *group-status
21981 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
21983 A Gnus group info (@pxref{Group Info}) is handed to the backend for
21984 alterations. This comes in handy if the backend really carries all the
21985 information (as is the case with virtual and imap groups). This
21986 function should destructively alter the info to suit its needs, and
21987 should return the (altered) group info.
21989 There should be no result data from this function.
21992 @item (nnchoke-request-type GROUP &optional ARTICLE)
21994 When the user issues commands for ``sending news'' (@kbd{F} in the
21995 summary buffer, for instance), Gnus has to know whether the article the
21996 user is following up on is news or mail. This function should return
21997 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
21998 is mail and @code{unknown} if the type can't be decided. (The
21999 @var{article} parameter is necessary in @code{nnvirtual} groups which
22000 might very well combine mail groups and news groups.) Both @var{group}
22001 and @var{article} may be @code{nil}.
22003 There should be no result data from this function.
22006 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
22008 Set/remove/add marks on articles. Normally Gnus handles the article
22009 marks (such as read, ticked, expired etc) internally, and store them in
22010 @code{~/.newsrc.eld}. Some backends (such as @sc{imap}) however carry
22011 all information about the articles on the server, so Gnus need to
22012 propagate the mark information to the server.
22014 ACTION is a list of mark setting requests, having this format:
22017 (RANGE ACTION MARK)
22020 RANGE is a range of articles you wish to update marks on. ACTION is
22021 @code{add} or @code{del}, used to add marks or remove marks
22022 (preserving all marks not mentioned). MARK is a list of marks; where
22023 each mark is a symbol. Currently used marks are @code{read},
22024 @code{tick}, @code{reply}, @code{expire}, @code{killed},
22025 @code{dormant}, @code{save}, @code{download}, @code{unsend},
22026 @code{forward} and @code{recent}, but your backend should, if
22027 possible, not limit itself to these.
22029 Given contradictory actions, the last action in the list should be the
22030 effective one. That is, if your action contains a request to add the
22031 @code{tick} mark on article 1 and, later in the list, a request to
22032 remove the mark on the same article, the mark should in fact be removed.
22034 An example action list:
22037 (((5 12 30) 'del '(tick))
22038 ((10 . 90) 'add '(read expire))
22039 ((92 94) 'del '(read)))
22042 The function should return a range of articles it wasn't able to set the
22043 mark on (currently not used for anything).
22045 There should be no result data from this function.
22047 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
22049 If the user tries to set a mark that the backend doesn't like, this
22050 function may change the mark. Gnus will use whatever this function
22051 returns as the mark for @var{article} instead of the original
22052 @var{mark}. If the backend doesn't care, it must return the original
22053 @var{mark}, and not @code{nil} or any other type of garbage.
22055 The only use for this I can see is what @code{nnvirtual} does with
22056 it---if a component group is auto-expirable, marking an article as read
22057 in the virtual group should result in the article being marked as
22060 There should be no result data from this function.
22063 @item (nnchoke-request-scan &optional GROUP SERVER)
22065 This function may be called at any time (by Gnus or anything else) to
22066 request that the backend check for incoming articles, in one way or
22067 another. A mail backend will typically read the spool file or query the
22068 POP server when this function is invoked. The @var{group} doesn't have
22069 to be heeded---if the backend decides that it is too much work just
22070 scanning for a single group, it may do a total scan of all groups. It
22071 would be nice, however, to keep things local if that's practical.
22073 There should be no result data from this function.
22076 @item (nnchoke-request-group-description GROUP &optional SERVER)
22078 The result data from this function should be a description of
22082 description-line = name <TAB> description eol
22084 description = <text>
22087 @item (nnchoke-request-list-newsgroups &optional SERVER)
22089 The result data from this function should be the description of all
22090 groups available on the server.
22093 description-buffer = *description-line
22097 @item (nnchoke-request-newgroups DATE &optional SERVER)
22099 The result data from this function should be all groups that were
22100 created after @samp{date}, which is in normal human-readable date
22101 format. The data should be in the active buffer format.
22104 @item (nnchoke-request-create-group GROUP &optional SERVER)
22106 This function should create an empty group with name @var{group}.
22108 There should be no return data.
22111 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
22113 This function should run the expiry process on all articles in the
22114 @var{articles} range (which is currently a simple list of article
22115 numbers.) It is left up to the backend to decide how old articles
22116 should be before they are removed by this function. If @var{force} is
22117 non-@code{nil}, all @var{articles} should be deleted, no matter how new
22120 This function should return a list of articles that it did not/was not
22123 There should be no result data returned.
22126 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
22129 This function should move @var{article} (which is a number) from
22130 @var{group} by calling @var{accept-form}.
22132 This function should ready the article in question for moving by
22133 removing any header lines it has added to the article, and generally
22134 should ``tidy up'' the article. Then it should @code{eval}
22135 @var{accept-form} in the buffer where the ``tidy'' article is. This
22136 will do the actual copying. If this @code{eval} returns a
22137 non-@code{nil} value, the article should be removed.
22139 If @var{last} is @code{nil}, that means that there is a high likelihood
22140 that there will be more requests issued shortly, so that allows some
22143 The function should return a cons where the @code{car} is the group name and
22144 the @code{cdr} is the article number that the article was entered as.
22146 There should be no data returned.
22149 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
22151 This function takes the current buffer and inserts it into @var{group}.
22152 If @var{last} in @code{nil}, that means that there will be more calls to
22153 this function in short order.
22155 The function should return a cons where the @code{car} is the group name and
22156 the @code{cdr} is the article number that the article was entered as.
22158 There should be no data returned.
22161 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
22163 This function should remove @var{article} (which is a number) from
22164 @var{group} and insert @var{buffer} there instead.
22166 There should be no data returned.
22169 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
22171 This function should delete @var{group}. If @var{force}, it should
22172 really delete all the articles in the group, and then delete the group
22173 itself. (If there is such a thing as ``the group itself''.)
22175 There should be no data returned.
22178 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
22180 This function should rename @var{group} into @var{new-name}. All
22181 articles in @var{group} should move to @var{new-name}.
22183 There should be no data returned.
22188 @node Error Messaging
22189 @subsubsection Error Messaging
22191 @findex nnheader-report
22192 @findex nnheader-get-report
22193 The backends should use the function @code{nnheader-report} to report
22194 error conditions---they should not raise errors when they aren't able to
22195 perform a request. The first argument to this function is the backend
22196 symbol, and the rest are interpreted as arguments to @code{format} if
22197 there are multiple of them, or just a string if there is one of them.
22198 This function must always returns @code{nil}.
22201 (nnheader-report 'nnchoke "You did something totally bogus")
22203 (nnheader-report 'nnchoke "Could not request group %s" group)
22206 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
22207 @code{nil} back from a server, and this function returns the most
22208 recently reported message for the backend in question. This function
22209 takes one argument---the server symbol.
22211 Internally, these functions access @var{backend}@code{-status-string},
22212 so the @code{nnchoke} backend will have its error message stored in
22213 @code{nnchoke-status-string}.
22216 @node Writing New Backends
22217 @subsubsection Writing New Backends
22219 Many backends are quite similar. @code{nnml} is just like
22220 @code{nnspool}, but it allows you to edit the articles on the server.
22221 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
22222 and it doesn't maintain overview databases. @code{nndir} is just like
22223 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
22226 It would make sense if it were possible to ``inherit'' functions from
22227 backends when writing new backends. And, indeed, you can do that if you
22228 want to. (You don't have to if you don't want to, of course.)
22230 All the backends declare their public variables and functions by using a
22231 package called @code{nnoo}.
22233 To inherit functions from other backends (and allow other backends to
22234 inherit functions from the current backend), you should use the
22240 This macro declares the first parameter to be a child of the subsequent
22241 parameters. For instance:
22244 (nnoo-declare nndir
22248 @code{nndir} has declared here that it intends to inherit functions from
22249 both @code{nnml} and @code{nnmh}.
22252 This macro is equivalent to @code{defvar}, but registers the variable as
22253 a public server variable. Most state-oriented variables should be
22254 declared with @code{defvoo} instead of @code{defvar}.
22256 In addition to the normal @code{defvar} parameters, it takes a list of
22257 variables in the parent backends to map the variable to when executing
22258 a function in those backends.
22261 (defvoo nndir-directory nil
22262 "Where nndir will look for groups."
22263 nnml-current-directory nnmh-current-directory)
22266 This means that @code{nnml-current-directory} will be set to
22267 @code{nndir-directory} when an @code{nnml} function is called on behalf
22268 of @code{nndir}. (The same with @code{nnmh}.)
22270 @item nnoo-define-basics
22271 This macro defines some common functions that almost all backends should
22275 (nnoo-define-basics nndir)
22279 This macro is just like @code{defun} and takes the same parameters. In
22280 addition to doing the normal @code{defun} things, it registers the
22281 function as being public so that other backends can inherit it.
22283 @item nnoo-map-functions
22284 This macro allows mapping of functions from the current backend to
22285 functions from the parent backends.
22288 (nnoo-map-functions nndir
22289 (nnml-retrieve-headers 0 nndir-current-group 0 0)
22290 (nnmh-request-article 0 nndir-current-group 0 0))
22293 This means that when @code{nndir-retrieve-headers} is called, the first,
22294 third, and fourth parameters will be passed on to
22295 @code{nnml-retrieve-headers}, while the second parameter is set to the
22296 value of @code{nndir-current-group}.
22299 This macro allows importing functions from backends. It should be the
22300 last thing in the source file, since it will only define functions that
22301 haven't already been defined.
22307 nnmh-request-newgroups)
22311 This means that calls to @code{nndir-request-list} should just be passed
22312 on to @code{nnmh-request-list}, while all public functions from
22313 @code{nnml} that haven't been defined in @code{nndir} yet should be
22318 Below is a slightly shortened version of the @code{nndir} backend.
22321 ;;; nndir.el --- single directory newsgroup access for Gnus
22322 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
22326 (require 'nnheader)
22330 (eval-when-compile (require 'cl))
22332 (nnoo-declare nndir
22335 (defvoo nndir-directory nil
22336 "Where nndir will look for groups."
22337 nnml-current-directory nnmh-current-directory)
22339 (defvoo nndir-nov-is-evil nil
22340 "*Non-nil means that nndir will never retrieve NOV headers."
22343 (defvoo nndir-current-group ""
22345 nnml-current-group nnmh-current-group)
22346 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
22347 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
22349 (defvoo nndir-status-string "" nil nnmh-status-string)
22350 (defconst nndir-version "nndir 1.0")
22352 ;;; Interface functions.
22354 (nnoo-define-basics nndir)
22356 (deffoo nndir-open-server (server &optional defs)
22357 (setq nndir-directory
22358 (or (cadr (assq 'nndir-directory defs))
22360 (unless (assq 'nndir-directory defs)
22361 (push `(nndir-directory ,server) defs))
22362 (push `(nndir-current-group
22363 ,(file-name-nondirectory
22364 (directory-file-name nndir-directory)))
22366 (push `(nndir-top-directory
22367 ,(file-name-directory (directory-file-name nndir-directory)))
22369 (nnoo-change-server 'nndir server defs))
22371 (nnoo-map-functions nndir
22372 (nnml-retrieve-headers 0 nndir-current-group 0 0)
22373 (nnmh-request-article 0 nndir-current-group 0 0)
22374 (nnmh-request-group nndir-current-group 0 0)
22375 (nnmh-close-group nndir-current-group 0))
22379 nnmh-status-message
22381 nnmh-request-newgroups))
22387 @node Hooking New Backends Into Gnus
22388 @subsubsection Hooking New Backends Into Gnus
22390 @vindex gnus-valid-select-methods
22391 Having Gnus start using your new backend is rather easy---you just
22392 declare it with the @code{gnus-declare-backend} functions. This will
22393 enter the backend into the @code{gnus-valid-select-methods} variable.
22395 @code{gnus-declare-backend} takes two parameters---the backend name and
22396 an arbitrary number of @dfn{abilities}.
22401 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
22404 The abilities can be:
22408 This is a mailish backend---followups should (probably) go via mail.
22410 This is a newsish backend---followups should (probably) go via news.
22412 This backend supports both mail and news.
22414 This is neither a post nor mail backend---it's something completely
22417 It supports respooling---or rather, it is able to modify its source
22418 articles and groups.
22420 The name of the server should be in the virtual server name. This is
22421 true for almost all backends.
22422 @item prompt-address
22423 The user should be prompted for an address when doing commands like
22424 @kbd{B} in the group buffer. This is true for backends like
22425 @code{nntp}, but not @code{nnmbox}, for instance.
22429 @node Mail-like Backends
22430 @subsubsection Mail-like Backends
22432 One of the things that separate the mail backends from the rest of the
22433 backends is the heavy dependence by the mail backends on common
22434 functions in @file{nnmail.el}. For instance, here's the definition of
22435 @code{nnml-request-scan}:
22438 (deffoo nnml-request-scan (&optional group server)
22439 (setq nnml-article-file-alist nil)
22440 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
22443 It simply calls @code{nnmail-get-new-mail} with a few parameters,
22444 and @code{nnmail} takes care of all the moving and splitting of the
22447 This function takes four parameters.
22451 This should be a symbol to designate which backend is responsible for
22454 @item exit-function
22455 This function should be called after the splitting has been performed.
22457 @item temp-directory
22458 Where the temporary files should be stored.
22461 This optional argument should be a group name if the splitting is to be
22462 performed for one group only.
22465 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
22466 save each article. @var{backend}@code{-active-number} will be called to
22467 find the article number assigned to this article.
22469 The function also uses the following variables:
22470 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
22471 this backend); and @var{backend}@code{-group-alist} and
22472 @var{backend}@code{-active-file} to generate the new active file.
22473 @var{backend}@code{-group-alist} should be a group-active alist, like
22477 (("a-group" (1 . 10))
22478 ("some-group" (34 . 39)))
22482 @node Score File Syntax
22483 @subsection Score File Syntax
22485 Score files are meant to be easily parseable, but yet extremely
22486 mallable. It was decided that something that had the same read syntax
22487 as an Emacs Lisp list would fit that spec.
22489 Here's a typical score file:
22493 ("win95" -10000 nil s)
22500 BNF definition of a score file:
22503 score-file = "" / "(" *element ")"
22504 element = rule / atom
22505 rule = string-rule / number-rule / date-rule
22506 string-rule = "(" quote string-header quote space *string-match ")"
22507 number-rule = "(" quote number-header quote space *number-match ")"
22508 date-rule = "(" quote date-header quote space *date-match ")"
22510 string-header = "subject" / "from" / "references" / "message-id" /
22511 "xref" / "body" / "head" / "all" / "followup"
22512 number-header = "lines" / "chars"
22513 date-header = "date"
22514 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
22515 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
22516 score = "nil" / <integer>
22517 date = "nil" / <natural number>
22518 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
22519 "r" / "regex" / "R" / "Regex" /
22520 "e" / "exact" / "E" / "Exact" /
22521 "f" / "fuzzy" / "F" / "Fuzzy"
22522 number-match = "(" <integer> [ "" / [ space score [ "" /
22523 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
22524 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
22525 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
22526 space date [ "" / [ space date-match-t ] ] ] ] ")"
22527 date-match-t = "nil" / "at" / "before" / "after"
22528 atom = "(" [ required-atom / optional-atom ] ")"
22529 required-atom = mark / expunge / mark-and-expunge / files /
22530 exclude-files / read-only / touched
22531 optional-atom = adapt / local / eval
22532 mark = "mark" space nil-or-number
22533 nil-or-number = "nil" / <integer>
22534 expunge = "expunge" space nil-or-number
22535 mark-and-expunge = "mark-and-expunge" space nil-or-number
22536 files = "files" *[ space <string> ]
22537 exclude-files = "exclude-files" *[ space <string> ]
22538 read-only = "read-only" [ space "nil" / space "t" ]
22539 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
22540 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
22541 local = "local" *[ space "(" <string> space <form> ")" ]
22542 eval = "eval" space <form>
22543 space = *[ " " / <TAB> / <NEWLINE> ]
22546 Any unrecognized elements in a score file should be ignored, but not
22549 As you can see, white space is needed, but the type and amount of white
22550 space is irrelevant. This means that formatting of the score file is
22551 left up to the programmer---if it's simpler to just spew it all out on
22552 one looong line, then that's ok.
22554 The meaning of the various atoms are explained elsewhere in this
22555 manual (@pxref{Score File Format}).
22559 @subsection Headers
22561 Internally Gnus uses a format for storing article headers that
22562 corresponds to the @sc{nov} format in a mysterious fashion. One could
22563 almost suspect that the author looked at the @sc{nov} specification and
22564 just shamelessly @emph{stole} the entire thing, and one would be right.
22566 @dfn{Header} is a severely overloaded term. ``Header'' is used in
22567 RFC 1036 to talk about lines in the head of an article (e.g.,
22568 @code{From}). It is used by many people as a synonym for
22569 ``head''---``the header and the body''. (That should be avoided, in my
22570 opinion.) And Gnus uses a format internally that it calls ``header'',
22571 which is what I'm talking about here. This is a 9-element vector,
22572 basically, with each header (ouch) having one slot.
22574 These slots are, in order: @code{number}, @code{subject}, @code{from},
22575 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
22576 @code{xref}, and @code{extra}. There are macros for accessing and
22577 setting these slots---they all have predictable names beginning with
22578 @code{mail-header-} and @code{mail-header-set-}, respectively.
22580 All these slots contain strings, except the @code{extra} slot, which
22581 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
22587 @sc{gnus} introduced a concept that I found so useful that I've started
22588 using it a lot and have elaborated on it greatly.
22590 The question is simple: If you have a large amount of objects that are
22591 identified by numbers (say, articles, to take a @emph{wild} example)
22592 that you want to qualify as being ``included'', a normal sequence isn't
22593 very useful. (A 200,000 length sequence is a bit long-winded.)
22595 The solution is as simple as the question: You just collapse the
22599 (1 2 3 4 5 6 10 11 12)
22602 is transformed into
22605 ((1 . 6) (10 . 12))
22608 To avoid having those nasty @samp{(13 . 13)} elements to denote a
22609 lonesome object, a @samp{13} is a valid element:
22612 ((1 . 6) 7 (10 . 12))
22615 This means that comparing two ranges to find out whether they are equal
22616 is slightly tricky:
22619 ((1 . 5) 7 8 (10 . 12))
22625 ((1 . 5) (7 . 8) (10 . 12))
22628 are equal. In fact, any non-descending list is a range:
22634 is a perfectly valid range, although a pretty long-winded one. This is
22641 and is equal to the previous range.
22643 Here's a BNF definition of ranges. Of course, one must remember the
22644 semantic requirement that the numbers are non-descending. (Any number
22645 of repetition of the same number is allowed, but apt to disappear in
22649 range = simple-range / normal-range
22650 simple-range = "(" number " . " number ")"
22651 normal-range = "(" start-contents ")"
22652 contents = "" / simple-range *[ " " contents ] /
22653 number *[ " " contents ]
22656 Gnus currently uses ranges to keep track of read articles and article
22657 marks. I plan on implementing a number of range operators in C if The
22658 Powers That Be are willing to let me. (I haven't asked yet, because I
22659 need to do some more thinking on what operators I need to make life
22660 totally range-based without ever having to convert back to normal
22665 @subsection Group Info
22667 Gnus stores all permanent info on groups in a @dfn{group info} list.
22668 This list is from three to six elements (or more) long and exhaustively
22669 describes the group.
22671 Here are two example group infos; one is a very simple group while the
22672 second is a more complex one:
22675 ("no.group" 5 ((1 . 54324)))
22677 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
22678 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
22680 ((auto-expire . t) (to-address . "ding@@gnus.org")))
22683 The first element is the @dfn{group name}---as Gnus knows the group,
22684 anyway. The second element is the @dfn{subscription level}, which
22685 normally is a small integer. (It can also be the @dfn{rank}, which is a
22686 cons cell where the @code{car} is the level and the @code{cdr} is the
22687 score.) The third element is a list of ranges of read articles. The
22688 fourth element is a list of lists of article marks of various kinds.
22689 The fifth element is the select method (or virtual server, if you like).
22690 The sixth element is a list of @dfn{group parameters}, which is what
22691 this section is about.
22693 Any of the last three elements may be missing if they are not required.
22694 In fact, the vast majority of groups will normally only have the first
22695 three elements, which saves quite a lot of cons cells.
22697 Here's a BNF definition of the group info format:
22700 info = "(" group space ralevel space read
22701 [ "" / [ space marks-list [ "" / [ space method [ "" /
22702 space parameters ] ] ] ] ] ")"
22703 group = quote <string> quote
22704 ralevel = rank / level
22705 level = <integer in the range of 1 to inf>
22706 rank = "(" level "." score ")"
22707 score = <integer in the range of 1 to inf>
22709 marks-lists = nil / "(" *marks ")"
22710 marks = "(" <string> range ")"
22711 method = "(" <string> *elisp-forms ")"
22712 parameters = "(" *elisp-forms ")"
22715 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
22716 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
22719 If you have a Gnus info and want to access the elements, Gnus offers a
22720 series of macros for getting/setting these elements.
22723 @item gnus-info-group
22724 @itemx gnus-info-set-group
22725 @findex gnus-info-group
22726 @findex gnus-info-set-group
22727 Get/set the group name.
22729 @item gnus-info-rank
22730 @itemx gnus-info-set-rank
22731 @findex gnus-info-rank
22732 @findex gnus-info-set-rank
22733 Get/set the group rank (@pxref{Group Score}).
22735 @item gnus-info-level
22736 @itemx gnus-info-set-level
22737 @findex gnus-info-level
22738 @findex gnus-info-set-level
22739 Get/set the group level.
22741 @item gnus-info-score
22742 @itemx gnus-info-set-score
22743 @findex gnus-info-score
22744 @findex gnus-info-set-score
22745 Get/set the group score (@pxref{Group Score}).
22747 @item gnus-info-read
22748 @itemx gnus-info-set-read
22749 @findex gnus-info-read
22750 @findex gnus-info-set-read
22751 Get/set the ranges of read articles.
22753 @item gnus-info-marks
22754 @itemx gnus-info-set-marks
22755 @findex gnus-info-marks
22756 @findex gnus-info-set-marks
22757 Get/set the lists of ranges of marked articles.
22759 @item gnus-info-method
22760 @itemx gnus-info-set-method
22761 @findex gnus-info-method
22762 @findex gnus-info-set-method
22763 Get/set the group select method.
22765 @item gnus-info-params
22766 @itemx gnus-info-set-params
22767 @findex gnus-info-params
22768 @findex gnus-info-set-params
22769 Get/set the group parameters.
22772 All the getter functions take one parameter---the info list. The setter
22773 functions take two parameters---the info list and the new value.
22775 The last three elements in the group info aren't mandatory, so it may be
22776 necessary to extend the group info before setting the element. If this
22777 is necessary, you can just pass on a non-@code{nil} third parameter to
22778 the three final setter functions to have this happen automatically.
22781 @node Extended Interactive
22782 @subsection Extended Interactive
22783 @cindex interactive
22784 @findex gnus-interactive
22786 Gnus extends the standard Emacs @code{interactive} specification
22787 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
22788 Prefixes}). Here's an example of how this is used:
22791 (defun gnus-summary-increase-score (&optional score symp)
22792 (interactive (gnus-interactive "P\ny"))
22797 The best thing to do would have been to implement
22798 @code{gnus-interactive} as a macro which would have returned an
22799 @code{interactive} form, but this isn't possible since Emacs checks
22800 whether a function is interactive or not by simply doing an @code{assq}
22801 on the lambda form. So, instead we have @code{gnus-interactive}
22802 function that takes a string and returns values that are usable to
22803 @code{interactive}.
22805 This function accepts (almost) all normal @code{interactive} specs, but
22810 @vindex gnus-current-prefix-symbol
22811 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
22815 @vindex gnus-current-prefix-symbols
22816 A list of the current symbolic prefixes---the
22817 @code{gnus-current-prefix-symbol} variable.
22820 The current article number---the @code{gnus-summary-article-number}
22824 The current article header---the @code{gnus-summary-article-header}
22828 The current group name---the @code{gnus-group-group-name}
22834 @node Emacs/XEmacs Code
22835 @subsection Emacs/XEmacs Code
22839 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
22840 platforms must be the primary one. I chose Emacs. Not because I don't
22841 like XEmacs or Mule, but because it comes first alphabetically.
22843 This means that Gnus will byte-compile under Emacs with nary a warning,
22844 while XEmacs will pump out gigabytes of warnings while byte-compiling.
22845 As I use byte-compilation warnings to help me root out trivial errors in
22846 Gnus, that's very useful.
22848 I've also consistently used Emacs function interfaces, but have used
22849 Gnusey aliases for the functions. To take an example: Emacs defines a
22850 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
22851 function. I then define a function called @code{gnus-run-at-time} that
22852 takes the same parameters as the Emacs @code{run-at-time}. When running
22853 Gnus under Emacs, the former function is just an alias for the latter.
22854 However, when running under XEmacs, the former is an alias for the
22855 following function:
22858 (defun gnus-xmas-run-at-time (time repeat function &rest args)
22862 (,function ,@@args))
22866 This sort of thing has been done for bunches of functions. Gnus does
22867 not redefine any native Emacs functions while running under XEmacs---it
22868 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
22871 In the cases where the XEmacs function interface was obviously cleaner,
22872 I used it instead. For example @code{gnus-region-active-p} is an alias
22873 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
22875 Of course, I could have chosen XEmacs as my native platform and done
22876 mapping functions the other way around. But I didn't. The performance
22877 hit these indirections impose on Gnus under XEmacs should be slight.
22880 @node Various File Formats
22881 @subsection Various File Formats
22884 * Active File Format:: Information on articles and groups available.
22885 * Newsgroups File Format:: Group descriptions.
22889 @node Active File Format
22890 @subsubsection Active File Format
22892 The active file lists all groups available on the server in
22893 question. It also lists the highest and lowest current article numbers
22896 Here's an excerpt from a typical active file:
22899 soc.motss 296030 293865 y
22900 alt.binaries.pictures.fractals 3922 3913 n
22901 comp.sources.unix 1605 1593 m
22902 comp.binaries.ibm.pc 5097 5089 y
22903 no.general 1000 900 y
22906 Here's a pseudo-BNF definition of this file:
22909 active = *group-line
22910 group-line = group spc high-number spc low-number spc flag <NEWLINE>
22911 group = <non-white-space string>
22913 high-number = <non-negative integer>
22914 low-number = <positive integer>
22915 flag = "y" / "n" / "m" / "j" / "x" / "=" group
22918 For a full description of this file, see the manual pages for
22919 @samp{innd}, in particular @samp{active(5)}.
22922 @node Newsgroups File Format
22923 @subsubsection Newsgroups File Format
22925 The newsgroups file lists groups along with their descriptions. Not all
22926 groups on the server have to be listed, and not all groups in the file
22927 have to exist on the server. The file is meant purely as information to
22930 The format is quite simple; a group name, a tab, and the description.
22931 Here's the definition:
22935 line = group tab description <NEWLINE>
22936 group = <non-white-space string>
22938 description = <string>
22943 @node Emacs for Heathens
22944 @section Emacs for Heathens
22946 Believe it or not, but some people who use Gnus haven't really used
22947 Emacs much before they embarked on their journey on the Gnus Love Boat.
22948 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
22949 region'', and ``set @code{gnus-flargblossen} to an alist where the key
22950 is a regexp that is used for matching on the group name'' are magical
22951 phrases with little or no meaning, then this appendix is for you. If
22952 you are already familiar with Emacs, just ignore this and go fondle your
22956 * Keystrokes:: Entering text and executing commands.
22957 * Emacs Lisp:: The built-in Emacs programming language.
22962 @subsection Keystrokes
22966 Q: What is an experienced Emacs user?
22969 A: A person who wishes that the terminal had pedals.
22972 Yes, when you use Emacs, you are apt to use the control key, the shift
22973 key and the meta key a lot. This is very annoying to some people
22974 (notably @code{vi}le users), and the rest of us just love the hell out
22975 of it. Just give up and submit. Emacs really does stand for
22976 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
22977 may have heard from other disreputable sources (like the Emacs author).
22979 The shift keys are normally located near your pinky fingers, and are
22980 normally used to get capital letters and stuff. You probably use it all
22981 the time. The control key is normally marked ``CTRL'' or something like
22982 that. The meta key is, funnily enough, never marked as such on any
22983 keyboard. The one I'm currently at has a key that's marked ``Alt'',
22984 which is the meta key on this keyboard. It's usually located somewhere
22985 to the left hand side of the keyboard, usually on the bottom row.
22987 Now, us Emacs people don't say ``press the meta-control-m key'',
22988 because that's just too inconvenient. We say ``press the @kbd{M-C-m}
22989 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
22990 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
22991 down the control key, and hold it down while you press @kbd{k}''.
22992 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
22993 the control key and then press @kbd{k}''. Simple, ay?
22995 This is somewhat complicated by the fact that not all keyboards have a
22996 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
22997 means ``press escape, release escape, press @kbd{k}''. That's much more
22998 work than if you have a meta key, so if that's the case, I respectfully
22999 suggest you get a real keyboard with a meta key. You can't live without
23005 @subsection Emacs Lisp
23007 Emacs is the King of Editors because it's really a Lisp interpreter.
23008 Each and every key you tap runs some Emacs Lisp code snippet, and since
23009 Emacs Lisp is an interpreted language, that means that you can configure
23010 any key to run any arbitrary code. You just, like, do it.
23012 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
23013 functions. (These are byte-compiled for speed, but it's still
23014 interpreted.) If you decide that you don't like the way Gnus does
23015 certain things, it's trivial to have it do something a different way.
23016 (Well, at least if you know how to write Lisp code.) However, that's
23017 beyond the scope of this manual, so we are simply going to talk about
23018 some common constructs that you normally use in your @file{.emacs} file
23021 If you want to set the variable @code{gnus-florgbnize} to four (4), you
23022 write the following:
23025 (setq gnus-florgbnize 4)
23028 This function (really ``special form'') @code{setq} is the one that can
23029 set a variable to some value. This is really all you need to know. Now
23030 you can go and fill your @code{.emacs} file with lots of these to change
23033 If you have put that thing in your @code{.emacs} file, it will be read
23034 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
23035 start Emacs. If you want to change the variable right away, simply say
23036 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
23037 previous ``form'', which is a simple @code{setq} statement here.
23039 Go ahead---just try it, if you're located at your Emacs. After you
23040 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
23041 is the return value of the form you @code{eval}ed.
23045 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
23049 (setq gnus-read-active-file 'some)
23052 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
23053 @samp{nntp.ifi.uio.no}'', that means:
23056 (setq gnus-nntp-server "nntp.ifi.uio.no")
23059 So be careful not to mix up strings (the latter) with symbols (the
23060 former). The manual is unambiguous, but it can be confusing.
23063 @include gnus-faq.texi
23084 % LocalWords: Backend BNF mucho Backends backends detailmenu cindex kindex kbd
23085 % LocalWords: findex Gnusae vindex dfn dfn samp nntp setq nnspool nntpserver
23086 % LocalWords: nnmbox backend newusers Blllrph NEWGROUPS dingnusdingnusdingnus
23087 % LocalWords: pre fab rec comp nnslashdot regex ga ga sci nnml nnbabyl nnmh
23088 % LocalWords: nnfolder emph looong eld newsreaders defun init elc pxref