sieve-manage-capability: Do not bug out when the server-value of the capability is nil
[gnus] / texi / gnus.texi
1 \input texinfo
2
3 @setfilename gnus
4 @settitle Gnus Manual
5 @syncodeindex fn cp
6 @syncodeindex vr cp
7 @syncodeindex pg cp
8
9 @documentencoding ISO-8859-1
10
11 @copying
12 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
13 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
14
15 @quotation
16 Permission is granted to copy, distribute and/or modify this document
17 under the terms of the GNU Free Documentation License, Version 1.3 or
18 any later version published by the Free Software Foundation; with no
19 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
20 and with the Back-Cover Texts as in (a) below.  A copy of the license
21 is included in the section entitled ``GNU Free Documentation License''.
22
23 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
24 modify this GNU manual.  Buying copies from the FSF supports it in
25 developing GNU and promoting software freedom.''
26 @end quotation
27 @end copying
28
29 @iftex
30 @iflatex
31 \documentclass[twoside,a4paper,openright,11pt]{book}
32 \usepackage[latin1]{inputenc}
33 \usepackage{pagestyle}
34 \usepackage{epsfig}
35 \usepackage{pixidx}
36 \input{gnusconfig.tex}
37
38 \ifx\pdfoutput\undefined
39 \else
40 \usepackage[pdftex,bookmarks,colorlinks=true]{hyperref}
41 \usepackage{thumbpdf}
42 \pdfcompresslevel=9
43 \fi
44
45 \makeindex
46 \begin{document}
47
48 % Adjust ../Makefile.in if you change the following line:
49 \newcommand{\gnusversionname}{No Gnus v0.11}
50 \newcommand{\gnuschaptername}{}
51 \newcommand{\gnussectionname}{}
52
53 \newcommand{\gnusbackslash}{/}
54
55 \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}}
56 \ifx\pdfoutput\undefined
57 \newcommand{\gnusuref}[1]{\gnustt{#1}}
58 \else
59 \newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}}
60 \fi
61 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
62 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
63
64 \newcommand{\gnuskindex}[1]{\index{#1}}
65 \newcommand{\gnusindex}[1]{\index{#1}}
66
67 \newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}}
68 \newcommand{\gnuscode}[1]{\gnustt{#1}}
69 \newcommand{\gnusasis}[1]{\gnustt{#1}}
70 \newcommand{\gnusurl}[1]{\gnustt{#1}}
71 \newcommand{\gnuscommand}[1]{\gnustt{#1}}
72 \newcommand{\gnusenv}[1]{\gnustt{#1}}
73 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''}
74 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
75 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
76 \newcommand{\gnuskey}[1]{`\gnustt{#1}'}
77 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
78 \newcommand{\gnusdfn}[1]{\textit{#1}}
79 \newcommand{\gnusi}[1]{\textit{#1}}
80 \newcommand{\gnusr}[1]{\textrm{#1}}
81 \newcommand{\gnusstrong}[1]{\textbf{#1}}
82 \newcommand{\gnusemph}[1]{\textit{#1}}
83 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
84 \newcommand{\gnussc}[1]{\textsc{#1}}
85 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
86 \newcommand{\gnusversion}[1]{{\small\textit{#1}}}
87 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
88 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
89 \newcommand{\gnusacronym}[1]{\textsc{#1}}
90 \newcommand{\gnusemail}[1]{\textit{#1}}
91
92 \newcommand{\gnusbullet}{{${\bullet}$}}
93 \newcommand{\gnusdollar}{\$}
94 \newcommand{\gnusampersand}{\&}
95 \newcommand{\gnuspercent}{\%}
96 \newcommand{\gnushash}{\#}
97 \newcommand{\gnushat}{\symbol{"5E}}
98 \newcommand{\gnusunderline}{\symbol{"5F}}
99 \newcommand{\gnusnot}{$\neg$}
100 \newcommand{\gnustilde}{\symbol{"7E}}
101 \newcommand{\gnusless}{{$<$}}
102 \newcommand{\gnusgreater}{{$>$}}
103 \newcommand{\gnusbraceleft}{{$>$}}
104 \newcommand{\gnusbraceright}{{$>$}}
105
106 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}}
107 \newcommand{\gnusinteresting}{
108 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
109 }
110
111 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
112
113 \newcommand{\gnuspagechapter}[1]{
114 {\mbox{}}
115 }
116
117 \newdimen{\gnusdimen}
118 \gnusdimen 0pt
119
120 \newcommand{\gnuschapter}[2]{
121 \gnuscleardoublepage
122 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
123 \chapter{#2}
124 \renewcommand{\gnussectionname}{}
125 \renewcommand{\gnuschaptername}{#2}
126 \thispagestyle{empty}
127 \hspace*{-2cm}
128 \begin{picture}(500,500)(0,0)
129 \put(480,350){\makebox(0,0)[tr]{#1}}
130 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
131 \end{picture}
132 \clearpage
133 }
134
135 \newcommand{\gnusfigure}[3]{
136 \begin{figure}
137 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
138 #3
139 \end{picture}
140 \caption{#1}
141 \end{figure}
142 }
143
144 \newcommand{\gnusicon}[1]{
145 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}}
146 }
147
148 \newcommand{\gnuspicon}[1]{
149 \margindex{\epsfig{figure=#1,width=2cm}}
150 }
151
152 \newcommand{\gnusxface}[2]{
153 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
154 }
155
156 \newcommand{\gnussmiley}[2]{
157 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
158 }
159
160 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
161
162 \newcommand{\gnussection}[1]{
163 \renewcommand{\gnussectionname}{#1}
164 \section{#1}
165 }
166
167 \newenvironment{codelist}%
168 {\begin{list}{}{
169 }
170 }{\end{list}}
171
172 \newenvironment{asislist}%
173 {\begin{list}{}{
174 }
175 }{\end{list}}
176
177 \newenvironment{kbdlist}%
178 {\begin{list}{}{
179 \labelwidth=0cm
180 }
181 }{\end{list}}
182
183 \newenvironment{dfnlist}%
184 {\begin{list}{}{
185 }
186 }{\end{list}}
187
188 \newenvironment{stronglist}%
189 {\begin{list}{}{
190 }
191 }{\end{list}}
192
193 \newenvironment{samplist}%
194 {\begin{list}{}{
195 }
196 }{\end{list}}
197
198 \newenvironment{varlist}%
199 {\begin{list}{}{
200 }
201 }{\end{list}}
202
203 \newenvironment{emphlist}%
204 {\begin{list}{}{
205 }
206 }{\end{list}}
207
208 \newlength\gnusheadtextwidth
209 \setlength{\gnusheadtextwidth}{\headtextwidth}
210 \addtolength{\gnusheadtextwidth}{1cm}
211
212 \newpagestyle{gnuspreamble}%
213 {
214 {
215 \ifodd\count0
216 {
217 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
218 }
219 \else
220 {
221 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
222 }
223 }
224 \fi
225 }
226 }
227 {
228 \ifodd\count0
229 \mbox{} \hfill
230 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
231 \else
232 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
233 \hfill \mbox{}
234 \fi
235 }
236
237 \newpagestyle{gnusindex}%
238 {
239 {
240 \ifodd\count0
241 {
242 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
243 }
244 \else
245 {
246 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
247 }
248 \fi
249 }
250 }
251 {
252 \ifodd\count0
253 \mbox{} \hfill
254 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
255 \else
256 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
257 \hfill \mbox{}
258 \fi
259 }
260
261 \newpagestyle{gnus}%
262 {
263 {
264 \ifodd\count0
265 {
266 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
267 }
268 \else
269 {
270 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
271 }
272 \fi
273 }
274 }
275 {
276 \ifodd\count0
277 \mbox{} \hfill
278 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
279 \else
280 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
281 \hfill \mbox{}
282 \fi
283 }
284
285 \pagenumbering{roman}
286 \pagestyle{gnuspreamble}
287
288 @end iflatex
289 @end iftex
290
291 @iftex
292 @iflatex
293
294 \begin{titlepage}
295 {
296
297 %\addtolength{\oddsidemargin}{-5cm}
298 %\addtolength{\evensidemargin}{-5cm}
299 \parindent=0cm
300 \addtolength{\textheight}{2cm}
301
302 \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\
303 \rule{15cm}{1mm}\\
304 \vfill
305 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm}
306 \vfill
307 \rule{15cm}{1mm}\\
308 \gnusauthor{by Lars Magne Ingebrigtsen}
309 \newpage
310 }
311
312 \mbox{}
313 \vfill
314
315 \thispagestyle{empty}
316
317 @c @insertcopying
318 \newpage
319 \end{titlepage}
320 @end iflatex
321 @end iftex
322
323 @dircategory Emacs
324 @direntry
325 * Gnus: (gnus).                 The newsreader Gnus.
326 @end direntry
327 @iftex
328 @finalout
329 @end iftex
330
331
332 @titlepage
333 @title Gnus Manual
334
335 @author by Lars Magne Ingebrigtsen
336 @page
337 @vskip 0pt plus 1filll
338 @insertcopying
339 @end titlepage
340
341 @summarycontents
342 @contents
343
344 @node Top
345 @top The Gnus Newsreader
346
347 @ifinfo
348
349 You can read news (and mail) from within Emacs by using Gnus.  The news
350 can be gotten by any nefarious means you can think of---@acronym{NNTP}, local
351 spool or your mbox file.  All at the same time, if you want to push your
352 luck.
353
354 @c Adjust ../Makefile.in if you change the following line:
355 This manual corresponds to No Gnus v0.11.
356
357 @ifnottex
358 @insertcopying
359 @end ifnottex
360
361 @end ifinfo
362
363 @iftex
364
365 @iflatex
366 \tableofcontents
367 \gnuscleardoublepage
368 @end iflatex
369
370 Gnus is the advanced, self-documenting, customizable, extensible
371 unreal-time newsreader for GNU Emacs.
372
373 Oops.  That sounds oddly familiar, so let's start over again to avoid
374 being accused of plagiarism:
375
376 Gnus is a message-reading laboratory.  It will let you look at just
377 about anything as if it were a newsgroup.  You can read mail with it,
378 you can browse directories with it, you can @code{ftp} with it---you
379 can even read news with it!
380
381 Gnus tries to empower people who read news the same way Emacs empowers
382 people who edit text.  Gnus sets no limits to what the user should be
383 allowed to do.  Users are encouraged to extend Gnus to make it behave
384 like they want it to behave.  A program should not control people;
385 people should be empowered to do what they want by using (or abusing)
386 the program.
387
388 @c Adjust ../Makefile.in if you change the following line:
389 This manual corresponds to No Gnus v0.11.
390
391 @heading Other related manuals
392 @itemize
393 @item Message manual: Composing messages
394 @item Emacs-MIME:     Composing messages; @acronym{MIME}-specific parts.
395 @item Sieve:          Managing Sieve scripts in Emacs.
396 @item PGG:            @acronym{PGP/MIME} with Gnus.
397 @item SASL:           @acronym{SASL} authentication in Emacs.
398 @end itemize
399
400 @end iftex
401
402 @menu
403 * Starting Up::              Finding news can be a pain.
404 * Group Buffer::             Selecting, subscribing and killing groups.
405 * Summary Buffer::           Reading, saving and posting articles.
406 * Article Buffer::           Displaying and handling articles.
407 * Composing Messages::       Information on sending mail and news.
408 * Select Methods::           Gnus reads all messages from various select methods.
409 * Scoring::                  Assigning values to articles.
410 * Various::                  General purpose settings.
411 * The End::                  Farewell and goodbye.
412 * Appendices::               Terminology, Emacs intro, @acronym{FAQ}, History, Internals.
413 * GNU Free Documentation License:: The license for this documentation.
414 * Index::                    Variable, function and concept index.
415 * Key Index::                Key Index.
416
417 Other related manuals
418
419 * Message:(message).         Composing messages.
420 * Emacs-MIME:(emacs-mime).   Composing messages; @acronym{MIME}-specific parts.
421 * Sieve:(sieve).             Managing Sieve scripts in Emacs.
422 * PGG:(pgg).                 @acronym{PGP/MIME} with Gnus.
423 * SASL:(sasl).               @acronym{SASL} authentication in Emacs.
424
425 @detailmenu
426  --- The Detailed Node Listing ---
427
428 Starting Gnus
429
430 * Finding the News::            Choosing a method for getting news.
431 * The First Time::              What does Gnus do the first time you start it?
432 * The Server is Down::          How can I read my mail then?
433 * Slave Gnusae::                You can have more than one Gnus active at a time.
434 * Fetching a Group::            Starting Gnus just to read a group.
435 * New Groups::                  What is Gnus supposed to do with new groups?
436 * Changing Servers::            You may want to move from one server to another.
437 * Startup Files::               Those pesky startup files---@file{.newsrc}.
438 * Auto Save::                   Recovering from a crash.
439 * The Active File::             Reading the active file over a slow line Takes Time.
440 * Startup Variables::           Other variables you might change.
441
442 New Groups
443
444 * Checking New Groups::         Determining what groups are new.
445 * Subscription Methods::        What Gnus should do with new groups.
446 * Filtering New Groups::        Making Gnus ignore certain new groups.
447
448 Group Buffer
449
450 * Group Buffer Format::         Information listed and how you can change it.
451 * Group Maneuvering::           Commands for moving in the group buffer.
452 * Selecting a Group::           Actually reading news.
453 * Subscription Commands::       Unsubscribing, killing, subscribing.
454 * Group Data::                  Changing the info for a group.
455 * Group Levels::                Levels? What are those, then?
456 * Group Score::                 A mechanism for finding out what groups you like.
457 * Marking Groups::              You can mark groups for later processing.
458 * Foreign Groups::              Creating and editing groups.
459 * Group Parameters::            Each group may have different parameters set.
460 * Listing Groups::              Gnus can list various subsets of the groups.
461 * Sorting Groups::              Re-arrange the group order.
462 * Group Maintenance::           Maintaining a tidy @file{.newsrc} file.
463 * Browse Foreign Server::       You can browse a server.  See what it has to offer.
464 * Exiting Gnus::                Stop reading news and get some work done.
465 * Group Topics::                A folding group mode divided into topics.
466 * Non-ASCII Group Names::       Accessing groups of non-English names.
467 * Misc Group Stuff::            Other stuff that you can to do.
468
469 Group Buffer Format
470
471 * Group Line Specification::    Deciding how the group buffer is to look.
472 * Group Mode Line Specification::  The group buffer mode line.
473 * Group Highlighting::          Having nice colors in the group buffer.
474
475 Group Topics
476
477 * Topic Commands::              Interactive E-Z commands.
478 * Topic Variables::             How to customize the topics the Lisp Way.
479 * Topic Sorting::               Sorting each topic individually.
480 * Topic Topology::              A map of the world.
481 * Topic Parameters::            Parameters that apply to all groups in a topic.
482
483 Misc Group Stuff
484
485 * Scanning New Messages::       Asking Gnus to see whether new messages have arrived.
486 * Group Information::           Information and help on groups and Gnus.
487 * Group Timestamp::             Making Gnus keep track of when you last read a group.
488 * File Commands::               Reading and writing the Gnus files.
489 * Sieve Commands::              Managing Sieve scripts.
490
491 Summary Buffer
492
493 * Summary Buffer Format::       Deciding how the summary buffer is to look.
494 * Summary Maneuvering::         Moving around the summary buffer.
495 * Choosing Articles::           Reading articles.
496 * Paging the Article::          Scrolling the current article.
497 * Reply Followup and Post::     Posting articles.
498 * Delayed Articles::            Send articles at a later time.
499 * Marking Articles::            Marking articles as read, expirable, etc.
500 * Limiting::                    You can limit the summary buffer.
501 * Threading::                   How threads are made.
502 * Sorting the Summary Buffer::  How articles and threads are sorted.
503 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
504 * Article Caching::             You may store articles in a cache.
505 * Persistent Articles::         Making articles expiry-resistant.
506 * Sticky Articles::             Article buffers that are not reused.
507 * Article Backlog::             Having already read articles hang around.
508 * Saving Articles::             Ways of customizing article saving.
509 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
510 * Article Treatment::           The article buffer can be mangled at will.
511 * MIME Commands::               Doing MIMEy things with the articles.
512 * Charsets::                    Character set issues.
513 * Article Commands::            Doing various things with the article buffer.
514 * Summary Sorting::             Sorting the summary buffer in various ways.
515 * Finding the Parent::          No child support? Get the parent.
516 * Alternative Approaches::      Reading using non-default summaries.
517 * Tree Display::                A more visual display of threads.
518 * Mail Group Commands::         Some commands can only be used in mail groups.
519 * Various Summary Stuff::       What didn't fit anywhere else.
520 * Exiting the Summary Buffer::  Returning to the Group buffer,
521                                 or reselecting the current group.
522 * Crosspost Handling::          How crossposted articles are dealt with.
523 * Duplicate Suppression::       An alternative when crosspost handling fails.
524 * Security::                    Decrypt and Verify.
525 * Mailing List::                Mailing list minor mode.
526
527 Summary Buffer Format
528
529 * Summary Buffer Lines::        You can specify how summary lines should look.
530 * To From Newsgroups::          How to not display your own name.
531 * Summary Buffer Mode Line::    You can say how the mode line should look.
532 * Summary Highlighting::        Making the summary buffer all pretty and nice.
533
534 Choosing Articles
535
536 * Choosing Commands::           Commands for choosing articles.
537 * Choosing Variables::          Variables that influence these commands.
538
539 Reply, Followup and Post
540
541 * Summary Mail Commands::       Sending mail.
542 * Summary Post Commands::       Sending news.
543 * Summary Message Commands::    Other Message-related commands.
544 * Canceling and Superseding::
545
546 Marking Articles
547
548 * Unread Articles::             Marks for unread articles.
549 * Read Articles::               Marks for read articles.
550 * Other Marks::                 Marks that do not affect readedness.
551 * Setting Marks::               How to set and remove marks.
552 * Generic Marking Commands::    How to customize the marking.
553 * Setting Process Marks::       How to mark articles for later processing.
554
555 Threading
556
557 * Customizing Threading::       Variables you can change to affect the threading.
558 * Thread Commands::             Thread based commands in the summary buffer.
559
560 Customizing Threading
561
562 * Loose Threads::               How Gnus gathers loose threads into bigger threads.
563 * Filling In Threads::          Making the threads displayed look fuller.
564 * More Threading::              Even more variables for fiddling with threads.
565 * Low-Level Threading::         You thought it was over@dots{} but you were wrong!
566
567 Decoding Articles
568
569 * Uuencoded Articles::          Uudecode articles.
570 * Shell Archives::              Unshar articles.
571 * PostScript Files::            Split PostScript.
572 * Other Files::                 Plain save and binhex.
573 * Decoding Variables::          Variables for a happy decoding.
574 * Viewing Files::               You want to look at the result of the decoding?
575
576 Decoding Variables
577
578 * Rule Variables::              Variables that say how a file is to be viewed.
579 * Other Decode Variables::      Other decode variables.
580 * Uuencoding and Posting::      Variables for customizing uuencoding.
581
582 Article Treatment
583
584 * Article Highlighting::        You want to make the article look like fruit salad.
585 * Article Fontisizing::         Making emphasized text look nice.
586 * Article Hiding::              You also want to make certain info go away.
587 * Article Washing::             Lots of way-neat functions to make life better.
588 * Article Header::              Doing various header transformations.
589 * Article Buttons::             Click on URLs, Message-IDs, addresses and the like.
590 * Article Button Levels::       Controlling appearance of buttons.
591 * Article Date::                Grumble, UT!
592 * Article Display::             Display various stuff---X-Face, Picons, Smileys, Gravatars
593 * Article Signature::           What is a signature?
594 * Article Miscellanea::         Various other stuff.
595
596 Alternative Approaches
597
598 * Pick and Read::               First mark articles and then read them.
599 * Binary Groups::               Auto-decode all articles.
600
601 Various Summary Stuff
602
603 * Summary Group Information::   Information oriented commands.
604 * Searching for Articles::      Multiple article commands.
605 * Summary Generation Commands::
606 * Really Various Summary Commands::  Those pesky non-conformant commands.
607
608 Article Buffer
609
610 * Hiding Headers::              Deciding what headers should be displayed.
611 * Using MIME::                  Pushing articles through @acronym{MIME} before reading them.
612 * Customizing Articles::        Tailoring the look of the articles.
613 * Article Keymap::              Keystrokes available in the article buffer.
614 * Misc Article::                Other stuff.
615
616 Composing Messages
617
618 * Mail::                        Mailing and replying.
619 * Posting Server::              What server should you post and mail via?
620 * POP before SMTP::             You cannot send a mail unless you read a mail.
621 * Mail and Post::               Mailing and posting at the same time.
622 * Archived Messages::           Where Gnus stores the messages you've sent.
623 * Posting Styles::              An easier way to specify who you are.
624 * Drafts::                      Postponing messages and rejected messages.
625 * Rejected Articles::           What happens if the server doesn't like your article?
626 * Signing and encrypting::      How to compose secure messages.
627
628 Select Methods
629
630 * Server Buffer::               Making and editing virtual servers.
631 * Getting News::                Reading USENET news with Gnus.
632 * Using IMAP::                  Reading mail from @acronym{IMAP}.
633 * Getting Mail::                Reading your personal mail with Gnus.
634 * Browsing the Web::            Getting messages from a plethora of Web sources.
635 * Other Sources::               Reading directories, files.
636 * Combined Groups::             Combining groups into one group.
637 * Email Based Diary::           Using mails to manage diary events in Gnus.
638 * Gnus Unplugged::              Reading news and mail offline.
639
640 Server Buffer
641
642 * Server Buffer Format::        You can customize the look of this buffer.
643 * Server Commands::             Commands to manipulate servers.
644 * Example Methods::             Examples server specifications.
645 * Creating a Virtual Server::   An example session.
646 * Server Variables::            Which variables to set.
647 * Servers and Methods::         You can use server names as select methods.
648 * Unavailable Servers::         Some servers you try to contact may be down.
649
650 Getting News
651
652 * NNTP::                        Reading news from an @acronym{NNTP} server.
653 * News Spool::                  Reading news from the local spool.
654
655 @acronym{NNTP}
656
657 * Direct Functions::            Connecting directly to the server.
658 * Indirect Functions::          Connecting indirectly to the server.
659 * Common Variables::            Understood by several connection functions.
660 * NNTP marks::                  Storing marks for @acronym{NNTP} servers.
661
662 Getting Mail
663
664 * Mail in a Newsreader::        Important introductory notes.
665 * Getting Started Reading Mail::  A simple cookbook example.
666 * Splitting Mail::              How to create mail groups.
667 * Mail Sources::                How to tell Gnus where to get mail from.
668 * Mail Back End Variables::     Variables for customizing mail handling.
669 * Fancy Mail Splitting::        Gnus can do hairy splitting of incoming mail.
670 * Group Mail Splitting::        Use group customize to drive mail splitting.
671 * Incorporating Old Mail::      What about the old mail you have?
672 * Expiring Mail::               Getting rid of unwanted mail.
673 * Washing Mail::                Removing cruft from the mail you get.
674 * Duplicates::                  Dealing with duplicated mail.
675 * Not Reading Mail::            Using mail back ends for reading other files.
676 * Choosing a Mail Back End::    Gnus can read a variety of mail formats.
677
678 Mail Sources
679
680 * Mail Source Specifiers::      How to specify what a mail source is.
681 * Mail Source Customization::   Some variables that influence things.
682 * Fetching Mail::               Using the mail source specifiers.
683
684 Choosing a Mail Back End
685
686 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
687 * Babyl::                       Babyl was used by older versions of Rmail.
688 * Mail Spool::                  Store your mail in a private spool?
689 * MH Spool::                    An mhspool-like back end.
690 * Maildir::                     Another one-file-per-message format.
691 * Mail Folders::                Having one file for each group.
692 * Comparing Mail Back Ends::    An in-depth looks at pros and cons.
693
694 Browsing the Web
695
696 * Archiving Mail::
697 * Web Searches::                Creating groups from articles that match a string.
698 * RSS::                         Reading RDF site summary.
699 * Customizing W3::              Doing stuff to Emacs/W3 from Gnus.
700
701 Other Sources
702
703 * Directory Groups::            You can read a directory as if it was a newsgroup.
704 * Anything Groups::             Dired?  Who needs dired?
705 * Document Groups::             Single files can be the basis of a group.
706 * Mail-To-News Gateways::       Posting articles via mail-to-news gateways.
707
708 Document Groups
709
710 * Document Server Internals::   How to add your own document types.
711
712 Combined Groups
713
714 * Virtual Groups::              Combining articles from many groups.
715
716 Email Based Diary
717
718 * The NNDiary Back End::        Basic setup and usage.
719 * The Gnus Diary Library::      Utility toolkit on top of nndiary.
720 * Sending or Not Sending::      A final note on sending diary messages.
721
722 The NNDiary Back End
723
724 * Diary Messages::              What makes a message valid for nndiary.
725 * Running NNDiary::             NNDiary has two modes of operation.
726 * Customizing NNDiary::         Bells and whistles.
727
728 The Gnus Diary Library
729
730 * Diary Summary Line Format::           A nicer summary buffer line format.
731 * Diary Articles Sorting::              A nicer way to sort messages.
732 * Diary Headers Generation::            Not doing it manually.
733 * Diary Group Parameters::              Not handling them manually.
734
735 Gnus Unplugged
736
737 * Agent Basics::                How it all is supposed to work.
738 * Agent Categories::            How to tell the Gnus Agent what to download.
739 * Agent Commands::              New commands for all the buffers.
740 * Agent Visuals::               Ways that the agent may effect your summary buffer.
741 * Agent as Cache::              The Agent is a big cache too.
742 * Agent Expiry::                How to make old articles go away.
743 * Agent Regeneration::          How to recover from lost connections and other accidents.
744 * Agent and flags::             How the Agent maintains flags.
745 * Agent and IMAP::              How to use the Agent with @acronym{IMAP}.
746 * Outgoing Messages::           What happens when you post/mail something?
747 * Agent Variables::             Customizing is fun.
748 * Example Setup::               An example @file{~/.gnus.el} file for offline people.
749 * Batching Agents::             How to fetch news from a @code{cron} job.
750 * Agent Caveats::               What you think it'll do and what it does.
751
752 Agent Categories
753
754 * Category Syntax::             What a category looks like.
755 * Category Buffer::             A buffer for maintaining categories.
756 * Category Variables::          Customize'r'Us.
757
758 Agent Commands
759
760 * Group Agent Commands::        Configure groups and fetch their contents.
761 * Summary Agent Commands::      Manually select then fetch specific articles.
762 * Server Agent Commands::       Select the servers that are supported by the agent.
763
764 Scoring
765
766 * Summary Score Commands::      Adding score entries for the current group.
767 * Group Score Commands::        General score commands.
768 * Score Variables::             Customize your scoring.  (My, what terminology).
769 * Score File Format::           What a score file may contain.
770 * Score File Editing::          You can edit score files by hand as well.
771 * Adaptive Scoring::            Big Sister Gnus knows what you read.
772 * Home Score File::             How to say where new score entries are to go.
773 * Followups To Yourself::       Having Gnus notice when people answer you.
774 * Scoring On Other Headers::    Scoring on non-standard headers.
775 * Scoring Tips::                How to score effectively.
776 * Reverse Scoring::             That problem child of old is not problem.
777 * Global Score Files::          Earth-spanning, ear-splitting score files.
778 * Kill Files::                  They are still here, but they can be ignored.
779 * Converting Kill Files::       Translating kill files to score files.
780 * Advanced Scoring::            Using logical expressions to build score rules.
781 * Score Decays::                It can be useful to let scores wither away.
782
783 Advanced Scoring
784
785 * Advanced Scoring Syntax::     A definition.
786 * Advanced Scoring Examples::   What they look like.
787 * Advanced Scoring Tips::       Getting the most out of it.
788
789 Various
790
791 * Process/Prefix::              A convention used by many treatment commands.
792 * Interactive::                 Making Gnus ask you many questions.
793 * Symbolic Prefixes::           How to supply some Gnus functions with options.
794 * Formatting Variables::        You can specify what buffers should look like.
795 * Window Layout::               Configuring the Gnus buffer windows.
796 * Faces and Fonts::             How to change how faces look.
797 * Compilation::                 How to speed Gnus up.
798 * Mode Lines::                  Displaying information in the mode lines.
799 * Highlighting and Menus::      Making buffers look all nice and cozy.
800 * Daemons::                     Gnus can do things behind your back.
801 * Undo::                        Some actions can be undone.
802 * Predicate Specifiers::        Specifying predicates.
803 * Moderation::                  What to do if you're a moderator.
804 * Image Enhancements::          Modern versions of Emacs/XEmacs can display images.
805 * Fuzzy Matching::              What's the big fuzz?
806 * Thwarting Email Spam::        Simple ways to avoid unsolicited commercial email.
807 * Spam Package::                A package for filtering and processing spam.
808 * The Gnus Registry::           A package for tracking messages by Message-ID.
809 * Other modes::                 Interaction with other modes.
810 * Various Various::             Things that are really various.
811
812 Formatting Variables
813
814 * Formatting Basics::           A formatting variable is basically a format string.
815 * Mode Line Formatting::        Some rules about mode line formatting variables.
816 * Advanced Formatting::         Modifying output in various ways.
817 * User-Defined Specs::          Having Gnus call your own functions.
818 * Formatting Fonts::            Making the formatting look colorful and nice.
819 * Positioning Point::           Moving point to a position after an operation.
820 * Tabulation::                  Tabulating your output.
821 * Wide Characters::             Dealing with wide characters.
822
823 Image Enhancements
824
825 * X-Face::                      Display a funky, teensy black-and-white image.
826 * Face::                        Display a funkier, teensier colored image.
827 * Smileys::                     Show all those happy faces the way they were
828                                   meant to be shown.
829 * Picons::                      How to display pictures of what you're reading.
830 * XVarious::                    Other XEmacsy Gnusey variables.
831
832 Thwarting Email Spam
833
834 * The problem of spam::         Some background, and some solutions
835 * Anti-Spam Basics::            Simple steps to reduce the amount of spam.
836 * SpamAssassin::                How to use external anti-spam tools.
837 * Hashcash::                    Reduce spam by burning CPU time.
838
839 Spam Package
840
841 * Spam Package Introduction::
842 * Filtering Incoming Mail::
843 * Detecting Spam in Groups::
844 * Spam and Ham Processors::
845 * Spam Package Configuration Examples::
846 * Spam Back Ends::
847 * Extending the Spam package::
848 * Spam Statistics Package::
849
850 Spam Statistics Package
851
852 * Creating a spam-stat dictionary::
853 * Splitting mail using spam-stat::
854 * Low-level interface to the spam-stat dictionary::
855
856 Appendices
857
858 * XEmacs::                      Requirements for installing under XEmacs.
859 * History::                     How Gnus got where it is today.
860 * On Writing Manuals::          Why this is not a beginner's guide.
861 * Terminology::                 We use really difficult, like, words here.
862 * Customization::               Tailoring Gnus to your needs.
863 * Troubleshooting::             What you might try if things do not work.
864 * Gnus Reference Guide::        Rilly, rilly technical stuff.
865 * Emacs for Heathens::          A short introduction to Emacsian terms.
866 * Frequently Asked Questions::  The Gnus FAQ
867
868 History
869
870 * Gnus Versions::               What Gnus versions have been released.
871 * Other Gnus Versions::         Other Gnus versions that also have been released.
872 * Why?::                        What's the point of Gnus?
873 * Compatibility::               Just how compatible is Gnus with @sc{gnus}?
874 * Conformity::                  Gnus tries to conform to all standards.
875 * Emacsen::                     Gnus can be run on a few modern Emacsen.
876 * Gnus Development::            How Gnus is developed.
877 * Contributors::                Oodles of people.
878 * New Features::                Pointers to some of the new stuff in Gnus.
879
880 New Features
881
882 * ding Gnus::                   New things in Gnus 5.0/5.1, the first new Gnus.
883 * September Gnus::              The Thing Formally Known As Gnus 5.2/5.3.
884 * Red Gnus::                    Third time best---Gnus 5.4/5.5.
885 * Quassia Gnus::                Two times two is four, or Gnus 5.6/5.7.
886 * Pterodactyl Gnus::            Pentad also starts with P, AKA Gnus 5.8/5.9.
887 * Oort Gnus::                   It's big.  It's far out.  Gnus 5.10/5.11.
888 * No Gnus::                     Very punny.
889
890 Customization
891
892 * Slow/Expensive Connection::   You run a local Emacs and get the news elsewhere.
893 * Slow Terminal Connection::    You run a remote Emacs.
894 * Little Disk Space::           You feel that having large setup files is icky.
895 * Slow Machine::                You feel like buying a faster machine.
896
897 Gnus Reference Guide
898
899 * Gnus Utility Functions::      Common functions and variable to use.
900 * Back End Interface::          How Gnus communicates with the servers.
901 * Score File Syntax::           A BNF definition of the score file standard.
902 * Headers::                     How Gnus stores headers internally.
903 * Ranges::                      A handy format for storing mucho numbers.
904 * Group Info::                  The group info format.
905 * Extended Interactive::        Symbolic prefixes and stuff.
906 * Emacs/XEmacs Code::           Gnus can be run under all modern Emacsen.
907 * Various File Formats::        Formats of files that Gnus use.
908
909 Back End Interface
910
911 * Required Back End Functions::  Functions that must be implemented.
912 * Optional Back End Functions::  Functions that need not be implemented.
913 * Error Messaging::             How to get messages and report errors.
914 * Writing New Back Ends::       Extending old back ends.
915 * Hooking New Back Ends Into Gnus::  What has to be done on the Gnus end.
916 * Mail-like Back Ends::         Some tips on mail back ends.
917
918 Various File Formats
919
920 * Active File Format::          Information on articles and groups available.
921 * Newsgroups File Format::      Group descriptions.
922
923 Emacs for Heathens
924
925 * Keystrokes::                  Entering text and executing commands.
926 * Emacs Lisp::                  The built-in Emacs programming language.
927
928 @end detailmenu
929 @end menu
930
931 @node Starting Up
932 @chapter Starting Gnus
933 @cindex starting up
934
935 If you haven't used Emacs much before using Gnus, read @ref{Emacs for
936 Heathens} first.
937
938 @kindex M-x gnus
939 @findex gnus
940 If your system administrator has set things up properly, starting Gnus
941 and reading news is extremely easy---you just type @kbd{M-x gnus} in
942 your Emacs.  If not, you should customize the variable
943 @code{gnus-select-method} as described in @ref{Finding the News}.  For a
944 minimal setup for posting should also customize the variables
945 @code{user-full-name} and @code{user-mail-address}.
946
947 @findex gnus-other-frame
948 @kindex M-x gnus-other-frame
949 If you want to start Gnus in a different frame, you can use the command
950 @kbd{M-x gnus-other-frame} instead.
951
952 If things do not go smoothly at startup, you have to twiddle some
953 variables in your @file{~/.gnus.el} file.  This file is similar to
954 @file{~/.emacs}, but is read when Gnus starts.
955
956 If you puzzle at any terms used in this manual, please refer to the
957 terminology section (@pxref{Terminology}).
958
959 @menu
960 * Finding the News::      Choosing a method for getting news.
961 * The First Time::        What does Gnus do the first time you start it?
962 * The Server is Down::    How can I read my mail then?
963 * Slave Gnusae::          You can have more than one Gnus active at a time.
964 * New Groups::            What is Gnus supposed to do with new groups?
965 * Changing Servers::      You may want to move from one server to another.
966 * Startup Files::         Those pesky startup files---@file{.newsrc}.
967 * Auto Save::             Recovering from a crash.
968 * The Active File::       Reading the active file over a slow line Takes Time.
969 * Startup Variables::     Other variables you might change.
970 @end menu
971
972
973 @node Finding the News
974 @section Finding the News
975 @cindex finding news
976
977 First of all, you should know that there is a special buffer called
978 @code{*Server*} that lists all the servers Gnus knows about.  You can
979 press @kbd{^} from the Group buffer to see it.  In the Server buffer,
980 you can press @kbd{RET} on a defined server to see all the groups it
981 serves (subscribed or not!).  You can also add or delete servers, edit
982 a foreign server's definition, agentize or de-agentize a server, and
983 do many other neat things.  @xref{Server Buffer}.  
984 @xref{Foreign Groups}.  @xref{Agent Basics}.
985
986 @vindex gnus-select-method
987 @c @head
988 The @code{gnus-select-method} variable says where Gnus should look for
989 news.  This variable should be a list where the first element says
990 @dfn{how} and the second element says @dfn{where}.  This method is your
991 native method.  All groups not fetched with this method are
992 foreign groups.
993
994 For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where
995 you want to get your daily dosage of news from, you'd say:
996
997 @lisp
998 (setq gnus-select-method '(nntp "news.somewhere.edu"))
999 @end lisp
1000
1001 If you want to read directly from the local spool, say:
1002
1003 @lisp
1004 (setq gnus-select-method '(nnspool ""))
1005 @end lisp
1006
1007 If you can use a local spool, you probably should, as it will almost
1008 certainly be much faster.  But do not use the local spool if your
1009 server is running Leafnode (which is a simple, standalone private news
1010 server); in this case, use @code{(nntp "localhost")}.
1011
1012 @vindex gnus-nntpserver-file
1013 @cindex NNTPSERVER
1014 @cindex @acronym{NNTP} server
1015 If this variable is not set, Gnus will take a look at the
1016 @env{NNTPSERVER} environment variable.  If that variable isn't set,
1017 Gnus will see whether @code{gnus-nntpserver-file}
1018 (@file{/etc/nntpserver} by default) has any opinions on the matter.
1019 If that fails as well, Gnus will try to use the machine running Emacs
1020 as an @acronym{NNTP} server.  That's a long shot, though.
1021
1022 @vindex gnus-nntp-server
1023 If @code{gnus-nntp-server} is set, this variable will override
1024 @code{gnus-select-method}.  You should therefore set
1025 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1026
1027 @vindex gnus-secondary-servers
1028 @vindex gnus-nntp-server
1029 You can also make Gnus prompt you interactively for the name of an
1030 @acronym{NNTP} server.  If you give a non-numerical prefix to @code{gnus}
1031 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
1032 in the @code{gnus-secondary-servers} list (if any).  You can also just
1033 type in the name of any server you feel like visiting.  (Note that this
1034 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1035 gnus} later in the same Emacs session, Gnus will contact the same
1036 server.)
1037
1038 @findex gnus-group-browse-foreign-server
1039 @kindex B (Group)
1040 However, if you use one @acronym{NNTP} server regularly and are just
1041 interested in a couple of groups from a different server, you would be
1042 better served by using the @kbd{B} command in the group buffer.  It will
1043 let you have a look at what groups are available, and you can subscribe
1044 to any of the groups you want to.  This also makes @file{.newsrc}
1045 maintenance much tidier.  @xref{Foreign Groups}.
1046
1047 @vindex gnus-secondary-select-methods
1048 @c @head
1049 A slightly different approach to foreign groups is to set the
1050 @code{gnus-secondary-select-methods} variable.  The select methods
1051 listed in this variable are in many ways just as native as the
1052 @code{gnus-select-method} server.  They will also be queried for active
1053 files during startup (if that's required), and new newsgroups that
1054 appear on these servers will be subscribed (or not) just as native
1055 groups are.
1056
1057 For instance, if you use the @code{nnmbox} back end to read your mail,
1058 you would typically set this variable to
1059
1060 @lisp
1061 (setq gnus-secondary-select-methods '((nnmbox "")))
1062 @end lisp
1063
1064 Note: the @acronym{NNTP} back end stores marks in marks files
1065 (@pxref{NNTP marks}).  This feature makes it easy to share marks between
1066 several Gnus installations, but may slow down things a bit when fetching
1067 new articles.  @xref{NNTP marks}, for more information.
1068
1069
1070 @node The First Time
1071 @section The First Time
1072 @cindex first time usage
1073
1074 If no startup files exist (@pxref{Startup Files}), Gnus will try to
1075 determine what groups should be subscribed by default.
1076
1077 @vindex gnus-default-subscribed-newsgroups
1078 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
1079 will subscribe you to just those groups in that list, leaving the rest
1080 killed.  Your system administrator should have set this variable to
1081 something useful.
1082
1083 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
1084 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is defined
1085 here as @dfn{whatever Lars thinks you should read}.)
1086
1087 You'll also be subscribed to the Gnus documentation group, which should
1088 help you with most common problems.
1089
1090 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
1091 use the normal functions for handling new groups, and not do anything
1092 special.
1093
1094
1095 @node The Server is Down
1096 @section The Server is Down
1097 @cindex server errors
1098
1099 If the default server is down, Gnus will understandably have some
1100 problems starting.  However, if you have some mail groups in addition to
1101 the news groups, you may want to start Gnus anyway.
1102
1103 Gnus, being the trusting sort of program, will ask whether to proceed
1104 without a native select method if that server can't be contacted.  This
1105 will happen whether the server doesn't actually exist (i.e., you have
1106 given the wrong address) or the server has just momentarily taken ill
1107 for some reason or other.  If you decide to continue and have no foreign
1108 groups, you'll find it difficult to actually do anything in the group
1109 buffer.  But, hey, that's your problem.  Blllrph!
1110
1111 @findex gnus-no-server
1112 @kindex M-x gnus-no-server
1113 @c @head
1114 If you know that the server is definitely down, or you just want to read
1115 your mail without bothering with the server at all, you can use the
1116 @code{gnus-no-server} command to start Gnus.  That might come in handy
1117 if you're in a hurry as well.  This command will not attempt to contact
1118 your primary server---instead, it will just activate all groups on level
1119 1 and 2.  (You should preferably keep no native groups on those two
1120 levels.) Also @pxref{Group Levels}.
1121
1122
1123 @node Slave Gnusae
1124 @section Slave Gnusae
1125 @cindex slave
1126
1127 You might want to run more than one Emacs with more than one Gnus at the
1128 same time.  If you are using different @file{.newsrc} files (e.g., if you
1129 are using the two different Gnusae to read from two different servers),
1130 that is no problem whatsoever.  You just do it.
1131
1132 The problem appears when you want to run two Gnusae that use the same
1133 @file{.newsrc} file.
1134
1135 To work around that problem some, we here at the Think-Tank at the Gnus
1136 Towers have come up with a new concept: @dfn{Masters} and
1137 @dfn{slaves}.  (We have applied for a patent on this concept, and have
1138 taken out a copyright on those words.  If you wish to use those words in
1139 conjunction with each other, you have to send $1 per usage instance to
1140 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
1141 Applications}) will be much more expensive, of course.)
1142
1143 @findex gnus-slave
1144 Anyway, you start one Gnus up the normal way with @kbd{M-x gnus} (or
1145 however you do it).  Each subsequent slave Gnusae should be started with
1146 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
1147 files, but instead save @dfn{slave files} that contain information only
1148 on what groups have been read in the slave session.  When a master Gnus
1149 starts, it will read (and delete) these slave files, incorporating all
1150 information from them.  (The slave files will be read in the sequence
1151 they were created, so the latest changes will have precedence.)
1152
1153 Information from the slave files has, of course, precedence over the
1154 information in the normal (i.e., master) @file{.newsrc} file.
1155
1156 If the @file{.newsrc*} files have not been saved in the master when the
1157 slave starts, you may be prompted as to whether to read an auto-save
1158 file.  If you answer ``yes'', the unsaved changes to the master will be
1159 incorporated into the slave.  If you answer ``no'', the slave may see some
1160 messages as unread that have been read in the master.
1161
1162
1163
1164 @node New Groups
1165 @section New Groups
1166 @cindex new groups
1167 @cindex subscription
1168
1169 @vindex gnus-check-new-newsgroups
1170 If you are satisfied that you really never want to see any new groups,
1171 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
1172 also save you some time at startup.  Even if this variable is
1173 @code{nil}, you can always subscribe to the new groups just by pressing
1174 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
1175 is @code{ask-server} by default.  If you set this variable to
1176 @code{always}, then Gnus will query the back ends for new groups even
1177 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1178
1179 @menu
1180 * Checking New Groups::         Determining what groups are new.
1181 * Subscription Methods::        What Gnus should do with new groups.
1182 * Filtering New Groups::        Making Gnus ignore certain new groups.
1183 @end menu
1184
1185
1186 @node Checking New Groups
1187 @subsection Checking New Groups
1188
1189 Gnus normally determines whether a group is new or not by comparing the
1190 list of groups from the active file(s) with the lists of subscribed and
1191 dead groups.  This isn't a particularly fast method.  If
1192 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
1193 server for new groups since the last time.  This is both faster and
1194 cheaper.  This also means that you can get rid of the list of killed
1195 groups altogether, so you may set @code{gnus-save-killed-list} to
1196 @code{nil}, which will save time both at startup, at exit, and all over.
1197 Saves disk space, too.  Why isn't this the default, then?
1198 Unfortunately, not all servers support this command.
1199
1200 I bet I know what you're thinking now: How do I find out whether my
1201 server supports @code{ask-server}?  No?  Good, because I don't have a
1202 fail-safe answer.  I would suggest just setting this variable to
1203 @code{ask-server} and see whether any new groups appear within the next
1204 few days.  If any do, then it works.  If none do, then it doesn't
1205 work.  I could write a function to make Gnus guess whether the server
1206 supports @code{ask-server}, but it would just be a guess.  So I won't.
1207 You could @code{telnet} to the server and say @code{HELP} and see
1208 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
1209 it does, then it might work.  (But there are servers that lists
1210 @samp{NEWGROUPS} without supporting the function properly.)
1211
1212 This variable can also be a list of select methods.  If so, Gnus will
1213 issue an @code{ask-server} command to each of the select methods, and
1214 subscribe them (or not) using the normal methods.  This might be handy
1215 if you are monitoring a few servers for new groups.  A side effect is
1216 that startup will take much longer, so you can meditate while waiting.
1217 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1218
1219
1220 @node Subscription Methods
1221 @subsection Subscription Methods
1222
1223 @vindex gnus-subscribe-newsgroup-method
1224 What Gnus does when it encounters a new group is determined by the
1225 @code{gnus-subscribe-newsgroup-method} variable.
1226
1227 This variable should contain a function.  This function will be called
1228 with the name of the new group as the only parameter.
1229
1230 Some handy pre-fab functions are:
1231
1232 @table @code
1233
1234 @item gnus-subscribe-zombies
1235 @vindex gnus-subscribe-zombies
1236 Make all new groups zombies.  This is the default.  You can browse the
1237 zombies later (with @kbd{A z}) and either kill them all off properly
1238 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1239
1240 @item gnus-subscribe-randomly
1241 @vindex gnus-subscribe-randomly
1242 Subscribe all new groups in arbitrary order.  This really means that all
1243 new groups will be added at ``the top'' of the group buffer.
1244
1245 @item gnus-subscribe-alphabetically
1246 @vindex gnus-subscribe-alphabetically
1247 Subscribe all new groups in alphabetical order.
1248
1249 @item gnus-subscribe-hierarchically
1250 @vindex gnus-subscribe-hierarchically
1251 Subscribe all new groups hierarchically.  The difference between this
1252 function and @code{gnus-subscribe-alphabetically} is slight.
1253 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1254 alphabetical fashion, while this function will enter groups into its
1255 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
1256 @samp{comp} hierarchy, this function will not mess that configuration
1257 up.  Or something like that.
1258
1259 @item gnus-subscribe-interactively
1260 @vindex gnus-subscribe-interactively
1261 Subscribe new groups interactively.  This means that Gnus will ask
1262 you about @strong{all} new groups.  The groups you choose to subscribe
1263 to will be subscribed hierarchically.
1264
1265 @item gnus-subscribe-killed
1266 @vindex gnus-subscribe-killed
1267 Kill all new groups.
1268
1269 @item gnus-subscribe-topics
1270 @vindex gnus-subscribe-topics
1271 Put the groups into the topic that has a matching @code{subscribe} topic
1272 parameter (@pxref{Topic Parameters}).  For instance, a @code{subscribe}
1273 topic parameter that looks like
1274
1275 @example
1276 "nnml"
1277 @end example
1278
1279 will mean that all groups that match that regex will be subscribed under
1280 that topic.
1281
1282 If no topics match the groups, the groups will be subscribed in the
1283 top-level topic.
1284
1285 @end table
1286
1287 @vindex gnus-subscribe-hierarchical-interactive
1288 A closely related variable is
1289 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
1290 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
1291 hierarchical fashion whether to subscribe to new groups or not.  Gnus
1292 will ask you for each sub-hierarchy whether you want to descend the
1293 hierarchy or not.
1294
1295 One common mistake is to set the variable a few paragraphs above
1296 (@code{gnus-subscribe-newsgroup-method}) to
1297 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
1298 will not work.  This is ga-ga.  So don't do it.
1299
1300
1301 @node Filtering New Groups
1302 @subsection Filtering New Groups
1303
1304 A nice and portable way to control which new newsgroups should be
1305 subscribed (or ignored) is to put an @dfn{options} line at the start of
1306 the @file{.newsrc} file.  Here's an example:
1307
1308 @example
1309 options -n !alt.all !rec.all sci.all
1310 @end example
1311
1312 @vindex gnus-subscribe-options-newsgroup-method
1313 This line obviously belongs to a serious-minded intellectual scientific
1314 person (or she may just be plain old boring), because it says that all
1315 groups that have names beginning with @samp{alt} and @samp{rec} should
1316 be ignored, and all groups with names beginning with @samp{sci} should
1317 be subscribed.  Gnus will not use the normal subscription method for
1318 subscribing these groups.
1319 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
1320 variable defaults to @code{gnus-subscribe-alphabetically}.
1321
1322 @vindex gnus-options-not-subscribe
1323 @vindex gnus-options-subscribe
1324 If you don't want to mess with your @file{.newsrc} file, you can just
1325 set the two variables @code{gnus-options-subscribe} and
1326 @code{gnus-options-not-subscribe}.  These two variables do exactly the
1327 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
1328 and if the new group matches the former, it will be unconditionally
1329 subscribed, and if it matches the latter, it will be ignored.
1330
1331 @vindex gnus-auto-subscribed-groups
1332 Yet another variable that meddles here is
1333 @code{gnus-auto-subscribed-groups}.  It works exactly like
1334 @code{gnus-options-subscribe}, and is therefore really superfluous,
1335 but I thought it would be nice to have two of these.  This variable is
1336 more meant for setting some ground rules, while the other variable is
1337 used more for user fiddling.  By default this variable makes all new
1338 groups that come from mail back ends (@code{nnml}, @code{nnbabyl},
1339 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir})
1340 subscribed.  If you don't like that, just set this variable to
1341 @code{nil}.
1342
1343 New groups that match this regexp are subscribed using
1344 @code{gnus-subscribe-options-newsgroup-method}.
1345
1346
1347 @node Changing Servers
1348 @section Changing Servers
1349 @cindex changing servers
1350
1351 Sometimes it is necessary to move from one @acronym{NNTP} server to another.
1352 This happens very rarely, but perhaps you change jobs, or one server is
1353 very flaky and you want to use another.
1354
1355 Changing the server is pretty easy, right?  You just change
1356 @code{gnus-select-method} to point to the new server?
1357
1358 @emph{Wrong!}
1359
1360 Article numbers are not (in any way) kept synchronized between different
1361 @acronym{NNTP} servers, and the only way Gnus keeps track of what articles
1362 you have read is by keeping track of article numbers.  So when you
1363 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1364 worthless.
1365
1366 @kindex M-x gnus-group-clear-data-on-native-groups
1367 @findex gnus-group-clear-data-on-native-groups
1368 You can use the @kbd{M-x gnus-group-clear-data-on-native-groups}
1369 command to clear out all data that you have on your native groups.
1370 Use with caution.
1371
1372 @kindex M-x gnus-group-clear-data
1373 @findex gnus-group-clear-data
1374 Clear the data from the current group only---nix out marks and the
1375 list of read articles (@code{gnus-group-clear-data}).
1376
1377 After changing servers, you @strong{must} move the cache hierarchy away,
1378 since the cached articles will have wrong article numbers, which will
1379 affect which articles Gnus thinks are read.
1380 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1381 to have it done automatically; for @code{gnus-group-clear-data}, you
1382 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1383 cache for all groups).
1384
1385
1386 @node Startup Files
1387 @section Startup Files
1388 @cindex startup files
1389 @cindex .newsrc
1390 @cindex .newsrc.el
1391 @cindex .newsrc.eld
1392
1393 Most common Unix news readers use a shared startup file called
1394 @file{.newsrc}.  This file contains all the information about what
1395 groups are subscribed, and which articles in these groups have been
1396 read.
1397
1398 Things got a bit more complicated with @sc{gnus}.  In addition to
1399 keeping the @file{.newsrc} file updated, it also used a file called
1400 @file{.newsrc.el} for storing all the information that didn't fit into
1401 the @file{.newsrc} file.  (Actually, it also duplicated everything in
1402 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
1403 files was the most recently saved, which enabled people to swap between
1404 @sc{gnus} and other newsreaders.
1405
1406 That was kinda silly, so Gnus went one better: In addition to the
1407 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1408 @file{.newsrc.eld}.  It will read whichever of these files that are most
1409 recent, but it will never write a @file{.newsrc.el} file.  You should
1410 never delete the @file{.newsrc.eld} file---it contains much information
1411 not stored in the @file{.newsrc} file.
1412
1413 @vindex gnus-save-newsrc-file
1414 @vindex gnus-read-newsrc-file
1415 You can turn off writing the @file{.newsrc} file by setting
1416 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1417 the file and save some space, as well as exiting from Gnus faster.
1418 However, this will make it impossible to use other newsreaders than
1419 Gnus.  But hey, who would want to, right?  Similarly, setting
1420 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
1421 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which can be
1422 convenient if you use a different news reader occasionally, and you
1423 want to read a different subset of the available groups with that
1424 news reader.
1425
1426 @vindex gnus-save-killed-list
1427 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1428 will not save the list of killed groups to the startup file.  This will
1429 save both time (when starting and quitting) and space (on disk).  It
1430 will also mean that Gnus has no record of what groups are new or old,
1431 so the automatic new groups subscription methods become meaningless.
1432 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1433 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1434 Groups}).  This variable can also be a regular expression.  If that's
1435 the case, remove all groups that do not match this regexp before
1436 saving.  This can be useful in certain obscure situations that involve
1437 several servers where not all servers support @code{ask-server}.
1438
1439 @vindex gnus-startup-file
1440 @vindex gnus-backup-startup-file
1441 @vindex version-control
1442 The @code{gnus-startup-file} variable says where the startup files are.
1443 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1444 file being whatever that one is, with a @samp{.eld} appended.
1445 If you want version control for this file, set
1446 @code{gnus-backup-startup-file}.  It respects the same values as the
1447 @code{version-control} variable.
1448
1449 @vindex gnus-save-newsrc-hook
1450 @vindex gnus-save-quick-newsrc-hook
1451 @vindex gnus-save-standard-newsrc-hook
1452 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1453 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1454 saving the @file{.newsrc.eld} file, and
1455 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1456 @file{.newsrc} file.  The latter two are commonly used to turn version
1457 control on or off.  Version control is on by default when saving the
1458 startup files.  If you want to turn backup creation off, say something like:
1459
1460 @lisp
1461 (defun turn-off-backup ()
1462   (set (make-local-variable 'backup-inhibited) t))
1463
1464 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1465 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1466 @end lisp
1467
1468 @vindex gnus-init-file
1469 @vindex gnus-site-init-file
1470 When Gnus starts, it will read the @code{gnus-site-init-file}
1471 (@file{.../site-lisp/gnus-init} by default) and @code{gnus-init-file}
1472 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
1473 and can be used to avoid cluttering your @file{~/.emacs} and
1474 @file{site-init} files with Gnus stuff.  Gnus will also check for files
1475 with the same names as these, but with @file{.elc} and @file{.el}
1476 suffixes.  In other words, if you have set @code{gnus-init-file} to
1477 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1478 and finally @file{~/.gnus} (in this order).  If Emacs was invoked with
1479 the @option{-q} or @option{--no-init-file} options (@pxref{Initial
1480 Options, ,Initial Options, emacs, The Emacs Manual}), Gnus doesn't read
1481 @code{gnus-init-file}.
1482
1483
1484 @node Auto Save
1485 @section Auto Save
1486 @cindex dribble file
1487 @cindex auto-save
1488
1489 Whenever you do something that changes the Gnus data (reading articles,
1490 catching up, killing/subscribing groups), the change is added to a
1491 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
1492 Emacs way.  If your Emacs should crash before you have saved the
1493 @file{.newsrc} files, all changes you have made can be recovered from
1494 this file.
1495
1496 If Gnus detects this file at startup, it will ask the user whether to
1497 read it.  The auto save file is deleted whenever the real startup file is
1498 saved.
1499
1500 @vindex gnus-use-dribble-file
1501 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
1502 maintain a dribble buffer.  The default is @code{t}.
1503
1504 @vindex gnus-dribble-directory
1505 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
1506 this variable is @code{nil}, which it is by default, Gnus will dribble
1507 into the directory where the @file{.newsrc} file is located.  (This is
1508 normally the user's home directory.)  The dribble file will get the same
1509 file permissions as the @file{.newsrc} file.
1510
1511 @vindex gnus-always-read-dribble-file
1512 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1513 read the dribble file on startup without querying the user.
1514
1515
1516 @node The Active File
1517 @section The Active File
1518 @cindex active file
1519 @cindex ignored groups
1520
1521 When Gnus starts, or indeed whenever it tries to determine whether new
1522 articles have arrived, it reads the active file.  This is a very large
1523 file that lists all the active groups and articles on the server.
1524
1525 @vindex gnus-ignored-newsgroups
1526 Before examining the active file, Gnus deletes all lines that match the
1527 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
1528 any groups with bogus names, but you can use this variable to make Gnus
1529 ignore hierarchies you aren't ever interested in.  However, this is not
1530 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
1531 Groups} for an overview of other variables that can be used instead.
1532
1533 @c This variable is
1534 @c @code{nil} by default, and will slow down active file handling somewhat
1535 @c if you set it to anything else.
1536
1537 @vindex gnus-read-active-file
1538 @c @head
1539 The active file can be rather Huge, so if you have a slow network, you
1540 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
1541 reading the active file.  This variable is @code{some} by default.
1542
1543 Gnus will try to make do by getting information just on the groups that
1544 you actually subscribe to.
1545
1546 Note that if you subscribe to lots and lots of groups, setting this
1547 variable to @code{nil} will probably make Gnus slower, not faster.  At
1548 present, having this variable @code{nil} will slow Gnus down
1549 considerably, unless you read news over a 2400 baud modem.
1550
1551 This variable can also have the value @code{some}.  Gnus will then
1552 attempt to read active info only on the subscribed groups.  On some
1553 servers this is quite fast (on sparkling, brand new INN servers that
1554 support the @code{LIST ACTIVE group} command), on others this isn't fast
1555 at all.  In any case, @code{some} should be faster than @code{nil}, and
1556 is certainly faster than @code{t} over slow lines.
1557
1558 Some news servers (old versions of Leafnode and old versions of INN, for
1559 instance) do not support the @code{LIST ACTIVE group}.  For these
1560 servers, @code{nil} is probably the most efficient value for this
1561 variable.
1562
1563 If this variable is @code{nil}, Gnus will ask for group info in total
1564 lock-step, which isn't very fast.  If it is @code{some} and you use an
1565 @acronym{NNTP} server, Gnus will pump out commands as fast as it can, and
1566 read all the replies in one swoop.  This will normally result in better
1567 performance, but if the server does not support the aforementioned
1568 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1569
1570 If you think that starting up Gnus takes too long, try all the three
1571 different values for this variable and see what works best for you.
1572
1573 In any case, if you use @code{some} or @code{nil}, you should definitely
1574 kill all groups that you aren't interested in to speed things up.
1575
1576 Note that this variable also affects active file retrieval from
1577 secondary select methods.
1578
1579
1580 @node Startup Variables
1581 @section Startup Variables
1582
1583 @table @code
1584
1585 @item gnus-load-hook
1586 @vindex gnus-load-hook
1587 A hook run while Gnus is being loaded.  Note that this hook will
1588 normally be run just once in each Emacs session, no matter how many
1589 times you start Gnus.
1590
1591 @item gnus-before-startup-hook
1592 @vindex gnus-before-startup-hook
1593 A hook called as the first thing when Gnus is started.
1594
1595 @item gnus-startup-hook
1596 @vindex gnus-startup-hook
1597 A hook run as the very last thing after starting up Gnus
1598
1599 @item gnus-started-hook
1600 @vindex gnus-started-hook
1601 A hook that is run as the very last thing after starting up Gnus
1602 successfully.
1603
1604 @item gnus-setup-news-hook
1605 @vindex gnus-setup-news-hook
1606 A hook that is run after reading the @file{.newsrc} file(s), but before
1607 generating the group buffer.
1608
1609 @item gnus-check-bogus-newsgroups
1610 @vindex gnus-check-bogus-newsgroups
1611 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1612 startup.  A @dfn{bogus group} is a group that you have in your
1613 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
1614 bogus groups can take quite a while, so to save time and resources it's
1615 best to leave this option off, and do the checking for bogus groups once
1616 in a while from the group buffer instead (@pxref{Group Maintenance}).
1617
1618 @item gnus-inhibit-startup-message
1619 @vindex gnus-inhibit-startup-message
1620 If non-@code{nil}, the startup message won't be displayed.  That way,
1621 your boss might not notice as easily that you are reading news instead
1622 of doing your job.  Note that this variable is used before
1623 @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1624
1625 @item gnus-no-groups-message
1626 @vindex gnus-no-groups-message
1627 Message displayed by Gnus when no groups are available.
1628
1629 @item gnus-use-backend-marks
1630 @vindex gnus-use-backend-marks
1631 If non-@code{nil}, Gnus will store article marks both in the
1632 @file{.newsrc.eld} file and in the backends.  This will slow down
1633 group operation some.
1634
1635 @end table
1636
1637
1638 @node Group Buffer
1639 @chapter Group Buffer
1640 @cindex group buffer
1641
1642 @c Alex Schroeder suggests to rearrange this as follows:
1643 @c
1644 @c <kensanata> ok, just save it for reference.  I'll go to bed in a minute.
1645 @c   1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1646 @c   4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1647 @c   7. Group Score, 8. Group Buffer Format
1648 @c <kensanata> Group Levels should have more information on levels 5 to 9.  I
1649 @c   suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1650 @c <kensanata> First, "Gnus considers groups... (default 9)."
1651 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1652 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1653 @c <kensanata> Then expand the next paragraph or add some more to it.
1654 @c    This short one sentence explains levels 1 and 2, therefore I understand
1655 @c    that I should keep important news at 3 and boring news at 4.
1656 @c    Say so!  Then go on to explain why I should bother with levels 6 to 9.
1657 @c    Maybe keep those that you don't want to read temporarily at 6,
1658 @c    those that you never want to read at 8, those that offend your
1659 @c    human rights at 9...
1660
1661
1662 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1663 is the first buffer shown when Gnus starts, and will never be killed as
1664 long as Gnus is active.
1665
1666 @iftex
1667 @iflatex
1668 \gnusfigure{The Group Buffer}{320}{
1669 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1670 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1671 \put(120,38){\vector(1,2){10}}
1672 \put(40,60){\makebox(0,0)[r]{Mode line}}
1673 \put(40,58){\vector(1,0){30}}
1674 \put(200,28){\makebox(0,0)[t]{Native select method}}
1675 \put(200,26){\vector(-1,2){15}}
1676 }
1677 @end iflatex
1678 @end iftex
1679
1680 @menu
1681 * Group Buffer Format::         Information listed and how you can change it.
1682 * Group Maneuvering::           Commands for moving in the group buffer.
1683 * Selecting a Group::           Actually reading news.
1684 * Subscription Commands::       Unsubscribing, killing, subscribing.
1685 * Group Data::                  Changing the info for a group.
1686 * Group Levels::                Levels? What are those, then?
1687 * Group Score::                 A mechanism for finding out what groups you like.
1688 * Marking Groups::              You can mark groups for later processing.
1689 * Foreign Groups::              Creating and editing groups.
1690 * Group Parameters::            Each group may have different parameters set.
1691 * Listing Groups::              Gnus can list various subsets of the groups.
1692 * Sorting Groups::              Re-arrange the group order.
1693 * Group Maintenance::           Maintaining a tidy @file{.newsrc} file.
1694 * Browse Foreign Server::       You can browse a server.  See what it has to offer.
1695 * Exiting Gnus::                Stop reading news and get some work done.
1696 * Group Topics::                A folding group mode divided into topics.
1697 * Non-ASCII Group Names::       Accessing groups of non-English names.
1698 * Searching::                   Mail search engines.
1699 * Misc Group Stuff::            Other stuff that you can to do.
1700 @end menu
1701
1702
1703 @node Group Buffer Format
1704 @section Group Buffer Format
1705
1706 @menu
1707 * Group Line Specification::    Deciding how the group buffer is to look.
1708 * Group Mode Line Specification::  The group buffer mode line.
1709 * Group Highlighting::          Having nice colors in the group buffer.
1710 @end menu
1711
1712 You can customize the Group Mode tool bar, see @kbd{M-x
1713 customize-apropos RET gnus-group-tool-bar}.  This feature is only
1714 available in Emacs.
1715
1716 The tool bar icons are now (de)activated correctly depending on the
1717 cursor position.  Therefore, moving around in the Group Buffer is
1718 slower.  You can disable this via the variable
1719 @code{gnus-group-update-tool-bar}.  Its default value depends on your
1720 Emacs version.
1721
1722 @node Group Line Specification
1723 @subsection Group Line Specification
1724 @cindex group buffer format
1725
1726 The default format of the group buffer is nice and dull, but you can
1727 make it as exciting and ugly as you feel like.
1728
1729 Here's a couple of example group lines:
1730
1731 @example
1732      25: news.announce.newusers
1733  *    0: alt.fan.andrea-dworkin
1734 @end example
1735
1736 Quite simple, huh?
1737
1738 You can see that there are 25 unread articles in
1739 @samp{news.announce.newusers}.  There are no unread articles, but some
1740 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1741 asterisk at the beginning of the line?).
1742
1743 @vindex gnus-group-line-format
1744 You can change that format to whatever you want by fiddling with the
1745 @code{gnus-group-line-format} variable.  This variable works along the
1746 lines of a @code{format} specification, which is pretty much the same as
1747 a @code{printf} specifications, for those of you who use (feh!) C.
1748 @xref{Formatting Variables}.
1749
1750 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1751
1752 There should always be a colon on the line; the cursor always moves to
1753 the colon after performing an operation.  @xref{Positioning
1754 Point}.  Nothing else is required---not even the group name.  All
1755 displayed text is just window dressing, and is never examined by Gnus.
1756 Gnus stores all real information it needs using text properties.
1757
1758 (Note that if you make a really strange, wonderful, spreadsheet-like
1759 layout, everybody will believe you are hard at work with the accounting
1760 instead of wasting time reading news.)
1761
1762 Here's a list of all available format characters:
1763
1764 @table @samp
1765
1766 @item M
1767 An asterisk if the group only has marked articles.
1768
1769 @item S
1770 Whether the group is subscribed.
1771
1772 @item L
1773 Level of subscribedness.
1774
1775 @item N
1776 Number of unread articles.
1777
1778 @item I
1779 Number of dormant articles.
1780
1781 @item T
1782 Number of ticked articles.
1783
1784 @item R
1785 Number of read articles.
1786
1787 @item U
1788 Number of unseen articles.
1789
1790 @item t
1791 Estimated total number of articles.  (This is really @var{max-number}
1792 minus @var{min-number} plus 1.)
1793
1794 Gnus uses this estimation because the @acronym{NNTP} protocol provides
1795 efficient access to @var{max-number} and @var{min-number} but getting
1796 the true unread message count is not possible efficiently.  For
1797 hysterical raisins, even the mail back ends, where the true number of
1798 unread messages might be available efficiently, use the same limited
1799 interface.  To remove this restriction from Gnus means that the back
1800 end interface has to be changed, which is not an easy job.
1801
1802 The nnml backend (@pxref{Mail Spool}) has a feature called ``group
1803 compaction'' which circumvents this deficiency: the idea is to
1804 renumber all articles from 1, removing all gaps between numbers, hence
1805 getting a correct total count.  Other backends may support this in the
1806 future.  In order to keep your total article count relatively up to
1807 date, you might want to compact your groups (or even directly your
1808 server) from time to time. @xref{Misc Group Stuff}, @xref{Server Commands}.
1809
1810 @item y
1811 Number of unread, unticked, non-dormant articles.
1812
1813 @item i
1814 Number of ticked and dormant articles.
1815
1816 @item g
1817 Full group name.
1818
1819 @item G
1820 Group name.
1821
1822 @item C
1823 Group comment (@pxref{Group Parameters}) or group name if there is no
1824 comment element in the group parameters.
1825
1826 @item D
1827 Newsgroup description.  You need to read the group descriptions
1828 before these will appear, and to do that, you either have to set
1829 @code{gnus-read-active-file} or use the group buffer @kbd{M-d}
1830 command.
1831
1832 @item o
1833 @samp{m} if moderated.
1834
1835 @item O
1836 @samp{(m)} if moderated.
1837
1838 @item s
1839 Select method.
1840
1841 @item B
1842 If the summary buffer for the group is open or not.
1843
1844 @item n
1845 Select from where.
1846
1847 @item z
1848 A string that looks like @samp{<%s:%n>} if a foreign select method is
1849 used.
1850
1851 @item P
1852 Indentation based on the level of the topic (@pxref{Group Topics}).
1853
1854 @item c
1855 @vindex gnus-group-uncollapsed-levels
1856 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1857 variable says how many levels to leave at the end of the group name.
1858 The default is 1---this will mean that group names like
1859 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1860
1861 @item m
1862 @vindex gnus-new-mail-mark
1863 @cindex %
1864 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1865 the group lately.
1866
1867 @item p
1868 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1869
1870 @item d
1871 A string that says when you last read the group (@pxref{Group
1872 Timestamp}).
1873
1874 @item F
1875 The disk space used by the articles fetched by both the cache and
1876 agent.  The value is automatically scaled to bytes(B), kilobytes(K),
1877 megabytes(M), or gigabytes(G) to minimize the column width.  A format
1878 of %7F is sufficient for a fixed-width column.
1879
1880 @item u
1881 User defined specifier.  The next character in the format string should
1882 be a letter.  Gnus will call the function
1883 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1884 following @samp{%u}.  The function will be passed a single dummy
1885 parameter as argument.  The function should return a string, which will
1886 be inserted into the buffer just like information from any other
1887 specifier.
1888 @end table
1889
1890 @cindex *
1891 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1892 if no info is available---for instance, if it is a non-activated foreign
1893 group, or a bogus native group.
1894
1895
1896 @node Group Mode Line Specification
1897 @subsection Group Mode Line Specification
1898 @cindex group mode line
1899
1900 @vindex gnus-group-mode-line-format
1901 The mode line can be changed by setting
1902 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}).  It
1903 doesn't understand that many format specifiers:
1904
1905 @table @samp
1906 @item S
1907 The native news server.
1908 @item M
1909 The native select method.
1910 @end table
1911
1912
1913 @node Group Highlighting
1914 @subsection Group Highlighting
1915 @cindex highlighting
1916 @cindex group highlighting
1917
1918 @vindex gnus-group-highlight
1919 Highlighting in the group buffer is controlled by the
1920 @code{gnus-group-highlight} variable.  This is an alist with elements
1921 that look like @code{(@var{form} . @var{face})}.  If @var{form} evaluates to
1922 something non-@code{nil}, the @var{face} will be used on the line.
1923
1924 Here's an example value for this variable that might look nice if the
1925 background is dark:
1926
1927 @lisp
1928 (cond (window-system
1929        (setq custom-background-mode 'light)
1930        (defface my-group-face-1
1931          '((t (:foreground "Red" :bold t))) "First group face")
1932        (defface my-group-face-2
1933          '((t (:foreground "DarkSeaGreen4" :bold t)))
1934          "Second group face")
1935        (defface my-group-face-3
1936          '((t (:foreground "Green4" :bold t))) "Third group face")
1937        (defface my-group-face-4
1938          '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1939        (defface my-group-face-5
1940          '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1941
1942 (setq gnus-group-highlight
1943       '(((> unread 200) . my-group-face-1)
1944         ((and (< level 3) (zerop unread)) . my-group-face-2)
1945         ((< level 3) . my-group-face-3)
1946         ((zerop unread) . my-group-face-4)
1947         (t . my-group-face-5)))
1948 @end lisp
1949
1950 Also @pxref{Faces and Fonts}.
1951
1952 Variables that are dynamically bound when the forms are evaluated
1953 include:
1954
1955 @table @code
1956 @item group
1957 The group name.
1958 @item unread
1959 The number of unread articles in the group.
1960 @item method
1961 The select method.
1962 @item mailp
1963 Whether the group is a mail group.
1964 @item level
1965 The level of the group.
1966 @item score
1967 The score of the group.
1968 @item ticked
1969 The number of ticked articles in the group.
1970 @item total
1971 The total number of articles in the group.  Or rather,
1972 @var{max-number} minus @var{min-number} plus one.
1973 @item topic
1974 When using the topic minor mode, this variable is bound to the current
1975 topic being inserted.
1976 @end table
1977
1978 When the forms are @code{eval}ed, point is at the beginning of the line
1979 of the group in question, so you can use many of the normal Gnus
1980 functions for snarfing info on the group.
1981
1982 @vindex gnus-group-update-hook
1983 @findex gnus-group-highlight-line
1984 @code{gnus-group-update-hook} is called when a group line is changed.
1985 It will not be called when @code{gnus-visual} is @code{nil}.
1986
1987
1988 @node Group Maneuvering
1989 @section Group Maneuvering
1990 @cindex group movement
1991
1992 All movement commands understand the numeric prefix and will behave as
1993 expected, hopefully.
1994
1995 @table @kbd
1996
1997 @item n
1998 @kindex n (Group)
1999 @findex gnus-group-next-unread-group
2000 Go to the next group that has unread articles
2001 (@code{gnus-group-next-unread-group}).
2002
2003 @item p
2004 @itemx DEL
2005 @kindex DEL (Group)
2006 @kindex p (Group)
2007 @findex gnus-group-prev-unread-group
2008 Go to the previous group that has unread articles
2009 (@code{gnus-group-prev-unread-group}).
2010
2011 @item N
2012 @kindex N (Group)
2013 @findex gnus-group-next-group
2014 Go to the next group (@code{gnus-group-next-group}).
2015
2016 @item P
2017 @kindex P (Group)
2018 @findex gnus-group-prev-group
2019 Go to the previous group (@code{gnus-group-prev-group}).
2020
2021 @item M-n
2022 @kindex M-n (Group)
2023 @findex gnus-group-next-unread-group-same-level
2024 Go to the next unread group on the same (or lower) level
2025 (@code{gnus-group-next-unread-group-same-level}).
2026
2027 @item M-p
2028 @kindex M-p (Group)
2029 @findex gnus-group-prev-unread-group-same-level
2030 Go to the previous unread group on the same (or lower) level
2031 (@code{gnus-group-prev-unread-group-same-level}).
2032 @end table
2033
2034 Three commands for jumping to groups:
2035
2036 @table @kbd
2037
2038 @item j
2039 @kindex j (Group)
2040 @findex gnus-group-jump-to-group
2041 Jump to a group (and make it visible if it isn't already)
2042 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
2043 like living groups.
2044
2045 @item ,
2046 @kindex , (Group)
2047 @findex gnus-group-best-unread-group
2048 Jump to the unread group with the lowest level
2049 (@code{gnus-group-best-unread-group}).
2050
2051 @item .
2052 @kindex . (Group)
2053 @findex gnus-group-first-unread-group
2054 Jump to the first group with unread articles
2055 (@code{gnus-group-first-unread-group}).
2056 @end table
2057
2058 @vindex gnus-group-goto-unread
2059 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2060 commands will move to the next group, not the next unread group.  Even
2061 the commands that say they move to the next unread group.  The default
2062 is @code{t}.
2063
2064 @vindex gnus-summary-next-group-on-exit
2065 If @code{gnus-summary-next-group-on-exit} is @code{t}, when a summary is
2066 exited, the point in the group buffer is moved to the next unread group.
2067 Otherwise, the point is set to the group just exited.  The default is
2068 @code{t}.
2069
2070 @node Selecting a Group
2071 @section Selecting a Group
2072 @cindex group selection
2073
2074 @table @kbd
2075
2076 @item SPACE
2077 @kindex SPACE (Group)
2078 @findex gnus-group-read-group
2079 Select the current group, switch to the summary buffer and display the
2080 first unread article (@code{gnus-group-read-group}).  If there are no
2081 unread articles in the group, or if you give a non-numerical prefix to
2082 this command, Gnus will offer to fetch all the old articles in this
2083 group from the server.  If you give a numerical prefix @var{n}, @var{n}
2084 determines the number of articles Gnus will fetch.  If @var{n} is
2085 positive, Gnus fetches the @var{n} newest articles, if @var{n} is
2086 negative, Gnus fetches the @code{abs(@var{n})} oldest articles.
2087
2088 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2089 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2090 - 4 2 SPC} fetches the 42 oldest ones.
2091
2092 When you are in the group (in the Summary buffer), you can type
2093 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2094 ones.
2095
2096 @item RET
2097 @kindex RET (Group)
2098 @findex gnus-group-select-group
2099 Select the current group and switch to the summary buffer
2100 (@code{gnus-group-select-group}).  Takes the same arguments as
2101 @code{gnus-group-read-group}---the only difference is that this command
2102 does not display the first unread article automatically upon group
2103 entry.
2104
2105 @item M-RET
2106 @kindex M-RET (Group)
2107 @findex gnus-group-quick-select-group
2108 This does the same as the command above, but tries to do it with the
2109 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
2110 scoring/killing will be performed, there will be no highlights and no
2111 expunging.  This might be useful if you're in a real hurry and have to
2112 enter some humongous group.  If you give a 0 prefix to this command
2113 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
2114 which is useful if you want to toggle threading before generating the
2115 summary buffer (@pxref{Summary Generation Commands}).
2116
2117 @item M-SPACE
2118 @kindex M-SPACE (Group)
2119 @findex gnus-group-visible-select-group
2120 This is yet one more command that does the same as the @kbd{RET}
2121 command, but this one does it without expunging and hiding dormants
2122 (@code{gnus-group-visible-select-group}).
2123
2124 @item C-M-RET
2125 @kindex C-M-RET (Group)
2126 @findex gnus-group-select-group-ephemerally
2127 Finally, this command selects the current group ephemerally without
2128 doing any processing of its contents
2129 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
2130 turned off.  Everything you do in the group after selecting it in this
2131 manner will have no permanent effects.
2132
2133 @end table
2134
2135 @vindex gnus-large-newsgroup
2136 The @code{gnus-large-newsgroup} variable says what Gnus should
2137 consider to be a big group.  If it is @code{nil}, no groups are
2138 considered big.  The default value is 200.  If the group has more
2139 (unread and/or ticked) articles than this, Gnus will query the user
2140 before entering the group.  The user can then specify how many
2141 articles should be fetched from the server.  If the user specifies a
2142 negative number (@var{-n}), the @var{n} oldest articles will be
2143 fetched.  If it is positive, the @var{n} articles that have arrived
2144 most recently will be fetched.
2145
2146 @vindex gnus-large-ephemeral-newsgroup
2147 @code{gnus-large-ephemeral-newsgroup} is the same as
2148 @code{gnus-large-newsgroup}, but is only used for ephemeral
2149 newsgroups.
2150
2151 @vindex gnus-newsgroup-maximum-articles
2152 In groups in some news servers, there might be a big gap between a few
2153 very old articles that will never be expired and the recent ones.  In
2154 such a case, the server will return the data like @code{(1 . 30000000)}
2155 for the @code{LIST ACTIVE group} command, for example.  Even if there
2156 are actually only the articles 1-10 and 29999900-30000000, Gnus doesn't
2157 know it at first and prepares for getting 30000000 articles.  However,
2158 it will consume hundreds megabytes of memories and might make Emacs get
2159 stuck as the case may be.  If you use such news servers, set the
2160 variable @code{gnus-newsgroup-maximum-articles} to a positive number.
2161 The value means that Gnus ignores articles other than this number of the
2162 latest ones in every group.  For instance, the value 10000 makes Gnus
2163 get only the articles 29990001-30000000 (if the latest article number is
2164 30000000 in a group).  Note that setting this variable to a number might
2165 prevent you from reading very old articles.  The default value of the
2166 variable @code{gnus-newsgroup-maximum-articles} is @code{nil}, which
2167 means Gnus never ignores old articles.
2168
2169 @vindex gnus-select-group-hook
2170 @vindex gnus-auto-select-first
2171 @vindex gnus-auto-select-subject
2172 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2173 automatically when entering a group with the @kbd{SPACE} command.
2174 Which article this is controlled by the
2175 @code{gnus-auto-select-subject} variable.  Valid values for this
2176 variable are:
2177
2178 @table @code
2179
2180 @item unread
2181 Place point on the subject line of the first unread article.
2182
2183 @item first
2184 Place point on the subject line of the first article.
2185
2186 @item unseen
2187 Place point on the subject line of the first unseen article.
2188
2189 @item unseen-or-unread
2190 Place point on the subject line of the first unseen article, and if
2191 there is no such article, place point on the subject line of the first
2192 unread article.
2193
2194 @item best
2195 Place point on the subject line of the highest-scored unread article.
2196
2197 @end table
2198
2199 This variable can also be a function.  In that case, that function
2200 will be called to place point on a subject line.
2201
2202 If you want to prevent automatic selection in some group (say, in a
2203 binary group with Huge articles) you can set the
2204 @code{gnus-auto-select-first} variable to @code{nil} in
2205 @code{gnus-select-group-hook}, which is called when a group is
2206 selected.
2207
2208
2209 @node Subscription Commands
2210 @section Subscription Commands
2211 @cindex subscription
2212
2213 @table @kbd
2214
2215 @item S t
2216 @itemx u
2217 @kindex S t (Group)
2218 @kindex u (Group)
2219 @findex gnus-group-unsubscribe-current-group
2220 @c @icon{gnus-group-unsubscribe}
2221 Toggle subscription to the current group
2222 (@code{gnus-group-unsubscribe-current-group}).
2223
2224 @item S s
2225 @itemx U
2226 @kindex S s (Group)
2227 @kindex U (Group)
2228 @findex gnus-group-unsubscribe-group
2229 Prompt for a group to subscribe, and then subscribe it.  If it was
2230 subscribed already, unsubscribe it instead
2231 (@code{gnus-group-unsubscribe-group}).
2232
2233 @item S k
2234 @itemx C-k
2235 @kindex S k (Group)
2236 @kindex C-k (Group)
2237 @findex gnus-group-kill-group
2238 @c @icon{gnus-group-kill-group}
2239 Kill the current group (@code{gnus-group-kill-group}).
2240
2241 @item S y
2242 @itemx C-y
2243 @kindex S y (Group)
2244 @kindex C-y (Group)
2245 @findex gnus-group-yank-group
2246 Yank the last killed group (@code{gnus-group-yank-group}).
2247
2248 @item C-x C-t
2249 @kindex C-x C-t (Group)
2250 @findex gnus-group-transpose-groups
2251 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
2252 really a subscription command, but you can use it instead of a
2253 kill-and-yank sequence sometimes.
2254
2255 @item S w
2256 @itemx C-w
2257 @kindex S w (Group)
2258 @kindex C-w (Group)
2259 @findex gnus-group-kill-region
2260 Kill all groups in the region (@code{gnus-group-kill-region}).
2261
2262 @item S z
2263 @kindex S z (Group)
2264 @findex gnus-group-kill-all-zombies
2265 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2266
2267 @item S C-k
2268 @kindex S C-k (Group)
2269 @findex gnus-group-kill-level
2270 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2271 These groups can't be yanked back after killing, so this command should
2272 be used with some caution.  The only time where this command comes in
2273 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2274 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
2275 kill off all unsubscribed groups that do not have message numbers in the
2276 @file{.newsrc} file.
2277
2278 @end table
2279
2280 Also @pxref{Group Levels}.
2281
2282
2283 @node Group Data
2284 @section Group Data
2285
2286 @table @kbd
2287
2288 @item c
2289 @kindex c (Group)
2290 @findex gnus-group-catchup-current
2291 @vindex gnus-group-catchup-group-hook
2292 @c @icon{gnus-group-catchup-current}
2293 Mark all unticked articles in this group as read
2294 (@code{gnus-group-catchup-current}).
2295 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2296 the group buffer.
2297
2298 @item C
2299 @kindex C (Group)
2300 @findex gnus-group-catchup-current-all
2301 Mark all articles in this group, even the ticked ones, as read
2302 (@code{gnus-group-catchup-current-all}).
2303
2304 @item M-c
2305 @kindex M-c (Group)
2306 @findex gnus-group-clear-data
2307 Clear the data from the current group---nix out marks and the list of
2308 read articles (@code{gnus-group-clear-data}).
2309
2310 @item M-x gnus-group-clear-data-on-native-groups
2311 @kindex M-x gnus-group-clear-data-on-native-groups
2312 @findex gnus-group-clear-data-on-native-groups
2313 If you have switched from one @acronym{NNTP} server to another, all your marks
2314 and read ranges have become worthless.  You can use this command to
2315 clear out all data that you have on your native groups.  Use with
2316 caution.
2317
2318 @end table
2319
2320
2321 @node Group Levels
2322 @section Group Levels
2323 @cindex group level
2324 @cindex level
2325
2326 All groups have a level of @dfn{subscribedness}.  For instance, if a
2327 group is on level 2, it is more subscribed than a group on level 5.  You
2328 can ask Gnus to just list groups on a given level or lower
2329 (@pxref{Listing Groups}), or to just check for new articles in groups on
2330 a given level or lower (@pxref{Scanning New Messages}).
2331
2332 Remember:  The higher the level of the group, the less important it is.
2333
2334 @table @kbd
2335
2336 @item S l
2337 @kindex S l (Group)
2338 @findex gnus-group-set-current-level
2339 Set the level of the current group.  If a numeric prefix is given, the
2340 next @var{n} groups will have their levels set.  The user will be
2341 prompted for a level.
2342 @end table
2343
2344 @vindex gnus-level-killed
2345 @vindex gnus-level-zombie
2346 @vindex gnus-level-unsubscribed
2347 @vindex gnus-level-subscribed
2348 Gnus considers groups from levels 1 to
2349 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2350 @code{gnus-level-subscribed} (exclusive) and
2351 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2352 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2353 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2354 (default 9).  Gnus treats subscribed and unsubscribed groups exactly the
2355 same, but zombie and killed groups have no information on what articles
2356 you have read, etc, stored.  This distinction between dead and living
2357 groups isn't done because it is nice or clever, it is done purely for
2358 reasons of efficiency.
2359
2360 It is recommended that you keep all your mail groups (if any) on quite
2361 low levels (e.g. 1 or 2).
2362
2363 Maybe the following description of the default behavior of Gnus helps to
2364 understand what these levels are all about.  By default, Gnus shows you
2365 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2366 empty subscribed groups and unsubscribed groups, too.  Type @kbd{l} to
2367 go back to showing nonempty subscribed groups again.  Thus, unsubscribed
2368 groups are hidden, in a way.
2369
2370 Zombie and killed groups are similar to unsubscribed groups in that they
2371 are hidden by default.  But they are different from subscribed and
2372 unsubscribed groups in that Gnus doesn't ask the news server for
2373 information (number of messages, number of unread messages) on zombie
2374 and killed groups.  Normally, you use @kbd{C-k} to kill the groups you
2375 aren't interested in.  If most groups are killed, Gnus is faster.
2376
2377 Why does Gnus distinguish between zombie and killed groups?  Well, when
2378 a new group arrives on the server, Gnus by default makes it a zombie
2379 group.  This means that you are normally not bothered with new groups,
2380 but you can type @kbd{A z} to get a list of all new groups.  Subscribe
2381 the ones you like and kill the ones you don't want.  (@kbd{A k} shows a
2382 list of killed groups.)
2383
2384 If you want to play with the level variables, you should show some care.
2385 Set them once, and don't touch them ever again.  Better yet, don't touch
2386 them at all unless you know exactly what you're doing.
2387
2388 @vindex gnus-level-default-unsubscribed
2389 @vindex gnus-level-default-subscribed
2390 Two closely related variables are @code{gnus-level-default-subscribed}
2391 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2392 which are the levels that new groups will be put on if they are
2393 (un)subscribed.  These two variables should, of course, be inside the
2394 relevant valid ranges.
2395
2396 @vindex gnus-keep-same-level
2397 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2398 will only move to groups of the same level (or lower).  In
2399 particular, going from the last article in one group to the next group
2400 will go to the next group of the same level (or lower).  This might be
2401 handy if you want to read the most important groups before you read the
2402 rest.
2403
2404 If this variable is @code{best}, Gnus will make the next newsgroup the
2405 one with the best level.
2406
2407 @vindex gnus-group-default-list-level
2408 All groups with a level less than or equal to
2409 @code{gnus-group-default-list-level} will be listed in the group buffer
2410 by default.
2411
2412 @vindex gnus-group-list-inactive-groups
2413 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2414 groups will be listed along with the unread groups.  This variable is
2415 @code{t} by default.  If it is @code{nil}, inactive groups won't be
2416 listed.
2417
2418 @vindex gnus-group-use-permanent-levels
2419 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2420 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2421 use this level as the ``work'' level.
2422
2423 @vindex gnus-activate-level
2424 Gnus will normally just activate (i. e., query the server about) groups
2425 on level @code{gnus-activate-level} or less.  If you don't want to
2426 activate unsubscribed groups, for instance, you might set this variable
2427 to 5.  The default is 6.
2428
2429
2430 @node Group Score
2431 @section Group Score
2432 @cindex group score
2433 @cindex group rank
2434 @cindex rank
2435
2436 You would normally keep important groups on high levels, but that scheme
2437 is somewhat restrictive.  Don't you wish you could have Gnus sort the
2438 group buffer according to how often you read groups, perhaps?  Within
2439 reason?
2440
2441 This is what @dfn{group score} is for.  You can have Gnus assign a score
2442 to each group through the mechanism described below.  You can then sort
2443 the group buffer based on this score.  Alternatively, you can sort on
2444 score and then level.  (Taken together, the level and the score is
2445 called the @dfn{rank} of the group.  A group that is on level 4 and has
2446 a score of 1 has a higher rank than a group on level 5 that has a score
2447 of 300.  (The level is the most significant part and the score is the
2448 least significant part.))
2449
2450 @findex gnus-summary-bubble-group
2451 If you want groups you read often to get higher scores than groups you
2452 read seldom you can add the @code{gnus-summary-bubble-group} function to
2453 the @code{gnus-summary-exit-hook} hook.  This will result (after
2454 sorting) in a bubbling sort of action.  If you want to see that in
2455 action after each summary exit, you can add
2456 @code{gnus-group-sort-groups-by-rank} or
2457 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2458 slow things down somewhat.
2459
2460
2461 @node Marking Groups
2462 @section Marking Groups
2463 @cindex marking groups
2464
2465 If you want to perform some command on several groups, and they appear
2466 subsequently in the group buffer, you would normally just give a
2467 numerical prefix to the command.  Most group commands will then do your
2468 bidding on those groups.
2469
2470 However, if the groups are not in sequential order, you can still
2471 perform a command on several groups.  You simply mark the groups first
2472 with the process mark and then execute the command.
2473
2474 @table @kbd
2475
2476 @item #
2477 @kindex # (Group)
2478 @itemx M m
2479 @kindex M m (Group)
2480 @findex gnus-group-mark-group
2481 Set the mark on the current group (@code{gnus-group-mark-group}).
2482
2483 @item M-#
2484 @kindex M-# (Group)
2485 @itemx M u
2486 @kindex M u (Group)
2487 @findex gnus-group-unmark-group
2488 Remove the mark from the current group
2489 (@code{gnus-group-unmark-group}).
2490
2491 @item M U
2492 @kindex M U (Group)
2493 @findex gnus-group-unmark-all-groups
2494 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2495
2496 @item M w
2497 @kindex M w (Group)
2498 @findex gnus-group-mark-region
2499 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2500
2501 @item M b
2502 @kindex M b (Group)
2503 @findex gnus-group-mark-buffer
2504 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2505
2506 @item M r
2507 @kindex M r (Group)
2508 @findex gnus-group-mark-regexp
2509 Mark all groups that match some regular expression
2510 (@code{gnus-group-mark-regexp}).
2511 @end table
2512
2513 Also @pxref{Process/Prefix}.
2514
2515 @findex gnus-group-universal-argument
2516 If you want to execute some command on all groups that have been marked
2517 with the process mark, you can use the @kbd{M-&}
2518 (@code{gnus-group-universal-argument}) command.  It will prompt you for
2519 the command to be executed.
2520
2521
2522 @node Foreign Groups
2523 @section Foreign Groups
2524 @cindex foreign groups
2525
2526 Below are some group mode commands for making and editing general foreign
2527 groups, as well as commands to ease the creation of a few
2528 special-purpose groups.  All these commands insert the newly created
2529 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2530 consulted.
2531
2532 Changes from the group editing commands are stored in
2533 @file{~/.newsrc.eld} (@code{gnus-startup-file}).  An alternative is the
2534 variable @code{gnus-parameters}, @xref{Group Parameters}.
2535
2536 @table @kbd
2537
2538 @item G m
2539 @kindex G m (Group)
2540 @findex gnus-group-make-group
2541 @cindex making groups
2542 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
2543 for a name, a method and possibly an @dfn{address}.  For an easier way
2544 to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}).
2545
2546 @item G M
2547 @kindex G M (Group)
2548 @findex gnus-group-read-ephemeral-group
2549 Make an ephemeral group (@code{gnus-group-read-ephemeral-group}).  Gnus
2550 will prompt you for a name, a method and an @dfn{address}.
2551
2552 @item G r
2553 @kindex G r (Group)
2554 @findex gnus-group-rename-group
2555 @cindex renaming groups
2556 Rename the current group to something else
2557 (@code{gnus-group-rename-group}).  This is valid only on some
2558 groups---mail groups mostly.  This command might very well be quite slow
2559 on some back ends.
2560
2561 @item G c
2562 @kindex G c (Group)
2563 @cindex customizing
2564 @findex gnus-group-customize
2565 Customize the group parameters (@code{gnus-group-customize}).
2566
2567 @item G e
2568 @kindex G e (Group)
2569 @findex gnus-group-edit-group-method
2570 @cindex renaming groups
2571 Enter a buffer where you can edit the select method of the current
2572 group (@code{gnus-group-edit-group-method}).
2573
2574 @item G p
2575 @kindex G p (Group)
2576 @findex gnus-group-edit-group-parameters
2577 Enter a buffer where you can edit the group parameters
2578 (@code{gnus-group-edit-group-parameters}).
2579
2580 @item G E
2581 @kindex G E (Group)
2582 @findex gnus-group-edit-group
2583 Enter a buffer where you can edit the group info
2584 (@code{gnus-group-edit-group}).
2585
2586 @item G d
2587 @kindex G d (Group)
2588 @findex gnus-group-make-directory-group
2589 @cindex nndir
2590 Make a directory group (@pxref{Directory Groups}).  You will be prompted
2591 for a directory name (@code{gnus-group-make-directory-group}).
2592
2593 @item G h
2594 @kindex G h (Group)
2595 @cindex help group
2596 @findex gnus-group-make-help-group
2597 Make the Gnus help group (@code{gnus-group-make-help-group}).
2598
2599 @item G D
2600 @kindex G D (Group)
2601 @findex gnus-group-enter-directory
2602 @cindex nneething
2603 Read an arbitrary directory as if it were a newsgroup with the
2604 @code{nneething} back end (@code{gnus-group-enter-directory}).
2605 @xref{Anything Groups}.
2606
2607 @item G f
2608 @kindex G f (Group)
2609 @findex gnus-group-make-doc-group
2610 @cindex ClariNet Briefs
2611 @cindex nndoc
2612 Make a group based on some file or other
2613 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
2614 command, you will be prompted for a file name and a file type.
2615 Currently supported types are @code{mbox}, @code{babyl},
2616 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2617 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2618 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2619 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}.  If
2620 you run this command without a prefix, Gnus will guess at the file
2621 type.  @xref{Document Groups}.
2622
2623 @item G u
2624 @kindex G u (Group)
2625 @vindex gnus-useful-groups
2626 @findex gnus-group-make-useful-group
2627 Create one of the groups mentioned in @code{gnus-useful-groups}
2628 (@code{gnus-group-make-useful-group}).
2629
2630 @item G w
2631 @kindex G w (Group)
2632 @findex gnus-group-make-web-group
2633 @cindex Google
2634 @cindex nnweb
2635 @cindex gmane
2636 Make an ephemeral group based on a web search
2637 (@code{gnus-group-make-web-group}).  If you give a prefix to this
2638 command, make a solid group instead.  You will be prompted for the
2639 search engine type and the search string.  Valid search engine types
2640 include @code{google}, @code{dejanews}, and @code{gmane}.
2641 @xref{Web Searches}.
2642
2643 If you use the @code{google} search engine, you can limit the search
2644 to a particular group by using a match string like
2645 @samp{shaving group:alt.sysadmin.recovery}.
2646
2647 @item G R
2648 @kindex G R (Group)
2649 @findex gnus-group-make-rss-group
2650 Make a group based on an @acronym{RSS} feed
2651 (@code{gnus-group-make-rss-group}).  You will be prompted for an URL.
2652 @xref{RSS}.
2653
2654 @item G DEL
2655 @kindex G DEL (Group)
2656 @findex gnus-group-delete-group
2657 This function will delete the current group
2658 (@code{gnus-group-delete-group}).  If given a prefix, this function will
2659 actually delete all the articles in the group, and forcibly remove the
2660 group itself from the face of the Earth.  Use a prefix only if you are
2661 absolutely sure of what you are doing.  This command can't be used on
2662 read-only groups (like @code{nntp} groups), though.
2663
2664 @item G V
2665 @kindex G V (Group)
2666 @findex gnus-group-make-empty-virtual
2667 Make a new, fresh, empty @code{nnvirtual} group
2668 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
2669
2670 @item G v
2671 @kindex G v (Group)
2672 @findex gnus-group-add-to-virtual
2673 Add the current group to an @code{nnvirtual} group
2674 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
2675 @end table
2676
2677 @xref{Select Methods}, for more information on the various select
2678 methods.
2679
2680 @vindex gnus-activate-foreign-newsgroups
2681 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2682 Gnus will check all foreign groups with this level or lower at startup.
2683 This might take quite a while, especially if you subscribe to lots of
2684 groups from different @acronym{NNTP} servers.  Also @pxref{Group Levels};
2685 @code{gnus-activate-level} also affects activation of foreign
2686 newsgroups.
2687
2688
2689 The following commands create ephemeral groups.  They can be called not
2690 only from the Group buffer, but in any Gnus buffer.
2691
2692 @table @code
2693 @item gnus-read-ephemeral-gmane-group
2694 @findex gnus-read-ephemeral-gmane-group
2695 @vindex gnus-gmane-group-download-format
2696 Read an ephemeral group on Gmane.org.  The articles are downloaded via
2697 HTTP using the URL specified by @code{gnus-gmane-group-download-format}.
2698 Gnus will prompt you for a group name, the start article number and an
2699 the article range.
2700
2701 @item gnus-read-ephemeral-gmane-group-url
2702 @findex gnus-read-ephemeral-gmane-group-url
2703 This command is similar to @code{gnus-read-ephemeral-gmane-group}, but
2704 the group name and the article number and range are constructed from a
2705 given @acronym{URL}.  Supported @acronym{URL} formats include e.g.
2706 @url{http://thread.gmane.org/gmane.foo.bar/12300/focus=12399},
2707 @url{http://thread.gmane.org/gmane.foo.bar/12345/},
2708 @url{http://article.gmane.org/gmane.foo.bar/12345/},
2709 @url{http://permalink.gmane.org/gmane.foo.bar/12345/}, and
2710 @url{http://news.gmane.org/group/gmane.foo.bar/thread=12345}.
2711
2712 @item gnus-read-ephemeral-emacs-bug-group
2713 @findex gnus-read-ephemeral-emacs-bug-group
2714 Read an Emacs bug report in an ephemeral group.  Gnus will prompt for a
2715 bug number.  The default is the number at point.  The @acronym{URL} is
2716 specified in @code{gnus-bug-group-download-format-alist}.
2717
2718 @item gnus-read-ephemeral-debian-bug-group
2719 @findex gnus-read-ephemeral-debian-bug-group
2720 Read a Debian bug report in an ephemeral group.  Analog to
2721 @code{gnus-read-ephemeral-emacs-bug-group}.
2722 @end table
2723
2724 Some of these command are also useful for article buttons, @xref{Article
2725 Buttons}.
2726
2727 Here is an example:
2728 @lisp
2729 (require 'gnus-art)
2730 (add-to-list
2731  'gnus-button-alist
2732  '("#\\([0-9]+\\)\\>" 1
2733    (string-match "\\<emacs\\>" (or gnus-newsgroup-name ""))
2734    gnus-read-ephemeral-emacs-bug-group 1))
2735 @end lisp
2736
2737
2738 @node Group Parameters
2739 @section Group Parameters
2740 @cindex group parameters
2741
2742 The group parameters store information local to a particular group.
2743
2744 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
2745 group.  (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
2746 presents you with a Customize-like interface.  The latter helps avoid
2747 silly Lisp errors.)  You might also be interested in reading about topic
2748 parameters (@pxref{Topic Parameters}).
2749 Additionally, you can set group parameters via the
2750 @code{gnus-parameters} variable, see below.
2751
2752 Here's an example group parameter list:
2753
2754 @example
2755 ((to-address . "ding@@gnus.org")
2756  (auto-expire . t))
2757 @end example
2758
2759 We see that each element consists of a ``dotted pair''---the thing before
2760 the dot is the key, while the thing after the dot is the value.  All the
2761 parameters have this form @emph{except} local variable specs, which are
2762 not dotted pairs, but proper lists.
2763
2764 Some parameters have correspondent customizable variables, each of which
2765 is an alist of regexps and values.
2766
2767 The following group parameters can be used:
2768
2769 @table @code
2770 @item to-address
2771 @cindex to-address
2772 Address used by when doing followups and new posts.
2773
2774 @example
2775 (to-address . "some@@where.com")
2776 @end example
2777
2778 This is primarily useful in mail groups that represent closed mailing
2779 lists---mailing lists where it's expected that everybody that writes to
2780 the mailing list is subscribed to it.  Since using this parameter
2781 ensures that the mail only goes to the mailing list itself, it means
2782 that members won't receive two copies of your followups.
2783
2784 Using @code{to-address} will actually work whether the group is foreign
2785 or not.  Let's say there's a group on the server that is called
2786 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
2787 the articles from a mail-to-news gateway.  Posting directly to this
2788 group is therefore impossible---you have to send mail to the mailing
2789 list address instead.
2790
2791 See also @code{gnus-parameter-to-address-alist}.
2792
2793 @item to-list
2794 @cindex to-list
2795 Address used when doing @kbd{a} in that group.
2796
2797 @example
2798 (to-list . "some@@where.com")
2799 @end example
2800
2801 It is totally ignored
2802 when doing a followup---except that if it is present in a news group,
2803 you'll get mail group semantics when doing @kbd{f}.
2804
2805 If you do an @kbd{a} command in a mail group and you have neither a
2806 @code{to-list} group parameter nor a @code{to-address} group parameter,
2807 then a @code{to-list} group parameter will be added automatically upon
2808 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2809 @vindex gnus-add-to-list
2810
2811 @findex gnus-mailing-list-mode
2812 @cindex mail list groups
2813 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2814 entering summary buffer.
2815
2816 See also @code{gnus-parameter-to-list-alist}.
2817
2818 @anchor{subscribed}
2819 @item subscribed
2820 @cindex subscribed
2821 @cindex Mail-Followup-To
2822 @findex gnus-find-subscribed-addresses
2823 If this parameter is set to @code{t}, Gnus will consider the
2824 to-address and to-list parameters for this group as addresses of
2825 mailing lists you are subscribed to.  Giving Gnus this information is
2826 (only) a first step in getting it to generate correct Mail-Followup-To
2827 headers for your posts to these lists.  The second step is to put the
2828 following in your @file{.gnus.el}
2829
2830 @lisp
2831 (setq message-subscribed-address-functions
2832       '(gnus-find-subscribed-addresses))
2833 @end lisp
2834
2835 @xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for
2836 a complete treatment of available MFT support.
2837
2838 @item visible
2839 @cindex visible
2840 If the group parameter list has the element @code{(visible . t)},
2841 that group will always be visible in the Group buffer, regardless
2842 of whether it has any unread articles.
2843
2844 This parameter cannot be set via @code{gnus-parameters}. See
2845 @code{gnus-permanently-visible-groups} as an alternative.
2846
2847 @item broken-reply-to
2848 @cindex broken-reply-to
2849 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2850 headers in this group are to be ignored, and for the header to be hidden
2851 if @code{reply-to} is part of @code{gnus-boring-article-headers}.  This
2852 can be useful if you're reading a mailing list group where the listserv
2853 has inserted @code{Reply-To} headers that point back to the listserv
2854 itself.  That is broken behavior.  So there!
2855
2856 @item to-group
2857 @cindex to-group
2858 Elements like @code{(to-group . "some.group.name")} means that all
2859 posts in that group will be sent to @code{some.group.name}.
2860
2861 @item newsgroup
2862 @cindex newsgroup
2863 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2864 will treat all responses as if they were responses to news articles.
2865 This can be useful if you have a mail group that's really a mirror of a
2866 news group.
2867
2868 @item gcc-self
2869 @cindex gcc-self
2870 If @code{(gcc-self . t)} is present in the group parameter list, newly
2871 composed messages will be @code{Gcc}'d to the current group.  If
2872 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2873 generated, if @code{(gcc-self . "string")} is present, this string will
2874 be inserted literally as a @code{gcc} header.  This parameter takes
2875 precedence over any default @code{Gcc} rules as described later
2876 (@pxref{Archived Messages}).
2877
2878 @strong{Caveat}: Adding @code{(gcc-self . t)} to the parameter list of
2879 @code{nntp} groups (or the like) isn't valid.  An @code{nntp} server
2880 doesn't accept articles.
2881
2882 @item auto-expire
2883 @cindex auto-expire
2884 @cindex expiring mail
2885 If the group parameter has an element that looks like @code{(auto-expire
2886 . t)}, all articles read will be marked as expirable.  For an
2887 alternative approach, @pxref{Expiring Mail}.
2888
2889 See also @code{gnus-auto-expirable-newsgroups}.
2890
2891 @item total-expire
2892 @cindex total-expire
2893 @cindex expiring mail
2894 If the group parameter has an element that looks like
2895 @code{(total-expire . t)}, all read articles will be put through the
2896 expiry process, even if they are not marked as expirable.  Use with
2897 caution.  Unread, ticked and dormant articles are not eligible for
2898 expiry.
2899
2900 See also @code{gnus-total-expirable-newsgroups}.
2901
2902 @item expiry-wait
2903 @cindex expiry-wait
2904 @vindex nnmail-expiry-wait-function
2905 If the group parameter has an element that looks like
2906 @code{(expiry-wait . 10)}, this value will override any
2907 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2908 (@pxref{Expiring Mail}) when expiring expirable messages.  The value
2909 can either be a number of days (not necessarily an integer) or the
2910 symbols @code{never} or @code{immediate}.
2911
2912 @item expiry-target
2913 @cindex expiry-target
2914 Where expired messages end up.  This parameter overrides
2915 @code{nnmail-expiry-target}.
2916
2917 @item score-file
2918 @cindex score file group parameter
2919 Elements that look like @code{(score-file . "file")} will make
2920 @file{file} into the current score file for the group in question.  All
2921 interactive score entries will be put into this file.
2922
2923 @item adapt-file
2924 @cindex adapt file group parameter
2925 Elements that look like @code{(adapt-file . "file")} will make
2926 @file{file} into the current adaptive file for the group in question.
2927 All adaptive score entries will be put into this file.
2928
2929 @item admin-address
2930 @cindex admin-address
2931 When unsubscribing from a mailing list you should never send the
2932 unsubscription notice to the mailing list itself.  Instead, you'd send
2933 messages to the administrative address.  This parameter allows you to
2934 put the admin address somewhere convenient.
2935
2936 @item display
2937 @cindex display
2938 Elements that look like @code{(display . MODE)} say which articles to
2939 display on entering the group.  Valid values are:
2940
2941 @table @code
2942 @item all
2943 Display all articles, both read and unread.
2944
2945 @item an integer
2946 Display the last @var{integer} articles in the group.  This is the same as
2947 entering the group with @kbd{C-u @var{integer}}.
2948
2949 @item default
2950 Display the default visible articles, which normally includes unread and
2951 ticked articles.
2952
2953 @item an array
2954 Display articles that satisfy a predicate.
2955
2956 Here are some examples:
2957
2958 @table @code
2959 @item [unread]
2960 Display only unread articles.
2961
2962 @item [not expire]
2963 Display everything except expirable articles.
2964
2965 @item [and (not reply) (not expire)]
2966 Display everything except expirable and articles you've already
2967 responded to.
2968 @end table
2969
2970 The available operators are @code{not}, @code{and} and @code{or}.
2971 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2972 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2973 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2974 @code{cache}, @code{forward}, @code{unseen} and @code{recent}.
2975
2976 @end table
2977
2978 The @code{display} parameter works by limiting the summary buffer to
2979 the subset specified.  You can pop the limit by using the @kbd{/ w}
2980 command (@pxref{Limiting}).
2981
2982 @item comment
2983 @cindex comment
2984 Elements that look like @code{(comment . "This is a comment")} are
2985 arbitrary comments on the group.  You can display comments in the
2986 group line (@pxref{Group Line Specification}).
2987
2988 @item charset
2989 @cindex charset
2990 Elements that look like @code{(charset . iso-8859-1)} will make
2991 @code{iso-8859-1} the default charset; that is, the charset that will be
2992 used for all articles that do not specify a charset.
2993
2994 See also @code{gnus-group-charset-alist}.
2995
2996 @item ignored-charsets
2997 @cindex ignored-charset
2998 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
2999 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
3000 default charset will be used for decoding articles.
3001
3002 See also @code{gnus-group-ignored-charsets-alist}.
3003
3004 @item posting-style
3005 @cindex posting-style
3006 You can store additional posting style information for this group
3007 here (@pxref{Posting Styles}).  The format is that of an entry in the
3008 @code{gnus-posting-styles} alist, except that there's no regexp matching
3009 the group name (of course).  Style elements in this group parameter will
3010 take precedence over the ones found in @code{gnus-posting-styles}.
3011
3012 For instance, if you want a funky name and signature in this group only,
3013 instead of hacking @code{gnus-posting-styles}, you could put something
3014 like this in the group parameters:
3015
3016 @example
3017 (posting-style
3018   (name "Funky Name")
3019   ("X-My-Header" "Funky Value")
3020   (signature "Funky Signature"))
3021 @end example
3022
3023 If you're using topics to organize your group buffer
3024 (@pxref{Group Topics}), note that posting styles can also be set in
3025 the topics parameters. Posting styles in topic parameters apply to all
3026 groups in this topic. More precisely, the posting-style settings for a
3027 group result from the hierarchical merging of all posting-style
3028 entries in the parameters of this group and all the topics it belongs
3029 to.
3030
3031
3032 @item post-method
3033 @cindex post-method
3034 If it is set, the value is used as the method for posting message
3035 instead of @code{gnus-post-method}.
3036
3037 @item mail-source
3038 @cindex mail-source
3039 If it is set, and the setting of @code{mail-sources} includes a
3040 @code{group} mail source (@pxref{Mail Sources}), the value is a
3041 mail source for this group.
3042
3043 @item banner
3044 @cindex banner
3045 An item like @code{(banner . @var{regexp})} causes any part of an article
3046 that matches the regular expression @var{regexp} to be stripped.  Instead of
3047 @var{regexp}, you can also use the symbol @code{signature} which strips the
3048 last signature or any of the elements of the alist
3049 @code{gnus-article-banner-alist}.
3050
3051 @item sieve
3052 @cindex sieve
3053 This parameter contains a Sieve test that should match incoming mail
3054 that should be placed in this group.  From this group parameter, a
3055 Sieve @samp{IF} control structure is generated, having the test as the
3056 condition and @samp{fileinto "group.name";} as the body.
3057
3058 For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve
3059 address "sender" "sieve-admin@@extundo.com")} group parameter, when
3060 translating the group parameter into a Sieve script (@pxref{Sieve
3061 Commands}) the following Sieve code is generated:
3062
3063 @example
3064 if address "sender" "sieve-admin@@extundo.com" @{
3065         fileinto "INBOX.list.sieve";
3066 @}
3067 @end example
3068
3069 To generate tests for multiple email-addresses use a group parameter
3070 like @code{(sieve address "sender" ("name@@one.org" else@@two.org"))}.
3071 When generating a sieve script (@pxref{Sieve Commands}) Sieve code
3072 like the following is generated:
3073
3074 @example
3075 if address "sender" ["name@@one.org", "else@@two.org"] @{
3076         fileinto "INBOX.list.sieve";
3077 @}
3078 @end example
3079
3080 See @pxref{Sieve Commands} for commands and variables that might be of
3081 interest in relation to the sieve parameter.
3082
3083 The Sieve language is described in RFC 3028.  @xref{Top, Emacs Sieve,
3084 Top, sieve, Emacs Sieve}.
3085
3086 @item (agent parameters)
3087 If the agent has been enabled, you can set any of the its parameters
3088 to control the behavior of the agent in individual groups. See Agent
3089 Parameters in @ref{Category Syntax}.  Most users will choose to set
3090 agent parameters in either an agent category or group topic to
3091 minimize the configuration effort.
3092
3093 @item (@var{variable} @var{form})
3094 You can use the group parameters to set variables local to the group you
3095 are entering.  If you want to turn threading off in @samp{news.answers},
3096 you could put @code{(gnus-show-threads nil)} in the group parameters of
3097 that group.  @code{gnus-show-threads} will be made into a local variable
3098 in the summary buffer you enter, and the form @code{nil} will be
3099 @code{eval}ed there.
3100
3101 Note that this feature sets the variable locally to the summary buffer
3102 if and only if @var{variable} has been bound as a variable.  Otherwise,
3103 only evaluating the form will take place.  So, you may want to bind the
3104 variable in advance using @code{defvar} or other if the result of the
3105 form needs to be set to it.
3106
3107 But some variables are evaluated in the article buffer, or in the
3108 message buffer (of a reply or followup or otherwise newly created
3109 message).  As a workaround, it might help to add the variable in
3110 question to @code{gnus-newsgroup-variables}.  @xref{Various Summary
3111 Stuff}.  So if you want to set @code{message-from-style} via the group
3112 parameters, then you may need the following statement elsewhere in your
3113 @file{~/.gnus.el} file:
3114
3115 @lisp
3116 (add-to-list 'gnus-newsgroup-variables 'message-from-style)
3117 @end lisp
3118
3119 @vindex gnus-list-identifiers
3120 A use for this feature is to remove a mailing list identifier tag in
3121 the subject fields of articles.  E.g. if the news group
3122
3123 @example
3124 nntp+news.gnus.org:gmane.text.docbook.apps
3125 @end example
3126
3127 has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this
3128 tag can be removed from the article subjects in the summary buffer for
3129 the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")}
3130 into the group parameters for the group.
3131
3132 This can also be used as a group-specific hook function.  If you want to
3133 hear a beep when you enter a group, you could put something like
3134 @code{(dummy-variable (ding))} in the parameters of that group.  If
3135 @code{dummy-variable} has been bound (see above), it will be set to the
3136 (meaningless) result of the @code{(ding)} form.
3137
3138 Alternatively, since the VARIABLE becomes local to the group, this
3139 pattern can be used to temporarily change a hook.  For example, if the
3140 following is added to a group parameter
3141
3142 @lisp
3143 (gnus-summary-prepared-hook
3144   '(lambda nil (local-set-key "d" (local-key-binding "n"))))
3145 @end lisp
3146
3147 when the group is entered, the 'd' key will not mark the article as
3148 expired.
3149
3150 @end table
3151
3152 @vindex gnus-parameters
3153 Group parameters can be set via the @code{gnus-parameters} variable too.
3154 But some variables, such as @code{visible}, have no effect (For this
3155 case see @code{gnus-permanently-visible-groups} as an alternative.).
3156 For example:
3157
3158 @lisp
3159 (setq gnus-parameters
3160       '(("mail\\..*"
3161          (gnus-show-threads nil)
3162          (gnus-use-scoring nil)
3163          (gnus-summary-line-format
3164           "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3165          (gcc-self . t)
3166          (display . all))
3167
3168         ("^nnimap:\\(foo.bar\\)$"
3169          (to-group . "\\1"))
3170
3171         ("mail\\.me"
3172          (gnus-use-scoring  t))
3173
3174         ("list\\..*"
3175          (total-expire . t)
3176          (broken-reply-to . t))))
3177 @end lisp
3178
3179 String value of parameters will be subjected to regexp substitution, as
3180 the @code{to-group} example shows.
3181
3182 @vindex gnus-parameters-case-fold-search
3183 By default, whether comparing the group name and one of those regexps
3184 specified in @code{gnus-parameters} is done in a case-sensitive manner
3185 or a case-insensitive manner depends on the value of
3186 @code{case-fold-search} at the time when the comparison is done.  The
3187 value of @code{case-fold-search} is typically @code{t}; it means, for
3188 example, the element @code{("INBOX\\.FOO" (total-expire . t))} might be
3189 applied to both the @samp{INBOX.FOO} group and the @samp{INBOX.foo}
3190 group.  If you want to make those regexps always case-sensitive, set the
3191 value of the @code{gnus-parameters-case-fold-search} variable to
3192 @code{nil}.  Otherwise, set it to @code{t} if you want to compare them
3193 always in a case-insensitive manner.
3194
3195 You can define different sorting to different groups via
3196 @code{gnus-parameters}.  Here is an example to sort an @acronym{NNTP}
3197 group by reverse date to see the latest news at the top and an
3198 @acronym{RSS} group by subject.  In this example, the first group is the
3199 Debian daily news group @code{gmane.linux.debian.user.news} from
3200 news.gmane.org.  The @acronym{RSS} group corresponds to the Debian
3201 weekly news RSS feed
3202 @url{http://packages.debian.org/unstable/newpkg_main.en.rdf},
3203 @xref{RSS}.
3204
3205 @lisp
3206 (setq
3207  gnus-parameters
3208  '(("nntp.*gmane\\.debian\\.user\\.news"
3209     (gnus-show-threads nil)
3210     (gnus-article-sort-functions '((not gnus-article-sort-by-date)))
3211     (gnus-use-adaptive-scoring nil)
3212     (gnus-use-scoring nil))
3213    ("nnrss.*debian"
3214     (gnus-show-threads nil)
3215     (gnus-article-sort-functions 'gnus-article-sort-by-subject)
3216     (gnus-use-adaptive-scoring nil)
3217     (gnus-use-scoring t)
3218     (gnus-score-find-score-files-function 'gnus-score-find-single)
3219     (gnus-summary-line-format "%U%R%z%d %I%(%[ %s %]%)\n"))))
3220 @end lisp
3221
3222
3223 @node Listing Groups
3224 @section Listing Groups
3225 @cindex group listing
3226
3227 These commands all list various slices of the groups available.
3228
3229 @table @kbd
3230
3231 @item l
3232 @itemx A s
3233 @kindex A s (Group)
3234 @kindex l (Group)
3235 @findex gnus-group-list-groups
3236 List all groups that have unread articles
3237 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
3238 command will list only groups of level ARG and lower.  By default, it
3239 only lists groups of level five (i.e.,
3240 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3241 groups).
3242
3243 @item L
3244 @itemx A u
3245 @kindex A u (Group)
3246 @kindex L (Group)
3247 @findex gnus-group-list-all-groups
3248 List all groups, whether they have unread articles or not
3249 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
3250 this command will list only groups of level ARG and lower.  By default,
3251 it lists groups of level seven or lower (i.e., just subscribed and
3252 unsubscribed groups).
3253
3254 @item A l
3255 @kindex A l (Group)
3256 @findex gnus-group-list-level
3257 List all unread groups on a specific level
3258 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
3259 with no unread articles.
3260
3261 @item A k
3262 @kindex A k (Group)
3263 @findex gnus-group-list-killed
3264 List all killed groups (@code{gnus-group-list-killed}).  If given a
3265 prefix argument, really list all groups that are available, but aren't
3266 currently (un)subscribed.  This could entail reading the active file
3267 from the server.
3268
3269 @item A z
3270 @kindex A z (Group)
3271 @findex gnus-group-list-zombies
3272 List all zombie groups (@code{gnus-group-list-zombies}).
3273
3274 @item A m
3275 @kindex A m (Group)
3276 @findex gnus-group-list-matching
3277 List all unread, subscribed groups with names that match a regexp
3278 (@code{gnus-group-list-matching}).
3279
3280 @item A M
3281 @kindex A M (Group)
3282 @findex gnus-group-list-all-matching
3283 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3284
3285 @item A A
3286 @kindex A A (Group)
3287 @findex gnus-group-list-active
3288 List absolutely all groups in the active file(s) of the
3289 server(s) you are connected to (@code{gnus-group-list-active}).  This
3290 might very well take quite a while.  It might actually be a better idea
3291 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3292 thing to match on.  Also note that this command may list groups that
3293 don't exist (yet)---these will be listed as if they were killed groups.
3294 Take the output with some grains of salt.
3295
3296 @item A a
3297 @kindex A a (Group)
3298 @findex gnus-group-apropos
3299 List all groups that have names that match a regexp
3300 (@code{gnus-group-apropos}).
3301
3302 @item A d
3303 @kindex A d (Group)
3304 @findex gnus-group-description-apropos
3305 List all groups that have names or descriptions that match a regexp
3306 (@code{gnus-group-description-apropos}).
3307
3308 @item A c
3309 @kindex A c (Group)
3310 @findex gnus-group-list-cached
3311 List all groups with cached articles (@code{gnus-group-list-cached}).
3312
3313 @item A ?
3314 @kindex A ? (Group)
3315 @findex gnus-group-list-dormant
3316 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3317
3318 @item A /
3319 @kindex A / (Group)
3320 @findex gnus-group-list-limit
3321 List groups limited within the current selection
3322 (@code{gnus-group-list-limit}).
3323
3324 @item A f
3325 @kindex A f (Group)
3326 @findex gnus-group-list-flush
3327 Flush groups from the current selection (@code{gnus-group-list-flush}).
3328
3329 @item A p
3330 @kindex A p (Group)
3331 @findex gnus-group-list-plus
3332 List groups plus the current selection (@code{gnus-group-list-plus}).
3333
3334 @end table
3335
3336 @vindex gnus-permanently-visible-groups
3337 @cindex visible group parameter
3338 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3339 always be shown, whether they have unread articles or not.  You can also
3340 add the @code{visible} element to the group parameters in question to
3341 get the same effect.
3342
3343 @vindex gnus-list-groups-with-ticked-articles
3344 Groups that have just ticked articles in it are normally listed in the
3345 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
3346 @code{nil}, these groups will be treated just like totally empty
3347 groups.  It is @code{t} by default.
3348
3349
3350 @node Sorting Groups
3351 @section Sorting Groups
3352 @cindex sorting groups
3353
3354 @kindex C-c C-s (Group)
3355 @findex gnus-group-sort-groups
3356 @vindex gnus-group-sort-function
3357 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3358 group buffer according to the function(s) given by the
3359 @code{gnus-group-sort-function} variable.  Available sorting functions
3360 include:
3361
3362 @table @code
3363
3364 @item gnus-group-sort-by-alphabet
3365 @findex gnus-group-sort-by-alphabet
3366 Sort the group names alphabetically.  This is the default.
3367
3368 @item gnus-group-sort-by-real-name
3369 @findex gnus-group-sort-by-real-name
3370 Sort the group alphabetically on the real (unprefixed) group names.
3371
3372 @item gnus-group-sort-by-level
3373 @findex gnus-group-sort-by-level
3374 Sort by group level.
3375
3376 @item gnus-group-sort-by-score
3377 @findex gnus-group-sort-by-score
3378 Sort by group score.  @xref{Group Score}.
3379
3380 @item gnus-group-sort-by-rank
3381 @findex gnus-group-sort-by-rank
3382 Sort by group score and then the group level.  The level and the score
3383 are, when taken together, the group's @dfn{rank}.  @xref{Group Score}.
3384
3385 @item gnus-group-sort-by-unread
3386 @findex gnus-group-sort-by-unread
3387 Sort by number of unread articles.
3388
3389 @item gnus-group-sort-by-method
3390 @findex gnus-group-sort-by-method
3391 Sort alphabetically on the select method.
3392
3393 @item gnus-group-sort-by-server
3394 @findex gnus-group-sort-by-server
3395 Sort alphabetically on the Gnus server name.
3396
3397
3398 @end table
3399
3400 @code{gnus-group-sort-function} can also be a list of sorting
3401 functions.  In that case, the most significant sort key function must be
3402 the last one.
3403
3404
3405 There are also a number of commands for sorting directly according to
3406 some sorting criteria:
3407
3408 @table @kbd
3409 @item G S a
3410 @kindex G S a (Group)
3411 @findex gnus-group-sort-groups-by-alphabet
3412 Sort the group buffer alphabetically by group name
3413 (@code{gnus-group-sort-groups-by-alphabet}).
3414
3415 @item G S u
3416 @kindex G S u (Group)
3417 @findex gnus-group-sort-groups-by-unread
3418 Sort the group buffer by the number of unread articles
3419 (@code{gnus-group-sort-groups-by-unread}).
3420
3421 @item G S l
3422 @kindex G S l (Group)
3423 @findex gnus-group-sort-groups-by-level
3424 Sort the group buffer by group level
3425 (@code{gnus-group-sort-groups-by-level}).
3426
3427 @item G S v
3428 @kindex G S v (Group)
3429 @findex gnus-group-sort-groups-by-score
3430 Sort the group buffer by group score
3431 (@code{gnus-group-sort-groups-by-score}).  @xref{Group Score}.
3432
3433 @item G S r
3434 @kindex G S r (Group)
3435 @findex gnus-group-sort-groups-by-rank
3436 Sort the group buffer by group rank
3437 (@code{gnus-group-sort-groups-by-rank}).  @xref{Group Score}.
3438
3439 @item G S m
3440 @kindex G S m (Group)
3441 @findex gnus-group-sort-groups-by-method
3442 Sort the group buffer alphabetically by back end name@*
3443 (@code{gnus-group-sort-groups-by-method}).
3444
3445 @item G S n
3446 @kindex G S n (Group)
3447 @findex gnus-group-sort-groups-by-real-name
3448 Sort the group buffer alphabetically by real (unprefixed) group name
3449 (@code{gnus-group-sort-groups-by-real-name}).
3450
3451 @end table
3452
3453 All the commands below obey the process/prefix convention
3454 (@pxref{Process/Prefix}).
3455
3456 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3457 commands will sort in reverse order.
3458
3459 You can also sort a subset of the groups:
3460
3461 @table @kbd
3462 @item G P a
3463 @kindex G P a (Group)
3464 @findex gnus-group-sort-selected-groups-by-alphabet
3465 Sort the groups alphabetically by group name
3466 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3467
3468 @item G P u
3469 @kindex G P u (Group)
3470 @findex gnus-group-sort-selected-groups-by-unread
3471 Sort the groups by the number of unread articles
3472 (@code{gnus-group-sort-selected-groups-by-unread}).
3473
3474 @item G P l
3475 @kindex G P l (Group)
3476 @findex gnus-group-sort-selected-groups-by-level
3477 Sort the groups by group level
3478 (@code{gnus-group-sort-selected-groups-by-level}).
3479
3480 @item G P v
3481 @kindex G P v (Group)
3482 @findex gnus-group-sort-selected-groups-by-score
3483 Sort the groups by group score
3484 (@code{gnus-group-sort-selected-groups-by-score}).  @xref{Group Score}.
3485
3486 @item G P r
3487 @kindex G P r (Group)
3488 @findex gnus-group-sort-selected-groups-by-rank
3489 Sort the groups by group rank
3490 (@code{gnus-group-sort-selected-groups-by-rank}).  @xref{Group Score}.
3491
3492 @item G P m
3493 @kindex G P m (Group)
3494 @findex gnus-group-sort-selected-groups-by-method
3495 Sort the groups alphabetically by back end name@*
3496 (@code{gnus-group-sort-selected-groups-by-method}).
3497
3498 @item G P n
3499 @kindex G P n (Group)
3500 @findex gnus-group-sort-selected-groups-by-real-name
3501 Sort the groups alphabetically by real (unprefixed) group name
3502 (@code{gnus-group-sort-selected-groups-by-real-name}).
3503
3504 @item G P s
3505 @kindex G P s (Group)
3506 @findex gnus-group-sort-selected-groups
3507 Sort the groups according to @code{gnus-group-sort-function}.
3508
3509 @end table
3510
3511 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3512 move groups around.
3513
3514
3515 @node Group Maintenance
3516 @section Group Maintenance
3517 @cindex bogus groups
3518
3519 @table @kbd
3520 @item b
3521 @kindex b (Group)
3522 @findex gnus-group-check-bogus-groups
3523 Find bogus groups and delete them
3524 (@code{gnus-group-check-bogus-groups}).
3525
3526 @item F
3527 @kindex F (Group)
3528 @findex gnus-group-find-new-groups
3529 Find new groups and process them (@code{gnus-group-find-new-groups}).
3530 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3531 for new groups.  With 2 @kbd{C-u}'s, use most complete method possible
3532 to query the server for new groups, and subscribe the new groups as
3533 zombies.
3534
3535 @item C-c C-x
3536 @kindex C-c C-x (Group)
3537 @findex gnus-group-expire-articles
3538 @cindex expiring mail
3539 Run all expirable articles in the current group through the expiry
3540 process (if any) (@code{gnus-group-expire-articles}).  That is, delete
3541 all expirable articles in the group that have been around for a while.
3542 (@pxref{Expiring Mail}).
3543
3544 @item C-c C-M-x
3545 @kindex C-c C-M-x (Group)
3546 @findex gnus-group-expire-all-groups
3547 @cindex expiring mail
3548 Run all expirable articles in all groups through the expiry process
3549 (@code{gnus-group-expire-all-groups}).
3550
3551 @end table
3552
3553
3554 @node Browse Foreign Server
3555 @section Browse Foreign Server
3556 @cindex foreign servers
3557 @cindex browsing servers
3558
3559 @table @kbd
3560 @item B
3561 @kindex B (Group)
3562 @findex gnus-group-browse-foreign-server
3563 You will be queried for a select method and a server name.  Gnus will
3564 then attempt to contact this server and let you browse the groups there
3565 (@code{gnus-group-browse-foreign-server}).
3566 @end table
3567
3568 @findex gnus-browse-mode
3569 A new buffer with a list of available groups will appear.  This buffer
3570 will use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
3571 a lot) like a normal group buffer.
3572
3573 Here's a list of keystrokes available in the browse mode:
3574
3575 @table @kbd
3576 @item n
3577 @kindex n (Browse)
3578 @findex gnus-group-next-group
3579 Go to the next group (@code{gnus-group-next-group}).
3580
3581 @item p
3582 @kindex p (Browse)
3583 @findex gnus-group-prev-group
3584 Go to the previous group (@code{gnus-group-prev-group}).
3585
3586 @item SPACE
3587 @kindex SPACE (Browse)
3588 @findex gnus-browse-read-group
3589 Enter the current group and display the first article
3590 (@code{gnus-browse-read-group}).
3591
3592 @item RET
3593 @kindex RET (Browse)
3594 @findex gnus-browse-select-group
3595 Enter the current group (@code{gnus-browse-select-group}).
3596
3597 @item u
3598 @kindex u (Browse)
3599 @findex gnus-browse-unsubscribe-current-group
3600 @vindex gnus-browse-subscribe-newsgroup-method
3601 Unsubscribe to the current group, or, as will be the case here,
3602 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).  You
3603 can affect the way the new group is entered into the Group buffer
3604 using the variable @code{gnus-browse-subscribe-newsgroup-method}.  See
3605 @pxref{Subscription Methods} for available options.
3606
3607 @item l
3608 @itemx q
3609 @kindex q (Browse)
3610 @kindex l (Browse)
3611 @findex gnus-browse-exit
3612 Exit browse mode (@code{gnus-browse-exit}).
3613
3614 @item d
3615 @kindex d (Browse)
3616 @findex gnus-browse-describe-group
3617 Describe the current group (@code{gnus-browse-describe-group}).
3618
3619 @item ?
3620 @kindex ? (Browse)
3621 @findex gnus-browse-describe-briefly
3622 Describe browse mode briefly (well, there's not much to describe, is
3623 there) (@code{gnus-browse-describe-briefly}).
3624 @end table
3625
3626
3627 @node Exiting Gnus
3628 @section Exiting Gnus
3629 @cindex exiting Gnus
3630
3631 Yes, Gnus is ex(c)iting.
3632
3633 @table @kbd
3634 @item z
3635 @kindex z (Group)
3636 @findex gnus-group-suspend
3637 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
3638 but it kills all buffers except the Group buffer.  I'm not sure why this
3639 is a gain, but then who am I to judge?
3640
3641 @item q
3642 @kindex q (Group)
3643 @findex gnus-group-exit
3644 @c @icon{gnus-group-exit}
3645 Quit Gnus (@code{gnus-group-exit}).
3646
3647 @item Q
3648 @kindex Q (Group)
3649 @findex gnus-group-quit
3650 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3651 The dribble file will be saved, though (@pxref{Auto Save}).
3652 @end table
3653
3654 @vindex gnus-exit-gnus-hook
3655 @vindex gnus-suspend-gnus-hook
3656 @vindex gnus-after-exiting-gnus-hook
3657 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
3658 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
3659 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3660 exiting Gnus.
3661
3662 Note:
3663
3664 @quotation
3665 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3666 numbly heavy and herself fall into a hazy trance as the boy sitting
3667 behind her drew repeated lines with his pencil across the back of her
3668 plastic chair.
3669 @end quotation
3670
3671
3672 @node Group Topics
3673 @section Group Topics
3674 @cindex topics
3675
3676 If you read lots and lots of groups, it might be convenient to group
3677 them hierarchically according to topics.  You put your Emacs groups over
3678 here, your sex groups over there, and the rest (what, two groups or so?)
3679 you put in some misc section that you never bother with anyway.  You can
3680 even group the Emacs sex groups as a sub-topic to either the Emacs
3681 groups or the sex groups---or both!  Go wild!
3682
3683 @iftex
3684 @iflatex
3685 \gnusfigure{Group Topics}{400}{
3686 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3687 }
3688 @end iflatex
3689 @end iftex
3690
3691 Here's an example:
3692
3693 @example
3694 Gnus
3695   Emacs -- I wuw it!
3696      3: comp.emacs
3697      2: alt.religion.emacs
3698     Naughty Emacs
3699      452: alt.sex.emacs
3700        0: comp.talk.emacs.recovery
3701   Misc
3702      8: comp.binaries.fractals
3703     13: comp.sources.unix
3704 @end example
3705
3706 @findex gnus-topic-mode
3707 @kindex t (Group)
3708 To get this @emph{fab} functionality you simply turn on (ooh!) the
3709 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
3710 is a toggling command.)
3711
3712 Go ahead, just try it.  I'll still be here when you get back.  La de
3713 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3714 Yes, and now press @kbd{l}.  There.  All your groups are now listed
3715 under @samp{misc}.  Doesn't that make you feel all warm and fuzzy?
3716 Hot and bothered?
3717
3718 If you want this permanently enabled, you should add that minor mode to
3719 the hook for the group mode.  Put the following line in your
3720 @file{~/.gnus.el} file:
3721
3722 @lisp
3723 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3724 @end lisp
3725
3726 @menu
3727 * Topic Commands::              Interactive E-Z commands.
3728 * Topic Variables::             How to customize the topics the Lisp Way.
3729 * Topic Sorting::               Sorting each topic individually.
3730 * Topic Topology::              A map of the world.
3731 * Topic Parameters::            Parameters that apply to all groups in a topic.
3732 @end menu
3733
3734
3735 @node Topic Commands
3736 @subsection Topic Commands
3737 @cindex topic commands
3738
3739 When the topic minor mode is turned on, a new @kbd{T} submap will be
3740 available.  In addition, a few of the standard keys change their
3741 definitions slightly.
3742
3743 In general, the following kinds of operations are possible on topics.
3744 First of all, you want to create topics.  Secondly, you want to put
3745 groups in topics and to move them around until you have an order you
3746 like.  The third kind of operation is to show/hide parts of the whole
3747 shebang.  You might want to hide a topic including its subtopics and
3748 groups, to get a better overview of the other groups.
3749
3750 Here is a list of the basic keys that you might need to set up topics
3751 the way you like.
3752
3753 @table @kbd
3754
3755 @item T n
3756 @kindex T n (Topic)
3757 @findex gnus-topic-create-topic
3758 Prompt for a new topic name and create it
3759 (@code{gnus-topic-create-topic}).
3760
3761 @item T TAB
3762 @itemx TAB
3763 @kindex T TAB (Topic)
3764 @kindex TAB (Topic)
3765 @findex gnus-topic-indent
3766 ``Indent'' the current topic so that it becomes a sub-topic of the
3767 previous topic (@code{gnus-topic-indent}).  If given a prefix,
3768 ``un-indent'' the topic instead.
3769
3770 @item M-TAB
3771 @kindex M-TAB (Topic)
3772 @findex gnus-topic-unindent
3773 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3774 parent of its current parent (@code{gnus-topic-unindent}).
3775
3776 @end table
3777
3778 The following two keys can be used to move groups and topics around.
3779 They work like the well-known cut and paste.  @kbd{C-k} is like cut and
3780 @kbd{C-y} is like paste.  Of course, this being Emacs, we use the terms
3781 kill and yank rather than cut and paste.
3782
3783 @table @kbd
3784
3785 @item C-k
3786 @kindex C-k (Topic)
3787 @findex gnus-topic-kill-group
3788 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
3789 topic will be removed along with the topic.
3790
3791 @item C-y
3792 @kindex C-y (Topic)
3793 @findex gnus-topic-yank-group
3794 Yank the previously killed group or topic
3795 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
3796 before all groups.
3797
3798 So, to move a topic to the beginning of the list of topics, just hit
3799 @kbd{C-k} on it.  This is like the ``cut'' part of cut and paste.  Then,
3800 move the cursor to the beginning of the buffer (just below the ``Gnus''
3801 topic) and hit @kbd{C-y}.  This is like the ``paste'' part of cut and
3802 paste.  Like I said -- E-Z.
3803
3804 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics.  So
3805 you can move topics around as well as groups.
3806
3807 @end table
3808
3809 After setting up the topics the way you like them, you might wish to
3810 hide a topic, or to show it again.  That's why we have the following
3811 key.
3812
3813 @table @kbd
3814
3815 @item RET
3816 @kindex RET (Topic)
3817 @findex gnus-topic-select-group
3818 @itemx SPACE
3819 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3820 When you perform this command on a group, you'll enter the group, as
3821 usual.  When done on a topic line, the topic will be folded (if it was
3822 visible) or unfolded (if it was folded already).  So it's basically a
3823 toggling command on topics.  In addition, if you give a numerical
3824 prefix, group on that level (and lower) will be displayed.
3825
3826 @end table
3827
3828 Now for a list of other commands, in no particular order.
3829
3830 @table @kbd
3831
3832 @item T m
3833 @kindex T m (Topic)
3834 @findex gnus-topic-move-group
3835 Move the current group to some other topic
3836 (@code{gnus-topic-move-group}).  This command uses the process/prefix
3837 convention (@pxref{Process/Prefix}).
3838
3839 @item T j
3840 @kindex T j (Topic)
3841 @findex gnus-topic-jump-to-topic
3842 Go to a topic (@code{gnus-topic-jump-to-topic}).
3843
3844 @item T c
3845 @kindex T c (Topic)
3846 @findex gnus-topic-copy-group
3847 Copy the current group to some other topic
3848 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
3849 convention (@pxref{Process/Prefix}).
3850
3851 @item T h
3852 @kindex T h (Topic)
3853 @findex gnus-topic-hide-topic
3854 Hide the current topic (@code{gnus-topic-hide-topic}).  If given
3855 a prefix, hide the topic permanently.
3856
3857 @item T s
3858 @kindex T s (Topic)
3859 @findex gnus-topic-show-topic
3860 Show the current topic (@code{gnus-topic-show-topic}).  If given
3861 a prefix, show the topic permanently.
3862
3863 @item T D
3864 @kindex T D (Topic)
3865 @findex gnus-topic-remove-group
3866 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3867 This command is mainly useful if you have the same group in several
3868 topics and wish to remove it from one of the topics.  You may also
3869 remove a group from all topics, but in that case, Gnus will add it to
3870 the root topic the next time you start Gnus.  In fact, all new groups
3871 (which, naturally, don't belong to any topic) will show up in the root
3872 topic.
3873
3874 This command uses the process/prefix convention
3875 (@pxref{Process/Prefix}).
3876
3877 @item T M
3878 @kindex T M (Topic)
3879 @findex gnus-topic-move-matching
3880 Move all groups that match some regular expression to a topic
3881 (@code{gnus-topic-move-matching}).
3882
3883 @item T C
3884 @kindex T C (Topic)
3885 @findex gnus-topic-copy-matching
3886 Copy all groups that match some regular expression to a topic
3887 (@code{gnus-topic-copy-matching}).
3888
3889 @item T H
3890 @kindex T H (Topic)
3891 @findex gnus-topic-toggle-display-empty-topics
3892 Toggle hiding empty topics
3893 (@code{gnus-topic-toggle-display-empty-topics}).
3894
3895 @item T #
3896 @kindex T # (Topic)
3897 @findex gnus-topic-mark-topic
3898 Mark all groups in the current topic with the process mark
3899 (@code{gnus-topic-mark-topic}).  This command works recursively on
3900 sub-topics unless given a prefix.
3901
3902 @item T M-#
3903 @kindex T M-# (Topic)
3904 @findex gnus-topic-unmark-topic
3905 Remove the process mark from all groups in the current topic
3906 (@code{gnus-topic-unmark-topic}).  This command works recursively on
3907 sub-topics unless given a prefix.
3908
3909 @item C-c C-x
3910 @kindex C-c C-x (Topic)
3911 @findex gnus-topic-expire-articles
3912 @cindex expiring mail
3913 Run all expirable articles in the current group or topic through the
3914 expiry process (if any)
3915 (@code{gnus-topic-expire-articles}).  (@pxref{Expiring Mail}).
3916
3917 @item T r
3918 @kindex T r (Topic)
3919 @findex gnus-topic-rename
3920 Rename a topic (@code{gnus-topic-rename}).
3921
3922 @item T DEL
3923 @kindex T DEL (Topic)
3924 @findex gnus-topic-delete
3925 Delete an empty topic (@code{gnus-topic-delete}).
3926
3927 @item A T
3928 @kindex A T (Topic)
3929 @findex gnus-topic-list-active
3930 List all groups that Gnus knows about in a topics-ified way
3931 (@code{gnus-topic-list-active}).
3932
3933 @item T M-n
3934 @kindex T M-n (Topic)
3935 @findex gnus-topic-goto-next-topic
3936 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3937
3938 @item T M-p
3939 @kindex T M-p (Topic)
3940 @findex gnus-topic-goto-previous-topic
3941 Go to the previous topic (@code{gnus-topic-goto-previous-topic}).
3942
3943 @item G p
3944 @kindex G p (Topic)
3945 @findex gnus-topic-edit-parameters
3946 @cindex group parameters
3947 @cindex topic parameters
3948 @cindex parameters
3949 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3950 @xref{Topic Parameters}.
3951
3952 @end table
3953
3954
3955 @node Topic Variables
3956 @subsection Topic Variables
3957 @cindex topic variables
3958
3959 The previous section told you how to tell Gnus which topics to display.
3960 This section explains how to tell Gnus what to display about each topic.
3961
3962 @vindex gnus-topic-line-format
3963 The topic lines themselves are created according to the
3964 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3965 Valid elements are:
3966
3967 @table @samp
3968 @item i
3969 Indentation.
3970 @item n
3971 Topic name.
3972 @item v
3973 Visibility.
3974 @item l
3975 Level.
3976 @item g
3977 Number of groups in the topic.
3978 @item a
3979 Number of unread articles in the topic.
3980 @item A
3981 Number of unread articles in the topic and all its subtopics.
3982 @end table
3983
3984 @vindex gnus-topic-indent-level
3985 Each sub-topic (and the groups in the sub-topics) will be indented with
3986 @code{gnus-topic-indent-level} times the topic level number of spaces.
3987 The default is 2.
3988
3989 @vindex gnus-topic-mode-hook
3990 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3991
3992 @vindex gnus-topic-display-empty-topics
3993 The @code{gnus-topic-display-empty-topics} says whether to display even
3994 topics that have no unread articles in them.  The default is @code{t}.
3995
3996
3997 @node Topic Sorting
3998 @subsection Topic Sorting
3999 @cindex topic sorting
4000
4001 You can sort the groups in each topic individually with the following
4002 commands:
4003
4004
4005 @table @kbd
4006 @item T S a
4007 @kindex T S a (Topic)
4008 @findex gnus-topic-sort-groups-by-alphabet
4009 Sort the current topic alphabetically by group name
4010 (@code{gnus-topic-sort-groups-by-alphabet}).
4011
4012 @item T S u
4013 @kindex T S u (Topic)
4014 @findex gnus-topic-sort-groups-by-unread
4015 Sort the current topic by the number of unread articles
4016 (@code{gnus-topic-sort-groups-by-unread}).
4017
4018 @item T S l
4019 @kindex T S l (Topic)
4020 @findex gnus-topic-sort-groups-by-level
4021 Sort the current topic by group level
4022 (@code{gnus-topic-sort-groups-by-level}).
4023
4024 @item T S v
4025 @kindex T S v (Topic)
4026 @findex gnus-topic-sort-groups-by-score
4027 Sort the current topic by group score
4028 (@code{gnus-topic-sort-groups-by-score}).  @xref{Group Score}.
4029
4030 @item T S r
4031 @kindex T S r (Topic)
4032 @findex gnus-topic-sort-groups-by-rank
4033 Sort the current topic by group rank
4034 (@code{gnus-topic-sort-groups-by-rank}).  @xref{Group Score}.
4035
4036 @item T S m
4037 @kindex T S m (Topic)
4038 @findex gnus-topic-sort-groups-by-method
4039 Sort the current topic alphabetically by back end name
4040 (@code{gnus-topic-sort-groups-by-method}).
4041
4042 @item T S e
4043 @kindex T S e (Topic)
4044 @findex gnus-topic-sort-groups-by-server
4045 Sort the current topic alphabetically by server name
4046 (@code{gnus-topic-sort-groups-by-server}).
4047
4048 @item T S s
4049 @kindex T S s (Topic)
4050 @findex gnus-topic-sort-groups
4051 Sort the current topic according to the function(s) given by the
4052 @code{gnus-group-sort-function} variable
4053 (@code{gnus-topic-sort-groups}).
4054
4055 @end table
4056
4057 When given a prefix argument, all these commands will sort in reverse
4058 order.  @xref{Sorting Groups}, for more information about group
4059 sorting.
4060
4061
4062 @node Topic Topology
4063 @subsection Topic Topology
4064 @cindex topic topology
4065 @cindex topology
4066
4067 So, let's have a look at an example group buffer:
4068
4069 @example
4070 @group
4071 Gnus
4072   Emacs -- I wuw it!
4073      3: comp.emacs
4074      2: alt.religion.emacs
4075     Naughty Emacs
4076      452: alt.sex.emacs
4077        0: comp.talk.emacs.recovery
4078   Misc
4079      8: comp.binaries.fractals
4080     13: comp.sources.unix
4081 @end group
4082 @end example
4083
4084 So, here we have one top-level topic (@samp{Gnus}), two topics under
4085 that, and one sub-topic under one of the sub-topics.  (There is always
4086 just one (1) top-level topic).  This topology can be expressed as
4087 follows:
4088
4089 @lisp
4090 (("Gnus" visible)
4091  (("Emacs -- I wuw it!" visible)
4092   (("Naughty Emacs" visible)))
4093  (("Misc" visible)))
4094 @end lisp
4095
4096 @vindex gnus-topic-topology
4097 This is in fact how the variable @code{gnus-topic-topology} would look
4098 for the display above.  That variable is saved in the @file{.newsrc.eld}
4099 file, and shouldn't be messed with manually---unless you really want
4100 to.  Since this variable is read from the @file{.newsrc.eld} file,
4101 setting it in any other startup files will have no effect.
4102
4103 This topology shows what topics are sub-topics of what topics (right),
4104 and which topics are visible.  Two settings are currently
4105 allowed---@code{visible} and @code{invisible}.
4106
4107
4108 @node Topic Parameters
4109 @subsection Topic Parameters
4110 @cindex topic parameters
4111
4112 All groups in a topic will inherit group parameters from the parent
4113 (and ancestor) topic parameters.  All valid group parameters are valid
4114 topic parameters (@pxref{Group Parameters}).  When the agent is
4115 enabled, all agent parameters (See Agent Parameters in @ref{Category
4116 Syntax}) are also valid topic parameters.
4117
4118 In addition, the following parameters are only valid as topic
4119 parameters:
4120
4121 @table @code
4122 @item subscribe
4123 When subscribing new groups by topic (@pxref{Subscription Methods}), the
4124 @code{subscribe} topic parameter says what groups go in what topic.  Its
4125 value should be a regexp to match the groups that should go in that
4126 topic.
4127
4128 @item subscribe-level
4129 When subscribing new groups by topic (see the @code{subscribe} parameter),
4130 the group will be subscribed with the level specified in the
4131 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
4132
4133 @end table
4134
4135 Group parameters (of course) override topic parameters, and topic
4136 parameters in sub-topics override topic parameters in super-topics.  You
4137 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
4138 verb, although you may feel free to disagree with me here.)
4139
4140 @example
4141 @group
4142 Gnus
4143   Emacs
4144      3: comp.emacs
4145      2: alt.religion.emacs
4146    452: alt.sex.emacs
4147     Relief
4148      452: alt.sex.emacs
4149        0: comp.talk.emacs.recovery
4150   Misc
4151      8: comp.binaries.fractals
4152     13: comp.sources.unix
4153    452: alt.sex.emacs
4154 @end group
4155 @end example
4156
4157 The @samp{Emacs} topic has the topic parameter @code{(score-file
4158 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4159 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4160 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
4161 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4162 . "religion.SCORE")}.
4163
4164 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4165 will get the @file{relief.SCORE} home score file.  If you enter the same
4166 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4167 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
4168 get the @file{religion.SCORE} home score file.
4169
4170 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
4171 there are some problems, especially with the @code{total-expiry}
4172 parameter.  Say you have a mail group in two topics; one with
4173 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
4174 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
4175 of these topics you mean to expire articles from, so anything may
4176 happen.  In fact, I hereby declare that it is @dfn{undefined} what
4177 happens.  You just have to be careful if you do stuff like that.
4178
4179
4180 @node Non-ASCII Group Names
4181 @section Accessing groups of non-English names
4182 @cindex non-ascii group names
4183
4184 There are some news servers that provide groups of which the names are
4185 expressed with their native languages in the world.  For instance, in a
4186 certain news server there are some newsgroups of which the names are
4187 spelled in Chinese, where people are talking in Chinese.  You can, of
4188 course, subscribe to such news groups using Gnus.  Currently Gnus
4189 supports non-@acronym{ASCII} group names not only with the @code{nntp}
4190 back end but also with the @code{nnml} back end and the @code{nnrss}
4191 back end.
4192
4193 Every such group name is encoded by a certain charset in the server
4194 side (in an @acronym{NNTP} server its administrator determines the
4195 charset, but for groups in the other back ends it is determined by you).
4196 Gnus has to display the decoded ones for you in the group buffer and the
4197 article buffer, and needs to use the encoded ones when communicating
4198 with servers.  However, Gnus doesn't know what charset is used for each
4199 non-@acronym{ASCII} group name.  The following two variables are just
4200 the ones for telling Gnus what charset should be used for each group:
4201
4202 @table @code
4203 @item gnus-group-name-charset-method-alist
4204 @vindex gnus-group-name-charset-method-alist
4205 An alist of select methods and charsets.  The default value is
4206 @code{nil}.  The names of groups in the server specified by that select
4207 method are all supposed to use the corresponding charset.  For example:
4208
4209 @lisp
4210 (setq gnus-group-name-charset-method-alist
4211       '(((nntp "news.com.cn") . cn-gb-2312)))
4212 @end lisp
4213
4214 Charsets specified for groups with this variable are preferred to the
4215 ones specified for the same groups with the
4216 @code{gnus-group-name-charset-group-alist} variable (see below).
4217
4218 A select method can be very long, like:
4219
4220 @lisp
4221 (nntp "gmane"
4222       (nntp-address "news.gmane.org")
4223       (nntp-end-of-line "\n")
4224       (nntp-open-connection-function
4225        nntp-open-via-rlogin-and-telnet)
4226       (nntp-via-rlogin-command "ssh")
4227       (nntp-via-rlogin-command-switches
4228        ("-C" "-t" "-e" "none"))
4229       (nntp-via-address @dots{}))
4230 @end lisp
4231
4232 In that case, you can truncate it into @code{(nntp "gmane")} in this
4233 variable.  That is, it is enough to contain only the back end name and
4234 the server name.
4235
4236 @item gnus-group-name-charset-group-alist
4237 @cindex UTF-8 group names
4238 @vindex gnus-group-name-charset-group-alist
4239 An alist of regexp of group name and the charset for group names.
4240 @code{((".*" . utf-8))} is the default value if UTF-8 is supported,
4241 otherwise the default is @code{nil}.  For example:
4242
4243 @lisp
4244 (setq gnus-group-name-charset-group-alist
4245       '(("\\.com\\.cn:" . cn-gb-2312)
4246         (".*" . utf-8)))
4247 @end lisp
4248
4249 Note that this variable is ignored if the match is made with
4250 @code{gnus-group-name-charset-method-alist}.
4251 @end table
4252
4253 Those two variables are used also to determine the charset for encoding
4254 and decoding non-@acronym{ASCII} group names that are in the back ends
4255 other than @code{nntp}.  It means that it is you who determine it.  If
4256 you do nothing, the charset used for group names in those back ends will
4257 all be @code{utf-8} because of the last element of
4258 @code{gnus-group-name-charset-group-alist}.
4259
4260 There is one more important variable for non-@acronym{ASCII} group
4261 names:
4262
4263 @table @code
4264 @item nnmail-pathname-coding-system
4265 @vindex nnmail-pathname-coding-system
4266 The value of this variable should be a coding system or @code{nil}.  The
4267 default is @code{nil} in Emacs, or is the aliasee of the coding system
4268 named @code{file-name} (a certain coding system of which an alias is
4269 @code{file-name}) in XEmacs.
4270
4271 The @code{nnml} back end, the @code{nnrss} back end, the @acronym{NNTP}
4272 marks feature (@pxref{NNTP marks}), the agent, and the cache use
4273 non-@acronym{ASCII} group names in those files and directories.  This
4274 variable overrides the value of @code{file-name-coding-system} which
4275 specifies the coding system used when encoding and decoding those file
4276 names and directory names.
4277
4278 In XEmacs (with the @code{mule} feature), @code{file-name-coding-system}
4279 is the only means to specify the coding system used to encode and decode
4280 file names.  On the other hand, Emacs uses the value of
4281 @code{default-file-name-coding-system} if @code{file-name-coding-system}
4282 is @code{nil} or it is bound to the value of
4283 @code{nnmail-pathname-coding-system} which is @code{nil}.
4284
4285 Normally the value of @code{default-file-name-coding-system} in Emacs or
4286 @code{nnmail-pathname-coding-system} in XEmacs is initialized according
4287 to the locale, so you will need to do nothing if the value is suitable
4288 to encode and decode non-@acronym{ASCII} group names.
4289
4290 The value of this variable (or @code{default-file-name-coding-system})
4291 does not necessarily need to be the same value that is determined by
4292 @code{gnus-group-name-charset-method-alist} and
4293 @code{gnus-group-name-charset-group-alist}.
4294
4295 If @code{default-file-name-coding-system} or this variable is
4296 initialized by default to @code{iso-latin-1} for example, although you
4297 want to subscribe to the groups spelled in Chinese, that is the most
4298 typical case where you have to customize
4299 @code{nnmail-pathname-coding-system}.  The @code{utf-8} coding system is
4300 a good candidate for it.  Otherwise, you may change the locale in your
4301 system so that @code{default-file-name-coding-system} or this variable
4302 may be initialized to an appropriate value.
4303 @end table
4304
4305 Note that when you copy or move articles from a non-@acronym{ASCII}
4306 group to another group, the charset used to encode and decode group
4307 names should be the same in both groups.  Otherwise the Newsgroups
4308 header will be displayed incorrectly in the article buffer.
4309
4310
4311 @node Searching
4312 @section Searching
4313
4314 @menu
4315 * nnir::                     Searching on IMAP, with swish, namazu, etc.
4316 * nnmairix::                 Searching maildir, MH or mbox with Mairix.
4317 @end menu
4318
4319 @cindex Searching
4320
4321 FIXME: This node is a stub.
4322
4323 FIXME: Add a brief overview of Gnus search capabilities.  A brief
4324 comparison of nnir, nnmairix, contrib/gnus-namazu would be nice
4325 as well.
4326
4327 FIXME: Explain difference to @ref{Searching for Articles}, add reference
4328 and back-reference.
4329
4330 @node nnir
4331 @subsection nnir
4332
4333 FIXME: As a first step, convert the commentary of @file{nnir} to texi.
4334 @cindex nnir
4335
4336 @node nnmairix
4337 @subsection nnmairix
4338
4339 @cindex mairix
4340 @cindex nnmairix
4341 This paragraph describes how to set up mairix and the back end
4342 @code{nnmairix} for indexing and searching your mail from within
4343 Gnus.  Additionally, you can create permanent ``smart'' groups which are
4344 bound to mairix searches and are automatically updated.
4345
4346 @menu
4347 * About mairix::                About the mairix mail search engine
4348 * nnmairix requirements::       What you will need for using nnmairix
4349 * What nnmairix does::          What does nnmairix actually do?
4350 * Setting up mairix::           Set up your mairix installation
4351 * Configuring nnmairix::        Set up the nnmairix back end
4352 * nnmairix keyboard shortcuts:: List of available keyboard shortcuts
4353 * Propagating marks::           How to propagate marks from nnmairix groups
4354 * nnmairix tips and tricks::    Some tips, tricks and examples
4355 * nnmairix caveats::            Some more stuff you might want to know
4356 @end menu
4357
4358 @c FIXME: The markup in this section might need improvement.
4359 @c E.g. adding @samp, @var, @file, @command, etc.
4360 @c Cf. (info "(texinfo)Indicating")
4361
4362 @node About mairix
4363 @subsubsection About mairix
4364
4365 Mairix is a tool for indexing and searching words in locally stored
4366 mail.  It was written by Richard Curnow and is licensed under the
4367 GPL.  Mairix comes with most popular GNU/Linux distributions, but it also
4368 runs under Windows (with cygwin), Mac OS X and Solaris.  The homepage can
4369 be found at
4370 @uref{http://www.rpcurnow.force9.co.uk/mairix/index.html}
4371
4372 Though mairix might not be as flexible as other search tools like
4373 swish++ or namazu, which you can use via the @code{nnir} back end, it
4374 has the prime advantage of being incredibly fast.  On current systems, it
4375 can easily search through headers and message bodies of thousands and
4376 thousands of mails in well under a second.  Building the database
4377 necessary for searching might take a minute or two, but only has to be
4378 done once fully.  Afterwards, the updates are done incrementally and
4379 therefore are really fast, too.  Additionally, mairix is very easy to set
4380 up.
4381
4382 For maximum speed though, mairix should be used with mails stored in
4383 @code{Maildir} or @code{MH} format (this includes the @code{nnml} back
4384 end), although it also works with mbox.  Mairix presents the search
4385 results by populating a @emph{virtual} maildir/MH folder with symlinks
4386 which point to the ``real'' message files (if mbox is used, copies are
4387 made).  Since mairix already presents search results in such a virtual
4388 mail folder, it is very well suited for using it as an external program
4389 for creating @emph{smart} mail folders, which represent certain mail
4390 searches.
4391
4392 @node nnmairix requirements
4393 @subsubsection nnmairix requirements
4394
4395 Mairix searches local mail---that means, mairix absolutely must have
4396 direct access to your mail folders.  If your mail resides on another
4397 server (e.g. an @acronym{IMAP} server) and you happen to have shell
4398 access, @code{nnmairix} supports running mairix remotely, e.g. via ssh.
4399
4400 Additionally, @code{nnmairix} only supports the following Gnus back
4401 ends: @code{nnml}, @code{nnmaildir}, and @code{nnimap}.  You must use
4402 one of these back ends for using @code{nnmairix}.  Other back ends, like
4403 @code{nnmbox}, @code{nnfolder} or @code{nnmh}, won't work.
4404
4405 If you absolutely must use mbox and still want to use @code{nnmairix},
4406 you can set up a local @acronym{IMAP} server, which you then access via
4407 @code{nnimap}.  This is a rather massive setup for accessing some mbox
4408 files, so just change to MH or Maildir already...  However, if you're
4409 really, really passionate about using mbox, you might want to look into
4410 the package @file{mairix.el}, which comes with Emacs 23.
4411
4412 @node What nnmairix does
4413 @subsubsection What nnmairix does
4414
4415 The back end @code{nnmairix} enables you to call mairix from within Gnus,
4416 either to query mairix with a search term or to update the
4417 database.  While visiting a message in the summary buffer, you can use
4418 several pre-defined shortcuts for calling mairix, e.g. to quickly
4419 search for all mails from the sender of the current message or to
4420 display the whole thread associated with the message, even if the
4421 mails are in different folders.
4422
4423 Additionally, you can create permanent @code{nnmairix} groups which are bound
4424 to certain mairix searches.  This way, you can easily create a group
4425 containing mails from a certain sender, with a certain subject line or
4426 even for one specific thread based on the Message-ID.  If you check for
4427 new mail in these folders (e.g. by pressing @kbd{g} or @kbd{M-g}), they
4428 automatically update themselves by calling mairix.
4429
4430 You might ask why you need @code{nnmairix} at all, since mairix already
4431 creates the group, populates it with links to the mails so that you can
4432 then access it with Gnus, right?  Well, this @emph{might} work, but often
4433 does not---at least not without problems.  Most probably you will get
4434 strange article counts, and sometimes you might see mails which Gnus
4435 claims have already been canceled and are inaccessible.  This is due to
4436 the fact that Gnus isn't really amused when things are happening behind
4437 its back.  Another problem can be the mail back end itself, e.g. if you
4438 use mairix with an @acronym{IMAP} server (I had Dovecot complaining
4439 about corrupt index files when mairix changed the contents of the search
4440 group).  Using @code{nnmairix} should circumvent these problems.
4441
4442 @code{nnmairix} is not really a mail back end---it's actually more like
4443 a wrapper, sitting between a ``real'' mail back end where mairix stores
4444 the searches and the Gnus front end.  You can choose between three
4445 different mail back ends for the mairix folders: @code{nnml},
4446 @code{nnmaildir} or @code{nnimap}.  @code{nnmairix} will call the mairix
4447 binary so that the search results are stored in folders named
4448 @code{zz_mairix-<NAME>-<NUMBER>} on this mail back end, but it will
4449 present these folders in the Gnus front end only with @code{<NAME>}.
4450 You can use an existing mail back end where you already store your mail,
4451 but if you're uncomfortable with @code{nnmairix} creating new mail
4452 groups alongside your other mail, you can also create e.g. a new
4453 @code{nnmaildir} or @code{nnml} server exclusively for mairix, but then
4454 make sure those servers do not accidentally receive your new mail
4455 (@pxref{nnmairix caveats}).  A special case exists if you want to use
4456 mairix remotely on an IMAP server with @code{nnimap}---here the mairix
4457 folders and your other mail must be on the same @code{nnimap} back end.
4458
4459 @node Setting up mairix
4460 @subsubsection Setting up mairix
4461
4462 First: create a backup of your mail folders (@pxref{nnmairix caveats}).
4463
4464 Setting up mairix is easy: simply create a @file{.mairixrc} file with
4465 (at least) the following entries:
4466
4467 @example
4468 # Your Maildir/MH base folder
4469 base=~/Maildir
4470 @end example
4471
4472 This is the base folder for your mails.  All the following directories
4473 are relative to this base folder.  If you want to use @code{nnmairix}
4474 with @code{nnimap}, this base directory has to point to the mail
4475 directory where the @acronym{IMAP} server stores the mail folders!
4476
4477 @example
4478 maildir= ... your maildir folders which should be indexed ...
4479 mh= ... your nnml/mh folders which should be indexed ...
4480 mbox = ... your mbox files which should be indexed ...
4481 @end example
4482
4483 This specifies all your mail folders and mbox files (relative to the
4484 base directory!) you want to index with mairix.  Note that the
4485 @code{nnml} back end saves mails in MH format, so you have to put those
4486 directories in the @code{mh} line.  See the example at the end of this
4487 section and mairixrc's man-page for further details.
4488
4489 @example
4490 omit=zz_mairix-*
4491 @end example
4492
4493 @vindex nnmairix-group-prefix
4494 This should make sure that you don't accidentally index the mairix
4495 search results.  You can change the prefix of these folders with the
4496 variable @code{nnmairix-group-prefix}.
4497
4498 @example
4499 mformat= ... 'maildir' or 'mh' ...
4500 database= ... location of database file ...
4501 @end example
4502
4503 The @code{format} setting specifies the output format for the mairix
4504 search folder.  Set this to @code{mh} if you want to access search results
4505 with @code{nnml}.  Otherwise choose @code{maildir}.
4506
4507 To summarize, here is my shortened @file{.mairixrc} file as an example:
4508
4509 @example
4510 base=~/Maildir
4511 maildir=.personal:.work:.logcheck:.sent
4512 mh=../Mail/nnml/*...
4513 mbox=../mboxmail/mailarchive_year*
4514 mformat=maildir
4515 omit=zz_mairix-*
4516 database=~/.mairixdatabase
4517 @end example
4518
4519 In this case, the base directory is @file{~/Maildir}, where all my Maildir
4520 folders are stored.  As you can see, the folders are separated by
4521 colons.  If you wonder why every folder begins with a dot: this is
4522 because I use Dovecot as @acronym{IMAP} server, which again uses
4523 @code{Maildir++} folders.  For testing nnmairix, I also have some
4524 @code{nnml} mail, which is saved in @file{~/Mail/nnml}.  Since this has
4525 to be specified relative to the @code{base} directory, the @code{../Mail}
4526 notation is needed.  Note that the line ends in @code{*...}, which means
4527 to recursively scan all files under this directory.  Without the three
4528 dots, the wildcard @code{*} will not work recursively.  I also have some
4529 old mbox files with archived mail lying around in @file{~/mboxmail}.
4530 The other lines should be obvious.
4531
4532 See the man page for @code{mairixrc} for details and further options,
4533 especially regarding wildcard usage, which may be a little different
4534 than you are used to.
4535
4536 Now simply call @code{mairix} to create the index for the first time.
4537 Note that this may take a few minutes, but every following index will do
4538 the updates incrementally and hence is very fast.
4539
4540 @node Configuring nnmairix
4541 @subsubsection Configuring nnmairix
4542
4543 In group mode, type @kbd{G b c}
4544 (@code{nnmairix-create-server-and-default-group}).  This will ask you for all
4545 necessary information and create a @code{nnmairix} server as a foreign
4546 server.  You will have to specify the following:
4547
4548 @itemize @bullet
4549
4550 @item
4551 The @strong{name} of the @code{nnmairix} server---choose whatever you
4552 want.
4553
4554 @item
4555 The name of the @strong{back end server} where mairix should store its
4556 searches.  This must be a full server name, like @code{nnml:mymail}.
4557 Just hit @kbd{TAB} to see the available servers.  Currently, servers
4558 which are accessed through @code{nnmaildir}, @code{nnimap} and
4559 @code{nnml} are supported.  As explained above, for locally stored
4560 mails, this can be an existing server where you store your mails.
4561 However, you can also create e.g. a new @code{nnmaildir} or @code{nnml}
4562 server exclusively for @code{nnmairix} in your secondary select methods
4563 (@pxref{Finding the News}).  If you use a secondary @code{nnml} server
4564 just for mairix, make sure that you explicitly set the server variable
4565 @code{nnml-get-new-mail} to @code{nil}, or you might loose mail
4566 (@pxref{nnmairix caveats}).  If you want to use mairix remotely on an
4567 @acronym{IMAP} server, you have to choose the corresponding
4568 @code{nnimap} server here.
4569
4570 @item
4571 @vindex nnmairix-mairix-search-options
4572 The @strong{command} to call the mairix binary.  This will usually just
4573 be @code{mairix}, but you can also choose something like @code{ssh
4574 SERVER mairix} if you want to call mairix remotely, e.g. on your
4575 @acronym{IMAP} server.  If you want to add some default options to
4576 mairix, you could do this here, but better use the variable
4577 @code{nnmairix-mairix-search-options} instead.
4578
4579 @item
4580 The name of the @strong{default search group}.  This will be the group
4581 where all temporary mairix searches are stored, i.e. all searches which
4582 are not bound to permanent @code{nnmairix} groups.  Choose whatever you
4583 like.
4584
4585 @item
4586 If the mail back end is @code{nnimap} or @code{nnmaildir}, you will be
4587 asked if you work with @strong{Maildir++}, i.e. with hidden maildir
4588 folders (=beginning with a dot).  For example, you have to answer
4589 @samp{yes} here if you work with the Dovecot @acronym{IMAP}
4590 server.  Otherwise, you should answer @samp{no} here.
4591
4592 @end itemize
4593
4594 @node nnmairix keyboard shortcuts
4595 @subsubsection nnmairix keyboard shortcuts
4596
4597 In group mode:
4598
4599 @table @kbd
4600
4601 @item G b c
4602 @kindex G b c (Group)
4603 @findex nnmairix-create-server-and-default-group
4604 Creates @code{nnmairix} server and default search group for this server
4605 (@code{nnmairix-create-server-and-default-group}).  You should have done
4606 this by now (@pxref{Configuring nnmairix}).
4607
4608 @item G b s
4609 @kindex G b s (Group)
4610 @findex nnmairix-search
4611 Prompts for query which is then sent to the mairix binary.  Search
4612 results are put into the default search group which is automatically
4613 displayed (@code{nnmairix-search}).
4614
4615 @item G b m
4616 @kindex G b m (Group)
4617 @findex nnmairix-widget-search
4618 Allows you to create a mairix search or a permanent group more
4619 comfortably using graphical widgets, similar to a customization
4620 group.  Just try it to see how it works (@code{nnmairix-widget-search}).
4621
4622 @item G b i
4623 @kindex G b i (Group)
4624 @findex nnmairix-search-interactive
4625 Another command for creating a mairix query more comfortably, but uses
4626 only the minibuffer (@code{nnmairix-search-interactive}).
4627
4628 @item G b g
4629 @kindex G b g (Group)
4630 @findex nnmairix-create-search-group
4631 Creates a permanent group which is associated with a search query
4632 (@code{nnmairix-create-search-group}).  The @code{nnmairix} back end
4633 automatically calls mairix when you update this group with @kbd{g} or
4634 @kbd{M-g}.
4635
4636 @item G b q
4637 @kindex G b q (Group)
4638 @findex nnmairix-group-change-query-this-group
4639 Changes the search query for the @code{nnmairix} group under cursor
4640 (@code{nnmairix-group-change-query-this-group}).
4641
4642 @item G b t
4643 @kindex G b t (Group)
4644 @findex nnmairix-group-toggle-threads-this-group
4645 Toggles the 'threads' parameter for the @code{nnmairix} group under cursor,
4646 i.e.  if you want see the whole threads of the found messages
4647 (@code{nnmairix-group-toggle-threads-this-group}).
4648
4649 @item G b u
4650 @kindex G b u (Group)
4651 @findex nnmairix-update-database
4652 @vindex nnmairix-mairix-update-options
4653 Calls mairix binary for updating the database
4654 (@code{nnmairix-update-database}).  The default parameters are @code{-F}
4655 and @code{-Q} for making this as fast as possible (see variable
4656 @code{nnmairix-mairix-update-options} for defining these default
4657 options).
4658
4659 @item G b r
4660 @kindex G b r (Group)
4661 @findex nnmairix-group-toggle-readmarks-this-group
4662 Keep articles in this @code{nnmairix} group always read or unread, or leave the
4663 marks unchanged (@code{nnmairix-group-toggle-readmarks-this-group}).
4664
4665 @item G b d
4666 @kindex G b d (Group)
4667 @findex nnmairix-group-delete-recreate-this-group
4668 Recreate @code{nnmairix} group on the ``real'' mail back end
4669 (@code{nnmairix-group-delete-recreate-this-group}).  You can do this if
4670 you always get wrong article counts with a @code{nnmairix} group.
4671
4672 @item G b a
4673 @kindex G b a (Group)
4674 @findex nnmairix-group-toggle-allowfast-this-group
4675 Toggles the @code{allow-fast} parameters for group under cursor
4676 (@code{nnmairix-group-toggle-allowfast-this-group}).  The default
4677 behavior of @code{nnmairix} is to do a mairix search every time you
4678 update or enter the group.  With the @code{allow-fast} parameter set,
4679 mairix will only be called when you explicitly update the group, but not
4680 upon entering.  This makes entering the group faster, but it may also
4681 lead to dangling symlinks if something changed between updating and
4682 entering the group which is not yet in the mairix database.
4683
4684 @item G b p
4685 @kindex G b p (Group)
4686 @findex nnmairix-group-toggle-propmarks-this-group
4687 Toggle marks propagation for this group
4688 (@code{nnmairix-group-toggle-propmarks-this-group}).  (@pxref{Propagating
4689 marks}).
4690
4691 @item G b o
4692 @kindex G b o (Group)
4693 @findex nnmairix-propagate-marks
4694 Manually propagate marks (@code{nnmairix-propagate-marks}); needed only when
4695 @code{nnmairix-propagate-marks-upon-close} is set to @code{nil}.
4696
4697 @end table
4698
4699 In summary mode:
4700
4701 @table @kbd
4702
4703 @item $ m
4704 @kindex $ m (Summary)
4705 @findex nnmairix-widget-search-from-this-article
4706 Allows you to create a mairix query or group based on the current
4707 message using graphical widgets (same as @code{nnmairix-widget-search})
4708 (@code{nnmairix-widget-search-from-this-article}).
4709
4710 @item $ g
4711 @kindex $ g (Summary)
4712 @findex nnmairix-create-search-group-from-message
4713 Interactively creates a new search group with query based on the current
4714 message, but uses the minibuffer instead of graphical widgets
4715 (@code{nnmairix-create-search-group-from-message}).
4716
4717 @item $ t
4718 @kindex $ t (Summary)
4719 @findex nnmairix-search-thread-this-article
4720 Searches thread for the current article
4721 (@code{nnmairix-search-thread-this-article}).  This is effectively a
4722 shortcut for calling @code{nnmairix-search} with @samp{m:msgid} of the
4723 current article and enabled threads.
4724
4725 @item $ f
4726 @kindex $ f (Summary)
4727 @findex nnmairix-search-from-this-article
4728 Searches all messages from sender of the current article
4729 (@code{nnmairix-search-from-this-article}).  This is a shortcut for
4730 calling @code{nnmairix-search} with @samp{f:From}.
4731
4732 @item $ o
4733 @kindex $ o (Summary)
4734 @findex nnmairix-goto-original-article
4735 (Only in @code{nnmairix} groups!) Tries determine the group this article
4736 originally came from and displays the article in this group, so that
4737 e.g. replying to this article the correct posting styles/group
4738 parameters are applied (@code{nnmairix-goto-original-article}).  This
4739 function will use the registry if available, but can also parse the
4740 article file name as a fallback method.
4741
4742 @item $ u
4743 @kindex $ u (Summary)
4744 @findex nnmairix-remove-tick-mark-original-article
4745 Remove possibly existing tick mark from original article
4746 (@code{nnmairix-remove-tick-mark-original-article}).  (@pxref{nnmairix
4747 tips and tricks}).
4748
4749 @end table
4750
4751 @node Propagating marks
4752 @subsubsection Propagating marks
4753
4754 First of: you really need a patched mairix binary for using the marks
4755 propagation feature efficiently. Otherwise, you would have to update
4756 the mairix database all the time. You can get the patch at
4757
4758 @uref{http://www.randomsample.de/mairix-maildir-patch.tar}
4759
4760 You need the mairix v0.21 source code for this patch; everything else
4761 is explained in the accompanied readme file. If you don't want to use
4762 marks propagation, you don't have to apply these patches, but they also
4763 fix some annoyances regarding changing maildir flags, so it might still
4764 be useful to you.
4765
4766 With the patched mairix binary, you can use @code{nnmairix} as an
4767 alternative to mail splitting (@pxref{Fancy Mail Splitting}). For
4768 example, instead of splitting all mails from @samp{david@@foobar.com}
4769 into a group, you can simply create a search group with the query
4770 @samp{f:david@@foobar.com}. This is actually what ``smart folders'' are
4771 all about: simply put everything in one mail folder and dynamically
4772 create searches instead of splitting. This is more flexible, since you
4773 can dynamically change your folders any time you want to. This also
4774 implies that you will usually read your mails in the @code{nnmairix}
4775 groups instead of your ``real'' mail groups.
4776
4777 There is one problem, though: say you got a new mail from
4778 @samp{david@@foobar.com}; it will now show up in two groups, the
4779 ``real'' group (your INBOX, for example) and in the @code{nnmairix}
4780 search group (provided you have updated the mairix database). Now you
4781 enter the @code{nnmairix} group and read the mail. The mail will be
4782 marked as read, but only in the @code{nnmairix} group---in the ``real''
4783 mail group it will be still shown as unread.
4784
4785 You could now catch up the mail group (@pxref{Group Data}), but this is
4786 tedious and error prone, since you may overlook mails you don't have
4787 created @code{nnmairix} groups for. Of course, you could first use
4788 @code{nnmairix-goto-original-article} (@pxref{nnmairix keyboard
4789 shortcuts}) and then read the mail in the original group, but that's
4790 even more cumbersome.
4791
4792 Clearly, the easiest way would be if marks could somehow be
4793 automatically set for the original article. This is exactly what
4794 @emph{marks propagation} is about.
4795
4796 Marks propagation is deactivated by default. You can activate it for a
4797 certain @code{nnmairix} group with
4798 @code{nnmairix-group-toggle-propmarks-this-group} (bound to @kbd{G b
4799 p}). This function will warn you if you try to use it with your default
4800 search group; the reason is that the default search group is used for
4801 temporary searches, and it's easy to accidentally propagate marks from
4802 this group. However, you can ignore this warning if you really want to.
4803
4804 With marks propagation enabled, all the marks you set in a @code{nnmairix}
4805 group should now be propagated to the original article. For example,
4806 you can now tick an article (by default with @kbd{!}) and this mark should
4807 magically be set for the original article, too.
4808
4809 A few more remarks which you may or may not want to know:
4810
4811 @vindex nnmairix-propagate-marks-upon-close
4812 Marks will not be set immediately, but only upon closing a group. This
4813 not only makes marks propagation faster, it also avoids problems with
4814 dangling symlinks when dealing with maildir files (since changing flags
4815 will change the file name). You can also control when to propagate marks
4816 via @code{nnmairix-propagate-marks-upon-close} (see the doc-string for
4817 details).
4818
4819 Obviously, @code{nnmairix} will have to look up the original group for every
4820 article you want to set marks for. If available, @code{nnmairix} will first use
4821 the registry for determining the original group. The registry is very
4822 fast, hence you should really, really enable the registry when using
4823 marks propagation. If you don't have to worry about RAM and disc space,
4824 set @code{gnus-registry-max-entries} to a large enough value; to be on
4825 the safe side, choose roughly the amount of mails you index with mairix.
4826
4827 @vindex nnmairix-only-use-registry
4828 If you don't want to use the registry or the registry hasn't seen the
4829 original article yet, @code{nnmairix} will use an additional mairix
4830 search for determining the file name of the article. This, of course, is
4831 way slower than the registry---if you set hundreds or even thousands of
4832 marks this way, it might take some time. You can avoid this situation by
4833 setting @code{nnmairix-only-use-registry} to t.
4834
4835 Maybe you also want to propagate marks the other way round, i.e. if you
4836 tick an article in a "real" mail group, you'd like to have the same
4837 article in a @code{nnmairix} group ticked, too. For several good
4838 reasons, this can only be done efficiently if you use maildir. To
4839 immediately contradict myself, let me mention that it WON'T work with
4840 @code{nnmaildir}, since @code{nnmaildir} stores the marks externally and
4841 not in the file name. Therefore, propagating marks to @code{nnmairix}
4842 groups will usually only work if you use an IMAP server which uses
4843 maildir as its file format.
4844
4845 @vindex nnmairix-propagate-marks-to-nnmairix-groups
4846 If you work with this setup, just set
4847 @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t} and see what
4848 happens. If you don't like what you see, just set it to @code{nil} again. One
4849 problem might be that you get a wrong number of unread articles; this
4850 usually happens when you delete or expire articles in the original
4851 groups. When this happens, you can recreate the @code{nnmairix} group on the
4852 back end using @kbd{G b d}.
4853
4854 @node nnmairix tips and tricks
4855 @subsubsection nnmairix tips and tricks
4856
4857 @itemize
4858 @item
4859 Checking Mail
4860
4861 @findex nnmairix-update-groups
4862 I put all my important mail groups at group level 1. The mairix groups
4863 have group level 5, so they do not get checked at start up (@pxref{Group
4864 Levels}).
4865
4866 I use the following to check for mails:
4867
4868 @lisp
4869 (defun my-check-mail-mairix-update (level)
4870   (interactive "P")
4871   ;; if no prefix given, set level=1
4872   (gnus-group-get-new-news (or level 1))
4873   (nnmairix-update-groups "mairixsearch" t t)
4874   (gnus-group-list-groups))
4875
4876 (define-key gnus-group-mode-map "g" 'my-check-mail-mairix-update)
4877 @end lisp
4878
4879 Instead of @samp{"mairixsearch"} use the name of your @code{nnmairix}
4880 server. See the doc string for @code{nnmairix-update-groups} for
4881 details.
4882
4883 @item
4884 Example: search group for ticked articles
4885
4886 For example, you can create a group for all ticked articles, where the
4887 articles always stay unread:
4888
4889 Hit @kbd{G b g}, enter group name (e.g. @samp{important}), use
4890 @samp{F:f} as query and do not include threads.
4891
4892 Now activate marks propagation for this group by using @kbd{G b p}. Then
4893 activate the always-unread feature by using @kbd{G b r} twice.
4894
4895 So far so good---but how do you remove the tick marks in the @code{nnmairix}
4896 group?  There are two options: You may simply use
4897 @code{nnmairix-remove-tick-mark-original-article} (bound to @kbd{$ u}) to remove
4898 tick marks from the original article. The other possibility is to set
4899 @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t}, but see the above
4900 comments about this option.  If it works for you, the tick marks should
4901 also exist in the @code{nnmairix} group and you can remove them as usual,
4902 e.g. by marking an article as read.
4903
4904 When you have removed a tick mark from the original article, this
4905 article should vanish from the @code{nnmairix} group after you have updated the
4906 mairix database and updated the group.  Fortunately, there is a function
4907 for doing exactly that: @code{nnmairix-update-groups}. See the previous code
4908 snippet and the doc string for details.
4909
4910 @item
4911 Dealing with auto-subscription of mail groups
4912
4913 As described before, all @code{nnmairix} groups are in fact stored on
4914 the mail back end in the form @samp{zz_mairix-<NAME>-<NUMBER>}. You can
4915 see them when you enter the back end server in the server buffer. You
4916 should not subscribe these groups! Unfortunately, these groups will
4917 usually get @emph{auto-subscribed} when you use @code{nnmaildir} or
4918 @code{nnml}, i.e. you will suddenly see groups of the form
4919 @samp{zz_mairix*} pop up in your group buffer. If this happens to you,
4920 simply kill these groups with C-k.  For avoiding this, turn off
4921 auto-subscription completely by setting the variable
4922 @code{gnus-auto-subscribed-groups} to @code{nil} (@pxref{Filtering New
4923 Groups}), or if you like to keep this feature use the following kludge
4924 for turning it off for all groups beginning with @samp{zz_}:
4925
4926 @lisp
4927 (setq gnus-auto-subscribed-groups
4928       "^\\(nnml\\|nnfolder\\|nnmbox\\|nnmh\\|nnbabyl\\|nnmaildir\\).*:\\([^z]\\|z$\\|\\z[^z]\\|zz$\\|zz[^_]\\|zz_$\\).*")
4929 @end lisp
4930
4931 @end itemize
4932
4933 @node nnmairix caveats
4934 @subsubsection nnmairix caveats
4935
4936 @itemize
4937 @item
4938 You can create a secondary @code{nnml} server just for nnmairix, but then
4939 you have to explicitly set the corresponding server variable
4940 @code{nnml-get-new-mail} to @code{nil}.  Otherwise, new mail might get
4941 put into this secondary server (and would never show up again).  Here's
4942 an example server definition:
4943
4944 @lisp
4945 (nnml "mairix" (nnml-directory "mairix") (nnml-get-new-mail nil))
4946 @end lisp
4947
4948 (The @code{nnmaildir} back end also has a server variabe
4949 @code{get-new-mail}, but its default value is @code{nil}, so you don't
4950 have to explicitly set it if you use a @code{nnmaildir} server just for
4951 mairix.)
4952
4953 @item
4954 If you use the Gnus registry: don't use the registry with
4955 @code{nnmairix} groups (put them in
4956 @code{gnus-registry-unfollowed-groups}).  Be @emph{extra careful} if
4957 you use @code{gnus-registry-split-fancy-with-parent}; mails which are
4958 split into @code{nnmairix} groups are usually gone for good as soon as
4959 you check the group for new mail (yes, it has happened to me...).
4960
4961 @item
4962 Therefore: @emph{Never ever} put ``real'' mails into @code{nnmairix}
4963 groups (you shouldn't be able to, anyway).
4964
4965 @item
4966 If you use the Gnus agent (@pxref{Gnus Unplugged}): don't agentize
4967 @code{nnmairix} groups (though I have no idea what happens if you do).
4968
4969 @item
4970 mairix does only support us-ascii characters.
4971
4972 @item
4973 @code{nnmairix} uses a rather brute force method to force Gnus to
4974 completely reread the group on the mail back end after mairix was
4975 called---it simply deletes and re-creates the group on the mail
4976 back end. So far, this has worked for me without any problems, and I
4977 don't see how @code{nnmairix} could delete other mail groups than its
4978 own, but anyway: you really should have a backup of your mail
4979 folders.
4980
4981 @item
4982 All necessary information is stored in the group parameters
4983 (@pxref{Group Parameters}). This has the advantage that no active file
4984 is needed, but also implies that when you kill a @code{nnmairix} group,
4985 it is gone for good.
4986
4987 @item
4988 @findex nnmairix-purge-old-groups
4989 If you create and kill a lot of @code{nnmairix} groups, the
4990 ``zz_mairix-*'' groups will accumulate on the mail back end server. To
4991 delete old groups which are no longer needed, call
4992 @code{nnmairix-purge-old-groups}. Note that this assumes that you don't
4993 save any ``real'' mail in folders of the form
4994 @code{zz_mairix-<NAME>-<NUMBER>}. You can change the prefix of
4995 @code{nnmairix} groups by changing the variable
4996 @code{nnmairix-group-prefix}.
4997
4998 @item
4999 The following only applies if you @emph{don't} use the mentioned patch
5000 for mairix (@pxref{Propagating marks}):
5001
5002 A problem can occur when using @code{nnmairix} with maildir folders and
5003 comes with the fact that maildir stores mail flags like @samp{Seen} or
5004 @samp{Replied} by appending chars @samp{S} and @samp{R} to the message
5005 file name, respectively. This implies that currently you would have to
5006 update the mairix database not only when new mail arrives, but also when
5007 mail flags are changing. The same applies to new mails which are indexed
5008 while they are still in the @samp{new} folder but then get moved to
5009 @samp{cur} when Gnus has seen the mail. If you don't update the database
5010 after this has happened, a mairix query can lead to symlinks pointing to
5011 non-existing files. In Gnus, these messages will usually appear with
5012 ``(none)'' entries in the header and can't be accessed. If this happens
5013 to you, using @kbd{G b u} and updating the group will usually fix this.
5014
5015 @end itemize
5016
5017 @node Misc Group Stuff
5018 @section Misc Group Stuff
5019
5020 @menu
5021 * Scanning New Messages::       Asking Gnus to see whether new messages have arrived.
5022 * Group Information::           Information and help on groups and Gnus.
5023 * Group Timestamp::             Making Gnus keep track of when you last read a group.
5024 * File Commands::               Reading and writing the Gnus files.
5025 * Sieve Commands::              Managing Sieve scripts.
5026 @end menu
5027
5028 @table @kbd
5029
5030 @item v
5031 @kindex v (Group)
5032 @cindex keys, reserved for users (Group)
5033 The key @kbd{v} is reserved for users.  You can bind it to some
5034 command or better use it as a prefix key.  For example:
5035
5036 @lisp
5037 (define-key gnus-group-mode-map (kbd "v j d")
5038   (lambda ()
5039     (interactive)
5040     (gnus-group-jump-to-group "nndraft:drafts")))
5041 @end lisp
5042
5043 On keys reserved for users in Emacs and on keybindings in general
5044 @xref{Keymaps, Keymaps, , emacs, The Emacs Editor}.
5045
5046 @item ^
5047 @kindex ^ (Group)
5048 @findex gnus-group-enter-server-mode
5049 Enter the server buffer (@code{gnus-group-enter-server-mode}).
5050 @xref{Server Buffer}.
5051
5052 @item a
5053 @kindex a (Group)
5054 @findex gnus-group-post-news
5055 Start composing a message (a news by default)
5056 (@code{gnus-group-post-news}).  If given a prefix, post to the group
5057 under the point.  If the prefix is 1, prompt for a group to post to.
5058 Contrary to what the name of this function suggests, the prepared
5059 article might be a mail instead of a news, if a mail group is specified
5060 with the prefix argument.  @xref{Composing Messages}.
5061
5062 @item m
5063 @kindex m (Group)
5064 @findex gnus-group-mail
5065 Mail a message somewhere (@code{gnus-group-mail}).  If given a prefix,
5066 use the posting style of the group under the point.  If the prefix is 1,
5067 prompt for a group name to find the posting style.
5068 @xref{Composing Messages}.
5069
5070 @item i
5071 @kindex i (Group)
5072 @findex gnus-group-news
5073 Start composing a news (@code{gnus-group-news}).  If given a prefix,
5074 post to the group under the point.  If the prefix is 1, prompt
5075 for group to post to.  @xref{Composing Messages}.
5076
5077 This function actually prepares a news even when using mail groups.
5078 This is useful for ``posting'' messages to mail groups without actually
5079 sending them over the network: they're just saved directly to the group
5080 in question.  The corresponding back end must have a request-post method
5081 for this to work though.
5082
5083 @item G z
5084 @kindex G z (Group)
5085 @findex gnus-group-compact-group
5086
5087 Compact the group under point (@code{gnus-group-compact-group}).
5088 Currently implemented only in nnml (@pxref{Mail Spool}).  This removes
5089 gaps between article numbers, hence getting a correct total article
5090 count.
5091
5092 @end table
5093
5094 Variables for the group buffer:
5095
5096 @table @code
5097
5098 @item gnus-group-mode-hook
5099 @vindex gnus-group-mode-hook
5100 is called after the group buffer has been
5101 created.
5102
5103 @item gnus-group-prepare-hook
5104 @vindex gnus-group-prepare-hook
5105 is called after the group buffer is
5106 generated.  It may be used to modify the buffer in some strange,
5107 unnatural way.
5108
5109 @item gnus-group-prepared-hook
5110 @vindex gnus-group-prepare-hook
5111 is called as the very last thing after the group buffer has been
5112 generated.  It may be used to move point around, for instance.
5113
5114 @item gnus-permanently-visible-groups
5115 @vindex gnus-permanently-visible-groups
5116 Groups matching this regexp will always be listed in the group buffer,
5117 whether they are empty or not.
5118
5119 @end table
5120
5121 @node Scanning New Messages
5122 @subsection Scanning New Messages
5123 @cindex new messages
5124 @cindex scanning new news
5125
5126 @table @kbd
5127
5128 @item g
5129 @kindex g (Group)
5130 @findex gnus-group-get-new-news
5131 @c @icon{gnus-group-get-new-news}
5132 Check the server(s) for new articles.  If the numerical prefix is used,
5133 this command will check only groups of level @var{arg} and lower
5134 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
5135 command will force a total re-reading of the active file(s) from the
5136 back end(s).
5137
5138 @item M-g
5139 @kindex M-g (Group)
5140 @findex gnus-group-get-new-news-this-group
5141 @vindex gnus-goto-next-group-when-activating
5142 @c @icon{gnus-group-get-new-news-this-group}
5143 Check whether new articles have arrived in the current group
5144 (@code{gnus-group-get-new-news-this-group}).
5145 @code{gnus-goto-next-group-when-activating} says whether this command is
5146 to move point to the next group or not.  It is @code{t} by default.
5147
5148 @findex gnus-activate-all-groups
5149 @cindex activating groups
5150 @item C-c M-g
5151 @kindex C-c M-g (Group)
5152 Activate absolutely all groups (@code{gnus-activate-all-groups}).
5153
5154 @item R
5155 @kindex R (Group)
5156 @cindex restarting
5157 @findex gnus-group-restart
5158 Restart Gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
5159 file(s), closes the connection to all servers, clears up all run-time
5160 Gnus variables, and then starts Gnus all over again.
5161
5162 @end table
5163
5164 @vindex gnus-get-new-news-hook
5165 @code{gnus-get-new-news-hook} is run just before checking for new news.
5166
5167 @vindex gnus-after-getting-new-news-hook
5168 @code{gnus-after-getting-new-news-hook} is run after checking for new
5169 news.
5170
5171
5172 @node Group Information
5173 @subsection Group Information
5174 @cindex group information
5175 @cindex information on groups
5176
5177 @table @kbd
5178
5179
5180 @item H f
5181 @kindex H f (Group)
5182 @findex gnus-group-fetch-faq
5183 @vindex gnus-group-faq-directory
5184 @cindex FAQ
5185 @cindex ange-ftp
5186 Try to fetch the @acronym{FAQ} for the current group
5187 (@code{gnus-group-fetch-faq}).  Gnus will try to get the @acronym{FAQ}
5188 from @code{gnus-group-faq-directory}, which is usually a directory on
5189 a remote machine.  This variable can also be a list of directories.
5190 In that case, giving a prefix to this command will allow you to choose
5191 between the various sites.  @code{ange-ftp} (or @code{efs}) will be
5192 used for fetching the file.
5193
5194 If fetching from the first site is unsuccessful, Gnus will attempt to go
5195 through @code{gnus-group-faq-directory} and try to open them one by one.
5196
5197 @item H C
5198 @kindex H C (Group)
5199 @findex gnus-group-fetch-control
5200 @vindex gnus-group-fetch-control-use-browse-url
5201 @cindex control message
5202 Fetch the control messages for the group from the archive at
5203 @code{ftp.isc.org} (@code{gnus-group-fetch-control}).  Query for a
5204 group if given a prefix argument.
5205
5206 If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
5207 Gnus will open the control messages in a browser using
5208 @code{browse-url}.  Otherwise they are fetched using @code{ange-ftp}
5209 and displayed in an ephemeral group.
5210
5211 Note that the control messages are compressed.  To use this command
5212 you need to turn on @code{auto-compression-mode} (@pxref{Compressed
5213 Files, ,Compressed Files, emacs, The Emacs Manual}).
5214
5215 @item H d
5216 @itemx C-c C-d
5217 @c @icon{gnus-group-describe-group}
5218 @kindex H d (Group)
5219 @kindex C-c C-d (Group)
5220 @cindex describing groups
5221 @cindex group description
5222 @findex gnus-group-describe-group
5223 Describe the current group (@code{gnus-group-describe-group}).  If given
5224 a prefix, force Gnus to re-read the description from the server.
5225
5226 @item M-d
5227 @kindex M-d (Group)
5228 @findex gnus-group-describe-all-groups
5229 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
5230 prefix, force Gnus to re-read the description file from the server.
5231
5232 @item H v
5233 @itemx V
5234 @kindex V (Group)
5235 @kindex H v (Group)
5236 @cindex version
5237 @findex gnus-version
5238 Display current Gnus version numbers (@code{gnus-version}).
5239
5240 @item ?
5241 @kindex ? (Group)
5242 @findex gnus-group-describe-briefly
5243 Give a very short help message (@code{gnus-group-describe-briefly}).
5244
5245 @item C-c C-i
5246 @kindex C-c C-i (Group)
5247 @cindex info
5248 @cindex manual
5249 @findex gnus-info-find-node
5250 Go to the Gnus info node (@code{gnus-info-find-node}).
5251 @end table
5252
5253
5254 @node Group Timestamp
5255 @subsection Group Timestamp
5256 @cindex timestamps
5257 @cindex group timestamps
5258
5259 It can be convenient to let Gnus keep track of when you last read a
5260 group.  To set the ball rolling, you should add
5261 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
5262
5263 @lisp
5264 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
5265 @end lisp
5266
5267 After doing this, each time you enter a group, it'll be recorded.
5268
5269 This information can be displayed in various ways---the easiest is to
5270 use the @samp{%d} spec in the group line format:
5271
5272 @lisp
5273 (setq gnus-group-line-format
5274       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
5275 @end lisp
5276
5277 This will result in lines looking like:
5278
5279 @example
5280 *        0: mail.ding                                19961002T012943
5281          0: custom                                   19961002T012713
5282 @end example
5283
5284 As you can see, the date is displayed in compact ISO 8601 format.  This
5285 may be a bit too much, so to just display the date, you could say
5286 something like:
5287
5288 @lisp
5289 (setq gnus-group-line-format
5290       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
5291 @end lisp
5292
5293 If you would like greater control of the time format, you can use a
5294 user-defined format spec.  Something like the following should do the
5295 trick:
5296
5297 @lisp
5298 (setq gnus-group-line-format
5299       "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
5300 (defun gnus-user-format-function-d (headers)
5301   (let ((time (gnus-group-timestamp gnus-tmp-group)))
5302     (if time
5303         (format-time-string "%b %d  %H:%M" time)
5304       "")))
5305 @end lisp
5306
5307
5308 @node File Commands
5309 @subsection File Commands
5310 @cindex file commands
5311
5312 @table @kbd
5313
5314 @item r
5315 @kindex r (Group)
5316 @findex gnus-group-read-init-file
5317 @vindex gnus-init-file
5318 @cindex reading init file
5319 Re-read the init file (@code{gnus-init-file}, which defaults to
5320 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
5321
5322 @item s
5323 @kindex s (Group)
5324 @findex gnus-group-save-newsrc
5325 @cindex saving .newsrc
5326 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
5327 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
5328 file(s) whether Gnus thinks it is necessary or not.
5329
5330 @c @item Z
5331 @c @kindex Z (Group)
5332 @c @findex gnus-group-clear-dribble
5333 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
5334
5335 @end table
5336
5337
5338 @node Sieve Commands
5339 @subsection Sieve Commands
5340 @cindex group sieve commands
5341
5342 Sieve is a server-side mail filtering language.  In Gnus you can use
5343 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
5344 sieve rules that should apply to each group.  Gnus provides two
5345 commands to translate all these group parameters into a proper Sieve
5346 script that can be transfered to the server somehow.
5347
5348 @vindex gnus-sieve-file
5349 @vindex gnus-sieve-region-start
5350 @vindex gnus-sieve-region-end
5351 The generated Sieve script is placed in @code{gnus-sieve-file} (by
5352 default @file{~/.sieve}).  The Sieve code that Gnus generate is placed
5353 between two delimiters, @code{gnus-sieve-region-start} and
5354 @code{gnus-sieve-region-end}, so you may write additional Sieve code
5355 outside these delimiters that will not be removed the next time you
5356 regenerate the Sieve script.
5357
5358 @vindex gnus-sieve-crosspost
5359 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
5360 is generated.  If it is non-@code{nil} (the default) articles is
5361 placed in all groups that have matching rules, otherwise the article
5362 is only placed in the group with the first matching rule.  For
5363 example, the group parameter @samp{(sieve address "sender"
5364 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
5365 code if @code{gnus-sieve-crosspost} is @code{nil}.  (When
5366 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
5367 except that the line containing the call to @code{stop} is removed.)
5368
5369 @example
5370 if address "sender" "owner-ding@@hpc.uh.edu" @{
5371         fileinto "INBOX.ding";
5372         stop;
5373 @}
5374 @end example
5375
5376 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
5377
5378 @table @kbd
5379
5380 @item D g
5381 @kindex D g (Group)
5382 @findex gnus-sieve-generate
5383 @vindex gnus-sieve-file
5384 @cindex generating sieve script
5385 Regenerate a Sieve script from the @code{sieve} group parameters and
5386 put you into the @code{gnus-sieve-file} without saving it.
5387
5388 @item D u
5389 @kindex D u (Group)
5390 @findex gnus-sieve-update
5391 @vindex gnus-sieve-file
5392 @cindex updating sieve script
5393 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
5394 @code{sieve} group parameters, save the file and upload it to the
5395 server using the @code{sieveshell} program.
5396
5397 @end table
5398
5399
5400 @node Summary Buffer
5401 @chapter Summary Buffer
5402 @cindex summary buffer
5403
5404 A line for each article is displayed in the summary buffer.  You can
5405 move around, read articles, post articles and reply to articles.
5406
5407 The most common way to a summary buffer is to select a group from the
5408 group buffer (@pxref{Selecting a Group}).
5409
5410 You can have as many summary buffers open as you wish.
5411
5412 You can customize the Summary Mode tool bar, see @kbd{M-x
5413 customize-apropos RET gnus-summary-tool-bar}.  This feature is only
5414 available in Emacs.
5415
5416 @kindex v (Summary)
5417 @cindex keys, reserved for users (Summary)
5418 The key @kbd{v} is reserved for users.  You can bind it to some
5419 command or better use it as a prefix key.  For example:
5420 @lisp
5421 (define-key gnus-summary-mode-map (kbd "v -") "LrS") ;; lower subthread
5422 @end lisp
5423
5424 @menu
5425 * Summary Buffer Format::       Deciding how the summary buffer is to look.
5426 * Summary Maneuvering::         Moving around the summary buffer.
5427 * Choosing Articles::           Reading articles.
5428 * Paging the Article::          Scrolling the current article.
5429 * Reply Followup and Post::     Posting articles.
5430 * Delayed Articles::            Send articles at a later time.
5431 * Marking Articles::            Marking articles as read, expirable, etc.
5432 * Limiting::                    You can limit the summary buffer.
5433 * Threading::                   How threads are made.
5434 * Sorting the Summary Buffer::  How articles and threads are sorted.
5435 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
5436 * Article Caching::             You may store articles in a cache.
5437 * Persistent Articles::         Making articles expiry-resistant.
5438 * Sticky Articles::             Article buffers that are not reused.
5439 * Article Backlog::             Having already read articles hang around.
5440 * Saving Articles::             Ways of customizing article saving.
5441 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
5442 * Article Treatment::           The article buffer can be mangled at will.
5443 * MIME Commands::               Doing MIMEy things with the articles.
5444 * Charsets::                    Character set issues.
5445 * Article Commands::            Doing various things with the article buffer.
5446 * Summary Sorting::             Sorting the summary buffer in various ways.
5447 * Finding the Parent::          No child support? Get the parent.
5448 * Alternative Approaches::      Reading using non-default summaries.
5449 * Tree Display::                A more visual display of threads.
5450 * Mail Group Commands::         Some commands can only be used in mail groups.
5451 * Various Summary Stuff::       What didn't fit anywhere else.
5452 * Exiting the Summary Buffer::  Returning to the Group buffer,
5453                                 or reselecting the current group.
5454 * Crosspost Handling::          How crossposted articles are dealt with.
5455 * Duplicate Suppression::       An alternative when crosspost handling fails.
5456 * Security::                    Decrypt and Verify.
5457 * Mailing List::                Mailing list minor mode.
5458 @end menu
5459
5460
5461 @node Summary Buffer Format
5462 @section Summary Buffer Format
5463 @cindex summary buffer format
5464
5465 @iftex
5466 @iflatex
5467 \gnusfigure{The Summary Buffer}{180}{
5468 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
5469 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
5470 }
5471 @end iflatex
5472 @end iftex
5473
5474 @menu
5475 * Summary Buffer Lines::        You can specify how summary lines should look.
5476 * To From Newsgroups::          How to not display your own name.
5477 * Summary Buffer Mode Line::    You can say how the mode line should look.
5478 * Summary Highlighting::        Making the summary buffer all pretty and nice.
5479 @end menu
5480
5481 @findex mail-extract-address-components
5482 @findex gnus-extract-address-components
5483 @vindex gnus-extract-address-components
5484 Gnus will use the value of the @code{gnus-extract-address-components}
5485 variable as a function for getting the name and address parts of a
5486 @code{From} header.  Two pre-defined functions exist:
5487 @code{gnus-extract-address-components}, which is the default, quite
5488 fast, and too simplistic solution; and
5489 @code{mail-extract-address-components}, which works very nicely, but is
5490 slower.  The default function will return the wrong answer in 5% of the
5491 cases.  If this is unacceptable to you, use the other function instead:
5492
5493 @lisp
5494 (setq gnus-extract-address-components
5495       'mail-extract-address-components)
5496 @end lisp
5497
5498 @vindex gnus-summary-same-subject
5499 @code{gnus-summary-same-subject} is a string indicating that the current
5500 article has the same subject as the previous.  This string will be used
5501 with those specs that require it.  The default is @code{""}.
5502
5503
5504 @node Summary Buffer Lines
5505 @subsection Summary Buffer Lines
5506
5507 @vindex gnus-summary-line-format
5508 You can change the format of the lines in the summary buffer by changing
5509 the @code{gnus-summary-line-format} variable.  It works along the same
5510 lines as a normal @code{format} string, with some extensions
5511 (@pxref{Formatting Variables}).
5512
5513 There should always be a colon or a point position marker on the line;
5514 the cursor always moves to the point position marker or the colon after
5515 performing an operation.  (Of course, Gnus wouldn't be Gnus if it wasn't
5516 possible to change this.  Just write a new function
5517 @code{gnus-goto-colon} which does whatever you like with the cursor.)
5518 @xref{Positioning Point}.
5519
5520 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
5521
5522 The following format specification characters and extended format
5523 specification(s) are understood:
5524
5525 @table @samp
5526 @item N
5527 Article number.
5528 @item S
5529 Subject string.  List identifiers stripped,
5530 @code{gnus-list-identifiers}.  @xref{Article Hiding}.
5531 @item s
5532 Subject if the article is the root of the thread or the previous article
5533 had a different subject, @code{gnus-summary-same-subject} otherwise.
5534 (@code{gnus-summary-same-subject} defaults to @code{""}.)
5535 @item F
5536 Full @code{From} header.
5537 @item n
5538 The name (from the @code{From} header).
5539 @item f
5540 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
5541 From Newsgroups}).
5542 @item a
5543 The name (from the @code{From} header).  This differs from the @code{n}
5544 spec in that it uses the function designated by the
5545 @code{gnus-extract-address-components} variable, which is slower, but
5546 may be more thorough.
5547 @item A
5548 The address (from the @code{From} header).  This works the same way as
5549 the @code{a} spec.
5550 @item L
5551 Number of lines in the article.
5552 @item c
5553 Number of characters in the article.  This specifier is not supported
5554 in some methods (like nnfolder).
5555 @item k
5556 Pretty-printed version of the number of characters in the article;
5557 for example, @samp{1.2k} or @samp{0.4M}.
5558 @item I
5559 Indentation based on thread level (@pxref{Customizing Threading}).
5560 @item B
5561 A complex trn-style thread tree, showing response-connecting trace
5562 lines.  A thread could be drawn like this:
5563
5564 @example
5565 >
5566 +->
5567 | +->
5568 | | \->
5569 | |   \->
5570 | \->
5571 +->
5572 \->
5573 @end example
5574
5575 You can customize the appearance with the following options.  Note
5576 that it is possible to make the thread display look really neat by
5577 replacing the default @acronym{ASCII} characters with graphic
5578 line-drawing glyphs.
5579 @table @code
5580 @item gnus-sum-thread-tree-root
5581 @vindex gnus-sum-thread-tree-root
5582 Used for the root of a thread.  If @code{nil}, use subject
5583 instead.  The default is @samp{> }.
5584
5585 @item gnus-sum-thread-tree-false-root
5586 @vindex gnus-sum-thread-tree-false-root
5587 Used for the false root of a thread (@pxref{Loose Threads}).  If
5588 @code{nil}, use subject instead.  The default is @samp{> }.
5589
5590 @item gnus-sum-thread-tree-single-indent
5591 @vindex gnus-sum-thread-tree-single-indent
5592 Used for a thread with just one message.  If @code{nil}, use subject
5593 instead.  The default is @samp{}.
5594
5595 @item gnus-sum-thread-tree-vertical
5596 @vindex gnus-sum-thread-tree-vertical
5597 Used for drawing a vertical line.  The default is @samp{| }.
5598
5599 @item gnus-sum-thread-tree-indent
5600 @vindex gnus-sum-thread-tree-indent
5601 Used for indenting.  The default is @samp{  }.
5602
5603 @item gnus-sum-thread-tree-leaf-with-other
5604 @vindex gnus-sum-thread-tree-leaf-with-other
5605 Used for a leaf with brothers.  The default is @samp{+-> }.
5606
5607 @item gnus-sum-thread-tree-single-leaf
5608 @vindex gnus-sum-thread-tree-single-leaf
5609 Used for a leaf without brothers.  The default is @samp{\-> }
5610
5611 @end table
5612
5613 @item T
5614 Nothing if the article is a root and lots of spaces if it isn't (it
5615 pushes everything after it off the screen).
5616 @item [
5617 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
5618 for adopted articles (@pxref{Customizing Threading}).
5619 @item ]
5620 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
5621 for adopted articles.
5622 @item >
5623 One space for each thread level.
5624 @item <
5625 Twenty minus thread level spaces.
5626 @item U
5627 Unread.  @xref{Read Articles}.
5628
5629 @item R
5630 This misleadingly named specifier is the @dfn{secondary mark}.  This
5631 mark will say whether the article has been replied to, has been cached,
5632 or has been saved.  @xref{Other Marks}.
5633
5634 @item i
5635 Score as a number (@pxref{Scoring}).
5636 @item z
5637 @vindex gnus-summary-zcore-fuzz
5638 Zcore, @samp{+} if above the default level and @samp{-} if below the
5639 default level.  If the difference between
5640 @code{gnus-summary-default-score} and the score is less than
5641 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
5642 @item V
5643 Total thread score.
5644 @item x
5645 @code{Xref}.
5646 @item D
5647 @code{Date}.
5648 @item d
5649 The @code{Date} in @code{DD-MMM} format.
5650 @item o
5651 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
5652 @item M
5653 @code{Message-ID}.
5654 @item r
5655 @code{References}.
5656 @item t
5657 Number of articles in the current sub-thread.  Using this spec will slow
5658 down summary buffer generation somewhat.
5659 @item e
5660 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
5661 article has any children.
5662 @item P
5663 The line number.
5664 @item O
5665 Download mark.
5666 @item *
5667 Desired cursor position (instead of after first colon).
5668 @item &user-date;
5669 Age sensitive date format.  Various date format is defined in
5670 @code{gnus-user-date-format-alist}.
5671 @item u
5672 User defined specifier.  The next character in the format string should
5673 be a letter.  Gnus will call the function
5674 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
5675 following @samp{%u}.  The function will be passed the current header as
5676 argument.  The function should return a string, which will be inserted
5677 into the summary just like information from any other summary specifier.
5678 @end table
5679
5680 Text between @samp{%(} and @samp{%)} will be highlighted with
5681 @code{gnus-mouse-face} when the mouse point is placed inside the area.
5682 There can only be one such area.
5683
5684 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
5685 have to be handled with care.  For reasons of efficiency, Gnus will
5686 compute what column these characters will end up in, and ``hard-code''
5687 that.  This means that it is invalid to have these specs after a
5688 variable-length spec.  Well, you might not be arrested, but your summary
5689 buffer will look strange, which is bad enough.
5690
5691 The smart choice is to have these specs as far to the left as possible.
5692 (Isn't that the case with everything, though?  But I digress.)
5693
5694 This restriction may disappear in later versions of Gnus.
5695
5696
5697 @node To From Newsgroups
5698 @subsection To From Newsgroups
5699 @cindex To
5700 @cindex Newsgroups
5701
5702 In some groups (particularly in archive groups), the @code{From} header
5703 isn't very interesting, since all the articles there are written by
5704 you.  To display the information in the @code{To} or @code{Newsgroups}
5705 headers instead, you need to decide three things: What information to
5706 gather; where to display it; and when to display it.
5707
5708 @enumerate
5709 @item
5710 @vindex gnus-extra-headers
5711 The reading of extra header information is controlled by the
5712 @code{gnus-extra-headers}.  This is a list of header symbols.  For
5713 instance:
5714
5715 @lisp
5716 (setq gnus-extra-headers
5717       '(To Newsgroups X-Newsreader))
5718 @end lisp
5719
5720 This will result in Gnus trying to obtain these three headers, and
5721 storing it in header structures for later easy retrieval.
5722
5723 @item
5724 @findex gnus-extra-header
5725 The value of these extra headers can be accessed via the
5726 @code{gnus-extra-header} function.  Here's a format line spec that will
5727 access the @code{X-Newsreader} header:
5728
5729 @example
5730 "%~(form (gnus-extra-header 'X-Newsreader))@@"
5731 @end example
5732
5733 @item
5734 @vindex gnus-ignored-from-addresses
5735 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
5736 summary line spec returns the @code{To}, @code{Newsreader} or
5737 @code{From} header.  If this regexp matches the contents of the
5738 @code{From} header, the value of the @code{To} or @code{Newsreader}
5739 headers are used instead.
5740
5741 To distinguish regular articles from those where the @code{From} field
5742 has been swapped, a string is prefixed to the @code{To} or
5743 @code{Newsgroups} header in the summary line.  By default the string is
5744 @samp{-> } for @code{To} and @samp{=> } for @code{Newsgroups}, you can
5745 customize these strings with @code{gnus-summary-to-prefix} and
5746 @code{gnus-summary-newsgroup-prefix}.
5747
5748 @end enumerate
5749
5750 @vindex nnmail-extra-headers
5751 A related variable is @code{nnmail-extra-headers}, which controls when
5752 to include extra headers when generating overview (@acronym{NOV}) files.
5753 If you have old overview files, you should regenerate them after
5754 changing this variable, by entering the server buffer using @kbd{^},
5755 and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause
5756 regeneration.
5757
5758 @vindex gnus-summary-line-format
5759 You also have to instruct Gnus to display the data by changing the
5760 @code{%n} spec to the @code{%f} spec in the
5761 @code{gnus-summary-line-format} variable.
5762
5763 In summary, you'd typically put something like the following in
5764 @file{~/.gnus.el}:
5765
5766 @lisp
5767 (setq gnus-extra-headers
5768       '(To Newsgroups))
5769 (setq nnmail-extra-headers gnus-extra-headers)
5770 (setq gnus-summary-line-format
5771       "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
5772 (setq gnus-ignored-from-addresses
5773       "Your Name Here")
5774 @end lisp
5775
5776 (The values listed above are the default values in Gnus.  Alter them
5777 to fit your needs.)
5778
5779 A note for news server administrators, or for users who wish to try to
5780 convince their news server administrator to provide some additional
5781 support:
5782
5783 The above is mostly useful for mail groups, where you have control over
5784 the @acronym{NOV} files that are created.  However, if you can persuade your
5785 nntp admin to add (in the usual implementation, notably INN):
5786
5787 @example
5788 Newsgroups:full
5789 @end example
5790
5791 to the end of her @file{overview.fmt} file, then you can use that just
5792 as you would the extra headers from the mail groups.
5793
5794
5795 @node Summary Buffer Mode Line
5796 @subsection Summary Buffer Mode Line
5797
5798 @vindex gnus-summary-mode-line-format
5799 You can also change the format of the summary mode bar (@pxref{Mode Line
5800 Formatting}).  Set @code{gnus-summary-mode-line-format} to whatever you
5801 like.  The default is @samp{Gnus: %%b [%A] %Z}.
5802
5803 Here are the elements you can play with:
5804
5805 @table @samp
5806 @item G
5807 Group name.
5808 @item p
5809 Unprefixed group name.
5810 @item A
5811 Current article number.
5812 @item z
5813 Current article score.
5814 @item V
5815 Gnus version.
5816 @item U
5817 Number of unread articles in this group.
5818 @item e
5819 Number of unread articles in this group that aren't displayed in the
5820 summary buffer.
5821 @item Z
5822 A string with the number of unread and unselected articles represented
5823 either as @samp{<%U(+%e) more>} if there are both unread and unselected
5824 articles, and just as @samp{<%U more>} if there are just unread articles
5825 and no unselected ones.
5826 @item g
5827 Shortish group name.  For instance, @samp{rec.arts.anime} will be
5828 shortened to @samp{r.a.anime}.
5829 @item S
5830 Subject of the current article.
5831 @item u
5832 User-defined spec (@pxref{User-Defined Specs}).
5833 @item s
5834 Name of the current score file (@pxref{Scoring}).
5835 @item d
5836 Number of dormant articles (@pxref{Unread Articles}).
5837 @item t
5838 Number of ticked articles (@pxref{Unread Articles}).
5839 @item r
5840 Number of articles that have been marked as read in this session.
5841 @item E
5842 Number of articles expunged by the score files.
5843 @end table
5844
5845
5846 @node Summary Highlighting
5847 @subsection Summary Highlighting
5848
5849 @table @code
5850
5851 @item gnus-visual-mark-article-hook
5852 @vindex gnus-visual-mark-article-hook
5853 This hook is run after selecting an article.  It is meant to be used for
5854 highlighting the article in some way.  It is not run if
5855 @code{gnus-visual} is @code{nil}.
5856
5857 @item gnus-summary-update-hook
5858 @vindex gnus-summary-update-hook
5859 This hook is called when a summary line is changed.  It is not run if
5860 @code{gnus-visual} is @code{nil}.
5861
5862 @item gnus-summary-selected-face
5863 @vindex gnus-summary-selected-face
5864 This is the face (or @dfn{font} as some people call it) used to
5865 highlight the current article in the summary buffer.
5866
5867 @item gnus-summary-highlight
5868 @vindex gnus-summary-highlight
5869 Summary lines are highlighted according to this variable, which is a
5870 list where the elements are of the format @code{(@var{form}
5871 . @var{face})}.  If you would, for instance, like ticked articles to be
5872 italic and high-scored articles to be bold, you could set this variable
5873 to something like
5874 @lisp
5875 (((eq mark gnus-ticked-mark) . italic)
5876  ((> score default) . bold))
5877 @end lisp
5878 As you may have guessed, if @var{form} returns a non-@code{nil} value,
5879 @var{face} will be applied to the line.
5880 @end table
5881
5882
5883 @node Summary Maneuvering
5884 @section Summary Maneuvering
5885 @cindex summary movement
5886
5887 All the straight movement commands understand the numeric prefix and
5888 behave pretty much as you'd expect.
5889
5890 None of these commands select articles.
5891
5892 @table @kbd
5893 @item G M-n
5894 @itemx M-n
5895 @kindex M-n (Summary)
5896 @kindex G M-n (Summary)
5897 @findex gnus-summary-next-unread-subject
5898 Go to the next summary line of an unread article
5899 (@code{gnus-summary-next-unread-subject}).
5900
5901 @item G M-p
5902 @itemx M-p
5903 @kindex M-p (Summary)
5904 @kindex G M-p (Summary)
5905 @findex gnus-summary-prev-unread-subject
5906 Go to the previous summary line of an unread article
5907 (@code{gnus-summary-prev-unread-subject}).
5908
5909 @item G g
5910 @kindex G g (Summary)
5911 @findex gnus-summary-goto-subject
5912 Ask for an article number and then go to the summary line of that article
5913 without displaying the article (@code{gnus-summary-goto-subject}).
5914 @end table
5915
5916 If Gnus asks you to press a key to confirm going to the next group, you
5917 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
5918 buffer, searching for the next group to read without actually returning
5919 to the group buffer.
5920
5921 Variables related to summary movement:
5922
5923 @table @code
5924
5925 @vindex gnus-auto-select-next
5926 @item gnus-auto-select-next
5927 If you issue one of the movement commands (like @kbd{n}) and there are
5928 no more unread articles after the current one, Gnus will offer to go to
5929 the next group.  If this variable is @code{t} and the next group is
5930 empty, Gnus will exit summary mode and return to the group buffer.  If
5931 this variable is neither @code{t} nor @code{nil}, Gnus will select the
5932 next group with unread articles.  As a special case, if this variable
5933 is @code{quietly}, Gnus will select the next group without asking for
5934 confirmation.  If this variable is @code{almost-quietly}, the same
5935 will happen only if you are located on the last article in the group.
5936 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
5937 command will go to the next group without confirmation.  Also
5938 @pxref{Group Levels}.
5939
5940 @item gnus-auto-select-same
5941 @vindex gnus-auto-select-same
5942 If non-@code{nil}, all the movement commands will try to go to the next
5943 article with the same subject as the current.  (@dfn{Same} here might
5944 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
5945 for details (@pxref{Customizing Threading}).)  If there are no more
5946 articles with the same subject, go to the first unread article.
5947
5948 This variable is not particularly useful if you use a threaded display.
5949
5950 @item gnus-summary-check-current
5951 @vindex gnus-summary-check-current
5952 If non-@code{nil}, all the ``unread'' movement commands will not proceed
5953 to the next (or previous) article if the current article is unread.
5954 Instead, they will choose the current article.
5955
5956 @item gnus-auto-center-summary
5957 @vindex gnus-auto-center-summary
5958 If non-@code{nil}, Gnus will keep the point in the summary buffer
5959 centered at all times.  This makes things quite tidy, but if you have a
5960 slow network connection, or simply do not like this un-Emacsism, you can
5961 set this variable to @code{nil} to get the normal Emacs scrolling
5962 action.  This will also inhibit horizontal re-centering of the summary
5963 buffer, which might make it more inconvenient to read extremely long
5964 threads.
5965
5966 This variable can also be a number.  In that case, center the window at
5967 the given number of lines from the top.
5968
5969 @item gnus-summary-stop-at-end-of-message
5970 @vindex gnus-summary-stop-at-end-of-message
5971 If non-@code{nil}, don't go to the next article when hitting
5972 @kbd{SPC}, and you're at the end of the article.
5973
5974 @end table
5975
5976
5977 @node Choosing Articles
5978 @section Choosing Articles
5979 @cindex selecting articles
5980
5981 @menu
5982 * Choosing Commands::           Commands for choosing articles.
5983 * Choosing Variables::          Variables that influence these commands.
5984 @end menu
5985
5986
5987 @node Choosing Commands
5988 @subsection Choosing Commands
5989
5990 None of the following movement commands understand the numeric prefix,
5991 and they all select and display an article.
5992
5993 If you want to fetch new articles or redisplay the group, see
5994 @ref{Exiting the Summary Buffer}.
5995
5996 @table @kbd
5997 @item SPACE
5998 @kindex SPACE (Summary)
5999 @findex gnus-summary-next-page
6000 Select the current article, or, if that one's read already, the next
6001 unread article (@code{gnus-summary-next-page}).
6002
6003 If you have an article window open already and you press @kbd{SPACE}
6004 again, the article will be scrolled.  This lets you conveniently
6005 @kbd{SPACE} through an entire newsgroup.  @xref{Paging the Article}.
6006
6007 @item G n
6008 @itemx n
6009 @kindex n (Summary)
6010 @kindex G n (Summary)
6011 @findex gnus-summary-next-unread-article
6012 @c @icon{gnus-summary-next-unread}
6013 Go to next unread article (@code{gnus-summary-next-unread-article}).
6014
6015 @item G p
6016 @itemx p
6017 @kindex p (Summary)
6018 @findex gnus-summary-prev-unread-article
6019 @c @icon{gnus-summary-prev-unread}
6020 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
6021
6022 @item G N
6023 @itemx N
6024 @kindex N (Summary)
6025 @kindex G N (Summary)
6026 @findex gnus-summary-next-article
6027 Go to the next article (@code{gnus-summary-next-article}).
6028
6029 @item G P
6030 @itemx P
6031 @kindex P (Summary)
6032 @kindex G P (Summary)
6033 @findex gnus-summary-prev-article
6034 Go to the previous article (@code{gnus-summary-prev-article}).
6035
6036 @item G C-n
6037 @kindex G C-n (Summary)
6038 @findex gnus-summary-next-same-subject
6039 Go to the next article with the same subject
6040 (@code{gnus-summary-next-same-subject}).
6041
6042 @item G C-p
6043 @kindex G C-p (Summary)
6044 @findex gnus-summary-prev-same-subject
6045 Go to the previous article with the same subject
6046 (@code{gnus-summary-prev-same-subject}).
6047
6048 @item G f
6049 @itemx .
6050 @kindex G f  (Summary)
6051 @kindex .  (Summary)
6052 @findex gnus-summary-first-unread-article
6053 Go to the first unread article
6054 (@code{gnus-summary-first-unread-article}).
6055
6056 @item G b
6057 @itemx ,
6058 @kindex G b (Summary)
6059 @kindex , (Summary)
6060 @findex gnus-summary-best-unread-article
6061 Go to the unread article with the highest score
6062 (@code{gnus-summary-best-unread-article}).  If given a prefix argument,
6063 go to the first unread article that has a score over the default score.
6064
6065 @item G l
6066 @itemx l
6067 @kindex l (Summary)
6068 @kindex G l (Summary)
6069 @findex gnus-summary-goto-last-article
6070 Go to the previous article read (@code{gnus-summary-goto-last-article}).
6071
6072 @item G o
6073 @kindex G o (Summary)
6074 @findex gnus-summary-pop-article
6075 @cindex history
6076 @cindex article history
6077 Pop an article off the summary history and go to this article
6078 (@code{gnus-summary-pop-article}).  This command differs from the
6079 command above in that you can pop as many previous articles off the
6080 history as you like, while @kbd{l} toggles the two last read articles.
6081 For a somewhat related issue (if you use these commands a lot),
6082 @pxref{Article Backlog}.
6083
6084 @item G j
6085 @itemx j
6086 @kindex j (Summary)
6087 @kindex G j (Summary)
6088 @findex gnus-summary-goto-article
6089 Ask for an article number or @code{Message-ID}, and then go to that
6090 article (@code{gnus-summary-goto-article}).
6091
6092 @end table
6093
6094
6095 @node Choosing Variables
6096 @subsection Choosing Variables
6097
6098 Some variables relevant for moving and selecting articles:
6099
6100 @table @code
6101 @item gnus-auto-extend-newsgroup
6102 @vindex gnus-auto-extend-newsgroup
6103 All the movement commands will try to go to the previous (or next)
6104 article, even if that article isn't displayed in the Summary buffer if
6105 this variable is non-@code{nil}.  Gnus will then fetch the article from
6106 the server and display it in the article buffer.
6107
6108 @item gnus-select-article-hook
6109 @vindex gnus-select-article-hook
6110 This hook is called whenever an article is selected.  The default is
6111 @code{nil}.  If you would like each article to be saved in the Agent as
6112 you read it, putting @code{gnus-agent-fetch-selected-article} on this
6113 hook will do so.
6114
6115 @item gnus-mark-article-hook
6116 @vindex gnus-mark-article-hook
6117 @findex gnus-summary-mark-unread-as-read
6118 @findex gnus-summary-mark-read-and-unread-as-read
6119 @findex gnus-unread-mark
6120 This hook is called whenever an article is selected.  It is intended to
6121 be used for marking articles as read.  The default value is
6122 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
6123 mark of almost any article you read to @code{gnus-read-mark}.  The only
6124 articles not affected by this function are ticked, dormant, and
6125 expirable articles.  If you'd instead like to just have unread articles
6126 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
6127 instead.  It will leave marks like @code{gnus-low-score-mark},
6128 @code{gnus-del-mark} (and so on) alone.
6129
6130 @end table
6131
6132
6133 @node Paging the Article
6134 @section Scrolling the Article
6135 @cindex article scrolling
6136
6137 @table @kbd
6138
6139 @item SPACE
6140 @kindex SPACE (Summary)
6141 @findex gnus-summary-next-page
6142 Pressing @kbd{SPACE} will scroll the current article forward one page,
6143 or, if you have come to the end of the current article, will choose the
6144 next article (@code{gnus-summary-next-page}).
6145
6146 @vindex gnus-article-boring-faces
6147 @vindex gnus-article-skip-boring
6148 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
6149 the article consists only of citations and signature, then it will be
6150 skipped; the next article will be shown instead.  You can customize
6151 what is considered uninteresting with
6152 @code{gnus-article-boring-faces}.  You can manually view the article's
6153 pages, no matter how boring, using @kbd{C-M-v}.
6154
6155 @item DEL
6156 @kindex DEL (Summary)
6157 @findex gnus-summary-prev-page
6158 Scroll the current article back one page (@code{gnus-summary-prev-page}).
6159
6160 @item RET
6161 @kindex RET (Summary)
6162 @findex gnus-summary-scroll-up
6163 Scroll the current article one line forward
6164 (@code{gnus-summary-scroll-up}).
6165
6166 @item M-RET
6167 @kindex M-RET (Summary)
6168 @findex gnus-summary-scroll-down
6169 Scroll the current article one line backward
6170 (@code{gnus-summary-scroll-down}).
6171
6172 @item A g
6173 @itemx g
6174 @kindex A g (Summary)
6175 @kindex g (Summary)
6176 @findex gnus-summary-show-article
6177 @vindex gnus-summary-show-article-charset-alist
6178 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
6179 given a prefix, fetch the current article, but don't run any of the
6180 article treatment functions.  This will give you a ``raw'' article, just
6181 the way it came from the server.
6182
6183 @cindex charset, view article with different charset
6184 If given a numerical prefix, you can do semi-manual charset stuff.
6185 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
6186 encoded in the @code{cn-gb-2312} charset.  If you have
6187
6188 @lisp
6189 (setq gnus-summary-show-article-charset-alist
6190       '((1 . cn-gb-2312)
6191         (2 . big5)))
6192 @end lisp
6193
6194 then you can say @kbd{C-u 1 g} to get the same effect.
6195
6196 @item A <
6197 @itemx <
6198 @kindex < (Summary)
6199 @kindex A < (Summary)
6200 @findex gnus-summary-beginning-of-article
6201 Scroll to the beginning of the article
6202 (@code{gnus-summary-beginning-of-article}).
6203
6204 @item A >
6205 @itemx >
6206 @kindex > (Summary)
6207 @kindex A > (Summary)
6208 @findex gnus-summary-end-of-article
6209 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
6210
6211 @item A s
6212 @itemx s
6213 @kindex A s (Summary)
6214 @kindex s (Summary)
6215 @findex gnus-summary-isearch-article
6216 Perform an isearch in the article buffer
6217 (@code{gnus-summary-isearch-article}).
6218
6219 @item h
6220 @kindex h (Summary)
6221 @findex gnus-summary-select-article-buffer
6222 Select the article buffer (@code{gnus-summary-select-article-buffer}).
6223
6224 @end table
6225
6226
6227 @node Reply Followup and Post
6228 @section Reply, Followup and Post
6229
6230 @menu
6231 * Summary Mail Commands::       Sending mail.
6232 * Summary Post Commands::       Sending news.
6233 * Summary Message Commands::    Other Message-related commands.
6234 * Canceling and Superseding::
6235 @end menu
6236
6237
6238 @node Summary Mail Commands
6239 @subsection Summary Mail Commands
6240 @cindex mail
6241 @cindex composing mail
6242
6243 Commands for composing a mail message:
6244
6245 @table @kbd
6246
6247 @item S r
6248 @itemx r
6249 @kindex S r (Summary)
6250 @kindex r (Summary)
6251 @findex gnus-summary-reply
6252 @c @icon{gnus-summary-mail-reply}
6253 @c @icon{gnus-summary-reply}
6254 Mail a reply to the author of the current article
6255 (@code{gnus-summary-reply}).
6256
6257 @item S R
6258 @itemx R
6259 @kindex R (Summary)
6260 @kindex S R (Summary)
6261 @findex gnus-summary-reply-with-original
6262 @c @icon{gnus-summary-reply-with-original}
6263 Mail a reply to the author of the current article and include the
6264 original message (@code{gnus-summary-reply-with-original}).  This
6265 command uses the process/prefix convention.
6266
6267 @item S w
6268 @kindex S w (Summary)
6269 @findex gnus-summary-wide-reply
6270 Mail a wide reply to the author of the current article
6271 (@code{gnus-summary-wide-reply}).  A @dfn{wide reply} is a reply that
6272 goes out to all people listed in the @code{To}, @code{From} (or
6273 @code{Reply-to}) and @code{Cc} headers.  If @code{Mail-Followup-To} is
6274 present, that's used instead.
6275
6276 @item S W
6277 @kindex S W (Summary)
6278 @findex gnus-summary-wide-reply-with-original
6279 Mail a wide reply to the current article and include the original
6280 message (@code{gnus-summary-wide-reply-with-original}).  This command uses
6281 the process/prefix convention, but only uses the headers from the
6282 first article to determine the recipients.
6283
6284 @item S v
6285 @kindex S v (Summary)
6286 @findex gnus-summary-very-wide-reply
6287 Mail a very wide reply to the author of the current article
6288 (@code{gnus-summary-wide-reply}).  A @dfn{very wide reply} is a reply
6289 that goes out to all people listed in the @code{To}, @code{From} (or
6290 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
6291 articles.  This command uses the process/prefix convention.
6292
6293 @item S V
6294 @kindex S V (Summary)
6295 @findex gnus-summary-very-wide-reply-with-original
6296 Mail a very wide reply to the author of the current article and include the
6297 original message (@code{gnus-summary-very-wide-reply-with-original}).  This
6298 command uses the process/prefix convention.
6299
6300 @item S B r
6301 @kindex S B r (Summary)
6302 @findex gnus-summary-reply-broken-reply-to
6303 Mail a reply to the author of the current article but ignore the
6304 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
6305 If you need this because a mailing list incorrectly sets a
6306 @code{Reply-To} header pointing to the list, you probably want to set
6307 the @code{broken-reply-to} group parameter instead, so things will work
6308 correctly.  @xref{Group Parameters}.
6309
6310 @item S B R
6311 @kindex S B R (Summary)
6312 @findex gnus-summary-reply-broken-reply-to-with-original
6313 Mail a reply to the author of the current article and include the
6314 original message but ignore the @code{Reply-To} field
6315 (@code{gnus-summary-reply-broken-reply-to-with-original}).
6316
6317 @item S o m
6318 @itemx C-c C-f
6319 @kindex S o m (Summary)
6320 @kindex C-c C-f (Summary)
6321 @findex gnus-summary-mail-forward
6322 @c @icon{gnus-summary-mail-forward}
6323 Forward the current article to some other person
6324 (@code{gnus-summary-mail-forward}).  If no prefix is given, the message
6325 is forwarded according to the value of (@code{message-forward-as-mime})
6326 and (@code{message-forward-show-mml}); if the prefix is 1, decode the
6327 message and forward directly inline; if the prefix is 2, forward message
6328 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
6329 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
6330 directly inline; otherwise, the message is forwarded as no prefix given
6331 but use the flipped value of (@code{message-forward-as-mime}).  By
6332 default, the message is decoded and forwarded as an rfc822 @acronym{MIME}
6333 section.
6334
6335 @item S m
6336 @itemx m
6337 @kindex m (Summary)
6338 @kindex S m (Summary)
6339 @findex gnus-summary-mail-other-window
6340 @c @icon{gnus-summary-mail-originate}
6341 Prepare a mail (@code{gnus-summary-mail-other-window}).  By default, use
6342 the posting style of the current group.  If given a prefix, disable that.
6343 If the prefix is 1, prompt for a group name to find the posting style.
6344
6345 @item S i
6346 @kindex S i (Summary)
6347 @findex gnus-summary-news-other-window
6348 Prepare a news (@code{gnus-summary-news-other-window}).  By default,
6349 post to the current group.  If given a prefix, disable that.  If the
6350 prefix is 1, prompt for a group to post to.
6351
6352 This function actually prepares a news even when using mail groups.
6353 This is useful for ``posting'' messages to mail groups without actually
6354 sending them over the network: they're just saved directly to the group
6355 in question.  The corresponding back end must have a request-post method
6356 for this to work though.
6357
6358 @item S D b
6359 @kindex S D b (Summary)
6360 @findex gnus-summary-resend-bounced-mail
6361 @cindex bouncing mail
6362 If you have sent a mail, but the mail was bounced back to you for some
6363 reason (wrong address, transient failure), you can use this command to
6364 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
6365 will be popped into a mail buffer where you can edit the headers before
6366 sending the mail off again.  If you give a prefix to this command, and
6367 the bounced mail is a reply to some other mail, Gnus will try to fetch
6368 that mail and display it for easy perusal of its headers.  This might
6369 very well fail, though.
6370
6371 @item S D r
6372 @kindex S D r (Summary)
6373 @findex gnus-summary-resend-message
6374 Not to be confused with the previous command,
6375 @code{gnus-summary-resend-message} will prompt you for an address to
6376 send the current message off to, and then send it to that place.  The
6377 headers of the message won't be altered---but lots of headers that say
6378 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
6379 means that you actually send a mail to someone that has a @code{To}
6380 header that (probably) points to yourself.  This will confuse people.
6381 So, natcherly you'll only do that if you're really eVIl.
6382
6383 This command is mainly used if you have several accounts and want to
6384 ship a mail to a different account of yours.  (If you're both
6385 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
6386 to the @code{root} account, you may want to resend it to
6387 @code{postmaster}.  Ordnung muss sein!
6388
6389 This command understands the process/prefix convention
6390 (@pxref{Process/Prefix}).
6391
6392 @item S D e
6393 @kindex S D e (Summary)
6394 @findex gnus-summary-resend-message-edit
6395
6396 Like the previous command, but will allow you to edit the message as
6397 if it were a new message before resending.
6398
6399 @item S O m
6400 @kindex S O m (Summary)
6401 @findex gnus-uu-digest-mail-forward
6402 Digest the current series (@pxref{Decoding Articles}) and forward the
6403 result using mail (@code{gnus-uu-digest-mail-forward}).  This command
6404 uses the process/prefix convention (@pxref{Process/Prefix}).
6405
6406 @item S M-c
6407 @kindex S M-c (Summary)
6408 @findex gnus-summary-mail-crosspost-complaint
6409 @cindex crossposting
6410 @cindex excessive crossposting
6411 Send a complaint about excessive crossposting to the author of the
6412 current article (@code{gnus-summary-mail-crosspost-complaint}).
6413
6414 @findex gnus-crosspost-complaint
6415 This command is provided as a way to fight back against the current
6416 crossposting pandemic that's sweeping Usenet.  It will compose a reply
6417 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
6418 command understands the process/prefix convention
6419 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
6420
6421 @end table
6422
6423 Also @xref{Header Commands, ,Header Commands, message, The Message
6424 Manual}, for more information.
6425
6426
6427 @node Summary Post Commands
6428 @subsection Summary Post Commands
6429 @cindex post
6430 @cindex composing news
6431
6432 Commands for posting a news article:
6433
6434 @table @kbd
6435 @item S p
6436 @itemx a
6437 @kindex a (Summary)
6438 @kindex S p (Summary)
6439 @findex gnus-summary-post-news
6440 @c @icon{gnus-summary-post-news}
6441 Prepare for posting an article (@code{gnus-summary-post-news}).  By
6442 default, post to the current group.  If given a prefix, disable that.
6443 If the prefix is 1, prompt for another group instead.
6444
6445 @item S f
6446 @itemx f
6447 @kindex f (Summary)
6448 @kindex S f (Summary)
6449 @findex gnus-summary-followup
6450 @c @icon{gnus-summary-followup}
6451 Post a followup to the current article (@code{gnus-summary-followup}).
6452
6453 @item S F
6454 @itemx F
6455 @kindex S F (Summary)
6456 @kindex F (Summary)
6457 @c @icon{gnus-summary-followup-with-original}
6458 @findex gnus-summary-followup-with-original
6459 Post a followup to the current article and include the original message
6460 (@code{gnus-summary-followup-with-original}).  This command uses the
6461 process/prefix convention.
6462
6463 @item S n
6464 @kindex S n (Summary)
6465 @findex gnus-summary-followup-to-mail
6466 Post a followup to the current article via news, even if you got the
6467 message through mail (@code{gnus-summary-followup-to-mail}).
6468
6469 @item S N
6470 @kindex S N (Summary)
6471 @findex gnus-summary-followup-to-mail-with-original
6472 Post a followup to the current article via news, even if you got the
6473 message through mail and include the original message
6474 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
6475 the process/prefix convention.
6476
6477 @item S o p
6478 @kindex S o p (Summary)
6479 @findex gnus-summary-post-forward
6480 Forward the current article to a newsgroup
6481 (@code{gnus-summary-post-forward}).
6482  If no prefix is given, the message is forwarded according to the value
6483 of (@code{message-forward-as-mime}) and
6484 (@code{message-forward-show-mml}); if the prefix is 1, decode the
6485 message and forward directly inline; if the prefix is 2, forward message
6486 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
6487 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
6488 directly inline; otherwise, the message is forwarded as no prefix given
6489 but use the flipped value of (@code{message-forward-as-mime}).  By
6490 default, the message is decoded and forwarded as an rfc822 @acronym{MIME} section.
6491
6492 @item S O p
6493 @kindex S O p (Summary)
6494 @findex gnus-uu-digest-post-forward
6495 @cindex digests
6496 @cindex making digests
6497 Digest the current series and forward the result to a newsgroup
6498 (@code{gnus-uu-digest-post-forward}).  This command uses the
6499 process/prefix convention.
6500
6501 @item S u
6502 @kindex S u (Summary)
6503 @findex gnus-uu-post-news
6504 @c @icon{gnus-uu-post-news}
6505 Uuencode a file, split it into parts, and post it as a series
6506 (@code{gnus-uu-post-news}).  (@pxref{Uuencoding and Posting}).
6507 @end table
6508
6509 Also @xref{Header Commands, ,Header Commands, message, The Message
6510 Manual}, for more information.
6511
6512
6513 @node Summary Message Commands
6514 @subsection Summary Message Commands
6515
6516 @table @kbd
6517 @item S y
6518 @kindex S y (Summary)
6519 @findex gnus-summary-yank-message
6520 Yank the current article into an already existing Message composition
6521 buffer (@code{gnus-summary-yank-message}).  This command prompts for
6522 what message buffer you want to yank into, and understands the
6523 process/prefix convention (@pxref{Process/Prefix}).
6524
6525 @end table
6526
6527
6528 @node Canceling and Superseding
6529 @subsection Canceling Articles
6530 @cindex canceling articles
6531 @cindex superseding articles
6532
6533 Have you ever written something, and then decided that you really,
6534 really, really wish you hadn't posted that?
6535
6536 Well, you can't cancel mail, but you can cancel posts.
6537
6538 @findex gnus-summary-cancel-article
6539 @kindex C (Summary)
6540 @c @icon{gnus-summary-cancel-article}
6541 Find the article you wish to cancel (you can only cancel your own
6542 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
6543 c} (@code{gnus-summary-cancel-article}).  Your article will be
6544 canceled---machines all over the world will be deleting your article.
6545 This command uses the process/prefix convention (@pxref{Process/Prefix}).
6546
6547 Be aware, however, that not all sites honor cancels, so your article may
6548 live on here and there, while most sites will delete the article in
6549 question.
6550
6551 Gnus will use the ``current'' select method when canceling.  If you
6552 want to use the standard posting method, use the @samp{a} symbolic
6553 prefix (@pxref{Symbolic Prefixes}).
6554
6555 Gnus ensures that only you can cancel your own messages using a
6556 @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, ,
6557 message, Message Manual}).
6558
6559 If you discover that you have made some mistakes and want to do some
6560 corrections, you can post a @dfn{superseding} article that will replace
6561 your original article.
6562
6563 @findex gnus-summary-supersede-article
6564 @kindex S (Summary)
6565 Go to the original article and press @kbd{S s}
6566 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
6567 where you can edit the article all you want before sending it off the
6568 usual way.
6569
6570 The same goes for superseding as for canceling, only more so: Some
6571 sites do not honor superseding.  On those sites, it will appear that you
6572 have posted almost the same article twice.
6573
6574 If you have just posted the article, and change your mind right away,
6575 there is a trick you can use to cancel/supersede the article without
6576 waiting for the article to appear on your site first.  You simply return
6577 to the post buffer (which is called @code{*sent ...*}).  There you will
6578 find the article you just posted, with all the headers intact.  Change
6579 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
6580 header by substituting one of those words for the word
6581 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
6582 you would do normally.  The previous article will be
6583 canceled/superseded.
6584
6585 Just remember, kids: There is no 'c' in 'supersede'.
6586
6587 @node Delayed Articles
6588 @section Delayed Articles
6589 @cindex delayed sending
6590 @cindex send delayed
6591
6592 Sometimes, you might wish to delay the sending of a message.  For
6593 example, you might wish to arrange for a message to turn up just in time
6594 to remind your about the birthday of your Significant Other.  For this,
6595 there is the @code{gnus-delay} package.  Setup is simple:
6596
6597 @lisp
6598 (gnus-delay-initialize)
6599 @end lisp
6600
6601 @findex gnus-delay-article
6602 Normally, to send a message you use the @kbd{C-c C-c} command from
6603 Message mode.  To delay a message, use @kbd{C-c C-j}
6604 (@code{gnus-delay-article}) instead.  This will ask you for how long the
6605 message should be delayed.  Possible answers are:
6606
6607 @itemize @bullet
6608 @item
6609 A time span.  Consists of an integer and a letter.  For example,
6610 @code{42d} means to delay for 42 days.  Available letters are @code{m}
6611 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
6612 (months) and @code{Y} (years).
6613
6614 @item
6615 A specific date.  Looks like @code{YYYY-MM-DD}.  The message will be
6616 delayed until that day, at a specific time (eight o'clock by default).
6617 See also @code{gnus-delay-default-hour}.
6618
6619 @item
6620 A specific time of day.  Given in @code{hh:mm} format, 24h, no am/pm
6621 stuff.  The deadline will be at that time today, except if that time has
6622 already passed, then it's at the given time tomorrow.  So if it's ten
6623 o'clock in the morning and you specify @code{11:15}, then the deadline
6624 is one hour and fifteen minutes hence.  But if you specify @code{9:20},
6625 that means a time tomorrow.
6626 @end itemize
6627
6628 The action of the @code{gnus-delay-article} command is influenced by a
6629 couple of variables:
6630
6631 @table @code
6632 @item gnus-delay-default-hour
6633 @vindex gnus-delay-default-hour
6634 When you specify a specific date, the message will be due on that hour
6635 on the given date.  Possible values are integers 0 through 23.
6636
6637 @item gnus-delay-default-delay
6638 @vindex gnus-delay-default-delay
6639 This is a string and gives the default delay.  It can be of any of the
6640 formats described above.
6641
6642 @item gnus-delay-group
6643 @vindex gnus-delay-group
6644 Delayed articles will be kept in this group on the drafts server until
6645 they are due.  You probably don't need to change this.  The default
6646 value is @code{"delayed"}.
6647
6648 @item gnus-delay-header
6649 @vindex gnus-delay-header
6650 The deadline for each article will be stored in a header.  This variable
6651 is a string and gives the header name.  You probably don't need to
6652 change this.  The default value is @code{"X-Gnus-Delayed"}.
6653 @end table
6654
6655 The way delaying works is like this: when you use the
6656 @code{gnus-delay-article} command, you give a certain delay.  Gnus
6657 calculates the deadline of the message and stores it in the
6658 @code{X-Gnus-Delayed} header and puts the message in the
6659 @code{nndraft:delayed} group.
6660
6661 @findex gnus-delay-send-queue
6662 And whenever you get new news, Gnus looks through the group for articles
6663 which are due and sends them.  It uses the @code{gnus-delay-send-queue}
6664 function for this.  By default, this function is added to the hook
6665 @code{gnus-get-new-news-hook}.  But of course, you can change this.
6666 Maybe you want to use the demon to send drafts?  Just tell the demon to
6667 execute the @code{gnus-delay-send-queue} function.
6668
6669 @table @code
6670 @item gnus-delay-initialize
6671 @findex gnus-delay-initialize
6672 By default, this function installs @code{gnus-delay-send-queue} in
6673 @code{gnus-get-new-news-hook}.  But it accepts the optional second
6674 argument @code{no-check}.  If it is non-@code{nil},
6675 @code{gnus-get-new-news-hook} is not changed.  The optional first
6676 argument is ignored.
6677
6678 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
6679 Presumably, you want to use the demon for sending due delayed articles.
6680 Just don't forget to set that up :-)
6681 @end table
6682
6683 When delaying an article with @kbd{C-c C-j}, Message mode will
6684 automatically add a @code{"Date"} header with the current time.  In
6685 many cases you probably want the @code{"Date"} header to reflect the
6686 time the message is sent instead.  To do this, you have to delete
6687 @code{Date} from @code{message-draft-headers}.
6688
6689
6690 @node Marking Articles
6691 @section Marking Articles
6692 @cindex article marking
6693 @cindex article ticking
6694 @cindex marks
6695
6696 There are several marks you can set on an article.
6697
6698 You have marks that decide the @dfn{readedness} (whoo, neato-keano
6699 neologism ohoy!) of the article.  Alphabetic marks generally mean
6700 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
6701
6702 In addition, you also have marks that do not affect readedness.
6703
6704 @ifinfo
6705 There's a plethora of commands for manipulating these marks.
6706 @end ifinfo
6707
6708 @menu
6709 * Unread Articles::             Marks for unread articles.
6710 * Read Articles::               Marks for read articles.
6711 * Other Marks::                 Marks that do not affect readedness.
6712 * Setting Marks::               How to set and remove marks.
6713 * Generic Marking Commands::    How to customize the marking.
6714 * Setting Process Marks::       How to mark articles for later processing.
6715 @end menu
6716
6717
6718 @node Unread Articles
6719 @subsection Unread Articles
6720
6721 The following marks mark articles as (kinda) unread, in one form or
6722 other.
6723
6724 @table @samp
6725 @item !
6726 @vindex gnus-ticked-mark
6727 Marked as ticked (@code{gnus-ticked-mark}).
6728
6729 @dfn{Ticked articles} are articles that will remain visible always.  If
6730 you see an article that you find interesting, or you want to put off
6731 reading it, or replying to it, until sometime later, you'd typically
6732 tick it.  However, articles can be expired (from news servers by the
6733 news server software, Gnus itself never expires ticked messages), so if
6734 you want to keep an article forever, you'll have to make it persistent
6735 (@pxref{Persistent Articles}).
6736
6737 @item ?
6738 @vindex gnus-dormant-mark
6739 Marked as dormant (@code{gnus-dormant-mark}).
6740
6741 @dfn{Dormant articles} will only appear in the summary buffer if there
6742 are followups to it.  If you want to see them even if they don't have
6743 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
6744 Otherwise (except for the visibility issue), they are just like ticked
6745 messages.
6746
6747 @item SPACE
6748 @vindex gnus-unread-mark
6749 Marked as unread (@code{gnus-unread-mark}).
6750
6751 @dfn{Unread articles} are articles that haven't been read at all yet.
6752 @end table
6753
6754
6755 @node Read Articles
6756 @subsection Read Articles
6757 @cindex expirable mark
6758
6759 All the following marks mark articles as read.
6760
6761 @table @samp
6762
6763 @item r
6764 @vindex gnus-del-mark
6765 These are articles that the user has marked as read with the @kbd{d}
6766 command manually, more or less (@code{gnus-del-mark}).
6767
6768 @item R
6769 @vindex gnus-read-mark
6770 Articles that have actually been read (@code{gnus-read-mark}).
6771
6772 @item O
6773 @vindex gnus-ancient-mark
6774 Articles that were marked as read in previous sessions and are now
6775 @dfn{old} (@code{gnus-ancient-mark}).
6776
6777 @item K
6778 @vindex gnus-killed-mark
6779 Marked as killed (@code{gnus-killed-mark}).
6780
6781 @item X
6782 @vindex gnus-kill-file-mark
6783 Marked as killed by kill files (@code{gnus-kill-file-mark}).
6784
6785 @item Y
6786 @vindex gnus-low-score-mark
6787 Marked as read by having too low a score (@code{gnus-low-score-mark}).
6788
6789 @item C
6790 @vindex gnus-catchup-mark
6791 Marked as read by a catchup (@code{gnus-catchup-mark}).
6792
6793 @item G
6794 @vindex gnus-canceled-mark
6795 Canceled article (@code{gnus-canceled-mark})
6796
6797 @item Q
6798 @vindex gnus-sparse-mark
6799 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
6800 Threading}.
6801
6802 @item M
6803 @vindex gnus-duplicate-mark
6804 Article marked as read by duplicate suppression
6805 (@code{gnus-duplicate-mark}).  @xref{Duplicate Suppression}.
6806
6807 @end table
6808
6809 All these marks just mean that the article is marked as read, really.
6810 They are interpreted differently when doing adaptive scoring, though.
6811
6812 One more special mark, though:
6813
6814 @table @samp
6815 @item E
6816 @vindex gnus-expirable-mark
6817 Marked as expirable (@code{gnus-expirable-mark}).
6818
6819 Marking articles as @dfn{expirable} (or have them marked as such
6820 automatically) doesn't make much sense in normal groups---a user doesn't
6821 control expiring of news articles, but in mail groups, for instance,
6822 articles marked as @dfn{expirable} can be deleted by Gnus at
6823 any time.
6824 @end table
6825
6826
6827 @node Other Marks
6828 @subsection Other Marks
6829 @cindex process mark
6830 @cindex bookmarks
6831
6832 There are some marks that have nothing to do with whether the article is
6833 read or not.
6834
6835 @itemize @bullet
6836
6837 @item
6838 You can set a bookmark in the current article.  Say you are reading a
6839 long thesis on cats' urinary tracts, and have to go home for dinner
6840 before you've finished reading the thesis.  You can then set a bookmark
6841 in the article, and Gnus will jump to this bookmark the next time it
6842 encounters the article.  @xref{Setting Marks}.
6843
6844 @item
6845 @vindex gnus-replied-mark
6846 All articles that you have replied to or made a followup to (i.e., have
6847 answered) will be marked with an @samp{A} in the second column
6848 (@code{gnus-replied-mark}).
6849
6850 @item
6851 @vindex gnus-forwarded-mark
6852 All articles that you have forwarded will be marked with an @samp{F} in
6853 the second column (@code{gnus-forwarded-mark}).
6854
6855 @item
6856 @vindex gnus-cached-mark
6857 Articles stored in the article cache will be marked with an @samp{*} in
6858 the second column (@code{gnus-cached-mark}).  @xref{Article Caching}.
6859
6860 @item
6861 @vindex gnus-saved-mark
6862 Articles ``saved'' (in some manner or other; not necessarily
6863 religiously) are marked with an @samp{S} in the second column
6864 (@code{gnus-saved-mark}).
6865
6866 @item
6867 @vindex gnus-recent-mark
6868 Articles that according to the server haven't been shown to the user
6869 before are marked with a @samp{N} in the second column
6870 (@code{gnus-recent-mark}).  Note that not all servers support this
6871 mark, in which case it simply never appears.  Compare with
6872 @code{gnus-unseen-mark}.
6873
6874 @item
6875 @vindex gnus-unseen-mark
6876 Articles that haven't been seen before in Gnus by the user are marked
6877 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
6878 Compare with @code{gnus-recent-mark}.
6879
6880 @item
6881 @vindex gnus-downloaded-mark
6882 When using the Gnus agent (@pxref{Agent Basics}), articles may be
6883 downloaded for unplugged (offline) viewing.  If you are using the
6884 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
6885 (The variable @code{gnus-downloaded-mark} controls which character to
6886 use.)
6887
6888 @item
6889 @vindex gnus-undownloaded-mark
6890 When using the Gnus agent (@pxref{Agent Basics}), some articles might
6891 not have been downloaded.  Such articles cannot be viewed while you
6892 are unplugged (offline).  If you are using the @samp{%O} spec, these
6893 articles get the @samp{-} mark in that spec.  (The variable
6894 @code{gnus-undownloaded-mark} controls which character to use.)
6895
6896 @item
6897 @vindex gnus-downloadable-mark
6898 The Gnus agent (@pxref{Agent Basics}) downloads some articles
6899 automatically, but it is also possible to explicitly mark articles for
6900 download, even if they would not be downloaded automatically.  Such
6901 explicitly-marked articles get the @samp{%} mark in the first column.
6902 (The variable @code{gnus-downloadable-mark} controls which character to
6903 use.)
6904
6905 @item
6906 @vindex gnus-not-empty-thread-mark
6907 @vindex gnus-empty-thread-mark
6908 If the @samp{%e} spec is used, the presence of threads or not will be
6909 marked with @code{gnus-not-empty-thread-mark} and
6910 @code{gnus-empty-thread-mark} in the third column, respectively.
6911
6912 @item
6913 @vindex gnus-process-mark
6914 Finally we have the @dfn{process mark} (@code{gnus-process-mark}).  A
6915 variety of commands react to the presence of the process mark.  For
6916 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
6917 all articles that have been marked with the process mark.  Articles
6918 marked with the process mark have a @samp{#} in the second column.
6919
6920 @end itemize
6921
6922 You might have noticed that most of these ``non-readedness'' marks
6923 appear in the second column by default.  So if you have a cached, saved,
6924 replied article that you have process-marked, what will that look like?
6925
6926 Nothing much.  The precedence rules go as follows: process -> cache ->
6927 replied -> saved.  So if the article is in the cache and is replied,
6928 you'll only see the cache mark and not the replied mark.
6929
6930
6931 @node Setting Marks
6932 @subsection Setting Marks
6933 @cindex setting marks
6934
6935 All the marking commands understand the numeric prefix.
6936
6937 @table @kbd
6938 @item M c
6939 @itemx M-u
6940 @kindex M c (Summary)
6941 @kindex M-u (Summary)
6942 @findex gnus-summary-clear-mark-forward
6943 @cindex mark as unread
6944 Clear all readedness-marks from the current article
6945 (@code{gnus-summary-clear-mark-forward}).  In other words, mark the
6946 article as unread.
6947
6948 @item M t
6949 @itemx !
6950 @kindex ! (Summary)
6951 @kindex M t (Summary)
6952 @findex gnus-summary-tick-article-forward
6953 Tick the current article (@code{gnus-summary-tick-article-forward}).
6954 @xref{Article Caching}.
6955
6956 @item M ?
6957 @itemx ?
6958 @kindex ? (Summary)
6959 @kindex M ? (Summary)
6960 @findex gnus-summary-mark-as-dormant
6961 Mark the current article as dormant
6962 (@code{gnus-summary-mark-as-dormant}).  @xref{Article Caching}.
6963
6964 @item M d
6965 @itemx d
6966 @kindex M d (Summary)
6967 @kindex d (Summary)
6968 @findex gnus-summary-mark-as-read-forward
6969 Mark the current article as read
6970 (@code{gnus-summary-mark-as-read-forward}).
6971
6972 @item D
6973 @kindex D (Summary)
6974 @findex gnus-summary-mark-as-read-backward
6975 Mark the current article as read and move point to the previous line
6976 (@code{gnus-summary-mark-as-read-backward}).
6977
6978 @item M k
6979 @itemx k
6980 @kindex k (Summary)
6981 @kindex M k (Summary)
6982 @findex gnus-summary-kill-same-subject-and-select
6983 Mark all articles that have the same subject as the current one as read,
6984 and then select the next unread article
6985 (@code{gnus-summary-kill-same-subject-and-select}).
6986
6987 @item M K
6988 @itemx C-k
6989 @kindex M K (Summary)
6990 @kindex C-k (Summary)
6991 @findex gnus-summary-kill-same-subject
6992 Mark all articles that have the same subject as the current one as read
6993 (@code{gnus-summary-kill-same-subject}).
6994
6995 @item M C
6996 @kindex M C (Summary)
6997 @findex gnus-summary-catchup
6998 @c @icon{gnus-summary-catchup}
6999 Mark all unread articles as read (@code{gnus-summary-catchup}).
7000
7001 @item M C-c
7002 @kindex M C-c (Summary)
7003 @findex gnus-summary-catchup-all
7004 Mark all articles in the group as read---even the ticked and dormant
7005 articles (@code{gnus-summary-catchup-all}).
7006
7007 @item M H
7008 @kindex M H (Summary)
7009 @findex gnus-summary-catchup-to-here
7010 Catchup the current group to point (before the point)
7011 (@code{gnus-summary-catchup-to-here}).
7012
7013 @item M h
7014 @kindex M h (Summary)
7015 @findex gnus-summary-catchup-from-here
7016 Catchup the current group from point (after the point)
7017 (@code{gnus-summary-catchup-from-here}).
7018
7019 @item C-w
7020 @kindex C-w (Summary)
7021 @findex gnus-summary-mark-region-as-read
7022 Mark all articles between point and mark as read
7023 (@code{gnus-summary-mark-region-as-read}).
7024
7025 @item M V k
7026 @kindex M V k (Summary)
7027 @findex gnus-summary-kill-below
7028 Kill all articles with scores below the default score (or below the
7029 numeric prefix) (@code{gnus-summary-kill-below}).
7030
7031 @item M e
7032 @itemx E
7033 @kindex M e (Summary)
7034 @kindex E (Summary)
7035 @findex gnus-summary-mark-as-expirable
7036 Mark the current article as expirable
7037 (@code{gnus-summary-mark-as-expirable}).
7038
7039 @item M b
7040 @kindex M b (Summary)
7041 @findex gnus-summary-set-bookmark
7042 Set a bookmark in the current article
7043 (@code{gnus-summary-set-bookmark}).
7044
7045 @item M B
7046 @kindex M B (Summary)
7047 @findex gnus-summary-remove-bookmark
7048 Remove the bookmark from the current article
7049 (@code{gnus-summary-remove-bookmark}).
7050
7051 @item M V c
7052 @kindex M V c (Summary)
7053 @findex gnus-summary-clear-above
7054 Clear all marks from articles with scores over the default score (or
7055 over the numeric prefix) (@code{gnus-summary-clear-above}).
7056
7057 @item M V u
7058 @kindex M V u (Summary)
7059 @findex gnus-summary-tick-above
7060 Tick all articles with scores over the default score (or over the
7061 numeric prefix) (@code{gnus-summary-tick-above}).
7062
7063 @item M V m
7064 @kindex M V m (Summary)
7065 @findex gnus-summary-mark-above
7066 Prompt for a mark, and mark all articles with scores over the default
7067 score (or over the numeric prefix) with this mark
7068 (@code{gnus-summary-clear-above}).
7069 @end table
7070
7071 @vindex gnus-summary-goto-unread
7072 The @code{gnus-summary-goto-unread} variable controls what action should
7073 be taken after setting a mark.  If non-@code{nil}, point will move to
7074 the next/previous unread article.  If @code{nil}, point will just move
7075 one line up or down.  As a special case, if this variable is
7076 @code{never}, all the marking commands as well as other commands (like
7077 @kbd{SPACE}) will move to the next article, whether it is unread or not.
7078 The default is @code{t}.
7079
7080
7081 @node Generic Marking Commands
7082 @subsection Generic Marking Commands
7083
7084 Some people would like the command that ticks an article (@kbd{!}) go to
7085 the next article.  Others would like it to go to the next unread
7086 article.  Yet others would like it to stay on the current article.  And
7087 even though I haven't heard of anybody wanting it to go to the
7088 previous (unread) article, I'm sure there are people that want that as
7089 well.
7090
7091 Multiply these five behaviors with five different marking commands, and
7092 you get a potentially complex set of variable to control what each
7093 command should do.
7094
7095 To sidestep that mess, Gnus provides commands that do all these
7096 different things.  They can be found on the @kbd{M M} map in the summary
7097 buffer.  Type @kbd{M M C-h} to see them all---there are too many of them
7098 to list in this manual.
7099
7100 While you can use these commands directly, most users would prefer
7101 altering the summary mode keymap.  For instance, if you would like the
7102 @kbd{!} command to go to the next article instead of the next unread
7103 article, you could say something like:
7104
7105 @lisp
7106 @group
7107 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
7108 (defun my-alter-summary-map ()
7109   (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
7110 @end group
7111 @end lisp
7112
7113 @noindent
7114 or
7115
7116 @lisp
7117 (defun my-alter-summary-map ()
7118   (local-set-key "!" "MM!n"))
7119 @end lisp
7120
7121
7122 @node Setting Process Marks
7123 @subsection Setting Process Marks
7124 @cindex setting process marks
7125
7126 Process marks are displayed as @code{#} in the summary buffer, and are
7127 used for marking articles in such a way that other commands will
7128 process these articles.  For instance, if you process mark four
7129 articles and then use the @kbd{*} command, Gnus will enter these four
7130 articles into the cache.  For more information,
7131 @pxref{Process/Prefix}.
7132
7133 @table @kbd
7134
7135 @item M P p
7136 @itemx #
7137 @kindex # (Summary)
7138 @kindex M P p (Summary)
7139 @findex gnus-summary-mark-as-processable
7140 Mark the current article with the process mark
7141 (@code{gnus-summary-mark-as-processable}).
7142 @findex gnus-summary-unmark-as-processable
7143
7144 @item M P u
7145 @itemx M-#
7146 @kindex M P u (Summary)
7147 @kindex M-# (Summary)
7148 Remove the process mark, if any, from the current article
7149 (@code{gnus-summary-unmark-as-processable}).
7150
7151 @item M P U
7152 @kindex M P U (Summary)
7153 @findex gnus-summary-unmark-all-processable
7154 Remove the process mark from all articles
7155 (@code{gnus-summary-unmark-all-processable}).
7156
7157 @item M P i
7158 @kindex M P i (Summary)
7159 @findex gnus-uu-invert-processable
7160 Invert the list of process marked articles
7161 (@code{gnus-uu-invert-processable}).
7162
7163 @item M P R
7164 @kindex M P R (Summary)
7165 @findex gnus-uu-mark-by-regexp
7166 Mark articles that have a @code{Subject} header that matches a regular
7167 expression (@code{gnus-uu-mark-by-regexp}).
7168
7169 @item M P G
7170 @kindex M P G (Summary)
7171 @findex gnus-uu-unmark-by-regexp
7172 Unmark articles that have a @code{Subject} header that matches a regular
7173 expression (@code{gnus-uu-unmark-by-regexp}).
7174
7175 @item M P r
7176 @kindex M P r (Summary)
7177 @findex gnus-uu-mark-region
7178 Mark articles in region (@code{gnus-uu-mark-region}).
7179
7180 @item M P g
7181 @kindex M P g (Summary)
7182 @findex gnus-uu-unmark-region
7183 Unmark articles in region (@code{gnus-uu-unmark-region}).
7184
7185 @item M P t
7186 @kindex M P t (Summary)
7187 @findex gnus-uu-mark-thread
7188 Mark all articles in the current (sub)thread
7189 (@code{gnus-uu-mark-thread}).
7190
7191 @item M P T
7192 @kindex M P T (Summary)
7193 @findex gnus-uu-unmark-thread
7194 Unmark all articles in the current (sub)thread
7195 (@code{gnus-uu-unmark-thread}).
7196
7197 @item M P v
7198 @kindex M P v (Summary)
7199 @findex gnus-uu-mark-over
7200 Mark all articles that have a score above the prefix argument
7201 (@code{gnus-uu-mark-over}).
7202
7203 @item M P s
7204 @kindex M P s (Summary)
7205 @findex gnus-uu-mark-series
7206 Mark all articles in the current series (@code{gnus-uu-mark-series}).
7207
7208 @item M P S
7209 @kindex M P S (Summary)
7210 @findex gnus-uu-mark-sparse
7211 Mark all series that have already had some articles marked
7212 (@code{gnus-uu-mark-sparse}).
7213
7214 @item M P a
7215 @kindex M P a (Summary)
7216 @findex gnus-uu-mark-all
7217 Mark all articles in series order (@code{gnus-uu-mark-all}).
7218
7219 @item M P b
7220 @kindex M P b (Summary)
7221 @findex gnus-uu-mark-buffer
7222 Mark all articles in the buffer in the order they appear
7223 (@code{gnus-uu-mark-buffer}).
7224
7225 @item M P k
7226 @kindex M P k (Summary)
7227 @findex gnus-summary-kill-process-mark
7228 Push the current process mark set onto the stack and unmark all articles
7229 (@code{gnus-summary-kill-process-mark}).
7230
7231 @item M P y
7232 @kindex M P y (Summary)
7233 @findex gnus-summary-yank-process-mark
7234 Pop the previous process mark set from the stack and restore it
7235 (@code{gnus-summary-yank-process-mark}).
7236
7237 @item M P w
7238 @kindex M P w (Summary)
7239 @findex gnus-summary-save-process-mark
7240 Push the current process mark set onto the stack
7241 (@code{gnus-summary-save-process-mark}).
7242
7243 @end table
7244
7245 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
7246 set process marks based on article body contents.
7247
7248
7249 @node Limiting
7250 @section Limiting
7251 @cindex limiting
7252
7253 It can be convenient to limit the summary buffer to just show some
7254 subset of the articles currently in the group.  The effect most limit
7255 commands have is to remove a few (or many) articles from the summary
7256 buffer.
7257
7258 Limiting commands work on subsets of the articles already fetched from
7259 the servers.  These commands don't query the server for additional
7260 articles.
7261
7262 @table @kbd
7263
7264 @item / /
7265 @itemx / s
7266 @kindex / / (Summary)
7267 @findex gnus-summary-limit-to-subject
7268 Limit the summary buffer to articles that match some subject
7269 (@code{gnus-summary-limit-to-subject}).  If given a prefix, exclude
7270 matching articles.
7271
7272 @item / a
7273 @kindex / a (Summary)
7274 @findex gnus-summary-limit-to-author
7275 Limit the summary buffer to articles that match some author
7276 (@code{gnus-summary-limit-to-author}).  If given a prefix, exclude
7277 matching articles.
7278
7279 @item / R
7280 @kindex / R (Summary)
7281 @findex gnus-summary-limit-to-recipient
7282 Limit the summary buffer to articles that match some recipient
7283 (@code{gnus-summary-limit-to-recipient}).  If given a prefix, exclude
7284 matching articles.
7285
7286 @item / A
7287 @kindex / A (Summary)
7288 @findex gnus-summary-limit-to-address
7289 Limit the summary buffer to articles in which contents of From, To or Cc
7290 header match a given address (@code{gnus-summary-limit-to-address}).  If
7291 given a prefix, exclude matching articles.
7292
7293 @item / S
7294 @kindex / S (Summary)
7295 @findex gnus-summary-limit-to-singletons
7296 Limit the summary buffer to articles that aren't part of any displayed
7297 threads (@code{gnus-summary-limit-to-singletons}).  If given a prefix,
7298 limit to articles that are part of displayed threads.
7299
7300 @item / x
7301 @kindex / x (Summary)
7302 @findex gnus-summary-limit-to-extra
7303 Limit the summary buffer to articles that match one of the ``extra''
7304 headers (@pxref{To From Newsgroups})
7305 (@code{gnus-summary-limit-to-extra}).  If given a prefix, exclude
7306 matching articles.
7307
7308 @item / u
7309 @itemx x
7310 @kindex / u (Summary)
7311 @kindex x (Summary)
7312 @findex gnus-summary-limit-to-unread
7313 Limit the summary buffer to articles not marked as read
7314 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
7315 buffer to articles strictly unread.  This means that ticked and
7316 dormant articles will also be excluded.
7317
7318 @item / m
7319 @kindex / m (Summary)
7320 @findex gnus-summary-limit-to-marks
7321 Ask for a mark and then limit to all articles that have been marked
7322 with that mark (@code{gnus-summary-limit-to-marks}).
7323
7324 @item / t
7325 @kindex / t (Summary)
7326 @findex gnus-summary-limit-to-age
7327 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
7328 (@code{gnus-summary-limit-to-age}).  If given a prefix, limit to
7329 articles younger than that number of days.
7330
7331 @item / n
7332 @kindex / n (Summary)
7333 @findex gnus-summary-limit-to-articles
7334 With prefix @samp{n}, limit the summary buffer to the next @samp{n}
7335 articles.  If not given a prefix, use the process marked articles
7336 instead.  (@code{gnus-summary-limit-to-articles}).
7337
7338 @item / w
7339 @kindex / w (Summary)
7340 @findex gnus-summary-pop-limit
7341 Pop the previous limit off the stack and restore it
7342 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
7343 the stack.
7344
7345 @item / .
7346 @kindex / . (Summary)
7347 @findex gnus-summary-limit-to-unseen
7348 Limit the summary buffer to the unseen articles
7349 (@code{gnus-summary-limit-to-unseen}).
7350
7351 @item / v
7352 @kindex / v (Summary)
7353 @findex gnus-summary-limit-to-score
7354 Limit the summary buffer to articles that have a score at or above some
7355 score (@code{gnus-summary-limit-to-score}).
7356
7357 @item / p
7358 @kindex / p (Summary)
7359 @findex gnus-summary-limit-to-display-predicate
7360 Limit the summary buffer to articles that satisfy the @code{display}
7361 group parameter predicate
7362 (@code{gnus-summary-limit-to-display-predicate}).  @xref{Group
7363 Parameters}, for more on this predicate.
7364
7365 @item / r
7366 @kindex / r (Summary)
7367 @findex gnus-summary-limit-to-replied
7368 Limit the summary buffer to replied articles
7369 (@code{gnus-summary-limit-to-replied}).  If given a prefix, exclude
7370 replied articles.
7371
7372 @item / E
7373 @itemx M S
7374 @kindex M S (Summary)
7375 @kindex / E (Summary)
7376 @findex gnus-summary-limit-include-expunged
7377 Include all expunged articles in the limit
7378 (@code{gnus-summary-limit-include-expunged}).
7379
7380 @item / D
7381 @kindex / D (Summary)
7382 @findex gnus-summary-limit-include-dormant
7383 Include all dormant articles in the limit
7384 (@code{gnus-summary-limit-include-dormant}).
7385
7386 @item / *
7387 @kindex / * (Summary)
7388 @findex gnus-summary-limit-include-cached
7389 Include all cached articles in the limit
7390 (@code{gnus-summary-limit-include-cached}).
7391
7392 @item / d
7393 @kindex / d (Summary)
7394 @findex gnus-summary-limit-exclude-dormant
7395 Exclude all dormant articles from the limit
7396 (@code{gnus-summary-limit-exclude-dormant}).
7397
7398 @item / M
7399 @kindex / M (Summary)
7400 @findex gnus-summary-limit-exclude-marks
7401 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
7402
7403 @item / T
7404 @kindex / T (Summary)
7405 @findex gnus-summary-limit-include-thread
7406 Include all the articles in the current thread in the limit.
7407
7408 @item / c
7409 @kindex / c (Summary)
7410 @findex gnus-summary-limit-exclude-childless-dormant
7411 Exclude all dormant articles that have no children from the limit@*
7412 (@code{gnus-summary-limit-exclude-childless-dormant}).
7413
7414 @item / C
7415 @kindex / C (Summary)
7416 @findex gnus-summary-limit-mark-excluded-as-read
7417 Mark all excluded unread articles as read
7418 (@code{gnus-summary-limit-mark-excluded-as-read}).  If given a prefix,
7419 also mark excluded ticked and dormant articles as read.
7420
7421 @item / b
7422 @kindex / b (Summary)
7423 @findex gnus-summary-limit-to-bodies
7424 Limit the summary buffer to articles that have bodies that match a
7425 certain regexp (@code{gnus-summary-limit-to-bodies}).  If given a
7426 prefix, reverse the limit.  This command is quite slow since it
7427 requires selecting each article to find the matches.
7428
7429 @item / h
7430 @kindex / h (Summary)
7431 @findex gnus-summary-limit-to-headers
7432 Like the previous command, only limit to headers instead
7433 (@code{gnus-summary-limit-to-headers}).
7434
7435 @end table
7436
7437
7438 The following commands aren't limiting commands, but use the @kbd{/}
7439 prefix as well.
7440
7441 @table @kbd
7442 @item / N
7443 @kindex / N (Summary)
7444 @findex gnus-summary-insert-new-articles
7445 Insert all new articles in the summary buffer.  It scans for new emails
7446 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
7447
7448 @item / o
7449 @kindex / o (Summary)
7450 @findex gnus-summary-insert-old-articles
7451 Insert all old articles in the summary buffer.  If given a numbered
7452 prefix, fetch this number of articles.
7453
7454 @end table
7455
7456
7457 @node Threading
7458 @section Threading
7459 @cindex threading
7460 @cindex article threading
7461
7462 Gnus threads articles by default.  @dfn{To thread} is to put responses
7463 to articles directly after the articles they respond to---in a
7464 hierarchical fashion.
7465
7466 Threading is done by looking at the @code{References} headers of the
7467 articles.  In a perfect world, this would be enough to build pretty
7468 trees, but unfortunately, the @code{References} header is often broken
7469 or simply missing.  Weird news propagation exacerbates the problem,
7470 so one has to employ other heuristics to get pleasing results.  A
7471 plethora of approaches exists, as detailed in horrible detail in
7472 @ref{Customizing Threading}.
7473
7474 First, a quick overview of the concepts:
7475
7476 @table @dfn
7477 @item root
7478 The top-most article in a thread; the first article in the thread.
7479
7480 @item thread
7481 A tree-like article structure.
7482
7483 @item sub-thread
7484 A small(er) section of this tree-like structure.
7485
7486 @item loose threads
7487 Threads often lose their roots due to article expiry, or due to the root
7488 already having been read in a previous session, and not displayed in the
7489 summary buffer.  We then typically have many sub-threads that really
7490 belong to one thread, but are without connecting roots.  These are
7491 called loose threads.
7492
7493 @item thread gathering
7494 An attempt to gather loose threads into bigger threads.
7495
7496 @item sparse threads
7497 A thread where the missing articles have been ``guessed'' at, and are
7498 displayed as empty lines in the summary buffer.
7499
7500 @end table
7501
7502
7503 @menu
7504 * Customizing Threading::       Variables you can change to affect the threading.
7505 * Thread Commands::             Thread based commands in the summary buffer.
7506 @end menu
7507
7508
7509 @node Customizing Threading
7510 @subsection Customizing Threading
7511 @cindex customizing threading
7512
7513 @menu
7514 * Loose Threads::               How Gnus gathers loose threads into bigger threads.
7515 * Filling In Threads::          Making the threads displayed look fuller.
7516 * More Threading::              Even more variables for fiddling with threads.
7517 * Low-Level Threading::         You thought it was over@dots{} but you were wrong!
7518 @end menu
7519
7520
7521 @node Loose Threads
7522 @subsubsection Loose Threads
7523 @cindex <
7524 @cindex >
7525 @cindex loose threads
7526
7527 @table @code
7528 @item gnus-summary-make-false-root
7529 @vindex gnus-summary-make-false-root
7530 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
7531 and create a dummy root at the top.  (Wait a minute.  Root at the top?
7532 Yup.)  Loose subtrees occur when the real root has expired, or you've
7533 read or killed the root in a previous session.
7534
7535 When there is no real root of a thread, Gnus will have to fudge
7536 something.  This variable says what fudging method Gnus should use.
7537 There are four possible values:
7538
7539 @iftex
7540 @iflatex
7541 \gnusfigure{The Summary Buffer}{390}{
7542 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
7543 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
7544 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
7545 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
7546 }
7547 @end iflatex
7548 @end iftex
7549
7550 @cindex adopting articles
7551
7552 @table @code
7553
7554 @item adopt
7555 Gnus will make the first of the orphaned articles the parent.  This
7556 parent will adopt all the other articles.  The adopted articles will be
7557 marked as such by pointy brackets (@samp{<>}) instead of the standard
7558 square brackets (@samp{[]}).  This is the default method.
7559
7560 @item dummy
7561 @vindex gnus-summary-dummy-line-format
7562 @vindex gnus-summary-make-false-root-always
7563 Gnus will create a dummy summary line that will pretend to be the
7564 parent.  This dummy line does not correspond to any real article, so
7565 selecting it will just select the first real article after the dummy
7566 article.  @code{gnus-summary-dummy-line-format} is used to specify the
7567 format of the dummy roots.  It accepts only one format spec:  @samp{S},
7568 which is the subject of the article.  @xref{Formatting Variables}.
7569 If you want all threads to have a dummy root, even the non-gathered
7570 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
7571
7572 @item empty
7573 Gnus won't actually make any article the parent, but simply leave the
7574 subject field of all orphans except the first empty.  (Actually, it will
7575 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
7576 Buffer Format}).)
7577
7578 @item none
7579 Don't make any article parent at all.  Just gather the threads and
7580 display them after one another.
7581
7582 @item nil
7583 Don't gather loose threads.
7584 @end table
7585
7586 @item gnus-summary-gather-subject-limit
7587 @vindex gnus-summary-gather-subject-limit
7588 Loose threads are gathered by comparing subjects of articles.  If this
7589 variable is @code{nil}, Gnus requires an exact match between the
7590 subjects of the loose threads before gathering them into one big
7591 super-thread.  This might be too strict a requirement, what with the
7592 presence of stupid newsreaders that chop off long subject lines.  If
7593 you think so, set this variable to, say, 20 to require that only the
7594 first 20 characters of the subjects have to match.  If you set this
7595 variable to a really low number, you'll find that Gnus will gather
7596 everything in sight into one thread, which isn't very helpful.
7597
7598 @cindex fuzzy article gathering
7599 If you set this variable to the special value @code{fuzzy}, Gnus will
7600 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
7601 Matching}).
7602
7603 @item gnus-simplify-subject-fuzzy-regexp
7604 @vindex gnus-simplify-subject-fuzzy-regexp
7605 This can either be a regular expression or list of regular expressions
7606 that match strings that will be removed from subjects if fuzzy subject
7607 simplification is used.
7608
7609 @item gnus-simplify-ignored-prefixes
7610 @vindex gnus-simplify-ignored-prefixes
7611 If you set @code{gnus-summary-gather-subject-limit} to something as low
7612 as 10, you might consider setting this variable to something sensible:
7613
7614 @c Written by Michael Ernst <mernst@cs.rice.edu>
7615 @lisp
7616 (setq gnus-simplify-ignored-prefixes
7617       (concat
7618        "\\`\\[?\\("
7619        (mapconcat
7620         'identity
7621         '("looking"
7622           "wanted" "followup" "summary\\( of\\)?"
7623           "help" "query" "problem" "question"
7624           "answer" "reference" "announce"
7625           "How can I" "How to" "Comparison of"
7626           ;; ...
7627           )
7628         "\\|")
7629        "\\)\\s *\\("
7630        (mapconcat 'identity
7631                   '("for" "for reference" "with" "about")
7632                   "\\|")
7633        "\\)?\\]?:?[ \t]*"))
7634 @end lisp
7635
7636 All words that match this regexp will be removed before comparing two
7637 subjects.
7638
7639 @item gnus-simplify-subject-functions
7640 @vindex gnus-simplify-subject-functions
7641 If non-@code{nil}, this variable overrides
7642 @code{gnus-summary-gather-subject-limit}.  This variable should be a
7643 list of functions to apply to the @code{Subject} string iteratively to
7644 arrive at the simplified version of the string.
7645
7646 Useful functions to put in this list include:
7647
7648 @table @code
7649 @item gnus-simplify-subject-re
7650 @findex gnus-simplify-subject-re
7651 Strip the leading @samp{Re:}.
7652
7653 @item gnus-simplify-subject-fuzzy
7654 @findex gnus-simplify-subject-fuzzy
7655 Simplify fuzzily.
7656
7657 @item gnus-simplify-whitespace
7658 @findex gnus-simplify-whitespace
7659 Remove excessive whitespace.
7660
7661 @item gnus-simplify-all-whitespace
7662 @findex gnus-simplify-all-whitespace
7663 Remove all whitespace.
7664 @end table
7665
7666 You may also write your own functions, of course.
7667
7668
7669 @item gnus-summary-gather-exclude-subject
7670 @vindex gnus-summary-gather-exclude-subject
7671 Since loose thread gathering is done on subjects only, that might lead
7672 to many false hits, especially with certain common subjects like
7673 @samp{} and @samp{(none)}.  To make the situation slightly better,
7674 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
7675 what subjects should be excluded from the gathering process.@*
7676 The default is @samp{^ *$\\|^(none)$}.
7677
7678 @item gnus-summary-thread-gathering-function
7679 @vindex gnus-summary-thread-gathering-function
7680 Gnus gathers threads by looking at @code{Subject} headers.  This means
7681 that totally unrelated articles may end up in the same ``thread'', which
7682 is confusing.  An alternate approach is to look at all the
7683 @code{Message-ID}s in all the @code{References} headers to find matches.
7684 This will ensure that no gathered threads ever include unrelated
7685 articles, but it also means that people who have posted with broken
7686 newsreaders won't be gathered properly.  The choice is yours---plague or
7687 cholera:
7688
7689 @table @code
7690 @item gnus-gather-threads-by-subject
7691 @findex gnus-gather-threads-by-subject
7692 This function is the default gathering function and looks at
7693 @code{Subject}s exclusively.
7694
7695 @item gnus-gather-threads-by-references
7696 @findex gnus-gather-threads-by-references
7697 This function looks at @code{References} headers exclusively.
7698 @end table
7699
7700 If you want to test gathering by @code{References}, you could say
7701 something like:
7702
7703 @lisp
7704 (setq gnus-summary-thread-gathering-function
7705       'gnus-gather-threads-by-references)
7706 @end lisp
7707
7708 @end table
7709
7710
7711 @node Filling In Threads
7712 @subsubsection Filling In Threads
7713
7714 @table @code
7715 @item gnus-fetch-old-headers
7716 @vindex gnus-fetch-old-headers
7717 If non-@code{nil}, Gnus will attempt to build old threads by fetching
7718 more old headers---headers to articles marked as read.  If you would
7719 like to display as few summary lines as possible, but still connect as
7720 many loose threads as possible, you should set this variable to
7721 @code{some} or a number.  If you set it to a number, no more than that
7722 number of extra old headers will be fetched.  In either case, fetching
7723 old headers only works if the back end you are using carries overview
7724 files---this would normally be @code{nntp}, @code{nnspool},
7725 @code{nnml}, and @code{nnmaildir}.  Also remember that if the root of
7726 the thread has been expired by the server, there's not much Gnus can
7727 do about that.
7728
7729 This variable can also be set to @code{invisible}.  This won't have any
7730 visible effects, but is useful if you use the @kbd{A T} command a lot
7731 (@pxref{Finding the Parent}).
7732
7733 The server has to support @acronym{NOV} for any of this to work.
7734
7735 @cindex Gmane, gnus-fetch-old-headers
7736 This feature can seriously impact performance it ignores all locally
7737 cached header entries.  Setting it to @code{t} for groups for a server
7738 that doesn't expire articles (such as news.gmane.org), leads to very
7739 slow summary generation.
7740
7741 @item gnus-fetch-old-ephemeral-headers
7742 @vindex gnus-fetch-old-ephemeral-headers
7743 Same as @code{gnus-fetch-old-headers}, but only used for ephemeral
7744 newsgroups.
7745
7746 @item gnus-build-sparse-threads
7747 @vindex gnus-build-sparse-threads
7748 Fetching old headers can be slow.  A low-rent similar effect can be
7749 gotten by setting this variable to @code{some}.  Gnus will then look at
7750 the complete @code{References} headers of all articles and try to string
7751 together articles that belong in the same thread.  This will leave
7752 @dfn{gaps} in the threading display where Gnus guesses that an article
7753 is missing from the thread.  (These gaps appear like normal summary
7754 lines.  If you select a gap, Gnus will try to fetch the article in
7755 question.)  If this variable is @code{t}, Gnus will display all these
7756 ``gaps'' without regard for whether they are useful for completing the
7757 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
7758 off sparse leaf nodes that don't lead anywhere.  This variable is
7759 @code{nil} by default.
7760
7761 @item gnus-read-all-available-headers
7762 @vindex gnus-read-all-available-headers
7763 This is a rather obscure variable that few will find useful.  It's
7764 intended for those non-news newsgroups where the back end has to fetch
7765 quite a lot to present the summary buffer, and where it's impossible to
7766 go back to parents of articles.  This is mostly the case in the
7767 web-based groups.
7768
7769 If you don't use those, then it's safe to leave this as the default
7770 @code{nil}.  If you want to use this variable, it should be a regexp
7771 that matches the group name, or @code{t} for all groups.
7772
7773 @end table
7774
7775
7776 @node More Threading
7777 @subsubsection More Threading
7778
7779 @table @code
7780 @item gnus-show-threads
7781 @vindex gnus-show-threads
7782 If this variable is @code{nil}, no threading will be done, and all of
7783 the rest of the variables here will have no effect.  Turning threading
7784 off will speed group selection up a bit, but it is sure to make reading
7785 slower and more awkward.
7786
7787 @item gnus-thread-hide-subtree
7788 @vindex gnus-thread-hide-subtree
7789 If non-@code{nil}, all threads will be hidden when the summary buffer is
7790 generated.
7791
7792 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
7793 Available predicates are @code{gnus-article-unread-p} and
7794 @code{gnus-article-unseen-p}.
7795
7796 Here's an example:
7797
7798 @lisp
7799 (setq gnus-thread-hide-subtree
7800       '(or gnus-article-unread-p
7801            gnus-article-unseen-p))
7802 @end lisp
7803
7804 (It's a pretty nonsensical example, since all unseen articles are also
7805 unread, but you get my drift.)
7806
7807
7808 @item gnus-thread-expunge-below
7809 @vindex gnus-thread-expunge-below
7810 All threads that have a total score (as defined by
7811 @code{gnus-thread-score-function}) less than this number will be
7812 expunged.  This variable is @code{nil} by default, which means that no
7813 threads are expunged.
7814
7815 @item gnus-thread-hide-killed
7816 @vindex gnus-thread-hide-killed
7817 if you kill a thread and this variable is non-@code{nil}, the subtree
7818 will be hidden.
7819
7820 @item gnus-thread-ignore-subject
7821 @vindex gnus-thread-ignore-subject
7822 Sometimes somebody changes the subject in the middle of a thread.  If
7823 this variable is non-@code{nil}, which is the default, the subject
7824 change is ignored.  If it is @code{nil}, a change in the subject will
7825 result in a new thread.
7826
7827 @item gnus-thread-indent-level
7828 @vindex gnus-thread-indent-level
7829 This is a number that says how much each sub-thread should be indented.
7830 The default is 4.
7831
7832 @item gnus-sort-gathered-threads-function
7833 @vindex gnus-sort-gathered-threads-function
7834 Sometimes, particularly with mailing lists, the order in which mails
7835 arrive locally is not necessarily the same as the order in which they
7836 arrived on the mailing list.  Consequently, when sorting sub-threads
7837 using the default @code{gnus-thread-sort-by-number}, responses can end
7838 up appearing before the article to which they are responding to.
7839 Setting this variable to an alternate value
7840 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
7841 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
7842 more logical sub-thread ordering in such instances.
7843
7844 @end table
7845
7846
7847 @node Low-Level Threading
7848 @subsubsection Low-Level Threading
7849
7850 @table @code
7851
7852 @item gnus-parse-headers-hook
7853 @vindex gnus-parse-headers-hook
7854 Hook run before parsing any headers.
7855
7856 @item gnus-alter-header-function
7857 @vindex gnus-alter-header-function
7858 If non-@code{nil}, this function will be called to allow alteration of
7859 article header structures.  The function is called with one parameter,
7860 the article header vector, which it may alter in any way.  For instance,
7861 if you have a mail-to-news gateway which alters the @code{Message-ID}s
7862 in systematic ways (by adding prefixes and such), you can use this
7863 variable to un-scramble the @code{Message-ID}s so that they are more
7864 meaningful.  Here's one example:
7865
7866 @lisp
7867 (setq gnus-alter-header-function 'my-alter-message-id)
7868
7869 (defun my-alter-message-id (header)
7870   (let ((id (mail-header-id header)))
7871     (when (string-match
7872            "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
7873       (mail-header-set-id
7874        (concat (match-string 1 id) "@@" (match-string 2 id))
7875        header))))
7876 @end lisp
7877
7878 @end table
7879
7880
7881 @node Thread Commands
7882 @subsection Thread Commands
7883 @cindex thread commands
7884
7885 @table @kbd
7886
7887 @item T k
7888 @itemx C-M-k
7889 @kindex T k (Summary)
7890 @kindex C-M-k (Summary)
7891 @findex gnus-summary-kill-thread
7892 Mark all articles in the current (sub-)thread as read
7893 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
7894 remove all marks instead.  If the prefix argument is negative, tick
7895 articles instead.
7896
7897 @item T l
7898 @itemx C-M-l
7899 @kindex T l (Summary)
7900 @kindex C-M-l (Summary)
7901 @findex gnus-summary-lower-thread
7902 Lower the score of the current (sub-)thread
7903 (@code{gnus-summary-lower-thread}).
7904
7905 @item T i
7906 @kindex T i (Summary)
7907 @findex gnus-summary-raise-thread
7908 Increase the score of the current (sub-)thread
7909 (@code{gnus-summary-raise-thread}).
7910
7911 @item T #
7912 @kindex T # (Summary)
7913 @findex gnus-uu-mark-thread
7914 Set the process mark on the current (sub-)thread
7915 (@code{gnus-uu-mark-thread}).
7916
7917 @item T M-#
7918 @kindex T M-# (Summary)
7919 @findex gnus-uu-unmark-thread
7920 Remove the process mark from the current (sub-)thread
7921 (@code{gnus-uu-unmark-thread}).
7922
7923 @item T T
7924 @kindex T T (Summary)
7925 @findex gnus-summary-toggle-threads
7926 Toggle threading (@code{gnus-summary-toggle-threads}).
7927
7928 @item T s
7929 @kindex T s (Summary)
7930 @findex gnus-summary-show-thread
7931 Expose the (sub-)thread hidden under the current article, if any@*
7932 (@code{gnus-summary-show-thread}).
7933
7934 @item T h
7935 @kindex T h (Summary)
7936 @findex gnus-summary-hide-thread
7937 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
7938
7939 @item T S
7940 @kindex T S (Summary)
7941 @findex gnus-summary-show-all-threads
7942 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
7943
7944 @item T H
7945 @kindex T H (Summary)
7946 @findex gnus-summary-hide-all-threads
7947 Hide all threads (@code{gnus-summary-hide-all-threads}).
7948
7949 @item T t
7950 @kindex T t (Summary)
7951 @findex gnus-summary-rethread-current
7952 Re-thread the current article's thread
7953 (@code{gnus-summary-rethread-current}).  This works even when the
7954 summary buffer is otherwise unthreaded.
7955
7956 @item T ^
7957 @kindex T ^ (Summary)
7958 @findex gnus-summary-reparent-thread
7959 Make the current article the child of the marked (or previous) article
7960 (@code{gnus-summary-reparent-thread}).
7961
7962 @item T M-^
7963 @kindex T M-^ (Summary)
7964 @findex gnus-summary-reparent-children
7965 Make the current article the parent of the marked articles
7966 (@code{gnus-summary-reparent-children}).
7967
7968 @end table
7969
7970 The following commands are thread movement commands.  They all
7971 understand the numeric prefix.
7972
7973 @table @kbd
7974
7975 @item T n
7976 @kindex T n (Summary)
7977 @itemx C-M-f
7978 @kindex C-M-n (Summary)
7979 @itemx M-down
7980 @kindex M-down (Summary)
7981 @findex gnus-summary-next-thread
7982 Go to the next thread (@code{gnus-summary-next-thread}).
7983
7984 @item T p
7985 @kindex T p (Summary)
7986 @itemx C-M-b
7987 @kindex C-M-p (Summary)
7988 @itemx M-up
7989 @kindex M-up (Summary)
7990 @findex gnus-summary-prev-thread
7991 Go to the previous thread (@code{gnus-summary-prev-thread}).
7992
7993 @item T d
7994 @kindex T d (Summary)
7995 @findex gnus-summary-down-thread
7996 Descend the thread (@code{gnus-summary-down-thread}).
7997
7998 @item T u
7999 @kindex T u (Summary)
8000 @findex gnus-summary-up-thread
8001 Ascend the thread (@code{gnus-summary-up-thread}).
8002
8003 @item T o
8004 @kindex T o (Summary)
8005 @findex gnus-summary-top-thread
8006 Go to the top of the thread (@code{gnus-summary-top-thread}).
8007 @end table
8008
8009 @vindex gnus-thread-operation-ignore-subject
8010 If you ignore subject while threading, you'll naturally end up with
8011 threads that have several different subjects in them.  If you then issue
8012 a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not
8013 wish to kill the entire thread, but just those parts of the thread that
8014 have the same subject as the current article.  If you like this idea,
8015 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If it
8016 is non-@code{nil} (which it is by default), subjects will be ignored
8017 when doing thread commands.  If this variable is @code{nil}, articles in
8018 the same thread with different subjects will not be included in the
8019 operation in question.  If this variable is @code{fuzzy}, only articles
8020 that have subjects fuzzily equal will be included (@pxref{Fuzzy
8021 Matching}).
8022
8023
8024 @node Sorting the Summary Buffer
8025 @section Sorting the Summary Buffer
8026
8027 @findex gnus-thread-sort-by-total-score
8028 @findex gnus-thread-sort-by-date
8029 @findex gnus-thread-sort-by-score
8030 @findex gnus-thread-sort-by-subject
8031 @findex gnus-thread-sort-by-author
8032 @findex gnus-thread-sort-by-recipient
8033 @findex gnus-thread-sort-by-number
8034 @findex gnus-thread-sort-by-random
8035 @vindex gnus-thread-sort-functions
8036 @findex gnus-thread-sort-by-most-recent-number
8037 @findex gnus-thread-sort-by-most-recent-date
8038 If you are using a threaded summary display, you can sort the threads by
8039 setting @code{gnus-thread-sort-functions}, which can be either a single
8040 function, a list of functions, or a list containing functions and
8041 @code{(not some-function)} elements.
8042
8043 By default, sorting is done on article numbers.  Ready-made sorting
8044 predicate functions include @code{gnus-thread-sort-by-number},
8045 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-recipient},
8046 @code{gnus-thread-sort-by-subject},
8047 @code{gnus-thread-sort-by-date},
8048 @code{gnus-thread-sort-by-score},
8049 @code{gnus-thread-sort-by-most-recent-number},
8050 @code{gnus-thread-sort-by-most-recent-date},
8051 @code{gnus-thread-sort-by-random} and
8052 @code{gnus-thread-sort-by-total-score}.
8053
8054 Each function takes two threads and returns non-@code{nil} if the first
8055 thread should be sorted before the other.  Note that sorting really is
8056 normally done by looking only at the roots of each thread.
8057
8058 If you use more than one function, the primary sort key should be the
8059 last function in the list.  You should probably always include
8060 @code{gnus-thread-sort-by-number} in the list of sorting
8061 functions---preferably first.  This will ensure that threads that are
8062 equal with respect to the other sort criteria will be displayed in
8063 ascending article order.
8064
8065 If you would like to sort by reverse score, then by subject, and finally
8066 by number, you could do something like:
8067
8068 @lisp
8069 (setq gnus-thread-sort-functions
8070       '(gnus-thread-sort-by-number
8071         gnus-thread-sort-by-subject
8072         (not gnus-thread-sort-by-total-score)))
8073 @end lisp
8074
8075 The threads that have highest score will be displayed first in the
8076 summary buffer.  When threads have the same score, they will be sorted
8077 alphabetically.  The threads that have the same score and the same
8078 subject will be sorted by number, which is (normally) the sequence in
8079 which the articles arrived.
8080
8081 If you want to sort by score and then reverse arrival order, you could
8082 say something like:
8083
8084 @lisp
8085 (setq gnus-thread-sort-functions
8086       '((not gnus-thread-sort-by-number)
8087         gnus-thread-sort-by-score))
8088 @end lisp
8089
8090 @vindex gnus-thread-score-function
8091 The function in the @code{gnus-thread-score-function} variable (default
8092 @code{+}) is used for calculating the total score of a thread.  Useful
8093 functions might be @code{max}, @code{min}, or squared means, or whatever
8094 tickles your fancy.
8095
8096 @findex gnus-article-sort-functions
8097 @findex gnus-article-sort-by-date
8098 @findex gnus-article-sort-by-most-recent-date
8099 @findex gnus-article-sort-by-score
8100 @findex gnus-article-sort-by-subject
8101 @findex gnus-article-sort-by-author
8102 @findex gnus-article-sort-by-random
8103 @findex gnus-article-sort-by-number
8104 @findex gnus-article-sort-by-most-recent-number
8105 If you are using an unthreaded display for some strange reason or
8106 other, you have to fiddle with the @code{gnus-article-sort-functions}
8107 variable.  It is very similar to the
8108 @code{gnus-thread-sort-functions}, except that it uses slightly
8109 different functions for article comparison.  Available sorting
8110 predicate functions are @code{gnus-article-sort-by-number},
8111 @code{gnus-article-sort-by-author},
8112 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
8113 @code{gnus-article-sort-by-random}, and
8114 @code{gnus-article-sort-by-score}.
8115
8116 If you want to sort an unthreaded summary display by subject, you could
8117 say something like:
8118
8119 @lisp
8120 (setq gnus-article-sort-functions
8121       '(gnus-article-sort-by-number
8122         gnus-article-sort-by-subject))
8123 @end lisp
8124
8125 You can define group specific sorting via @code{gnus-parameters},
8126 @xref{Group Parameters}.
8127
8128
8129 @node Asynchronous Fetching
8130 @section Asynchronous Article Fetching
8131 @cindex asynchronous article fetching
8132 @cindex article pre-fetch
8133 @cindex pre-fetch
8134
8135 If you read your news from an @acronym{NNTP} server that's far away, the
8136 network latencies may make reading articles a chore.  You have to wait
8137 for a while after pressing @kbd{n} to go to the next article before the
8138 article appears.  Why can't Gnus just go ahead and fetch the article
8139 while you are reading the previous one?  Why not, indeed.
8140
8141 First, some caveats.  There are some pitfalls to using asynchronous
8142 article fetching, especially the way Gnus does it.
8143
8144 Let's say you are reading article 1, which is short, and article 2 is
8145 quite long, and you are not interested in reading that.  Gnus does not
8146 know this, so it goes ahead and fetches article 2.  You decide to read
8147 article 3, but since Gnus is in the process of fetching article 2, the
8148 connection is blocked.
8149
8150 To avoid these situations, Gnus will open two (count 'em two)
8151 connections to the server.  Some people may think this isn't a very nice
8152 thing to do, but I don't see any real alternatives.  Setting up that
8153 extra connection takes some time, so Gnus startup will be slower.
8154
8155 Gnus will fetch more articles than you will read.  This will mean that
8156 the link between your machine and the @acronym{NNTP} server will become more
8157 loaded than if you didn't use article pre-fetch.  The server itself will
8158 also become more loaded---both with the extra article requests, and the
8159 extra connection.
8160
8161 Ok, so now you know that you shouldn't really use this thing@dots{} unless
8162 you really want to.
8163
8164 @vindex gnus-asynchronous
8165 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
8166 happen automatically.
8167
8168 @vindex gnus-use-article-prefetch
8169 You can control how many articles are to be pre-fetched by setting
8170 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
8171 that when you read an article in the group, the back end will pre-fetch
8172 the next 30 articles.  If this variable is @code{t}, the back end will
8173 pre-fetch all the articles it can without bound.  If it is
8174 @code{nil}, no pre-fetching will be done.
8175
8176 @vindex gnus-async-prefetch-article-p
8177 @findex gnus-async-unread-p
8178 There are probably some articles that you don't want to pre-fetch---read
8179 articles, for instance.  The @code{gnus-async-prefetch-article-p}
8180 variable controls whether an article is to be pre-fetched.  This
8181 function should return non-@code{nil} when the article in question is
8182 to be pre-fetched.  The default is @code{gnus-async-unread-p}, which
8183 returns @code{nil} on read articles.  The function is called with an
8184 article data structure as the only parameter.
8185
8186 If, for instance, you wish to pre-fetch only unread articles shorter
8187 than 100 lines, you could say something like:
8188
8189 @lisp
8190 (defun my-async-short-unread-p (data)
8191   "Return non-nil for short, unread articles."
8192   (and (gnus-data-unread-p data)
8193        (< (mail-header-lines (gnus-data-header data))
8194           100)))
8195
8196 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
8197 @end lisp
8198
8199 These functions will be called many, many times, so they should
8200 preferably be short and sweet to avoid slowing down Gnus too much.
8201 It's probably a good idea to byte-compile things like this.
8202
8203 @vindex gnus-async-post-fetch-function
8204 @findex gnus-html-prefetch-images
8205 After an article has been prefetched, this
8206 @code{gnus-async-post-fetch-function} will be called.  The buffer will
8207 be narrowed to the region of the article that was fetched.  A useful
8208 value would be @code{gnus-html-prefetch-images}, which will prefetch
8209 and store images referenced in the article, so that you don't have to
8210 wait for them to be fetched when you read the article.  This is useful
8211 for @acronym{HTML} messages that have external images.
8212
8213 @vindex gnus-prefetched-article-deletion-strategy
8214 Articles have to be removed from the asynch buffer sooner or later.  The
8215 @code{gnus-prefetched-article-deletion-strategy} says when to remove
8216 articles.  This is a list that may contain the following elements:
8217
8218 @table @code
8219 @item read
8220 Remove articles when they are read.
8221
8222 @item exit
8223 Remove articles when exiting the group.
8224 @end table
8225
8226 The default value is @code{(read exit)}.
8227
8228 @c @vindex gnus-use-header-prefetch
8229 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
8230 @c from the next group.
8231
8232
8233 @node Article Caching
8234 @section Article Caching
8235 @cindex article caching
8236 @cindex caching
8237
8238 If you have an @emph{extremely} slow @acronym{NNTP} connection, you may
8239 consider turning article caching on.  Each article will then be stored
8240 locally under your home directory.  As you may surmise, this could
8241 potentially use @emph{huge} amounts of disk space, as well as eat up all
8242 your inodes so fast it will make your head swim.  In vodka.
8243
8244 Used carefully, though, it could be just an easier way to save articles.
8245
8246 @vindex gnus-use-long-file-name
8247 @vindex gnus-cache-directory
8248 @vindex gnus-use-cache
8249 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
8250 all articles ticked or marked as dormant will then be copied
8251 over to your local cache (@code{gnus-cache-directory}).  Whether this
8252 cache is flat or hierarchical is controlled by the
8253 @code{gnus-use-long-file-name} variable, as usual.
8254
8255 When re-selecting a ticked or dormant article, it will be fetched from the
8256 cache instead of from the server.  As articles in your cache will never
8257 expire, this might serve as a method of saving articles while still
8258 keeping them where they belong.  Just mark all articles you want to save
8259 as dormant, and don't worry.
8260
8261 When an article is marked as read, is it removed from the cache.
8262
8263 @vindex gnus-cache-remove-articles
8264 @vindex gnus-cache-enter-articles
8265 The entering/removal of articles from the cache is controlled by the
8266 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
8267 variables.  Both are lists of symbols.  The first is @code{(ticked
8268 dormant)} by default, meaning that ticked and dormant articles will be
8269 put in the cache.  The latter is @code{(read)} by default, meaning that
8270 articles marked as read are removed from the cache.  Possibly
8271 symbols in these two lists are @code{ticked}, @code{dormant},
8272 @code{unread} and @code{read}.
8273
8274 @findex gnus-jog-cache
8275 So where does the massive article-fetching and storing come into the
8276 picture?  The @code{gnus-jog-cache} command will go through all
8277 subscribed newsgroups, request all unread articles, score them, and
8278 store them in the cache.  You should only ever, ever ever ever, use this
8279 command if 1) your connection to the @acronym{NNTP} server is really, really,
8280 really slow and 2) you have a really, really, really huge disk.
8281 Seriously.  One way to cut down on the number of articles downloaded is
8282 to score unwanted articles down and have them marked as read.  They will
8283 not then be downloaded by this command.
8284
8285 @vindex gnus-uncacheable-groups
8286 @vindex gnus-cacheable-groups
8287 It is likely that you do not want caching on all groups.  For instance,
8288 if your @code{nnml} mail is located under your home directory, it makes no
8289 sense to cache it somewhere else under your home directory.  Unless you
8290 feel that it's neat to use twice as much space.
8291
8292 To limit the caching, you could set @code{gnus-cacheable-groups} to a
8293 regexp of groups to cache, @samp{^nntp} for instance, or set the
8294 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
8295 Both variables are @code{nil} by default.  If a group matches both
8296 variables, the group is not cached.
8297
8298 @findex gnus-cache-generate-nov-databases
8299 @findex gnus-cache-generate-active
8300 @vindex gnus-cache-active-file
8301 The cache stores information on what articles it contains in its active
8302 file (@code{gnus-cache-active-file}).  If this file (or any other parts
8303 of the cache) becomes all messed up for some reason or other, Gnus
8304 offers two functions that will try to set things right.  @kbd{M-x
8305 gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV}
8306 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
8307 file.
8308
8309 @findex gnus-cache-move-cache
8310 @code{gnus-cache-move-cache} will move your whole
8311 @code{gnus-cache-directory} to some other location.  You get asked to
8312 where, isn't that cool?
8313
8314 @node Persistent Articles
8315 @section Persistent Articles
8316 @cindex persistent articles
8317
8318 Closely related to article caching, we have @dfn{persistent articles}.
8319 In fact, it's just a different way of looking at caching, and much more
8320 useful in my opinion.
8321
8322 Say you're reading a newsgroup, and you happen on to some valuable gem
8323 that you want to keep and treasure forever.  You'd normally just save it
8324 (using one of the many saving commands) in some file.  The problem with
8325 that is that it's just, well, yucky.  Ideally you'd prefer just having
8326 the article remain in the group where you found it forever; untouched by
8327 the expiry going on at the news server.
8328
8329 This is what a @dfn{persistent article} is---an article that just won't
8330 be deleted.  It's implemented using the normal cache functions, but
8331 you use two explicit commands for managing persistent articles:
8332
8333 @table @kbd
8334
8335 @item *
8336 @kindex * (Summary)
8337 @findex gnus-cache-enter-article
8338 Make the current article persistent (@code{gnus-cache-enter-article}).
8339
8340 @item M-*
8341 @kindex M-* (Summary)
8342 @findex gnus-cache-remove-article
8343 Remove the current article from the persistent articles
8344 (@code{gnus-cache-remove-article}).  This will normally delete the
8345 article.
8346 @end table
8347
8348 Both these commands understand the process/prefix convention.
8349
8350 To avoid having all ticked articles (and stuff) entered into the cache,
8351 you should set @code{gnus-use-cache} to @code{passive} if you're just
8352 interested in persistent articles:
8353
8354 @lisp
8355 (setq gnus-use-cache 'passive)
8356 @end lisp
8357
8358 @node Sticky Articles
8359 @section Sticky Articles
8360 @cindex sticky articles
8361
8362 When you select an article the current article buffer will be reused
8363 according to the value of the variable
8364 @code{gnus-single-article-buffer}.  If its value is non-@code{nil} (the
8365 default) all articles reuse the same article buffer.  Else each group
8366 has its own article buffer.
8367
8368 This implies that it's not possible to have more than one article buffer
8369 in a group at a time.  But sometimes you might want to display all the
8370 latest emails from your mother, your father, your aunt, your uncle and
8371 your 17 cousins to coordinate the next christmas party.
8372
8373 That's where sticky articles come in handy.  A sticky article buffer
8374 basically is a normal article buffer, but it won't be reused when you
8375 select another article.  You can make an article sticky with:
8376
8377 @table @kbd
8378 @item A S
8379 @kindex A S (Summary)
8380 @findex gnus-sticky-article
8381 Make the current article sticky.  If a prefix arg is given, ask for a
8382 name for this sticky article buffer.
8383 @end table
8384
8385 To close a sticky article buffer you can use these commands:
8386
8387 @table @kbd
8388 @item q
8389 @kindex q (Article)
8390 @findex bury-buffer
8391 Puts this sticky article buffer at the end of the list of all buffers.
8392
8393 @item k
8394 @kindex k (Article)
8395 @findex gnus-kill-sticky-article-buffer
8396 Kills this sticky article buffer.
8397 @end table
8398
8399 To kill all sticky article buffers you can use:
8400
8401 @defun gnus-kill-sticky-article-buffers ARG
8402 Kill all sticky article buffers.
8403 If a prefix ARG is given, ask for confirmation.
8404 @end defun
8405
8406 @node Article Backlog
8407 @section Article Backlog
8408 @cindex backlog
8409 @cindex article backlog
8410
8411 If you have a slow connection, but the idea of using caching seems
8412 unappealing to you (and it is, really), you can help the situation some
8413 by switching on the @dfn{backlog}.  This is where Gnus will buffer
8414 already read articles so that it doesn't have to re-fetch articles
8415 you've already read.  This only helps if you are in the habit of
8416 re-selecting articles you've recently read, of course.  If you never do
8417 that, turning the backlog on will slow Gnus down a little bit, and
8418 increase memory usage some.
8419
8420 @vindex gnus-keep-backlog
8421 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
8422 at most @var{n} old articles in a buffer for later re-fetching.  If this
8423 variable is non-@code{nil} and is not a number, Gnus will store
8424 @emph{all} read articles, which means that your Emacs will grow without
8425 bound before exploding and taking your machine down with you.  I put
8426 that in there just to keep y'all on your toes.
8427
8428 The default value is 20.
8429
8430
8431 @node Saving Articles
8432 @section Saving Articles
8433 @cindex saving articles
8434
8435 Gnus can save articles in a number of ways.  Below is the documentation
8436 for saving articles in a fairly straight-forward fashion (i.e., little
8437 processing of the article is done before it is saved).  For a different
8438 approach (uudecoding, unsharing) you should use @code{gnus-uu}
8439 (@pxref{Decoding Articles}).
8440
8441 For the commands listed here, the target is a file.  If you want to
8442 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
8443 command (@pxref{Mail Group Commands}).
8444
8445 @vindex gnus-save-all-headers
8446 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
8447 unwanted headers before saving the article.
8448
8449 @vindex gnus-saved-headers
8450 If the preceding variable is @code{nil}, all headers that match the
8451 @code{gnus-saved-headers} regexp will be kept, while the rest will be
8452 deleted before saving.
8453
8454 @table @kbd
8455
8456 @item O o
8457 @itemx o
8458 @kindex O o (Summary)
8459 @kindex o (Summary)
8460 @findex gnus-summary-save-article
8461 @c @icon{gnus-summary-save-article}
8462 Save the current article using the default article saver
8463 (@code{gnus-summary-save-article}).
8464
8465 @item O m
8466 @kindex O m (Summary)
8467 @findex gnus-summary-save-article-mail
8468 Save the current article in a Unix mail box (mbox) file
8469 (@code{gnus-summary-save-article-mail}).
8470
8471 @item O r
8472 @kindex O r (Summary)
8473 @findex gnus-summary-save-article-rmail
8474 Save the current article in Rmail format
8475 (@code{gnus-summary-save-article-rmail}).  This is mbox since Emacs 23,
8476 Babyl in older versions.
8477
8478 @item O f
8479 @kindex O f (Summary)
8480 @findex gnus-summary-save-article-file
8481 @c @icon{gnus-summary-save-article-file}
8482 Save the current article in plain file format
8483 (@code{gnus-summary-save-article-file}).
8484
8485 @item O F
8486 @kindex O F (Summary)
8487 @findex gnus-summary-write-article-file
8488 Write the current article in plain file format, overwriting any previous
8489 file contents (@code{gnus-summary-write-article-file}).
8490
8491 @item O b
8492 @kindex O b (Summary)
8493 @findex gnus-summary-save-article-body-file
8494 Save the current article body in plain file format
8495 (@code{gnus-summary-save-article-body-file}).
8496
8497 @item O h
8498 @kindex O h (Summary)
8499 @findex gnus-summary-save-article-folder
8500 Save the current article in mh folder format
8501 (@code{gnus-summary-save-article-folder}).
8502
8503 @item O v
8504 @kindex O v (Summary)
8505 @findex gnus-summary-save-article-vm
8506 Save the current article in a VM folder
8507 (@code{gnus-summary-save-article-vm}).
8508
8509 @item O p
8510 @itemx |
8511 @kindex O p (Summary)
8512 @kindex | (Summary)
8513 @findex gnus-summary-pipe-output
8514 @vindex gnus-summary-pipe-output-default-command
8515 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
8516 the current article to a process (@code{gnus-summary-pipe-output}).
8517 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
8518 complete headers in the piped output.  The symbolic prefix @code{r} is
8519 special; it lets this command pipe a raw article including all headers.
8520 The @code{gnus-summary-pipe-output-default-command} variable can be set
8521 to a string containing the default command and options (default
8522 @code{nil}).
8523
8524 @item O P
8525 @kindex O P (Summary)
8526 @findex gnus-summary-muttprint
8527 @vindex gnus-summary-muttprint-program
8528 Save the current article into muttprint.  That is, print it using the
8529 external program @uref{http://muttprint.sourceforge.net/,
8530 Muttprint}.  The program name and options to use is controlled by the
8531 variable @code{gnus-summary-muttprint-program}.
8532 (@code{gnus-summary-muttprint}).
8533
8534 @end table
8535
8536 @vindex gnus-prompt-before-saving
8537 All these commands use the process/prefix convention
8538 (@pxref{Process/Prefix}).  If you save bunches of articles using these
8539 functions, you might get tired of being prompted for files to save each
8540 and every article in.  The prompting action is controlled by
8541 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
8542 default, giving you that excessive prompting action you know and
8543 loathe.  If you set this variable to @code{t} instead, you'll be prompted
8544 just once for each series of articles you save.  If you like to really
8545 have Gnus do all your thinking for you, you can even set this variable
8546 to @code{nil}, which means that you will never be prompted for files to
8547 save articles in.  Gnus will simply save all the articles in the default
8548 files.
8549
8550
8551 @vindex gnus-default-article-saver
8552 You can customize the @code{gnus-default-article-saver} variable to make
8553 Gnus do what you want it to.  You can use any of the eight ready-made
8554 functions below, or you can create your own.
8555
8556 @table @code
8557
8558 @item gnus-summary-save-in-rmail
8559 @findex gnus-summary-save-in-rmail
8560 @vindex gnus-rmail-save-name
8561 @findex gnus-plain-save-name
8562 This is the default format, that used by the Rmail package.  Since Emacs
8563 23, Rmail uses standard mbox format.  Before this, it used the
8564 @dfn{Babyl} format.  Accordingly, this command writes mbox format since
8565 Emacs 23, unless appending to an existing Babyl file.  In older versions
8566 of Emacs, it always uses Babyl format.  Uses the function in the
8567 @code{gnus-rmail-save-name} variable to get a file name to save the
8568 article in.  The default is @code{gnus-plain-save-name}.
8569
8570 @item gnus-summary-save-in-mail
8571 @findex gnus-summary-save-in-mail
8572 @vindex gnus-mail-save-name
8573 Save in a Unix mail (mbox) file.  Uses the function in the
8574 @code{gnus-mail-save-name} variable to get a file name to save the
8575 article in.  The default is @code{gnus-plain-save-name}.
8576
8577 @item gnus-summary-save-in-file
8578 @findex gnus-summary-save-in-file
8579 @vindex gnus-file-save-name
8580 @findex gnus-numeric-save-name
8581 Append the article straight to an ordinary file.  Uses the function in
8582 the @code{gnus-file-save-name} variable to get a file name to save the
8583 article in.  The default is @code{gnus-numeric-save-name}.
8584
8585 @item gnus-summary-write-to-file
8586 @findex gnus-summary-write-to-file
8587 Write the article straight to an ordinary file.  The file is
8588 overwritten if it exists.  Uses the function in the
8589 @code{gnus-file-save-name} variable to get a file name to save the
8590 article in.  The default is @code{gnus-numeric-save-name}.
8591
8592 @item gnus-summary-save-body-in-file
8593 @findex gnus-summary-save-body-in-file
8594 Append the article body to an ordinary file.  Uses the function in the
8595 @code{gnus-file-save-name} variable to get a file name to save the
8596 article in.  The default is @code{gnus-numeric-save-name}.
8597
8598 @item gnus-summary-write-body-to-file
8599 @findex gnus-summary-write-body-to-file
8600 Write the article body straight to an ordinary file.  The file is
8601 overwritten if it exists.  Uses the function in the
8602 @code{gnus-file-save-name} variable to get a file name to save the
8603 article in.  The default is @code{gnus-numeric-save-name}.
8604
8605 @item gnus-summary-save-in-folder
8606 @findex gnus-summary-save-in-folder
8607 @findex gnus-folder-save-name
8608 @findex gnus-Folder-save-name
8609 @vindex gnus-folder-save-name
8610 @cindex rcvstore
8611 @cindex MH folders
8612 Save the article to an MH folder using @code{rcvstore} from the MH
8613 library.  Uses the function in the @code{gnus-folder-save-name} variable
8614 to get a file name to save the article in.  The default is
8615 @code{gnus-folder-save-name}, but you can also use
8616 @code{gnus-Folder-save-name}, which creates capitalized names.
8617
8618 @item gnus-summary-save-in-vm
8619 @findex gnus-summary-save-in-vm
8620 Save the article in a VM folder.  You have to have the VM mail
8621 reader to use this setting.
8622
8623 @item gnus-summary-save-in-pipe
8624 @findex gnus-summary-save-in-pipe
8625 Pipe the article to a shell command.  This function takes optional two
8626 arguments COMMAND and RAW.  Valid values for COMMAND include:
8627
8628 @itemize @bullet
8629 @item a string@*
8630 The executable command name and possibly arguments.
8631 @item @code{nil}@*
8632 You will be prompted for the command in the minibuffer.
8633 @item the symbol @code{default}@*
8634 It will be replaced with the command which the variable
8635 @code{gnus-summary-pipe-output-default-command} holds or the command
8636 last used for saving.
8637 @end itemize
8638
8639 Non-@code{nil} value for RAW overrides @code{:decode} and
8640 @code{:headers} properties (see below) and the raw article including all
8641 headers will be piped.
8642 @end table
8643
8644 The symbol of each function may have the following properties:
8645
8646 @table @code
8647 @item :decode
8648 The value non-@code{nil} means save decoded articles.  This is
8649 meaningful only with @code{gnus-summary-save-in-file},
8650 @code{gnus-summary-save-body-in-file},
8651 @code{gnus-summary-write-to-file},
8652 @code{gnus-summary-write-body-to-file}, and
8653 @code{gnus-summary-save-in-pipe}.
8654
8655 @item :function
8656 The value specifies an alternative function which appends, not
8657 overwrites, articles to a file.  This implies that when saving many
8658 articles at a time, @code{gnus-prompt-before-saving} is bound to
8659 @code{t} and all articles are saved in a single file.  This is
8660 meaningful only with @code{gnus-summary-write-to-file} and
8661 @code{gnus-summary-write-body-to-file}.
8662
8663 @item :headers
8664 The value specifies the symbol of a variable of which the value
8665 specifies headers to be saved.  If it is omitted,
8666 @code{gnus-save-all-headers} and @code{gnus-saved-headers} control what
8667 headers should be saved.
8668 @end table
8669
8670 @vindex gnus-article-save-directory
8671 All of these functions, except for the last one, will save the article
8672 in the @code{gnus-article-save-directory}, which is initialized from the
8673 @env{SAVEDIR} environment variable.  This is @file{~/News/} by
8674 default.
8675
8676 As you can see above, the functions use different functions to find a
8677 suitable name of a file to save the article in.  Below is a list of
8678 available functions that generate names:
8679
8680 @table @code
8681
8682 @item gnus-Numeric-save-name
8683 @findex gnus-Numeric-save-name
8684 File names like @file{~/News/Alt.andrea-dworkin/45}.
8685
8686 @item gnus-numeric-save-name
8687 @findex gnus-numeric-save-name
8688 File names like @file{~/News/alt.andrea-dworkin/45}.
8689
8690 @item gnus-Plain-save-name
8691 @findex gnus-Plain-save-name
8692 File names like @file{~/News/Alt.andrea-dworkin}.
8693
8694 @item gnus-plain-save-name
8695 @findex gnus-plain-save-name
8696 File names like @file{~/News/alt.andrea-dworkin}.
8697
8698 @item gnus-sender-save-name
8699 @findex gnus-sender-save-name
8700 File names like @file{~/News/larsi}.
8701 @end table
8702
8703 @vindex gnus-split-methods
8704 You can have Gnus suggest where to save articles by plonking a regexp into
8705 the @code{gnus-split-methods} alist.  For instance, if you would like to
8706 save articles related to Gnus in the file @file{gnus-stuff}, and articles
8707 related to VM in @file{vm-stuff}, you could set this variable to something
8708 like:
8709
8710 @lisp
8711 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
8712  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
8713  (my-choosing-function "../other-dir/my-stuff")
8714  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
8715 @end lisp
8716
8717 We see that this is a list where each element is a list that has two
8718 elements---the @dfn{match} and the @dfn{file}.  The match can either be
8719 a string (in which case it is used as a regexp to match on the article
8720 head); it can be a symbol (which will be called as a function with the
8721 group name as a parameter); or it can be a list (which will be
8722 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
8723 the @dfn{file} will be used as a default prompt.  In addition, the
8724 result of the operation itself will be used if the function or form
8725 called returns a string or a list of strings.
8726
8727 You basically end up with a list of file names that might be used when
8728 saving the current article.  (All ``matches'' will be used.)  You will
8729 then be prompted for what you really want to use as a name, with file
8730 name completion over the results from applying this variable.
8731
8732 This variable is @code{((gnus-article-archive-name))} by default, which
8733 means that Gnus will look at the articles it saves for an
8734 @code{Archive-name} line and use that as a suggestion for the file
8735 name.
8736
8737 Here's an example function to clean up file names somewhat.  If you have
8738 lots of mail groups called things like
8739 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
8740 these group names before creating the file name to save to.  The
8741 following will do just that:
8742
8743 @lisp
8744 (defun my-save-name (group)
8745   (when (string-match "^nnml:mail." group)
8746     (substring group (match-end 0))))
8747
8748 (setq gnus-split-methods
8749       '((gnus-article-archive-name)
8750         (my-save-name)))
8751 @end lisp
8752
8753
8754 @vindex gnus-use-long-file-name
8755 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
8756 @code{nil}, all the preceding functions will replace all periods
8757 (@samp{.}) in the group names with slashes (@samp{/})---which means that
8758 the functions will generate hierarchies of directories instead of having
8759 all the files in the top level directory
8760 (@file{~/News/alt/andrea-dworkin} instead of
8761 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
8762 on most systems.  However, for historical reasons, this is @code{nil} on
8763 Xenix and usg-unix-v machines by default.
8764
8765 This function also affects kill and score file names.  If this variable
8766 is a list, and the list contains the element @code{not-score}, long file
8767 names will not be used for score files, if it contains the element
8768 @code{not-save}, long file names will not be used for saving, and if it
8769 contains the element @code{not-kill}, long file names will not be used
8770 for kill files.
8771
8772 If you'd like to save articles in a hierarchy that looks something like
8773 a spool, you could
8774
8775 @lisp
8776 (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy}
8777 (setq gnus-default-article-saver
8778       'gnus-summary-save-in-file)          ; @r{no encoding}
8779 @end lisp
8780
8781 Then just save with @kbd{o}.  You'd then read this hierarchy with
8782 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
8783 the top level directory as the argument (@file{~/News/}).  Then just walk
8784 around to the groups/directories with @code{nneething}.
8785
8786
8787 @node Decoding Articles
8788 @section Decoding Articles
8789 @cindex decoding articles
8790
8791 Sometime users post articles (or series of articles) that have been
8792 encoded in some way or other.  Gnus can decode them for you.
8793
8794 @menu
8795 * Uuencoded Articles::          Uudecode articles.
8796 * Shell Archives::              Unshar articles.
8797 * PostScript Files::            Split PostScript.
8798 * Other Files::                 Plain save and binhex.
8799 * Decoding Variables::          Variables for a happy decoding.
8800 * Viewing Files::               You want to look at the result of the decoding?
8801 @end menu
8802
8803 @cindex series
8804 @cindex article series
8805 All these functions use the process/prefix convention
8806 (@pxref{Process/Prefix}) for finding out what articles to work on, with
8807 the extension that a ``single article'' means ``a single series''.  Gnus
8808 can find out by itself what articles belong to a series, decode all the
8809 articles and unpack/view/save the resulting file(s).
8810
8811 Gnus guesses what articles are in the series according to the following
8812 simplish rule: The subjects must be (nearly) identical, except for the
8813 last two numbers of the line.  (Spaces are largely ignored, however.)
8814
8815 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
8816 will find all the articles that match the regexp @samp{^cat.gif
8817 ([0-9]+/[0-9]+).*$}.
8818
8819 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
8820 series}, will not be properly recognized by any of the automatic viewing
8821 commands, and you have to mark the articles manually with @kbd{#}.
8822
8823
8824 @node Uuencoded Articles
8825 @subsection Uuencoded Articles
8826 @cindex uudecode
8827 @cindex uuencoded articles
8828
8829 @table @kbd
8830
8831 @item X u
8832 @kindex X u (Summary)
8833 @findex gnus-uu-decode-uu
8834 @c @icon{gnus-uu-decode-uu}
8835 Uudecodes the current series (@code{gnus-uu-decode-uu}).
8836
8837 @item X U
8838 @kindex X U (Summary)
8839 @findex gnus-uu-decode-uu-and-save
8840 Uudecodes and saves the current series
8841 (@code{gnus-uu-decode-uu-and-save}).
8842
8843 @item X v u
8844 @kindex X v u (Summary)
8845 @findex gnus-uu-decode-uu-view
8846 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
8847
8848 @item X v U
8849 @kindex X v U (Summary)
8850 @findex gnus-uu-decode-uu-and-save-view
8851 Uudecodes, views and saves the current series
8852 (@code{gnus-uu-decode-uu-and-save-view}).
8853
8854 @end table
8855
8856 Remember that these all react to the presence of articles marked with
8857 the process mark.  If, for instance, you'd like to decode and save an
8858 entire newsgroup, you'd typically do @kbd{M P a}
8859 (@code{gnus-uu-mark-all}) and then @kbd{X U}
8860 (@code{gnus-uu-decode-uu-and-save}).
8861
8862 All this is very much different from how @code{gnus-uu} worked with
8863 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
8864 the sun.  This version of @code{gnus-uu} generally assumes that you mark
8865 articles in some way (@pxref{Setting Process Marks}) and then press
8866 @kbd{X u}.
8867
8868 @vindex gnus-uu-notify-files
8869 Note: When trying to decode articles that have names matching
8870 @code{gnus-uu-notify-files}, which is hard-coded to
8871 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
8872 automatically post an article on @samp{comp.unix.wizards} saying that
8873 you have just viewed the file in question.  This feature can't be turned
8874 off.
8875
8876
8877 @node Shell Archives
8878 @subsection Shell Archives
8879 @cindex unshar
8880 @cindex shell archives
8881 @cindex shared articles
8882
8883 Shell archives (``shar files'') used to be a popular way to distribute
8884 sources, but it isn't used all that much today.  In any case, we have
8885 some commands to deal with these:
8886
8887 @table @kbd
8888
8889 @item X s
8890 @kindex X s (Summary)
8891 @findex gnus-uu-decode-unshar
8892 Unshars the current series (@code{gnus-uu-decode-unshar}).
8893
8894 @item X S
8895 @kindex X S (Summary)
8896 @findex gnus-uu-decode-unshar-and-save
8897 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
8898
8899 @item X v s
8900 @kindex X v s (Summary)
8901 @findex gnus-uu-decode-unshar-view
8902 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
8903
8904 @item X v S
8905 @kindex X v S (Summary)
8906 @findex gnus-uu-decode-unshar-and-save-view
8907 Unshars, views and saves the current series
8908 (@code{gnus-uu-decode-unshar-and-save-view}).
8909 @end table
8910
8911
8912 @node PostScript Files
8913 @subsection PostScript Files
8914 @cindex PostScript
8915
8916 @table @kbd
8917
8918 @item X p
8919 @kindex X p (Summary)
8920 @findex gnus-uu-decode-postscript
8921 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
8922
8923 @item X P
8924 @kindex X P (Summary)
8925 @findex gnus-uu-decode-postscript-and-save
8926 Unpack and save the current PostScript series
8927 (@code{gnus-uu-decode-postscript-and-save}).
8928
8929 @item X v p
8930 @kindex X v p (Summary)
8931 @findex gnus-uu-decode-postscript-view
8932 View the current PostScript series
8933 (@code{gnus-uu-decode-postscript-view}).
8934
8935 @item X v P
8936 @kindex X v P (Summary)
8937 @findex gnus-uu-decode-postscript-and-save-view
8938 View and save the current PostScript series
8939 (@code{gnus-uu-decode-postscript-and-save-view}).
8940 @end table
8941
8942
8943 @node Other Files
8944 @subsection Other Files
8945
8946 @table @kbd
8947 @item X o
8948 @kindex X o (Summary)
8949 @findex gnus-uu-decode-save
8950 Save the current series
8951 (@code{gnus-uu-decode-save}).
8952
8953 @item X b
8954 @kindex X b (Summary)
8955 @findex gnus-uu-decode-binhex
8956 Unbinhex the current series (@code{gnus-uu-decode-binhex}).  This
8957 doesn't really work yet.
8958
8959 @item X Y
8960 @kindex X Y (Summary)
8961 @findex gnus-uu-decode-yenc
8962 yEnc-decode the current series and save it (@code{gnus-uu-decode-yenc}).
8963 @end table
8964
8965
8966 @node Decoding Variables
8967 @subsection Decoding Variables
8968
8969 Adjective, not verb.
8970
8971 @menu
8972 * Rule Variables::              Variables that say how a file is to be viewed.
8973 * Other Decode Variables::      Other decode variables.
8974 * Uuencoding and Posting::      Variables for customizing uuencoding.
8975 @end menu
8976
8977
8978 @node Rule Variables
8979 @subsubsection Rule Variables
8980 @cindex rule variables
8981
8982 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
8983 variables are of the form
8984
8985 @lisp
8986       (list '(regexp1 command2)
8987             '(regexp2 command2)
8988             ...)
8989 @end lisp
8990
8991 @table @code
8992
8993 @item gnus-uu-user-view-rules
8994 @vindex gnus-uu-user-view-rules
8995 @cindex sox
8996 This variable is consulted first when viewing files.  If you wish to use,
8997 for instance, @code{sox} to convert an @file{.au} sound file, you could
8998 say something like:
8999 @lisp
9000 (setq gnus-uu-user-view-rules
9001       (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
9002 @end lisp
9003
9004 @item gnus-uu-user-view-rules-end
9005 @vindex gnus-uu-user-view-rules-end
9006 This variable is consulted if Gnus couldn't make any matches from the
9007 user and default view rules.
9008
9009 @item gnus-uu-user-archive-rules
9010 @vindex gnus-uu-user-archive-rules
9011 This variable can be used to say what commands should be used to unpack
9012 archives.
9013 @end table
9014
9015
9016 @node Other Decode Variables
9017 @subsubsection Other Decode Variables
9018
9019 @table @code
9020 @vindex gnus-uu-grabbed-file-functions
9021
9022 @item gnus-uu-grabbed-file-functions
9023 All functions in this list will be called right after each file has been
9024 successfully decoded---so that you can move or view files right away,
9025 and don't have to wait for all files to be decoded before you can do
9026 anything.  Ready-made functions you can put in this list are:
9027
9028 @table @code
9029
9030 @item gnus-uu-grab-view
9031 @findex gnus-uu-grab-view
9032 View the file.
9033
9034 @item gnus-uu-grab-move
9035 @findex gnus-uu-grab-move
9036 Move the file (if you're using a saving function.)
9037 @end table
9038
9039 @item gnus-uu-be-dangerous
9040 @vindex gnus-uu-be-dangerous
9041 Specifies what to do if unusual situations arise during decoding.  If
9042 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
9043 that didn't work, and overwrite existing files.  Otherwise, ask each
9044 time.
9045
9046 @item gnus-uu-ignore-files-by-name
9047 @vindex gnus-uu-ignore-files-by-name
9048 Files with name matching this regular expression won't be viewed.
9049
9050 @item gnus-uu-ignore-files-by-type
9051 @vindex gnus-uu-ignore-files-by-type
9052 Files with a @acronym{MIME} type matching this variable won't be viewed.
9053 Note that Gnus tries to guess what type the file is based on the name.
9054 @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly
9055 kludgey.
9056
9057 @item gnus-uu-tmp-dir
9058 @vindex gnus-uu-tmp-dir
9059 Where @code{gnus-uu} does its work.
9060
9061 @item gnus-uu-do-not-unpack-archives
9062 @vindex gnus-uu-do-not-unpack-archives
9063 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
9064 looking for files to display.
9065
9066 @item gnus-uu-view-and-save
9067 @vindex gnus-uu-view-and-save
9068 Non-@code{nil} means that the user will always be asked to save a file
9069 after viewing it.
9070
9071 @item gnus-uu-ignore-default-view-rules
9072 @vindex gnus-uu-ignore-default-view-rules
9073 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
9074 rules.
9075
9076 @item gnus-uu-ignore-default-archive-rules
9077 @vindex gnus-uu-ignore-default-archive-rules
9078 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
9079 unpacking commands.
9080
9081 @item gnus-uu-kill-carriage-return
9082 @vindex gnus-uu-kill-carriage-return
9083 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
9084 from articles.
9085
9086 @item gnus-uu-unmark-articles-not-decoded
9087 @vindex gnus-uu-unmark-articles-not-decoded
9088 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
9089 decoded articles as unread.
9090
9091 @item gnus-uu-correct-stripped-uucode
9092 @vindex gnus-uu-correct-stripped-uucode
9093 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
9094 uuencoded files that have had trailing spaces deleted.
9095
9096 @item gnus-uu-pre-uudecode-hook
9097 @vindex gnus-uu-pre-uudecode-hook
9098 Hook run before sending a message to @code{uudecode}.
9099
9100 @item gnus-uu-view-with-metamail
9101 @vindex gnus-uu-view-with-metamail
9102 @cindex metamail
9103 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
9104 commands defined by the rule variables and just fudge a @acronym{MIME}
9105 content type based on the file name.  The result will be fed to
9106 @code{metamail} for viewing.
9107
9108 @item gnus-uu-save-in-digest
9109 @vindex gnus-uu-save-in-digest
9110 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
9111 decoding, will save in digests.  If this variable is @code{nil},
9112 @code{gnus-uu} will just save everything in a file without any
9113 embellishments.  The digesting almost conforms to RFC 1153---no easy way
9114 to specify any meaningful volume and issue numbers were found, so I
9115 simply dropped them.
9116
9117 @end table
9118
9119
9120 @node Uuencoding and Posting
9121 @subsubsection Uuencoding and Posting
9122
9123 @table @code
9124
9125 @item gnus-uu-post-include-before-composing
9126 @vindex gnus-uu-post-include-before-composing
9127 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
9128 before you compose the article.  If this variable is @code{t}, you can
9129 either include an encoded file with @kbd{C-c C-i} or have one included
9130 for you when you post the article.
9131
9132 @item gnus-uu-post-length
9133 @vindex gnus-uu-post-length
9134 Maximum length of an article.  The encoded file will be split into how
9135 many articles it takes to post the entire file.
9136
9137 @item gnus-uu-post-threaded
9138 @vindex gnus-uu-post-threaded
9139 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
9140 thread.  This may not be smart, as no other decoder I have seen is able
9141 to follow threads when collecting uuencoded articles.  (Well, I have
9142 seen one package that does that---@code{gnus-uu}, but somehow, I don't
9143 think that counts@dots{}) Default is @code{nil}.
9144
9145 @item gnus-uu-post-separate-description
9146 @vindex gnus-uu-post-separate-description
9147 Non-@code{nil} means that the description will be posted in a separate
9148 article.  The first article will typically be numbered (0/x).  If this
9149 variable is @code{nil}, the description the user enters will be included
9150 at the beginning of the first article, which will be numbered (1/x).
9151 Default is @code{t}.
9152
9153 @end table
9154
9155
9156 @node Viewing Files
9157 @subsection Viewing Files
9158 @cindex viewing files
9159 @cindex pseudo-articles
9160
9161 After decoding, if the file is some sort of archive, Gnus will attempt
9162 to unpack the archive and see if any of the files in the archive can be
9163 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
9164 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
9165 uncompress and de-tar the main file, and then view the two pictures.
9166 This unpacking process is recursive, so if the archive contains archives
9167 of archives, it'll all be unpacked.
9168
9169 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
9170 extracted file into the summary buffer.  If you go to these
9171 ``articles'', you will be prompted for a command to run (usually Gnus
9172 will make a suggestion), and then the command will be run.
9173
9174 @vindex gnus-view-pseudo-asynchronously
9175 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
9176 until the viewing is done before proceeding.
9177
9178 @vindex gnus-view-pseudos
9179 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
9180 the pseudo-articles into the summary buffer, but view them
9181 immediately.  If this variable is @code{not-confirm}, the user won't even
9182 be asked for a confirmation before viewing is done.
9183
9184 @vindex gnus-view-pseudos-separately
9185 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
9186 pseudo-article will be created for each file to be viewed.  If
9187 @code{nil}, all files that use the same viewing command will be given as
9188 a list of parameters to that command.
9189
9190 @vindex gnus-insert-pseudo-articles
9191 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
9192 pseudo-articles when decoding.  It is @code{t} by default.
9193
9194 So; there you are, reading your @emph{pseudo-articles} in your
9195 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
9196 Why isn't anything real anymore? How did we get here?
9197
9198
9199 @node Article Treatment
9200 @section Article Treatment
9201
9202 Reading through this huge manual, you may have quite forgotten that the
9203 object of newsreaders is to actually, like, read what people have
9204 written.  Reading articles.  Unfortunately, people are quite bad at
9205 writing, so there are tons of functions and variables to make reading
9206 these articles easier.
9207
9208 @menu
9209 * Article Highlighting::        You want to make the article look like fruit salad.
9210 * Article Fontisizing::         Making emphasized text look nice.
9211 * Article Hiding::              You also want to make certain info go away.
9212 * Article Washing::             Lots of way-neat functions to make life better.
9213 * Article Header::              Doing various header transformations.
9214 * Article Buttons::             Click on URLs, Message-IDs, addresses and the like.
9215 * Article Button Levels::       Controlling appearance of buttons.
9216 * Article Date::                Grumble, UT!
9217 * Article Display::             Display various stuff:
9218                                 X-Face, Picons, Gravatars, Smileys.
9219 * Article Signature::           What is a signature?
9220 * Article Miscellanea::         Various other stuff.
9221 @end menu
9222
9223
9224 @node Article Highlighting
9225 @subsection Article Highlighting
9226 @cindex highlighting
9227
9228 Not only do you want your article buffer to look like fruit salad, but
9229 you want it to look like technicolor fruit salad.
9230
9231 @table @kbd
9232
9233 @item W H a
9234 @kindex W H a (Summary)
9235 @findex gnus-article-highlight
9236 @findex gnus-article-maybe-highlight
9237 Do much highlighting of the current article
9238 (@code{gnus-article-highlight}).  This function highlights header, cited
9239 text, the signature, and adds buttons to the body and the head.
9240
9241 @item W H h
9242 @kindex W H h (Summary)
9243 @findex gnus-article-highlight-headers
9244 @vindex gnus-header-face-alist
9245 Highlight the headers (@code{gnus-article-highlight-headers}).  The
9246 highlighting will be done according to the @code{gnus-header-face-alist}
9247 variable, which is a list where each element has the form
9248 @code{(@var{regexp} @var{name} @var{content})}.
9249 @var{regexp} is a regular expression for matching the
9250 header, @var{name} is the face used for highlighting the header name
9251 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
9252 the header value.  The first match made will be used.  Note that
9253 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
9254
9255 @item W H c
9256 @kindex W H c (Summary)
9257 @findex gnus-article-highlight-citation
9258 Highlight cited text (@code{gnus-article-highlight-citation}).
9259
9260 Some variables to customize the citation highlights:
9261
9262 @table @code
9263 @vindex gnus-cite-parse-max-size
9264
9265 @item gnus-cite-parse-max-size
9266 If the article size in bytes is bigger than this variable (which is
9267 25000 by default), no citation highlighting will be performed.
9268
9269 @item gnus-cite-max-prefix
9270 @vindex gnus-cite-max-prefix
9271 Maximum possible length for a citation prefix (default 20).
9272
9273 @item gnus-cite-face-list
9274 @vindex gnus-cite-face-list
9275 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
9276 When there are citations from multiple articles in the same message,
9277 Gnus will try to give each citation from each article its own face.
9278 This should make it easier to see who wrote what.
9279
9280 @item gnus-supercite-regexp
9281 @vindex gnus-supercite-regexp
9282 Regexp matching normal Supercite attribution lines.
9283
9284 @item gnus-supercite-secondary-regexp
9285 @vindex gnus-supercite-secondary-regexp
9286 Regexp matching mangled Supercite attribution lines.
9287
9288 @item gnus-cite-minimum-match-count
9289 @vindex gnus-cite-minimum-match-count
9290 Minimum number of identical prefixes we have to see before we believe
9291 that it's a citation.
9292
9293 @item gnus-cite-attribution-prefix
9294 @vindex gnus-cite-attribution-prefix
9295 Regexp matching the beginning of an attribution line.
9296
9297 @item gnus-cite-attribution-suffix
9298 @vindex gnus-cite-attribution-suffix
9299 Regexp matching the end of an attribution line.
9300
9301 @item gnus-cite-attribution-face
9302 @vindex gnus-cite-attribution-face
9303 Face used for attribution lines.  It is merged with the face for the
9304 cited text belonging to the attribution.
9305
9306 @item gnus-cite-ignore-quoted-from
9307 @vindex gnus-cite-ignore-quoted-from
9308 If non-@code{nil}, no citation highlighting will be performed on lines
9309 beginning with @samp{>From }.  Those lines may have been quoted by MTAs
9310 in order not to mix up with the envelope From line.  The default value
9311 is @code{t}.
9312
9313 @end table
9314
9315
9316 @item W H s
9317 @kindex W H s (Summary)
9318 @vindex gnus-signature-separator
9319 @vindex gnus-signature-face
9320 @findex gnus-article-highlight-signature
9321 Highlight the signature (@code{gnus-article-highlight-signature}).
9322 Everything after @code{gnus-signature-separator} (@pxref{Article
9323 Signature}) in an article will be considered a signature and will be
9324 highlighted with @code{gnus-signature-face}, which is @code{italic} by
9325 default.
9326
9327 @end table
9328
9329 @xref{Customizing Articles}, for how to highlight articles automatically.
9330
9331
9332 @node Article Fontisizing
9333 @subsection Article Fontisizing
9334 @cindex emphasis
9335 @cindex article emphasis
9336
9337 @findex gnus-article-emphasize
9338 @kindex W e (Summary)
9339 People commonly add emphasis to words in news articles by writing things
9340 like @samp{_this_} or @samp{*this*} or @samp{/this/}.  Gnus can make
9341 this look nicer by running the article through the @kbd{W e}
9342 (@code{gnus-article-emphasize}) command.
9343
9344 @vindex gnus-emphasis-alist
9345 How the emphasis is computed is controlled by the
9346 @code{gnus-emphasis-alist} variable.  This is an alist where the first
9347 element is a regular expression to be matched.  The second is a number
9348 that says what regular expression grouping is used to find the entire
9349 emphasized word.  The third is a number that says what regexp grouping
9350 should be displayed and highlighted.  (The text between these two
9351 groupings will be hidden.)  The fourth is the face used for
9352 highlighting.
9353
9354 @lisp
9355 (setq gnus-emphasis-alist
9356       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
9357         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
9358 @end lisp
9359
9360 @cindex slash
9361 @cindex asterisk
9362 @cindex underline
9363 @cindex /
9364 @cindex *
9365
9366 @vindex gnus-emphasis-underline
9367 @vindex gnus-emphasis-bold
9368 @vindex gnus-emphasis-italic
9369 @vindex gnus-emphasis-underline-bold
9370 @vindex gnus-emphasis-underline-italic
9371 @vindex gnus-emphasis-bold-italic
9372 @vindex gnus-emphasis-underline-bold-italic
9373 By default, there are seven rules, and they use the following faces:
9374 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
9375 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
9376 @code{gnus-emphasis-underline-italic},
9377 @code{gnus-emphasis-underline-bold}, and
9378 @code{gnus-emphasis-underline-bold-italic}.
9379
9380 If you want to change these faces, you can either use @kbd{M-x
9381 customize}, or you can use @code{copy-face}.  For instance, if you want
9382 to make @code{gnus-emphasis-italic} use a red face instead, you could
9383 say something like:
9384
9385 @lisp
9386 (copy-face 'red 'gnus-emphasis-italic)
9387 @end lisp
9388
9389 @vindex gnus-group-highlight-words-alist
9390
9391 If you want to highlight arbitrary words, you can use the
9392 @code{gnus-group-highlight-words-alist} variable, which uses the same
9393 syntax as @code{gnus-emphasis-alist}.  The @code{highlight-words} group
9394 parameter (@pxref{Group Parameters}) can also be used.
9395
9396 @xref{Customizing Articles}, for how to fontize articles automatically.
9397
9398
9399 @node Article Hiding
9400 @subsection Article Hiding
9401 @cindex article hiding
9402
9403 Or rather, hiding certain things in each article.  There usually is much
9404 too much cruft in most articles.
9405
9406 @table @kbd
9407
9408 @item W W a
9409 @kindex W W a (Summary)
9410 @findex gnus-article-hide
9411 Do quite a lot of hiding on the article buffer
9412 (@kbd{gnus-article-hide}).  In particular, this function will hide
9413 headers, @acronym{PGP}, cited text and the signature.
9414
9415 @item W W h
9416 @kindex W W h (Summary)
9417 @findex gnus-article-hide-headers
9418 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
9419 Headers}.
9420
9421 @item W W b
9422 @kindex W W b (Summary)
9423 @findex gnus-article-hide-boring-headers
9424 Hide headers that aren't particularly interesting
9425 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
9426
9427 @item W W s
9428 @kindex W W s (Summary)
9429 @findex gnus-article-hide-signature
9430 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
9431 Signature}.
9432
9433 @item W W l
9434 @kindex W W l (Summary)
9435 @findex gnus-article-hide-list-identifiers
9436 @vindex gnus-list-identifiers
9437 Strip list identifiers specified in @code{gnus-list-identifiers}.  These
9438 are strings some mailing list servers add to the beginning of all
9439 @code{Subject} headers---for example, @samp{[zebra 4711]}.  Any leading
9440 @samp{Re: } is skipped before stripping.  @code{gnus-list-identifiers}
9441 may not contain @code{\\(..\\)}.
9442
9443 @table @code
9444
9445 @item gnus-list-identifiers
9446 @vindex gnus-list-identifiers
9447 A regular expression that matches list identifiers to be removed from
9448 subject.  This can also be a list of regular expressions.
9449
9450 @end table
9451
9452 @item W W P
9453 @kindex W W P (Summary)
9454 @findex gnus-article-hide-pem
9455 Hide @acronym{PEM} (privacy enhanced messages) cruft
9456 (@code{gnus-article-hide-pem}).
9457
9458 @item W W B
9459 @kindex W W B (Summary)
9460 @findex gnus-article-strip-banner
9461 @vindex gnus-article-banner-alist
9462 @vindex gnus-article-address-banner-alist
9463 @cindex banner
9464 @cindex OneList
9465 @cindex stripping advertisements
9466 @cindex advertisements
9467 Strip the banner specified by the @code{banner} group parameter
9468 (@code{gnus-article-strip-banner}).  This is mainly used to hide those
9469 annoying banners and/or signatures that some mailing lists and moderated
9470 groups adds to all the messages.  The way to use this function is to add
9471 the @code{banner} group parameter (@pxref{Group Parameters}) to the
9472 group you want banners stripped from.  The parameter either be a string,
9473 which will be interpreted as a regular expression matching text to be
9474 removed, or the symbol @code{signature}, meaning that the (last)
9475 signature should be removed, or other symbol, meaning that the
9476 corresponding regular expression in @code{gnus-article-banner-alist} is
9477 used.
9478
9479 For instance:
9480
9481 @lisp
9482 (setq gnus-article-banner-alist
9483       ((googleGroups .
9484        "^\n*--~--~---------\\(.+\n\\)+")))
9485 @end lisp
9486
9487 Regardless of a group, you can hide things like advertisements only when
9488 the sender of an article has a certain mail address specified in
9489 @code{gnus-article-address-banner-alist}.
9490
9491 @table @code
9492
9493 @item gnus-article-address-banner-alist
9494 @vindex gnus-article-address-banner-alist
9495 Alist of mail addresses and banners.  Each element has the form
9496 @code{(@var{address} . @var{banner})}, where @var{address} is a regexp
9497 matching a mail address in the From header, @var{banner} is one of a
9498 symbol @code{signature}, an item in @code{gnus-article-banner-alist},
9499 a regexp and @code{nil}.  If @var{address} matches author's mail
9500 address, it will remove things like advertisements.  For example, if a
9501 sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a
9502 banner something like @samp{Do You Yoo-hoo!?} in all articles he
9503 sends, you can use the following element to remove them:
9504
9505 @lisp
9506 ("@@yoo-hoo\\.co\\.jp\\'" .
9507  "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
9508 @end lisp
9509
9510 @end table
9511
9512 @item W W c
9513 @kindex W W c (Summary)
9514 @findex gnus-article-hide-citation
9515 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
9516 customizing the hiding:
9517
9518 @table @code
9519
9520 @item gnus-cited-opened-text-button-line-format
9521 @itemx gnus-cited-closed-text-button-line-format
9522 @vindex gnus-cited-closed-text-button-line-format
9523 @vindex gnus-cited-opened-text-button-line-format
9524 Gnus adds buttons to show where the cited text has been hidden, and to
9525 allow toggle hiding the text.  The format of the variable is specified
9526 by these format-like variable (@pxref{Formatting Variables}).  These
9527 specs are valid:
9528
9529 @table @samp
9530 @item b
9531 Starting point of the hidden text.
9532 @item e
9533 Ending point of the hidden text.
9534 @item l
9535 Number of characters in the hidden region.
9536 @item n
9537 Number of lines of hidden text.
9538 @end table
9539
9540 @item gnus-cited-lines-visible
9541 @vindex gnus-cited-lines-visible
9542 The number of lines at the beginning of the cited text to leave
9543 shown.  This can also be a cons cell with the number of lines at the top
9544 and bottom of the text, respectively, to remain visible.
9545
9546 @end table
9547
9548 @item W W C-c
9549 @kindex W W C-c (Summary)
9550 @findex gnus-article-hide-citation-maybe
9551
9552 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
9553 following two variables:
9554
9555 @table @code
9556 @item gnus-cite-hide-percentage
9557 @vindex gnus-cite-hide-percentage
9558 If the cited text is of a bigger percentage than this variable (default
9559 50), hide the cited text.
9560
9561 @item gnus-cite-hide-absolute
9562 @vindex gnus-cite-hide-absolute
9563 The cited text must have at least this length (default 10) before it
9564 is hidden.
9565 @end table
9566
9567 @item W W C
9568 @kindex W W C (Summary)
9569 @findex gnus-article-hide-citation-in-followups
9570 Hide cited text in articles that aren't roots
9571 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
9572 useful as an interactive command, but might be a handy function to stick
9573 have happen automatically (@pxref{Customizing Articles}).
9574
9575 @end table
9576
9577 All these ``hiding'' commands are toggles, but if you give a negative
9578 prefix to these commands, they will show what they have previously
9579 hidden.  If you give a positive prefix, they will always hide.
9580
9581 Also @pxref{Article Highlighting} for further variables for
9582 citation customization.
9583
9584 @xref{Customizing Articles}, for how to hide article elements
9585 automatically.
9586
9587
9588 @node Article Washing
9589 @subsection Article Washing
9590 @cindex washing
9591 @cindex article washing
9592
9593 We call this ``article washing'' for a really good reason.  Namely, the
9594 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
9595
9596 @dfn{Washing} is defined by us as ``changing something from something to
9597 something else'', but normally results in something looking better.
9598 Cleaner, perhaps.
9599
9600 @xref{Customizing Articles}, if you want to change how Gnus displays
9601 articles by default.
9602
9603 @table @kbd
9604
9605 @item C-u g
9606 This is not really washing, it's sort of the opposite of washing.  If
9607 you type this, you see the article exactly as it exists on disk or on
9608 the server.
9609
9610 @item g
9611 Force redisplaying of the current article
9612 (@code{gnus-summary-show-article}).  This is also not really washing.
9613 If you type this, you see the article without any previously applied
9614 interactive Washing functions but with all default treatments
9615 (@pxref{Customizing Articles}).
9616
9617 @item W l
9618 @kindex W l (Summary)
9619 @findex gnus-summary-stop-page-breaking
9620 Remove page breaks from the current article
9621 (@code{gnus-summary-stop-page-breaking}).  @xref{Misc Article}, for page
9622 delimiters.
9623
9624 @item W r
9625 @kindex W r (Summary)
9626 @findex gnus-summary-caesar-message
9627 @c @icon{gnus-summary-caesar-message}
9628 Do a Caesar rotate (rot13) on the article buffer
9629 (@code{gnus-summary-caesar-message}).
9630 Unreadable articles that tell you to read them with Caesar rotate or rot13.
9631 (Typically offensive jokes and such.)
9632
9633 It's commonly called ``rot13'' because each letter is rotated 13
9634 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
9635 #15).  It is sometimes referred to as ``Caesar rotate'' because Caesar
9636 is rumored to have employed this form of, uh, somewhat weak encryption.
9637
9638 @item W m
9639 @kindex W m (Summary)
9640 @findex gnus-summary-morse-message
9641 Morse decode the article buffer (@code{gnus-summary-morse-message}).
9642
9643 @item W i
9644 @kindex W i (Summary)
9645 @findex gnus-summary-idna-message
9646 Decode IDNA encoded domain names in the current articles.  IDNA
9647 encoded domain names looks like @samp{xn--bar}.  If a string remain
9648 unencoded after running invoking this, it is likely an invalid IDNA
9649 string (@samp{xn--bar} is invalid).  You must have GNU Libidn
9650 (@url{http://www.gnu.org/software/libidn/}) installed for this command
9651 to work.
9652
9653 @item W t
9654 @item t
9655 @kindex W t (Summary)
9656 @kindex t (Summary)
9657 @findex gnus-summary-toggle-header
9658 Toggle whether to display all headers in the article buffer
9659 (@code{gnus-summary-toggle-header}).
9660
9661 @item W v
9662 @kindex W v (Summary)
9663 @findex gnus-summary-verbose-headers
9664 Toggle whether to display all headers in the article buffer permanently
9665 (@code{gnus-summary-verbose-headers}).
9666
9667 @item W o
9668 @kindex W o (Summary)
9669 @findex gnus-article-treat-overstrike
9670 Treat overstrike (@code{gnus-article-treat-overstrike}).
9671
9672 @item W d
9673 @kindex W d (Summary)
9674 @findex gnus-article-treat-dumbquotes
9675 @vindex gnus-article-dumbquotes-map
9676 @cindex Smartquotes
9677 @cindex M****s*** sm*rtq**t*s
9678 @cindex Latin 1
9679 Treat M****s*** sm*rtq**t*s according to
9680 @code{gnus-article-dumbquotes-map}
9681 (@code{gnus-article-treat-dumbquotes}).  Note that this function guesses
9682 whether a character is a sm*rtq**t* or not, so it should only be used
9683 interactively.
9684
9685 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
9686 an attempt to provide more quoting characters.  If you see something
9687 like @code{\222} or @code{\264} where you're expecting some kind of
9688 apostrophe or quotation mark, then try this wash.
9689
9690 @item W Y f
9691 @kindex W Y f (Summary)
9692 @findex gnus-article-outlook-deuglify-article
9693 @cindex Outlook Express
9694 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
9695 unwrap lines, repair attribution and rearrange citation.
9696 (@code{gnus-article-outlook-deuglify-article}).
9697
9698 @item W Y u
9699 @kindex W Y u (Summary)
9700 @findex gnus-article-outlook-unwrap-lines
9701 @vindex gnus-outlook-deuglify-unwrap-min
9702 @vindex gnus-outlook-deuglify-unwrap-max
9703 Unwrap lines that appear to be wrapped citation lines.  You can control
9704 what lines will be unwrapped by frobbing
9705 @code{gnus-outlook-deuglify-unwrap-min} and
9706 @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and
9707 maximum length of an unwrapped citation line.
9708 (@code{gnus-article-outlook-unwrap-lines}).
9709
9710 @item W Y a
9711 @kindex W Y a (Summary)
9712 @findex gnus-article-outlook-repair-attribution
9713 Repair a broken attribution line.@*
9714 (@code{gnus-article-outlook-repair-attribution}).
9715
9716 @item W Y c
9717 @kindex W Y c (Summary)
9718 @findex gnus-article-outlook-rearrange-citation
9719 Repair broken citations by rearranging the text.
9720 (@code{gnus-article-outlook-rearrange-citation}).
9721
9722 @item W w
9723 @kindex W w (Summary)
9724 @findex gnus-article-fill-cited-article
9725 Do word wrap (@code{gnus-article-fill-cited-article}).
9726
9727 You can give the command a numerical prefix to specify the width to use
9728 when filling.
9729
9730 @item W Q
9731 @kindex W Q (Summary)
9732 @findex gnus-article-fill-long-lines
9733 Fill long lines (@code{gnus-article-fill-long-lines}).
9734
9735 @item W C
9736 @kindex W C (Summary)
9737 @findex gnus-article-capitalize-sentences
9738 Capitalize the first word in each sentence
9739 (@code{gnus-article-capitalize-sentences}).
9740
9741 @item W c
9742 @kindex W c (Summary)
9743 @findex gnus-article-remove-cr
9744 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
9745 (this takes care of DOS line endings), and then translate any remaining
9746 CRs into LF (this takes care of Mac line endings)
9747 (@code{gnus-article-remove-cr}).
9748
9749 @item W q
9750 @kindex W q (Summary)
9751 @findex gnus-article-de-quoted-unreadable
9752 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
9753 Quoted-Printable is one common @acronym{MIME} encoding employed when
9754 sending non-@acronym{ASCII} (i.e., 8-bit) articles.  It typically
9755 makes strings like @samp{d@'ej@`a vu} look like @samp{d=E9j=E0 vu},
9756 which doesn't look very readable to me.  Note that this is usually
9757 done automatically by Gnus if the message in question has a
9758 @code{Content-Transfer-Encoding} header that says that this encoding
9759 has been done.  If a prefix is given, a charset will be asked for.
9760
9761 @item W 6
9762 @kindex W 6 (Summary)
9763 @findex gnus-article-de-base64-unreadable
9764 Treat base64 (@code{gnus-article-de-base64-unreadable}).  Base64 is
9765 one common @acronym{MIME} encoding employed when sending
9766 non-@acronym{ASCII} (i.e., 8-bit) articles.  Note that this is
9767 usually done automatically by Gnus if the message in question has a
9768 @code{Content-Transfer-Encoding} header that says that this encoding
9769 has been done.  If a prefix is given, a charset will be asked for.
9770
9771 @item W Z
9772 @kindex W Z (Summary)
9773 @findex gnus-article-decode-HZ
9774 Treat HZ or HZP (@code{gnus-article-decode-HZ}).  HZ (or HZP) is one
9775 common encoding employed when sending Chinese articles.  It typically
9776 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
9777
9778 @item W A
9779 @kindex W A (Summary)
9780 @findex gnus-article-treat-ansi-sequences
9781 @cindex @acronym{ANSI} control sequences
9782 Translate @acronym{ANSI} SGR control sequences into overlays or
9783 extents (@code{gnus-article-treat-ansi-sequences}).  @acronym{ANSI}
9784 sequences are used in some Chinese hierarchies for highlighting.
9785
9786 @item W u
9787 @kindex W u (Summary)
9788 @findex gnus-article-unsplit-urls
9789 Remove newlines from within URLs.  Some mailers insert newlines into
9790 outgoing email messages to keep lines short.  This reformatting can
9791 split long URLs onto multiple lines.  Repair those URLs by removing
9792 the newlines (@code{gnus-article-unsplit-urls}).
9793
9794 @item W h
9795 @kindex W h (Summary)
9796 @findex gnus-article-wash-html
9797 Treat @acronym{HTML} (@code{gnus-article-wash-html}).  Note that this is
9798 usually done automatically by Gnus if the message in question has a
9799 @code{Content-Type} header that says that the message is @acronym{HTML}.
9800
9801 If a prefix is given, a charset will be asked for.  If it is a number,
9802 the charset defined in @code{gnus-summary-show-article-charset-alist}
9803 (@pxref{Paging the Article}) will be used.
9804
9805 @vindex gnus-article-wash-function
9806 The default is to use the function specified by
9807 @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
9808 Customization, emacs-mime, The Emacs MIME Manual}) to convert the
9809 @acronym{HTML}, but this is controlled by the
9810 @code{gnus-article-wash-function} variable.  Pre-defined functions you
9811 can use include:
9812
9813 @table @code
9814 @item gnus-article-html
9815 Use Gnus rendered based on w3m.
9816
9817 @item w3
9818 Use Emacs/W3.
9819
9820 @item w3m
9821 Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
9822
9823 @item w3m-standalone
9824 Use @uref{http://w3m.sourceforge.net/, w3m}.
9825
9826 @item links
9827 Use @uref{http://links.sf.net/, Links}.
9828
9829 @item lynx
9830 Use @uref{http://lynx.isc.org/, Lynx}.
9831
9832 @item html2text
9833 Use html2text---a simple @acronym{HTML} converter included with Gnus.
9834
9835 @end table
9836
9837 @item W b
9838 @kindex W b (Summary)
9839 @findex gnus-article-add-buttons
9840 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
9841 @xref{Article Buttons}.
9842
9843 @item W B
9844 @kindex W B (Summary)
9845 @findex gnus-article-add-buttons-to-head
9846 Add clickable buttons to the article headers
9847 (@code{gnus-article-add-buttons-to-head}).
9848
9849 @item W p
9850 @kindex W p (Summary)
9851 @findex gnus-article-verify-x-pgp-sig
9852 Verify a signed control message
9853 (@code{gnus-article-verify-x-pgp-sig}).  Control messages such as
9854 @code{newgroup} and @code{checkgroups} are usually signed by the
9855 hierarchy maintainer.  You need to add the @acronym{PGP} public key of
9856 the maintainer to your keyring to verify the
9857 message.@footnote{@acronym{PGP} keys for many hierarchies are
9858 available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
9859
9860 @item W s
9861 @kindex W s (Summary)
9862 @findex gnus-summary-force-verify-and-decrypt
9863 Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or
9864 @acronym{S/MIME}) message
9865 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
9866
9867 @item W a
9868 @kindex W a (Summary)
9869 @findex gnus-article-strip-headers-in-body
9870 Strip headers like the @code{X-No-Archive} header from the beginning of
9871 article bodies (@code{gnus-article-strip-headers-in-body}).
9872
9873 @item W E l
9874 @kindex W E l (Summary)
9875 @findex gnus-article-strip-leading-blank-lines
9876 Remove all blank lines from the beginning of the article
9877 (@code{gnus-article-strip-leading-blank-lines}).
9878
9879 @item W E m
9880 @kindex W E m (Summary)
9881 @findex gnus-article-strip-multiple-blank-lines
9882 Replace all blank lines with empty lines and then all multiple empty
9883 lines with a single empty line.
9884 (@code{gnus-article-strip-multiple-blank-lines}).
9885
9886 @item W E t
9887 @kindex W E t (Summary)
9888 @findex gnus-article-remove-trailing-blank-lines
9889 Remove all blank lines at the end of the article
9890 (@code{gnus-article-remove-trailing-blank-lines}).
9891
9892 @item W E a
9893 @kindex W E a (Summary)
9894 @findex gnus-article-strip-blank-lines
9895 Do all the three commands above
9896 (@code{gnus-article-strip-blank-lines}).
9897
9898 @item W E A
9899 @kindex W E A (Summary)
9900 @findex gnus-article-strip-all-blank-lines
9901 Remove all blank lines
9902 (@code{gnus-article-strip-all-blank-lines}).
9903
9904 @item W E s
9905 @kindex W E s (Summary)
9906 @findex gnus-article-strip-leading-space
9907 Remove all white space from the beginning of all lines of the article
9908 body (@code{gnus-article-strip-leading-space}).
9909
9910 @item W E e
9911 @kindex W E e (Summary)
9912 @findex gnus-article-strip-trailing-space
9913 Remove all white space from the end of all lines of the article
9914 body (@code{gnus-article-strip-trailing-space}).
9915
9916 @end table
9917
9918 @xref{Customizing Articles}, for how to wash articles automatically.
9919
9920
9921 @node Article Header
9922 @subsection Article Header
9923
9924 These commands perform various transformations of article header.
9925
9926 @table @kbd
9927
9928 @item W G u
9929 @kindex W G u (Summary)
9930 @findex gnus-article-treat-unfold-headers
9931 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
9932
9933 @item W G n
9934 @kindex W G n (Summary)
9935 @findex gnus-article-treat-fold-newsgroups
9936 Fold the @code{Newsgroups} and @code{Followup-To} headers
9937 (@code{gnus-article-treat-fold-newsgroups}).
9938
9939 @item W G f
9940 @kindex W G f (Summary)
9941 @findex gnus-article-treat-fold-headers
9942 Fold all the message headers
9943 (@code{gnus-article-treat-fold-headers}).
9944
9945 @item W E w
9946 @kindex W E w (Summary)
9947 @findex gnus-article-remove-leading-whitespace
9948 Remove excessive whitespace from all headers
9949 (@code{gnus-article-remove-leading-whitespace}).
9950
9951 @end table
9952
9953
9954 @node Article Buttons
9955 @subsection Article Buttons
9956 @cindex buttons
9957
9958 People often include references to other stuff in articles, and it would
9959 be nice if Gnus could just fetch whatever it is that people talk about
9960 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
9961 button on these references.
9962
9963 @vindex gnus-button-man-handler
9964 Gnus adds @dfn{buttons} to certain standard references by default:
9965 Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and
9966 Emacs or Gnus related references.  This is controlled by two variables,
9967 one that handles article bodies and one that handles article heads:
9968
9969 @table @code
9970
9971 @item gnus-button-alist
9972 @vindex gnus-button-alist
9973 This is an alist where each entry has this form:
9974
9975 @lisp
9976 (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
9977 @end lisp
9978
9979 @table @var
9980
9981 @item regexp
9982 All text that match this regular expression (case insensitive) will be
9983 considered an external reference.  Here's a typical regexp that matches
9984 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}.  This can also be a
9985 variable containing a regexp, useful variables to use include
9986 @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}.
9987
9988 @item button-par
9989 Gnus has to know which parts of the matches is to be highlighted.  This
9990 is a number that says what sub-expression of the regexp is to be
9991 highlighted.  If you want it all highlighted, you use 0 here.
9992
9993 @item use-p
9994 This form will be @code{eval}ed, and if the result is non-@code{nil},
9995 this is considered a match.  This is useful if you want extra sifting to
9996 avoid false matches.  Often variables named
9997 @code{gnus-button-@var{*}-level} are used here, @xref{Article Button
9998 Levels}, but any other form may be used too.
9999
10000 @c @code{use-p} is @code{eval}ed only if @code{regexp} matches.
10001
10002 @item function
10003 This function will be called when you click on this button.
10004
10005 @item data-par
10006 As with @var{button-par}, this is a sub-expression number, but this one
10007 says which part of the match is to be sent as data to @var{function}.
10008
10009 @end table
10010
10011 So the full entry for buttonizing URLs is then
10012
10013 @lisp
10014 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
10015 @end lisp
10016
10017 @item gnus-header-button-alist
10018 @vindex gnus-header-button-alist
10019 This is just like the other alist, except that it is applied to the
10020 article head only, and that each entry has an additional element that is
10021 used to say what headers to apply the buttonize coding to:
10022
10023 @lisp
10024 (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
10025 @end lisp
10026
10027 @var{header} is a regular expression.
10028 @end table
10029
10030 @subsubsection Related variables and functions
10031
10032 @table @code
10033 @item gnus-button-@var{*}-level
10034 @xref{Article Button Levels}.
10035
10036 @c Stuff related to gnus-button-browse-level
10037
10038 @item gnus-button-url-regexp
10039 @vindex gnus-button-url-regexp
10040 A regular expression that matches embedded URLs.  It is used in the
10041 default values of the variables above.
10042
10043 @c Stuff related to gnus-button-man-level
10044
10045 @item gnus-button-man-handler
10046 @vindex gnus-button-man-handler
10047 The function to use for displaying man pages.  It must take at least one
10048 argument with a string naming the man page.
10049
10050 @c Stuff related to gnus-button-message-level
10051
10052 @item gnus-button-mid-or-mail-regexp
10053 @vindex gnus-button-mid-or-mail-regexp
10054 Regular expression that matches a message ID or a mail address.
10055
10056 @item gnus-button-prefer-mid-or-mail
10057 @vindex gnus-button-prefer-mid-or-mail
10058 This variable determines what to do when the button on a string as
10059 @samp{foo123@@bar.invalid} is pushed.  Strings like this can be either a
10060 message ID or a mail address.  If it is one of the symbols @code{mid} or
10061 @code{mail}, Gnus will always assume that the string is a message ID or
10062 a mail address, respectively.  If this variable is set to the symbol
10063 @code{ask}, always query the user what to do.  If it is a function, this
10064 function will be called with the string as its only argument.  The
10065 function must return @code{mid}, @code{mail}, @code{invalid} or
10066 @code{ask}.  The default value is the function
10067 @code{gnus-button-mid-or-mail-heuristic}.
10068
10069 @item gnus-button-mid-or-mail-heuristic
10070 @findex gnus-button-mid-or-mail-heuristic
10071 Function that guesses whether its argument is a message ID or a mail
10072 address.  Returns @code{mid} if it's a message IDs, @code{mail} if
10073 it's a mail address, @code{ask} if unsure and @code{invalid} if the
10074 string is invalid.
10075
10076 @item gnus-button-mid-or-mail-heuristic-alist
10077 @vindex gnus-button-mid-or-mail-heuristic-alist
10078 An alist of @code{(RATE . REGEXP)} pairs used by the function
10079 @code{gnus-button-mid-or-mail-heuristic}.
10080
10081 @c Misc stuff
10082
10083 @item gnus-article-button-face
10084 @vindex gnus-article-button-face
10085 Face used on buttons.
10086
10087 @item gnus-article-mouse-face
10088 @vindex gnus-article-mouse-face
10089 Face used when the mouse cursor is over a button.
10090
10091 @end table
10092
10093 @xref{Customizing Articles}, for how to buttonize articles automatically.
10094
10095
10096 @node Article Button Levels
10097 @subsection Article button levels
10098 @cindex button levels
10099 The higher the value of the variables @code{gnus-button-@var{*}-level},
10100 the more buttons will appear.  If the level is zero, no corresponding
10101 buttons are displayed.  With the default value (which is 5) you should
10102 already see quite a lot of buttons.  With higher levels, you will see
10103 more buttons, but you may also get more false positives.  To avoid them,
10104 you can set the variables @code{gnus-button-@var{*}-level} local to
10105 specific groups (@pxref{Group Parameters}).  Here's an example for the
10106 variable @code{gnus-parameters}:
10107
10108 @lisp
10109 ;; @r{increase @code{gnus-button-*-level} in some groups:}
10110 (setq gnus-parameters
10111       '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10))
10112         ("\\<unix\\>"               (gnus-button-man-level 10))
10113         ("\\<tex\\>"                (gnus-button-tex-level 10))))
10114 @end lisp
10115
10116 @table @code
10117
10118 @item gnus-button-browse-level
10119 @vindex gnus-button-browse-level
10120 Controls the display of references to message IDs, mail addresses and
10121 news URLs.  Related variables and functions include
10122 @code{gnus-button-url-regexp}, @code{browse-url}, and
10123 @code{browse-url-browser-function}.
10124
10125 @item gnus-button-emacs-level
10126 @vindex gnus-button-emacs-level
10127 Controls the display of Emacs or Gnus references.  Related functions are
10128 @code{gnus-button-handle-custom},
10129 @code{gnus-button-handle-describe-function},
10130 @code{gnus-button-handle-describe-variable},
10131 @code{gnus-button-handle-symbol},
10132 @code{gnus-button-handle-describe-key},
10133 @code{gnus-button-handle-apropos},
10134 @code{gnus-button-handle-apropos-command},
10135 @code{gnus-button-handle-apropos-variable},
10136 @code{gnus-button-handle-apropos-documentation}, and
10137 @code{gnus-button-handle-library}.
10138
10139 @item gnus-button-man-level
10140 @vindex gnus-button-man-level
10141 Controls the display of references to (Unix) man pages.
10142 See @code{gnus-button-man-handler}.
10143
10144 @item gnus-button-message-level
10145 @vindex gnus-button-message-level
10146 Controls the display of message IDs, mail addresses and news URLs.
10147 Related variables and functions include
10148 @code{gnus-button-mid-or-mail-regexp},
10149 @code{gnus-button-prefer-mid-or-mail},
10150 @code{gnus-button-mid-or-mail-heuristic}, and
10151 @code{gnus-button-mid-or-mail-heuristic-alist}.
10152
10153 @end table
10154
10155
10156 @node Article Date
10157 @subsection Article Date
10158
10159 The date is most likely generated in some obscure timezone you've never
10160 heard of, so it's quite nice to be able to find out what the time was
10161 when the article was sent.
10162
10163 @table @kbd
10164
10165 @item W T u
10166 @kindex W T u (Summary)
10167 @findex gnus-article-date-ut
10168 Display the date in UT (aka. GMT, aka ZULU)
10169 (@code{gnus-article-date-ut}).
10170
10171 @item W T i
10172 @kindex W T i (Summary)
10173 @findex gnus-article-date-iso8601
10174 @cindex ISO 8601
10175 Display the date in international format, aka. ISO 8601
10176 (@code{gnus-article-date-iso8601}).
10177
10178 @item W T l
10179 @kindex W T l (Summary)
10180 @findex gnus-article-date-local
10181 Display the date in the local timezone (@code{gnus-article-date-local}).
10182
10183 @item W T p
10184 @kindex W T p (Summary)
10185 @findex gnus-article-date-english
10186 Display the date in a format that's easily pronounceable in English
10187 (@code{gnus-article-date-english}).
10188
10189 @item W T s
10190 @kindex W T s (Summary)
10191 @vindex gnus-article-time-format
10192 @findex gnus-article-date-user
10193 @findex format-time-string
10194 Display the date using a user-defined format
10195 (@code{gnus-article-date-user}).  The format is specified by the
10196 @code{gnus-article-time-format} variable, and is a string that's passed
10197 to @code{format-time-string}.  See the documentation of that variable
10198 for a list of possible format specs.
10199
10200 @item W T e
10201 @kindex W T e (Summary)
10202 @findex gnus-article-date-lapsed
10203 @findex gnus-start-date-timer
10204 @findex gnus-stop-date-timer
10205 Say how much time has elapsed between the article was posted and now
10206 (@code{gnus-article-date-lapsed}).  It looks something like:
10207
10208 @example
10209 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
10210 @end example
10211
10212 @vindex gnus-article-date-lapsed-new-header
10213 The value of @code{gnus-article-date-lapsed-new-header} determines
10214 whether this header will just be added below the old Date one, or will
10215 replace it.
10216
10217 An advantage of using Gnus to read mail is that it converts simple bugs
10218 into wonderful absurdities.
10219
10220 If you want to have this line updated continually, you can put
10221
10222 @lisp
10223 (gnus-start-date-timer)
10224 @end lisp
10225
10226 in your @file{~/.gnus.el} file, or you can run it off of some hook.  If
10227 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
10228 command.
10229
10230 @item W T o
10231 @kindex W T o (Summary)
10232 @findex gnus-article-date-original
10233 Display the original date (@code{gnus-article-date-original}).  This can
10234 be useful if you normally use some other conversion function and are
10235 worried that it might be doing something totally wrong.  Say, claiming
10236 that the article was posted in 1854.  Although something like that is
10237 @emph{totally} impossible.  Don't you trust me? *titter*
10238
10239 @end table
10240
10241 @xref{Customizing Articles}, for how to display the date in your
10242 preferred format automatically.
10243
10244
10245 @node Article Display
10246 @subsection Article Display
10247 @cindex picons
10248 @cindex x-face
10249 @cindex smileys
10250 @cindex gravatars
10251
10252 These commands add various frivolous display gimmicks to the article
10253 buffer in Emacs versions that support them.
10254
10255 @code{X-Face} headers are small black-and-white images supplied by the
10256 message headers (@pxref{X-Face}).
10257
10258 @code{Face} headers are small colored images supplied by the message
10259 headers (@pxref{Face}).
10260
10261 Smileys are those little @samp{:-)} symbols that people like to litter
10262 their messages with (@pxref{Smileys}).
10263
10264 Picons, on the other hand, reside on your own system, and Gnus will
10265 try to match the headers to what you have (@pxref{Picons}).
10266
10267 Gravatars reside on-line and are fetched from
10268 @uref{http://www.gravatar.com/} (@pxref{Gravatars}).
10269
10270 All these functions are toggles---if the elements already exist,
10271 they'll be removed.
10272
10273 @table @kbd
10274 @item W D x
10275 @kindex W D x (Summary)
10276 @findex gnus-article-display-x-face
10277 Display an @code{X-Face} in the @code{From} header.
10278 (@code{gnus-article-display-x-face}).
10279
10280 @item W D d
10281 @kindex W D d (Summary)
10282 @findex gnus-article-display-face
10283 Display a @code{Face} in the @code{From} header.
10284 (@code{gnus-article-display-face}).
10285
10286 @item W D s
10287 @kindex W D s (Summary)
10288 @findex gnus-treat-smiley
10289 Display smileys (@code{gnus-treat-smiley}).
10290
10291 @item W D f
10292 @kindex W D f (Summary)
10293 @findex gnus-treat-from-picon
10294 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
10295
10296 @item W D m
10297 @kindex W D m (Summary)
10298 @findex gnus-treat-mail-picon
10299 Piconify all mail headers (i. e., @code{Cc}, @code{To})
10300 (@code{gnus-treat-mail-picon}).
10301
10302 @item W D n
10303 @kindex W D n (Summary)
10304 @findex gnus-treat-newsgroups-picon
10305 Piconify all news headers (i. e., @code{Newsgroups} and
10306 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
10307
10308 @item W D g
10309 @kindex W D g (Summary)
10310 @findex gnus-treat-from-gravatar
10311 Gravatarify the @code{From} header (@code{gnus-treat-from-gravatar}).
10312
10313 @item W D h
10314 @kindex W D h (Summary)
10315 @findex gnus-treat-mail-gravatar
10316 Gravatarify all mail headers (i. e., @code{Cc}, @code{To})
10317 (@code{gnus-treat-from-gravatar}).
10318
10319 @item W D D
10320 @kindex W D D (Summary)
10321 @findex gnus-article-remove-images
10322 Remove all images from the article buffer
10323 (@code{gnus-article-remove-images}).
10324
10325 @item W D W
10326 @kindex W D W (Summary)
10327 @findex gnus-html-show-images
10328 If you're reading an @acronym{HTML} article rendered with
10329 @code{gnus-article-html}, then you can insert any blocked images in
10330 the buffer with this command.
10331 (@code{gnus-html-show-images}).
10332
10333 @end table
10334
10335
10336
10337 @node Article Signature
10338 @subsection Article Signature
10339 @cindex signatures
10340 @cindex article signature
10341
10342 @vindex gnus-signature-separator
10343 Each article is divided into two parts---the head and the body.  The
10344 body can be divided into a signature part and a text part.  The variable
10345 that says what is to be considered a signature is
10346 @code{gnus-signature-separator}.  This is normally the standard
10347 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
10348 non-standard signature separators, so this variable can also be a list
10349 of regular expressions to be tested, one by one.  (Searches are done
10350 from the end of the body towards the beginning.)  One likely value is:
10351
10352 @lisp
10353 (setq gnus-signature-separator
10354       '("^-- $"         ; @r{The standard}
10355         "^-- *$"        ; @r{A common mangling}
10356         "^-------*$"    ; @r{Many people just use a looong}
10357                         ; @r{line of dashes.  Shame!}
10358         "^ *--------*$" ; @r{Double-shame!}
10359         "^________*$"   ; @r{Underscores are also popular}
10360         "^========*$")) ; @r{Pervert!}
10361 @end lisp
10362
10363 The more permissive you are, the more likely it is that you'll get false
10364 positives.
10365
10366 @vindex gnus-signature-limit
10367 @code{gnus-signature-limit} provides a limit to what is considered a
10368 signature when displaying articles.
10369
10370 @enumerate
10371 @item
10372 If it is an integer, no signature may be longer (in characters) than
10373 that integer.
10374 @item
10375 If it is a floating point number, no signature may be longer (in lines)
10376 than that number.
10377 @item
10378 If it is a function, the function will be called without any parameters,
10379 and if it returns @code{nil}, there is no signature in the buffer.
10380 @item
10381 If it is a string, it will be used as a regexp.  If it matches, the text
10382 in question is not a&n